Package software.amazon.awscdk.services.cleanrooms

Class CfnPrivacyBudgetTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cleanrooms.CfnPrivacyBudgetTemplate
All Implemented Interfaces:
IInspectable, ITaggableV2, IPrivacyBudgetTemplateRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:34.029Z") @Stability(Stable) public class CfnPrivacyBudgetTemplate extends CfnResource implements IInspectable, IPrivacyBudgetTemplateRef, ITaggableV2
An object that defines the privacy budget template.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cleanrooms.*;
 CfnPrivacyBudgetTemplate cfnPrivacyBudgetTemplate = CfnPrivacyBudgetTemplate.Builder.create(this, "MyCfnPrivacyBudgetTemplate")
         .autoRefresh("autoRefresh")
         .membershipIdentifier("membershipIdentifier")
         .parameters(ParametersProperty.builder()
                 .epsilon(123)
                 .usersNoisePerQuery(123)
                 .build())
         .privacyBudgetType("privacyBudgetType")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPrivacyBudgetTemplate

      protected CfnPrivacyBudgetTemplate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPrivacyBudgetTemplate

      protected CfnPrivacyBudgetTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPrivacyBudgetTemplate

      @Stability(Stable) public CfnPrivacyBudgetTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPrivacyBudgetTemplateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the privacy budget template.

    • getAttrCollaborationArn

      @Stability(Stable) @NotNull public String getAttrCollaborationArn()
      The ARN of the collaboration that contains this privacy budget template.

    • getAttrCollaborationIdentifier

      @Stability(Stable) @NotNull public String getAttrCollaborationIdentifier()
      The unique ID of the collaboration that contains this privacy budget template.

    • getAttrMembershipArn

      @Stability(Stable) @NotNull public String getAttrMembershipArn()
      The Amazon Resource Name (ARN) of the member who created the privacy budget template.

    • getAttrPrivacyBudgetTemplateIdentifier

      @Stability(Stable) @NotNull public String getAttrPrivacyBudgetTemplateIdentifier()
      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.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPrivacyBudgetTemplateRef

      @Stability(Stable) @NotNull public PrivacyBudgetTemplateReference getPrivacyBudgetTemplateRef()
      A reference to a PrivacyBudgetTemplate resource.
      Specified by:
      getPrivacyBudgetTemplateRef in interface IPrivacyBudgetTemplateRef

    • getAutoRefresh

      @Stability(Stable) @NotNull public String getAutoRefresh()
      How often the privacy budget refreshes.

    • setAutoRefresh

      @Stability(Stable) public void setAutoRefresh(@NotNull String value)
      How often the privacy budget refreshes.

    • getMembershipIdentifier

      @Stability(Stable) @NotNull public String getMembershipIdentifier()
      The identifier for a membership resource.

    • setMembershipIdentifier

      @Stability(Stable) public void setMembershipIdentifier(@NotNull String value)
      The identifier for a membership resource.

    • getParameters

      @Stability(Stable) @NotNull public Object getParameters()
      Specifies the epsilon and noise parameters for the privacy budget template.

      Returns union: either IResolvable or CfnPrivacyBudgetTemplate.ParametersProperty

    • setParameters

      @Stability(Stable) public void setParameters(@NotNull IResolvable value)
      Specifies the epsilon and noise parameters for the privacy budget template.

    • setParameters

      @Stability(Stable) public void setParameters(@NotNull CfnPrivacyBudgetTemplate.ParametersProperty value)
      Specifies the epsilon and noise parameters for the privacy budget template.

    • getPrivacyBudgetType

      @Stability(Stable) @NotNull public String getPrivacyBudgetType()
      Specifies the type of the privacy budget template.

    • setPrivacyBudgetType

      @Stability(Stable) public void setPrivacyBudgetType(@NotNull String value)
      Specifies the type of the privacy budget template.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An optional label that you can assign to a resource when you create it.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An optional label that you can assign to a resource when you create it.