Interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDeliveryStream
ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kinesisfirehose.*;
ElasticsearchDestinationConfigurationProperty elasticsearchDestinationConfigurationProperty = ElasticsearchDestinationConfigurationProperty.builder()
.indexName("indexName")
.roleArn("roleArn")
.s3Configuration(S3DestinationConfigurationProperty.builder()
.bucketArn("bucketArn")
.roleArn("roleArn")
// the properties below are optional
.bufferingHints(BufferingHintsProperty.builder()
.intervalInSeconds(123)
.sizeInMBs(123)
.build())
.cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
.enabled(false)
.logGroupName("logGroupName")
.logStreamName("logStreamName")
.build())
.compressionFormat("compressionFormat")
.encryptionConfiguration(EncryptionConfigurationProperty.builder()
.kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
.awskmsKeyArn("awskmsKeyArn")
.build())
.noEncryptionConfig("noEncryptionConfig")
.build())
.errorOutputPrefix("errorOutputPrefix")
.prefix("prefix")
.build())
// the properties below are optional
.bufferingHints(ElasticsearchBufferingHintsProperty.builder()
.intervalInSeconds(123)
.sizeInMBs(123)
.build())
.cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
.enabled(false)
.logGroupName("logGroupName")
.logStreamName("logStreamName")
.build())
.clusterEndpoint("clusterEndpoint")
.documentIdOptions(DocumentIdOptionsProperty.builder()
.defaultDocumentIdFormat("defaultDocumentIdFormat")
.build())
.domainArn("domainArn")
.indexRotationPeriod("indexRotationPeriod")
.processingConfiguration(ProcessingConfigurationProperty.builder()
.enabled(false)
.processors(List.of(ProcessorProperty.builder()
.type("type")
// the properties below are optional
.parameters(List.of(ProcessorParameterProperty.builder()
.parameterName("parameterName")
.parameterValue("parameterValue")
.build()))
.build()))
.build())
.retryOptions(ElasticsearchRetryOptionsProperty.builder()
.durationInSeconds(123)
.build())
.s3BackupMode("s3BackupMode")
.typeName("typeName")
.vpcConfiguration(VpcConfigurationProperty.builder()
.roleArn("roleArn")
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classstatic final classAn implementation forCfnDeliveryStream.ElasticsearchDestinationConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectConfigures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.default ObjectThe Amazon CloudWatch Logs logging options for the delivery stream.default StringThe endpoint to use when communicating with the cluster.default ObjectIndicates the method for setting up document ID.default StringThe ARN of the Amazon ES domain.The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.default StringThe frequency of Elasticsearch index rotation.default ObjectThe data processing configuration for the Kinesis Data Firehose delivery stream.default ObjectThe retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.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.default StringThe condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3).The S3 bucket where Kinesis Data Firehose backs up incoming data.default StringThe Elasticsearch type name that Amazon ES adds to documents when indexing data.default ObjectThe details of the VPC of the Amazon ES destination.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIndexName
The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.- See Also:
-
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.For more information, see Controlling Access with Amazon Kinesis Data Firehose .
- See Also:
-
getS3Configuration
The S3 bucket where Kinesis Data Firehose backs up incoming data.Returns union: either
IResolvableorCfnDeliveryStream.S3DestinationConfigurationProperty- See Also:
-
getBufferingHints
Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.Returns union: either
IResolvableorCfnDeliveryStream.ElasticsearchBufferingHintsProperty- See Also:
-
getCloudWatchLoggingOptions
The Amazon CloudWatch Logs logging options for the delivery stream.Returns union: either
IResolvableorCfnDeliveryStream.CloudWatchLoggingOptionsProperty- See Also:
-
getClusterEndpoint
The endpoint to use when communicating with the cluster.Specify either this
ClusterEndpointor theDomainARNfield.- See Also:
-
getDocumentIdOptions
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
IResolvableorCfnDeliveryStream.DocumentIdOptionsProperty- See Also:
-
getDomainArn
The ARN of the Amazon ES domain.The IAM role must have permissions for
DescribeElasticsearchDomain,DescribeElasticsearchDomains, andDescribeElasticsearchDomainConfigafter assuming the role specified in RoleARN .Specify either
ClusterEndpointorDomainARN.- See Also:
-
getIndexRotationPeriod
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 .
- See Also:
-
getProcessingConfiguration
The data processing configuration for the Kinesis Data Firehose delivery stream.Returns union: either
IResolvableorCfnDeliveryStream.ProcessingConfigurationProperty- See Also:
-
getRetryOptions
The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.Returns union: either
IResolvableorCfnDeliveryStream.ElasticsearchRetryOptionsProperty- See Also:
-
getS3BackupMode
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
S3BackupModecontent for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .- See Also:
-
getTypeName
The Elasticsearch type name that Amazon ES adds to documents when indexing data.- See Also:
-
getVpcConfiguration
The details of the VPC of the Amazon ES destination.Returns union: either
IResolvableorCfnDeliveryStream.VpcConfigurationProperty- See Also:
-
builder
@Stability(Stable) static CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder builder()
-