Class: Aws::CleanRooms::Types::CreateMembershipInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cleanrooms/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#collaboration_identifier ⇒ String

The unique ID for the associated collaboration.

Returns:

  • (String) 


3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3934

class CreateMembershipInput < Struct.new(
  :collaboration_identifier,
  :query_log_status,
  :job_log_status,
  :tags,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#default_job_result_configuration ⇒ Types::MembershipProtectedJobResultConfiguration

The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.

Returns:



3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3934

class CreateMembershipInput < Struct.new(
  :collaboration_identifier,
  :query_log_status,
  :job_log_status,
  :tags,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#default_result_configuration ⇒ Types::MembershipProtectedQueryResultConfiguration

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

Returns:



3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3934

class CreateMembershipInput < Struct.new(
  :collaboration_identifier,
  :query_log_status,
  :job_log_status,
  :tags,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#is_metrics_enabled ⇒ Boolean

An indicator as to whether Amazon CloudWatch metrics have been enabled or disabled for the membership.

Amazon CloudWatch metrics are only available when the collaboration has metrics enabled. This option can be set by collaboration members who have the ability to run queries (analysis runners) or by members who are configured as payers.

When true, metrics about query execution are collected in Amazon CloudWatch. The default value is false.

Returns:

  • (Boolean) 


3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3934

class CreateMembershipInput < Struct.new(
  :collaboration_identifier,
  :query_log_status,
  :job_log_status,
  :tags,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#job_log_status ⇒ String

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

When ENABLED, 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) 


3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3934

class CreateMembershipInput < Struct.new(
  :collaboration_identifier,
  :query_log_status,
  :job_log_status,
  :tags,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#payment_configuration ⇒ Types::MembershipPaymentConfiguration

The payment responsibilities accepted by the collaboration member.

Not required if the collaboration member has the member ability to run queries.

Required if the collaboration member doesn’t have the member ability to run queries but is configured as a payer by the collaboration creator.

Returns:



3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3934

class CreateMembershipInput < Struct.new(
  :collaboration_identifier,
  :query_log_status,
  :job_log_status,
  :tags,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#query_log_status ⇒ String

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

When ENABLED, 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) 


3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3934

class CreateMembershipInput < Struct.new(
  :collaboration_identifier,
  :query_log_status,
  :job_log_status,
  :tags,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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:

  • (Hash<String,String>) 


3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3934

class CreateMembershipInput < Struct.new(
  :collaboration_identifier,
  :query_log_status,
  :job_log_status,
  :tags,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end