Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.SchemaConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDeliveryStream.SchemaConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnDeliveryStream
@Stability(Stable) public static interface CfnDeliveryStream.SchemaConfigurationProperty extends software.amazon.jsii.JsiiSerializable
Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.

This parameter is required if Enabled is set to true.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 SchemaConfigurationProperty schemaConfigurationProperty = SchemaConfigurationProperty.builder()
         .catalogId("catalogId")
         .databaseName("databaseName")
         .region("region")
         .roleArn("roleArn")
         .tableName("tableName")
         .versionId("versionId")
         .build();

  • Method Details

    • getCatalogId

      @Stability(Stable) @Nullable default String getCatalogId()
      The ID of the AWS Glue Data Catalog.

      If you don't supply this, the AWS account ID is used by default.

    • getDatabaseName

      @Stability(Stable) @Nullable default String getDatabaseName()
      Specifies the name of the AWS Glue database that contains the schema for the output data.

      If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

    • getRegion

      @Stability(Stable) @Nullable default String getRegion()
      If you don't specify an AWS Region, the default is the current Region.

    • getRoleArn

      @Stability(Stable) @Nullable default String getRoleArn()
      The role that Kinesis Data Firehose can use to access AWS Glue.

      This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

      If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

    • getTableName

      @Stability(Stable) @Nullable default String getTableName()
      Specifies the AWS Glue table that contains the column information that constitutes your data schema.

      If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

    • getVersionId

      @Stability(Stable) @Nullable default String getVersionId()
      Specifies the table version for the output data schema.

      If you don't specify this version ID, or if you set it to LATEST , Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

    • builder

      @Stability(Stable) static CfnDeliveryStream.SchemaConfigurationProperty.Builder builder()
      Returns:
      a CfnDeliveryStream.SchemaConfigurationProperty.Builder of CfnDeliveryStream.SchemaConfigurationProperty