Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. cleanrooms
  5. PrivacyBudgetTemplate

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cleanrooms.PrivacyBudgetTemplate

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Represents a privacy budget within a collaboration

    Create PrivacyBudgetTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivacyBudgetTemplate(name: string, args: PrivacyBudgetTemplateArgs, opts?: CustomResourceOptions);
    @overload
def PrivacyBudgetTemplate(resource_name: str,
                          args: PrivacyBudgetTemplateArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def PrivacyBudgetTemplate(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          auto_refresh: Optional[PrivacyBudgetTemplateAutoRefresh] = None,
                          membership_identifier: Optional[str] = None,
                          parameters: Optional[ParametersPropertiesArgs] = None,
                          privacy_budget_type: Optional[PrivacyBudgetTemplatePrivacyBudgetType] = None,
                          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewPrivacyBudgetTemplate(ctx *Context, name string, args PrivacyBudgetTemplateArgs, opts ...ResourceOption) (*PrivacyBudgetTemplate, error)
    public PrivacyBudgetTemplate(string name, PrivacyBudgetTemplateArgs args, CustomResourceOptions? opts = null)
    public PrivacyBudgetTemplate(String name, PrivacyBudgetTemplateArgs args)
public PrivacyBudgetTemplate(String name, PrivacyBudgetTemplateArgs args, CustomResourceOptions options)

    type: aws-native:cleanrooms:PrivacyBudgetTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PrivacyBudgetTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrivacyBudgetTemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrivacyBudgetTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivacyBudgetTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivacyBudgetTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    PrivacyBudgetTemplate Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PrivacyBudgetTemplate resource accepts the following input properties:

    AutoRefresh Pulumi.AwsNative.CleanRooms.PrivacyBudgetTemplateAutoRefresh

    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.

    MembershipIdentifier string
    The identifier for a membership resource.
    Parameters Pulumi.AwsNative.CleanRooms.Inputs.ParametersProperties
    Specifies the epsilon and noise parameters for the privacy budget template.
    PrivacyBudgetType Pulumi.AwsNative.CleanRooms.PrivacyBudgetTemplatePrivacyBudgetType
    Specifies the type of the privacy budget template.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    AutoRefresh PrivacyBudgetTemplateAutoRefresh

    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.

    MembershipIdentifier string
    The identifier for a membership resource.
    Parameters ParametersPropertiesArgs
    Specifies the epsilon and noise parameters for the privacy budget template.
    PrivacyBudgetType PrivacyBudgetTemplatePrivacyBudgetType
    Specifies the type of the privacy budget template.
    Tags TagArgs
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    autoRefresh PrivacyBudgetTemplateAutoRefresh

    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.

    membershipIdentifier String
    The identifier for a membership resource.
    parameters ParametersProperties
    Specifies the epsilon and noise parameters for the privacy budget template.
    privacyBudgetType PrivacyBudgetTemplatePrivacyBudgetType
    Specifies the type of the privacy budget template.
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    autoRefresh PrivacyBudgetTemplateAutoRefresh

    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.

    membershipIdentifier string
    The identifier for a membership resource.
    parameters ParametersProperties
    Specifies the epsilon and noise parameters for the privacy budget template.
    privacyBudgetType PrivacyBudgetTemplatePrivacyBudgetType
    Specifies the type of the privacy budget template.
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    auto_refresh PrivacyBudgetTemplateAutoRefresh

    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.

    membership_identifier str
    The identifier for a membership resource.
    parameters ParametersPropertiesArgs
    Specifies the epsilon and noise parameters for the privacy budget template.
    privacy_budget_type PrivacyBudgetTemplatePrivacyBudgetType
    Specifies the type of the privacy budget template.
    tags Sequence[TagArgs]
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    autoRefresh "CALENDAR_MONTH" | "NONE"

    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.

    membershipIdentifier String
    The identifier for a membership resource.
    parameters Property Map
    Specifies the epsilon and noise parameters for the privacy budget template.
    privacyBudgetType "DIFFERENTIAL_PRIVACY"
    Specifies the type of the privacy budget template.
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivacyBudgetTemplate resource produces the following output properties:

    Arn string
    The ARN of the privacy budget template.
    CollaborationArn string
    The ARN of the collaboration that contains this privacy budget template.
    CollaborationIdentifier string
    The unique ID of the collaboration that contains this privacy budget template.
    Id string
    The provider-assigned unique ID for this managed resource.
    MembershipArn string
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    PrivacyBudgetTemplateIdentifier string
    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.
    Arn string
    The ARN of the privacy budget template.
    CollaborationArn string
    The ARN of the collaboration that contains this privacy budget template.
    CollaborationIdentifier string
    The unique ID of the collaboration that contains this privacy budget template.
    Id string
    The provider-assigned unique ID for this managed resource.
    MembershipArn string
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    PrivacyBudgetTemplateIdentifier string
    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.
    arn String
    The ARN of the privacy budget template.
    collaborationArn String
    The ARN of the collaboration that contains this privacy budget template.
    collaborationIdentifier String
    The unique ID of the collaboration that contains this privacy budget template.
    id String
    The provider-assigned unique ID for this managed resource.
    membershipArn String
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    privacyBudgetTemplateIdentifier String
    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.
    arn string
    The ARN of the privacy budget template.
    collaborationArn string
    The ARN of the collaboration that contains this privacy budget template.
    collaborationIdentifier string
    The unique ID of the collaboration that contains this privacy budget template.
    id string
    The provider-assigned unique ID for this managed resource.
    membershipArn string
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    privacyBudgetTemplateIdentifier string
    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.
    arn str
    The ARN of the privacy budget template.
    collaboration_arn str
    The ARN of the collaboration that contains this privacy budget template.
    collaboration_identifier str
    The unique ID of the collaboration that contains this privacy budget template.
    id str
    The provider-assigned unique ID for this managed resource.
    membership_arn str
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    privacy_budget_template_identifier str
    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.
    arn String
    The ARN of the privacy budget template.
    collaborationArn String
    The ARN of the collaboration that contains this privacy budget template.
    collaborationIdentifier String
    The unique ID of the collaboration that contains this privacy budget template.
    id String
    The provider-assigned unique ID for this managed resource.
    membershipArn String
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    privacyBudgetTemplateIdentifier String
    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.

    Supporting Types

    ParametersProperties, ParametersPropertiesArgs

    Epsilon int
    The epsilon value that you want to use.
    UsersNoisePerQuery int
    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.
    Epsilon int
    The epsilon value that you want to use.
    UsersNoisePerQuery int
    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.
    epsilon Integer
    The epsilon value that you want to use.
    usersNoisePerQuery Integer
    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.
    epsilon number
    The epsilon value that you want to use.
    usersNoisePerQuery number
    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.
    epsilon int
    The epsilon value that you want to use.
    users_noise_per_query int
    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.
    epsilon Number
    The epsilon value that you want to use.
    usersNoisePerQuery Number
    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.

    PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetTemplateAutoRefreshArgs

    CalendarMonth
    CALENDAR_MONTH
    None
    NONE
    PrivacyBudgetTemplateAutoRefreshCalendarMonth
    CALENDAR_MONTH
    PrivacyBudgetTemplateAutoRefreshNone
    NONE
    CalendarMonth
    CALENDAR_MONTH
    None
    NONE
    CalendarMonth
    CALENDAR_MONTH
    None
    NONE
    CALENDAR_MONTH
    CALENDAR_MONTH
    NONE
    NONE
    "CALENDAR_MONTH"
    CALENDAR_MONTH
    "NONE"
    NONE

    PrivacyBudgetTemplatePrivacyBudgetType, PrivacyBudgetTemplatePrivacyBudgetTypeArgs

    DifferentialPrivacy
    DIFFERENTIAL_PRIVACY
    PrivacyBudgetTemplatePrivacyBudgetTypeDifferentialPrivacy
    DIFFERENTIAL_PRIVACY
    DifferentialPrivacy
    DIFFERENTIAL_PRIVACY
    DifferentialPrivacy
    DIFFERENTIAL_PRIVACY
    DIFFERENTIAL_PRIVACY
    DIFFERENTIAL_PRIVACY
    "DIFFERENTIAL_PRIVACY"
    DIFFERENTIAL_PRIVACY

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native