Struct aws_sdk_firehose::model::elasticsearch_destination_configuration::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for ElasticsearchDestinationConfiguration

Implementations

impl Builder

pub fn role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_role_arn(self, input: Option<String>) -> Self

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.

pub fn domain_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_domain_arn(self, input: Option<String>) -> Self

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.

pub fn cluster_endpoint(self, input: impl Into<String>) -> Self

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

pub fn set_cluster_endpoint(self, input: Option<String>) -> Self

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

pub fn index_name(self, input: impl Into<String>) -> Self

The Elasticsearch index name.

pub fn set_index_name(self, input: Option<String>) -> Self

The Elasticsearch index name.

pub fn type_name(self, input: impl Into<String>) -> Self

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.

pub fn set_type_name(self, input: Option<String>) -> Self

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.

pub fn index_rotation_period(
    self,
    input: ElasticsearchIndexRotationPeriod
) -> Self

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.

pub fn set_index_rotation_period(
    self,
    input: Option<ElasticsearchIndexRotationPeriod>
) -> Self

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.

pub fn buffering_hints(self, input: ElasticsearchBufferingHints) -> Self

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

pub fn set_buffering_hints(
    self,
    input: Option<ElasticsearchBufferingHints>
) -> Self

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

pub fn retry_options(self, input: ElasticsearchRetryOptions) -> Self

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

pub fn set_retry_options(self, input: Option<ElasticsearchRetryOptions>) -> Self

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

pub fn s3_backup_mode(self, input: ElasticsearchS3BackupMode) -> Self

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.

pub fn set_s3_backup_mode(
    self,
    input: Option<ElasticsearchS3BackupMode>
) -> Self

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.

pub fn s3_configuration(self, input: S3DestinationConfiguration) -> Self

The configuration for the backup Amazon S3 location.

pub fn set_s3_configuration(
    self,
    input: Option<S3DestinationConfiguration>
) -> Self

The configuration for the backup Amazon S3 location.

pub fn processing_configuration(self, input: ProcessingConfiguration) -> Self

The data processing configuration.

pub fn set_processing_configuration(
    self,
    input: Option<ProcessingConfiguration>
) -> Self

The data processing configuration.

pub fn cloud_watch_logging_options(
    self,
    input: CloudWatchLoggingOptions
) -> Self

The Amazon CloudWatch logging options for your delivery stream.

pub fn set_cloud_watch_logging_options(
    self,
    input: Option<CloudWatchLoggingOptions>
) -> Self

The Amazon CloudWatch logging options for your delivery stream.

pub fn vpc_configuration(self, input: VpcConfiguration) -> Self

The details of the VPC of the Amazon ES destination.

pub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self

The details of the VPC of the Amazon ES destination.

pub fn build(self) -> ElasticsearchDestinationConfiguration

Consumes the builder and constructs a ElasticsearchDestinationConfiguration

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder