Class: Aws::OpenSearchServerless::Types::CreateIngestionStreamRequest

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchServerless::Types::CreateIngestionStreamRequest

Defined in:

gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier to ensure idempotency of the request.

• #collection_id ⇒ String

  The unique identifier of the collection to ingest data into.

• #failure_index_name ⇒ String

  The name of the index where documents that fail to be ingested are recorded.

• #index_name ⇒ String

  The name of the index to ingest documents into.

• #ingestion_stream_name ⇒ String

  The name of the ingestion stream.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source.

• #source ⇒ Types::IngestionStreamSource

  The Amazon S3 source to ingest data from, including the Amazon SQS queue that receives S3 event notifications.

• #tags ⇒ Array<Types::Tag>

  An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier to ensure idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1283

class CreateIngestionStreamRequest < Struct.new(
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#collection_id ⇒ String

The unique identifier of the collection to ingest data into.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1283

class CreateIngestionStreamRequest < Struct.new(
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#failure_index_name ⇒ String

The name of the index where documents that fail to be ingested are recorded.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1283

class CreateIngestionStreamRequest < Struct.new(
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The name of the index to ingest documents into.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1283

class CreateIngestionStreamRequest < Struct.new(
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_stream_name ⇒ String

The name of the ingestion stream. The name must be unique within the collection.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1283

class CreateIngestionStreamRequest < Struct.new(
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source. The role must be in the same account as the collection.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1283

class CreateIngestionStreamRequest < Struct.new(
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::IngestionStreamSource

The Amazon S3 source to ingest data from, including the Amazon SQS queue that receives S3 event notifications.

Returns:

• (Types::IngestionStreamSource)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1283

class CreateIngestionStreamRequest < Struct.new(
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1283

class CreateIngestionStreamRequest < Struct.new(
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end