PipelineState class

Input properties used for looking up and filtering Pipeline resources.

Constructors

PipelineState({Input<PipelineBufferOptions?>? bufferOptions, Input<PipelineEncryptionAtRestOptions?>? encryptionAtRestOptions, Input<List<String>?>? ingestEndpointUrls, Input<PipelineLogPublishingOptions?>? logPublishingOptions, Input<int?>? maxUnits, Input<int?>? minUnits, Input<String?>? pipelineArn, Input<String?>? pipelineConfigurationBody, Input<String?>? pipelineName, Input<String?>? pipelineRoleArn, Input<String?>? region, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<PipelineTimeouts?>? timeouts, Input<PipelineVpcOptions?>? vpcOptions})
Creates a new PipelineState. bufferOptions Key-value pairs to configure persistent buffering for the pipeline. See bufferOptions below. encryptionAtRestOptions Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryptionAtRestOptions below. ingestEndpointUrls The list of ingestion endpoints for the pipeline, which you can send data to. logPublishingOptions Key-value pairs to configure log publishing. See logPublishingOptions below. maxUnits The maximum pipeline capacity, in Ingestion Compute Units (ICUs). minUnits The minimum pipeline capacity, in Ingestion Compute Units (ICUs). pipelineArn ARN of the pipeline. pipelineConfigurationBody The pipeline configuration in YAML format. This argument accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n. pipelineName Name of the pipeline. Pipeline names are unique across the pipelines owned by an account within an AWS Region. pipelineRoleArn ARN of the IAM role that grants the pipeline permission to access AWS resources. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. tags A map of tags to assign to the pipeline. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Optional. timeouts Optional. vpcOptions Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint. See vpcOptions below.
const
PipelineState.fromMap(Map<String, dynamic> map)
factory

Properties

bufferOptions → Input<PipelineBufferOptions?>?
Key-value pairs to configure persistent buffering for the pipeline. See bufferOptions below.
final
encryptionAtRestOptions → Input<PipelineEncryptionAtRestOptions?>?
Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryptionAtRestOptions below.
final
hashCode → int
The hash code for this object.
no setterinherited
ingestEndpointUrls → Input<List<String>?>?
The list of ingestion endpoints for the pipeline, which you can send data to.
final
logPublishingOptions → Input<PipelineLogPublishingOptions?>?
Key-value pairs to configure log publishing. See logPublishingOptions below.
final
maxUnits → Input<int?>?
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
final
minUnits → Input<int?>?
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
final
pipelineArn → Input<String?>?
ARN of the pipeline.
final
pipelineConfigurationBody → Input<String?>?
The pipeline configuration in YAML format. This argument accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.
final
pipelineName → Input<String?>?
Name of the pipeline. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
final
pipelineRoleArn → Input<String?>?
ARN of the IAM role that grants the pipeline permission to access AWS resources.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<Map<String, String>?>?
A map of tags to assign to the pipeline. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
final
timeouts → Input<PipelineTimeouts?>?
final
vpcOptions → Input<PipelineVpcOptions?>?
Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint. See vpcOptions below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited