AWS::CleanRooms::PrivacyBudgetTemplate - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::CleanRooms::PrivacyBudgetTemplate

An object that defines the privacy budget template.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CleanRooms::PrivacyBudgetTemplate",
  "Properties" : {
      "AutoRefresh" : String,
      "MembershipIdentifier" : String,
      "Parameters" : Parameters,
      "PrivacyBudgetType" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CleanRooms::PrivacyBudgetTemplate
Properties:
  AutoRefresh: String
  MembershipIdentifier: String
  Parameters: 
    Parameters
  PrivacyBudgetType: String
  Tags: 
    - Tag

Properties

AutoRefresh

How often the privacy budget refreshes.

Important

If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

Required: Yes

Type: String

Allowed values: CALENDAR_MONTH | NONE

Update requires: Replacement

MembershipIdentifier

The identifier for a membership resource.

Required: Yes

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Minimum: 36

Maximum: 36

Update requires: Replacement

Parameters

Specifies the epsilon and noise parameters for the privacy budget template.

Required: Yes

Type: Parameters

Update requires: No interruption

PrivacyBudgetType

Specifies the type of the privacy budget template.

Required: Yes

Type: String

Allowed values: DIFFERENTIAL_PRIVACY

Update requires: Replacement

Tags

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource ARN. For example:

{ "Ref": "myPrivacyBudgetTemplate" }

For the Clean Rooms privacy budget template, Ref returns the ARN of the privacy budget template.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the privacy budget template.

CollaborationArn

The ARN of the collaboration that contains this privacy budget template.

CollaborationIdentifier

The unique ID of the collaboration that contains this privacy budget template.

MembershipArn

The Amazon Resource Name (ARN) of the member who created the privacy budget template.

PrivacyBudgetTemplateIdentifier

A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.