Class: Aws::Firehose::Types::AmazonopensearchserviceDestinationUpdate

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

Overview

Describes an update for a destination in Amazon OpenSearch Service.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hints ⇒ Types::AmazonopensearchserviceBufferingHints

The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

Returns:



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your Firehose stream.

Returns:



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_endpoint ⇒ String

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Returns:

  • (String) 


547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#document_id_options ⇒ Types::DocumentIdOptions

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Returns:



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_arn ⇒ String

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.

Returns:

  • (String) 


547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The Amazon OpenSearch Service index name.

Returns:

  • (String) 


547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#index_rotation_period ⇒ String

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

Returns:

  • (String) 


547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#processing_configuration ⇒ Types::ProcessingConfiguration

Describes a data processing configuration.

Returns:



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#retry_options ⇒ Types::AmazonopensearchserviceRetryOptions

The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

Returns:



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

Returns:

  • (String) 


547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#s3_update ⇒ Types::S3DestinationUpdate

Describes an update for a destination in Amazon S3.

Returns:



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end

#type_name ⇒ String

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for TypeName.

Returns:

  • (String) 


547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 547

class AmazonopensearchserviceDestinationUpdate < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_update,
  :processing_configuration,
  :cloud_watch_logging_options,
  :document_id_options)
  SENSITIVE = []
  include Aws::Structure
end