portal_products

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

Overview

Name	portal_products
Type	Resource
Id	aws.apigatewayv2.portal_products

Fields

The following fields are returned by SELECT queries:

get_portal_product

Name	Datatype	Description
description	string	The description of a portal product.
display_name	string	The display name.
display_order	object	The display order.
last_modified	string (date-time)	The timestamp when the portal product was last modified.
portal_product_arn	string	The ARN of the portal product.
portal_product_id	string	The portal product identifier. (pattern: <code>^[a-z0-9]+$</code>)
tags	object	The collection of tags. Each tag element is associated with a given resource.

list_portal_products

Name	Datatype	Description
description	string	The description.
display_name	string	The display name of a portal product.
last_modified	string (date-time)	The timestamp when the portal product was last modified.
portal_product_arn	string	The ARN of a portal product.
portal_product_id	string	The portal product identifier. (pattern: <code>^[a-z0-9]+$</code>)
tags	object	The collection of tags. Each tag element is associated with a given resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_portal_product	select	portal_product_id, region	resourceOwnerAccountId	Gets a portal product.
list_portal_products	select	region	maxResults, nextToken, resourceOwner	Lists portal products.
create_portal_product	insert	region, DisplayName		Creates a new portal product.
update_portal_product	update	portal_product_id, region		Updates the portal product.
delete_portal_product	delete	portal_product_id, region		Deletes a portal product.

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
portal_product_id	string	The portal product identifier.
region	string	AWS region (default: us-east-1)
maxResults	string	The maximum number of elements to be returned for this resource.
nextToken	string	The next page of elements from this collection. Not valid for the last element of the collection.
resourceOwner	string	The resource owner of the portal product.
resourceOwnerAccountId	string	The account ID of the resource owner of the portal product.

SELECT examples

get_portal_product

Gets a portal product.

SELECT
description,
display_name,
display_order,
last_modified,
portal_product_arn,
portal_product_id,
tags
FROM aws.apigatewayv2.portal_products
WHERE portal_product_id = '{{ portal_product_id }}' -- required
AND region = '{{ region }}' -- required
AND resourceOwnerAccountId = '{{ resourceOwnerAccountId }}'
;

list_portal_products

Lists portal products.

SELECT
description,
display_name,
last_modified,
portal_product_arn,
portal_product_id,
tags
FROM aws.apigatewayv2.portal_products
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND resourceOwner = '{{ resourceOwner }}'
;

INSERT examples

create_portal_product

Creates a new portal product.

INSERT INTO aws.apigatewayv2.portal_products (
Description,
DisplayName,
Tags,
region
)
SELECT 
'{{ Description }}',
'{{ DisplayName }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
description,
display_name,
display_order,
last_modified,
portal_product_arn,
portal_product_id,
tags
;

Manifest

# Description fields are for documentation purposes
- name: portal_products
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the portal_products resource.
  - name: Description
    value: "{{ Description }}"
  - name: DisplayName
    value: "{{ DisplayName }}"
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Represents a collection of tags associated with the resource.

UPDATE examples

update_portal_product

Updates the portal product.

UPDATE aws.apigatewayv2.portal_products
SET 
Description = '{{ Description }}',
DisplayName = '{{ DisplayName }}',
DisplayOrder = '{{ DisplayOrder }}'
WHERE 
portal_product_id = '{{ portal_product_id }}' --required
AND region = '{{ region }}' --required
RETURNING
description,
display_name,
display_order,
last_modified,
portal_product_arn,
portal_product_id,
tags;

DELETE examples

delete_portal_product

Deletes a portal product.

DELETE FROM aws.apigatewayv2.portal_products
WHERE portal_product_id = '{{ portal_product_id }}' --required
AND region = '{{ region }}' --required
;