Package com.pulumi.aws.kinesis.outputs

Class FirehoseDeliveryStreamOpensearchConfigurationS3Configuration

java.lang.Object

com.pulumi.aws.kinesis.outputs.FirehoseDeliveryStreamOpensearchConfigurationS3Configuration

public final class FirehoseDeliveryStreamOpensearchConfigurationS3Configuration
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FirehoseDeliveryStreamOpensearchConfigurationS3Configuration.Builder

Method Summary

Modifier and Type	Method	Description
java.lang.String	bucketArn()
java.util.Optional<java.lang.Integer>	bufferingInterval()
java.util.Optional<java.lang.Integer>	bufferingSize()
static FirehoseDeliveryStreamOpensearchConfigurationS3Configuration.Builder	builder()
static FirehoseDeliveryStreamOpensearchConfigurationS3Configuration.Builder	builder(FirehoseDeliveryStreamOpensearchConfigurationS3Configuration defaults)
java.util.Optional<FirehoseDeliveryStreamOpensearchConfigurationS3ConfigurationCloudwatchLoggingOptions>	cloudwatchLoggingOptions()
java.util.Optional<java.lang.String>	compressionFormat()
java.util.Optional<java.lang.String>	errorOutputPrefix()
java.util.Optional<java.lang.String>	kmsKeyArn()
java.util.Optional<java.lang.String>	prefix()
java.lang.String	roleArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

bucketArn

public java.lang.String bucketArn()

Returns:

The ARN of the S3 bucket

bufferingInterval

public java.util.Optional<java.lang.Integer> bufferingInterval()

Returns:

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

bufferingSize

public java.util.Optional<java.lang.Integer> bufferingSize()

Returns:

Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec set SizeInMBs to be 10 MB or higher.

cloudwatchLoggingOptions

public java.util.Optional<FirehoseDeliveryStreamOpensearchConfigurationS3ConfigurationCloudwatchLoggingOptions> cloudwatchLoggingOptions()

Returns:

The CloudWatch Logging Options for the delivery stream. See `cloudwatch_logging_options` block below for details.

compressionFormat

public java.util.Optional<java.lang.String> compressionFormat()

Returns:

The compression format. If no value is specified, the default is `UNCOMPRESSED`. Other supported values are `GZIP`, `ZIP`, `Snappy`, & `HADOOP_SNAPPY`.

errorOutputPrefix

public java.util.Optional<java.lang.String> errorOutputPrefix()

Returns:

Prefix added to failed records before writing them to S3. Not currently supported for `redshift` destination. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects](https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html).

kmsKeyArn

public java.util.Optional<java.lang.String> kmsKeyArn()

Returns:

Specifies the KMS key ARN the stream will use to encrypt data. If not set, no encryption will be used.

prefix

public java.util.Optional<java.lang.String> prefix()

Returns:

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket

roleArn

public java.lang.String roleArn()

Returns:

The ARN of the AWS credentials.

builder

public static FirehoseDeliveryStreamOpensearchConfigurationS3Configuration.Builder builder()

builder

public static FirehoseDeliveryStreamOpensearchConfigurationS3Configuration.Builder builder(FirehoseDeliveryStreamOpensearchConfigurationS3Configuration defaults)