ElasticsearchDestinationConfiguration

public struct ElasticsearchDestinationConfiguration : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

    Declaration

    Swift

    public let bufferingHints: ElasticsearchBufferingHints?

  • The Amazon CloudWatch logging options for your delivery stream.

    Declaration

    Swift

    public let cloudWatchLoggingOptions: CloudWatchLoggingOptions?

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

    Declaration

    Swift

    public let clusterEndpoint: String?

  • The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces. Specify either ClusterEndpoint or DomainARN.

    Declaration

    Swift

    public let domainARN: String?

  • The Elasticsearch index name.

    Declaration

    Swift

    public let indexName: String

  • The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.

    Declaration

    Swift

    public let indexRotationPeriod: ElasticsearchIndexRotationPeriod?

  • The data processing configuration.

    Declaration

    Swift

    public let processingConfiguration: ProcessingConfiguration?

  • The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

    Declaration

    Swift

    public let retryOptions: ElasticsearchRetryOptions?

  • The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

    Declaration

    Swift

    public let roleARN: String

  • Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly. You can’t change this backup mode after you create the delivery stream.

    Declaration

    Swift

    public let s3BackupMode: ElasticsearchS3BackupMode?

  • The configuration for the backup Amazon S3 location.

    Declaration

    Swift

    public let s3Configuration: S3DestinationConfiguration

  • The Elasticsearch 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, Kinesis Data Firehose returns an error during run time. For Elasticsearch 7.x, don’t specify a TypeName.

    Declaration

    Swift

    public let typeName: String?

  • The details of the VPC of the Amazon ES destination.

    Declaration

    Swift

    public let vpcConfiguration: VpcConfiguration?

  • Undocumented

    Declaration

    Swift

    public init(bufferingHints: ElasticsearchBufferingHints? = nil, cloudWatchLoggingOptions: CloudWatchLoggingOptions? = nil, clusterEndpoint: String? = nil, domainARN: String? = nil, indexName: String, indexRotationPeriod: ElasticsearchIndexRotationPeriod? = nil, processingConfiguration: ProcessingConfiguration? = nil, retryOptions: ElasticsearchRetryOptions? = nil, roleARN: String, s3BackupMode: ElasticsearchS3BackupMode? = nil, s3Configuration: S3DestinationConfiguration, typeName: String? = nil, vpcConfiguration: VpcConfiguration? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws