Class: Aws::Firehose::Types::AmazonopensearchserviceDestinationConfiguration

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

Overview

Note:

When making an API call, you may pass AmazonopensearchserviceDestinationConfiguration data as a hash:

{
  role_arn: "RoleARN", # required
  domain_arn: "AmazonopensearchserviceDomainARN",
  cluster_endpoint: "AmazonopensearchserviceClusterEndpoint",
  index_name: "AmazonopensearchserviceIndexName", # required
  type_name: "AmazonopensearchserviceTypeName",
  index_rotation_period: "NoRotation", # accepts NoRotation, OneHour, OneDay, OneWeek, OneMonth
  buffering_hints: {
    interval_in_seconds: 1,
    size_in_m_bs: 1,
  },
  retry_options: {
    duration_in_seconds: 1,
  },
  s3_backup_mode: "FailedDocumentsOnly", # accepts FailedDocumentsOnly, AllDocuments
  s3_configuration: { # required
    role_arn: "RoleARN", # required
    bucket_arn: "BucketARN", # required
    prefix: "Prefix",
    error_output_prefix: "ErrorOutputPrefix",
    buffering_hints: {
      size_in_m_bs: 1,
      interval_in_seconds: 1,
    },
    compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy, HADOOP_SNAPPY
    encryption_configuration: {
      no_encryption_config: "NoEncryption", # accepts NoEncryption
      kms_encryption_config: {
        awskms_key_arn: "AWSKMSKeyARN", # required
      },
    },
    cloud_watch_logging_options: {
      enabled: false,
      log_group_name: "LogGroupName",
      log_stream_name: "LogStreamName",
    },
  },
  processing_configuration: {
    enabled: false,
    processors: [
      {
        type: "RecordDeAggregation", # required, accepts RecordDeAggregation, Lambda, MetadataExtraction, AppendDelimiterToRecord
        parameters: [
          {
            parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, MetadataExtractionQuery, JsonParsingEngine, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds, SubRecordType, Delimiter
            parameter_value: "ProcessorParameterValue", # required
          },
        ],
      },
    ],
  },
  cloud_watch_logging_options: {
    enabled: false,
    log_group_name: "LogGroupName",
    log_stream_name: "LogStreamName",
  },
  vpc_configuration: {
    subnet_ids: ["NonEmptyStringWithoutWhitespace"], # required
    role_arn: "RoleARN", # required
    security_group_ids: ["NonEmptyStringWithoutWhitespace"], # required
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hintsTypes::AmazonopensearchserviceBufferingHints


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#cluster_endpointString

Returns:

  • (String)

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#domain_arnString

Returns:

  • (String)

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#index_nameString

Returns:

  • (String)

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#index_rotation_periodString

Returns:

  • (String)

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#processing_configurationTypes::ProcessingConfiguration

Describes a data processing configuration.


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#retry_optionsTypes::AmazonopensearchserviceRetryOptions


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#role_arnString

Returns:

  • (String)

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#s3_backup_modeString

Returns:

  • (String)

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#s3_configurationTypes::S3DestinationConfiguration

Describes the configuration of a destination in Amazon S3.


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#type_nameString

Returns:

  • (String)

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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

#vpc_configurationTypes::VpcConfiguration

The details of the VPC of the Amazon ES destination.


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/aws-sdk-firehose/types.rb', line 148

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