Interface OpenSearchIntegrationDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OpenSearchIntegrationDetails.Builder,OpenSearchIntegrationDetails>, SdkBuilder<OpenSearchIntegrationDetails.Builder,OpenSearchIntegrationDetails>, SdkPojo

Enclosing class:

OpenSearchIntegrationDetails

@Mutable
@NotThreadSafe
public static interface OpenSearchIntegrationDetails.Builder
extends SdkPojo, CopyableBuilder<OpenSearchIntegrationDetails.Builder,OpenSearchIntegrationDetails>

Method Summary

Modifier and Type	Method	Description
default OpenSearchIntegrationDetails.Builder	accessPolicy(Consumer<OpenSearchDataAccessPolicy.Builder> accessPolicy)	This structure contains information about the OpenSearch Service data access policy used for this integration.
OpenSearchIntegrationDetails.Builder	accessPolicy(OpenSearchDataAccessPolicy accessPolicy)	This structure contains information about the OpenSearch Service data access policy used for this integration.
default OpenSearchIntegrationDetails.Builder	application(Consumer<OpenSearchApplication.Builder> application)	This structure contains information about the OpenSearch Service application used for this integration.
OpenSearchIntegrationDetails.Builder	application(OpenSearchApplication application)	This structure contains information about the OpenSearch Service application used for this integration.
default OpenSearchIntegrationDetails.Builder	collection(Consumer<OpenSearchCollection.Builder> collection)	This structure contains information about the OpenSearch Service collection used for this integration.
OpenSearchIntegrationDetails.Builder	collection(OpenSearchCollection collection)	This structure contains information about the OpenSearch Service collection used for this integration.
default OpenSearchIntegrationDetails.Builder	dataSource(Consumer<OpenSearchDataSource.Builder> dataSource)	This structure contains information about the OpenSearch Service data source used for this integration.
OpenSearchIntegrationDetails.Builder	dataSource(OpenSearchDataSource dataSource)	This structure contains information about the OpenSearch Service data source used for this integration.
default OpenSearchIntegrationDetails.Builder	encryptionPolicy(Consumer<OpenSearchEncryptionPolicy.Builder> encryptionPolicy)	This structure contains information about the OpenSearch Service encryption policy used for this integration.
OpenSearchIntegrationDetails.Builder	encryptionPolicy(OpenSearchEncryptionPolicy encryptionPolicy)	This structure contains information about the OpenSearch Service encryption policy used for this integration.
default OpenSearchIntegrationDetails.Builder	lifecyclePolicy(Consumer<OpenSearchLifecyclePolicy.Builder> lifecyclePolicy)	This structure contains information about the OpenSearch Service data lifecycle policy used for this integration.
OpenSearchIntegrationDetails.Builder	lifecyclePolicy(OpenSearchLifecyclePolicy lifecyclePolicy)	This structure contains information about the OpenSearch Service data lifecycle policy used for this integration.
default OpenSearchIntegrationDetails.Builder	networkPolicy(Consumer<OpenSearchNetworkPolicy.Builder> networkPolicy)	This structure contains information about the OpenSearch Service network policy used for this integration.
OpenSearchIntegrationDetails.Builder	networkPolicy(OpenSearchNetworkPolicy networkPolicy)	This structure contains information about the OpenSearch Service network policy used for this integration.
default OpenSearchIntegrationDetails.Builder	workspace(Consumer<OpenSearchWorkspace.Builder> workspace)	This structure contains information about the OpenSearch Service workspace used for this integration.
OpenSearchIntegrationDetails.Builder	workspace(OpenSearchWorkspace workspace)	This structure contains information about the OpenSearch Service workspace used for this integration.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

dataSource

OpenSearchIntegrationDetails.Builder dataSource(OpenSearchDataSource dataSource)

This structure contains information about the OpenSearch Service data source used for this integration. This data source was created as part of the integration setup. An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It includes the role required to execute queries and write to collections.

For more information about OpenSearch Service data sources , see Creating OpenSearch Service data source integrations with Amazon S3.

Parameters:

dataSource - This structure contains information about the OpenSearch Service data source used for this integration. This data source was created as part of the integration setup. An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It includes the role required to execute queries and write to collections.

For more information about OpenSearch Service data sources , see Creating OpenSearch Service data source integrations with Amazon S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSource

default OpenSearchIntegrationDetails.Builder dataSource(Consumer<OpenSearchDataSource.Builder> dataSource)

This structure contains information about the OpenSearch Service data source used for this integration. This data source was created as part of the integration setup. An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It includes the role required to execute queries and write to collections.

For more information about OpenSearch Service data sources , see Creating OpenSearch Service data source integrations with Amazon S3.

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

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

Parameters:

dataSource - a consumer that will call methods on OpenSearchDataSource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• dataSource(OpenSearchDataSource)

application

OpenSearchIntegrationDetails.Builder application(OpenSearchApplication application)

This structure contains information about the OpenSearch Service application used for this integration. An OpenSearch Service application is the web application that was created by the integration with CloudWatch Logs. It hosts the vended logs dashboards.

Parameters:

application - This structure contains information about the OpenSearch Service application used for this integration. An OpenSearch Service application is the web application that was created by the integration with CloudWatch Logs. It hosts the vended logs dashboards.

Returns:

Returns a reference to this object so that method calls can be chained together.

application

default OpenSearchIntegrationDetails.Builder application(Consumer<OpenSearchApplication.Builder> application)

This structure contains information about the OpenSearch Service application used for this integration. An OpenSearch Service application is the web application that was created by the integration with CloudWatch Logs. It hosts the vended logs dashboards.

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

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

Parameters:

application - a consumer that will call methods on OpenSearchApplication.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• application(OpenSearchApplication)

collection

OpenSearchIntegrationDetails.Builder collection(OpenSearchCollection collection)

This structure contains information about the OpenSearch Service collection used for this integration. This collection was created as part of the integration setup. An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload. For more information, see Creating and managing OpenSearch Service Serverless collections.

Parameters:

collection - This structure contains information about the OpenSearch Service collection used for this integration. This collection was created as part of the integration setup. An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload. For more information, see Creating and managing OpenSearch Service Serverless collections.

Returns:

Returns a reference to this object so that method calls can be chained together.

collection

default OpenSearchIntegrationDetails.Builder collection(Consumer<OpenSearchCollection.Builder> collection)

This structure contains information about the OpenSearch Service collection used for this integration. This collection was created as part of the integration setup. An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload. For more information, see Creating and managing OpenSearch Service Serverless collections.

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

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

Parameters:

collection - a consumer that will call methods on OpenSearchCollection.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• collection(OpenSearchCollection)

workspace

OpenSearchIntegrationDetails.Builder workspace(OpenSearchWorkspace workspace)

This structure contains information about the OpenSearch Service workspace used for this integration. An OpenSearch Service workspace is the collection of dashboards along with other OpenSearch Service tools. This workspace was created automatically as part of the integration setup. For more information, see Centralized OpenSearch user interface (Dashboards) with OpenSearch Service.

Parameters:

workspace - This structure contains information about the OpenSearch Service workspace used for this integration. An OpenSearch Service workspace is the collection of dashboards along with other OpenSearch Service tools. This workspace was created automatically as part of the integration setup. For more information, see Centralized OpenSearch user interface (Dashboards) with OpenSearch Service.

Returns:

Returns a reference to this object so that method calls can be chained together.

workspace

default OpenSearchIntegrationDetails.Builder workspace(Consumer<OpenSearchWorkspace.Builder> workspace)

This structure contains information about the OpenSearch Service workspace used for this integration. An OpenSearch Service workspace is the collection of dashboards along with other OpenSearch Service tools. This workspace was created automatically as part of the integration setup. For more information, see Centralized OpenSearch user interface (Dashboards) with OpenSearch Service.

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

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

Parameters:

workspace - a consumer that will call methods on OpenSearchWorkspace.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• workspace(OpenSearchWorkspace)

encryptionPolicy

OpenSearchIntegrationDetails.Builder encryptionPolicy(OpenSearchEncryptionPolicy encryptionPolicy)

This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created automatically when you created the integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.

Parameters:

encryptionPolicy - This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created automatically when you created the integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionPolicy

default OpenSearchIntegrationDetails.Builder encryptionPolicy(Consumer<OpenSearchEncryptionPolicy.Builder> encryptionPolicy)

This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created automatically when you created the integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.

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

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

Parameters:

encryptionPolicy - a consumer that will call methods on OpenSearchEncryptionPolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• encryptionPolicy(OpenSearchEncryptionPolicy)

networkPolicy

OpenSearchIntegrationDetails.Builder networkPolicy(OpenSearchNetworkPolicy networkPolicy)

This structure contains information about the OpenSearch Service network policy used for this integration. The network policy assigns network access settings to collections. For more information, see Network policies in the OpenSearch Service Developer Guide.

Parameters:

networkPolicy - This structure contains information about the OpenSearch Service network policy used for this integration. The network policy assigns network access settings to collections. For more information, see Network policies in the OpenSearch Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkPolicy

default OpenSearchIntegrationDetails.Builder networkPolicy(Consumer<OpenSearchNetworkPolicy.Builder> networkPolicy)

This structure contains information about the OpenSearch Service network policy used for this integration. The network policy assigns network access settings to collections. For more information, see Network policies in the OpenSearch Service Developer Guide.

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

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

Parameters:

networkPolicy - a consumer that will call methods on OpenSearchNetworkPolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• networkPolicy(OpenSearchNetworkPolicy)

accessPolicy

OpenSearchIntegrationDetails.Builder accessPolicy(OpenSearchDataAccessPolicy accessPolicy)

This structure contains information about the OpenSearch Service data access policy used for this integration. The access policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup. For more information about OpenSearch Service data access policies, see Data access control for Amazon OpenSearch Serverless in the OpenSearch Service Developer Guide.

Parameters:

accessPolicy - This structure contains information about the OpenSearch Service data access policy used for this integration. The access policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup. For more information about OpenSearch Service data access policies, see Data access control for Amazon OpenSearch Serverless in the OpenSearch Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

accessPolicy

default OpenSearchIntegrationDetails.Builder accessPolicy(Consumer<OpenSearchDataAccessPolicy.Builder> accessPolicy)

This structure contains information about the OpenSearch Service data access policy used for this integration. The access policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup. For more information about OpenSearch Service data access policies, see Data access control for Amazon OpenSearch Serverless in the OpenSearch Service Developer Guide.

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

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

Parameters:

accessPolicy - a consumer that will call methods on OpenSearchDataAccessPolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• accessPolicy(OpenSearchDataAccessPolicy)

lifecyclePolicy

OpenSearchIntegrationDetails.Builder lifecyclePolicy(OpenSearchLifecyclePolicy lifecyclePolicy)

This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy determines the lifespan of the data in the collection. It was automatically created as part of the integration setup.

For more information, see Using data lifecycle policies with OpenSearch Service Serverless in the OpenSearch Service Developer Guide.

Parameters:

lifecyclePolicy - This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy determines the lifespan of the data in the collection. It was automatically created as part of the integration setup.

For more information, see Using data lifecycle policies with OpenSearch Service Serverless in the OpenSearch Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecyclePolicy

default OpenSearchIntegrationDetails.Builder lifecyclePolicy(Consumer<OpenSearchLifecyclePolicy.Builder> lifecyclePolicy)

This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy determines the lifespan of the data in the collection. It was automatically created as part of the integration setup.

For more information, see Using data lifecycle policies with OpenSearch Service Serverless in the OpenSearch Service Developer Guide.

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

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

Parameters:

lifecyclePolicy - a consumer that will call methods on OpenSearchLifecyclePolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• lifecyclePolicy(OpenSearchLifecyclePolicy)