Amazon CloudFront 2020-05-31
- Client: Aws\CloudFront\CloudFrontClient
- Service ID: cloudfront
- Version: 2020-05-31
This page describes the parameters and results for the operations of the Amazon CloudFront (2020-05-31), and shows how to use the Aws\CloudFront\CloudFrontClient object to call the described operations. This documentation is specific to the 2020-05-31 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateAlias ( array $params = [] )
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
- CreateCachePolicy ( array $params = [] )
Creates a cache policy.
- CreateCloudFrontOriginAccessIdentity ( array $params = [] )
Creates a new origin access identity.
- CreateDistribution ( array $params = [] )
Creates a new web distribution.
- CreateDistributionWithTags ( array $params = [] )
Create a new distribution with tags.
- CreateFieldLevelEncryptionConfig ( array $params = [] )
Create a new field-level encryption configuration.
- CreateFieldLevelEncryptionProfile ( array $params = [] )
Create a field-level encryption profile.
- CreateFunction ( array $params = [] )
Creates a CloudFront function.
- CreateInvalidation ( array $params = [] )
Create a new invalidation.
- CreateKeyGroup ( array $params = [] )
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
- CreateMonitoringSubscription ( array $params = [] )
Enables additional CloudWatch metrics for the specified CloudFront distribution.
- CreateOriginRequestPolicy ( array $params = [] )
Creates an origin request policy.
- CreatePublicKey ( array $params = [] )
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
- CreateRealtimeLogConfig ( array $params = [] )
Creates a real-time log configuration.
- CreateResponseHeadersPolicy ( array $params = [] )
Creates a response headers policy.
- CreateStreamingDistribution ( array $params = [] )
This API is deprecated.
- CreateStreamingDistributionWithTags ( array $params = [] )
This API is deprecated.
- DeleteCachePolicy ( array $params = [] )
Deletes a cache policy.
- DeleteCloudFrontOriginAccessIdentity ( array $params = [] )
Delete an origin access identity.
- DeleteDistribution ( array $params = [] )
Delete a distribution.
- DeleteFieldLevelEncryptionConfig ( array $params = [] )
Remove a field-level encryption configuration.
- DeleteFieldLevelEncryptionProfile ( array $params = [] )
Remove a field-level encryption profile.
- DeleteFunction ( array $params = [] )
Deletes a CloudFront function.
- DeleteKeyGroup ( array $params = [] )
Deletes a key group.
- DeleteMonitoringSubscription ( array $params = [] )
Disables additional CloudWatch metrics for the specified CloudFront distribution.
- DeleteOriginRequestPolicy ( array $params = [] )
Deletes an origin request policy.
- DeletePublicKey ( array $params = [] )
Remove a public key you previously added to CloudFront.
- DeleteRealtimeLogConfig ( array $params = [] )
Deletes a real-time log configuration.
- DeleteResponseHeadersPolicy ( array $params = [] )
Deletes a response headers policy.
- DeleteStreamingDistribution ( array $params = [] )
Delete a streaming distribution.
- DescribeFunction ( array $params = [] )
Gets configuration information and metadata about a CloudFront function, but not the function’s code.
- GetCachePolicy ( array $params = [] )
Gets a cache policy, including the following metadata: The policy’s identifier.
- GetCachePolicyConfig ( array $params = [] )
Gets a cache policy configuration.
- GetCloudFrontOriginAccessIdentity ( array $params = [] )
Get the information about an origin access identity.
- GetCloudFrontOriginAccessIdentityConfig ( array $params = [] )
Get the configuration information about an origin access identity.
- GetDistribution ( array $params = [] )
Get the information about a distribution.
- GetDistributionConfig ( array $params = [] )
Get the configuration information about a distribution.
- GetFieldLevelEncryption ( array $params = [] )
Get the field-level encryption configuration information.
- GetFieldLevelEncryptionConfig ( array $params = [] )
Get the field-level encryption configuration information.
- GetFieldLevelEncryptionProfile ( array $params = [] )
Get the field-level encryption profile information.
- GetFieldLevelEncryptionProfileConfig ( array $params = [] )
Get the field-level encryption profile configuration information.
- GetFunction ( array $params = [] )
Gets the code of a CloudFront function.
- GetInvalidation ( array $params = [] )
Get the information about an invalidation.
- GetKeyGroup ( array $params = [] )
Gets a key group, including the date and time when the key group was last modified.
- GetKeyGroupConfig ( array $params = [] )
Gets a key group configuration.
- GetMonitoringSubscription ( array $params = [] )
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
- GetOriginRequestPolicy ( array $params = [] )
Gets an origin request policy, including the following metadata: The policy’s identifier.
- GetOriginRequestPolicyConfig ( array $params = [] )
Gets an origin request policy configuration.
- GetPublicKey ( array $params = [] )
Gets a public key.
- GetPublicKeyConfig ( array $params = [] )
Gets a public key configuration.
- GetRealtimeLogConfig ( array $params = [] )
Gets a real-time log configuration.
- GetResponseHeadersPolicy ( array $params = [] )
Gets a response headers policy, including metadata (the policy’s identifier and the date and time when the policy was last modified).
- GetResponseHeadersPolicyConfig ( array $params = [] )
Gets a response headers policy configuration.
- GetStreamingDistribution ( array $params = [] )
Gets information about a specified RTMP distribution, including the distribution configuration.
- GetStreamingDistributionConfig ( array $params = [] )
Get the configuration information about a streaming distribution.
- ListCachePolicies ( array $params = [] )
Gets a list of cache policies.
- ListCloudFrontOriginAccessIdentities ( array $params = [] )
Lists origin access identities.
- ListConflictingAliases ( array $params = [] )
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias.
- ListDistributions ( array $params = [] )
List CloudFront distributions.
- ListDistributionsByCachePolicyId ( array $params = [] )
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.
- ListDistributionsByKeyGroup ( array $params = [] )
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
- ListDistributionsByOriginRequestPolicyId ( array $params = [] )
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.
- ListDistributionsByRealtimeLogConfig ( array $params = [] )
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.
- ListDistributionsByResponseHeadersPolicyId ( array $params = [] )
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified response headers policy.
- ListDistributionsByWebACLId ( array $params = [] )
List the distributions that are associated with a specified WAF web ACL.
- ListFieldLevelEncryptionConfigs ( array $params = [] )
List all field-level encryption configurations that have been created in CloudFront for this account.
- ListFieldLevelEncryptionProfiles ( array $params = [] )
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
- ListFunctions ( array $params = [] )
Gets a list of all CloudFront functions in your Amazon Web Services account.
- ListInvalidations ( array $params = [] )
Lists invalidation batches.
- ListKeyGroups ( array $params = [] )
Gets a list of key groups.
- ListOriginRequestPolicies ( array $params = [] )
Gets a list of origin request policies.
- ListPublicKeys ( array $params = [] )
List all public keys that have been added to CloudFront for this account.
- ListRealtimeLogConfigs ( array $params = [] )
Gets a list of real-time log configurations.
- ListResponseHeadersPolicies ( array $params = [] )
Gets a list of response headers policies.
- ListStreamingDistributions ( array $params = [] )
List streaming distributions.
- ListTagsForResource ( array $params = [] )
List tags for a CloudFront resource.
- PublishFunction ( array $params = [] )
Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE.
- TagResource ( array $params = [] )
Add tags to a CloudFront resource.
- TestFunction ( array $params = [] )
Tests a CloudFront function.
- UntagResource ( array $params = [] )
Remove tags from a CloudFront resource.
- UpdateCachePolicy ( array $params = [] )
Updates a cache policy configuration.
- UpdateCloudFrontOriginAccessIdentity ( array $params = [] )
Update an origin access identity.
- UpdateDistribution ( array $params = [] )
Updates the configuration for a web distribution.
- UpdateFieldLevelEncryptionConfig ( array $params = [] )
Update a field-level encryption configuration.
- UpdateFieldLevelEncryptionProfile ( array $params = [] )
Update a field-level encryption profile.
- UpdateFunction ( array $params = [] )
Updates a CloudFront function.
- UpdateKeyGroup ( array $params = [] )
Updates a key group.
- UpdateOriginRequestPolicy ( array $params = [] )
Updates an origin request policy configuration.
- UpdatePublicKey ( array $params = [] )
Update public key information.
- UpdateRealtimeLogConfig ( array $params = [] )
Updates a real-time log configuration.
- UpdateResponseHeadersPolicy ( array $params = [] )
Updates a response headers policy.
- UpdateStreamingDistribution ( array $params = [] )
Update a streaming distribution.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
| Waiter name | API Operation | Delay | Max Attempts |
|---|---|---|---|
| DistributionDeployed | GetDistribution | 60 | 35 |
| InvalidationCompleted | GetInvalidation | 20 | 30 |
| StreamingDistributionDeployed | GetStreamingDistribution | 60 | 25 |
Operations
AssociateAlias
$result = $client->associateAlias([/* ... */]); $promise = $client->associateAliasAsync([/* ... */]);
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that’s already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
Parameter Syntax
$result = $client->associateAlias([
'Alias' => '<string>', // REQUIRED
'TargetDistributionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An argument is invalid.
-
The specified distribution does not exist.
-
Your request contains more CNAMEs than are allowed per distribution.
-
The update contains modifications that are not allowed.
-
Access denied.
CreateCachePolicy
$result = $client->createCachePolicy([/* ... */]); $promise = $client->createCachePolicyAsync([/* ... */]);
Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:
-
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
-
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically 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.
Parameter Syntax
$result = $client->createCachePolicy([
'CachePolicyConfig' => [ // REQUIRED
'Comment' => '<string>',
'DefaultTTL' => <integer>,
'MaxTTL' => <integer>,
'MinTTL' => <integer>, // REQUIRED
'Name' => '<string>', // REQUIRED
'ParametersInCacheKeyAndForwardedToOrigin' => [
'CookiesConfig' => [ // REQUIRED
'CookieBehavior' => 'none|whitelist|allExcept|all', // REQUIRED
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'EnableAcceptEncodingBrotli' => true || false,
'EnableAcceptEncodingGzip' => true || false, // REQUIRED
'HeadersConfig' => [ // REQUIRED
'HeaderBehavior' => 'none|whitelist', // REQUIRED
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'QueryStringsConfig' => [ // REQUIRED
'QueryStringBehavior' => 'none|whitelist|allExcept|all', // REQUIRED
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
],
],
]);
Parameter Details
Members
- CachePolicyConfig
-
- Required: Yes
- Type: CachePolicyConfig structure
A cache policy configuration.
Result Syntax
[
'CachePolicy' => [
'CachePolicyConfig' => [
'Comment' => '<string>',
'DefaultTTL' => <integer>,
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'Name' => '<string>',
'ParametersInCacheKeyAndForwardedToOrigin' => [
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|allExcept|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'EnableAcceptEncodingBrotli' => true || false,
'EnableAcceptEncodingGzip' => true || false,
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|allExcept|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
'ETag' => '<string>',
'Location' => '<string>',
]
Result Details
Members
- CachePolicy
-
- Type: CachePolicy structure
A cache policy.
- ETag
-
- Type: string
The current version of the cache policy.
- Location
-
- Type: string
The fully qualified URI of the cache policy just created.
Errors
-
Access denied.
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use
UpdateCachePolicy. -
You have reached the maximum number of cache policies for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyQueryStringsInCachePolicy:
The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
CreateCloudFrontOriginAccessIdentity
$result = $client->createCloudFrontOriginAccessIdentity([/* ... */]); $promise = $client->createCloudFrontOriginAccessIdentityAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createCloudFrontOriginAccessIdentity([
'CloudFrontOriginAccessIdentityConfig' => [ // REQUIRED
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- CloudFrontOriginAccessIdentityConfig
-
- Required: Yes
- Type: CloudFrontOriginAccessIdentityConfig structure
The current configuration information for the identity.
Result Syntax
[
'CloudFrontOriginAccessIdentity' => [
'CloudFrontOriginAccessIdentityConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
],
'Id' => '<string>',
'S3CanonicalUserId' => '<string>',
],
'ETag' => '<string>',
'Location' => '<string>',
]
Result Details
Members
- CloudFrontOriginAccessIdentity
-
- Type: CloudFrontOriginAccessIdentity structure
The origin access identity's information.
- ETag
-
- Type: string
The current version of the origin access identity created.
- Location
-
- Type: string
The fully qualified URI of the new origin access identity just created.
Errors
-
CloudFrontOriginAccessIdentityAlreadyExists:
If the
CallerReferenceis a value you already sent in a previous request to create an identity but the content of theCloudFrontOriginAccessIdentityConfigis different from the original request, CloudFront returns aCloudFrontOriginAccessIdentityAlreadyExistserror. -
This operation requires a body. Ensure that the body is present and the
Content-Typeheader is set. -
TooManyCloudFrontOriginAccessIdentities:
Processing your request would cause you to exceed the maximum number of origin access identities allowed.
-
An argument is invalid.
-
The value of
Quantityand the size ofItemsdon't match.
CreateDistribution
$result = $client->createDistribution([/* ... */]); $promise = $client->createDistributionAsync([/* ... */]);
Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
Parameter Syntax
$result = $client->createDistribution([
'DistributionConfig' => [ // REQUIRED
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [ // REQUIRED
'Forward' => 'none|whitelist|all', // REQUIRED
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'QueryString' => true || false, // REQUIRED
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'FunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>', // REQUIRED
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>', // REQUIRED
'TrustedKeyGroups' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'TrustedSigners' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>', // REQUIRED
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>, // REQUIRED
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'DefaultCacheBehavior' => [ // REQUIRED
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [ // REQUIRED
'Forward' => 'none|whitelist|all', // REQUIRED
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'QueryString' => true || false, // REQUIRED
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'FunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>', // REQUIRED
'TrustedKeyGroups' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'TrustedSigners' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
],
'DefaultRootObject' => '<string>',
'Enabled' => true || false, // REQUIRED
'HttpVersion' => 'http1.1|http2',
'IsIPV6Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
'IncludeCookies' => true || false, // REQUIRED
'Prefix' => '<string>', // REQUIRED
],
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [ // REQUIRED
'StatusCodes' => [ // REQUIRED
'Items' => [<integer>, ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
],
'Id' => '<string>', // REQUIRED
'Members' => [ // REQUIRED
'Items' => [ // REQUIRED
[
'OriginId' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'Origins' => [ // REQUIRED
'Items' => [ // REQUIRED
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>', // REQUIRED
'HeaderValue' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>, // REQUIRED
'HTTPSPort' => <integer>, // REQUIRED
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
],
'DomainName' => '<string>', // REQUIRED
'Id' => '<string>', // REQUIRED
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false, // REQUIRED
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>', // REQUIRED
],
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [ // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
'RestrictionType' => 'blacklist|whitelist|none', // REQUIRED
],
],
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
]);
Parameter Details
Members
- DistributionConfig
-
- Required: Yes
- Type: DistributionConfig structure
The distribution's configuration information.
Result Syntax
[
'Distribution' => [
'ARN' => '<string>',
'ActiveTrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => [
[
'KeyGroupId' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'ActiveTrustedSigners' => [
'Enabled' => true || false,
'Items' => [
[
'AwsAccountNumber' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'AliasICPRecordals' => [
[
'CNAME' => '<string>',
'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
],
// ...
],
'DistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
// ...
],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>,
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'DefaultCacheBehavior' => [
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
'DefaultRootObject' => '<string>',
'Enabled' => true || false,
'HttpVersion' => 'http1.1|http2',
'IsIPV6Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'IncludeCookies' => true || false,
'Prefix' => '<string>',
],
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [
'StatusCodes' => [
'Items' => [<integer>, ...],
'Quantity' => <integer>,
],
],
'Id' => '<string>',
'Members' => [
'Items' => [
[
'OriginId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'Origins' => [
'Items' => [
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>',
'HeaderValue' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>,
'HTTPSPort' => <integer>,
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false,
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>',
],
],
// ...
],
'Quantity' => <integer>,
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
'RestrictionType' => 'blacklist|whitelist|none',
],
],
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
'DomainName' => '<string>',
'Id' => '<string>',
'InProgressInvalidationBatches' => <integer>,
'LastModifiedTime' => <DateTime>,
'Status' => '<string>',
],
'ETag' => '<string>',
'Location' => '<string>',
]
Result Details
Members
- Distribution
-
- Type: Distribution structure
The distribution's information.
- ETag
-
- Type: string
The current version of the distribution created.
- Location
-
- Type: string
The fully qualified URI of the new distribution resource just created.
Errors
-
The CNAME specified is already defined for CloudFront.
-
The caller reference you attempted to create the distribution with is associated with another distribution.
-
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
-
The origin access identity is not valid or doesn't exist.
-
Access denied.
-
Your request contains more trusted signers than are allowed per distribution.
-
One or more of your trusted signers don't exist.
-
A viewer certificate specified is not valid.
-
InvalidMinimumProtocolVersion:
The minimum protocol version specified is not valid.
-
This operation requires a body. Ensure that the body is present and the
Content-Typeheader is set. -
Your request contains more CNAMEs than are allowed per distribution.
-
Processing your request would cause you to exceed the maximum number of distributions allowed.
-
The default root object file name is too big or contains an invalid character.
-
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
-
An invalid error code was specified.
-
A response code is not valid.
-
An argument is invalid.
-
This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the
RequiredProtocolselement from your distribution configuration. -
No origin exists with the specified
Origin Id. -
You cannot create more origins for the distribution.
-
TooManyOriginGroupsPerDistribution:
Processing your request would cause you to exceed the maximum number of origin groups allowed.
-
You cannot create more cache behaviors for the distribution.
-
TooManyCookieNamesInWhiteList:
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
-
Your request contains forward cookies option which doesn't match with the expectation for the
whitelistedlist of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected. -
TooManyHeadersInForwardedValues:
Your request contains too many headers in forwarded values.
-
The headers specified are not valid for an Amazon S3 origin.
-
The value of
Quantityand the size ofItemsdon't match. -
You cannot create anymore custom SSL/TLS certificates.
-
The location code specified is not valid.
-
InvalidGeoRestrictionParameter:
The specified geo restriction parameter is not valid.
-
You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).
-
The TTL order specified is not valid.
-
A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a. -
Your request contains too many origin custom headers.
-
Your request contains too many query string parameters.
-
The query string parameters specified are not valid.
-
TooManyDistributionsWithLambdaAssociations:
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
-
TooManyDistributionsWithSingleFunctionARN:
The maximum number of distributions have been associated with the specified Lambda@Edge function.
-
TooManyLambdaFunctionAssociations:
Your request contains more Lambda@Edge function associations than are allowed per distribution.
-
InvalidLambdaFunctionAssociation:
The specified Lambda@Edge function association is invalid.
-
TooManyDistributionsWithFunctionAssociations:
You have reached the maximum number of distributions that are associated with a CloudFront function. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
You have reached the maximum number of CloudFront function associations for this distribution. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
A CloudFront function association is invalid.
-
The read timeout specified for the origin is not valid.
-
InvalidOriginKeepaliveTimeout:
The keep alive timeout specified for the origin is not valid.
-
NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
-
IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
-
TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
-
The cache policy does not exist.
-
TooManyDistributionsAssociatedToCachePolicy:
The maximum number of distributions have been associated with the specified cache policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The response headers policy does not exist.
-
TooManyDistributionsAssociatedToResponseHeadersPolicy:
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The origin request policy does not exist.
-
TooManyDistributionsAssociatedToOriginRequestPolicy:
The maximum number of distributions have been associated with the specified origin request policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyDistributionsAssociatedToKeyGroup:
The number of distributions that reference this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyKeyGroupsAssociatedToDistribution:
The number of key groups referenced by this distribution is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The specified key group does not exist.
-
The real-time log configuration does not exist.
-
RealtimeLogConfigOwnerMismatch:
The specified real-time log configuration belongs to a different Amazon Web Services account.
CreateDistributionWithTags
$result = $client->createDistributionWithTags([/* ... */]); $promise = $client->createDistributionWithTagsAsync([/* ... */]);
Create a new distribution with tags.
Parameter Syntax
$result = $client->createDistributionWithTags([
'DistributionConfigWithTags' => [ // REQUIRED
'DistributionConfig' => [ // REQUIRED
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [ // REQUIRED
'Forward' => 'none|whitelist|all', // REQUIRED
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'QueryString' => true || false, // REQUIRED
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'FunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>', // REQUIRED
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>', // REQUIRED
'TrustedKeyGroups' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'TrustedSigners' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>', // REQUIRED
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>, // REQUIRED
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'DefaultCacheBehavior' => [ // REQUIRED
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [ // REQUIRED
'Forward' => 'none|whitelist|all', // REQUIRED
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'QueryString' => true || false, // REQUIRED
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'FunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>', // REQUIRED
'TrustedKeyGroups' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'TrustedSigners' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
],
'DefaultRootObject' => '<string>',
'Enabled' => true || false, // REQUIRED
'HttpVersion' => 'http1.1|http2',
'IsIPV6Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
'IncludeCookies' => true || false, // REQUIRED
'Prefix' => '<string>', // REQUIRED
],
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [ // REQUIRED
'StatusCodes' => [ // REQUIRED
'Items' => [<integer>, ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
],
'Id' => '<string>', // REQUIRED
'Members' => [ // REQUIRED
'Items' => [ // REQUIRED
[
'OriginId' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'Origins' => [ // REQUIRED
'Items' => [ // REQUIRED
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>', // REQUIRED
'HeaderValue' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>, // REQUIRED
'HTTPSPort' => <integer>, // REQUIRED
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
],
'DomainName' => '<string>', // REQUIRED
'Id' => '<string>', // REQUIRED
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false, // REQUIRED
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>', // REQUIRED
],
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [ // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
'RestrictionType' => 'blacklist|whitelist|none', // REQUIRED
],
],
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
'Tags' => [ // REQUIRED
'Items' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
],
],
]);
Parameter Details
Members
- DistributionConfigWithTags
-
- Required: Yes
- Type: DistributionConfigWithTags structure
The distribution's configuration information.
Result Syntax
[
'Distribution' => [
'ARN' => '<string>',
'ActiveTrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => [
[
'KeyGroupId' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'ActiveTrustedSigners' => [
'Enabled' => true || false,
'Items' => [
[
'AwsAccountNumber' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'AliasICPRecordals' => [
[
'CNAME' => '<string>',
'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
],
// ...
],
'DistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
// ...
],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>,
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'DefaultCacheBehavior' => [
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
'DefaultRootObject' => '<string>',
'Enabled' => true || false,
'HttpVersion' => 'http1.1|http2',
'IsIPV6Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'IncludeCookies' => true || false,
'Prefix' => '<string>',
],
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [
'StatusCodes' => [
'Items' => [<integer>, ...],
'Quantity' => <integer>,
],
],
'Id' => '<string>',
'Members' => [
'Items' => [
[
'OriginId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'Origins' => [
'Items' => [
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>',
'HeaderValue' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>,
'HTTPSPort' => <integer>,
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false,
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>',
],
],
// ...
],
'Quantity' => <integer>,
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
'RestrictionType' => 'blacklist|whitelist|none',
],
],
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
'DomainName' => '<string>',
'Id' => '<string>',
'InProgressInvalidationBatches' => <integer>,
'LastModifiedTime' => <DateTime>,
'Status' => '<string>',
],
'ETag' => '<string>',
'Location' => '<string>',
]
Result Details
Members
- Distribution
-
- Type: Distribution structure
The distribution's information.
- ETag
-
- Type: string
The current version of the distribution created.
- Location
-
- Type: string
The fully qualified URI of the new distribution resource just created.
Errors
-
The CNAME specified is already defined for CloudFront.
-
The caller reference you attempted to create the distribution with is associated with another distribution.
-
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
-
The origin access identity is not valid or doesn't exist.
-
Access denied.
-
Your request contains more trusted signers than are allowed per distribution.
-
One or more of your trusted signers don't exist.
-
A viewer certificate specified is not valid.
-
InvalidMinimumProtocolVersion:
The minimum protocol version specified is not valid.
-
This operation requires a body. Ensure that the body is present and the
Content-Typeheader is set. -
Your request contains more CNAMEs than are allowed per distribution.
-
Processing your request would cause you to exceed the maximum number of distributions allowed.
-
The default root object file name is too big or contains an invalid character.
-
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
-
An invalid error code was specified.
-
A response code is not valid.
-
An argument is invalid.
-
This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the
RequiredProtocolselement from your distribution configuration. -
No origin exists with the specified
Origin Id. -
You cannot create more origins for the distribution.
-
TooManyOriginGroupsPerDistribution:
Processing your request would cause you to exceed the maximum number of origin groups allowed.
-
You cannot create more cache behaviors for the distribution.
-
TooManyCookieNamesInWhiteList:
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
-
Your request contains forward cookies option which doesn't match with the expectation for the
whitelistedlist of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected. -
TooManyHeadersInForwardedValues:
Your request contains too many headers in forwarded values.
-
The headers specified are not valid for an Amazon S3 origin.
-
The value of
Quantityand the size ofItemsdon't match. -
You cannot create anymore custom SSL/TLS certificates.
-
The location code specified is not valid.
-
InvalidGeoRestrictionParameter:
The specified geo restriction parameter is not valid.
-
You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).
-
The TTL order specified is not valid.
-
A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a. -
Your request contains too many origin custom headers.
-
The tagging specified is not valid.
-
Your request contains too many query string parameters.
-
The query string parameters specified are not valid.
-
TooManyDistributionsWithLambdaAssociations:
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
-
TooManyDistributionsWithSingleFunctionARN:
The maximum number of distributions have been associated with the specified Lambda@Edge function.
-
TooManyLambdaFunctionAssociations:
Your request contains more Lambda@Edge function associations than are allowed per distribution.
-
InvalidLambdaFunctionAssociation:
The specified Lambda@Edge function association is invalid.
-
TooManyDistributionsWithFunctionAssociations:
You have reached the maximum number of distributions that are associated with a CloudFront function. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
You have reached the maximum number of CloudFront function associations for this distribution. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
A CloudFront function association is invalid.
-
The read timeout specified for the origin is not valid.
-
InvalidOriginKeepaliveTimeout:
The keep alive timeout specified for the origin is not valid.
-
NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
-
IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
-
TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
-
The cache policy does not exist.
-
TooManyDistributionsAssociatedToCachePolicy:
The maximum number of distributions have been associated with the specified cache policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The response headers policy does not exist.
-
TooManyDistributionsAssociatedToResponseHeadersPolicy:
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The origin request policy does not exist.
-
TooManyDistributionsAssociatedToOriginRequestPolicy:
The maximum number of distributions have been associated with the specified origin request policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyDistributionsAssociatedToKeyGroup:
The number of distributions that reference this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyKeyGroupsAssociatedToDistribution:
The number of key groups referenced by this distribution is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The specified key group does not exist.
-
The real-time log configuration does not exist.
-
RealtimeLogConfigOwnerMismatch:
The specified real-time log configuration belongs to a different Amazon Web Services account.
CreateFieldLevelEncryptionConfig
$result = $client->createFieldLevelEncryptionConfig([/* ... */]); $promise = $client->createFieldLevelEncryptionConfigAsync([/* ... */]);
Create a new field-level encryption configuration.
Parameter Syntax
$result = $client->createFieldLevelEncryptionConfig([
'FieldLevelEncryptionConfig' => [ // REQUIRED
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>',
'ContentTypeProfileConfig' => [
'ContentTypeProfiles' => [
'Items' => [
[
'ContentType' => '<string>', // REQUIRED
'Format' => 'URLEncoded', // REQUIRED
'ProfileId' => '<string>',
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'ForwardWhenContentTypeIsUnknown' => true || false, // REQUIRED
],
'QueryArgProfileConfig' => [
'ForwardWhenQueryArgProfileIsUnknown' => true || false, // REQUIRED
'QueryArgProfiles' => [
'Items' => [
[
'ProfileId' => '<string>', // REQUIRED
'QueryArg' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
],
],
]);
Parameter Details
Members
- FieldLevelEncryptionConfig
-
- Required: Yes
- Type: FieldLevelEncryptionConfig structure
The request to create a new field-level encryption configuration.
Result Syntax
[
'ETag' => '<string>',
'FieldLevelEncryption' => [
'FieldLevelEncryptionConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'ContentTypeProfileConfig' => [
'ContentTypeProfiles' => [
'Items' => [
[
'ContentType' => '<string>',
'Format' => 'URLEncoded',
'ProfileId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'ForwardWhenContentTypeIsUnknown' => true || false,
],
'QueryArgProfileConfig' => [
'ForwardWhenQueryArgProfileIsUnknown' => true || false,
'QueryArgProfiles' => [
'Items' => [
[
'ProfileId' => '<string>',
'QueryArg' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
'Location' => '<string>',
]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption configuration. For example:
E2QWRUHAPOMQZL. - FieldLevelEncryption
-
- Type: FieldLevelEncryption structure
Returned when you create a new field-level encryption configuration.
- Location
-
- Type: string
The fully qualified URI of the new configuration resource just created.
Errors
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
-
FieldLevelEncryptionConfigAlreadyExists:
The specified configuration for field-level encryption already exists.
-
TooManyFieldLevelEncryptionConfigs:
The maximum number of configurations for field-level encryption have been created.
-
TooManyFieldLevelEncryptionQueryArgProfiles:
The maximum number of query arg profiles for field-level encryption have been created.
-
TooManyFieldLevelEncryptionContentTypeProfiles:
The maximum number of content type profiles for field-level encryption have been created.
-
No profile specified for the field-level encryption query argument.
CreateFieldLevelEncryptionProfile
$result = $client->createFieldLevelEncryptionProfile([/* ... */]); $promise = $client->createFieldLevelEncryptionProfileAsync([/* ... */]);
Create a field-level encryption profile.
Parameter Syntax
$result = $client->createFieldLevelEncryptionProfile([
'FieldLevelEncryptionProfileConfig' => [ // REQUIRED
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>',
'EncryptionEntities' => [ // REQUIRED
'Items' => [
[
'FieldPatterns' => [ // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'ProviderId' => '<string>', // REQUIRED
'PublicKeyId' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'Name' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- FieldLevelEncryptionProfileConfig
-
- Required: Yes
- Type: FieldLevelEncryptionProfileConfig structure
The request to create a field-level encryption profile.
Result Syntax
[
'ETag' => '<string>',
'FieldLevelEncryptionProfile' => [
'FieldLevelEncryptionProfileConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'EncryptionEntities' => [
'Items' => [
[
'FieldPatterns' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ProviderId' => '<string>',
'PublicKeyId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Name' => '<string>',
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
'Location' => '<string>',
]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption profile. For example:
E2QWRUHAPOMQZL. - FieldLevelEncryptionProfile
-
- Type: FieldLevelEncryptionProfile structure
Returned when you create a new field-level encryption profile.
- Location
-
- Type: string
The fully qualified URI of the new profile resource just created.
Errors
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
The specified public key doesn't exist.
-
FieldLevelEncryptionProfileAlreadyExists:
The specified profile for field-level encryption already exists.
-
FieldLevelEncryptionProfileSizeExceeded:
The maximum size of a profile for field-level encryption was exceeded.
-
TooManyFieldLevelEncryptionProfiles:
The maximum number of profiles for field-level encryption have been created.
-
TooManyFieldLevelEncryptionEncryptionEntities:
The maximum number of encryption entities for field-level encryption have been created.
-
TooManyFieldLevelEncryptionFieldPatterns:
The maximum number of field patterns for field-level encryption have been created.
CreateFunction
$result = $client->createFunction([/* ... */]); $promise = $client->createFunctionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createFunction([
'FunctionCode' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
'FunctionConfig' => [ // REQUIRED
'Comment' => '<string>', // REQUIRED
'Runtime' => 'cloudfront-js-1.0', // REQUIRED
],
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- FunctionCode
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.
- FunctionConfig
-
- Required: Yes
- Type: FunctionConfig structure
Configuration information about the function, including an optional comment and the function’s runtime.
- Name
-
- Required: Yes
- Type: string
A name to identify the function.
Result Syntax
[
'ETag' => '<string>',
'FunctionSummary' => [
'FunctionConfig' => [
'Comment' => '<string>',
'Runtime' => 'cloudfront-js-1.0',
],
'FunctionMetadata' => [
'CreatedTime' => <DateTime>,
'FunctionARN' => '<string>',
'LastModifiedTime' => <DateTime>,
'Stage' => 'DEVELOPMENT|LIVE',
],
'Name' => '<string>',
'Status' => '<string>',
],
'Location' => '<string>',
]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the CloudFront function.
- FunctionSummary
-
- Type: FunctionSummary structure
Contains configuration information and metadata about a CloudFront function.
- Location
-
- Type: string
The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.
Errors
-
You have reached the maximum number of CloudFront functions for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
A function with the same name already exists in this Amazon Web Services account. To create a function, you must provide a unique name. To update an existing function, use
UpdateFunction. -
The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
An argument is invalid.
-
This operation is not supported in this region.
CreateInvalidation
$result = $client->createInvalidation([/* ... */]); $promise = $client->createInvalidationAsync([/* ... */]);
Create a new invalidation.
Parameter Syntax
$result = $client->createInvalidation([
'DistributionId' => '<string>', // REQUIRED
'InvalidationBatch' => [ // REQUIRED
'CallerReference' => '<string>', // REQUIRED
'Paths' => [ // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
]);
Parameter Details
Members
- DistributionId
-
- Required: Yes
- Type: string
The distribution's id.
- InvalidationBatch
-
- Required: Yes
- Type: InvalidationBatch structure
The batch information for the invalidation.
Result Syntax
[
'Invalidation' => [
'CreateTime' => <DateTime>,
'Id' => '<string>',
'InvalidationBatch' => [
'CallerReference' => '<string>',
'Paths' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Status' => '<string>',
],
'Location' => '<string>',
]
Result Details
Members
- Invalidation
-
- Type: Invalidation structure
The invalidation's information.
- Location
-
- Type: string
The fully qualified URI of the distribution and invalidation batch request, including the
Invalidation ID.
Errors
-
Access denied.
-
This operation requires a body. Ensure that the body is present and the
Content-Typeheader is set. -
An argument is invalid.
-
The specified distribution does not exist.
-
Invalidation batch specified is too large.
-
TooManyInvalidationsInProgress:
You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.
-
The value of
Quantityand the size ofItemsdon't match.
CreateKeyGroup
$result = $client->createKeyGroup([/* ... */]); $promise = $client->createKeyGroupAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createKeyGroup([
'KeyGroupConfig' => [ // REQUIRED
'Comment' => '<string>',
'Items' => ['<string>', ...], // REQUIRED
'Name' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- KeyGroupConfig
-
- Required: Yes
- Type: KeyGroupConfig structure
A key group configuration.
Result Syntax
[
'ETag' => '<string>',
'KeyGroup' => [
'Id' => '<string>',
'KeyGroupConfig' => [
'Comment' => '<string>',
'Items' => ['<string>', ...],
'Name' => '<string>',
],
'LastModifiedTime' => <DateTime>,
],
'Location' => '<string>',
]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the key group.
- KeyGroup
-
- Type: KeyGroup structure
The key group that was just created.
- Location
-
- Type: string
The URL of the key group.
Errors
-
An argument is invalid.
-
A key group with this name already exists. You must provide a unique name. To modify an existing key group, use
UpdateKeyGroup. -
You have reached the maximum number of key groups for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The number of public keys in this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
CreateMonitoringSubscription
$result = $client->createMonitoringSubscription([/* ... */]); $promise = $client->createMonitoringSubscriptionAsync([/* ... */]);
Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
Parameter Syntax
$result = $client->createMonitoringSubscription([
'DistributionId' => '<string>', // REQUIRED
'MonitoringSubscription' => [ // REQUIRED
'RealtimeMetricsSubscriptionConfig' => [
'RealtimeMetricsSubscriptionStatus' => 'Enabled|Disabled', // REQUIRED
],
],
]);
Parameter Details
Members
- DistributionId
-
- Required: Yes
- Type: string
The ID of the distribution that you are enabling metrics for.
- MonitoringSubscription
-
- Required: Yes
- Type: MonitoringSubscription structure
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Result Syntax
[
'MonitoringSubscription' => [
'RealtimeMetricsSubscriptionConfig' => [
'RealtimeMetricsSubscriptionStatus' => 'Enabled|Disabled',
],
],
]
Result Details
Members
- MonitoringSubscription
-
- Type: MonitoringSubscription structure
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Errors
-
Access denied.
-
The specified distribution does not exist.
-
This operation is not supported in this region.
CreateOriginRequestPolicy
$result = $client->createOriginRequestPolicy([/* ... */]); $promise = $client->createOriginRequestPolicyAsync([/* ... */]);
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, andX-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.
Parameter Syntax
$result = $client->createOriginRequestPolicy([
'OriginRequestPolicyConfig' => [ // REQUIRED
'Comment' => '<string>',
'CookiesConfig' => [ // REQUIRED
'CookieBehavior' => 'none|whitelist|all', // REQUIRED
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'HeadersConfig' => [ // REQUIRED
'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront', // REQUIRED
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'Name' => '<string>', // REQUIRED
'QueryStringsConfig' => [ // REQUIRED
'QueryStringBehavior' => 'none|whitelist|all', // REQUIRED
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
],
]);
Parameter Details
Members
- OriginRequestPolicyConfig
-
- Required: Yes
- Type: OriginRequestPolicyConfig structure
An origin request policy configuration.
Result Syntax
[
'ETag' => '<string>',
'Location' => '<string>',
'OriginRequestPolicy' => [
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'OriginRequestPolicyConfig' => [
'Comment' => '<string>',
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Name' => '<string>',
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the origin request policy.
- Location
-
- Type: string
The fully qualified URI of the origin request policy just created.
- OriginRequestPolicy
-
- Type: OriginRequestPolicy structure
An origin request policy.
Errors
-
Access denied.
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
OriginRequestPolicyAlreadyExists:
An origin request policy with this name already exists. You must provide a unique name. To modify an existing origin request policy, use
UpdateOriginRequestPolicy. -
You have reached the maximum number of origin request policies for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyHeadersInOriginRequestPolicy:
The number of headers in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyCookiesInOriginRequestPolicy:
The number of cookies in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyQueryStringsInOriginRequestPolicy:
The number of query strings in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
CreatePublicKey
$result = $client->createPublicKey([/* ... */]); $promise = $client->createPublicKeyAsync([/* ... */]);
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
Parameter Syntax
$result = $client->createPublicKey([
'PublicKeyConfig' => [ // REQUIRED
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>',
'EncodedKey' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- PublicKeyConfig
-
- Required: Yes
- Type: PublicKeyConfig structure
A CloudFront public key configuration.
Result Syntax
[
'ETag' => '<string>',
'Location' => '<string>',
'PublicKey' => [
'CreatedTime' => <DateTime>,
'Id' => '<string>',
'PublicKeyConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'EncodedKey' => '<string>',
'Name' => '<string>',
],
],
]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the public key.
- Location
-
- Type: string
The URL of the public key.
- PublicKey
-
- Type: PublicKey structure
The public key.
Errors
-
The specified public key already exists.
-
An argument is invalid.
-
The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.
CreateRealtimeLogConfig
$result = $client->createRealtimeLogConfig([/* ... */]); $promise = $client->createRealtimeLogConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createRealtimeLogConfig([
'EndPoints' => [ // REQUIRED
[
'KinesisStreamConfig' => [
'RoleARN' => '<string>', // REQUIRED
'StreamARN' => '<string>', // REQUIRED
],
'StreamType' => '<string>', // REQUIRED
],
// ...
],
'Fields' => ['<string>', ...], // REQUIRED
'Name' => '<string>', // REQUIRED
'SamplingRate' => <integer>, // REQUIRED
]);
Parameter Details
Members
- EndPoints
-
- Required: Yes
- Type: Array of EndPoint structures
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
- Fields
-
- Required: Yes
- Type: Array of strings
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: Yes
- Type: string
A unique name to identify this real-time log configuration.
- SamplingRate
-
- Required: Yes
- Type: long (int|float)
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.
Result Syntax
[
'RealtimeLogConfig' => [
'ARN' => '<string>',
'EndPoints' => [
[
'KinesisStreamConfig' => [
'RoleARN' => '<string>',
'StreamARN' => '<string>',
],
'StreamType' => '<string>',
],
// ...
],
'Fields' => ['<string>', ...],
'Name' => '<string>',
'SamplingRate' => <integer>,
],
]
Result Details
Members
- RealtimeLogConfig
-
- Type: RealtimeLogConfig structure
A real-time log configuration.
Errors
-
RealtimeLogConfigAlreadyExists:
A real-time log configuration with this name already exists. You must provide a unique name. To modify an existing real-time log configuration, use
UpdateRealtimeLogConfig. -
You have reached the maximum number of real-time log configurations for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
An argument is invalid.
-
Access denied.
CreateResponseHeadersPolicy
$result = $client->createResponseHeadersPolicy([/* ... */]); $promise = $client->createResponseHeadersPolicyAsync([/* ... */]);
Creates a response headers policy.
A response headers policy contains information about a set of HTTP response headers and their values. To create a response headers policy, you provide some metadata about the policy, and a set of configurations that specify the response 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, CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match the cache behavior.
Parameter Syntax
$result = $client->createResponseHeadersPolicy([
'ResponseHeadersPolicyConfig' => [ // REQUIRED
'Comment' => '<string>',
'CorsConfig' => [
'AccessControlAllowCredentials' => true || false, // REQUIRED
'AccessControlAllowHeaders' => [ // REQUIRED
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'AccessControlAllowMethods' => [ // REQUIRED
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'AccessControlAllowOrigins' => [ // REQUIRED
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'AccessControlExposeHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'AccessControlMaxAgeSec' => <integer>,
'OriginOverride' => true || false, // REQUIRED
],
'CustomHeadersConfig' => [
'Items' => [
[
'Header' => '<string>', // REQUIRED
'Override' => true || false, // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'Name' => '<string>', // REQUIRED
'SecurityHeadersConfig' => [
'ContentSecurityPolicy' => [
'ContentSecurityPolicy' => '<string>', // REQUIRED
'Override' => true || false, // REQUIRED
],
'ContentTypeOptions' => [
'Override' => true || false, // REQUIRED
],
'FrameOptions' => [
'FrameOption' => 'DENY|SAMEORIGIN', // REQUIRED
'Override' => true || false, // REQUIRED
],
'ReferrerPolicy' => [
'Override' => true || false, // REQUIRED
'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url', // REQUIRED
],
'StrictTransportSecurity' => [
'AccessControlMaxAgeSec' => <integer>, // REQUIRED
'IncludeSubdomains' => true || false,
'Override' => true || false, // REQUIRED
'Preload' => true || false,
],
'XSSProtection' => [
'ModeBlock' => true || false,
'Override' => true || false, // REQUIRED
'Protection' => true || false, // REQUIRED
'ReportUri' => '<string>',
],
],
'ServerTimingHeadersConfig' => [
'Enabled' => true || false, // REQUIRED
'SamplingRate' => <float>,
],
],
]);
Parameter Details
Members
- ResponseHeadersPolicyConfig
-
- Required: Yes
- Type: ResponseHeadersPolicyConfig structure
Contains metadata about the response headers policy, and a set of configurations that specify the response headers.
Result Syntax
[
'ETag' => '<string>',
'Location' => '<string>',
'ResponseHeadersPolicy' => [
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'ResponseHeadersPolicyConfig' => [
'Comment' => '<string>',
'CorsConfig' => [
'AccessControlAllowCredentials' => true || false,
'AccessControlAllowHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowOrigins' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlExposeHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlMaxAgeSec' => <integer>,
'OriginOverride' => true || false,
],
'CustomHeadersConfig' => [
'Items' => [
[
'Header' => '<string>',
'Override' => true || false,
'Value' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Name' => '<string>',
'SecurityHeadersConfig' => [
'ContentSecurityPolicy' => [
'ContentSecurityPolicy' => '<string>',
'Override' => true || false,
],
'ContentTypeOptions' => [
'Override' => true || false,
],
'FrameOptions' => [
'FrameOption' => 'DENY|SAMEORIGIN',
'Override' => true || false,
],
'ReferrerPolicy' => [
'Override' => true || false,
'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url',
],
'StrictTransportSecurity' => [
'AccessControlMaxAgeSec' => <integer>,
'IncludeSubdomains' => true || false,
'Override' => true || false,
'Preload' => true || false,
],
'XSSProtection' => [
'ModeBlock' => true || false,
'Override' => true || false,
'Protection' => true || false,
'ReportUri' => '<string>',
],
],
'ServerTimingHeadersConfig' => [
'Enabled' => true || false,
'SamplingRate' => <float>,
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the response headers policy.
- Location
-
- Type: string
The URL of the response headers policy.
- ResponseHeadersPolicy
-
- Type: ResponseHeadersPolicy structure
Contains a response headers policy.
Errors
-
Access denied.
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
ResponseHeadersPolicyAlreadyExists:
A response headers policy with this name already exists. You must provide a unique name. To modify an existing response headers policy, use
UpdateResponseHeadersPolicy. -
TooManyResponseHeadersPolicies:
You have reached the maximum number of response headers policies for this Amazon Web Services account.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyCustomHeadersInResponseHeadersPolicy:
The number of custom headers in the response headers policy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooLongCSPInResponseHeadersPolicy:
The length of the
Content-Security-Policyheader value in the response headers policy exceeds the maximum.For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
CreateStreamingDistribution
$result = $client->createStreamingDistribution([/* ... */]); $promise = $client->createStreamingDistributionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createStreamingDistribution([
'StreamingDistributionConfig' => [ // REQUIRED
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
'Logging' => [
'Bucket' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
'Prefix' => '<string>', // REQUIRED
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'S3Origin' => [ // REQUIRED
'DomainName' => '<string>', // REQUIRED
'OriginAccessIdentity' => '<string>', // REQUIRED
],
'TrustedSigners' => [ // REQUIRED
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
]);
Parameter Details
Members
- StreamingDistributionConfig
-
- Required: Yes
- Type: StreamingDistributionConfig structure
The streaming distribution's configuration information.
Result Syntax
[
'ETag' => '<string>',
'Location' => '<string>',
'StreamingDistribution' => [
'ARN' => '<string>',
'ActiveTrustedSigners' => [
'Enabled' => true || false,
'Items' => [
[
'AwsAccountNumber' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'DomainName' => '<string>',
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'Status' => '<string>',
'StreamingDistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'S3Origin' => [
'DomainName' => '<string>',
'OriginAccessIdentity' => '<string>',
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the streaming distribution created.
- Location
-
- Type: string
The fully qualified URI of the new streaming distribution resource just created.
- StreamingDistribution
-
- Type: StreamingDistribution structure
The streaming distribution's information.
Errors
-
The CNAME specified is already defined for CloudFront.
-
StreamingDistributionAlreadyExists:
The caller reference you attempted to create the streaming distribution with is associated with another distribution
-
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
-
The origin access identity is not valid or doesn't exist.
-
Access denied.
-
Your request contains more trusted signers than are allowed per distribution.
-
One or more of your trusted signers don't exist.
-
This operation requires a body. Ensure that the body is present and the
Content-Typeheader is set. -
TooManyStreamingDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
-
TooManyStreamingDistributions:
Processing your request would cause you to exceed the maximum number of streaming distributions allowed.
-
An argument is invalid.
-
The value of
Quantityand the size ofItemsdon't match.
CreateStreamingDistributionWithTags
$result = $client->createStreamingDistributionWithTags([/* ... */]); $promise = $client->createStreamingDistributionWithTagsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createStreamingDistributionWithTags([
'StreamingDistributionConfigWithTags' => [ // REQUIRED
'StreamingDistributionConfig' => [ // REQUIRED
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
'Logging' => [
'Bucket' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
'Prefix' => '<string>', // REQUIRED
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'S3Origin' => [ // REQUIRED
'DomainName' => '<string>', // REQUIRED
'OriginAccessIdentity' => '<string>', // REQUIRED
],
'TrustedSigners' => [ // REQUIRED
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'Tags' => [ // REQUIRED
'Items' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
],
],
]);
Parameter Details
Members
- StreamingDistributionConfigWithTags
-
- Required: Yes
- Type: StreamingDistributionConfigWithTags structure
The streaming distribution's configuration information.
Result Syntax
[
'ETag' => '<string>',
'Location' => '<string>',
'StreamingDistribution' => [
'ARN' => '<string>',
'ActiveTrustedSigners' => [
'Enabled' => true || false,
'Items' => [
[
'AwsAccountNumber' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'DomainName' => '<string>',
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'Status' => '<string>',
'StreamingDistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'S3Origin' => [
'DomainName' => '<string>',
'OriginAccessIdentity' => '<string>',
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the distribution created.
- Location
-
- Type: string
The fully qualified URI of the new streaming distribution resource just created.
- StreamingDistribution
-
- Type: StreamingDistribution structure
The streaming distribution's information.
Errors
-
The CNAME specified is already defined for CloudFront.
-
StreamingDistributionAlreadyExists:
The caller reference you attempted to create the streaming distribution with is associated with another distribution
-
The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.
-
The origin access identity is not valid or doesn't exist.
-
Access denied.
-
Your request contains more trusted signers than are allowed per distribution.
-
One or more of your trusted signers don't exist.
-
This operation requires a body. Ensure that the body is present and the
Content-Typeheader is set. -
TooManyStreamingDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
-
TooManyStreamingDistributions:
Processing your request would cause you to exceed the maximum number of streaming distributions allowed.
-
An argument is invalid.
-
The value of
Quantityand the size ofItemsdon't match. -
The tagging specified is not valid.
DeleteCachePolicy
$result = $client->deleteCachePolicy([/* ... */]); $promise = $client->deleteCachePolicyAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteCachePolicy([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the cache policy that you are deleting. To get the identifier, you can use
ListCachePolicies. - IfMatch
-
- Type: string
The version of the cache policy that you are deleting. The version is the cache policy’s
ETagvalue, which you can get usingListCachePolicies,GetCachePolicy, orGetCachePolicyConfig.
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
The
If-Matchversion is missing or not valid. -
The cache policy does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
You cannot delete a managed policy.
-
Cannot delete the cache policy because it is attached to one or more cache behaviors.
DeleteCloudFrontOriginAccessIdentity
$result = $client->deleteCloudFrontOriginAccessIdentity([/* ... */]); $promise = $client->deleteCloudFrontOriginAccessIdentityAsync([/* ... */]);
Delete an origin access identity.
Parameter Syntax
$result = $client->deleteCloudFrontOriginAccessIdentity([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
The
If-Matchversion is missing or not valid. -
NoSuchCloudFrontOriginAccessIdentity:
The specified origin access identity does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
CloudFrontOriginAccessIdentityInUse:
The Origin Access Identity specified is already in use.
DeleteDistribution
$result = $client->deleteDistribution([/* ... */]); $promise = $client->deleteDistributionAsync([/* ... */]);
Delete a distribution.
Parameter Syntax
$result = $client->deleteDistribution([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.
-
The
If-Matchversion is missing or not valid. -
The specified distribution does not exist.
-
The precondition in one or more of the request fields evaluated to
false.
DeleteFieldLevelEncryptionConfig
$result = $client->deleteFieldLevelEncryptionConfig([/* ... */]); $promise = $client->deleteFieldLevelEncryptionConfigAsync([/* ... */]);
Remove a field-level encryption configuration.
Parameter Syntax
$result = $client->deleteFieldLevelEncryptionConfig([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
The
If-Matchversion is missing or not valid. -
NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
-
The precondition in one or more of the request fields evaluated to
false. -
FieldLevelEncryptionConfigInUse:
The specified configuration for field-level encryption is in use.
DeleteFieldLevelEncryptionProfile
$result = $client->deleteFieldLevelEncryptionProfile([/* ... */]); $promise = $client->deleteFieldLevelEncryptionProfileAsync([/* ... */]);
Remove a field-level encryption profile.
Parameter Syntax
$result = $client->deleteFieldLevelEncryptionProfile([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
The
If-Matchversion is missing or not valid. -
NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
-
The precondition in one or more of the request fields evaluated to
false. -
FieldLevelEncryptionProfileInUse:
The specified profile for field-level encryption is in use.
DeleteFunction
$result = $client->deleteFunction([/* ... */]); $promise = $client->deleteFunctionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteFunction([
'IfMatch' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The
If-Matchversion is missing or not valid. -
The function does not exist.
-
Cannot delete the function because it’s attached to one or more cache behaviors.
-
The precondition in one or more of the request fields evaluated to
false. -
This operation is not supported in this region.
DeleteKeyGroup
$result = $client->deleteKeyGroup([/* ... */]); $promise = $client->deleteKeyGroupAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteKeyGroup([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The
If-Matchversion is missing or not valid. -
A resource that was specified is not valid.
-
The precondition in one or more of the request fields evaluated to
false. -
Cannot delete this resource because it is in use.
DeleteMonitoringSubscription
$result = $client->deleteMonitoringSubscription([/* ... */]); $promise = $client->deleteMonitoringSubscriptionAsync([/* ... */]);
Disables additional CloudWatch metrics for the specified CloudFront distribution.
Parameter Syntax
$result = $client->deleteMonitoringSubscription([
'DistributionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
The specified distribution does not exist.
-
This operation is not supported in this region.
DeleteOriginRequestPolicy
$result = $client->deleteOriginRequestPolicy([/* ... */]); $promise = $client->deleteOriginRequestPolicyAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteOriginRequestPolicy([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use
ListOriginRequestPolicies. - IfMatch
-
- Type: string
The version of the origin request policy that you are deleting. The version is the origin request policy’s
ETagvalue, which you can get usingListOriginRequestPolicies,GetOriginRequestPolicy, orGetOriginRequestPolicyConfig.
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
The
If-Matchversion is missing or not valid. -
The origin request policy does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
You cannot delete a managed policy.
-
Cannot delete the origin request policy because it is attached to one or more cache behaviors.
DeletePublicKey
$result = $client->deletePublicKey([/* ... */]); $promise = $client->deletePublicKeyAsync([/* ... */]);
Remove a public key you previously added to CloudFront.
Parameter Syntax
$result = $client->deletePublicKey([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
The specified public key is in use.
-
The
If-Matchversion is missing or not valid. -
The specified public key doesn't exist.
-
The precondition in one or more of the request fields evaluated to
false.
DeleteRealtimeLogConfig
$result = $client->deleteRealtimeLogConfig([/* ... */]); $promise = $client->deleteRealtimeLogConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteRealtimeLogConfig([
'ARN' => '<string>',
'Name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The real-time log configuration does not exist.
-
Cannot delete the real-time log configuration because it is attached to one or more cache behaviors.
-
An argument is invalid.
-
Access denied.
DeleteResponseHeadersPolicy
$result = $client->deleteResponseHeadersPolicy([/* ... */]); $promise = $client->deleteResponseHeadersPolicyAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteResponseHeadersPolicy([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier for the response headers policy that you are deleting.
To get the identifier, you can use
ListResponseHeadersPolicies. - IfMatch
-
- Type: string
The version of the response headers policy that you are deleting.
The version is the response headers policy’s
ETagvalue, which you can get usingListResponseHeadersPolicies,GetResponseHeadersPolicy, orGetResponseHeadersPolicyConfig.
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
The
If-Matchversion is missing or not valid. -
The response headers policy does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
You cannot delete a managed policy.
-
Cannot delete the response headers policy because it is attached to one or more cache behaviors in a CloudFront distribution.
DeleteStreamingDistribution
$result = $client->deleteStreamingDistribution([/* ... */]); $promise = $client->deleteStreamingDistributionAsync([/* ... */]);
Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
-
Disable the RTMP distribution.
-
Submit a
GET Streaming Distribution Configrequest to get the current configuration and theEtagheader for the distribution. -
Update the XML document that was returned in the response to your
GET Streaming Distribution Configrequest to change the value ofEnabledtofalse. -
Submit a
PUT Streaming Distribution Configrequest 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 HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Streaming Distribution Configrequest in Step 2. -
Review the response to the
PUT Streaming Distribution Configrequest to confirm that the distribution was successfully disabled. -
Submit a
GET Streaming Distribution Configrequest to confirm that your changes have propagated. When propagation is complete, the value ofStatusisDeployed. -
Submit a
DELETE Streaming Distributionrequest. Set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Streaming Distribution Configrequest in Step 2. -
Review the response to your
DELETE Streaming Distributionrequest 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.
Parameter Syntax
$result = $client->deleteStreamingDistribution([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
StreamingDistributionNotDisabled:
The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.
-
The
If-Matchversion is missing or not valid. -
The specified streaming distribution does not exist.
-
The precondition in one or more of the request fields evaluated to
false.
DescribeFunction
$result = $client->describeFunction([/* ... */]); $promise = $client->describeFunctionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->describeFunction([
'Name' => '<string>', // REQUIRED
'Stage' => 'DEVELOPMENT|LIVE',
]);
Parameter Details
Members
Result Syntax
[
'ETag' => '<string>',
'FunctionSummary' => [
'FunctionConfig' => [
'Comment' => '<string>',
'Runtime' => 'cloudfront-js-1.0',
],
'FunctionMetadata' => [
'CreatedTime' => <DateTime>,
'FunctionARN' => '<string>',
'LastModifiedTime' => <DateTime>,
'Stage' => 'DEVELOPMENT|LIVE',
],
'Name' => '<string>',
'Status' => '<string>',
],
]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the CloudFront function.
- FunctionSummary
-
- Type: FunctionSummary structure
Contains configuration information and metadata about a CloudFront function.
Errors
-
The function does not exist.
-
This operation is not supported in this region.
GetCachePolicy
$result = $client->getCachePolicy([/* ... */]); $promise = $client->getCachePolicyAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getCachePolicy([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: 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
ListDistributionsorGetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier usingListCachePolicies.
Result Syntax
[
'CachePolicy' => [
'CachePolicyConfig' => [
'Comment' => '<string>',
'DefaultTTL' => <integer>,
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'Name' => '<string>',
'ParametersInCacheKeyAndForwardedToOrigin' => [
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|allExcept|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'EnableAcceptEncodingBrotli' => true || false,
'EnableAcceptEncodingGzip' => true || false,
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|allExcept|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
'ETag' => '<string>',
]
Result Details
Members
- CachePolicy
-
- Type: CachePolicy structure
The cache policy.
- ETag
-
- Type: string
The current version of the cache policy.
Errors
-
Access denied.
-
The cache policy does not exist.
GetCachePolicyConfig
$result = $client->getCachePolicyConfig([/* ... */]); $promise = $client->getCachePolicyConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getCachePolicyConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: 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
ListDistributionsorGetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier usingListCachePolicies.
Result Syntax
[
'CachePolicyConfig' => [
'Comment' => '<string>',
'DefaultTTL' => <integer>,
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'Name' => '<string>',
'ParametersInCacheKeyAndForwardedToOrigin' => [
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|allExcept|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'EnableAcceptEncodingBrotli' => true || false,
'EnableAcceptEncodingGzip' => true || false,
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|allExcept|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
],
'ETag' => '<string>',
]
Result Details
Members
- CachePolicyConfig
-
- Type: CachePolicyConfig structure
The cache policy configuration.
- ETag
-
- Type: string
The current version of the cache policy.
Errors
-
Access denied.
-
The cache policy does not exist.
GetCloudFrontOriginAccessIdentity
$result = $client->getCloudFrontOriginAccessIdentity([/* ... */]); $promise = $client->getCloudFrontOriginAccessIdentityAsync([/* ... */]);
Get the information about an origin access identity.
Parameter Syntax
$result = $client->getCloudFrontOriginAccessIdentity([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'CloudFrontOriginAccessIdentity' => [
'CloudFrontOriginAccessIdentityConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
],
'Id' => '<string>',
'S3CanonicalUserId' => '<string>',
],
'ETag' => '<string>',
]
Result Details
Members
- CloudFrontOriginAccessIdentity
-
- Type: CloudFrontOriginAccessIdentity structure
The origin access identity's information.
- ETag
-
- Type: string
The current version of the origin access identity's information. For example:
E2QWRUHAPOMQZL.
Errors
-
NoSuchCloudFrontOriginAccessIdentity:
The specified origin access identity does not exist.
-
Access denied.
GetCloudFrontOriginAccessIdentityConfig
$result = $client->getCloudFrontOriginAccessIdentityConfig([/* ... */]); $promise = $client->getCloudFrontOriginAccessIdentityConfigAsync([/* ... */]);
Get the configuration information about an origin access identity.
Parameter Syntax
$result = $client->getCloudFrontOriginAccessIdentityConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'CloudFrontOriginAccessIdentityConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
],
'ETag' => '<string>',
]
Result Details
Members
- CloudFrontOriginAccessIdentityConfig
-
- Type: CloudFrontOriginAccessIdentityConfig structure
The origin access identity's configuration information.
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL.
Errors
-
NoSuchCloudFrontOriginAccessIdentity:
The specified origin access identity does not exist.
-
Access denied.
GetDistribution
$result = $client->getDistribution([/* ... */]); $promise = $client->getDistributionAsync([/* ... */]);
Get the information about a distribution.
Parameter Syntax
$result = $client->getDistribution([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Distribution' => [
'ARN' => '<string>',
'ActiveTrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => [
[
'KeyGroupId' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'ActiveTrustedSigners' => [
'Enabled' => true || false,
'Items' => [
[
'AwsAccountNumber' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'AliasICPRecordals' => [
[
'CNAME' => '<string>',
'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
],
// ...
],
'DistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
// ...
],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>,
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'DefaultCacheBehavior' => [
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
'DefaultRootObject' => '<string>',
'Enabled' => true || false,
'HttpVersion' => 'http1.1|http2',
'IsIPV6Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'IncludeCookies' => true || false,
'Prefix' => '<string>',
],
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [
'StatusCodes' => [
'Items' => [<integer>, ...],
'Quantity' => <integer>,
],
],
'Id' => '<string>',
'Members' => [
'Items' => [
[
'OriginId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'Origins' => [
'Items' => [
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>',
'HeaderValue' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>,
'HTTPSPort' => <integer>,
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false,
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>',
],
],
// ...
],
'Quantity' => <integer>,
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
'RestrictionType' => 'blacklist|whitelist|none',
],
],
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
'DomainName' => '<string>',
'Id' => '<string>',
'InProgressInvalidationBatches' => <integer>,
'LastModifiedTime' => <DateTime>,
'Status' => '<string>',
],
'ETag' => '<string>',
]
Result Details
Members
- Distribution
-
- Type: Distribution structure
The distribution's information.
- ETag
-
- Type: string
The current version of the distribution's information. For example:
E2QWRUHAPOMQZL.
Errors
-
The specified distribution does not exist.
-
Access denied.
GetDistributionConfig
$result = $client->getDistributionConfig([/* ... */]); $promise = $client->getDistributionConfigAsync([/* ... */]);
Get the configuration information about a distribution.
Parameter Syntax
$result = $client->getDistributionConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
// ...
],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>,
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'DefaultCacheBehavior' => [
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
'DefaultRootObject' => '<string>',
'Enabled' => true || false,
'HttpVersion' => 'http1.1|http2',
'IsIPV6Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'IncludeCookies' => true || false,
'Prefix' => '<string>',
],
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [
'StatusCodes' => [
'Items' => [<integer>, ...],
'Quantity' => <integer>,
],
],
'Id' => '<string>',
'Members' => [
'Items' => [
[
'OriginId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'Origins' => [
'Items' => [
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>',
'HeaderValue' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>,
'HTTPSPort' => <integer>,
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false,
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>',
],
],
// ...
],
'Quantity' => <integer>,
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
'RestrictionType' => 'blacklist|whitelist|none',
],
],
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
'ETag' => '<string>',
]
Result Details
Members
- DistributionConfig
-
- Type: DistributionConfig structure
The distribution's configuration information.
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL.
Errors
-
The specified distribution does not exist.
-
Access denied.
GetFieldLevelEncryption
$result = $client->getFieldLevelEncryption([/* ... */]); $promise = $client->getFieldLevelEncryptionAsync([/* ... */]);
Get the field-level encryption configuration information.
Parameter Syntax
$result = $client->getFieldLevelEncryption([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ETag' => '<string>',
'FieldLevelEncryption' => [
'FieldLevelEncryptionConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'ContentTypeProfileConfig' => [
'ContentTypeProfiles' => [
'Items' => [
[
'ContentType' => '<string>',
'Format' => 'URLEncoded',
'ProfileId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'ForwardWhenContentTypeIsUnknown' => true || false,
],
'QueryArgProfileConfig' => [
'ForwardWhenQueryArgProfileIsUnknown' => true || false,
'QueryArgProfiles' => [
'Items' => [
[
'ProfileId' => '<string>',
'QueryArg' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption configuration. For example:
E2QWRUHAPOMQZL. - FieldLevelEncryption
-
- Type: FieldLevelEncryption structure
Return the field-level encryption configuration information.
Errors
-
Access denied.
-
NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
GetFieldLevelEncryptionConfig
$result = $client->getFieldLevelEncryptionConfig([/* ... */]); $promise = $client->getFieldLevelEncryptionConfigAsync([/* ... */]);
Get the field-level encryption configuration information.
Parameter Syntax
$result = $client->getFieldLevelEncryptionConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ETag' => '<string>',
'FieldLevelEncryptionConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'ContentTypeProfileConfig' => [
'ContentTypeProfiles' => [
'Items' => [
[
'ContentType' => '<string>',
'Format' => 'URLEncoded',
'ProfileId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'ForwardWhenContentTypeIsUnknown' => true || false,
],
'QueryArgProfileConfig' => [
'ForwardWhenQueryArgProfileIsUnknown' => true || false,
'QueryArgProfiles' => [
'Items' => [
[
'ProfileId' => '<string>',
'QueryArg' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption configuration. For example:
E2QWRUHAPOMQZL. - FieldLevelEncryptionConfig
-
- Type: FieldLevelEncryptionConfig structure
Return the field-level encryption configuration information.
Errors
-
Access denied.
-
NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
GetFieldLevelEncryptionProfile
$result = $client->getFieldLevelEncryptionProfile([/* ... */]); $promise = $client->getFieldLevelEncryptionProfileAsync([/* ... */]);
Get the field-level encryption profile information.
Parameter Syntax
$result = $client->getFieldLevelEncryptionProfile([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ETag' => '<string>',
'FieldLevelEncryptionProfile' => [
'FieldLevelEncryptionProfileConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'EncryptionEntities' => [
'Items' => [
[
'FieldPatterns' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ProviderId' => '<string>',
'PublicKeyId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Name' => '<string>',
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the field level encryption profile. For example:
E2QWRUHAPOMQZL. - FieldLevelEncryptionProfile
-
- Type: FieldLevelEncryptionProfile structure
Return the field-level encryption profile information.
Errors
-
Access denied.
-
NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
GetFieldLevelEncryptionProfileConfig
$result = $client->getFieldLevelEncryptionProfileConfig([/* ... */]); $promise = $client->getFieldLevelEncryptionProfileConfigAsync([/* ... */]);
Get the field-level encryption profile configuration information.
Parameter Syntax
$result = $client->getFieldLevelEncryptionProfileConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ETag' => '<string>',
'FieldLevelEncryptionProfileConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'EncryptionEntities' => [
'Items' => [
[
'FieldPatterns' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ProviderId' => '<string>',
'PublicKeyId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Name' => '<string>',
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the field-level encryption profile configuration result. For example:
E2QWRUHAPOMQZL. - FieldLevelEncryptionProfileConfig
-
- Type: FieldLevelEncryptionProfileConfig structure
Return the field-level encryption profile configuration information.
Errors
-
Access denied.
-
NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
GetFunction
$result = $client->getFunction([/* ... */]); $promise = $client->getFunctionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getFunction([
'Name' => '<string>', // REQUIRED
'Stage' => 'DEVELOPMENT|LIVE',
]);
Parameter Details
Members
Result Syntax
[
'ContentType' => '<string>',
'ETag' => '<string>',
'FunctionCode' => <string || resource || Psr\Http\Message\StreamInterface>,
]
Result Details
Members
Errors
-
The function does not exist.
-
This operation is not supported in this region.
GetInvalidation
$result = $client->getInvalidation([/* ... */]); $promise = $client->getInvalidationAsync([/* ... */]);
Get the information about an invalidation.
Parameter Syntax
$result = $client->getInvalidation([
'DistributionId' => '<string>', // REQUIRED
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Invalidation' => [
'CreateTime' => <DateTime>,
'Id' => '<string>',
'InvalidationBatch' => [
'CallerReference' => '<string>',
'Paths' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Status' => '<string>',
],
]
Result Details
Members
- Invalidation
-
- Type: Invalidation structure
The invalidation's information. For more information, see Invalidation Complex Type.
Errors
-
The specified invalidation does not exist.
-
The specified distribution does not exist.
-
Access denied.
GetKeyGroup
$result = $client->getKeyGroup([/* ... */]); $promise = $client->getKeyGroupAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getKeyGroup([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ETag' => '<string>',
'KeyGroup' => [
'Id' => '<string>',
'KeyGroupConfig' => [
'Comment' => '<string>',
'Items' => ['<string>', ...],
'Name' => '<string>',
],
'LastModifiedTime' => <DateTime>,
],
]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the key group.
- KeyGroup
-
- Type: KeyGroup structure
The key group.
Errors
-
A resource that was specified is not valid.
GetKeyGroupConfig
$result = $client->getKeyGroupConfig([/* ... */]); $promise = $client->getKeyGroupConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getKeyGroupConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ETag' => '<string>',
'KeyGroupConfig' => [
'Comment' => '<string>',
'Items' => ['<string>', ...],
'Name' => '<string>',
],
]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the key group.
- KeyGroupConfig
-
- Type: KeyGroupConfig structure
The key group configuration.
Errors
-
A resource that was specified is not valid.
GetMonitoringSubscription
$result = $client->getMonitoringSubscription([/* ... */]); $promise = $client->getMonitoringSubscriptionAsync([/* ... */]);
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
Parameter Syntax
$result = $client->getMonitoringSubscription([
'DistributionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'MonitoringSubscription' => [
'RealtimeMetricsSubscriptionConfig' => [
'RealtimeMetricsSubscriptionStatus' => 'Enabled|Disabled',
],
],
]
Result Details
Members
- MonitoringSubscription
-
- Type: MonitoringSubscription structure
A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Errors
-
Access denied.
-
The specified distribution does not exist.
-
This operation is not supported in this region.
GetOriginRequestPolicy
$result = $client->getOriginRequestPolicy([/* ... */]); $promise = $client->getOriginRequestPolicyAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getOriginRequestPolicy([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: 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
ListDistributionsorGetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier usingListOriginRequestPolicies.
Result Syntax
[
'ETag' => '<string>',
'OriginRequestPolicy' => [
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'OriginRequestPolicyConfig' => [
'Comment' => '<string>',
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Name' => '<string>',
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the origin request policy.
- OriginRequestPolicy
-
- Type: OriginRequestPolicy structure
The origin request policy.
Errors
-
Access denied.
-
The origin request policy does not exist.
GetOriginRequestPolicyConfig
$result = $client->getOriginRequestPolicyConfig([/* ... */]); $promise = $client->getOriginRequestPolicyConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getOriginRequestPolicyConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: 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
ListDistributionsorGetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier usingListOriginRequestPolicies.
Result Syntax
[
'ETag' => '<string>',
'OriginRequestPolicyConfig' => [
'Comment' => '<string>',
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Name' => '<string>',
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the origin request policy.
- OriginRequestPolicyConfig
-
- Type: OriginRequestPolicyConfig structure
The origin request policy configuration.
Errors
-
Access denied.
-
The origin request policy does not exist.
GetPublicKey
$result = $client->getPublicKey([/* ... */]); $promise = $client->getPublicKeyAsync([/* ... */]);
Gets a public key.
Parameter Syntax
$result = $client->getPublicKey([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ETag' => '<string>',
'PublicKey' => [
'CreatedTime' => <DateTime>,
'Id' => '<string>',
'PublicKeyConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'EncodedKey' => '<string>',
'Name' => '<string>',
],
],
]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the public key.
- PublicKey
-
- Type: PublicKey structure
The public key.
Errors
-
Access denied.
-
The specified public key doesn't exist.
GetPublicKeyConfig
$result = $client->getPublicKeyConfig([/* ... */]); $promise = $client->getPublicKeyConfigAsync([/* ... */]);
Gets a public key configuration.
Parameter Syntax
$result = $client->getPublicKeyConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ETag' => '<string>',
'PublicKeyConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'EncodedKey' => '<string>',
'Name' => '<string>',
],
]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the public key configuration.
- PublicKeyConfig
-
- Type: PublicKeyConfig structure
A public key configuration.
Errors
-
Access denied.
-
The specified public key doesn't exist.
GetRealtimeLogConfig
$result = $client->getRealtimeLogConfig([/* ... */]); $promise = $client->getRealtimeLogConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getRealtimeLogConfig([
'ARN' => '<string>',
'Name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'RealtimeLogConfig' => [
'ARN' => '<string>',
'EndPoints' => [
[
'KinesisStreamConfig' => [
'RoleARN' => '<string>',
'StreamARN' => '<string>',
],
'StreamType' => '<string>',
],
// ...
],
'Fields' => ['<string>', ...],
'Name' => '<string>',
'SamplingRate' => <integer>,
],
]
Result Details
Members
- RealtimeLogConfig
-
- Type: RealtimeLogConfig structure
A real-time log configuration.
Errors
-
The real-time log configuration does not exist.
-
An argument is invalid.
-
Access denied.
GetResponseHeadersPolicy
$result = $client->getResponseHeadersPolicy([/* ... */]); $promise = $client->getResponseHeadersPolicyAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getResponseHeadersPolicy([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: 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
ListDistributionsorGetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier usingListResponseHeadersPolicies.
Result Syntax
[
'ETag' => '<string>',
'ResponseHeadersPolicy' => [
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'ResponseHeadersPolicyConfig' => [
'Comment' => '<string>',
'CorsConfig' => [
'AccessControlAllowCredentials' => true || false,
'AccessControlAllowHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowOrigins' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlExposeHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlMaxAgeSec' => <integer>,
'OriginOverride' => true || false,
],
'CustomHeadersConfig' => [
'Items' => [
[
'Header' => '<string>',
'Override' => true || false,
'Value' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Name' => '<string>',
'SecurityHeadersConfig' => [
'ContentSecurityPolicy' => [
'ContentSecurityPolicy' => '<string>',
'Override' => true || false,
],
'ContentTypeOptions' => [
'Override' => true || false,
],
'FrameOptions' => [
'FrameOption' => 'DENY|SAMEORIGIN',
'Override' => true || false,
],
'ReferrerPolicy' => [
'Override' => true || false,
'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url',
],
'StrictTransportSecurity' => [
'AccessControlMaxAgeSec' => <integer>,
'IncludeSubdomains' => true || false,
'Override' => true || false,
'Preload' => true || false,
],
'XSSProtection' => [
'ModeBlock' => true || false,
'Override' => true || false,
'Protection' => true || false,
'ReportUri' => '<string>',
],
],
'ServerTimingHeadersConfig' => [
'Enabled' => true || false,
'SamplingRate' => <float>,
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the response headers policy.
- ResponseHeadersPolicy
-
- Type: ResponseHeadersPolicy structure
Contains a response headers policy.
Errors
-
Access denied.
-
The response headers policy does not exist.
GetResponseHeadersPolicyConfig
$result = $client->getResponseHeadersPolicyConfig([/* ... */]); $promise = $client->getResponseHeadersPolicyConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getResponseHeadersPolicyConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: 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
ListDistributionsorGetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier usingListResponseHeadersPolicies.
Result Syntax
[
'ETag' => '<string>',
'ResponseHeadersPolicyConfig' => [
'Comment' => '<string>',
'CorsConfig' => [
'AccessControlAllowCredentials' => true || false,
'AccessControlAllowHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowOrigins' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlExposeHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlMaxAgeSec' => <integer>,
'OriginOverride' => true || false,
],
'CustomHeadersConfig' => [
'Items' => [
[
'Header' => '<string>',
'Override' => true || false,
'Value' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Name' => '<string>',
'SecurityHeadersConfig' => [
'ContentSecurityPolicy' => [
'ContentSecurityPolicy' => '<string>',
'Override' => true || false,
],
'ContentTypeOptions' => [
'Override' => true || false,
],
'FrameOptions' => [
'FrameOption' => 'DENY|SAMEORIGIN',
'Override' => true || false,
],
'ReferrerPolicy' => [
'Override' => true || false,
'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url',
],
'StrictTransportSecurity' => [
'AccessControlMaxAgeSec' => <integer>,
'IncludeSubdomains' => true || false,
'Override' => true || false,
'Preload' => true || false,
],
'XSSProtection' => [
'ModeBlock' => true || false,
'Override' => true || false,
'Protection' => true || false,
'ReportUri' => '<string>',
],
],
'ServerTimingHeadersConfig' => [
'Enabled' => true || false,
'SamplingRate' => <float>,
],
],
]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the response headers policy.
- ResponseHeadersPolicyConfig
-
- Type: ResponseHeadersPolicyConfig structure
Contains a response headers policy.
Errors
-
Access denied.
-
The response headers policy does not exist.
GetStreamingDistribution
$result = $client->getStreamingDistribution([/* ... */]); $promise = $client->getStreamingDistributionAsync([/* ... */]);
Gets information about a specified RTMP distribution, including the distribution configuration.
Parameter Syntax
$result = $client->getStreamingDistribution([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ETag' => '<string>',
'StreamingDistribution' => [
'ARN' => '<string>',
'ActiveTrustedSigners' => [
'Enabled' => true || false,
'Items' => [
[
'AwsAccountNumber' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'DomainName' => '<string>',
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'Status' => '<string>',
'StreamingDistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'S3Origin' => [
'DomainName' => '<string>',
'OriginAccessIdentity' => '<string>',
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the streaming distribution's information. For example:
E2QWRUHAPOMQZL. - StreamingDistribution
-
- Type: StreamingDistribution structure
The streaming distribution's information.
Errors
-
The specified streaming distribution does not exist.
-
Access denied.
GetStreamingDistributionConfig
$result = $client->getStreamingDistributionConfig([/* ... */]); $promise = $client->getStreamingDistributionConfigAsync([/* ... */]);
Get the configuration information about a streaming distribution.
Parameter Syntax
$result = $client->getStreamingDistributionConfig([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ETag' => '<string>',
'StreamingDistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'S3Origin' => [
'DomainName' => '<string>',
'OriginAccessIdentity' => '<string>',
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL. - StreamingDistributionConfig
-
- Type: StreamingDistributionConfig structure
The streaming distribution's configuration information.
Errors
-
The specified streaming distribution does not exist.
-
Access denied.
ListCachePolicies
$result = $client->listCachePolicies([/* ... */]); $promise = $client->listCachePoliciesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listCachePolicies([
'Marker' => '<string>',
'MaxItems' => '<string>',
'Type' => 'managed|custom',
]);
Parameter Details
Members
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of cache policies that you want in the response.
- Type
-
- 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.
Result Syntax
[
'CachePolicyList' => [
'Items' => [
[
'CachePolicy' => [
'CachePolicyConfig' => [
'Comment' => '<string>',
'DefaultTTL' => <integer>,
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'Name' => '<string>',
'ParametersInCacheKeyAndForwardedToOrigin' => [
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|allExcept|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'EnableAcceptEncodingBrotli' => true || false,
'EnableAcceptEncodingGzip' => true || false,
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|allExcept|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
'Type' => 'managed|custom',
],
// ...
],
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- CachePolicyList
-
- Type: CachePolicyList structure
A list of cache policies.
Errors
-
Access denied.
-
The cache policy does not exist.
-
An argument is invalid.
ListCloudFrontOriginAccessIdentities
$result = $client->listCloudFrontOriginAccessIdentities([/* ... */]); $promise = $client->listCloudFrontOriginAccessIdentitiesAsync([/* ... */]);
Lists origin access identities.
Parameter Syntax
$result = $client->listCloudFrontOriginAccessIdentities([
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- Marker
-
- Type: 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
Markerto the value of theNextMarkerfrom the current page's response (which is also the ID of the last identity on that page). - MaxItems
-
- Type: string
The maximum number of origin access identities you want in the response body.
Result Syntax
[
'CloudFrontOriginAccessIdentityList' => [
'IsTruncated' => true || false,
'Items' => [
[
'Comment' => '<string>',
'Id' => '<string>',
'S3CanonicalUserId' => '<string>',
],
// ...
],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- CloudFrontOriginAccessIdentityList
-
- Type: CloudFrontOriginAccessIdentityList structure
The
CloudFrontOriginAccessIdentityListtype.
Errors
-
An argument is invalid.
ListConflictingAliases
$result = $client->listConflictingAliases([/* ... */]); $promise = $client->listConflictingAliasesAsync([/* ... */]);
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Parameter Syntax
$result = $client->listConflictingAliases([
'Alias' => '<string>', // REQUIRED
'DistributionId' => '<string>', // REQUIRED
'Marker' => '<string>',
'MaxItems' => <integer>,
]);
Parameter Details
Members
- Alias
-
- Required: Yes
- Type: string
The alias (also called a CNAME) to search for conflicting aliases.
- DistributionId
-
- Required: Yes
- Type: string
The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: int
The maximum number of conflicting aliases that you want in the response.
Result Syntax
[
'ConflictingAliasesList' => [
'Items' => [
[
'AccountId' => '<string>',
'Alias' => '<string>',
'DistributionId' => '<string>',
],
// ...
],
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- ConflictingAliasesList
-
- Type: ConflictingAliasesList structure
A list of conflicting aliases.
Errors
-
An argument is invalid.
-
The specified distribution does not exist.
ListDistributions
$result = $client->listDistributions([/* ... */]); $promise = $client->listDistributionsAsync([/* ... */]);
List CloudFront distributions.
Parameter Syntax
$result = $client->listDistributions([
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- Marker
-
- Type: 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
Markerto the value of theNextMarkerfrom the current page's response (which is also the ID of the last distribution on that page). - MaxItems
-
- Type: string
The maximum number of distributions you want in the response body.
Result Syntax
[
'DistributionList' => [
'IsTruncated' => true || false,
'Items' => [
[
'ARN' => '<string>',
'AliasICPRecordals' => [
[
'CNAME' => '<string>',
'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
],
// ...
],
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
// ...
],
'Quantity' => <integer>,
],
'Comment' => '<string>',
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>,
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'DefaultCacheBehavior' => [
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
'DomainName' => '<string>',
'Enabled' => true || false,
'HttpVersion' => 'http1.1|http2',
'Id' => '<string>',
'IsIPV6Enabled' => true || false,
'LastModifiedTime' => <DateTime>,
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [
'StatusCodes' => [
'Items' => [<integer>, ...],
'Quantity' => <integer>,
],
],
'Id' => '<string>',
'Members' => [
'Items' => [
[
'OriginId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'Origins' => [
'Items' => [
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>',
'HeaderValue' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>,
'HTTPSPort' => <integer>,
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false,
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>',
],
],
// ...
],
'Quantity' => <integer>,
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
'RestrictionType' => 'blacklist|whitelist|none',
],
],
'Status' => '<string>',
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
// ...
],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- DistributionList
-
- Type: DistributionList structure
The
DistributionListtype.
Errors
-
An argument is invalid.
ListDistributionsByCachePolicyId
$result = $client->listDistributionsByCachePolicyId([/* ... */]); $promise = $client->listDistributionsByCachePolicyIdAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listDistributionsByCachePolicyId([
'CachePolicyId' => '<string>', // REQUIRED
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- CachePolicyId
-
- Required: Yes
- Type: string
The ID of the cache policy whose associated distribution IDs you want to list.
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of distribution IDs that you want in the response.
Result Syntax
[
'DistributionIdList' => [
'IsTruncated' => true || false,
'Items' => ['<string>', ...],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- DistributionIdList
-
- Type: DistributionIdList structure
A list of distribution IDs.
Errors
-
The cache policy does not exist.
-
An argument is invalid.
-
Access denied.
ListDistributionsByKeyGroup
$result = $client->listDistributionsByKeyGroup([/* ... */]); $promise = $client->listDistributionsByKeyGroupAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listDistributionsByKeyGroup([
'KeyGroupId' => '<string>', // REQUIRED
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- KeyGroupId
-
- Required: Yes
- Type: string
The ID of the key group whose associated distribution IDs you are listing.
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of distribution IDs that you want in the response.
Result Syntax
[
'DistributionIdList' => [
'IsTruncated' => true || false,
'Items' => ['<string>', ...],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- DistributionIdList
-
- Type: DistributionIdList structure
A list of distribution IDs.
Errors
-
A resource that was specified is not valid.
-
An argument is invalid.
ListDistributionsByOriginRequestPolicyId
$result = $client->listDistributionsByOriginRequestPolicyId([/* ... */]); $promise = $client->listDistributionsByOriginRequestPolicyIdAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listDistributionsByOriginRequestPolicyId([
'Marker' => '<string>',
'MaxItems' => '<string>',
'OriginRequestPolicyId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of distribution IDs that you want in the response.
- OriginRequestPolicyId
-
- Required: Yes
- Type: string
The ID of the origin request policy whose associated distribution IDs you want to list.
Result Syntax
[
'DistributionIdList' => [
'IsTruncated' => true || false,
'Items' => ['<string>', ...],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- DistributionIdList
-
- Type: DistributionIdList structure
A list of distribution IDs.
Errors
-
The origin request policy does not exist.
-
An argument is invalid.
-
Access denied.
ListDistributionsByRealtimeLogConfig
$result = $client->listDistributionsByRealtimeLogConfig([/* ... */]); $promise = $client->listDistributionsByRealtimeLogConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listDistributionsByRealtimeLogConfig([
'Marker' => '<string>',
'MaxItems' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'RealtimeLogConfigName' => '<string>',
]);
Parameter Details
Members
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of distributions that you want in the response.
- RealtimeLogConfigArn
-
- Type: string
The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.
- RealtimeLogConfigName
-
- Type: string
The name of the real-time log configuration whose associated distributions you want to list.
Result Syntax
[
'DistributionList' => [
'IsTruncated' => true || false,
'Items' => [
[
'ARN' => '<string>',
'AliasICPRecordals' => [
[
'CNAME' => '<string>',
'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
],
// ...
],
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
// ...
],
'Quantity' => <integer>,
],
'Comment' => '<string>',
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>,
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'DefaultCacheBehavior' => [
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
'DomainName' => '<string>',
'Enabled' => true || false,
'HttpVersion' => 'http1.1|http2',
'Id' => '<string>',
'IsIPV6Enabled' => true || false,
'LastModifiedTime' => <DateTime>,
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [
'StatusCodes' => [
'Items' => [<integer>, ...],
'Quantity' => <integer>,
],
],
'Id' => '<string>',
'Members' => [
'Items' => [
[
'OriginId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'Origins' => [
'Items' => [
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>',
'HeaderValue' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>,
'HTTPSPort' => <integer>,
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false,
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>',
],
],
// ...
],
'Quantity' => <integer>,
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
'RestrictionType' => 'blacklist|whitelist|none',
],
],
'Status' => '<string>',
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
// ...
],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- DistributionList
-
- Type: DistributionList structure
A distribution list.
Errors
-
An argument is invalid.
ListDistributionsByResponseHeadersPolicyId
$result = $client->listDistributionsByResponseHeadersPolicyId([/* ... */]); $promise = $client->listDistributionsByResponseHeadersPolicyIdAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listDistributionsByResponseHeadersPolicyId([
'Marker' => '<string>',
'MaxItems' => '<string>',
'ResponseHeadersPolicyId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of distribution IDs that you want to get in the response.
- ResponseHeadersPolicyId
-
- Required: Yes
- Type: string
The ID of the response headers policy whose associated distribution IDs you want to list.
Result Syntax
[
'DistributionIdList' => [
'IsTruncated' => true || false,
'Items' => ['<string>', ...],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- DistributionIdList
-
- Type: DistributionIdList structure
A list of distribution IDs.
Errors
-
The response headers policy does not exist.
-
An argument is invalid.
-
Access denied.
ListDistributionsByWebACLId
$result = $client->listDistributionsByWebACLId([/* ... */]); $promise = $client->listDistributionsByWebACLIdAsync([/* ... */]);
List the distributions that are associated with a specified WAF web ACL.
Parameter Syntax
$result = $client->listDistributionsByWebACLId([
'Marker' => '<string>',
'MaxItems' => '<string>',
'WebACLId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Marker
-
- Type: string
Use
MarkerandMaxItemsto control pagination of results. If you have more thanMaxItemsdistributions that satisfy the request, the response includes aNextMarkerelement. To get the next page of results, submit another request. For the value ofMarker, specify the value ofNextMarkerfrom the last response. (For the first request, omitMarker.) - MaxItems
-
- Type: string
The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
- WebACLId
-
- Required: Yes
- Type: 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.
Result Syntax
[
'DistributionList' => [
'IsTruncated' => true || false,
'Items' => [
[
'ARN' => '<string>',
'AliasICPRecordals' => [
[
'CNAME' => '<string>',
'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
],
// ...
],
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
// ...
],
'Quantity' => <integer>,
],
'Comment' => '<string>',
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>,
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'DefaultCacheBehavior' => [
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
'DomainName' => '<string>',
'Enabled' => true || false,
'HttpVersion' => 'http1.1|http2',
'Id' => '<string>',
'IsIPV6Enabled' => true || false,
'LastModifiedTime' => <DateTime>,
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [
'StatusCodes' => [
'Items' => [<integer>, ...],
'Quantity' => <integer>,
],
],
'Id' => '<string>',
'Members' => [
'Items' => [
[
'OriginId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'Origins' => [
'Items' => [
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>',
'HeaderValue' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>,
'HTTPSPort' => <integer>,
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false,
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>',
],
],
// ...
],
'Quantity' => <integer>,
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
'RestrictionType' => 'blacklist|whitelist|none',
],
],
'Status' => '<string>',
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
// ...
],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- DistributionList
-
- Type: DistributionList structure
The
DistributionListtype.
Errors
-
An argument is invalid.
-
A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a.
ListFieldLevelEncryptionConfigs
$result = $client->listFieldLevelEncryptionConfigs([/* ... */]); $promise = $client->listFieldLevelEncryptionConfigsAsync([/* ... */]);
List all field-level encryption configurations that have been created in CloudFront for this account.
Parameter Syntax
$result = $client->listFieldLevelEncryptionConfigs([
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- Marker
-
- Type: 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
Markerto the value of theNextMarkerfrom the current page's response (which is also the ID of the last configuration on that page). - MaxItems
-
- Type: string
The maximum number of field-level encryption configurations you want in the response body.
Result Syntax
[
'FieldLevelEncryptionList' => [
'Items' => [
[
'Comment' => '<string>',
'ContentTypeProfileConfig' => [
'ContentTypeProfiles' => [
'Items' => [
[
'ContentType' => '<string>',
'Format' => 'URLEncoded',
'ProfileId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'ForwardWhenContentTypeIsUnknown' => true || false,
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'QueryArgProfileConfig' => [
'ForwardWhenQueryArgProfileIsUnknown' => true || false,
'QueryArgProfiles' => [
'Items' => [
[
'ProfileId' => '<string>',
'QueryArg' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
],
// ...
],
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- FieldLevelEncryptionList
-
- Type: FieldLevelEncryptionList structure
Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.
Errors
-
An argument is invalid.
ListFieldLevelEncryptionProfiles
$result = $client->listFieldLevelEncryptionProfiles([/* ... */]); $promise = $client->listFieldLevelEncryptionProfilesAsync([/* ... */]);
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
Parameter Syntax
$result = $client->listFieldLevelEncryptionProfiles([
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- Marker
-
- Type: 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
Markerto the value of theNextMarkerfrom the current page's response (which is also the ID of the last profile on that page). - MaxItems
-
- Type: string
The maximum number of field-level encryption profiles you want in the response body.
Result Syntax
[
'FieldLevelEncryptionProfileList' => [
'Items' => [
[
'Comment' => '<string>',
'EncryptionEntities' => [
'Items' => [
[
'FieldPatterns' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ProviderId' => '<string>',
'PublicKeyId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'Name' => '<string>',
],
// ...
],
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- FieldLevelEncryptionProfileList
-
- Type: FieldLevelEncryptionProfileList structure
Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.
Errors
-
An argument is invalid.
ListFunctions
$result = $client->listFunctions([/* ... */]); $promise = $client->listFunctionsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listFunctions([
'Marker' => '<string>',
'MaxItems' => '<string>',
'Stage' => 'DEVELOPMENT|LIVE',
]);
Parameter Details
Members
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of functions that you want in the response.
- Stage
-
- Type: string
An optional filter to return only the functions that are in the specified stage, either
DEVELOPMENTorLIVE.
Result Syntax
[
'FunctionList' => [
'Items' => [
[
'FunctionConfig' => [
'Comment' => '<string>',
'Runtime' => 'cloudfront-js-1.0',
],
'FunctionMetadata' => [
'CreatedTime' => <DateTime>,
'FunctionARN' => '<string>',
'LastModifiedTime' => <DateTime>,
'Stage' => 'DEVELOPMENT|LIVE',
],
'Name' => '<string>',
'Status' => '<string>',
],
// ...
],
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- FunctionList
-
- Type: FunctionList structure
A list of CloudFront functions.
Errors
-
An argument is invalid.
-
This operation is not supported in this region.
ListInvalidations
$result = $client->listInvalidations([/* ... */]); $promise = $client->listInvalidationsAsync([/* ... */]);
Lists invalidation batches.
Parameter Syntax
$result = $client->listInvalidations([
'DistributionId' => '<string>', // REQUIRED
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- DistributionId
-
- Required: Yes
- Type: string
The distribution's ID.
- Marker
-
- Type: 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
Markerto the value of theNextMarkerfrom the current page's response. This value is the same as the ID of the last invalidation batch on that page. - MaxItems
-
- Type: string
The maximum number of invalidation batches that you want in the response body.
Result Syntax
[
'InvalidationList' => [
'IsTruncated' => true || false,
'Items' => [
[
'CreateTime' => <DateTime>,
'Id' => '<string>',
'Status' => '<string>',
],
// ...
],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- InvalidationList
-
- Type: InvalidationList structure
Information about invalidation batches.
Errors
-
An argument is invalid.
-
The specified distribution does not exist.
-
Access denied.
ListKeyGroups
$result = $client->listKeyGroups([/* ... */]); $promise = $client->listKeyGroupsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listKeyGroups([
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of key groups that you want in the response.
Result Syntax
[
'KeyGroupList' => [
'Items' => [
[
'KeyGroup' => [
'Id' => '<string>',
'KeyGroupConfig' => [
'Comment' => '<string>',
'Items' => ['<string>', ...],
'Name' => '<string>',
],
'LastModifiedTime' => <DateTime>,
],
],
// ...
],
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- KeyGroupList
-
- Type: KeyGroupList structure
A list of key groups.
Errors
-
An argument is invalid.
ListOriginRequestPolicies
$result = $client->listOriginRequestPolicies([/* ... */]); $promise = $client->listOriginRequestPoliciesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listOriginRequestPolicies([
'Marker' => '<string>',
'MaxItems' => '<string>',
'Type' => 'managed|custom',
]);
Parameter Details
Members
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of origin request policies that you want in the response.
- Type
-
- 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.
Result Syntax
[
'OriginRequestPolicyList' => [
'Items' => [
[
'OriginRequestPolicy' => [
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'OriginRequestPolicyConfig' => [
'Comment' => '<string>',
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Name' => '<string>',
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
],
'Type' => 'managed|custom',
],
// ...
],
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- OriginRequestPolicyList
-
- Type: OriginRequestPolicyList structure
A list of origin request policies.
Errors
-
Access denied.
-
The origin request policy does not exist.
-
An argument is invalid.
ListPublicKeys
$result = $client->listPublicKeys([/* ... */]); $promise = $client->listPublicKeysAsync([/* ... */]);
List all public keys that have been added to CloudFront for this account.
Parameter Syntax
$result = $client->listPublicKeys([
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- Marker
-
- Type: 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
Markerto the value of theNextMarkerfrom the current page's response (which is also the ID of the last public key on that page). - MaxItems
-
- Type: string
The maximum number of public keys you want in the response body.
Result Syntax
[
'PublicKeyList' => [
'Items' => [
[
'Comment' => '<string>',
'CreatedTime' => <DateTime>,
'EncodedKey' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
],
// ...
],
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- PublicKeyList
-
- Type: PublicKeyList structure
Returns a list of all public keys that have been added to CloudFront for this account.
Errors
-
An argument is invalid.
ListRealtimeLogConfigs
$result = $client->listRealtimeLogConfigs([/* ... */]); $promise = $client->listRealtimeLogConfigsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listRealtimeLogConfigs([
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of real-time log configurations that you want in the response.
Result Syntax
[
'RealtimeLogConfigs' => [
'IsTruncated' => true || false,
'Items' => [
[
'ARN' => '<string>',
'EndPoints' => [
[
'KinesisStreamConfig' => [
'RoleARN' => '<string>',
'StreamARN' => '<string>',
],
'StreamType' => '<string>',
],
// ...
],
'Fields' => ['<string>', ...],
'Name' => '<string>',
'SamplingRate' => <integer>,
],
// ...
],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
],
]
Result Details
Members
- RealtimeLogConfigs
-
- Type: RealtimeLogConfigs structure
A list of real-time log configurations.
Errors
-
An argument is invalid.
-
Access denied.
-
The real-time log configuration does not exist.
ListResponseHeadersPolicies
$result = $client->listResponseHeadersPolicies([/* ... */]); $promise = $client->listResponseHeadersPoliciesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listResponseHeadersPolicies([
'Marker' => '<string>',
'MaxItems' => '<string>',
'Type' => 'managed|custom',
]);
Parameter Details
Members
- Marker
-
- Type: 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
NextMarkerfrom the current page’s response. - MaxItems
-
- Type: string
The maximum number of response headers policies that you want to get in the response.
- Type
-
- 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.
Result Syntax
[
'ResponseHeadersPolicyList' => [
'Items' => [
[
'ResponseHeadersPolicy' => [
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'ResponseHeadersPolicyConfig' => [
'Comment' => '<string>',
'CorsConfig' => [
'AccessControlAllowCredentials' => true || false,
'AccessControlAllowHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowOrigins' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlExposeHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlMaxAgeSec' => <integer>,
'OriginOverride' => true || false,
],
'CustomHeadersConfig' => [
'Items' => [
[
'Header' => '<string>',
'Override' => true || false,
'Value' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Name' => '<string>',
'SecurityHeadersConfig' => [
'ContentSecurityPolicy' => [
'ContentSecurityPolicy' => '<string>',
'Override' => true || false,
],
'ContentTypeOptions' => [
'Override' => true || false,
],
'FrameOptions' => [
'FrameOption' => 'DENY|SAMEORIGIN',
'Override' => true || false,
],
'ReferrerPolicy' => [
'Override' => true || false,
'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url',
],
'StrictTransportSecurity' => [
'AccessControlMaxAgeSec' => <integer>,
'IncludeSubdomains' => true || false,
'Override' => true || false,
'Preload' => true || false,
],
'XSSProtection' => [
'ModeBlock' => true || false,
'Override' => true || false,
'Protection' => true || false,
'ReportUri' => '<string>',
],
],
'ServerTimingHeadersConfig' => [
'Enabled' => true || false,
'SamplingRate' => <float>,
],
],
],
'Type' => 'managed|custom',
],
// ...
],
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- ResponseHeadersPolicyList
-
- Type: ResponseHeadersPolicyList structure
A list of response headers policies.
Errors
-
Access denied.
-
The response headers policy does not exist.
-
An argument is invalid.
ListStreamingDistributions
$result = $client->listStreamingDistributions([/* ... */]); $promise = $client->listStreamingDistributionsAsync([/* ... */]);
List streaming distributions.
Parameter Syntax
$result = $client->listStreamingDistributions([
'Marker' => '<string>',
'MaxItems' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'StreamingDistributionList' => [
'IsTruncated' => true || false,
'Items' => [
[
'ARN' => '<string>',
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Comment' => '<string>',
'DomainName' => '<string>',
'Enabled' => true || false,
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'S3Origin' => [
'DomainName' => '<string>',
'OriginAccessIdentity' => '<string>',
],
'Status' => '<string>',
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Marker' => '<string>',
'MaxItems' => <integer>,
'NextMarker' => '<string>',
'Quantity' => <integer>,
],
]
Result Details
Members
- StreamingDistributionList
-
- Type: StreamingDistributionList structure
The
StreamingDistributionListtype.
Errors
-
An argument is invalid.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
List tags for a CloudFront resource.
Parameter Syntax
$result = $client->listTagsForResource([
'Resource' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => [
'Items' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Tags
-
- Required: Yes
- Type: Tags structure
A complex type that contains zero or more
Tagelements.
Errors
-
Access denied.
-
An argument is invalid.
-
The tagging specified is not valid.
-
A resource that was specified is not valid.
PublishFunction
$result = $client->publishFunction([/* ... */]); $promise = $client->publishFunctionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->publishFunction([
'IfMatch' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'FunctionSummary' => [
'FunctionConfig' => [
'Comment' => '<string>',
'Runtime' => 'cloudfront-js-1.0',
],
'FunctionMetadata' => [
'CreatedTime' => <DateTime>,
'FunctionARN' => '<string>',
'LastModifiedTime' => <DateTime>,
'Stage' => 'DEVELOPMENT|LIVE',
],
'Name' => '<string>',
'Status' => '<string>',
],
]
Result Details
Members
- FunctionSummary
-
- Type: FunctionSummary structure
Contains configuration information and metadata about a CloudFront function.
Errors
-
An argument is invalid.
-
The
If-Matchversion is missing or not valid. -
The function does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
This operation is not supported in this region.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Add tags to a CloudFront resource.
Parameter Syntax
$result = $client->tagResource([
'Resource' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
'Items' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
],
]);
Parameter Details
Members
- Resource
-
- Required: Yes
- Type: string
An ARN of a CloudFront resource.
- Tags
-
- Required: Yes
- Type: Tags structure
A complex type that contains zero or more
Tagelements.
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
An argument is invalid.
-
The tagging specified is not valid.
-
A resource that was specified is not valid.
TestFunction
$result = $client->testFunction([/* ... */]); $promise = $client->testFunctionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->testFunction([
'EventObject' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
'IfMatch' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'Stage' => 'DEVELOPMENT|LIVE',
]);
Parameter Details
Members
- EventObject
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
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.
- IfMatch
-
- Required: Yes
- Type: string
The current version (
ETagvalue) of the function that you are testing, which you can get usingDescribeFunction. - Name
-
- Required: Yes
- Type: string
The name of the function that you are testing.
- Stage
-
- Type: string
The stage of the function that you are testing, either
DEVELOPMENTorLIVE.
Result Syntax
[
'TestResult' => [
'ComputeUtilization' => '<string>',
'FunctionErrorMessage' => '<string>',
'FunctionExecutionLogs' => ['<string>', ...],
'FunctionOutput' => '<string>',
'FunctionSummary' => [
'FunctionConfig' => [
'Comment' => '<string>',
'Runtime' => 'cloudfront-js-1.0',
],
'FunctionMetadata' => [
'CreatedTime' => <DateTime>,
'FunctionARN' => '<string>',
'LastModifiedTime' => <DateTime>,
'Stage' => 'DEVELOPMENT|LIVE',
],
'Name' => '<string>',
'Status' => '<string>',
],
],
]
Result Details
Members
- TestResult
-
- Type: TestResult structure
An object that represents the result of running the function with the provided event object.
Errors
-
An argument is invalid.
-
The
If-Matchversion is missing or not valid. -
The function does not exist.
-
The CloudFront function failed.
-
This operation is not supported in this region.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Remove tags from a CloudFront resource.
Parameter Syntax
$result = $client->untagResource([
'Resource' => '<string>', // REQUIRED
'TagKeys' => [ // REQUIRED
'Items' => ['<string>', ...],
],
]);
Parameter Details
Members
- Resource
-
- Required: Yes
- Type: string
An ARN of a CloudFront resource.
- TagKeys
-
- Required: Yes
- Type: TagKeys structure
A complex type that contains zero or more
Tagkey elements.
Result Syntax
[]
Result Details
Errors
-
Access denied.
-
An argument is invalid.
-
The tagging specified is not valid.
-
A resource that was specified is not valid.
UpdateCachePolicy
$result = $client->updateCachePolicy([/* ... */]); $promise = $client->updateCachePolicyAsync([/* ... */]);
Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
-
Use
GetCachePolicyConfigto get the current configuration. -
Locally modify the fields in the cache policy configuration that you want to update.
-
Call
UpdateCachePolicyby providing the entire cache policy configuration, including the fields that you modified and those that you didn’t.
Parameter Syntax
$result = $client->updateCachePolicy([
'CachePolicyConfig' => [ // REQUIRED
'Comment' => '<string>',
'DefaultTTL' => <integer>,
'MaxTTL' => <integer>,
'MinTTL' => <integer>, // REQUIRED
'Name' => '<string>', // REQUIRED
'ParametersInCacheKeyAndForwardedToOrigin' => [
'CookiesConfig' => [ // REQUIRED
'CookieBehavior' => 'none|whitelist|allExcept|all', // REQUIRED
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'EnableAcceptEncodingBrotli' => true || false,
'EnableAcceptEncodingGzip' => true || false, // REQUIRED
'HeadersConfig' => [ // REQUIRED
'HeaderBehavior' => 'none|whitelist', // REQUIRED
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'QueryStringsConfig' => [ // REQUIRED
'QueryStringBehavior' => 'none|whitelist|allExcept|all', // REQUIRED
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
],
],
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
- CachePolicyConfig
-
- Required: Yes
- Type: CachePolicyConfig structure
A cache policy configuration.
- Id
-
- Required: Yes
- Type: string
The unique identifier for the cache policy that you are updating. The identifier is returned in a cache behavior’s
CachePolicyIdfield in the response toGetDistributionConfig. - IfMatch
-
- Type: string
The version of the cache policy that you are updating. The version is returned in the cache policy’s
ETagfield in the response toGetCachePolicyConfig.
Result Syntax
[
'CachePolicy' => [
'CachePolicyConfig' => [
'Comment' => '<string>',
'DefaultTTL' => <integer>,
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'Name' => '<string>',
'ParametersInCacheKeyAndForwardedToOrigin' => [
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|allExcept|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'EnableAcceptEncodingBrotli' => true || false,
'EnableAcceptEncodingGzip' => true || false,
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|allExcept|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
'ETag' => '<string>',
]
Result Details
Members
- CachePolicy
-
- Type: CachePolicy structure
A cache policy.
- ETag
-
- Type: string
The current version of the cache policy.
Errors
-
Access denied.
-
The update contains modifications that are not allowed.
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
The
If-Matchversion is missing or not valid. -
The cache policy does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use
UpdateCachePolicy. -
The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyQueryStringsInCachePolicy:
The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
UpdateCloudFrontOriginAccessIdentity
$result = $client->updateCloudFrontOriginAccessIdentity([/* ... */]); $promise = $client->updateCloudFrontOriginAccessIdentityAsync([/* ... */]);
Update an origin access identity.
Parameter Syntax
$result = $client->updateCloudFrontOriginAccessIdentity([
'CloudFrontOriginAccessIdentityConfig' => [ // REQUIRED
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>', // REQUIRED
],
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
- CloudFrontOriginAccessIdentityConfig
-
- Required: Yes
- Type: CloudFrontOriginAccessIdentityConfig structure
The identity's configuration information.
- Id
-
- Required: Yes
- Type: string
The identity's id.
- IfMatch
-
- Type: string
The value of the
ETagheader that you received when retrieving the identity's configuration. For example:E2QWRUHAPOMQZL.
Result Syntax
[
'CloudFrontOriginAccessIdentity' => [
'CloudFrontOriginAccessIdentityConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
],
'Id' => '<string>',
'S3CanonicalUserId' => '<string>',
],
'ETag' => '<string>',
]
Result Details
Members
- CloudFrontOriginAccessIdentity
-
- Type: CloudFrontOriginAccessIdentity structure
The origin access identity's information.
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL.
Errors
-
Access denied.
-
The update contains modifications that are not allowed.
-
The
If-Matchversion is missing or not valid. -
This operation requires a body. Ensure that the body is present and the
Content-Typeheader is set. -
NoSuchCloudFrontOriginAccessIdentity:
The specified origin access identity does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
An argument is invalid.
-
The value of
Quantityand the size ofItemsdon't match.
UpdateDistribution
$result = $client->updateDistribution([/* ... */]); $promise = $client->updateDistributionAsync([/* ... */]);
Updates the configuration for a web distribution.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.
For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.
To update a web distribution using the CloudFront API
-
Submit a GetDistributionConfig request to get the current configuration and an
Etagheader for the distribution.If you update the distribution again, you must get a new
Etagheader. -
Update the XML document that was returned in the response to your
GetDistributionConfigrequest to include your changes.When you edit the XML file, be aware of the following:
-
You must strip out the ETag parameter that is returned.
-
Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.
-
You can't change the value of
CallerReference. If you try to change this value, CloudFront returns anIllegalUpdateerror. -
The new configuration replaces the existing configuration; the values that you specify in an
UpdateDistributionrequest are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example,CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the correspondingQuantityelement.
-
-
Submit an
UpdateDistributionrequest to update the configuration for your distribution:-
In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a
DistributionConfigelement. -
Set the value of the HTTP
If-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGetDistributionConfigrequest in Step 1.
-
-
Review the response to the
UpdateDistributionrequest to confirm that the configuration was successfully updated. -
Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of
StatusisDeployed.
Parameter Syntax
$result = $client->updateDistribution([
'DistributionConfig' => [ // REQUIRED
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [ // REQUIRED
'Forward' => 'none|whitelist|all', // REQUIRED
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'QueryString' => true || false, // REQUIRED
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'FunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>', // REQUIRED
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>', // REQUIRED
'TrustedKeyGroups' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'TrustedSigners' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>', // REQUIRED
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>, // REQUIRED
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'DefaultCacheBehavior' => [ // REQUIRED
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [ // REQUIRED
'Forward' => 'none|whitelist|all', // REQUIRED
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'QueryString' => true || false, // REQUIRED
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'FunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response', // REQUIRED
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>', // REQUIRED
'TrustedKeyGroups' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'TrustedSigners' => [
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https', // REQUIRED
],
'DefaultRootObject' => '<string>',
'Enabled' => true || false, // REQUIRED
'HttpVersion' => 'http1.1|http2',
'IsIPV6Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
'IncludeCookies' => true || false, // REQUIRED
'Prefix' => '<string>', // REQUIRED
],
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [ // REQUIRED
'StatusCodes' => [ // REQUIRED
'Items' => [<integer>, ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
],
'Id' => '<string>', // REQUIRED
'Members' => [ // REQUIRED
'Items' => [ // REQUIRED
[
'OriginId' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'Origins' => [ // REQUIRED
'Items' => [ // REQUIRED
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>', // REQUIRED
'HeaderValue' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>, // REQUIRED
'HTTPSPort' => <integer>, // REQUIRED
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only', // REQUIRED
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
],
'DomainName' => '<string>', // REQUIRED
'Id' => '<string>', // REQUIRED
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false, // REQUIRED
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>', // REQUIRED
],
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [ // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
'RestrictionType' => 'blacklist|whitelist|none', // REQUIRED
],
],
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
- DistributionConfig
-
- Required: Yes
- Type: DistributionConfig structure
The distribution's configuration information.
- Id
-
- Required: Yes
- Type: string
The distribution's id.
- IfMatch
-
- Type: string
The value of the
ETagheader that you received when retrieving the distribution's configuration. For example:E2QWRUHAPOMQZL.
Result Syntax
[
'Distribution' => [
'ARN' => '<string>',
'ActiveTrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => [
[
'KeyGroupId' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'ActiveTrustedSigners' => [
'Enabled' => true || false,
'Items' => [
[
'AwsAccountNumber' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'AliasICPRecordals' => [
[
'CNAME' => '<string>',
'ICPRecordalStatus' => 'APPROVED|SUSPENDED|PENDING',
],
// ...
],
'DistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CacheBehaviors' => [
'Items' => [
[
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'PathPattern' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
// ...
],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'CustomErrorResponses' => [
'Items' => [
[
'ErrorCachingMinTTL' => <integer>,
'ErrorCode' => <integer>,
'ResponseCode' => '<string>',
'ResponsePagePath' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'DefaultCacheBehavior' => [
'AllowedMethods' => [
'CachedMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CachePolicyId' => '<string>',
'Compress' => true || false,
'DefaultTTL' => <integer>,
'FieldLevelEncryptionId' => '<string>',
'ForwardedValues' => [
'Cookies' => [
'Forward' => 'none|whitelist|all',
'WhitelistedNames' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'QueryString' => true || false,
'QueryStringCacheKeys' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'FunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'FunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'LambdaFunctionAssociations' => [
'Items' => [
[
'EventType' => 'viewer-request|viewer-response|origin-request|origin-response',
'IncludeBody' => true || false,
'LambdaFunctionARN' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'MaxTTL' => <integer>,
'MinTTL' => <integer>,
'OriginRequestPolicyId' => '<string>',
'RealtimeLogConfigArn' => '<string>',
'ResponseHeadersPolicyId' => '<string>',
'SmoothStreaming' => true || false,
'TargetOriginId' => '<string>',
'TrustedKeyGroups' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ViewerProtocolPolicy' => 'allow-all|https-only|redirect-to-https',
],
'DefaultRootObject' => '<string>',
'Enabled' => true || false,
'HttpVersion' => 'http1.1|http2',
'IsIPV6Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'IncludeCookies' => true || false,
'Prefix' => '<string>',
],
'OriginGroups' => [
'Items' => [
[
'FailoverCriteria' => [
'StatusCodes' => [
'Items' => [<integer>, ...],
'Quantity' => <integer>,
],
],
'Id' => '<string>',
'Members' => [
'Items' => [
[
'OriginId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'Origins' => [
'Items' => [
[
'ConnectionAttempts' => <integer>,
'ConnectionTimeout' => <integer>,
'CustomHeaders' => [
'Items' => [
[
'HeaderName' => '<string>',
'HeaderValue' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'CustomOriginConfig' => [
'HTTPPort' => <integer>,
'HTTPSPort' => <integer>,
'OriginKeepaliveTimeout' => <integer>,
'OriginProtocolPolicy' => 'http-only|match-viewer|https-only',
'OriginReadTimeout' => <integer>,
'OriginSslProtocols' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'DomainName' => '<string>',
'Id' => '<string>',
'OriginPath' => '<string>',
'OriginShield' => [
'Enabled' => true || false,
'OriginShieldRegion' => '<string>',
],
'S3OriginConfig' => [
'OriginAccessIdentity' => '<string>',
],
],
// ...
],
'Quantity' => <integer>,
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'Restrictions' => [
'GeoRestriction' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
'RestrictionType' => 'blacklist|whitelist|none',
],
],
'ViewerCertificate' => [
'ACMCertificateArn' => '<string>',
'Certificate' => '<string>',
'CertificateSource' => 'cloudfront|iam|acm',
'CloudFrontDefaultCertificate' => true || false,
'IAMCertificateId' => '<string>',
'MinimumProtocolVersion' => 'SSLv3|TLSv1|TLSv1_2016|TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
'SSLSupportMethod' => 'sni-only|vip|static-ip',
],
'WebACLId' => '<string>',
],
'DomainName' => '<string>',
'Id' => '<string>',
'InProgressInvalidationBatches' => <integer>,
'LastModifiedTime' => <DateTime>,
'Status' => '<string>',
],
'ETag' => '<string>',
]
Result Details
Members
- Distribution
-
- Type: Distribution structure
The distribution's information.
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL.
Errors
-
Access denied.
-
The CNAME specified is already defined for CloudFront.
-
The update contains modifications that are not allowed.
-
The
If-Matchversion is missing or not valid. -
This operation requires a body. Ensure that the body is present and the
Content-Typeheader is set. -
The specified distribution does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
Your request contains more CNAMEs than are allowed per distribution.
-
The default root object file name is too big or contains an invalid character.
-
The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
-
An invalid error code was specified.
-
A response code is not valid.
-
An argument is invalid.
-
The origin access identity is not valid or doesn't exist.
-
Your request contains more trusted signers than are allowed per distribution.
-
One or more of your trusted signers don't exist.
-
A viewer certificate specified is not valid.
-
InvalidMinimumProtocolVersion:
The minimum protocol version specified is not valid.
-
This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the
RequiredProtocolselement from your distribution configuration. -
No origin exists with the specified
Origin Id. -
You cannot create more origins for the distribution.
-
TooManyOriginGroupsPerDistribution:
Processing your request would cause you to exceed the maximum number of origin groups allowed.
-
You cannot create more cache behaviors for the distribution.
-
TooManyCookieNamesInWhiteList:
Your request contains more cookie names in the whitelist than are allowed per cache behavior.
-
Your request contains forward cookies option which doesn't match with the expectation for the
whitelistedlist of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected. -
TooManyHeadersInForwardedValues:
Your request contains too many headers in forwarded values.
-
The headers specified are not valid for an Amazon S3 origin.
-
The value of
Quantityand the size ofItemsdon't match. -
You cannot create anymore custom SSL/TLS certificates.
-
The location code specified is not valid.
-
InvalidGeoRestrictionParameter:
The specified geo restriction parameter is not valid.
-
The TTL order specified is not valid.
-
A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using WAF Classic, use the ACL ID, for example473e64fd-f30b-4765-81a0-62ad96dd167a. -
Your request contains too many origin custom headers.
-
Your request contains too many query string parameters.
-
The query string parameters specified are not valid.
-
TooManyDistributionsWithLambdaAssociations:
Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
-
TooManyDistributionsWithSingleFunctionARN:
The maximum number of distributions have been associated with the specified Lambda@Edge function.
-
TooManyLambdaFunctionAssociations:
Your request contains more Lambda@Edge function associations than are allowed per distribution.
-
InvalidLambdaFunctionAssociation:
The specified Lambda@Edge function association is invalid.
-
TooManyDistributionsWithFunctionAssociations:
You have reached the maximum number of distributions that are associated with a CloudFront function. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
You have reached the maximum number of CloudFront function associations for this distribution. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
A CloudFront function association is invalid.
-
The read timeout specified for the origin is not valid.
-
InvalidOriginKeepaliveTimeout:
The keep alive timeout specified for the origin is not valid.
-
NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
-
IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior:
The specified configuration for field-level encryption can't be associated with the specified cache behavior.
-
TooManyDistributionsAssociatedToFieldLevelEncryptionConfig:
The maximum number of distributions have been associated with the specified configuration for field-level encryption.
-
The cache policy does not exist.
-
TooManyDistributionsAssociatedToCachePolicy:
The maximum number of distributions have been associated with the specified cache policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The response headers policy does not exist.
-
TooManyDistributionsAssociatedToResponseHeadersPolicy:
The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The origin request policy does not exist.
-
TooManyDistributionsAssociatedToOriginRequestPolicy:
The maximum number of distributions have been associated with the specified origin request policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyDistributionsAssociatedToKeyGroup:
The number of distributions that reference this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyKeyGroupsAssociatedToDistribution:
The number of key groups referenced by this distribution is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
The specified key group does not exist.
-
The real-time log configuration does not exist.
-
RealtimeLogConfigOwnerMismatch:
The specified real-time log configuration belongs to a different Amazon Web Services account.
UpdateFieldLevelEncryptionConfig
$result = $client->updateFieldLevelEncryptionConfig([/* ... */]); $promise = $client->updateFieldLevelEncryptionConfigAsync([/* ... */]);
Update a field-level encryption configuration.
Parameter Syntax
$result = $client->updateFieldLevelEncryptionConfig([
'FieldLevelEncryptionConfig' => [ // REQUIRED
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>',
'ContentTypeProfileConfig' => [
'ContentTypeProfiles' => [
'Items' => [
[
'ContentType' => '<string>', // REQUIRED
'Format' => 'URLEncoded', // REQUIRED
'ProfileId' => '<string>',
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'ForwardWhenContentTypeIsUnknown' => true || false, // REQUIRED
],
'QueryArgProfileConfig' => [
'ForwardWhenQueryArgProfileIsUnknown' => true || false, // REQUIRED
'QueryArgProfiles' => [
'Items' => [
[
'ProfileId' => '<string>', // REQUIRED
'QueryArg' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
],
],
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
- FieldLevelEncryptionConfig
-
- Required: Yes
- Type: FieldLevelEncryptionConfig structure
Request to update a field-level encryption configuration.
- Id
-
- Required: Yes
- Type: string
The ID of the configuration you want to update.
- IfMatch
-
- Type: string
The value of the
ETagheader that you received when retrieving the configuration identity to update. For example:E2QWRUHAPOMQZL.
Result Syntax
[
'ETag' => '<string>',
'FieldLevelEncryption' => [
'FieldLevelEncryptionConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'ContentTypeProfileConfig' => [
'ContentTypeProfiles' => [
'Items' => [
[
'ContentType' => '<string>',
'Format' => 'URLEncoded',
'ProfileId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'ForwardWhenContentTypeIsUnknown' => true || false,
],
'QueryArgProfileConfig' => [
'ForwardWhenQueryArgProfileIsUnknown' => true || false,
'QueryArgProfiles' => [
'Items' => [
[
'ProfileId' => '<string>',
'QueryArg' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
],
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
]
Result Details
Members
- ETag
-
- Type: string
The value of the
ETagheader that you received when updating the configuration. For example:E2QWRUHAPOMQZL. - FieldLevelEncryption
-
- Type: FieldLevelEncryption structure
Return the results of updating the configuration.
Errors
-
Access denied.
-
The update contains modifications that are not allowed.
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
The
If-Matchversion is missing or not valid. -
NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
-
NoSuchFieldLevelEncryptionConfig:
The specified configuration for field-level encryption doesn't exist.
-
The precondition in one or more of the request fields evaluated to
false. -
TooManyFieldLevelEncryptionQueryArgProfiles:
The maximum number of query arg profiles for field-level encryption have been created.
-
TooManyFieldLevelEncryptionContentTypeProfiles:
The maximum number of content type profiles for field-level encryption have been created.
-
No profile specified for the field-level encryption query argument.
UpdateFieldLevelEncryptionProfile
$result = $client->updateFieldLevelEncryptionProfile([/* ... */]); $promise = $client->updateFieldLevelEncryptionProfileAsync([/* ... */]);
Update a field-level encryption profile.
Parameter Syntax
$result = $client->updateFieldLevelEncryptionProfile([
'FieldLevelEncryptionProfileConfig' => [ // REQUIRED
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>',
'EncryptionEntities' => [ // REQUIRED
'Items' => [
[
'FieldPatterns' => [ // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'ProviderId' => '<string>', // REQUIRED
'PublicKeyId' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'Name' => '<string>', // REQUIRED
],
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
]);
Parameter Details
Members
- FieldLevelEncryptionProfileConfig
-
- Required: Yes
- Type: FieldLevelEncryptionProfileConfig structure
Request to update a field-level encryption profile.
- Id
-
- Required: Yes
- Type: string
The ID of the field-level encryption profile request.
- IfMatch
-
- Type: string
The value of the
ETagheader that you received when retrieving the profile identity to update. For example:E2QWRUHAPOMQZL.
Result Syntax
[
'ETag' => '<string>',
'FieldLevelEncryptionProfile' => [
'FieldLevelEncryptionProfileConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'EncryptionEntities' => [
'Items' => [
[
'FieldPatterns' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'ProviderId' => '<string>',
'PublicKeyId' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Name' => '<string>',
],
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
],
]
Result Details
Members
- ETag
-
- Type: string
The result of the field-level encryption profile request.
- FieldLevelEncryptionProfile
-
- Type: FieldLevelEncryptionProfile structure
Return the results of updating the profile.
Errors
-
Access denied.
-
FieldLevelEncryptionProfileAlreadyExists:
The specified profile for field-level encryption already exists.
-
The update contains modifications that are not allowed.
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
The
If-Matchversion is missing or not valid. -
The specified public key doesn't exist.
-
NoSuchFieldLevelEncryptionProfile:
The specified profile for field-level encryption doesn't exist.
-
The precondition in one or more of the request fields evaluated to
false. -
FieldLevelEncryptionProfileSizeExceeded:
The maximum size of a profile for field-level encryption was exceeded.
-
TooManyFieldLevelEncryptionEncryptionEntities:
The maximum number of encryption entities for field-level encryption have been created.
-
TooManyFieldLevelEncryptionFieldPatterns:
The maximum number of field patterns for field-level encryption have been created.
UpdateFunction
$result = $client->updateFunction([/* ... */]); $promise = $client->updateFunctionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateFunction([
'FunctionCode' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
'FunctionConfig' => [ // REQUIRED
'Comment' => '<string>', // REQUIRED
'Runtime' => 'cloudfront-js-1.0', // REQUIRED
],
'IfMatch' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- FunctionCode
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.
- FunctionConfig
-
- Required: Yes
- Type: FunctionConfig structure
Configuration information about the function.
- IfMatch
-
- Required: Yes
- Type: string
The current version (
ETagvalue) of the function that you are updating, which you can get usingDescribeFunction. - Name
-
- Required: Yes
- Type: string
The name of the function that you are updating.
Result Syntax
[
'ETag' => '<string>',
'FunctionSummary' => [
'FunctionConfig' => [
'Comment' => '<string>',
'Runtime' => 'cloudfront-js-1.0',
],
'FunctionMetadata' => [
'CreatedTime' => <DateTime>,
'FunctionARN' => '<string>',
'LastModifiedTime' => <DateTime>,
'Stage' => 'DEVELOPMENT|LIVE',
],
'Name' => '<string>',
'Status' => '<string>',
],
]
Result Details
Members
- ETag
-
- Type: string
The version identifier for the current version of the CloudFront function.
- FunctionSummary
-
- Type: FunctionSummary structure
Contains configuration information and metadata about a CloudFront function.
Errors
-
An argument is invalid.
-
The
If-Matchversion is missing or not valid. -
The function does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
This operation is not supported in this region.
UpdateKeyGroup
$result = $client->updateKeyGroup([/* ... */]); $promise = $client->updateKeyGroupAsync([/* ... */]);
Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
-
Get the current key group with
GetKeyGrouporGetKeyGroupConfig. -
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
-
Call
UpdateKeyGroupwith the entire key group object, including the fields that you modified and those that you didn’t.
Parameter Syntax
$result = $client->updateKeyGroup([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
'KeyGroupConfig' => [ // REQUIRED
'Comment' => '<string>',
'Items' => ['<string>', ...], // REQUIRED
'Name' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the key group that you are updating.
- IfMatch
-
- Type: string
The version of the key group that you are updating. The version is the key group’s
ETagvalue. - KeyGroupConfig
-
- Required: Yes
- Type: KeyGroupConfig structure
The key group configuration.
Result Syntax
[
'ETag' => '<string>',
'KeyGroup' => [
'Id' => '<string>',
'KeyGroupConfig' => [
'Comment' => '<string>',
'Items' => ['<string>', ...],
'Name' => '<string>',
],
'LastModifiedTime' => <DateTime>,
],
]
Result Details
Members
- ETag
-
- Type: string
The identifier for this version of the key group.
- KeyGroup
-
- Type: KeyGroup structure
The key group that was just updated.
Errors
-
The
If-Matchversion is missing or not valid. -
A resource that was specified is not valid.
-
The precondition in one or more of the request fields evaluated to
false. -
A key group with this name already exists. You must provide a unique name. To modify an existing key group, use
UpdateKeyGroup. -
An argument is invalid.
-
The number of public keys in this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
UpdateOriginRequestPolicy
$result = $client->updateOriginRequestPolicy([/* ... */]); $promise = $client->updateOriginRequestPolicyAsync([/* ... */]);
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
-
Use
GetOriginRequestPolicyConfigto get the current configuration. -
Locally modify the fields in the origin request policy configuration that you want to update.
-
Call
UpdateOriginRequestPolicyby providing the entire origin request policy configuration, including the fields that you modified and those that you didn’t.
Parameter Syntax
$result = $client->updateOriginRequestPolicy([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
'OriginRequestPolicyConfig' => [ // REQUIRED
'Comment' => '<string>',
'CookiesConfig' => [ // REQUIRED
'CookieBehavior' => 'none|whitelist|all', // REQUIRED
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'HeadersConfig' => [ // REQUIRED
'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront', // REQUIRED
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
'Name' => '<string>', // REQUIRED
'QueryStringsConfig' => [ // REQUIRED
'QueryStringBehavior' => 'none|whitelist|all', // REQUIRED
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
],
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache behavior’s
OriginRequestPolicyIdfield in the response toGetDistributionConfig. - IfMatch
-
- Type: string
The version of the origin request policy that you are updating. The version is returned in the origin request policy’s
ETagfield in the response toGetOriginRequestPolicyConfig. - OriginRequestPolicyConfig
-
- Required: Yes
- Type: OriginRequestPolicyConfig structure
An origin request policy configuration.
Result Syntax
[
'ETag' => '<string>',
'OriginRequestPolicy' => [
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'OriginRequestPolicyConfig' => [
'Comment' => '<string>',
'CookiesConfig' => [
'CookieBehavior' => 'none|whitelist|all',
'Cookies' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'HeadersConfig' => [
'HeaderBehavior' => 'none|whitelist|allViewer|allViewerAndWhitelistCloudFront',
'Headers' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
'Name' => '<string>',
'QueryStringsConfig' => [
'QueryStringBehavior' => 'none|whitelist|all',
'QueryStrings' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the origin request policy.
- OriginRequestPolicy
-
- Type: OriginRequestPolicy structure
An origin request policy.
Errors
-
Access denied.
-
The update contains modifications that are not allowed.
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
The
If-Matchversion is missing or not valid. -
The origin request policy does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
OriginRequestPolicyAlreadyExists:
An origin request policy with this name already exists. You must provide a unique name. To modify an existing origin request policy, use
UpdateOriginRequestPolicy. -
TooManyHeadersInOriginRequestPolicy:
The number of headers in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyCookiesInOriginRequestPolicy:
The number of cookies in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooManyQueryStringsInOriginRequestPolicy:
The number of query strings in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
UpdatePublicKey
$result = $client->updatePublicKey([/* ... */]); $promise = $client->updatePublicKeyAsync([/* ... */]);
Update public key information. Note that the only value you can change is the comment.
Parameter Syntax
$result = $client->updatePublicKey([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
'PublicKeyConfig' => [ // REQUIRED
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>',
'EncodedKey' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the public key that you are updating.
- IfMatch
-
- Type: string
The value of the
ETagheader that you received when retrieving the public key to update. For example:E2QWRUHAPOMQZL. - PublicKeyConfig
-
- Required: Yes
- Type: PublicKeyConfig structure
A public key configuration.
Result Syntax
[
'ETag' => '<string>',
'PublicKey' => [
'CreatedTime' => <DateTime>,
'Id' => '<string>',
'PublicKeyConfig' => [
'CallerReference' => '<string>',
'Comment' => '<string>',
'EncodedKey' => '<string>',
'Name' => '<string>',
],
],
]
Result Details
Members
- ETag
-
- Type: string
The identifier of the current version of the public key.
- PublicKey
-
- Type: PublicKey structure
The public key.
Errors
-
Access denied.
-
CannotChangeImmutablePublicKeyFields:
You can't change the value of a public key.
-
An argument is invalid.
-
The
If-Matchversion is missing or not valid. -
The update contains modifications that are not allowed.
-
The specified public key doesn't exist.
-
The precondition in one or more of the request fields evaluated to
false.
UpdateRealtimeLogConfig
$result = $client->updateRealtimeLogConfig([/* ... */]); $promise = $client->updateRealtimeLogConfigAsync([/* ... */]);
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
-
Call
GetRealtimeLogConfigto get the current real-time log configuration. -
Locally modify the parameters in the real-time log configuration that you want to update.
-
Call this API (
UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn’t.
You cannot update a real-time log configuration’s Name or ARN.
Parameter Syntax
$result = $client->updateRealtimeLogConfig([
'ARN' => '<string>',
'EndPoints' => [
[
'KinesisStreamConfig' => [
'RoleARN' => '<string>', // REQUIRED
'StreamARN' => '<string>', // REQUIRED
],
'StreamType' => '<string>', // REQUIRED
],
// ...
],
'Fields' => ['<string>', ...],
'Name' => '<string>',
'SamplingRate' => <integer>,
]);
Parameter Details
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) for this real-time log configuration.
- EndPoints
-
- Type: Array of EndPoint structures
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
- Fields
-
- Type: Array of strings
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
-
- Type: string
The name for this real-time log configuration.
- SamplingRate
-
- Type: long (int|float)
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.
Result Syntax
[
'RealtimeLogConfig' => [
'ARN' => '<string>',
'EndPoints' => [
[
'KinesisStreamConfig' => [
'RoleARN' => '<string>',
'StreamARN' => '<string>',
],
'StreamType' => '<string>',
],
// ...
],
'Fields' => ['<string>', ...],
'Name' => '<string>',
'SamplingRate' => <integer>,
],
]
Result Details
Members
- RealtimeLogConfig
-
- Type: RealtimeLogConfig structure
A real-time log configuration.
Errors
-
The real-time log configuration does not exist.
-
An argument is invalid.
-
Access denied.
UpdateResponseHeadersPolicy
$result = $client->updateResponseHeadersPolicy([/* ... */]); $promise = $client->updateResponseHeadersPolicyAsync([/* ... */]);
Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
-
Use
GetResponseHeadersPolicyConfigto get the current policy’s configuration. -
Modify the fields in the response headers policy configuration that you want to update.
-
Call
UpdateResponseHeadersPolicy, providing the entire response headers policy configuration, including the fields that you modified and those that you didn’t.
Parameter Syntax
$result = $client->updateResponseHeadersPolicy([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
'ResponseHeadersPolicyConfig' => [ // REQUIRED
'Comment' => '<string>',
'CorsConfig' => [
'AccessControlAllowCredentials' => true || false, // REQUIRED
'AccessControlAllowHeaders' => [ // REQUIRED
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'AccessControlAllowMethods' => [ // REQUIRED
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'AccessControlAllowOrigins' => [ // REQUIRED
'Items' => ['<string>', ...], // REQUIRED
'Quantity' => <integer>, // REQUIRED
],
'AccessControlExposeHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'AccessControlMaxAgeSec' => <integer>,
'OriginOverride' => true || false, // REQUIRED
],
'CustomHeadersConfig' => [
'Items' => [
[
'Header' => '<string>', // REQUIRED
'Override' => true || false, // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'Quantity' => <integer>, // REQUIRED
],
'Name' => '<string>', // REQUIRED
'SecurityHeadersConfig' => [
'ContentSecurityPolicy' => [
'ContentSecurityPolicy' => '<string>', // REQUIRED
'Override' => true || false, // REQUIRED
],
'ContentTypeOptions' => [
'Override' => true || false, // REQUIRED
],
'FrameOptions' => [
'FrameOption' => 'DENY|SAMEORIGIN', // REQUIRED
'Override' => true || false, // REQUIRED
],
'ReferrerPolicy' => [
'Override' => true || false, // REQUIRED
'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url', // REQUIRED
],
'StrictTransportSecurity' => [
'AccessControlMaxAgeSec' => <integer>, // REQUIRED
'IncludeSubdomains' => true || false,
'Override' => true || false, // REQUIRED
'Preload' => true || false,
],
'XSSProtection' => [
'ModeBlock' => true || false,
'Override' => true || false, // REQUIRED
'Protection' => true || false, // REQUIRED
'ReportUri' => '<string>',
],
],
'ServerTimingHeadersConfig' => [
'Enabled' => true || false, // REQUIRED
'SamplingRate' => <float>,
],
],
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier for the response headers policy that you are updating.
- IfMatch
-
- Type: string
The version of the response headers policy that you are updating.
The version is returned in the cache policy’s
ETagfield in the response toGetResponseHeadersPolicyConfig. - ResponseHeadersPolicyConfig
-
- Required: Yes
- Type: ResponseHeadersPolicyConfig structure
A response headers policy configuration.
Result Syntax
[
'ETag' => '<string>',
'ResponseHeadersPolicy' => [
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'ResponseHeadersPolicyConfig' => [
'Comment' => '<string>',
'CorsConfig' => [
'AccessControlAllowCredentials' => true || false,
'AccessControlAllowHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowMethods' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlAllowOrigins' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlExposeHeaders' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'AccessControlMaxAgeSec' => <integer>,
'OriginOverride' => true || false,
],
'CustomHeadersConfig' => [
'Items' => [
[
'Header' => '<string>',
'Override' => true || false,
'Value' => '<string>',
],
// ...
],
'Quantity' => <integer>,
],
'Name' => '<string>',
'SecurityHeadersConfig' => [
'ContentSecurityPolicy' => [
'ContentSecurityPolicy' => '<string>',
'Override' => true || false,
],
'ContentTypeOptions' => [
'Override' => true || false,
],
'FrameOptions' => [
'FrameOption' => 'DENY|SAMEORIGIN',
'Override' => true || false,
],
'ReferrerPolicy' => [
'Override' => true || false,
'ReferrerPolicy' => 'no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url',
],
'StrictTransportSecurity' => [
'AccessControlMaxAgeSec' => <integer>,
'IncludeSubdomains' => true || false,
'Override' => true || false,
'Preload' => true || false,
],
'XSSProtection' => [
'ModeBlock' => true || false,
'Override' => true || false,
'Protection' => true || false,
'ReportUri' => '<string>',
],
],
'ServerTimingHeadersConfig' => [
'Enabled' => true || false,
'SamplingRate' => <float>,
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the response headers policy.
- ResponseHeadersPolicy
-
- Type: ResponseHeadersPolicy structure
A response headers policy.
Errors
-
Access denied.
-
The update contains modifications that are not allowed.
-
The value of
Quantityand the size ofItemsdon't match. -
An argument is invalid.
-
The
If-Matchversion is missing or not valid. -
The response headers policy does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
ResponseHeadersPolicyAlreadyExists:
A response headers policy with this name already exists. You must provide a unique name. To modify an existing response headers policy, use
UpdateResponseHeadersPolicy. -
TooManyCustomHeadersInResponseHeadersPolicy:
The number of custom headers in the response headers policy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
-
TooLongCSPInResponseHeadersPolicy:
The length of the
Content-Security-Policyheader value in the response headers policy exceeds the maximum.For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
UpdateStreamingDistribution
$result = $client->updateStreamingDistribution([/* ... */]); $promise = $client->updateStreamingDistributionAsync([/* ... */]);
Update a streaming distribution.
Parameter Syntax
$result = $client->updateStreamingDistribution([
'Id' => '<string>', // REQUIRED
'IfMatch' => '<string>',
'StreamingDistributionConfig' => [ // REQUIRED
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
'CallerReference' => '<string>', // REQUIRED
'Comment' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
'Logging' => [
'Bucket' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
'Prefix' => '<string>', // REQUIRED
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'S3Origin' => [ // REQUIRED
'DomainName' => '<string>', // REQUIRED
'OriginAccessIdentity' => '<string>', // REQUIRED
],
'TrustedSigners' => [ // REQUIRED
'Enabled' => true || false, // REQUIRED
'Items' => ['<string>', ...],
'Quantity' => <integer>, // REQUIRED
],
],
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The streaming distribution's id.
- IfMatch
-
- Type: string
The value of the
ETagheader that you received when retrieving the streaming distribution's configuration. For example:E2QWRUHAPOMQZL. - StreamingDistributionConfig
-
- Required: Yes
- Type: StreamingDistributionConfig structure
The streaming distribution's configuration information.
Result Syntax
[
'ETag' => '<string>',
'StreamingDistribution' => [
'ARN' => '<string>',
'ActiveTrustedSigners' => [
'Enabled' => true || false,
'Items' => [
[
'AwsAccountNumber' => '<string>',
'KeyPairIds' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
// ...
],
'Quantity' => <integer>,
],
'DomainName' => '<string>',
'Id' => '<string>',
'LastModifiedTime' => <DateTime>,
'Status' => '<string>',
'StreamingDistributionConfig' => [
'Aliases' => [
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
'CallerReference' => '<string>',
'Comment' => '<string>',
'Enabled' => true || false,
'Logging' => [
'Bucket' => '<string>',
'Enabled' => true || false,
'Prefix' => '<string>',
],
'PriceClass' => 'PriceClass_100|PriceClass_200|PriceClass_All',
'S3Origin' => [
'DomainName' => '<string>',
'OriginAccessIdentity' => '<string>',
],
'TrustedSigners' => [
'Enabled' => true || false,
'Items' => ['<string>', ...],
'Quantity' => <integer>,
],
],
],
]
Result Details
Members
- ETag
-
- Type: string
The current version of the configuration. For example:
E2QWRUHAPOMQZL. - StreamingDistribution
-
- Type: StreamingDistribution structure
The streaming distribution's information.
Errors
-
Access denied.
-
The CNAME specified is already defined for CloudFront.
-
The update contains modifications that are not allowed.
-
The
If-Matchversion is missing or not valid. -
This operation requires a body. Ensure that the body is present and the
Content-Typeheader is set. -
The specified streaming distribution does not exist.
-
The precondition in one or more of the request fields evaluated to
false. -
TooManyStreamingDistributionCNAMEs:
Your request contains more CNAMEs than are allowed per distribution.
-
An argument is invalid.
-
The origin access identity is not valid or doesn't exist.
-
Your request contains more trusted signers than are allowed per distribution.
-
One or more of your trusted signers don't exist.
-
The value of
Quantityand the size ofItemsdon't match.
Shapes
AccessDenied
ActiveTrustedKeyGroups
Description
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.
Members
- Enabled
-
- Required: Yes
- Type: boolean
This field is
trueif any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field isfalse. - Items
-
- Type: Array of KGKeyPairIds structures
A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.
- Quantity
-
- Required: Yes
- Type: int
The number of key groups in the list.
ActiveTrustedSigners
Description
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.
Members
- Enabled
-
- Required: Yes
- Type: boolean
This field is
trueif any of the Amazon Web Services accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field isfalse. - Items
-
- Type: Array of Signer structures
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
- Quantity
-
- Required: Yes
- Type: int
The number of Amazon Web Services accounts in the list.
AliasICPRecordal
Description
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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
Members
- CNAME
-
- Type: string
A domain name associated with a distribution.
- ICPRecordalStatus
-
- Type: string
The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.
The status values returned are the following:
-
APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.
-
SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.
-
PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.
Aliases
Description
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
Members
AllowedMethods
Description
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:
-
CloudFront forwards only
GETandHEADrequests. -
CloudFront forwards only
GET,HEAD, andOPTIONSrequests. -
CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
Members
- CachedMethods
-
- Type: CachedMethods structure
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
-
CloudFront caches responses to
GETandHEADrequests. -
CloudFront caches responses to
GET,HEAD, andOPTIONSrequests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- Items
-
- Required: Yes
- Type: Array of strings
A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
- Quantity
-
- Required: Yes
- Type: int
The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for
GETandHEADrequests), 3 (forGET,HEAD, andOPTIONSrequests) and 7 (forGET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests).
BatchTooLarge
CNAMEAlreadyExists
CacheBehavior
Description
A complex type that describes how CloudFront processes requests.
You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.
For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.
If you don’t want to specify any cache behaviors, include only an empty CacheBehaviors element. Don’t include an empty CacheBehavior element because this is invalid.
To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.
To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.
For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
Members
- AllowedMethods
-
- Type: AllowedMethods structure
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:
-
CloudFront forwards only
GETandHEADrequests. -
CloudFront forwards only
GET,HEAD, andOPTIONSrequests. -
CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CachePolicyId
-
- Type: string
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
CacheBehaviormust include either aCachePolicyIdorForwardedValues. We recommend that you use aCachePolicyId. - Compress
-
- Type: boolean
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
- DefaultTTL
-
- Type: long (int|float)
This field is deprecated. We recommend that you use the
DefaultTTLfield in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - FieldLevelEncryptionId
-
- Type: string
The value of
IDfor the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. - ForwardedValues
-
- Type: ForwardedValues structure
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
CacheBehaviormust include either aCachePolicyIdorForwardedValues. We recommend that you use aCachePolicyId.A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
- FunctionAssociations
-
- Type: FunctionAssociations structure
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVEstage to associate them with a cache behavior. - LambdaFunctionAssociations
-
- Type: LambdaFunctionAssociations structure
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- MaxTTL
-
- Type: long (int|float)
This field is deprecated. We recommend that you use the
MaxTTLfield in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - MinTTL
-
- Type: long (int|float)
This field is deprecated. We recommend that you use the
MinTTLfield in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
You must specify
0forMinTTLif you configure CloudFront to forward all headers to your origin (underHeaders, if you specify1forQuantityand*forName). - OriginRequestPolicyId
-
- Type: string
The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- PathPattern
-
- Required: Yes
- Type: string
The pattern (for example,
images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.You can optionally include a slash (
/) at the beginning of the path pattern. For example,/images/*.jpg. CloudFront behavior is the same with or without the leading/.The path pattern for the default cache behavior is
*and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.For more information, see Path Pattern in the Amazon CloudFront Developer Guide.
- RealtimeLogConfigArn
-
- Type: string
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- ResponseHeadersPolicyId
-
- Type: string
The identifier for a response headers policy.
- SmoothStreaming
-
- Type: boolean
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true; if not, specifyfalse. If you specifytrueforSmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern. - TargetOriginId
-
- Required: Yes
- Type: string
The value of
IDfor the origin that you want CloudFront to route requests to when they match this cache behavior. - TrustedKeyGroups
-
- Type: TrustedKeyGroups structure
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, 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.
- TrustedSigners
-
- Type: TrustedSigners structure
We recommend using
TrustedKeyGroupsinstead ofTrustedSigners.A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. 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.
- ViewerProtocolPolicy
-
- Required: Yes
- Type: string
The protocol that viewers can use to access the files in the origin specified by
TargetOriginIdwhen a request matches the path pattern inPathPattern. You can specify the following options:-
allow-all: Viewers can use HTTP or HTTPS. -
redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. -
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
CacheBehaviors
Description
A complex type that contains zero or more CacheBehavior elements.
Members
- Items
-
- Type: Array of CacheBehavior structures
Optional: A complex type that contains cache behaviors for this distribution. If
Quantityis0, you can omitItems. - Quantity
-
- Required: Yes
- Type: int
The number of cache behaviors for this distribution.
CachePolicy
Description
A cache policy.
When it’s attached to a cache behavior, the cache policy determines the following:
-
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
-
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid 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.
Members
- CachePolicyConfig
-
- Required: Yes
- Type: CachePolicyConfig structure
The cache policy configuration.
- Id
-
- Required: Yes
- Type: string
The unique identifier for the cache policy.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the cache policy was last modified.
CachePolicyAlreadyExists
Description
A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use UpdateCachePolicy.
Members
CachePolicyConfig
Description
A cache policy configuration.
This configuration determines the following:
-
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
-
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid 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.
Members
- Comment
-
- Type: string
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
- DefaultTTL
-
- Type: long (int|float)
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send
Cache-ControlorExpiresheaders with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.The default value for this field is 86400 seconds (one day). If the value of
MinTTLis more than 86400 seconds, then the default value for this field is the same as the value ofMinTTL. - MaxTTL
-
- Type: long (int|float)
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends
Cache-ControlorExpiresheaders with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.The default value for this field is 31536000 seconds (one year). If the value of
MinTTLorDefaultTTLis more than 31536000 seconds, then the default value for this field is the same as the value ofDefaultTTL. - MinTTL
-
- Required: Yes
- Type: long (int|float)
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
- Name
-
- Required: Yes
- Type: string
A unique name to identify the cache policy.
- ParametersInCacheKeyAndForwardedToOrigin
-
- Type: ParametersInCacheKeyAndForwardedToOrigin structure
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
CachePolicyCookiesConfig
Description
An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
Members
- CookieBehavior
-
- Required: Yes
- Type: string
Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
-
none– Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set tonone, any cookies that are listed in anOriginRequestPolicyare included in origin requests. -
whitelist– The cookies in viewer requests that are listed in theCookieNamestype are included in the cache key and automatically included in requests that CloudFront sends to the origin. -
allExcept– All cookies in viewer requests that are not listed in theCookieNamestype are included in the cache key and automatically included in requests that CloudFront sends to the origin. -
all– All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
- Cookies
-
- Type: CookieNames structure
Contains a list of cookie names.
CachePolicyHeadersConfig
Description
An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
Members
- HeaderBehavior
-
- Required: Yes
- Type: string
Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
-
none– HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set tonone, any headers that are listed in anOriginRequestPolicyare included in origin requests. -
whitelist– The HTTP headers that are listed in theHeaderstype are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
- Headers
-
- Type: Headers structure
Contains a list of HTTP header names.
CachePolicyInUse
Description
Cannot delete the cache policy because it is attached to one or more cache behaviors.
Members
CachePolicyList
Description
A list of cache policies.
Members
- Items
-
- Type: Array of CachePolicySummary structures
Contains the cache policies in the list.
- MaxItems
-
- Required: Yes
- Type: int
The maximum number of cache policies requested.
- NextMarker
-
- Type: string
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the
Markerfield of a subsequent request to continue listing cache policies where you left off. - Quantity
-
- Required: Yes
- Type: int
The total number of cache policies returned in the response.
CachePolicyQueryStringsConfig
Description
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 automatically included in requests that CloudFront sends to the origin.
Members
- QueryStringBehavior
-
- Required: Yes
- Type: string
Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
-
none– Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set tonone, any query strings that are listed in anOriginRequestPolicyare included in origin requests. -
whitelist– The query strings in viewer requests that are listed in theQueryStringNamestype are included in the cache key and automatically included in requests that CloudFront sends to the origin. -
allExcept– All query strings in viewer requests that are not listed in theQueryStringNamestype are included in the cache key and automatically included in requests that CloudFront sends to the origin. -
all– All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
- QueryStrings
-
- Type: QueryStringNames structure
Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the
QueryStringBehaviorfield in theCachePolicyQueryStringsConfigtype is set towhitelist(the listed query strings are included) orallExcept(the listed query strings are not included, but all other query strings are).
CachePolicySummary
Description
Contains a cache policy.
Members
- CachePolicy
-
- Required: Yes
- Type: CachePolicy structure
The cache policy.
- Type
-
- Required: Yes
- Type: string
The type of cache policy, either
managed(created by Amazon Web Services) orcustom(created in this Amazon Web Services account).
CachedMethods
Description
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
-
CloudFront caches responses to
GETandHEADrequests. -
CloudFront caches responses to
GET,HEAD, andOPTIONSrequests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
Members
- Items
-
- Required: Yes
- Type: Array of strings
A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
- Quantity
-
- Required: Yes
- Type: int
The number of HTTP methods for which you want CloudFront to cache responses. Valid values are
2(for caching responses toGETandHEADrequests) and3(for caching responses toGET,HEAD, andOPTIONSrequests).
CannotChangeImmutablePublicKeyFields
CloudFrontOriginAccessIdentity
Description
CloudFront origin access identity.
Members
- CloudFrontOriginAccessIdentityConfig
-
- Type: CloudFrontOriginAccessIdentityConfig structure
The current configuration information for the identity.
- Id
-
- Required: Yes
- Type: string
The ID for the origin access identity, for example,
E74FTE3AJFJ256A. - S3CanonicalUserId
-
- Required: Yes
- Type: string
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.
CloudFrontOriginAccessIdentityAlreadyExists
Description
If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.
Members
CloudFrontOriginAccessIdentityConfig
Description
Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.
Members
- CallerReference
-
- Required: Yes
- Type: string
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of
CallerReferenceis new (regardless of the content of theCloudFrontOriginAccessIdentityConfigobject), a new origin access identity is created.If the
CallerReferenceis a value already sent in a previous identity request, and the content of theCloudFrontOriginAccessIdentityConfigis identical to the original request (ignoring white space), the response includes the same information returned to the original request.If the
CallerReferenceis a value you already sent in a previous request to create an identity, but the content of theCloudFrontOriginAccessIdentityConfigis different from the original request, CloudFront returns aCloudFrontOriginAccessIdentityAlreadyExistserror. - Comment
-
- Required: Yes
- Type: string
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
CloudFrontOriginAccessIdentityInUse
CloudFrontOriginAccessIdentityList
Description
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.
Members
- IsTruncated
-
- Required: Yes
- Type: boolean
A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the
Markerrequest parameter to retrieve more items in the list. - Items
-
- Type: Array of CloudFrontOriginAccessIdentitySummary structures
A complex type that contains one
CloudFrontOriginAccessIdentitySummaryelement for each origin access identity that was created by the current Amazon Web Services account. - Marker
-
- Required: Yes
- Type: 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
Markerto the value of theNextMarkerfrom the current page's response (which is also the ID of the last identity on that page). - MaxItems
-
- Required: Yes
- Type: int
The maximum number of origin access identities you want in the response body.
- NextMarker
-
- Type: string
If
IsTruncatedistrue, this element is present and contains the value you can use for theMarkerrequest parameter to continue listing your origin access identities where they left off. - Quantity
-
- Required: Yes
- Type: int
The number of CloudFront origin access identities that were created by the current Amazon Web Services account.
CloudFrontOriginAccessIdentitySummary
Description
Summary of the information about a CloudFront origin access identity.
Members
- Comment
-
- Required: Yes
- Type: string
The comment for this origin access identity, as originally specified when created.
- Id
-
- Required: Yes
- Type: string
The ID for the origin access identity. For example:
E74FTE3AJFJ256A. - S3CanonicalUserId
-
- Required: Yes
- Type: string
The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.
ConflictingAlias
Description
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.
Members
- AccountId
-
- Type: string
The (partially hidden) ID of the Amazon Web Services account that owns the distribution that’s associated with the alias.
- Alias
-
- Type: string
An alias (also called a CNAME).
- DistributionId
-
- Type: string
The (partially hidden) ID of the CloudFront distribution associated with the alias.
ConflictingAliasesList
Description
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.
Members
- Items
-
- Type: Array of ConflictingAlias structures
Contains the conflicting aliases in the list.
- MaxItems
-
- Type: int
The maximum number of conflicting aliases requested.
- NextMarker
-
- Type: string
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the
Markerfield of a subsequent request to continue listing conflicting aliases where you left off. - Quantity
-
- Type: int
The number of conflicting aliases returned in the response.
ContentTypeProfile
Description
A field-level encryption content type profile.
Members
- ContentType
-
- Required: Yes
- Type: string
The content type for a field-level encryption content type-profile mapping.
- Format
-
- Required: Yes
- Type: string
The format for a field-level encryption content type-profile mapping.
- ProfileId
-
- Type: string
The profile ID for a field-level encryption content type-profile mapping.
ContentTypeProfileConfig
Description
The configuration for a field-level encryption content type-profile mapping.
Members
- ContentTypeProfiles
-
- Type: ContentTypeProfiles structure
The configuration for a field-level encryption content type-profile.
- ForwardWhenContentTypeIsUnknown
-
- Required: Yes
- Type: boolean
The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
ContentTypeProfiles
Description
Field-level encryption content type-profile.
Members
- Items
-
- Type: Array of ContentTypeProfile structures
Items in a field-level encryption content type-profile mapping.
- Quantity
-
- Required: Yes
- Type: int
The number of field-level encryption content type-profile mappings.
CookieNames
Description
Contains a list of cookie names.
Members
CookiePreference
Description
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use CookiesConfig in a cache policy. See CachePolicy.
If you want to send cookies to the origin but not include them in the cache key, use CookiesConfig in an origin request policy. See OriginRequestPolicy.
A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Cookies in the Amazon CloudFront Developer Guide.
Members
- Forward
-
- Required: Yes
- Type: string
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the
WhitelistedNamescomplex type.Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the
Forwardelement. - WhitelistedNames
-
- Type: CookieNames structure
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify
whitelistfor the value ofForward. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.If you specify
allornonefor the value ofForward, omitWhitelistedNames. If you change the value ofForwardfromwhitelisttoallornoneand you don't delete theWhitelistedNameselement and its child elements, CloudFront deletes them automatically.For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference.
CreateFunctionRequest
Members
- FunctionCode
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.
- FunctionConfig
-
- Required: Yes
- Type: FunctionConfig structure
Configuration information about the function, including an optional comment and the function’s runtime.
- Name
-
- Required: Yes
- Type: string
A name to identify the function.
CreateRealtimeLogConfigRequest
Members
- EndPoints
-
- Required: Yes
- Type: Array of EndPoint structures
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
- Fields
-
- Required: Yes
- Type: Array of strings
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: Yes
- Type: string
A unique name to identify this real-time log configuration.
- SamplingRate
-
- Required: Yes
- Type: long (int|float)
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.
CustomErrorResponse
Description
A complex type that controls:
-
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
-
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
Members
- ErrorCachingMinTTL
-
- Type: long (int|float)
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- ErrorCode
-
- Required: Yes
- Type: int
The HTTP status code for which you want to specify a custom error page and/or a caching duration.
- ResponseCode
-
- Type: string
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
-
Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute
200, the response typically won't be intercepted. -
If you don't care about distinguishing among different client errors or server errors, you can specify
400or500as theResponseCodefor all 4xx or 5xx errors. -
You might want to return a
200status code (OK) and static website so your customers don't know that your website is down.
If you specify a value for
ResponseCode, you must also specify a value forResponsePagePath. - ResponsePagePath
-
- Type: string
The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by
ErrorCode, for example,/4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:-
The value of
PathPatternmatches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named/4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example,/4xx-errors/*. -
The value of
TargetOriginIdspecifies the value of theIDelement for the origin that contains your custom error pages.
If you specify a value for
ResponsePagePath, you must also specify a value forResponseCode.We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
CustomErrorResponses
Description
A complex type that controls:
-
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
-
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
Members
- Items
-
- Type: Array of CustomErrorResponse structures
A complex type that contains a
CustomErrorResponseelement for each HTTP status code for which you want to specify a custom error page and/or a caching duration. - Quantity
-
- Required: Yes
- Type: int
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If
Quantityis0, you can omitItems.
CustomHeaders
Description
A complex type that contains the list of Custom Headers for each origin.
Members
- Items
-
- Type: Array of OriginCustomHeader structures
Optional: A list that contains one
OriginCustomHeaderelement for each custom header that you want CloudFront to forward to the origin. If Quantity is0, omitItems. - Quantity
-
- Required: Yes
- Type: int
The number of custom headers, if any, for this distribution.
CustomOriginConfig
Description
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.
Members
- HTTPPort
-
- Required: Yes
- Type: int
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
- HTTPSPort
-
- Required: Yes
- Type: int
The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
- OriginKeepaliveTimeout
-
- Type: int
Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.
For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.
- OriginProtocolPolicy
-
- Required: Yes
- Type: string
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
-
http-only– CloudFront always uses HTTP to connect to the origin. -
match-viewer– CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. -
https-only– CloudFront always uses HTTPS to connect to the origin.
- OriginReadTimeout
-
- Type: int
Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.
- OriginSslProtocols
-
- Type: OriginSslProtocols structure
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include
SSLv3,TLSv1,TLSv1.1, andTLSv1.2.For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
DefaultCacheBehavior
Description
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.
Members
- AllowedMethods
-
- Type: AllowedMethods structure
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:
-
CloudFront forwards only
GETandHEADrequests. -
CloudFront forwards only
GET,HEAD, andOPTIONSrequests. -
CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- CachePolicyId
-
- Type: string
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehaviormust include either aCachePolicyIdorForwardedValues. We recommend that you use aCachePolicyId. - Compress
-
- Type: boolean
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
true; if not, specifyfalse. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide. - DefaultTTL
-
- Type: long (int|float)
This field is deprecated. We recommend that you use the
DefaultTTLfield in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - FieldLevelEncryptionId
-
- Type: string
The value of
IDfor the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. - ForwardedValues
-
- Type: ForwardedValues structure
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A
DefaultCacheBehaviormust include either aCachePolicyIdorForwardedValues. We recommend that you use aCachePolicyId.A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
- FunctionAssociations
-
- Type: FunctionAssociations structure
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the
LIVEstage to associate them with a cache behavior. - LambdaFunctionAssociations
-
- Type: LambdaFunctionAssociations structure
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
- MaxTTL
-
- Type: long (int|float)
This field is deprecated. We recommend that you use the
MaxTTLfield in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as
Cache-Control max-age,Cache-Control s-maxage, andExpiresto objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. - MinTTL
-
- Type: long (int|float)
This field is deprecated. We recommend that you use the
MinTTLfield in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
You must specify
0forMinTTLif you configure CloudFront to forward all headers to your origin (underHeaders, if you specify1forQuantityand*forName). - OriginRequestPolicyId
-
- Type: string
The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
- RealtimeLogConfigArn
-
- Type: string
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
- ResponseHeadersPolicyId
-
- Type: string
The identifier for a response headers policy.
- SmoothStreaming
-
- Type: boolean
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify
true; if not, specifyfalse. If you specifytrueforSmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern. - TargetOriginId
-
- Required: Yes
- Type: string
The value of
IDfor the origin that you want CloudFront to route requests to when they use the default cache behavior. - TrustedKeyGroups
-
- Type: TrustedKeyGroups structure
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, 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.
- TrustedSigners
-
- Type: TrustedSigners structure
We recommend using
TrustedKeyGroupsinstead ofTrustedSigners.A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. 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.
- ViewerProtocolPolicy
-
- Required: Yes
- Type: string
The protocol that viewers can use to access the files in the origin specified by
TargetOriginIdwhen a request matches the path pattern inPathPattern. You can specify the following options:-
allow-all: Viewers can use HTTP or HTTPS. -
redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. -
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
DeleteRealtimeLogConfigRequest
Members
Distribution
Description
A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
Members
- ARN
-
- Required: Yes
- Type: string
The ARN (Amazon Resource Name) for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where123456789012is your Amazon Web Services account ID. - ActiveTrustedKeyGroups
-
- Type: ActiveTrustedKeyGroups structure
CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.
- ActiveTrustedSigners
-
- Type: ActiveTrustedSigners structure
We recommend using
TrustedKeyGroupsinstead ofTrustedSigners.CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
- AliasICPRecordals
-
- Type: Array of AliasICPRecordal structures
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.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
- DistributionConfig
-
- Required: Yes
- Type: DistributionConfig structure
The current configuration information for the distribution. Send a
GETrequest to the/CloudFront API version/distribution ID/configresource. - DomainName
-
- Required: Yes
- Type: string
The domain name corresponding to the distribution, for example,
d111111abcdef8.cloudfront.net. - Id
-
- Required: Yes
- Type: string
The identifier for the distribution. For example:
EDFDVBD632BHDS5. - InProgressInvalidationBatches
-
- Required: Yes
- Type: int
The number of invalidation batches currently in progress.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the distribution was last modified.
- Status
-
- Required: Yes
- Type: string
This response element indicates the current status of the distribution. When the status is
Deployed, the distribution's information is fully propagated to all CloudFront edge locations.
DistributionAlreadyExists
Description
The caller reference you attempted to create the distribution with is associated with another distribution.
Members
DistributionConfig
Description
A distribution configuration.
Members
- Aliases
-
- Type: Aliases structure
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- CacheBehaviors
-
- Type: CacheBehaviors structure
A complex type that contains zero or more
CacheBehaviorelements. - CallerReference
-
- Required: Yes
- Type: string
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of
CallerReferenceis new (regardless of the content of theDistributionConfigobject), CloudFront creates a new distribution.If
CallerReferenceis a value that you already sent in a previous request to create a distribution, CloudFront returns aDistributionAlreadyExistserror. - Comment
-
- Required: Yes
- Type: string
An optional comment to describe the distribution. The comment cannot be longer than 128 characters.
- CustomErrorResponses
-
- Type: CustomErrorResponses structure
A complex type that controls the following:
-
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
-
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
- DefaultCacheBehavior
-
- Required: Yes
- Type: DefaultCacheBehavior structure
A complex type that describes the default cache behavior if you don't specify a
CacheBehaviorelement or if files don't match any of the values ofPathPatterninCacheBehaviorelements. You must create exactly one default cache behavior. - DefaultRootObject
-
- Type: string
The object that you want CloudFront to request from your origin (for example,
index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.Specify only the object name, for example,
index.html. Don't add a/before the object name.If you don't want to specify a default root object when you create a distribution, include an empty
DefaultRootObjectelement.To delete the default root object from an existing distribution, update the distribution configuration and include an empty
DefaultRootObjectelement.To replace the default root object, update the distribution configuration and specify the new object.
For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.
- Enabled
-
- Required: Yes
- Type: boolean
From this field, you can enable or disable the selected distribution.
- HttpVersion
-
- Type: string
(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).
In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."
- IsIPV6Enabled
-
- Type: boolean
If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
true. If you specifyfalse, CloudFront responds to IPv6 DNS requests with the DNS response codeNOERRORand with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the
IpAddressparameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
-
You enable IPv6 for the distribution
-
You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide.
If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
- Logging
-
- Type: LoggingConfig structure
A complex type that controls whether access logs are written for the distribution.
For more information about logging, see