Struct aws_sdk_osis::types::Pipeline

#[non_exhaustive]
pub struct Pipeline {

    pub pipeline_name: Option<String>,
    pub pipeline_arn: Option<String>,
    pub min_units: i32,
    pub max_units: i32,
    pub status: Option<PipelineStatus>,
    pub status_reason: Option<PipelineStatusReason>,
    pub pipeline_configuration_body: Option<String>,
    pub created_at: Option<DateTime>,
    pub last_updated_at: Option<DateTime>,
    pub ingest_endpoint_urls: Option<Vec<String>>,
    pub log_publishing_options: Option<LogPublishingOptions>,
    pub vpc_endpoints: Option<Vec<VpcEndpoint>>,
    pub buffer_options: Option<BufferOptions>,
    pub encryption_at_rest_options: Option<EncryptionAtRestOptions>,
    pub vpc_endpoint_service: Option<String>,
    pub service_vpc_endpoints: Option<Vec<ServiceVpcEndpoint>>,
    pub destinations: Option<Vec<PipelineDestination>>,
    pub tags: Option<Vec<Tag>>,
}

Information about an existing OpenSearch Ingestion pipeline.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pipeline_name: Option<String>

The name of the pipeline.

pipeline_arn: Option<String>

The Amazon Resource Name (ARN) of the pipeline.

min_units: i32

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

max_units: i32

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

status: Option<PipelineStatus>

The current status of the pipeline.

status_reason: Option<PipelineStatusReason>

The reason for the current status of the pipeline.

pipeline_configuration_body: Option<String>

The Data Prepper pipeline configuration in YAML format.

created_at: Option<DateTime>

The date and time when the pipeline was created.

last_updated_at: Option<DateTime>

The date and time when the pipeline was last updated.

ingest_endpoint_urls: Option<Vec<String>>

The ingestion endpoints for the pipeline, which you can send data to.

log_publishing_options: Option<LogPublishingOptions>

Key-value pairs that represent log publishing settings.

vpc_endpoints: Option<Vec<VpcEndpoint>>

The VPC interface endpoints that have access to the pipeline.

buffer_options: Option<BufferOptions>

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.

encryption_at_rest_options: Option<EncryptionAtRestOptions>

Options to control how OpenSearch encrypts buffer data.

vpc_endpoint_service: Option<String>

The VPC endpoint service name for the pipeline.

service_vpc_endpoints: Option<Vec<ServiceVpcEndpoint>>

A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

destinations: Option<Vec<PipelineDestination>>

Destinations to which the pipeline writes data.

tags: Option<Vec<Tag>>

A list of tags associated with the given pipeline.

Implementations

impl Pipeline

pub fn pipeline_name(&self) -> Option<&str>

The name of the pipeline.

pub fn pipeline_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the pipeline.

pub fn min_units(&self) -> i32

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

pub fn max_units(&self) -> i32

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

pub fn status(&self) -> Option<&PipelineStatus>

The current status of the pipeline.

pub fn status_reason(&self) -> Option<&PipelineStatusReason>

The reason for the current status of the pipeline.

pub fn pipeline_configuration_body(&self) -> Option<&str>

The Data Prepper pipeline configuration in YAML format.

pub fn created_at(&self) -> Option<&DateTime>

The date and time when the pipeline was created.

pub fn last_updated_at(&self) -> Option<&DateTime>

The date and time when the pipeline was last updated.

pub fn ingest_endpoint_urls(&self) -> &[String]

The ingestion endpoints for the pipeline, which you can send data to.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ingest_endpoint_urls.is_none().

pub fn log_publishing_options(&self) -> Option<&LogPublishingOptions>

Key-value pairs that represent log publishing settings.

pub fn vpc_endpoints(&self) -> &[VpcEndpoint]

The VPC interface endpoints that have access to the pipeline.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_endpoints.is_none().

pub fn buffer_options(&self) -> Option<&BufferOptions>

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.

pub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>

Options to control how OpenSearch encrypts buffer data.

pub fn vpc_endpoint_service(&self) -> Option<&str>

The VPC endpoint service name for the pipeline.

pub fn service_vpc_endpoints(&self) -> &[ServiceVpcEndpoint]

A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .service_vpc_endpoints.is_none().

pub fn destinations(&self) -> &[PipelineDestination]

Destinations to which the pipeline writes data.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .destinations.is_none().

pub fn tags(&self) -> &[Tag]

A list of tags associated with the given pipeline.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl Pipeline

pub fn builder() -> PipelineBuilder

Creates a new builder-style object to manufacture Pipeline.

Trait Implementations

impl Clone for Pipeline

fn clone(&self) -> Pipeline

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pipeline

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Pipeline

fn eq(&self, other: &Pipeline) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Pipeline