Class CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

Inheritance

object

CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty

Implements

CfnDeliveryStreamPropsMixin.IAmazonOpenSearchServerlessDestinationConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty : CfnDeliveryStreamPropsMixin.IAmazonOpenSearchServerlessDestinationConfigurationProperty

Syntax (vb)

Public Class CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty Implements CfnDeliveryStreamPropsMixin.IAmazonOpenSearchServerlessDestinationConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins;

             var amazonOpenSearchServerlessDestinationConfigurationProperty = new AmazonOpenSearchServerlessDestinationConfigurationProperty {
                 BufferingHints = new AmazonOpenSearchServerlessBufferingHintsProperty {
                     IntervalInSeconds = 123,
                     SizeInMBs = 123
                 },
                 CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                     Enabled = false,
                     LogGroupName = "logGroupName",
                     LogStreamName = "logStreamName"
                 },
                 CollectionEndpoint = "collectionEndpoint",
                 IndexName = "indexName",
                 ProcessingConfiguration = new ProcessingConfigurationProperty {
                     Enabled = false,
                     Processors = new [] { new ProcessorProperty {
                         Parameters = new [] { new ProcessorParameterProperty {
                             ParameterName = "parameterName",
                             ParameterValue = "parameterValue"
                         } },
                         Type = "type"
                     } }
                 },
                 RetryOptions = new AmazonOpenSearchServerlessRetryOptionsProperty {
                     DurationInSeconds = 123
                 },
                 RoleArn = "roleArn",
                 S3BackupMode = "s3BackupMode",
                 S3Configuration = new S3DestinationConfigurationProperty {
                     BucketArn = "bucketArn",
                     BufferingHints = new BufferingHintsProperty {
                         IntervalInSeconds = 123,
                         SizeInMBs = 123
                     },
                     CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                         Enabled = false,
                         LogGroupName = "logGroupName",
                         LogStreamName = "logStreamName"
                     },
                     CompressionFormat = "compressionFormat",
                     EncryptionConfiguration = new EncryptionConfigurationProperty {
                         KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                             AwskmsKeyArn = "awskmsKeyArn"
                         },
                         NoEncryptionConfig = "noEncryptionConfig"
                     },
                     ErrorOutputPrefix = "errorOutputPrefix",
                     Prefix = "prefix",
                     RoleArn = "roleArn"
                 },
                 VpcConfiguration = new VpcConfigurationProperty {
                     RoleArn = "roleArn",
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Synopsis

Constructors

AmazonOpenSearchServerlessDestinationConfigurationProperty()

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

Properties

BufferingHints	The buffering options.
CloudWatchLoggingOptions	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
CollectionEndpoint	The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
IndexName	The Serverless offering for Amazon OpenSearch Service index name.
ProcessingConfiguration	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
RetryOptions	The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
RoleArn	The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
S3BackupMode	Defines how documents should be delivered to Amazon S3.
S3Configuration	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
VpcConfiguration	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

Constructors

AmazonOpenSearchServerlessDestinationConfigurationProperty()

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

public AmazonOpenSearchServerlessDestinationConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins;

             var amazonOpenSearchServerlessDestinationConfigurationProperty = new AmazonOpenSearchServerlessDestinationConfigurationProperty {
                 BufferingHints = new AmazonOpenSearchServerlessBufferingHintsProperty {
                     IntervalInSeconds = 123,
                     SizeInMBs = 123
                 },
                 CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                     Enabled = false,
                     LogGroupName = "logGroupName",
                     LogStreamName = "logStreamName"
                 },
                 CollectionEndpoint = "collectionEndpoint",
                 IndexName = "indexName",
                 ProcessingConfiguration = new ProcessingConfigurationProperty {
                     Enabled = false,
                     Processors = new [] { new ProcessorProperty {
                         Parameters = new [] { new ProcessorParameterProperty {
                             ParameterName = "parameterName",
                             ParameterValue = "parameterValue"
                         } },
                         Type = "type"
                     } }
                 },
                 RetryOptions = new AmazonOpenSearchServerlessRetryOptionsProperty {
                     DurationInSeconds = 123
                 },
                 RoleArn = "roleArn",
                 S3BackupMode = "s3BackupMode",
                 S3Configuration = new S3DestinationConfigurationProperty {
                     BucketArn = "bucketArn",
                     BufferingHints = new BufferingHintsProperty {
                         IntervalInSeconds = 123,
                         SizeInMBs = 123
                     },
                     CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                         Enabled = false,
                         LogGroupName = "logGroupName",
                         LogStreamName = "logStreamName"
                     },
                     CompressionFormat = "compressionFormat",
                     EncryptionConfiguration = new EncryptionConfigurationProperty {
                         KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                             AwskmsKeyArn = "awskmsKeyArn"
                         },
                         NoEncryptionConfig = "noEncryptionConfig"
                     },
                     ErrorOutputPrefix = "errorOutputPrefix",
                     Prefix = "prefix",
                     RoleArn = "roleArn"
                 },
                 VpcConfiguration = new VpcConfigurationProperty {
                     RoleArn = "roleArn",
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Properties

BufferingHints

The buffering options.

public object? BufferingHints { get; set; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IAmazonOpenSearchServerlessBufferingHintsProperty

CloudWatchLoggingOptions

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

public object? CloudWatchLoggingOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.ICloudWatchLoggingOptionsProperty

CollectionEndpoint

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

public string? CollectionEndpoint { get; set; }

Property Value

string

Remarks

IndexName

The Serverless offering for Amazon OpenSearch Service index name.

public string? IndexName { get; set; }

Property Value

string

Remarks

ProcessingConfiguration

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

public object? ProcessingConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IProcessingConfigurationProperty

RetryOptions

The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.

public object? RetryOptions { get; set; }

Property Value

object

Remarks

The default value is 300 (5 minutes).

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IAmazonOpenSearchServerlessRetryOptionsProperty

RoleArn

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

public string? RoleArn { get; set; }

Property Value

string

Remarks

S3BackupMode

Defines how documents should be delivered to Amazon S3.

public string? S3BackupMode { get; set; }

Property Value

string

Remarks

When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

S3Configuration

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

public object? S3Configuration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IS3DestinationConfigurationProperty

VpcConfiguration

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

public object? VpcConfiguration { get; set; }