Class: Aws::CleanRooms::Types::PrivacyBudgetTemplate

Inherits:

Struct

• Object
• Struct
• Aws::CleanRooms::Types::PrivacyBudgetTemplate

Defined in:

gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb

Overview

An object that defines the privacy budget template.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the privacy budget template.

• #auto_refresh ⇒ String

  How often the privacy budget refreshes.

• #collaboration_arn ⇒ String

  The ARN of the collaboration that contains this privacy budget template.

• #collaboration_id ⇒ String

  The unique ID of the collaboration that contains this privacy budget template.

• #create_time ⇒ Time

  The time at which the privacy budget template was created.

• #id ⇒ String

  The unique identifier of the privacy budget template.

• #membership_arn ⇒ String

  The Amazon Resource Name (ARN) of the member who created the privacy budget template.

• #membership_id ⇒ String

  The identifier for a membership resource.

• #parameters ⇒ Types::PrivacyBudgetTemplateParametersOutput

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

• #privacy_budget_type ⇒ String

  Specifies the type of the privacy budget template.

• #update_time ⇒ Time

  The most recent time at which the privacy budget template was updated.

Instance Attribute Details

#arn ⇒ String

The ARN of the privacy budget template.

Returns:

• (String)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#auto_refresh ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#collaboration_arn ⇒ String

The ARN of the collaboration that contains this privacy budget template.

Returns:

• (String)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#collaboration_id ⇒ String

The unique ID of the collaboration that contains this privacy budget template.

Returns:

• (String)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

The time at which the privacy budget template was created.

Returns:

• (Time)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the privacy budget template.

Returns:

• (String)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#membership_arn ⇒ String

The Amazon Resource Name (ARN) of the member who created the privacy budget template.

Returns:

• (String)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#membership_id ⇒ String

The identifier for a membership resource.

Returns:

• (String)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Types::PrivacyBudgetTemplateParametersOutput

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

Returns:

• (Types::PrivacyBudgetTemplateParametersOutput)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#privacy_budget_type ⇒ String

Specifies the type of the privacy budget template.

Returns:

• (String)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#update_time ⇒ Time

The most recent time at which the privacy budget template was updated.

Returns:

• (Time)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 6273

class PrivacyBudgetTemplate < Struct.new(
  :id,
  :arn,
  :membership_id,
  :membership_arn,
  :collaboration_id,
  :collaboration_arn,
  :create_time,
  :update_time,
  :privacy_budget_type,
  :auto_refresh,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end