UpdateDistribution - Amazon Lightsail

UpdateDistribution

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

Use this action to update the configuration of your existing distribution

Request Syntax

{ "cacheBehaviors": [ { "behavior": "string", "path": "string" } ], "cacheBehaviorSettings": { "allowedHTTPMethods": "string", "cachedHTTPMethods": "string", "defaultTTL": number, "forwardedCookies": { "cookiesAllowList": [ "string" ], "option": "string" }, "forwardedHeaders": { "headersAllowList": [ "string" ], "option": "string" }, "forwardedQueryStrings": { "option": boolean, "queryStringsAllowList": [ "string" ] }, "maximumTTL": number, "minimumTTL": number }, "defaultCacheBehavior": { "behavior": "string" }, "distributionName": "string", "isEnabled": boolean, "origin": { "name": "string", "protocolPolicy": "string", "regionName": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

cacheBehaviors

An array of objects that describe the per-path cache behavior for the distribution.

Type: Array of CacheBehaviorPerPath objects

Required: No

cacheBehaviorSettings

An object that describes the cache behavior settings for the distribution.

Note

The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.

Type: CacheSettings object

Required: No

defaultCacheBehavior

An object that describes the default cache behavior for the distribution.

Type: CacheBehavior object

Required: No

distributionName

The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names that you can specify.

Type: String

Pattern: \w[\w\-]*\w

Required: Yes

isEnabled

Indicates whether to enable the distribution.

Type: Boolean

Required: No

origin

An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.

The distribution pulls, caches, and serves content from the origin.

Type: InputOrigin object

Required: No

Response Syntax

{ "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

operation

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

Type: Operation object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: