DeliveryStreamProps

class aws_cdk.aws_kinesisfirehose_alpha.DeliveryStreamProps(*, destination, delivery_stream_name=None, encryption=None, role=None, source=None)

Bases: object

(experimental) Properties for a new delivery stream.

Parameters:
  • destination (IDestination) – (experimental) The destination that this delivery stream will deliver data to.

  • delivery_stream_name (Optional[str]) – (experimental) A name for the delivery stream. Default: - a name is generated by CloudFormation.

  • encryption (Optional[StreamEncryption]) – (experimental) Indicates the type of customer master key (CMK) to use for server-side encryption, if any. Default: StreamEncryption.unencrypted()

  • role (Optional[IRole]) – (experimental) The IAM role associated with this delivery stream. Assumed by Kinesis Data Firehose to read from sources and encrypt data server-side. Default: - a role will be created with default permissions.

  • source (Optional[ISource]) – (experimental) The Kinesis data stream to use as a source for this delivery stream. Default: - data must be written to the delivery stream via a direct put.

Stability:

experimental

ExampleMetadata:

infused

Example:

# bucket: s3.Bucket
# Provide a Lambda function that will transform records before delivery, with custom
# buffering and retry configuration
lambda_function = lambda_.Function(self, "Processor",
    runtime=lambda_.Runtime.NODEJS_LATEST,
    handler="index.handler",
    code=lambda_.Code.from_asset(path.join(__dirname, "process-records"))
)
lambda_processor = firehose.LambdaFunctionProcessor(lambda_function,
    buffer_interval=Duration.minutes(5),
    buffer_size=Size.mebibytes(5),
    retries=5
)
s3_destination = destinations.S3Bucket(bucket,
    processor=lambda_processor
)
firehose.DeliveryStream(self, "Delivery Stream",
    destination=s3_destination
)

Attributes

delivery_stream_name

(experimental) A name for the delivery stream.

Default:
  • a name is generated by CloudFormation.

Stability:

experimental

destination

(experimental) The destination that this delivery stream will deliver data to.

Stability:

experimental

encryption

(experimental) Indicates the type of customer master key (CMK) to use for server-side encryption, if any.

Default:

StreamEncryption.unencrypted()

Stability:

experimental

role

(experimental) The IAM role associated with this delivery stream.

Assumed by Kinesis Data Firehose to read from sources and encrypt data server-side.

Default:
  • a role will be created with default permissions.

Stability:

experimental

source

(experimental) The Kinesis data stream to use as a source for this delivery stream.

Default:
  • data must be written to the delivery stream via a direct put.

Stability:

experimental