delivery_streams

Creates, updates, deletes or gets a delivery_stream resource or lists delivery_streams in a region

Overview

Name	delivery_streams
Type	Resource
Description	Resource Type definition for AWS::KinesisFirehose::DeliveryStream
Id	awscc.kinesisfirehose.delivery_streams

Fields

Name	Datatype	Description
▶delivery_stream_encryption_configuration_input	object
▶http_endpoint_destination_configuration	object
▶kinesis_stream_source_configuration	object
delivery_stream_type	string
▶iceberg_destination_configuration	object
▶redshift_destination_configuration	object
▶amazonopensearchservice_destination_configuration	object
▶msk_source_configuration	object
▶direct_put_source_configuration	object
▶splunk_destination_configuration	object
▶extended_s3_destination_configuration	object
▶amazon_open_search_serverless_destination_configuration	object
▶elasticsearch_destination_configuration	object
▶snowflake_destination_configuration	object
▶database_source_configuration	object
▶s3_destination_configuration	object
delivery_stream_name	string
arn	string
▶tags	array
region	string	AWS region.

For more information, see AWS::KinesisFirehose::DeliveryStream.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual delivery_stream.

SELECT
region,
delivery_stream_encryption_configuration_input,
http_endpoint_destination_configuration,
kinesis_stream_source_configuration,
delivery_stream_type,
iceberg_destination_configuration,
redshift_destination_configuration,
amazonopensearchservice_destination_configuration,
msk_source_configuration,
direct_put_source_configuration,
splunk_destination_configuration,
extended_s3_destination_configuration,
amazon_open_search_serverless_destination_configuration,
elasticsearch_destination_configuration,
snowflake_destination_configuration,
database_source_configuration,
s3_destination_configuration,
delivery_stream_name,
arn,
tags
FROM awscc.kinesisfirehose.delivery_streams
WHERE region = 'us-east-1' AND data__Identifier = '<DeliveryStreamName>';

INSERT example

Use the following StackQL query and manifest file to create a new delivery_stream resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.kinesisfirehose.delivery_streams (
 DeliveryStreamEncryptionConfigurationInput,
 HttpEndpointDestinationConfiguration,
 KinesisStreamSourceConfiguration,
 DeliveryStreamType,
 IcebergDestinationConfiguration,
 RedshiftDestinationConfiguration,
 AmazonopensearchserviceDestinationConfiguration,
 MSKSourceConfiguration,
 DirectPutSourceConfiguration,
 SplunkDestinationConfiguration,
 ExtendedS3DestinationConfiguration,
 AmazonOpenSearchServerlessDestinationConfiguration,
 ElasticsearchDestinationConfiguration,
 SnowflakeDestinationConfiguration,
 DatabaseSourceConfiguration,
 S3DestinationConfiguration,
 DeliveryStreamName,
 Tags,
 region
)
SELECT 
'{{ DeliveryStreamEncryptionConfigurationInput }}',
 '{{ HttpEndpointDestinationConfiguration }}',
 '{{ KinesisStreamSourceConfiguration }}',
 '{{ DeliveryStreamType }}',
 '{{ IcebergDestinationConfiguration }}',
 '{{ RedshiftDestinationConfiguration }}',
 '{{ AmazonopensearchserviceDestinationConfiguration }}',
 '{{ MSKSourceConfiguration }}',
 '{{ DirectPutSourceConfiguration }}',
 '{{ SplunkDestinationConfiguration }}',
 '{{ ExtendedS3DestinationConfiguration }}',
 '{{ AmazonOpenSearchServerlessDestinationConfiguration }}',
 '{{ ElasticsearchDestinationConfiguration }}',
 '{{ SnowflakeDestinationConfiguration }}',
 '{{ DatabaseSourceConfiguration }}',
 '{{ S3DestinationConfiguration }}',
 '{{ DeliveryStreamName }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.kinesisfirehose.delivery_streams (
 DeliveryStreamEncryptionConfigurationInput,
 HttpEndpointDestinationConfiguration,
 KinesisStreamSourceConfiguration,
 DeliveryStreamType,
 IcebergDestinationConfiguration,
 RedshiftDestinationConfiguration,
 AmazonopensearchserviceDestinationConfiguration,
 MSKSourceConfiguration,
 DirectPutSourceConfiguration,
 SplunkDestinationConfiguration,
 ExtendedS3DestinationConfiguration,
 AmazonOpenSearchServerlessDestinationConfiguration,
 ElasticsearchDestinationConfiguration,
 SnowflakeDestinationConfiguration,
 DatabaseSourceConfiguration,
 S3DestinationConfiguration,
 DeliveryStreamName,
 Tags,
 region
)
SELECT 
 '{{ DeliveryStreamEncryptionConfigurationInput }}',
 '{{ HttpEndpointDestinationConfiguration }}',
 '{{ KinesisStreamSourceConfiguration }}',
 '{{ DeliveryStreamType }}',
 '{{ IcebergDestinationConfiguration }}',
 '{{ RedshiftDestinationConfiguration }}',
 '{{ AmazonopensearchserviceDestinationConfiguration }}',
 '{{ MSKSourceConfiguration }}',
 '{{ DirectPutSourceConfiguration }}',
 '{{ SplunkDestinationConfiguration }}',
 '{{ ExtendedS3DestinationConfiguration }}',
 '{{ AmazonOpenSearchServerlessDestinationConfiguration }}',
 '{{ ElasticsearchDestinationConfiguration }}',
 '{{ SnowflakeDestinationConfiguration }}',
 '{{ DatabaseSourceConfiguration }}',
 '{{ S3DestinationConfiguration }}',
 '{{ DeliveryStreamName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: delivery_stream
    props:
      - name: DeliveryStreamEncryptionConfigurationInput
        value:
          KeyType: '{{ KeyType }}'
          KeyARN: '{{ KeyARN }}'
      - name: HttpEndpointDestinationConfiguration
        value:
          RequestConfiguration:
            CommonAttributes:
              - AttributeValue: '{{ AttributeValue }}'
                AttributeName: '{{ AttributeName }}'
            ContentEncoding: '{{ ContentEncoding }}'
          S3Configuration:
            ErrorOutputPrefix: '{{ ErrorOutputPrefix }}'
            BucketARN: '{{ BucketARN }}'
            BufferingHints:
              IntervalInSeconds: '{{ IntervalInSeconds }}'
              SizeInMBs: '{{ SizeInMBs }}'
            CompressionFormat: '{{ CompressionFormat }}'
            EncryptionConfiguration:
              KMSEncryptionConfig:
                AWSKMSKeyARN: '{{ AWSKMSKeyARN }}'
              NoEncryptionConfig: '{{ NoEncryptionConfig }}'
            Prefix: '{{ Prefix }}'
            CloudWatchLoggingOptions:
              LogStreamName: '{{ LogStreamName }}'
              Enabled: '{{ Enabled }}'
              LogGroupName: '{{ LogGroupName }}'
            RoleARN: '{{ RoleARN }}'
          BufferingHints: null
          RetryOptions:
            DurationInSeconds: '{{ DurationInSeconds }}'
          SecretsManagerConfiguration:
            SecretARN: '{{ SecretARN }}'
            Enabled: '{{ Enabled }}'
            RoleARN: '{{ RoleARN }}'
          EndpointConfiguration:
            AccessKey: '{{ AccessKey }}'
            Url: '{{ Url }}'
            Name: '{{ Name }}'
          ProcessingConfiguration:
            Enabled: '{{ Enabled }}'
            Processors:
              - Type: '{{ Type }}'
                Parameters:
                  - ParameterValue: '{{ ParameterValue }}'
                    ParameterName: '{{ ParameterName }}'
          RoleARN: '{{ RoleARN }}'
          CloudWatchLoggingOptions: null
          S3BackupMode: '{{ S3BackupMode }}'
      - name: KinesisStreamSourceConfiguration
        value:
          KinesisStreamARN: '{{ KinesisStreamARN }}'
          RoleARN: '{{ RoleARN }}'
      - name: DeliveryStreamType
        value: '{{ DeliveryStreamType }}'
      - name: IcebergDestinationConfiguration
        value:
          CatalogConfiguration:
            CatalogArn: '{{ CatalogArn }}'
            WarehouseLocation: '{{ WarehouseLocation }}'
          S3Configuration: null
          DestinationTableConfigurationList:
            - DestinationDatabaseName: '{{ DestinationDatabaseName }}'
              S3ErrorOutputPrefix: '{{ S3ErrorOutputPrefix }}'
              DestinationTableName: '{{ DestinationTableName }}'
              UniqueKeys:
                - '{{ UniqueKeys[0] }}'
              PartitionSpec:
                Identity:
                  - SourceName: '{{ SourceName }}'
          BufferingHints: null
          TableCreationConfiguration:
            Enabled: '{{ Enabled }}'
          RetryOptions: null
          s3BackupMode: '{{ s3BackupMode }}'
          ProcessingConfiguration: null
          SchemaEvolutionConfiguration:
            Enabled: '{{ Enabled }}'
          AppendOnly: '{{ AppendOnly }}'
          CloudWatchLoggingOptions: null
          RoleARN: '{{ RoleARN }}'
      - name: RedshiftDestinationConfiguration
        value:
          S3BackupConfiguration: null
          S3Configuration: null
          Username: '{{ Username }}'
          CopyCommand:
            DataTableName: '{{ DataTableName }}'
            CopyOptions: '{{ CopyOptions }}'
            DataTableColumns: '{{ DataTableColumns }}'
          RetryOptions:
            DurationInSeconds: '{{ DurationInSeconds }}'
          SecretsManagerConfiguration: null
          ProcessingConfiguration: null
          CloudWatchLoggingOptions: null
          ClusterJDBCURL: '{{ ClusterJDBCURL }}'
          RoleARN: '{{ RoleARN }}'
          Password: '{{ Password }}'
          S3BackupMode: '{{ S3BackupMode }}'
      - name: AmazonopensearchserviceDestinationConfiguration
        value:
          TypeName: '{{ TypeName }}'
          IndexRotationPeriod: '{{ IndexRotationPeriod }}'
          ProcessingConfiguration: null
          ClusterEndpoint: '{{ ClusterEndpoint }}'
          DomainARN: '{{ DomainARN }}'
          RoleARN: '{{ RoleARN }}'
          S3BackupMode: '{{ S3BackupMode }}'
          IndexName: '{{ IndexName }}'
          DocumentIdOptions:
            DefaultDocumentIdFormat: '{{ DefaultDocumentIdFormat }}'
          S3Configuration: null
          BufferingHints:
            IntervalInSeconds: '{{ IntervalInSeconds }}'
            SizeInMBs: '{{ SizeInMBs }}'
          RetryOptions:
            DurationInSeconds: '{{ DurationInSeconds }}'
          VpcConfiguration:
            SubnetIds:
              - '{{ SubnetIds[0] }}'
            SecurityGroupIds:
              - '{{ SecurityGroupIds[0] }}'
            RoleARN: '{{ RoleARN }}'
          CloudWatchLoggingOptions: null
      - name: MSKSourceConfiguration
        value:
          AuthenticationConfiguration:
            Connectivity: '{{ Connectivity }}'
            RoleARN: '{{ RoleARN }}'
          ReadFromTimestamp: '{{ ReadFromTimestamp }}'
          MSKClusterARN: '{{ MSKClusterARN }}'
          TopicName: '{{ TopicName }}'
      - name: DirectPutSourceConfiguration
        value:
          ThroughputHintInMBs: '{{ ThroughputHintInMBs }}'
      - name: SplunkDestinationConfiguration
        value:
          HECEndpoint: '{{ HECEndpoint }}'
          S3Configuration: null
          BufferingHints:
            IntervalInSeconds: '{{ IntervalInSeconds }}'
            SizeInMBs: '{{ SizeInMBs }}'
          HECToken: '{{ HECToken }}'
          RetryOptions:
            DurationInSeconds: '{{ DurationInSeconds }}'
          HECEndpointType: '{{ HECEndpointType }}'
          SecretsManagerConfiguration: null
          HECAcknowledgmentTimeoutInSeconds: '{{ HECAcknowledgmentTimeoutInSeconds }}'
          ProcessingConfiguration: null
          CloudWatchLoggingOptions: null
          S3BackupMode: '{{ S3BackupMode }}'
      - name: ExtendedS3DestinationConfiguration
        value:
          ErrorOutputPrefix: '{{ ErrorOutputPrefix }}'
          S3BackupConfiguration: null
          BucketARN: '{{ BucketARN }}'
          CompressionFormat: '{{ CompressionFormat }}'
          DataFormatConversionConfiguration:
            InputFormatConfiguration:
              Deserializer:
                HiveJsonSerDe:
                  TimestampFormats:
                    - '{{ TimestampFormats[0] }}'
                OpenXJsonSerDe:
                  ConvertDotsInJsonKeysToUnderscores: '{{ ConvertDotsInJsonKeysToUnderscores }}'
                  ColumnToJsonKeyMappings: {}
                  CaseInsensitive: '{{ CaseInsensitive }}'
            Enabled: '{{ Enabled }}'
            SchemaConfiguration:
              VersionId: '{{ VersionId }}'
              TableName: '{{ TableName }}'
              DatabaseName: '{{ DatabaseName }}'
              Region: '{{ Region }}'
              CatalogId: '{{ CatalogId }}'
              RoleARN: '{{ RoleARN }}'
            OutputFormatConfiguration:
              Serializer:
                OrcSerDe:
                  PaddingTolerance: null
                  Compression: '{{ Compression }}'
                  StripeSizeBytes: '{{ StripeSizeBytes }}'
                  BloomFilterColumns:
                    - '{{ BloomFilterColumns[0] }}'
                  BloomFilterFalsePositiveProbability: null
                  EnablePadding: '{{ EnablePadding }}'
                  FormatVersion: '{{ FormatVersion }}'
                  RowIndexStride: '{{ RowIndexStride }}'
                  BlockSizeBytes: '{{ BlockSizeBytes }}'
                  DictionaryKeyThreshold: null
                ParquetSerDe:
                  Compression: '{{ Compression }}'
                  BlockSizeBytes: '{{ BlockSizeBytes }}'
                  EnableDictionaryCompression: '{{ EnableDictionaryCompression }}'
                  PageSizeBytes: '{{ PageSizeBytes }}'
                  MaxPaddingBytes: '{{ MaxPaddingBytes }}'
                  WriterVersion: '{{ WriterVersion }}'
          EncryptionConfiguration: null
          CustomTimeZone: '{{ CustomTimeZone }}'
          DynamicPartitioningConfiguration:
            Enabled: '{{ Enabled }}'
            RetryOptions: null
          Prefix: '{{ Prefix }}'
          ProcessingConfiguration: null
          RoleARN: '{{ RoleARN }}'
          S3BackupMode: '{{ S3BackupMode }}'
          BufferingHints: null
          FileExtension: '{{ FileExtension }}'
          CloudWatchLoggingOptions: null
      - name: AmazonOpenSearchServerlessDestinationConfiguration
        value:
          IndexName: '{{ IndexName }}'
          S3Configuration: null
          BufferingHints:
            IntervalInSeconds: '{{ IntervalInSeconds }}'
            SizeInMBs: '{{ SizeInMBs }}'
          RetryOptions:
            DurationInSeconds: '{{ DurationInSeconds }}'
          CollectionEndpoint: '{{ CollectionEndpoint }}'
          VpcConfiguration: null
          ProcessingConfiguration: null
          CloudWatchLoggingOptions: null
          RoleARN: '{{ RoleARN }}'
          S3BackupMode: '{{ S3BackupMode }}'
      - name: ElasticsearchDestinationConfiguration
        value:
          TypeName: '{{ TypeName }}'
          IndexRotationPeriod: '{{ IndexRotationPeriod }}'
          ProcessingConfiguration: null
          ClusterEndpoint: '{{ ClusterEndpoint }}'
          DomainARN: '{{ DomainARN }}'
          RoleARN: '{{ RoleARN }}'
          S3BackupMode: '{{ S3BackupMode }}'
          IndexName: '{{ IndexName }}'
          DocumentIdOptions: null
          S3Configuration: null
          BufferingHints:
            IntervalInSeconds: '{{ IntervalInSeconds }}'
            SizeInMBs: '{{ SizeInMBs }}'
          RetryOptions:
            DurationInSeconds: '{{ DurationInSeconds }}'
          VpcConfiguration: null
          CloudWatchLoggingOptions: null
      - name: SnowflakeDestinationConfiguration
        value:
          PrivateKey: '{{ PrivateKey }}'
          User: '{{ User }}'
          Table: '{{ Table }}'
          SnowflakeVpcConfiguration:
            PrivateLinkVpceId: '{{ PrivateLinkVpceId }}'
          DataLoadingOption: '{{ DataLoadingOption }}'
          Schema: '{{ Schema }}'
          ContentColumnName: '{{ ContentColumnName }}'
          SecretsManagerConfiguration: null
          SnowflakeRoleConfiguration:
            SnowflakeRole: '{{ SnowflakeRole }}'
            Enabled: '{{ Enabled }}'
          ProcessingConfiguration: null
          AccountUrl: '{{ AccountUrl }}'
          RoleARN: '{{ RoleARN }}'
          S3BackupMode: '{{ S3BackupMode }}'
          S3Configuration: null
          BufferingHints:
            IntervalInSeconds: '{{ IntervalInSeconds }}'
            SizeInMBs: '{{ SizeInMBs }}'
          MetaDataColumnName: '{{ MetaDataColumnName }}'
          Database: '{{ Database }}'
          RetryOptions:
            DurationInSeconds: '{{ DurationInSeconds }}'
          KeyPassphrase: '{{ KeyPassphrase }}'
          CloudWatchLoggingOptions: null
      - name: DatabaseSourceConfiguration
        value:
          Digest: '{{ Digest }}'
          Port: '{{ Port }}'
          PublicCertificate: '{{ PublicCertificate }}'
          Columns:
            Exclude:
              - '{{ Exclude[0] }}'
            Include:
              - null
          Type: '{{ Type }}'
          SurrogateKeys:
            - '{{ SurrogateKeys[0] }}'
          Databases:
            Exclude:
              - '{{ Exclude[0] }}'
            Include:
              - null
          Endpoint: '{{ Endpoint }}'
          SSLMode: '{{ SSLMode }}'
          SnapshotWatermarkTable: '{{ SnapshotWatermarkTable }}'
          DatabaseSourceAuthenticationConfiguration:
            SecretsManagerConfiguration: null
          Tables:
            Exclude:
              - null
            Include:
              - null
          DatabaseSourceVPCConfiguration:
            VpcEndpointServiceName: '{{ VpcEndpointServiceName }}'
      - name: S3DestinationConfiguration
        value: null
      - name: DeliveryStreamName
        value: '{{ DeliveryStreamName }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM awscc.kinesisfirehose.delivery_streams
WHERE data__Identifier = '<DeliveryStreamName>'
AND region = 'us-east-1';

Permissions

To operate on the delivery_streams resource, the following permissions are required:

Read

firehose:DescribeDeliveryStream,
firehose:ListTagsForDeliveryStream

Create

firehose:CreateDeliveryStream,
firehose:DescribeDeliveryStream,
iam:GetRole,
iam:PassRole,
kms:CreateGrant,
kms:DescribeKey,
firehose:TagDeliveryStream

Update

firehose:UpdateDestination,
firehose:DescribeDeliveryStream,
firehose:StartDeliveryStreamEncryption,
firehose:StopDeliveryStreamEncryption,
firehose:ListTagsForDeliveryStream,
firehose:TagDeliveryStream,
firehose:UntagDeliveryStream,
kms:CreateGrant,
kms:RevokeGrant,
kms:DescribeKey,
iam:PassRole

List

firehose:ListDeliveryStreams

Delete

firehose:DeleteDeliveryStream,
firehose:DescribeDeliveryStream,
kms:RevokeGrant,
kms:DescribeKey