privacy_budget_templates

Creates, updates, deletes or gets a privacy_budget_template resource or lists privacy_budget_templates in a region

Overview

Name	privacy_budget_templates
Type	Resource
Description	Represents a privacy budget within a collaboration
Id	aws.cleanrooms.privacy_budget_templates

Fields

Name	Datatype	Description
arn	string
collaboration_arn	string
collaboration_identifier	string
privacy_budget_template_identifier	string
tags	array	An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
auto_refresh	string
privacy_budget_type	string
parameters	object
membership_arn	string
membership_identifier	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AutoRefresh, PrivacyBudgetType, Parameters, MembershipIdentifier, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all privacy_budget_templates in a region.

SELECT
region,
arn,
collaboration_arn,
collaboration_identifier,
privacy_budget_template_identifier,
tags,
auto_refresh,
privacy_budget_type,
parameters,
membership_arn,
membership_identifier
FROM aws.cleanrooms.privacy_budget_templates
WHERE region = 'us-east-1';

Gets all properties from an individual privacy_budget_template.

SELECT
region,
arn,
collaboration_arn,
collaboration_identifier,
privacy_budget_template_identifier,
tags,
auto_refresh,
privacy_budget_type,
parameters,
membership_arn,
membership_identifier
FROM aws.cleanrooms.privacy_budget_templates
WHERE region = 'us-east-1' AND data__Identifier = '<PrivacyBudgetTemplateIdentifier>|<MembershipIdentifier>';

INSERT example

Use the following StackQL query and manifest file to create a new privacy_budget_template resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.cleanrooms.privacy_budget_templates (
 AutoRefresh,
 PrivacyBudgetType,
 Parameters,
 MembershipIdentifier,
 region
)
SELECT 
'{{ AutoRefresh }}',
 '{{ PrivacyBudgetType }}',
 '{{ Parameters }}',
 '{{ MembershipIdentifier }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cleanrooms.privacy_budget_templates (
 Tags,
 AutoRefresh,
 PrivacyBudgetType,
 Parameters,
 MembershipIdentifier,
 region
)
SELECT 
 '{{ Tags }}',
 '{{ AutoRefresh }}',
 '{{ PrivacyBudgetType }}',
 '{{ Parameters }}',
 '{{ MembershipIdentifier }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: privacy_budget_template
    props:
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: AutoRefresh
        value: '{{ AutoRefresh }}'
      - name: PrivacyBudgetType
        value: '{{ PrivacyBudgetType }}'
      - name: Parameters
        value:
          Epsilon: '{{ Epsilon }}'
          UsersNoisePerQuery: '{{ UsersNoisePerQuery }}'
      - name: MembershipIdentifier
        value: '{{ MembershipIdentifier }}'

DELETE example

/*+ delete */
DELETE FROM aws.cleanrooms.privacy_budget_templates
WHERE data__Identifier = '<PrivacyBudgetTemplateIdentifier|MembershipIdentifier>'
AND region = 'us-east-1';

Permissions

To operate on the privacy_budget_templates resource, the following permissions are required:

Create

cleanrooms:CreatePrivacyBudgetTemplate,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:GetPrivacyBudgetTemplate,
cleanrooms:ListPrivacyBudgetTemplates

Read

cleanrooms:GetPrivacyBudgetTemplate,
cleanrooms:ListTagsForResource

Update

cleanrooms:UpdatePrivacyBudgetTemplate,
cleanrooms:GetPrivacyBudgetTemplate,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource

Delete

cleanrooms:DeletePrivacyBudgetTemplate,
cleanrooms:GetPrivacyBudgetTemplate,
cleanrooms:ListPrivacyBudgetTemplates,
cleanrooms:ListTagsForResource,
cleanrooms:UntagResource

List

cleanrooms:ListPrivacyBudgetTemplates