Interface AddDirectQueryDataSourceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<AddDirectQueryDataSourceRequest.Builder,AddDirectQueryDataSourceRequest>, OpenSearchRequest.Builder, SdkBuilder<AddDirectQueryDataSourceRequest.Builder,AddDirectQueryDataSourceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
AddDirectQueryDataSourceRequest
@Mutable @NotThreadSafe public static interface AddDirectQueryDataSourceRequest.Builder extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<AddDirectQueryDataSourceRequest.Builder,AddDirectQueryDataSourceRequest>

  • Method Details

    • dataSourceName

      AddDirectQueryDataSourceRequest.Builder dataSourceName(String dataSourceName)

      A unique, user-defined label to identify the data source within your OpenSearch Service environment.

      Parameters:
      dataSourceName - A unique, user-defined label to identify the data source within your OpenSearch Service environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceType

      AddDirectQueryDataSourceRequest.Builder dataSourceType(DirectQueryDataSourceType dataSourceType)

      The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.

      Parameters:
      dataSourceType - The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceType

      default AddDirectQueryDataSourceRequest.Builder dataSourceType(Consumer<DirectQueryDataSourceType.Builder> dataSourceType)

      The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.

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

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

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

    • description

      AddDirectQueryDataSourceRequest.Builder description(String description)

      An optional text field for providing additional context and details about the data source.

      Parameters:
      description - An optional text field for providing additional context and details about the data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openSearchArns

      AddDirectQueryDataSourceRequest.Builder openSearchArns(Collection<String> openSearchArns)

      An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. This field is required for CloudWatchLogs and SecurityLake datasource types.

      Parameters:
      openSearchArns - An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. This field is required for CloudWatchLogs and SecurityLake datasource types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openSearchArns

      AddDirectQueryDataSourceRequest.Builder openSearchArns(String... openSearchArns)

      An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. This field is required for CloudWatchLogs and SecurityLake datasource types.

      Parameters:
      openSearchArns - An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. This field is required for CloudWatchLogs and SecurityLake datasource types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceAccessPolicy

      AddDirectQueryDataSourceRequest.Builder dataSourceAccessPolicy(String dataSourceAccessPolicy)

      An optional IAM access policy document that defines the permissions for accessing the data source. The policy document must be in valid JSON format and follow IAM policy syntax.

      Parameters:
      dataSourceAccessPolicy - An optional IAM access policy document that defines the permissions for accessing the data source. The policy document must be in valid JSON format and follow IAM policy syntax.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagList

      AddDirectQueryDataSourceRequest.Builder tagList(Collection<Tag> tagList)
      Sets the value of the TagList property for this object.
      Parameters:
      tagList - The new value for the TagList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagList

      AddDirectQueryDataSourceRequest.Builder tagList(Tag... tagList)
      Sets the value of the TagList property for this object.
      Parameters:
      tagList - The new value for the TagList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagList

      AddDirectQueryDataSourceRequest.Builder tagList(Consumer<Tag.Builder>... tagList)
      Sets the value of the TagList property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagList(List<Tag>).

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

    • overrideConfiguration

      AddDirectQueryDataSourceRequest.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

      AddDirectQueryDataSourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.