PipelineState class
Input properties used for looking up and filtering Pipeline resources.
Constructors
-
PipelineState({Input<
PipelineBufferOptions?> ? bufferOptions, Input<PipelineEncryptionAtRestOptions?> ? encryptionAtRestOptions, Input<List< ? ingestEndpointUrls, Input<String> ?>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< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>PipelineTimeouts?> ? timeouts, Input<PipelineVpcOptions?> ? vpcOptions}) -
Creates a new PipelineState.
bufferOptionsKey-value pairs to configure persistent buffering for the pipeline. SeebufferOptionsbelow.encryptionAtRestOptionsKey-value pairs to configure encryption for data that is written to a persistent buffer. SeeencryptionAtRestOptionsbelow.ingestEndpointUrlsThe list of ingestion endpoints for the pipeline, which you can send data to.logPublishingOptionsKey-value pairs to configure log publishing. SeelogPublishingOptionsbelow.maxUnitsThe maximum pipeline capacity, in Ingestion Compute Units (ICUs).minUnitsThe minimum pipeline capacity, in Ingestion Compute Units (ICUs).pipelineArnARN of the pipeline.pipelineConfigurationBodyThe 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.pipelineNameName of the pipeline. Pipeline names are unique across the pipelines owned by an account within an AWS Region.pipelineRoleArnARN of the IAM role that grants the pipeline permission to access AWS resources.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.tagsA map of tags to assign to the pipeline. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllOptional.timeoutsOptional.vpcOptionsContainer 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. SeevpcOptionsbelow.const -
PipelineState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
bufferOptions
→ Input<
PipelineBufferOptions?> ? -
Key-value pairs to configure persistent buffering for the pipeline. See
bufferOptionsbelow.final -
encryptionAtRestOptions
→ Input<
PipelineEncryptionAtRestOptions?> ? -
Key-value pairs to configure encryption for data that is written to a persistent buffer. See
encryptionAtRestOptionsbelow.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
logPublishingOptionsbelow.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
-
A map of tags to assign to the pipeline. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
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
vpcOptionsbelow.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