vpc_origins

Creates, updates, deletes, gets or lists a vpc_origins resource.

Overview

Name	vpc_origins
Type	Resource
Id	aws.cloudfront.vpc_origins

Fields

The following fields are returned by SELECT queries:

get_vpc_origin

Name	Datatype	Description
account_id	string	The account ID of the Amazon Web Services account that owns the VPC origin.
arn	string	The VPC origin ARN.
created_time	string	The VPC origin created time.
id	string	The VPC origin ID.
last_modified_time	string	The VPC origin last modified time.
status	string	The VPC origin status.
vpc_origin_endpoint_config	string	The VPC origin endpoint configuration.

list_vpc_origins

Name	Datatype	Description
is_truncated	boolean	A flag that indicates whether more VPC origins remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more VPC origins in the list.
items	string	The items of the VPC origins list.
marker	string	The marker associated with the VPC origins list.
max_items	integer	The maximum number of items included in the list.
next_marker	string	The next marker associated with the VPC origins list.
quantity	integer	The number of VPC origins in the list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vpc_origin	select	id, region		Get the details of an Amazon CloudFront VPC origin.
list_vpc_origins	select	region	Marker, MaxItems	List the CloudFront VPC origins in your account.
create_vpc_origin	insert	region, VpcOriginEndpointConfig		Create an Amazon CloudFront VPC origin.
update_vpc_origin	update	id, If-Match, region, VpcOriginEndpointConfig		Update an Amazon CloudFront VPC origin in your account.
delete_vpc_origin	delete	id, If-Match, region		Delete an Amazon CloudFront VPC origin.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
If-Match	string	The version identifier of the VPC origin to delete. This is the ETag value returned in the response to GetVpcOrigin.
id	string	The VPC origin ID.
region	string	AWS region (default: us-east-1)
Marker	string	The marker associated with the VPC origins list.
MaxItems	string	The maximum number of items included in the list.

SELECT examples

get_vpc_origin

Get the details of an Amazon CloudFront VPC origin.

SELECT
account_id,
arn,
created_time,
id,
last_modified_time,
status,
vpc_origin_endpoint_config
FROM aws.cloudfront.vpc_origins
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_vpc_origins

List the CloudFront VPC origins in your account.

SELECT
is_truncated,
items,
marker,
max_items,
next_marker,
quantity
FROM aws.cloudfront.vpc_origins
WHERE region = '{{ region }}' -- required
AND Marker = '{{ Marker }}'
AND MaxItems = '{{ MaxItems }}'
;

INSERT examples

create_vpc_origin

Create an Amazon CloudFront VPC origin.

INSERT INTO aws.cloudfront.vpc_origins (
VpcOriginEndpointConfig,
Tags,
region
)
SELECT 
'{{ VpcOriginEndpointConfig }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
account_id,
arn,
created_time,
id,
last_modified_time,
status,
vpc_origin_endpoint_config
;

Manifest

# Description fields are for documentation purposes
- name: vpc_origins
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_origins resource.
  - name: VpcOriginEndpointConfig
    description: |
      An Amazon CloudFront VPC origin endpoint configuration.
    value:
      Name: "{{ Name }}"
      Arn: "{{ Arn }}"
      HTTPPort: {{ HTTPPort }}
      HTTPSPort: {{ HTTPSPort }}
      OriginProtocolPolicy: "{{ OriginProtocolPolicy }}"
      OriginSslProtocols:
        Quantity: {{ Quantity }}
        Items:
          - "{{ Items }}"
  - name: Tags
    description: |
      A complex type that contains zero or more Tag elements.
    value:
      Items:
        - Key: "{{ Key }}"
          Value: "{{ Value }}"

UPDATE examples

update_vpc_origin

Update an Amazon CloudFront VPC origin in your account.

UPDATE aws.cloudfront.vpc_origins
SET 
VpcOriginEndpointConfig = '{{ VpcOriginEndpointConfig }}'
WHERE 
id = '{{ id }}' --required
AND `If-Match` = '{{ If-Match }}' --required
AND region = '{{ region }}' --required
AND VpcOriginEndpointConfig = '{{ VpcOriginEndpointConfig }}' --required
RETURNING
account_id,
arn,
created_time,
id,
last_modified_time,
status,
vpc_origin_endpoint_config;

DELETE examples

delete_vpc_origin

Delete an Amazon CloudFront VPC origin.

DELETE FROM aws.cloudfront.vpc_origins
WHERE id = '{{ id }}' --required
AND `If-Match` = '{{ If-Match }}' --required
AND region = '{{ region }}' --required
;