Interface CfnDeliveryStreamProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeliveryStreamProps.Jsii$Proxy
CfnDeliveryStream.
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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDeliveryStreamPropsstatic final classAn implementation forCfnDeliveryStreamProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectDescribes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.default ObjectThe destination in Amazon OpenSearch Service.default ObjectThe top level object for configuring streams with database as a source.default ObjectSpecifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).default ObjectThe name of the Firehose stream.default StringThe Firehose stream type.default ObjectThe structure that configures parameters such asThroughputHintInMBsfor a stream configured with Direct PUT as a source.default ObjectAn Amazon ES destination for the delivery stream.default ObjectAn Amazon S3 destination for the delivery stream.default ObjectEnables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.default ObjectSpecifies the destination configure settings for Apache Iceberg Table.default ObjectWhen 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.default ObjectThe configuration for the Amazon MSK cluster to be used as the source for a delivery stream.default ObjectAn Amazon Redshift destination for the delivery stream.default ObjectTheS3DestinationConfigurationproperty type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.default ObjectConfigure Snowflake destination.default ObjectThe configuration of a destination in Splunk for the delivery stream.getTags()A set of tags to assign to the Firehose stream.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAmazonOpenSearchServerlessDestinationConfiguration
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.Returns union: either
IResolvableorCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty- See Also:
-
getAmazonopensearchserviceDestinationConfiguration
The destination in Amazon OpenSearch Service.You can specify only one destination.
Returns union: either
IResolvableorCfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty- See Also:
-
getDatabaseSourceConfiguration
The top level object for configuring streams with database as a source.Amazon Data Firehose is in preview release and is subject to change.
Returns union: either
IResolvableorCfnDeliveryStream.DatabaseSourceConfigurationProperty- See Also:
-
getDeliveryStreamEncryptionConfigurationInput
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).Returns union: either
IResolvableorCfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty- See Also:
-
getDeliveryStreamName
The name of the Firehose stream.Returns union: either
StringorIStreamRef- See Also:
-
getDeliveryStreamType
The Firehose stream type. This can be one of the following values:.DirectPut: Provider applications access the Firehose stream directly.KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
- See Also:
-
getDirectPutSourceConfiguration
The structure that configures parameters such asThroughputHintInMBsfor a stream configured with Direct PUT as a source.Returns union: either
IResolvableorCfnDeliveryStream.DirectPutSourceConfigurationProperty- See Also:
-
getElasticsearchDestinationConfiguration
An Amazon ES destination for the delivery stream.Conditional. You must specify only one destination configuration.
If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires some interruptions .
Returns union: either
IResolvableorCfnDeliveryStream.ElasticsearchDestinationConfigurationProperty- See Also:
-
getExtendedS3DestinationConfiguration
An Amazon S3 destination for the delivery stream.Conditional. You must specify only one destination configuration.
If you change the delivery stream destination from an Amazon Extended S3 destination to an Amazon ES destination, update requires some interruptions .
Returns union: either
IResolvableorCfnDeliveryStream.ExtendedS3DestinationConfigurationProperty- See Also:
-
getHttpEndpointDestinationConfiguration
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.You can specify only one destination.
Returns union: either
IResolvableorCfnDeliveryStream.HttpEndpointDestinationConfigurationProperty- See Also:
-
getIcebergDestinationConfiguration
Specifies the destination configure settings for Apache Iceberg Table.Returns union: either
IResolvableorCfnDeliveryStream.IcebergDestinationConfigurationProperty- See Also:
-
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.Returns union: either
IResolvableorCfnDeliveryStream.KinesisStreamSourceConfigurationProperty- See Also:
-
getMskSourceConfiguration
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.Returns union: either
IResolvableorCfnDeliveryStream.MSKSourceConfigurationProperty- See Also:
-
getRedshiftDestinationConfiguration
An Amazon Redshift destination for the delivery stream.Conditional. You must specify only one destination configuration.
If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires some interruptions .
Returns union: either
IResolvableorCfnDeliveryStream.RedshiftDestinationConfigurationProperty- See Also:
-
getS3DestinationConfiguration
TheS3DestinationConfigurationproperty type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.Conditional. You must specify only one destination configuration.
If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires some interruptions .
Returns union: either
IResolvableorCfnDeliveryStream.S3DestinationConfigurationProperty- See Also:
-
getSnowflakeDestinationConfiguration
Configure Snowflake destination.Returns union: either
IResolvableorCfnDeliveryStream.SnowflakeDestinationConfigurationProperty- See Also:
-
getSplunkDestinationConfiguration
The configuration of a destination in Splunk for the delivery stream.Returns union: either
IResolvableorCfnDeliveryStream.SplunkDestinationConfigurationProperty- See Also:
-
getTags
A set of tags to assign to the Firehose stream.A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a Firehose stream.
If you specify tags in the
CreateDeliveryStreamaction, Amazon Data Firehose performs an additional authorization on thefirehose:TagDeliveryStreamaction to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with anAccessDeniedExceptionsuch as following.AccessDeniedException
User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.
For an example IAM policy, see Tag example.
- See Also:
-
builder
- Returns:
- a
CfnDeliveryStreamProps.BuilderofCfnDeliveryStreamProps
-