Class: Aws::OSIS::Types::Pipeline

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb

Overview

Information about an existing OpenSearch Ingestion pipeline.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buffer_options ⇒ Types::BufferOptions

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time when the pipeline was created.

Returns:

  • (Time) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#destinations ⇒ Array<Types::PipelineDestination>

Destinations to which the pipeline writes data.

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

Options to control how OpenSearch encrypts buffer data.

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ingest_endpoint_urls ⇒ Array<String>

The ingestion endpoints for the pipeline, which you can send data to.

Returns:

  • (Array<String>) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

The date and time when the pipeline was last updated.

Returns:

  • (Time) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#log_publishing_options ⇒ Types::LogPublishingOptions

Key-value pairs that represent log publishing settings.

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#max_units ⇒ Integer

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

Returns:

  • (Integer) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#min_units ⇒ Integer

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

Returns:

  • (Integer) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_arn ⇒ String

The Amazon Resource Name (ARN) of the pipeline.

Returns:

  • (String) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_configuration_body ⇒ String

The Data Prepper pipeline configuration in YAML format.

Returns:

  • (String) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_name ⇒ String

The name of the pipeline.

Returns:

  • (String) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.

Returns:

  • (String) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#service_vpc_endpoints ⇒ Array<Types::ServiceVpcEndpoint>

A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the pipeline.

Returns:

  • (String) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ Types::PipelineStatusReason

The reason for the current status of the pipeline.

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags associated with the given pipeline.

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_service ⇒ String

The VPC endpoint service name for the pipeline.

Returns:

  • (String) 


726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoints ⇒ Array<Types::VpcEndpoint>

The VPC interface endpoints that have access to the pipeline.

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 726

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags,
  :pipeline_role_arn)
  SENSITIVE = []
  include Aws::Structure
end