CfnPrivacyBudgetTemplatePropsMixin

class aws_cdk.mixins_preview.aws_cleanrooms.mixins.CfnPrivacyBudgetTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

An object that defines the privacy budget template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html
CloudformationResource:: AWS::CleanRooms::PrivacyBudgetTemplate
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

cfn_privacy_budget_template_props_mixin = cleanrooms_mixins.CfnPrivacyBudgetTemplatePropsMixin(cleanrooms_mixins.CfnPrivacyBudgetTemplateMixinProps(
    auto_refresh="autoRefresh",
    membership_identifier="membershipIdentifier",
    parameters=cleanrooms_mixins.CfnPrivacyBudgetTemplatePropsMixin.ParametersProperty(
        budget_parameters=[cleanrooms_mixins.CfnPrivacyBudgetTemplatePropsMixin.BudgetParameterProperty(
            auto_refresh="autoRefresh",
            budget=123,
            type="type"
        )],
        epsilon=123,
        resource_arn="resourceArn",
        users_noise_per_query=123
    ),
    privacy_budget_type="privacyBudgetType",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CleanRooms::PrivacyBudgetTemplate.

Parameters:

props (Union[CfnPrivacyBudgetTemplateMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['autoRefresh', 'membershipIdentifier', 'parameters', 'privacyBudgetType', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

BudgetParameterProperty

class CfnPrivacyBudgetTemplatePropsMixin.BudgetParameterProperty(*, auto_refresh=None, budget=None, type=None)

Bases: object

Individual budget parameter configuration that defines specific budget allocation settings for access budgets.

Parameters:

auto_refresh (Optional[str]) – Whether this individual budget parameter automatically refreshes when the budget period resets.
budget (Union[int, float, None]) – The budget allocation amount for this specific parameter.
type (Optional[str]) – The type of budget parameter being configured.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-budgetparameter.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

budget_parameter_property = cleanrooms_mixins.CfnPrivacyBudgetTemplatePropsMixin.BudgetParameterProperty(
    auto_refresh="autoRefresh",
    budget=123,
    type="type"
)

Attributes

auto_refresh

Whether this individual budget parameter automatically refreshes when the budget period resets.

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

budget

The budget allocation amount for this specific parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-budgetparameter.html#cfn-cleanrooms-privacybudgettemplate-budgetparameter-budget

type

The type of budget parameter being configured.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-budgetparameter.html#cfn-cleanrooms-privacybudgettemplate-budgetparameter-type

ParametersProperty

class CfnPrivacyBudgetTemplatePropsMixin.ParametersProperty(*, budget_parameters=None, epsilon=None, resource_arn=None, users_noise_per_query=None)

Bases: object

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

Parameters:

budget_parameters (Union[IResolvable, Sequence[Union[IResolvable, BudgetParameterProperty, Dict[str, Any]]], None])
epsilon (Union[int, float, None]) – The epsilon value that you want to use.
resource_arn (Optional[str])
users_noise_per_query (Union[int, float, None]) – Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-parameters.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

parameters_property = cleanrooms_mixins.CfnPrivacyBudgetTemplatePropsMixin.ParametersProperty(
    budget_parameters=[cleanrooms_mixins.CfnPrivacyBudgetTemplatePropsMixin.BudgetParameterProperty(
        auto_refresh="autoRefresh",
        budget=123,
        type="type"
    )],
    epsilon=123,
    resource_arn="resourceArn",
    users_noise_per_query=123
)

Attributes

budget_parameters

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

Type:: see

epsilon

The epsilon value that you want to use.

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

resource_arn

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

Type:: see

users_noise_per_query

Noise added per query is measured in terms of the number of users whose contributions you want to obscure.

This value governs the rate at which the privacy budget is depleted.

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