Class FirehoseDeliveryStreamElasticsearchConfiguration

Inheritance

System.Object

FirehoseDeliveryStreamElasticsearchConfiguration

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Kinesis.Outputs

Assembly: Pulumi.Aws.dll

Syntax

public sealed class FirehoseDeliveryStreamElasticsearchConfiguration

Fields

BufferingInterval

Buffer incoming data for the specified period of time, in seconds between 60 to 900, before delivering it to the destination. The default value is 300s.

Declaration

public readonly int? BufferingInterval

Field Value

Type	Description
System.Nullable<System.Int32>

BufferingSize

Buffer incoming data to the specified size, in MBs between 1 to 100, before delivering it to the destination. The default value is 5MB.

Declaration

public readonly int? BufferingSize

Field Value

Type	Description
System.Nullable<System.Int32>

CloudwatchLoggingOptions

The CloudWatch Logging Options for the delivery stream. More details are given below

Declaration

public readonly FirehoseDeliveryStreamElasticsearchConfigurationCloudwatchLoggingOptions CloudwatchLoggingOptions

Field Value

Type	Description
FirehoseDeliveryStreamElasticsearchConfigurationCloudwatchLoggingOptions

DomainArn

The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming RoleARN. The pattern needs to be arn:.*.

Declaration

public readonly string DomainArn

Field Value

Type	Description
System.String

IndexName

The Elasticsearch index name.

Declaration

public readonly string IndexName

Field Value

Type	Description
System.String

IndexRotationPeriod

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. Valid values are NoRotation, OneHour, OneDay, OneWeek, and OneMonth. The default value is OneDay.

Declaration

public readonly string IndexRotationPeriod

Field Value

Type	Description
System.String

ProcessingConfiguration

The data processing configuration. More details are given below.

Declaration

public readonly FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfiguration ProcessingConfiguration

Field Value

Type	Description
FirehoseDeliveryStreamElasticsearchConfigurationProcessingConfiguration

RetryDuration

After an initial failure to deliver to Amazon Elasticsearch, the total amount of time, in seconds between 0 to 7200, during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. The default value is 300s. There will be no retry if the value is 0.

Declaration

public readonly int? RetryDuration

Field Value

Type	Description
System.Nullable<System.Int32>

RoleArn

The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. The pattern needs to be arn:.*.

Declaration

public readonly string RoleArn

Field Value

Type	Description
System.String

S3BackupMode

Defines how documents should be delivered to Amazon S3. Valid values are FailedDocumentsOnly and AllDocuments. Default value is FailedDocumentsOnly.

Declaration

public readonly string S3BackupMode

Field Value

Type	Description
System.String

TypeName

The Elasticsearch type name with maximum length of 100 characters.

Declaration

public readonly string TypeName

Field Value

Type	Description
System.String