portal_product_sharing_policies

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

Overview

Name	portal_product_sharing_policies
Type	Resource
Id	aws.apigatewayv2.portal_product_sharing_policies

Fields

The following fields are returned by SELECT queries:

get_portal_product_sharing_policy

Name	Datatype	Description
policy_document	string	The product sharing policy.
portal_product_id	string	The portal product identifier. (pattern: <code>^[a-z0-9]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_portal_product_sharing_policy	select	portal_product_id, region		Gets the sharing policy for a portal product.
put_portal_product_sharing_policy	replace	portal_product_id, region, PolicyDocument		Updates the sharing policy for a portal product.
delete_portal_product_sharing_policy	delete	portal_product_id, region		Deletes the sharing policy for 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)

SELECT examples

get_portal_product_sharing_policy

Gets the sharing policy for a portal product.

SELECT
policy_document,
portal_product_id
FROM aws.apigatewayv2.portal_product_sharing_policies
WHERE portal_product_id = '{{ portal_product_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_portal_product_sharing_policy

Updates the sharing policy for a portal product.

REPLACE aws.apigatewayv2.portal_product_sharing_policies
SET 
PolicyDocument = '{{ PolicyDocument }}'
WHERE 
portal_product_id = '{{ portal_product_id }}' --required
AND region = '{{ region }}' --required
AND PolicyDocument = '{{ PolicyDocument }}' --required;

DELETE examples

delete_portal_product_sharing_policy

Deletes the sharing policy for a portal product.

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