Class: Aws::Firehose::Types::AmazonopensearchserviceDestinationDescription

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

Overview

The destination description in Amazon OpenSearch Service.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hints ⇒ Types::AmazonopensearchserviceBufferingHints

The buffering options.

Returns:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

class AmazonopensearchserviceDestinationDescription < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options,
  :vpc_configuration_description,
  :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:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#cluster_endpoint ⇒ String

The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

Returns:

  • (String) 


454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

class AmazonopensearchserviceDestinationDescription < Struct.new(
  :role_arn,
  :domain_arn,
  :cluster_endpoint,
  :index_name,
  :type_name,
  :index_rotation_period,
  :buffering_hints,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options,
  :vpc_configuration_description,
  :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:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#domain_arn ⇒ String

The ARN of the Amazon OpenSearch Service domain.

Returns:

  • (String) 


454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#index_name ⇒ String

The Amazon OpenSearch Service index name.

Returns:

  • (String) 


454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#index_rotation_period ⇒ String

The Amazon OpenSearch Service index rotation period

Returns:

  • (String) 


454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#processing_configuration ⇒ Types::ProcessingConfiguration

Describes a data processing configuration.

Returns:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#retry_options ⇒ Types::AmazonopensearchserviceRetryOptions

The Amazon OpenSearch Service retry options.

Returns:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

Returns:

  • (String) 


454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#s3_backup_mode ⇒ String

The Amazon S3 backup mode.

Returns:

  • (String) 


454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#s3_destination_description ⇒ Types::S3DestinationDescription

Describes a destination in Amazon S3.

Returns:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#type_name ⇒ String

The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

Returns:

  • (String) 


454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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

#vpc_configuration_description ⇒ Types::VpcConfigurationDescription

The details of the VPC of the Amazon ES destination.

Returns:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 454

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