Class CfnDeliveryStream
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.
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeliveryStream : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDeliveryStream
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream in the Amazon Kinesis Data Firehose Developer Guide .
CloudformationResource: AWS::KinesisFirehose::DeliveryStream
ExampleMetadata: infused
Examples
var destinationBucket = new Bucket(this, "Bucket");
var deliveryStreamRole = new Role(this, "Role", new RoleProps {
AssumedBy = new ServicePrincipal("firehose.amazonaws.com")
});
var stream = new CfnDeliveryStream(this, "MyStream", new CfnDeliveryStreamProps {
DeliveryStreamName = "amazon-apigateway-delivery-stream",
S3DestinationConfiguration = new S3DestinationConfigurationProperty {
BucketArn = destinationBucket.BucketArn,
RoleArn = deliveryStreamRole.RoleArn
}
});
var api = new RestApi(this, "books", new RestApiProps {
DeployOptions = new StageOptions {
AccessLogDestination = new FirehoseLogDestination(stream),
AccessLogFormat = AccessLogFormat.JsonWithStandardFields()
}
});
Synopsis
Constructors
CfnDeliveryStream(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDeliveryStream(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDeliveryStream(Construct, String, ICfnDeliveryStreamProps) |
Properties
AmazonOpenSearchServerlessDestinationConfiguration | Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service. |
AmazonopensearchserviceDestinationConfiguration | The destination in Amazon OpenSearch Service. |
AttrArn | The Amazon Resource Name (ARN) of the delivery stream, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DeliveryStreamEncryptionConfigurationInput | Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). |
DeliveryStreamName | The name of the delivery stream. |
DeliveryStreamType | The delivery stream type. |
ElasticsearchDestinationConfiguration | An Amazon ES destination for the delivery stream. |
ExtendedS3DestinationConfiguration | An Amazon S3 destination for the delivery stream. |
HttpEndpointDestinationConfiguration | Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. |
KinesisStreamSourceConfiguration | 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. |
MskSourceConfiguration | The configuration for the Amazon MSK cluster to be used as the source for a delivery stream. |
RedshiftDestinationConfiguration | An Amazon Redshift destination for the delivery stream. |
S3DestinationConfiguration | The |
SnowflakeDestinationConfiguration | Configure Snowflake destination. |
SplunkDestinationConfiguration | The configuration of a destination in Splunk for the delivery stream. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A set of tags to assign to the delivery stream. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDeliveryStream(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDeliveryStream(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDeliveryStream(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDeliveryStream(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDeliveryStream(Construct, String, ICfnDeliveryStreamProps)
public CfnDeliveryStream(Construct scope, string id, ICfnDeliveryStreamProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDeliveryStreamProps
Resource properties.
Properties
AmazonOpenSearchServerlessDestinationConfiguration
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
public virtual object AmazonOpenSearchServerlessDestinationConfiguration { get; set; }
Property Value
System.Object
AmazonopensearchserviceDestinationConfiguration
The destination in Amazon OpenSearch Service.
public virtual object AmazonopensearchserviceDestinationConfiguration { get; set; }
Property Value
System.Object
AttrArn
The Amazon Resource Name (ARN) of the delivery stream, such as arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DeliveryStreamEncryptionConfigurationInput
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
public virtual object DeliveryStreamEncryptionConfigurationInput { get; set; }
Property Value
System.Object
DeliveryStreamName
The name of the delivery stream.
public virtual string DeliveryStreamName { get; set; }
Property Value
System.String
DeliveryStreamType
The delivery stream type.
public virtual string DeliveryStreamType { get; set; }
Property Value
System.String
Remarks
This can be one of the following values:.
ElasticsearchDestinationConfiguration
An Amazon ES destination for the delivery stream.
public virtual object ElasticsearchDestinationConfiguration { get; set; }
Property Value
System.Object
ExtendedS3DestinationConfiguration
An Amazon S3 destination for the delivery stream.
public virtual object ExtendedS3DestinationConfiguration { get; set; }
Property Value
System.Object
HttpEndpointDestinationConfiguration
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
public virtual object HttpEndpointDestinationConfiguration { get; set; }
Property Value
System.Object
KinesisStreamSourceConfiguration
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.
public virtual object KinesisStreamSourceConfiguration { get; set; }
Property Value
System.Object
MskSourceConfiguration
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
public virtual object MskSourceConfiguration { get; set; }
Property Value
System.Object
RedshiftDestinationConfiguration
An Amazon Redshift destination for the delivery stream.
public virtual object RedshiftDestinationConfiguration { get; set; }
Property Value
System.Object
S3DestinationConfiguration
The S3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
public virtual object S3DestinationConfiguration { get; set; }
Property Value
System.Object
SnowflakeDestinationConfiguration
Configure Snowflake destination.
public virtual object SnowflakeDestinationConfiguration { get; set; }
Property Value
System.Object
SplunkDestinationConfiguration
The configuration of a destination in Splunk for the delivery stream.
public virtual object SplunkDestinationConfiguration { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A set of tags to assign to the delivery stream.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>