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

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

Overview

The destination description in Amazon OpenSearch Service.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hintsTypes::AmazonopensearchserviceBufferingHints

The buffering options.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File '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_optionsTypes::CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File '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_endpointString

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 '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_optionsTypes::DocumentIdOptions

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



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File '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_arnString

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 '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_nameString

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 '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_periodString

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 '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_configurationTypes::ProcessingConfiguration

Describes a data processing configuration.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File '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_optionsTypes::AmazonopensearchserviceRetryOptions

The Amazon OpenSearch Service retry options.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File '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_arnString

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 '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_modeString

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 '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_descriptionTypes::S3DestinationDescription

Describes a destination in Amazon S3.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File '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_nameString

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 '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_descriptionTypes::VpcConfigurationDescription

The details of the VPC of the Amazon ES destination.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File '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