Interface CreateMembershipRequest.Builder

  • Method Details

    • collaborationIdentifier

      CreateMembershipRequest.Builder collaborationIdentifier(String collaborationIdentifier)

      The unique ID for the associated collaboration.

      Parameters:
      collaborationIdentifier - The unique ID for the associated collaboration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • queryLogStatus

      CreateMembershipRequest.Builder queryLogStatus(String queryLogStatus)

      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.

      Parameters:
      queryLogStatus - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • queryLogStatus

      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.

      Parameters:
      queryLogStatus - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • jobLogStatus

      CreateMembershipRequest.Builder jobLogStatus(String jobLogStatus)

      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.

      Parameters:
      jobLogStatus - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • jobLogStatus

      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.

      Parameters:
      jobLogStatus - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • tags

      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.

      Parameters:
      tags - 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:
      Returns a reference to this object so that method calls can be chained together.
    • defaultResultConfiguration

      CreateMembershipRequest.Builder defaultResultConfiguration(MembershipProtectedQueryResultConfiguration defaultResultConfiguration)

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

      Parameters:
      defaultResultConfiguration - The default protected query result configuration as specified by the member who can receive results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • defaultResultConfiguration

      default CreateMembershipRequest.Builder defaultResultConfiguration(Consumer<MembershipProtectedQueryResultConfiguration.Builder> defaultResultConfiguration)

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

      This is a convenience method that creates an instance of the MembershipProtectedQueryResultConfiguration.Builder avoiding the need to create one manually via MembershipProtectedQueryResultConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultResultConfiguration(MembershipProtectedQueryResultConfiguration).

      Parameters:
      defaultResultConfiguration - a consumer that will call methods on MembershipProtectedQueryResultConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • defaultJobResultConfiguration

      CreateMembershipRequest.Builder defaultJobResultConfiguration(MembershipProtectedJobResultConfiguration defaultJobResultConfiguration)

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

      Parameters:
      defaultJobResultConfiguration - The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • defaultJobResultConfiguration

      default CreateMembershipRequest.Builder defaultJobResultConfiguration(Consumer<MembershipProtectedJobResultConfiguration.Builder> defaultJobResultConfiguration)

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

      This is a convenience method that creates an instance of the MembershipProtectedJobResultConfiguration.Builder avoiding the need to create one manually via MembershipProtectedJobResultConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultJobResultConfiguration(MembershipProtectedJobResultConfiguration).

      Parameters:
      defaultJobResultConfiguration - a consumer that will call methods on MembershipProtectedJobResultConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • paymentConfiguration

      CreateMembershipRequest.Builder paymentConfiguration(MembershipPaymentConfiguration paymentConfiguration)

      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.

      Parameters:
      paymentConfiguration - 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:
      Returns a reference to this object so that method calls can be chained together.
    • paymentConfiguration

      default CreateMembershipRequest.Builder paymentConfiguration(Consumer<MembershipPaymentConfiguration.Builder> paymentConfiguration)

      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.

      This is a convenience method that creates an instance of the MembershipPaymentConfiguration.Builder avoiding the need to create one manually via MembershipPaymentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to paymentConfiguration(MembershipPaymentConfiguration).

      Parameters:
      paymentConfiguration - a consumer that will call methods on MembershipPaymentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • isMetricsEnabled

      CreateMembershipRequest.Builder isMetricsEnabled(Boolean isMetricsEnabled)

      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.

      Parameters:
      isMetricsEnabled - 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:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      CreateMembershipRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.