AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ElasticsearchDestinationConfiguration

import "github.com/aws/aws-sdk-go/service/firehose"

type ElasticsearchDestinationConfiguration struct { BufferingHints *ElasticsearchBufferingHints `type:"structure"` CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` DomainARN *string `min:"1" type:"string" required:"true"` IndexName *string `min:"1" type:"string" required:"true"` IndexRotationPeriod *string `type:"string" enum:"ElasticsearchIndexRotationPeriod"` ProcessingConfiguration *ProcessingConfiguration `type:"structure"` RetryOptions *ElasticsearchRetryOptions `type:"structure"` RoleARN *string `min:"1" type:"string" required:"true"` S3BackupMode *string `type:"string" enum:"ElasticsearchS3BackupMode"` S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"` TypeName *string `min:"1" type:"string" required:"true"` }

Describes the configuration of a destination in Amazon ES.

BufferingHints

Describes the buffering to perform before delivering data to the Amazon ES destination.

CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

DomainARN

Type: *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 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).

DomainARN is a required field

IndexName

Type: *string

The Elasticsearch index name.

IndexName is a required field

IndexRotationPeriod

Type: *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 (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). The default value is OneDay.

ProcessingConfiguration

Describes a data processing configuration.

RetryOptions

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.

RoleARN

Type: *string

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 (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) and Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).

RoleARN is a required field

S3BackupMode

Type: *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 (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup). Default value is FailedDocumentsOnly.

S3Configuration

Describes the configuration of a destination in Amazon S3.

TypeName

Type: *string

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.

TypeName is a required field

Method

GoString

func (s ElasticsearchDestinationConfiguration) GoString() string

GoString returns the string representation

SetBufferingHints

func (s *ElasticsearchDestinationConfiguration) SetBufferingHints(v *ElasticsearchBufferingHints) *ElasticsearchDestinationConfiguration

SetBufferingHints sets the BufferingHints field's value.

SetCloudWatchLoggingOptions

func (s *ElasticsearchDestinationConfiguration) SetCloudWatchLoggingOptions(v *CloudWatchLoggingOptions) *ElasticsearchDestinationConfiguration

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

SetDomainARN

func (s *ElasticsearchDestinationConfiguration) SetDomainARN(v string) *ElasticsearchDestinationConfiguration

SetDomainARN sets the DomainARN field's value.

SetIndexName

func (s *ElasticsearchDestinationConfiguration) SetIndexName(v string) *ElasticsearchDestinationConfiguration

SetIndexName sets the IndexName field's value.

SetIndexRotationPeriod

func (s *ElasticsearchDestinationConfiguration) SetIndexRotationPeriod(v string) *ElasticsearchDestinationConfiguration

SetIndexRotationPeriod sets the IndexRotationPeriod field's value.

SetProcessingConfiguration

func (s *ElasticsearchDestinationConfiguration) SetProcessingConfiguration(v *ProcessingConfiguration) *ElasticsearchDestinationConfiguration

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

SetRetryOptions

func (s *ElasticsearchDestinationConfiguration) SetRetryOptions(v *ElasticsearchRetryOptions) *ElasticsearchDestinationConfiguration

SetRetryOptions sets the RetryOptions field's value.

SetRoleARN

func (s *ElasticsearchDestinationConfiguration) SetRoleARN(v string) *ElasticsearchDestinationConfiguration

SetRoleARN sets the RoleARN field's value.

SetS3BackupMode

func (s *ElasticsearchDestinationConfiguration) SetS3BackupMode(v string) *ElasticsearchDestinationConfiguration

SetS3BackupMode sets the S3BackupMode field's value.

SetS3Configuration

func (s *ElasticsearchDestinationConfiguration) SetS3Configuration(v *S3DestinationConfiguration) *ElasticsearchDestinationConfiguration

SetS3Configuration sets the S3Configuration field's value.

SetTypeName

func (s *ElasticsearchDestinationConfiguration) SetTypeName(v string) *ElasticsearchDestinationConfiguration

SetTypeName sets the TypeName field's value.

String

func (s ElasticsearchDestinationConfiguration) String() string

String returns the string representation

Validate

func (s *ElasticsearchDestinationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: