Class: Aws::OSIS::Types::CreatePipelineRequest

Inherits:

Struct

• Object
• Struct
• Aws::OSIS::Types::CreatePipelineRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #buffer_options ⇒ Types::BufferOptions

  Key-value pairs to configure persistent buffering for the pipeline.

• #encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

  Key-value pairs to configure encryption for data that is written to a persistent buffer.

• #log_publishing_options ⇒ Types::LogPublishingOptions

  Key-value pairs to configure log publishing.

• #max_units ⇒ Integer

  The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

• #min_units ⇒ Integer

  The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

• #pipeline_configuration_body ⇒ String

  The pipeline configuration in YAML format.

• #pipeline_name ⇒ String

  The name of the OpenSearch Ingestion pipeline to create.

• #tags ⇒ Array<Types::Tag>

  List of tags to add to the pipeline upon creation.

• #vpc_options ⇒ Types::VpcOptions

  Container for the values required to configure VPC access for the pipeline.

Instance Attribute Details

#buffer_options ⇒ Types::BufferOptions

Key-value pairs to configure persistent buffering for the pipeline.

Returns:

• (Types::BufferOptions)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 165

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :min_units,
  :max_units,
  :pipeline_configuration_body,
  :log_publishing_options,
  :vpc_options,
  :buffer_options,
  :encryption_at_rest_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

Key-value pairs to configure encryption for data that is written to a persistent buffer.

Returns:

• (Types::EncryptionAtRestOptions)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 165

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :min_units,
  :max_units,
  :pipeline_configuration_body,
  :log_publishing_options,
  :vpc_options,
  :buffer_options,
  :encryption_at_rest_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#log_publishing_options ⇒ Types::LogPublishingOptions

Key-value pairs to configure log publishing.

Returns:

• (Types::LogPublishingOptions)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 165

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :min_units,
  :max_units,
  :pipeline_configuration_body,
  :log_publishing_options,
  :vpc_options,
  :buffer_options,
  :encryption_at_rest_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#max_units ⇒ Integer

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

• (Integer)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 165

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :min_units,
  :max_units,
  :pipeline_configuration_body,
  :log_publishing_options,
  :vpc_options,
  :buffer_options,
  :encryption_at_rest_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#min_units ⇒ Integer

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

• (Integer)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 165

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :min_units,
  :max_units,
  :pipeline_configuration_body,
  :log_publishing_options,
  :vpc_options,
  :buffer_options,
  :encryption_at_rest_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_configuration_body ⇒ String

The pipeline configuration in YAML format. The command 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.

Returns:

• (String)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 165

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :min_units,
  :max_units,
  :pipeline_configuration_body,
  :log_publishing_options,
  :vpc_options,
  :buffer_options,
  :encryption_at_rest_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_name ⇒ String

The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

Returns:

• (String)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 165

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :min_units,
  :max_units,
  :pipeline_configuration_body,
  :log_publishing_options,
  :vpc_options,
  :buffer_options,
  :encryption_at_rest_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

List of tags to add to the pipeline upon creation.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 165

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :min_units,
  :max_units,
  :pipeline_configuration_body,
  :log_publishing_options,
  :vpc_options,
  :buffer_options,
  :encryption_at_rest_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_options ⇒ Types::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.

Returns:

• (Types::VpcOptions)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 165

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :min_units,
  :max_units,
  :pipeline_configuration_body,
  :log_publishing_options,
  :vpc_options,
  :buffer_options,
  :encryption_at_rest_options,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end