CfnPrivacyBudgetTemplateProps

class aws_cdk.aws_cleanrooms.CfnPrivacyBudgetTemplateProps(*, auto_refresh, membership_identifier, parameters, privacy_budget_type, tags=None)

Bases: object

Properties for defining a CfnPrivacyBudgetTemplate.

Parameters:

• auto_refresh (str) – How often the privacy budget refreshes. .. epigraph:: 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.

• membership_identifier (str) – The identifier for a membership resource.

• parameters (Union[IResolvable, ParametersProperty, Dict[str, Any]]) – Specifies the epsilon and noise parameters for the privacy budget template.

• privacy_budget_type (str) – Specifies the type of the privacy budget template.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cleanrooms as cleanrooms

cfn_privacy_budget_template_props = cleanrooms.CfnPrivacyBudgetTemplateProps(
    auto_refresh="autoRefresh",
    membership_identifier="membershipIdentifier",
    parameters=cleanrooms.CfnPrivacyBudgetTemplate.ParametersProperty(
        epsilon=123,
        users_noise_per_query=123
    ),
    privacy_budget_type="privacyBudgetType",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

auto_refresh

How often the privacy budget refreshes.

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-autorefresh

membership_identifier

The identifier for a membership resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-membershipidentifier

parameters

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-parameters

privacy_budget_type

Specifies the type of the privacy budget template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-privacybudgettype

tags

An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-tags