UpdateVpcOrigin - Amazon CloudFront

UpdateVpcOrigin

Update an Amazon CloudFront VPC origin in your account.

Request Syntax

PUT /2020-05-31/vpc-origin/Id HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <VpcOriginEndpointConfig xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/"> <Arn>string</Arn> <HTTPPort>integer</HTTPPort> <HTTPSPort>integer</HTTPSPort> <Name>string</Name> <OriginProtocolPolicy>string</OriginProtocolPolicy> <OriginSslProtocols> <Items> <SslProtocol>string</SslProtocol> </Items> <Quantity>integer</Quantity> </OriginSslProtocols> </VpcOriginEndpointConfig>

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in XML format.

VpcOriginEndpointConfig

Root level tag for the VpcOriginEndpointConfig parameters.

Required: Yes

Arn

The ARN of the CloudFront VPC origin endpoint configuration.

Type: String

Required: Yes

HTTPPort

The HTTP port for the CloudFront VPC origin endpoint configuration.

Type: Integer

Required: Yes

HTTPSPort

The HTTPS port of the CloudFront VPC origin endpoint configuration.

Type: Integer

Required: Yes

Name

The name of the CloudFront VPC origin endpoint configuration.

Type: String

Required: Yes

OriginProtocolPolicy

The origin protocol policy for the CloudFront VPC origin endpoint configuration.

Type: String

Valid Values: http-only | match-viewer | https-only

Required: Yes

OriginSslProtocols

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

Type: OriginSslProtocols object

Required: No

Response Syntax

HTTP/1.1 202 <?xml version="1.0" encoding="UTF-8"?> <VpcOrigin> <Arn>string</Arn> <CreatedTime>timestamp</CreatedTime> <Id>string</Id> <LastModifiedTime>timestamp</LastModifiedTime> <Status>string</Status> <VpcOriginEndpointConfig> <Arn>string</Arn> <HTTPPort>integer</HTTPPort> <HTTPSPort>integer</HTTPSPort> <Name>string</Name> <OriginProtocolPolicy>string</OriginProtocolPolicy> <OriginSslProtocols> <Items> <SslProtocol>string</SslProtocol> </Items> <Quantity>integer</Quantity> </OriginSslProtocols> </VpcOriginEndpointConfig> </VpcOrigin>

Response Elements

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

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

VpcOrigin

Root level tag for the VpcOrigin parameters.

Required: Yes

Arn

The VPC origin ARN.

Type: String

CreatedTime

The VPC origin created time.

Type: Timestamp

Id

The VPC origin ID.

Type: String

LastModifiedTime

The VPC origin last modified time.

Type: Timestamp

Status

The VPC origin status.

Type: String

VpcOriginEndpointConfig

The VPC origin endpoint configuration.

Type: VpcOriginEndpointConfig object

Errors

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

AccessDenied

Access denied.

HTTP Status Code: 403

CannotUpdateEntityWhileInUse

The entity cannot be updated while it is in use.

HTTP Status Code: 409

EntityAlreadyExists

The entity already exists. You must provide a unique entity.

HTTP Status Code: 409

EntityLimitExceeded

The entity limit has been exceeded.

HTTP Status Code: 400

EntityNotFound

The entity was not found.

HTTP Status Code: 404

IllegalUpdate

The update contains modifications that are not allowed.

HTTP Status Code: 400

InconsistentQuantities

The value of Quantity and the size of Items don't match.

HTTP Status Code: 400

InvalidArgument

An argument is invalid.

HTTP Status Code: 400

InvalidIfMatchVersion

The If-Match version is missing or not valid.

HTTP Status Code: 400

PreconditionFailed

The precondition in one or more of the request fields evaluated to false.

HTTP Status Code: 412

UnsupportedOperation

This operation is not supported in this region.

HTTP Status Code: 400

See Also

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