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	awscc.cleanrooms.privacy_budget_templates

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
privacy_budget_template_identifier	string
membership_identifier	string
region	string	AWS region.

For more information, see AWS::CleanRooms::PrivacyBudgetTemplate.

Methods

Name	Resource	Accessible by	Required Params
create_resource	privacy_budget_templates	INSERT	AutoRefresh, PrivacyBudgetType, Parameters, MembershipIdentifier, region
delete_resource	privacy_budget_templates	DELETE	Identifier, region
update_resource	privacy_budget_templates	UPDATE	Identifier, PatchDocument, region
list_resources	privacy_budget_templates_list_only	SELECT	region
get_resource	privacy_budget_templates	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.cleanrooms.privacy_budget_templates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ privacy_budget_template_identifier }}|{{ membership_identifier }}';

list (identifiers only)

Lists all privacy_budget_templates in a region.

SELECT
  region,
  privacy_budget_template_identifier,
  membership_identifier
FROM awscc.cleanrooms.privacy_budget_templates_list_only
WHERE
  region = 'us-east-1';

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 awscc.cleanrooms.privacy_budget_templates (
  AutoRefresh,
  PrivacyBudgetType,
  Parameters,
  MembershipIdentifier,
  region
)
SELECT
  '{{ auto_refresh }}',
  '{{ privacy_budget_type }}',
  '{{ parameters }}',
  '{{ membership_identifier }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cleanrooms.privacy_budget_templates (
  Tags,
  AutoRefresh,
  PrivacyBudgetType,
  Parameters,
  MembershipIdentifier,
  region
)
SELECT
  '{{ tags }}',
  '{{ auto_refresh }}',
  '{{ privacy_budget_type }}',
  '{{ parameters }}',
  '{{ membership_identifier }}',
  '{{ 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: auto_refresh
        value: '{{ auto_refresh }}'
      - name: privacy_budget_type
        value: '{{ privacy_budget_type }}'
      - name: parameters
        value:
          epsilon: '{{ epsilon }}'
          users_noise_per_query: '{{ users_noise_per_query }}'
      - name: membership_identifier
        value: '{{ membership_identifier }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cleanrooms.privacy_budget_templates
SET PatchDocument = string('{{ {
    "Tags": tags,
    "Parameters": parameters
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ privacy_budget_template_identifier }}|{{ membership_identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cleanrooms.privacy_budget_templates
WHERE
  Identifier = '{{ privacy_budget_template_identifier }}|{{ membership_identifier }}' 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