Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

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

An implementation for CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

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.AmazonopensearchserviceDestinationConfigurationProperty

CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder, CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.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()	The buffering options.
final Object	getCloudWatchLoggingOptions()	Describes the Amazon CloudWatch logging options for your 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 OpenSearch Service domain.
final String	getIndexName()	The Amazon OpenSearch Service index name.
final String	getIndexRotationPeriod()	The Amazon OpenSearch Service index rotation period.
final Object	getProcessingConfiguration()	Describes a data processing configuration.
final Object	getRetryOptions()	The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
final String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
final String	getS3BackupMode()	Defines how documents should be delivered to Amazon S3.
final Object	getS3Configuration()	Describes the configuration of a destination in Amazon S3.
final String	getTypeName()	The Amazon OpenSearch Service type name.
final Object	getVpcConfiguration()	The details of the VPC of the Amazon OpenSearch Service 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.AmazonopensearchserviceDestinationConfigurationProperty.Builder builder)

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

Method Details

getIndexName

public final String getIndexName()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

The Amazon OpenSearch Service index name.

Specified by:

getIndexName in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getRoleArn

public final String getRoleArn()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

Specified by:

getRoleArn in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getS3Configuration

public final Object getS3Configuration()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

Describes the configuration of a destination in Amazon S3.

Returns union: either IResolvable or CfnDeliveryStream.S3DestinationConfigurationProperty

Specified by:

getS3Configuration in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getBufferingHints

public final Object getBufferingHints()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

The buffering options.

If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

Returns union: either IResolvable or CfnDeliveryStream.AmazonopensearchserviceBufferingHintsProperty

Specified by:

getBufferingHints in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getCloudWatchLoggingOptions

public final Object getCloudWatchLoggingOptions()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

Describes the Amazon CloudWatch logging options for your delivery stream.

Returns union: either IResolvable or CfnDeliveryStream.CloudWatchLoggingOptionsProperty

Specified by:

getCloudWatchLoggingOptions in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getClusterEndpoint

public final String getClusterEndpoint()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

The endpoint to use when communicating with the cluster.

Specify either this ClusterEndpoint or the DomainARN field.

Specified by:

getClusterEndpoint in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getDocumentIdOptions

public final Object getDocumentIdOptions()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

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.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getDomainArn

public final String getDomainArn()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

The ARN of the Amazon OpenSearch Service domain.

Specified by:

getDomainArn in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getIndexRotationPeriod

public final String getIndexRotationPeriod()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

The Amazon OpenSearch Service index rotation period.

Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

Specified by:

getIndexRotationPeriod in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getProcessingConfiguration

public final Object getProcessingConfiguration()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

Describes a data processing configuration.

Returns union: either IResolvable or CfnDeliveryStream.ProcessingConfigurationProperty

Specified by:

getProcessingConfiguration in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getRetryOptions

public final Object getRetryOptions()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

The default value is 300 (5 minutes).

Returns union: either IResolvable or CfnDeliveryStream.AmazonopensearchserviceRetryOptionsProperty

Specified by:

getRetryOptions in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getS3BackupMode

public final String getS3BackupMode()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

Defines how documents should be delivered to Amazon S3.

Specified by:

getS3BackupMode in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getTypeName

public final String getTypeName()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

The Amazon OpenSearch Service type name.

Specified by:

getTypeName in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

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

getVpcConfiguration

public final Object getVpcConfiguration()

Description copied from interface: CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

The details of the VPC of the Amazon OpenSearch Service destination.

Returns union: either IResolvable or CfnDeliveryStream.VpcConfigurationProperty

Specified by:

getVpcConfiguration in interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-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