1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cleanrooms
  5. getPrivacyBudgetTemplate

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

AWS Cloud Control v1.40.0 published on Thursday, Dec 11, 2025 by Pulumi
aws-native logo

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

AWS Cloud Control v1.40.0 published on Thursday, Dec 11, 2025 by Pulumi

    Represents a privacy budget within a collaboration

    Using getPrivacyBudgetTemplate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPrivacyBudgetTemplate(args: GetPrivacyBudgetTemplateArgs, opts?: InvokeOptions): Promise<GetPrivacyBudgetTemplateResult>
    function getPrivacyBudgetTemplateOutput(args: GetPrivacyBudgetTemplateOutputArgs, opts?: InvokeOptions): Output<GetPrivacyBudgetTemplateResult>
    def get_privacy_budget_template(membership_identifier: Optional[str] = None,
                                    privacy_budget_template_identifier: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetPrivacyBudgetTemplateResult
    def get_privacy_budget_template_output(membership_identifier: Optional[pulumi.Input[str]] = None,
                                    privacy_budget_template_identifier: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetPrivacyBudgetTemplateResult]
    func LookupPrivacyBudgetTemplate(ctx *Context, args *LookupPrivacyBudgetTemplateArgs, opts ...InvokeOption) (*LookupPrivacyBudgetTemplateResult, error)
    func LookupPrivacyBudgetTemplateOutput(ctx *Context, args *LookupPrivacyBudgetTemplateOutputArgs, opts ...InvokeOption) LookupPrivacyBudgetTemplateResultOutput

    > Note: This function is named LookupPrivacyBudgetTemplate in the Go SDK.

    public static class GetPrivacyBudgetTemplate 
    {
        public static Task<GetPrivacyBudgetTemplateResult> InvokeAsync(GetPrivacyBudgetTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetPrivacyBudgetTemplateResult> Invoke(GetPrivacyBudgetTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrivacyBudgetTemplateResult> getPrivacyBudgetTemplate(GetPrivacyBudgetTemplateArgs args, InvokeOptions options)
    public static Output<GetPrivacyBudgetTemplateResult> getPrivacyBudgetTemplate(GetPrivacyBudgetTemplateArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:cleanrooms:getPrivacyBudgetTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    MembershipIdentifier string
    The identifier for a membership resource.
    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.
    MembershipIdentifier string
    The identifier for a membership resource.
    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.
    membershipIdentifier String
    The identifier for a membership resource.
    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.
    membershipIdentifier string
    The identifier for a membership resource.
    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.
    membership_identifier str
    The identifier for a membership resource.
    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.
    membershipIdentifier String
    The identifier for a membership resource.
    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.

    getPrivacyBudgetTemplate Result

    The following output properties are available:

    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.
    MembershipArn string
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    Parameters Pulumi.AwsNative.CleanRooms.Outputs.ParametersProperties
    Specifies the epsilon and noise parameters for 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.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    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.
    MembershipArn string
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    Parameters ParametersProperties
    Specifies the epsilon and noise parameters for 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.
    Tags Tag
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    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.
    membershipArn String
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    parameters ParametersProperties
    Specifies the epsilon and noise parameters for 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.
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    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.
    membershipArn string
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    parameters ParametersProperties
    Specifies the epsilon and noise parameters for 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.
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    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.
    membership_arn str
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    parameters ParametersProperties
    Specifies the epsilon and noise parameters for 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.
    tags Sequence[root_Tag]
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
    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.
    membershipArn String
    The Amazon Resource Name (ARN) of the member who created the privacy budget template.
    parameters Property Map
    Specifies the epsilon and noise parameters for 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.
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.

    Supporting Types

    ParametersProperties

    BudgetParameters List<Pulumi.AwsNative.CleanRooms.Inputs.PrivacyBudgetTemplateBudgetParameter>
    Epsilon int
    The epsilon value that you want to use.
    ResourceArn string
    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.
    BudgetParameters []PrivacyBudgetTemplateBudgetParameter
    Epsilon int
    The epsilon value that you want to use.
    ResourceArn string
    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.
    budgetParameters List<PrivacyBudgetTemplateBudgetParameter>
    epsilon Integer
    The epsilon value that you want to use.
    resourceArn String
    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.
    budgetParameters PrivacyBudgetTemplateBudgetParameter[]
    epsilon number
    The epsilon value that you want to use.
    resourceArn string
    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.
    budget_parameters Sequence[PrivacyBudgetTemplateBudgetParameter]
    epsilon int
    The epsilon value that you want to use.
    resource_arn str
    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.
    budgetParameters List<Property Map>
    epsilon Number
    The epsilon value that you want to use.
    resourceArn String
    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.

    PrivacyBudgetTemplateBudgetParameter

    Budget int
    The budget allocation amount for this specific parameter.
    Type Pulumi.AwsNative.CleanRooms.PrivacyBudgetTemplateBudgetParameterType
    The type of budget parameter being configured.
    AutoRefresh Pulumi.AwsNative.CleanRooms.PrivacyBudgetTemplateBudgetParameterAutoRefresh
    Whether this individual budget parameter automatically refreshes when the budget period resets.
    Budget int
    The budget allocation amount for this specific parameter.
    Type PrivacyBudgetTemplateBudgetParameterType
    The type of budget parameter being configured.
    AutoRefresh PrivacyBudgetTemplateBudgetParameterAutoRefresh
    Whether this individual budget parameter automatically refreshes when the budget period resets.
    budget Integer
    The budget allocation amount for this specific parameter.
    type PrivacyBudgetTemplateBudgetParameterType
    The type of budget parameter being configured.
    autoRefresh PrivacyBudgetTemplateBudgetParameterAutoRefresh
    Whether this individual budget parameter automatically refreshes when the budget period resets.
    budget number
    The budget allocation amount for this specific parameter.
    type PrivacyBudgetTemplateBudgetParameterType
    The type of budget parameter being configured.
    autoRefresh PrivacyBudgetTemplateBudgetParameterAutoRefresh
    Whether this individual budget parameter automatically refreshes when the budget period resets.
    budget int
    The budget allocation amount for this specific parameter.
    type PrivacyBudgetTemplateBudgetParameterType
    The type of budget parameter being configured.
    auto_refresh PrivacyBudgetTemplateBudgetParameterAutoRefresh
    Whether this individual budget parameter automatically refreshes when the budget period resets.
    budget Number
    The budget allocation amount for this specific parameter.
    type "CALENDAR_DAY" | "CALENDAR_MONTH" | "CALENDAR_WEEK" | "LIFETIME"
    The type of budget parameter being configured.
    autoRefresh "ENABLED" | "DISABLED"
    Whether this individual budget parameter automatically refreshes when the budget period resets.

    PrivacyBudgetTemplateBudgetParameterAutoRefresh

    PrivacyBudgetTemplateBudgetParameterType

    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 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 Cloud Control v1.40.0 published on Thursday, Dec 11, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate