Class: AWSCDK::CleanRooms::CfnPrivacyBudgetTemplate::ParametersProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
clean_rooms/cfn_privacy_budget_template.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(budget_parameters: nil, epsilon: nil, resource_arn: nil, users_noise_per_query: nil) ⇒ ParametersProperty

Returns a new instance of ParametersProperty.

Parameters:



660
661
662
663
664
665
666
667
668
669
 
# File 'clean_rooms/cfn_privacy_budget_template.rb', line 660

def initialize(budget_parameters: nil, epsilon: nil, resource_arn: nil, users_noise_per_query: nil)
  @budget_parameters = budget_parameters
  Jsii::Type.check_type(@budget_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xlYW5yb29tcy5DZm5Qcml2YWN5QnVkZ2V0VGVtcGxhdGUuQnVkZ2V0UGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "budgetParameters") unless @budget_parameters.nil?
  @epsilon = epsilon
  Jsii::Type.check_type(@epsilon, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "epsilon") unless @epsilon.nil?
  @resource_arn = resource_arn
  Jsii::Type.check_type(@resource_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceArn") unless @resource_arn.nil?
  @users_noise_per_query = users_noise_per_query
  Jsii::Type.check_type(@users_noise_per_query, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "usersNoisePerQuery") unless @users_noise_per_query.nil?
end

Instance Attribute Details

#budget_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



673
674
675
 
# File 'clean_rooms/cfn_privacy_budget_template.rb', line 673

def budget_parameters
  @budget_parameters
end

#epsilon ⇒ Numeric? (readonly)

The epsilon value that you want to use.

Returns:

  • (Numeric, nil)

See Also:



678
679
680
 
# File 'clean_rooms/cfn_privacy_budget_template.rb', line 678

def epsilon
  @epsilon
end

#resource_arn ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



681
682
683
 
# File 'clean_rooms/cfn_privacy_budget_template.rb', line 681

def resource_arn
  @resource_arn
end

#users_noise_per_query ⇒ Numeric? (readonly)

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.

Returns:

  • (Numeric, nil)

See Also:



688
689
690
 
# File 'clean_rooms/cfn_privacy_budget_template.rb', line 688

def users_noise_per_query
  @users_noise_per_query
end

Class Method Details

.jsii_properties ⇒ Object 



690
691
692
693
694
695
696
697
 
# File 'clean_rooms/cfn_privacy_budget_template.rb', line 690

def self.jsii_properties
  {
    :budget_parameters => "budgetParameters",
    :epsilon => "epsilon",
    :resource_arn => "resourceArn",
    :users_noise_per_query => "usersNoisePerQuery",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



699
700
701
702
703
704
705
706
707
708
 
# File 'clean_rooms/cfn_privacy_budget_template.rb', line 699

def to_jsii
  result = {}
  result.merge!({
    "budgetParameters" => @budget_parameters,
    "epsilon" => @epsilon,
    "resourceArn" => @resource_arn,
    "usersNoisePerQuery" => @users_noise_per_query,
  })
  result.compact
end