DeliveryStreamAttributes

class aws_cdk.aws_kinesisfirehose.DeliveryStreamAttributes(*, delivery_stream_arn=None, delivery_stream_name=None, role=None)

Bases: object

(experimental) A full specification of a delivery stream that can be used to import it fluently into the CDK application.

Parameters
  • delivery_stream_arn (Optional[str]) – (experimental) The ARN of the delivery stream. At least one of deliveryStreamArn and deliveryStreamName must be provided. Default: - derived from deliveryStreamName.

  • delivery_stream_name (Optional[str]) – (experimental) The name of the delivery stream. At least one of deliveryStreamName and deliveryStreamArn must be provided. Default: - derived from deliveryStreamArn.

  • 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: - the imported stream cannot be granted access to other resources as an iam.IGrantable.

Stability

experimental

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iam as iam
import aws_cdk.aws_kinesisfirehose as kinesisfirehose

# role: iam.Role

delivery_stream_attributes = kinesisfirehose.DeliveryStreamAttributes(
    delivery_stream_arn="deliveryStreamArn",
    delivery_stream_name="deliveryStreamName",
    role=role
)

Attributes

delivery_stream_arn

(experimental) The ARN of the delivery stream.

At least one of deliveryStreamArn and deliveryStreamName must be provided.

Default
  • derived from deliveryStreamName.

Stability

experimental

Return type

Optional[str]

delivery_stream_name

(experimental) The name of the delivery stream.

At least one of deliveryStreamName and deliveryStreamArn must be provided.

Default
  • derived from deliveryStreamArn.

Stability

experimental

Return type

Optional[str]

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
  • the imported stream cannot be granted access to other resources as an iam.IGrantable.

Stability

experimental

Return type

Optional[IRole]