aws_osis_pipeline

account_id

Type: STRING

buffer_options

Type: STRUCT
Provider name: BufferOptions

• persistent_buffer_enabled
  Type: BOOLEAN
  Provider name: PersistentBufferEnabled
  Description: Whether persistent buffering should be enabled.
  

created_at

Type: TIMESTAMP
Provider name: CreatedAt
Description: The date and time when the pipeline was created.

destinations

Type: UNORDERED_LIST_STRUCT
Provider name: Destinations
Description: Destinations to which the pipeline writes data.

• endpoint
  Type: STRING
  Provider name: Endpoint
  Description: The endpoint receiving data from the pipeline.
  
• service_name
  Type: STRING
  Provider name: ServiceName
  Description: The name of the service receiving data from the pipeline.
  

encryption_at_rest_options

Type: STRUCT
Provider name: EncryptionAtRestOptions

• kms_key_arn
  Type: STRING
  Provider name: KmsKeyArn
  Description: The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key.
  

ingest_endpoint_urls

Type: UNORDERED_LIST_STRING
Provider name: IngestEndpointUrls
Description: The ingestion endpoints for the pipeline, which you can send data to.

last_updated_at

Type: TIMESTAMP
Provider name: LastUpdatedAt
Description: The date and time when the pipeline was last updated.

log_publishing_options

Type: STRUCT
Provider name: LogPublishingOptions
Description: Key-value pairs that represent log publishing settings.

• cloud_watch_log_destination
  Type: STRUCT
  Provider name: CloudWatchLogDestination
  Description: The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.
  
  • log_group
    Type: STRING
    Provider name: LogGroup
    Description: The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/vendedlogs/OpenSearchService/pipelines.
    
• is_logging_enabled
  Type: BOOLEAN
  Provider name: IsLoggingEnabled
  Description: Whether logs should be published.
  

max_units

Type: INT32
Provider name: MaxUnits
Description: The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

min_units

Type: INT32
Provider name: MinUnits
Description: The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

pipeline_arn

Type: STRING
Provider name: PipelineArn
Description: The Amazon Resource Name (ARN) of the pipeline.

pipeline_configuration_body

Type: STRING
Provider name: PipelineConfigurationBody
Description: The Data Prepper pipeline configuration in YAML format.

pipeline_name

Type: STRING
Provider name: PipelineName
Description: The name of the pipeline.

service_vpc_endpoints

Type: UNORDERED_LIST_STRUCT
Provider name: ServiceVpcEndpoints
Description: A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

• service_name
  Type: STRING
  Provider name: ServiceName
  Description: The name of the service for which a VPC endpoint was created.
  
• vpc_endpoint_id
  Type: STRING
  Provider name: VpcEndpointId
  Description: The unique identifier of the VPC endpoint that was created.
  

status

Type: STRING
Provider name: Status
Description: The current status of the pipeline.

status_reason

Type: STRUCT
Provider name: StatusReason
Description: The reason for the current status of the pipeline.

• description
  Type: STRING
  Provider name: Description
  Description: A description of why a pipeline has a certain status.
  

tags

Type: UNORDERED_LIST_STRING

vpc_endpoint_service

Type: STRING
Provider name: VpcEndpointService
Description: The VPC endpoint service name for the pipeline.

vpc_endpoints

Type: UNORDERED_LIST_STRUCT
Provider name: VpcEndpoints
Description: The VPC interface endpoints that have access to the pipeline.

• vpc_endpoint_id
  Type: STRING
  Provider name: VpcEndpointId
  Description: The unique identifier of the endpoint.
  
• vpc_id
  Type: STRING
  Provider name: VpcId
  Description: The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.
  
• vpc_options
  Type: STRUCT
  Provider name: VpcOptions
  Description: Information about the VPC, including associated subnets and security groups.
  
  • security_group_ids
    Type: UNORDERED_LIST_STRING
    Provider name: SecurityGroupIds
    Description: A list of security groups associated with the VPC endpoint.
    
  • subnet_ids
    Type: UNORDERED_LIST_STRING
    Provider name: SubnetIds
    Description: A list of subnet IDs associated with the VPC endpoint.
    
  • vpc_attachment_options
    Type: STRUCT
    Provider name: VpcAttachmentOptions
    Description: Options for attaching a VPC to a pipeline.
    
    • attach_to_vpc
      Type: BOOLEAN
      Provider name: AttachToVpc
      Description: Whether a VPC is attached to the pipeline.
      
    • cidr_block
      Type: STRING
      Provider name: CidrBlock
      Description: The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
      
  • vpc_endpoint_management
    Type: STRING
    Provider name: VpcEndpointManagement
    Description: Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.