Class: Aws::CleanRooms::Types::CreateCollaborationInput

Inherits:

Struct

Object
Struct
Aws::CleanRooms::Types::CreateCollaborationInput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cleanrooms/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#allowed_result_regions ⇒ Array<String>

The Amazon Web Services Regions where collaboration query results can be stored.
#analytics_engine ⇒ String

The analytics engine.
#auto_approved_change_request_types ⇒ Array<String>

The types of change requests that are automatically approved for this collaboration.
#creator_display_name ⇒ String

The display name of the collaboration creator.
#creator_member_abilities ⇒ Array<String>

The abilities granted to the collaboration creator.
#creator_ml_member_abilities ⇒ Types::MLMemberAbilities

The ML abilities granted to the collaboration creator.
#creator_payment_configuration ⇒ Types::PaymentConfiguration

The collaboration creator’s payment responsibilities set by the collaboration creator.
#data_encryption_metadata ⇒ Types::DataEncryptionMetadata

The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
#description ⇒ String

A description of the collaboration provided by the collaboration owner.
#job_log_status ⇒ String

Specifies whether job logs are enabled for this collaboration.
#members ⇒ Array<Types::MemberSpecification>

A list of initial members, not including the creator.
#name ⇒ String

The display name for a collaboration.
#query_log_status ⇒ String

An indicator as to whether query logging has been enabled or disabled for the collaboration.
#tags ⇒ Hash<String,String>

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

Instance Attribute Details

#allowed_result_regions ⇒ `Array<String>`

The Amazon Web Services Regions where collaboration query results can be stored. When specified, results can only be written to these Regions. This parameter enables you to meet your compliance and data governance requirements, and implement regional data governance policies.

Returns:

(Array<String>)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#analytics_engine ⇒ `String`

The analytics engine.

<note markdown=“1”> After July 16, 2025, the ‘CLEAN_ROOMS_SQL` parameter will no longer be available.

</note>

Returns:

(String)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#auto_approved_change_request_types ⇒ `Array<String>`

The types of change requests that are automatically approved for this collaboration.

Returns:

(Array<String>)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#creator_display_name ⇒ `String`

The display name of the collaboration creator.

Returns:

(String)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#creator_member_abilities ⇒ `Array<String>`

The abilities granted to the collaboration creator.

Returns:

(Array<String>)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#creator_ml_member_abilities ⇒ `Types::MLMemberAbilities`

The ML abilities granted to the collaboration creator.

Returns:

(Types::MLMemberAbilities)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#creator_payment_configuration ⇒ `Types::PaymentConfiguration`

The collaboration creator’s payment responsibilities set by the collaboration creator.

If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer.

Returns:

(Types::PaymentConfiguration)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#data_encryption_metadata ⇒ `Types::DataEncryptionMetadata`

The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

Returns:

(Types::DataEncryptionMetadata)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description of the collaboration provided by the collaboration owner.

Returns:

(String)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#job_log_status ⇒ `String`

Specifies whether job logs are enabled for this collaboration.

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

Returns:

(String)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#members ⇒ `Array<Types::MemberSpecification>`

A list of initial members, not including the creator. This list is immutable.

Returns:

(Array<Types::MemberSpecification>)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The display name for a collaboration.

Returns:

(String)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

#query_log_status ⇒ `String`

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

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)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  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>)

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

class CreateCollaborationInput < Struct.new(
  :members,
  :name,
  :description,
  :creator_member_abilities,
  :creator_ml_member_abilities,
  :creator_display_name,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :tags,
  :creator_payment_configuration,
  :analytics_engine,
  :auto_approved_change_request_types,
  :allowed_result_regions)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CleanRooms::Types::CreateCollaborationInput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_result_regions ⇒ Array<String>

#analytics_engine ⇒ String

#auto_approved_change_request_types ⇒ Array<String>

#creator_display_name ⇒ String

#creator_member_abilities ⇒ Array<String>

#creator_ml_member_abilities ⇒ Types::MLMemberAbilities

#creator_payment_configuration ⇒ Types::PaymentConfiguration

#data_encryption_metadata ⇒ Types::DataEncryptionMetadata

#description ⇒ String

#job_log_status ⇒ String

#members ⇒ Array<Types::MemberSpecification>

#name ⇒ String

#query_log_status ⇒ String

#tags ⇒ Hash<String,String>

#allowed_result_regions ⇒ `Array<String>`

#analytics_engine ⇒ `String`

#auto_approved_change_request_types ⇒ `Array<String>`

#creator_display_name ⇒ `String`

#creator_member_abilities ⇒ `Array<String>`

#creator_ml_member_abilities ⇒ `Types::MLMemberAbilities`

#creator_payment_configuration ⇒ `Types::PaymentConfiguration`

#data_encryption_metadata ⇒ `Types::DataEncryptionMetadata`

#description ⇒ `String`

#job_log_status ⇒ `String`

#members ⇒ `Array<Types::MemberSpecification>`

#name ⇒ `String`

#query_log_status ⇒ `String`

#tags ⇒ `Hash<String,String>`