Class: AWSCDK::CleanRooms::CfnMembershipProps

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

Overview

Properties for defining a CfnMembership.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collaboration_identifier:, query_log_status:, default_job_result_configuration: nil, default_result_configuration: nil, is_metrics_enabled: nil, job_log_status: nil, payment_configuration: nil, tags: nil) ⇒ CfnMembershipProps

Returns a new instance of CfnMembershipProps.

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'clean_rooms/cfn_membership_props.rb', line 17

def initialize(collaboration_identifier:, query_log_status:, default_job_result_configuration: nil, default_result_configuration: nil, is_metrics_enabled: nil, job_log_status: nil, payment_configuration: nil, tags: nil)
  @collaboration_identifier = collaboration_identifier
  Jsii::Type.check_type(@collaboration_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "collaborationIdentifier")
  @query_log_status = query_log_status
  Jsii::Type.check_type(@query_log_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryLogStatus")
  @default_job_result_configuration = default_job_result_configuration.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnMembership::MembershipProtectedJobResultConfigurationProperty.new(**default_job_result_configuration.transform_keys(&:to_sym)) : default_job_result_configuration
  Jsii::Type.check_type(@default_job_result_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbk1lbWJlcnNoaXAuTWVtYmVyc2hpcFByb3RlY3RlZEpvYlJlc3VsdENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "defaultJobResultConfiguration") unless @default_job_result_configuration.nil?
  @default_result_configuration = default_result_configuration.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnMembership::MembershipProtectedQueryResultConfigurationProperty.new(**default_result_configuration.transform_keys(&:to_sym)) : default_result_configuration
  Jsii::Type.check_type(@default_result_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbk1lbWJlcnNoaXAuTWVtYmVyc2hpcFByb3RlY3RlZFF1ZXJ5UmVzdWx0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "defaultResultConfiguration") unless @default_result_configuration.nil?
  @is_metrics_enabled = is_metrics_enabled
  Jsii::Type.check_type(@is_metrics_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isMetricsEnabled") unless @is_metrics_enabled.nil?
  @job_log_status = job_log_status
  Jsii::Type.check_type(@job_log_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobLogStatus") unless @job_log_status.nil?
  @payment_configuration = payment_configuration.is_a?(Hash) ? ::AWSCDK::CleanRooms::CfnMembership::MembershipPaymentConfigurationProperty.new(**payment_configuration.transform_keys(&:to_sym)) : payment_configuration
  Jsii::Type.check_type(@payment_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbGVhbnJvb21zLkNmbk1lbWJlcnNoaXAuTWVtYmVyc2hpcFBheW1lbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "paymentConfiguration") unless @payment_configuration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#collaboration_identifier ⇒ String (readonly)

The unique ID for the associated collaboration.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'clean_rooms/cfn_membership_props.rb', line 40

def collaboration_identifier
  @collaboration_identifier
end

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

The default job result configuration for the membership.

Returns:

See Also:



52
53
54
 
# File 'clean_rooms/cfn_membership_props.rb', line 52

def default_job_result_configuration
  @default_job_result_configuration
end

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

The default protected query result configuration as specified by the member who can receive results.

Returns:

See Also:



57
58
59
 
# File 'clean_rooms/cfn_membership_props.rb', line 57

def default_result_configuration
  @default_result_configuration
end

#is_metrics_enabled ⇒ Boolean, ... (readonly)

Returns:

See Also:



60
61
62
 
# File 'clean_rooms/cfn_membership_props.rb', line 60

def is_metrics_enabled
  @is_metrics_enabled
end

#job_log_status ⇒ String? (readonly)

An indicator as to whether job logging has been enabled or disabled for the collaboration.

When ENABLED , AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED .

Returns:

  • (String, nil)

See Also:



67
68
69
 
# File 'clean_rooms/cfn_membership_props.rb', line 67

def job_log_status
  @job_log_status
end

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

The payment responsibilities accepted by the collaboration member.

Returns:

See Also:



72
73
74
 
# File 'clean_rooms/cfn_membership_props.rb', line 72

def payment_configuration
  @payment_configuration
end

#query_log_status ⇒ String (readonly)

An indicator as to whether query logging has been enabled or disabled for the membership.

When ENABLED , AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED .

Returns:

  • (String)

See Also:



47
48
49
 
# File 'clean_rooms/cfn_membership_props.rb', line 47

def query_log_status
  @query_log_status
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An optional label that you can assign to a resource when you create it.

Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Returns:

See Also:



79
80
81
 
# File 'clean_rooms/cfn_membership_props.rb', line 79

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'clean_rooms/cfn_membership_props.rb', line 81

def self.jsii_properties
  {
    :collaboration_identifier => "collaborationIdentifier",
    :query_log_status => "queryLogStatus",
    :default_job_result_configuration => "defaultJobResultConfiguration",
    :default_result_configuration => "defaultResultConfiguration",
    :is_metrics_enabled => "isMetricsEnabled",
    :job_log_status => "jobLogStatus",
    :payment_configuration => "paymentConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'clean_rooms/cfn_membership_props.rb', line 94

def to_jsii
  result = {}
  result.merge!({
    "collaborationIdentifier" => @collaboration_identifier,
    "queryLogStatus" => @query_log_status,
    "defaultJobResultConfiguration" => @default_job_result_configuration,
    "defaultResultConfiguration" => @default_result_configuration,
    "isMetricsEnabled" => @is_metrics_enabled,
    "jobLogStatus" => @job_log_status,
    "paymentConfiguration" => @payment_configuration,
    "tags" => @tags,
  })
  result.compact
end