OpenSearch Ingestion

1 resource kind. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

OSISPipeline # CLOUD CONTROL · AWS::OSIS::Pipeline

OSISPipeline manages AWS::OSIS::Pipeline through the AWS Cloud Control API.

kubectl get osispipelines · example on GitHub

Example

# OSISPipeline — OpenSearch Ingestion
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/osis.html#osispipeline
apiVersion: aws.konfig.io/v1alpha1
kind: OSISPipeline
metadata:
  name: example-osispipeline
  namespace: default
spec:
  bufferOptions:
    persistentBufferEnabled: true
  encryptionAtRestOptions:
    kmsKeyArn: arn:aws:iam::123456789012:role/example-role
  logPublishingOptions:
    cloudWatchLogDestination:
      logGroup: example
    isLoggingEnabled: true
  maxUnits: 1
  minUnits: 1
  pipelineConfigurationBody: example
  pipelineName: example-osispipeline
  pipelineRoleArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-osispipeline
    region: us-east-1
  tags:
  - key: example
    value: example
  vpcOptions:
    securityGroupIds:
    - example
    subnetIds:
    - example
    vpcAttachmentOptions:
      attachToVpc: false
      cidrBlock: 10.0.0.0/16
    vpcEndpointManagement: CUSTOMER

Spec

Field	Type	Required	Description
`bufferOptions`	object	—	OSISPipelineBufferOptions is a nested property type of AWS::OSIS::Pipeline.
`bufferOptions.persistentBufferEnabled`	boolean	yes	Whether persistent buffering should be enabled.
`encryptionAtRestOptions`	object	—	OSISPipelineEncryptionAtRestOptions is a nested property type of AWS::OSIS::Pipeline.
`encryptionAtRestOptions.kmsKeyArn`	string	yes	The KMS key to use for encrypting data.
`logPublishingOptions`	object	—	OSISPipelineLogPublishingOptions is a nested property type of AWS::OSIS::Pipeline.
`logPublishingOptions.cloudWatchLogDestination`	object	—	The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
`logPublishingOptions.cloudWatchLogDestination.logGroup`	string	yes
`logPublishingOptions.isLoggingEnabled`	boolean	—	Whether logs should be published.
`maxUnits`	integer	yes	The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
`minUnits`	integer	yes	The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
`pipelineConfigurationBody`	string	yes	The Data Prepper pipeline configuration.
`pipelineName`	string	yes	Name of the OpenSearch Ingestion Service pipeline to create.
`pipelineRoleArn`	string	—	The Pipeline Role (ARN) for the pipeline.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`resourcePolicy`	object	—	OSISPipelineResourcePolicy is a nested property type of AWS::OSIS::Pipeline.
`resourcePolicy.policy`	object	yes
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes
`vpcOptions`	object	—	OSISPipelineVpcOptions is a nested property type of AWS::OSIS::Pipeline.
`vpcOptions.securityGroupIds`	array<string>	—	A list of security groups associated with the VPC endpoint.
`vpcOptions.subnetIds`	array<string>	yes	A list of subnet IDs associated with the VPC endpoint.
`vpcOptions.vpcAttachmentOptions`	object	—	Options for attaching a VPC to the pipeline.
`vpcOptions.vpcAttachmentOptions.attachToVpc`	boolean	yes	Whether the pipeline should be attached to the provided VPC
`vpcOptions.vpcAttachmentOptions.cidrBlock`	string	yes	The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
`vpcOptions.vpcEndpointManagement`	enum	—	Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. Allowed: `CUSTOMER, SERVICE`

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`ingestEndpointUrls`	array<string>	—	A list of endpoints that can be used for ingesting data into a pipeline Read-only: reported by AWS after creation.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`pipelineArn`	string	—	The Amazon Resource Name (ARN) of the pipeline.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`vpcEndpointService`	string	—	The VPC endpoint service name for the pipeline.
`vpcEndpoints`	array<object>	—	The VPC interface endpoints that have access to the pipeline.
`vpcEndpoints[].vpcEndpointId`	string	—	The unique identifier of the endpoint.
`vpcEndpoints[].vpcId`	string	—	The ID for your VPC.
`vpcEndpoints[].vpcOptions`	object	—	OSISPipelineVpcOptions is a nested property type of AWS::OSIS::Pipeline.
`vpcEndpoints[].vpcOptions.securityGroupIds`	array<string>	—	A list of security groups associated with the VPC endpoint.
`vpcEndpoints[].vpcOptions.subnetIds`	array<string>	yes	A list of subnet IDs associated with the VPC endpoint.
`vpcEndpoints[].vpcOptions.vpcAttachmentOptions`	object	—	Options for attaching a VPC to the pipeline.
`vpcEndpoints[].vpcOptions.vpcAttachmentOptions.attachToVpc`	boolean	yes	Whether the pipeline should be attached to the provided VPC
`vpcEndpoints[].vpcOptions.vpcAttachmentOptions.cidrBlock`	string	yes	The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
`vpcEndpoints[].vpcOptions.vpcEndpointManagement`	enum	—	Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. Allowed: `CUSTOMER, SERVICE`