Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

An implementation for CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder, CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getBufferingHints()	Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.
final Object	getCloudWatchLoggingOptions()	The Amazon CloudWatch Logs logging options for the delivery stream.
final String	getClusterEndpoint()	The endpoint to use when communicating with the cluster.
final Object	getDocumentIdOptions()	Indicates the method for setting up document ID.
final String	getDomainArn()	The ARN of the Amazon ES domain.
final String	getIndexName()	The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.
final String	getIndexRotationPeriod()	The frequency of Elasticsearch index rotation.
final Object	getProcessingConfiguration()	The data processing configuration for the Kinesis Data Firehose delivery stream.
final Object	getRetryOptions()	The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.
final String	getRoleArn()	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.
final String	getS3BackupMode()	The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3).
final Object	getS3Configuration()	The S3 bucket where Kinesis Data Firehose backs up incoming data.
final String	getTypeName()	The Elasticsearch type name that Amazon ES adds to documents when indexing data.
final Object	getVpcConfiguration()	The details of the VPC of the Amazon ES destination.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder.

Method Details

getIndexName

public final String getIndexName()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.

Specified by:

getIndexName in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname

getRoleArn

public final String getRoleArn()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

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 Controlling Access with Amazon Kinesis Data Firehose .

Specified by:

getRoleArn in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-rolearn

getS3Configuration

public final Object getS3Configuration()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The S3 bucket where Kinesis Data Firehose backs up incoming data.

Returns union: either IResolvable or CfnDeliveryStream.S3DestinationConfigurationProperty

Specified by:

getS3Configuration in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3configuration

getBufferingHints

public final Object getBufferingHints()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.

Returns union: either IResolvable or CfnDeliveryStream.ElasticsearchBufferingHintsProperty

Specified by:

getBufferingHints in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints

getCloudWatchLoggingOptions

public final Object getCloudWatchLoggingOptions()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The Amazon CloudWatch Logs logging options for the delivery stream.

Returns union: either IResolvable or CfnDeliveryStream.CloudWatchLoggingOptionsProperty

Specified by:

getCloudWatchLoggingOptions in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-cloudwatchloggingoptions

getClusterEndpoint

public final String getClusterEndpoint()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The endpoint to use when communicating with the cluster.

Specify either this ClusterEndpoint or the DomainARN field.

Specified by:

getClusterEndpoint in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-clusterendpoint

getDocumentIdOptions

public final Object getDocumentIdOptions()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

Indicates the method for setting up document ID.

The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Returns union: either IResolvable or CfnDeliveryStream.DocumentIdOptionsProperty

Specified by:

getDocumentIdOptions in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-documentidoptions

getDomainArn

public final String getDomainArn()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

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 .

Specify either ClusterEndpoint or DomainARN .

Specified by:

getDomainArn in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn

getIndexRotationPeriod

public final String getIndexRotationPeriod()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The frequency of Elasticsearch index rotation.

If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Data Firehose Developer Guide .

Specified by:

getIndexRotationPeriod in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod

getProcessingConfiguration

public final Object getProcessingConfiguration()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The data processing configuration for the Kinesis Data Firehose delivery stream.

Returns union: either IResolvable or CfnDeliveryStream.ProcessingConfigurationProperty

Specified by:

getProcessingConfiguration in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-processingconfiguration

getRetryOptions

public final Object getRetryOptions()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.

Returns union: either IResolvable or CfnDeliveryStream.ElasticsearchRetryOptionsProperty

Specified by:

getRetryOptions in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-retryoptions

getS3BackupMode

public final String getS3BackupMode()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3).

You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

Specified by:

getS3BackupMode in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3backupmode

getTypeName

public final String getTypeName()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The Elasticsearch type name that Amazon ES adds to documents when indexing data.

Specified by:

getTypeName in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename

getVpcConfiguration

public final Object getVpcConfiguration()

Description copied from interface: CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

The details of the VPC of the Amazon ES destination.

Returns union: either IResolvable or CfnDeliveryStream.VpcConfigurationProperty

Specified by:

getVpcConfiguration in interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-vpcconfiguration

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object