Class CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty
Describes the configuration of a destination in Amazon OpenSearch Service.
Inheritance
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AmazonopensearchserviceDestinationConfigurationProperty : Object, CfnDeliveryStream.IAmazonopensearchserviceDestinationConfigurationProperty
Syntax (vb)
Public Class AmazonopensearchserviceDestinationConfigurationProperty
Inherits Object
Implements CfnDeliveryStream.IAmazonopensearchserviceDestinationConfigurationProperty
Remarks
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.AWS.KinesisFirehose;
var amazonopensearchserviceDestinationConfigurationProperty = new AmazonopensearchserviceDestinationConfigurationProperty {
IndexName = "indexName",
RoleArn = "roleArn",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
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"
},
// the properties below are optional
BufferingHints = new AmazonopensearchserviceBufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
ClusterEndpoint = "clusterEndpoint",
DocumentIdOptions = new DocumentIdOptionsProperty {
DefaultDocumentIdFormat = "defaultDocumentIdFormat"
},
DomainArn = "domainArn",
IndexRotationPeriod = "indexRotationPeriod",
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new AmazonopensearchserviceRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupMode = "s3BackupMode",
TypeName = "typeName",
VpcConfiguration = new VpcConfigurationProperty {
RoleArn = "roleArn",
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};
Synopsis
Constructors
AmazonopensearchserviceDestinationConfigurationProperty() |
Properties
BufferingHints | The buffering options. |
CloudWatchLoggingOptions | Describes the Amazon CloudWatch logging options for your delivery stream. |
ClusterEndpoint | The endpoint to use when communicating with the cluster. |
DocumentIdOptions | Indicates the method for setting up document ID. |
DomainArn | The ARN of the Amazon OpenSearch Service domain. |
IndexName | The Amazon OpenSearch Service index name. |
IndexRotationPeriod | The Amazon OpenSearch Service index rotation period. |
ProcessingConfiguration | Describes a data processing configuration. |
RetryOptions | The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. |
RoleArn | 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. |
S3BackupMode | Defines how documents should be delivered to Amazon S3. |
S3Configuration | Describes the configuration of a destination in Amazon S3. |
TypeName | The Amazon OpenSearch Service type name. |
VpcConfiguration | The details of the VPC of the Amazon OpenSearch Service destination. |
Constructors
AmazonopensearchserviceDestinationConfigurationProperty()
public AmazonopensearchserviceDestinationConfigurationProperty()
Properties
BufferingHints
The buffering options.
public object BufferingHints { get; set; }
Property Value
System.Object
Remarks
If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
CloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.
public object CloudWatchLoggingOptions { get; set; }
Property Value
System.Object
Remarks
ClusterEndpoint
The endpoint to use when communicating with the cluster.
public string ClusterEndpoint { get; set; }
Property Value
System.String
Remarks
Specify either this ClusterEndpoint or the DomainARN field.
DocumentIdOptions
Indicates the method for setting up document ID.
public object DocumentIdOptions { get; set; }
Property Value
System.Object
Remarks
The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
DomainArn
The ARN of the Amazon OpenSearch Service domain.
public string DomainArn { get; set; }
Property Value
System.String
Remarks
IndexName
The Amazon OpenSearch Service index name.
public string IndexName { get; set; }
Property Value
System.String
Remarks
IndexRotationPeriod
The Amazon OpenSearch Service index rotation period.
public string IndexRotationPeriod { get; set; }
Property Value
System.String
Remarks
Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
ProcessingConfiguration
Describes a data processing configuration.
public object ProcessingConfiguration { get; set; }
Property Value
System.Object
Remarks
RetryOptions
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
public object RetryOptions { get; set; }
Property Value
System.Object
Remarks
RoleArn
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.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
S3BackupMode
Defines how documents should be delivered to Amazon S3.
public string S3BackupMode { get; set; }
Property Value
System.String
Remarks
S3Configuration
Describes the configuration of a destination in Amazon S3.
public object S3Configuration { get; set; }
Property Value
System.Object
Remarks
TypeName
The Amazon OpenSearch Service type name.
public string TypeName { get; set; }
Property Value
System.String
Remarks
VpcConfiguration
The details of the VPC of the Amazon OpenSearch Service destination.
public object VpcConfiguration { get; set; }
Property Value
System.Object