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.

ElasticsearchDestinationUpdate

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

type ElasticsearchDestinationUpdate struct { BufferingHints *ElasticsearchBufferingHints `type:"structure"` CloudWatchLoggingOptions *CloudWatchLoggingOptions `type:"structure"` DomainARN *string `min:"1" type:"string"` IndexName *string `min:"1" type:"string"` IndexRotationPeriod *string `type:"string" enum:"ElasticsearchIndexRotationPeriod"` ProcessingConfiguration *ProcessingConfiguration `type:"structure"` RetryOptions *ElasticsearchRetryOptions `type:"structure"` RoleARN *string `min:"1" type:"string"` S3Update *S3DestinationUpdate `type:"structure"` TypeName *string `min:"1" type:"string"` }

Describes an update for 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 IAM 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).

IndexName

Type: *string

The Elasticsearch index name.

IndexRotationPeriod

Type: *string

The Elasticsearch index rotation period. Index rotation appends a timestamp to 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). 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).

S3Update

Describes an update for 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 runtime.

Method

GoString

func (s ElasticsearchDestinationUpdate) GoString() string

GoString returns the string representation

SetBufferingHints

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

SetBufferingHints sets the BufferingHints field's value.

SetCloudWatchLoggingOptions

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

SetCloudWatchLoggingOptions sets the CloudWatchLoggingOptions field's value.

SetDomainARN

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

SetDomainARN sets the DomainARN field's value.

SetIndexName

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

SetIndexName sets the IndexName field's value.

SetIndexRotationPeriod

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

SetIndexRotationPeriod sets the IndexRotationPeriod field's value.

SetProcessingConfiguration

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

SetProcessingConfiguration sets the ProcessingConfiguration field's value.

SetRetryOptions

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

SetRetryOptions sets the RetryOptions field's value.

SetRoleARN

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

SetRoleARN sets the RoleARN field's value.

SetS3Update

func (s *ElasticsearchDestinationUpdate) SetS3Update(v *S3DestinationUpdate) *ElasticsearchDestinationUpdate

SetS3Update sets the S3Update field's value.

SetTypeName

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

SetTypeName sets the TypeName field's value.

String

func (s ElasticsearchDestinationUpdate) String() string

String returns the string representation

Validate

func (s *ElasticsearchDestinationUpdate) Validate() error

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

On this page: