Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStream

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:45.276Z")
@Stability(Stable)
public class CfnDeliveryStream
extends CfnResource
implements IInspectable, ITaggable

The AWS::KinesisFirehose::DeliveryStream resource specifies an Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3), Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES) destination.

For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream in the Amazon Kinesis Data Firehose Developer Guide .

Example:

 Bucket destinationBucket = new Bucket(this, "Bucket");
 Role deliveryStreamRole = Role.Builder.create(this, "Role")
         .assumedBy(new ServicePrincipal("firehose.amazonaws.com"))
         .build();
 CfnDeliveryStream stream = CfnDeliveryStream.Builder.create(this, "MyStream")
         .deliveryStreamName("amazon-apigateway-delivery-stream")
         .s3DestinationConfiguration(S3DestinationConfigurationProperty.builder()
                 .bucketArn(destinationBucket.getBucketArn())
                 .roleArn(deliveryStreamRole.getRoleArn())
                 .build())
         .build();
 RestApi api = RestApi.Builder.create(this, "books")
         .deployOptions(StageOptions.builder()
                 .accessLogDestination(new FirehoseLogDestination(stream))
                 .accessLogFormat(AccessLogFormat.jsonWithStandardFields())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDeliveryStream.AmazonOpenSearchServerlessBufferingHintsProperty	Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
static interface	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
static interface	CfnDeliveryStream.AmazonOpenSearchServerlessRetryOptionsProperty	Configures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
static interface	CfnDeliveryStream.AmazonopensearchserviceBufferingHintsProperty	Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
static interface	CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty	Describes the configuration of a destination in Amazon OpenSearch Service.
static interface	CfnDeliveryStream.AmazonopensearchserviceRetryOptionsProperty	Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
static interface	CfnDeliveryStream.AuthenticationConfigurationProperty	The authentication configuration of the Amazon MSK cluster.
static interface	CfnDeliveryStream.BufferingHintsProperty	The BufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data before delivering it to the destination.
static final class	CfnDeliveryStream.Builder	A fluent builder for CfnDeliveryStream.
static interface	CfnDeliveryStream.CatalogConfigurationProperty	Describes the containers where the destination Apache Iceberg Tables are persisted.
static interface	CfnDeliveryStream.CloudWatchLoggingOptionsProperty	The CloudWatchLoggingOptions property type specifies Amazon CloudWatch Logs (CloudWatch Logs) logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses for the delivery stream.
static interface	CfnDeliveryStream.CopyCommandProperty	The CopyCommand property type configures the Amazon Redshift COPY command that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket.
static interface	CfnDeliveryStream.DataFormatConversionConfigurationProperty	Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
static interface	CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty	Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
static interface	CfnDeliveryStream.DeserializerProperty	The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON.
static interface	CfnDeliveryStream.DestinationTableConfigurationProperty	Describes the configuration of a destination in Apache Iceberg Tables.
static interface	CfnDeliveryStream.DocumentIdOptionsProperty	Indicates the method for setting up document ID.
static interface	CfnDeliveryStream.DynamicPartitioningConfigurationProperty	The DynamicPartitioningConfiguration property type specifies the configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.
static interface	CfnDeliveryStream.ElasticsearchBufferingHintsProperty	The ElasticsearchBufferingHints property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data while delivering it to the destination.
static interface	CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty	The ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.
static interface	CfnDeliveryStream.ElasticsearchRetryOptionsProperty	The ElasticsearchRetryOptions property type configures the retry behavior for when Amazon Kinesis Data Firehose (Kinesis Data Firehose) can't deliver data to Amazon Elasticsearch Service (Amazon ES).
static interface	CfnDeliveryStream.EncryptionConfigurationProperty	The EncryptionConfiguration property type specifies the encryption settings that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses when delivering data to Amazon Simple Storage Service (Amazon S3).
static interface	CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty	The ExtendedS3DestinationConfiguration property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.
static interface	CfnDeliveryStream.HiveJsonSerDeProperty	The native Hive / HCatalog JsonSerDe.
static interface	CfnDeliveryStream.HttpEndpointCommonAttributeProperty	Describes the metadata that's delivered to the specified HTTP endpoint destination.
static interface	CfnDeliveryStream.HttpEndpointConfigurationProperty	Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
static interface	CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty	Describes the configuration of the HTTP endpoint destination.
static interface	CfnDeliveryStream.HttpEndpointRequestConfigurationProperty	The configuration of the HTTP endpoint request.
static interface	CfnDeliveryStream.IcebergDestinationConfigurationProperty	Specifies the destination configure settings for Apache Iceberg Table.
static interface	CfnDeliveryStream.InputFormatConfigurationProperty	Specifies the deserializer you want to use to convert the format of the input data.
static interface	CfnDeliveryStream.KinesisStreamSourceConfigurationProperty	The KinesisStreamSourceConfiguration property type specifies the stream and role Amazon Resource Names (ARNs) for a Kinesis stream used as the source for a delivery stream.
static interface	CfnDeliveryStream.KMSEncryptionConfigProperty	The KMSEncryptionConfig property type specifies the AWS Key Management Service ( AWS KMS) encryption key that Amazon Simple Storage Service (Amazon S3) uses to encrypt data delivered by the Amazon Kinesis Data Firehose (Kinesis Data Firehose) stream.
static interface	CfnDeliveryStream.MSKSourceConfigurationProperty	The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
static interface	CfnDeliveryStream.OpenXJsonSerDeProperty	The OpenX SerDe.
static interface	CfnDeliveryStream.OrcSerDeProperty	A serializer to use for converting data to the ORC format before storing it in Amazon S3.
static interface	CfnDeliveryStream.OutputFormatConfigurationProperty	Specifies the serializer that you want Firehose to use to convert the format of your data before it writes it to Amazon S3.
static interface	CfnDeliveryStream.ParquetSerDeProperty	A serializer to use for converting data to the Parquet format before storing it in Amazon S3.
static interface	CfnDeliveryStream.ProcessingConfigurationProperty	The ProcessingConfiguration property configures data processing for an Amazon Kinesis Data Firehose delivery stream.
static interface	CfnDeliveryStream.ProcessorParameterProperty	The ProcessorParameter property specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream.
static interface	CfnDeliveryStream.ProcessorProperty	The Processor property specifies a data processor for an Amazon Kinesis Data Firehose delivery stream.
static interface	CfnDeliveryStream.RedshiftDestinationConfigurationProperty	The RedshiftDestinationConfiguration property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
static interface	CfnDeliveryStream.RedshiftRetryOptionsProperty	Configures retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.
static interface	CfnDeliveryStream.RetryOptionsProperty	Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
static interface	CfnDeliveryStream.S3DestinationConfigurationProperty	The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
static interface	CfnDeliveryStream.SchemaConfigurationProperty	Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3.
static interface	CfnDeliveryStream.SecretsManagerConfigurationProperty	The structure that defines how Firehose accesses the secret.
static interface	CfnDeliveryStream.SerializerProperty	The serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3.
static interface	CfnDeliveryStream.SnowflakeBufferingHintsProperty	Describes the buffering to perform before delivering data to the Snowflake destination.
static interface	CfnDeliveryStream.SnowflakeDestinationConfigurationProperty	Configure Snowflake destination.
static interface	CfnDeliveryStream.SnowflakeRetryOptionsProperty	Specify how long Firehose retries sending data to the New Relic HTTP endpoint.
static interface	CfnDeliveryStream.SnowflakeRoleConfigurationProperty	Optionally configure a Snowflake role.
static interface	CfnDeliveryStream.SnowflakeVpcConfigurationProperty	Configure a Snowflake VPC.
static interface	CfnDeliveryStream.SplunkBufferingHintsProperty	The buffering options.
static interface	CfnDeliveryStream.SplunkDestinationConfigurationProperty	The SplunkDestinationConfiguration property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.
static interface	CfnDeliveryStream.SplunkRetryOptionsProperty	The SplunkRetryOptions property type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk.
static interface	CfnDeliveryStream.VpcConfigurationProperty	The details of the VPC of the Amazon ES destination.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDeliveryStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeliveryStream(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDeliveryStream(software.constructs.Construct scope, String id)
	CfnDeliveryStream(software.constructs.Construct scope, String id, CfnDeliveryStreamProps props)

Method Summary

Modifier and Type	Method	Description
Object	getAmazonOpenSearchServerlessDestinationConfiguration()	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
Object	getAmazonopensearchserviceDestinationConfiguration()	The destination in Amazon OpenSearch Service.
String	getAttrArn()	The Amazon Resource Name (ARN) of the delivery stream, such as arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name .
protected Map<String,Object>	getCfnProperties()
Object	getDeliveryStreamEncryptionConfigurationInput()	Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
String	getDeliveryStreamName()	The name of the Firehose stream.
String	getDeliveryStreamType()	The Firehose stream type.
Object	getElasticsearchDestinationConfiguration()	An Amazon ES destination for the delivery stream.
Object	getExtendedS3DestinationConfiguration()	An Amazon S3 destination for the delivery stream.
Object	getHttpEndpointDestinationConfiguration()	Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
Object	getIcebergDestinationConfiguration()	Specifies the destination configure settings for Apache Iceberg Table.
Object	getKinesisStreamSourceConfiguration()	When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.
Object	getMskSourceConfiguration()	The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
Object	getRedshiftDestinationConfiguration()	An Amazon Redshift destination for the delivery stream.
Object	getS3DestinationConfiguration()	The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
Object	getSnowflakeDestinationConfiguration()	Configure Snowflake destination.
Object	getSplunkDestinationConfiguration()	The configuration of a destination in Splunk for the delivery stream.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	A set of tags to assign to the Firehose stream.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAmazonOpenSearchServerlessDestinationConfiguration(IResolvable value)	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
void	setAmazonOpenSearchServerlessDestinationConfiguration(CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty value)	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
void	setAmazonopensearchserviceDestinationConfiguration(IResolvable value)	The destination in Amazon OpenSearch Service.
void	setAmazonopensearchserviceDestinationConfiguration(CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty value)	The destination in Amazon OpenSearch Service.
void	setDeliveryStreamEncryptionConfigurationInput(IResolvable value)	Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
void	setDeliveryStreamEncryptionConfigurationInput(CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty value)	Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
void	setDeliveryStreamName(String value)	The name of the Firehose stream.
void	setDeliveryStreamType(String value)	The Firehose stream type.
void	setElasticsearchDestinationConfiguration(IResolvable value)	An Amazon ES destination for the delivery stream.
void	setElasticsearchDestinationConfiguration(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty value)	An Amazon ES destination for the delivery stream.
void	setExtendedS3DestinationConfiguration(IResolvable value)	An Amazon S3 destination for the delivery stream.
void	setExtendedS3DestinationConfiguration(CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty value)	An Amazon S3 destination for the delivery stream.
void	setHttpEndpointDestinationConfiguration(IResolvable value)	Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
void	setHttpEndpointDestinationConfiguration(CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty value)	Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
void	setIcebergDestinationConfiguration(IResolvable value)	Specifies the destination configure settings for Apache Iceberg Table.
void	setIcebergDestinationConfiguration(CfnDeliveryStream.IcebergDestinationConfigurationProperty value)	Specifies the destination configure settings for Apache Iceberg Table.
void	setKinesisStreamSourceConfiguration(IResolvable value)	When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.
void	setKinesisStreamSourceConfiguration(CfnDeliveryStream.KinesisStreamSourceConfigurationProperty value)	When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.
void	setMskSourceConfiguration(IResolvable value)	The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
void	setMskSourceConfiguration(CfnDeliveryStream.MSKSourceConfigurationProperty value)	The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
void	setRedshiftDestinationConfiguration(IResolvable value)	An Amazon Redshift destination for the delivery stream.
void	setRedshiftDestinationConfiguration(CfnDeliveryStream.RedshiftDestinationConfigurationProperty value)	An Amazon Redshift destination for the delivery stream.
void	setS3DestinationConfiguration(IResolvable value)	The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
void	setS3DestinationConfiguration(CfnDeliveryStream.S3DestinationConfigurationProperty value)	The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
void	setSnowflakeDestinationConfiguration(IResolvable value)	Configure Snowflake destination.
void	setSnowflakeDestinationConfiguration(CfnDeliveryStream.SnowflakeDestinationConfigurationProperty value)	Configure Snowflake destination.
void	setSplunkDestinationConfiguration(IResolvable value)	The configuration of a destination in Splunk for the delivery stream.
void	setSplunkDestinationConfiguration(CfnDeliveryStream.SplunkDestinationConfigurationProperty value)	The configuration of a destination in Splunk for the delivery stream.
void	setTagsRaw(List<CfnTag> value)	A set of tags to assign to the Firehose stream.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDeliveryStream

protected CfnDeliveryStream(software.amazon.jsii.JsiiObjectRef objRef)

CfnDeliveryStream

protected CfnDeliveryStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDeliveryStream

@Stability(Stable)
public CfnDeliveryStream(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnDeliveryStreamProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnDeliveryStream

@Stability(Stable)
public CfnDeliveryStream(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the delivery stream, such as arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAmazonOpenSearchServerlessDestinationConfiguration

@Stability(Stable)
@Nullable
public Object getAmazonOpenSearchServerlessDestinationConfiguration()

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

setAmazonOpenSearchServerlessDestinationConfiguration

@Stability(Stable)
public void setAmazonOpenSearchServerlessDestinationConfiguration(@Nullable
 IResolvable value)

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

setAmazonOpenSearchServerlessDestinationConfiguration

@Stability(Stable)
public void setAmazonOpenSearchServerlessDestinationConfiguration(@Nullable
 CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty value)

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

getAmazonopensearchserviceDestinationConfiguration

@Stability(Stable)
@Nullable
public Object getAmazonopensearchserviceDestinationConfiguration()

The destination in Amazon OpenSearch Service.

setAmazonopensearchserviceDestinationConfiguration

@Stability(Stable)
public void setAmazonopensearchserviceDestinationConfiguration(@Nullable
 IResolvable value)

The destination in Amazon OpenSearch Service.

setAmazonopensearchserviceDestinationConfiguration

@Stability(Stable)
public void setAmazonopensearchserviceDestinationConfiguration(@Nullable
 CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty value)

The destination in Amazon OpenSearch Service.

getDeliveryStreamEncryptionConfigurationInput

@Stability(Stable)
@Nullable
public Object getDeliveryStreamEncryptionConfigurationInput()

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

setDeliveryStreamEncryptionConfigurationInput

@Stability(Stable)
public void setDeliveryStreamEncryptionConfigurationInput(@Nullable
 IResolvable value)

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

setDeliveryStreamEncryptionConfigurationInput

@Stability(Stable)
public void setDeliveryStreamEncryptionConfigurationInput(@Nullable
 CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty value)

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

getDeliveryStreamName

@Stability(Stable)
@Nullable
public String getDeliveryStreamName()

The name of the Firehose stream.

setDeliveryStreamName

@Stability(Stable)
public void setDeliveryStreamName(@Nullable
 String value)

The name of the Firehose stream.

getDeliveryStreamType

@Stability(Stable)
@Nullable
public String getDeliveryStreamType()

The Firehose stream type.

This can be one of the following values:.

setDeliveryStreamType

@Stability(Stable)
public void setDeliveryStreamType(@Nullable
 String value)

The Firehose stream type.

This can be one of the following values:.

getElasticsearchDestinationConfiguration

@Stability(Stable)
@Nullable
public Object getElasticsearchDestinationConfiguration()

An Amazon ES destination for the delivery stream.

setElasticsearchDestinationConfiguration

@Stability(Stable)
public void setElasticsearchDestinationConfiguration(@Nullable
 IResolvable value)

An Amazon ES destination for the delivery stream.

setElasticsearchDestinationConfiguration

@Stability(Stable)
public void setElasticsearchDestinationConfiguration(@Nullable
 CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty value)

An Amazon ES destination for the delivery stream.

getExtendedS3DestinationConfiguration

@Stability(Stable)
@Nullable
public Object getExtendedS3DestinationConfiguration()

An Amazon S3 destination for the delivery stream.

setExtendedS3DestinationConfiguration

@Stability(Stable)
public void setExtendedS3DestinationConfiguration(@Nullable
 IResolvable value)

An Amazon S3 destination for the delivery stream.

setExtendedS3DestinationConfiguration

@Stability(Stable)
public void setExtendedS3DestinationConfiguration(@Nullable
 CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty value)

An Amazon S3 destination for the delivery stream.

getHttpEndpointDestinationConfiguration

@Stability(Stable)
@Nullable
public Object getHttpEndpointDestinationConfiguration()

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

setHttpEndpointDestinationConfiguration

@Stability(Stable)
public void setHttpEndpointDestinationConfiguration(@Nullable
 IResolvable value)

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

setHttpEndpointDestinationConfiguration

@Stability(Stable)
public void setHttpEndpointDestinationConfiguration(@Nullable
 CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty value)

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

getIcebergDestinationConfiguration

@Stability(Stable)
@Nullable
public Object getIcebergDestinationConfiguration()

Specifies the destination configure settings for Apache Iceberg Table.

setIcebergDestinationConfiguration

@Stability(Stable)
public void setIcebergDestinationConfiguration(@Nullable
 IResolvable value)

Specifies the destination configure settings for Apache Iceberg Table.

setIcebergDestinationConfiguration

@Stability(Stable)
public void setIcebergDestinationConfiguration(@Nullable
 CfnDeliveryStream.IcebergDestinationConfigurationProperty value)

Specifies the destination configure settings for Apache Iceberg Table.

getKinesisStreamSourceConfiguration

@Stability(Stable)
@Nullable
public Object getKinesisStreamSourceConfiguration()

When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

setKinesisStreamSourceConfiguration

@Stability(Stable)
public void setKinesisStreamSourceConfiguration(@Nullable
 IResolvable value)

When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

setKinesisStreamSourceConfiguration

@Stability(Stable)
public void setKinesisStreamSourceConfiguration(@Nullable
 CfnDeliveryStream.KinesisStreamSourceConfigurationProperty value)

When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

getMskSourceConfiguration

@Stability(Stable)
@Nullable
public Object getMskSourceConfiguration()

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

setMskSourceConfiguration

@Stability(Stable)
public void setMskSourceConfiguration(@Nullable
 IResolvable value)

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

setMskSourceConfiguration

@Stability(Stable)
public void setMskSourceConfiguration(@Nullable
 CfnDeliveryStream.MSKSourceConfigurationProperty value)

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

getRedshiftDestinationConfiguration

@Stability(Stable)
@Nullable
public Object getRedshiftDestinationConfiguration()

An Amazon Redshift destination for the delivery stream.

setRedshiftDestinationConfiguration

@Stability(Stable)
public void setRedshiftDestinationConfiguration(@Nullable
 IResolvable value)

An Amazon Redshift destination for the delivery stream.

setRedshiftDestinationConfiguration

@Stability(Stable)
public void setRedshiftDestinationConfiguration(@Nullable
 CfnDeliveryStream.RedshiftDestinationConfigurationProperty value)

An Amazon Redshift destination for the delivery stream.

getS3DestinationConfiguration

@Stability(Stable)
@Nullable
public Object getS3DestinationConfiguration()

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

setS3DestinationConfiguration

@Stability(Stable)
public void setS3DestinationConfiguration(@Nullable
 IResolvable value)

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

setS3DestinationConfiguration

@Stability(Stable)
public void setS3DestinationConfiguration(@Nullable
 CfnDeliveryStream.S3DestinationConfigurationProperty value)

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

getSnowflakeDestinationConfiguration

@Stability(Stable)
@Nullable
public Object getSnowflakeDestinationConfiguration()

Configure Snowflake destination.

setSnowflakeDestinationConfiguration

@Stability(Stable)
public void setSnowflakeDestinationConfiguration(@Nullable
 IResolvable value)

Configure Snowflake destination.

setSnowflakeDestinationConfiguration

@Stability(Stable)
public void setSnowflakeDestinationConfiguration(@Nullable
 CfnDeliveryStream.SnowflakeDestinationConfigurationProperty value)

Configure Snowflake destination.

getSplunkDestinationConfiguration

@Stability(Stable)
@Nullable
public Object getSplunkDestinationConfiguration()

The configuration of a destination in Splunk for the delivery stream.

setSplunkDestinationConfiguration

@Stability(Stable)
public void setSplunkDestinationConfiguration(@Nullable
 IResolvable value)

The configuration of a destination in Splunk for the delivery stream.

setSplunkDestinationConfiguration

@Stability(Stable)
public void setSplunkDestinationConfiguration(@Nullable
 CfnDeliveryStream.SplunkDestinationConfigurationProperty value)

The configuration of a destination in Splunk for the delivery stream.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

A set of tags to assign to the Firehose stream.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

A set of tags to assign to the Firehose stream.