@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-kinesisanalytics-application.d.ts

@@ -0,0 +1,225 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type KinesisAnalyticsApplication = ResourceDefinitionWithAttributes<"AWS::KinesisAnalytics::Application", KinesisAnalyticsApplicationProps, KinesisAnalyticsApplicationAttribs>;
+/**
+ * The `AWS::KinesisAnalytics::Application` resource creates an Amazon Kinesis Data Analytics application. For more information, see the [Amazon Kinesis Data Analytics Developer Guide](https://docs.aws.amazon.com//kinesisanalytics/latest/dev/what-is.html) .
+ */
+export type KinesisAnalyticsApplicationProps = {
+    /**
+     * One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see [Application Code](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html) .
+     *
+     * You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.
+     *
+     * Note that the application code must create the streams with names specified in the `Outputs` . For example, if your `Outputs` defines output streams named `ExampleOutputStream1` and `ExampleOutputStream2` , then your application code must create these streams.
+     */
+    ApplicationCode?: string | undefined;
+    /**
+     * Summary description of the application.
+     */
+    ApplicationDescription?: string | undefined;
+    /**
+     * Name of your Amazon Kinesis Analytics application (for example, `sample-app` ).
+     */
+    ApplicationName?: string | undefined;
+    /**
+     * Use this parameter to configure the application input.
+     *
+     * You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).
+     *
+     * For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.
+     *
+     * To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.
+     */
+    Inputs: Input[];
+};
+export type KinesisAnalyticsApplicationAttribs = {
+    Id: string;
+};
+/**
+ * Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'\n'* as the row delimiter and a comma (",") as the column delimiter:
+ *
+ * `"name1", "address1"`
+ *
+ * `"name2", "address2"`
+ */
+export type CSVMappingParameters = {
+    /**
+     * Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
+     */
+    RecordColumnDelimiter: string;
+    /**
+     * Row delimiter. For example, in a CSV format, *'\n'* is the typical row delimiter.
+     */
+    RecordRowDelimiter: string;
+};
+/**
+ * When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) .
+ */
+export type Input = {
+    /**
+     * Describes the number of in-application streams to create.
+     *
+     * Data from your source is routed to these in-application input streams.
+     *
+     * See [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) .
+     */
+    InputParallelism?: InputParallelism | undefined;
+    /**
+     * The [InputProcessingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html) for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is [InputLambdaProcessor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html) .
+     */
+    InputProcessingConfiguration?: InputProcessingConfiguration | undefined;
+    /**
+     * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
+     *
+     * Also used to describe the format of the reference data source.
+     */
+    InputSchema: InputSchema;
+    /**
+     * If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
+     *
+     * Note: Either `KinesisStreamsInput` or `KinesisFirehoseInput` is required.
+     */
+    KinesisFirehoseInput?: KinesisFirehoseInput | undefined;
+    /**
+     * If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
+     *
+     * Note: Either `KinesisStreamsInput` or `KinesisFirehoseInput` is required.
+     */
+    KinesisStreamsInput?: KinesisStreamsInput | undefined;
+    /**
+     * Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the `InputParallelism` count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.
+     */
+    NamePrefix: string;
+};
+/**
+ * An object that contains the Amazon Resource Name (ARN) of the [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function.
+ */
+export type InputLambdaProcessor = {
+    /**
+     * The ARN of the [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that operates on records in the stream.
+     *
+     * > To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see [Example ARNs: AWS Lambda](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda)
+     */
+    ResourceARN: string;
+    /**
+     * The ARN of the IAM role that is used to access the AWS Lambda function.
+     */
+    RoleARN: string;
+};
+/**
+ * Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) .
+ */
+export type InputParallelism = {
+    /**
+     * Number of in-application streams to create. For more information, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html) .
+     */
+    Count?: number | undefined;
+};
+/**
+ * Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is [AWS Lambda](https://docs.aws.amazon.com/lambda/) .
+ */
+export type InputProcessingConfiguration = {
+    /**
+     * The [InputLambdaProcessor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html) that is used to preprocess the records in the stream before being processed by your application code.
+     */
+    InputLambdaProcessor?: InputLambdaProcessor | undefined;
+};
+/**
+ * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
+ *
+ * Also used to describe the format of the reference data source.
+ */
+export type InputSchema = {
+    /**
+     * A list of `RecordColumn` objects.
+     */
+    RecordColumns: RecordColumn[];
+    /**
+     * Specifies the encoding of the records in the streaming source. For example, UTF-8.
+     */
+    RecordEncoding?: string | undefined;
+    /**
+     * Specifies the format of the records on the streaming source.
+     */
+    RecordFormat: RecordFormat;
+};
+/**
+ * Provides additional mapping information when JSON is the record format on the streaming source.
+ */
+export type JSONMappingParameters = {
+    /**
+     * Path to the top-level parent that contains the records.
+     */
+    RecordRowPath: string;
+};
+/**
+ * Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.
+ */
+export type KinesisFirehoseInput = {
+    /**
+     * ARN of the input delivery stream.
+     */
+    ResourceARN: string;
+    /**
+     * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream.
+     */
+    RoleARN: string;
+};
+/**
+ * Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.
+ */
+export type KinesisStreamsInput = {
+    /**
+     * ARN of the input Amazon Kinesis stream to read.
+     */
+    ResourceARN: string;
+    /**
+     * ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.
+     */
+    RoleARN: string;
+};
+/**
+ * When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
+ */
+export type MappingParameters = {
+    /**
+     * Provides additional mapping information when the record format uses delimiters (for example, CSV).
+     */
+    CSVMappingParameters?: CSVMappingParameters | undefined;
+    /**
+     * Provides additional mapping information when JSON is the record format on the streaming source.
+     */
+    JSONMappingParameters?: JSONMappingParameters | undefined;
+};
+/**
+ * Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
+ *
+ * Also used to describe the format of the reference data source.
+ */
+export type RecordColumn = {
+    /**
+     * Reference to the data element in the streaming input or the reference data source. This element is required if the [RecordFormatType](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) is `JSON` .
+     */
+    Mapping?: string | undefined;
+    /**
+     * Name of the column created in the in-application input stream or reference table.
+     */
+    Name: string;
+    /**
+     * Type of column created in the in-application input stream or reference table.
+     */
+    SqlType: string;
+};
+/**
+ * Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
+ */
+export type RecordFormat = {
+    /**
+     * When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
+     */
+    MappingParameters?: MappingParameters | undefined;
+    /**
+     * The type of record format.
+     */
+    RecordFormatType: string;
+};
+//# sourceMappingURL=aws-kinesisanalytics-application.d.ts.map

package/out/exports/resources.generated/aws-kinesisanalytics-applicationoutput.d.ts

@@ -0,0 +1,106 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type KinesisAnalyticsApplicationOutput = ResourceDefinitionWithAttributes<"AWS::KinesisAnalytics::ApplicationOutput", KinesisAnalyticsApplicationOutputProps, KinesisAnalyticsApplicationOutputAttribs>;
+/**
+ * Adds an external destination to your Amazon Kinesis Analytics application.
+ *
+ * If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.
+ *
+ * You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see [Understanding Application Output (Destination)](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html) .
+ *
+ * Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the `DescribeApplication` operation to find the current application version.
+ *
+ * For the limits on the number of application inputs and outputs you can configure, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html) .
+ *
+ * This operation requires permissions to perform the `kinesisanalytics:AddApplicationOutput` action.
+ */
+export type KinesisAnalyticsApplicationOutputProps = {
+    /**
+     * Name of the application to which you want to add the output configuration.
+     */
+    ApplicationName: string;
+    /**
+     * An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.
+     */
+    Output: Output;
+};
+export type KinesisAnalyticsApplicationOutputAttribs = {
+    Id: string;
+};
+/**
+ * Describes the data format when records are written to the destination. For more information, see [Configuring Application Output](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html) .
+ */
+export type DestinationSchema = {
+    /**
+     * Specifies the format of the records on the output stream.
+     */
+    RecordFormatType?: string | undefined;
+};
+/**
+ * When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf.
+ */
+export type KinesisFirehoseOutput = {
+    /**
+     * ARN of the destination Amazon Kinesis Firehose delivery stream to write to.
+     */
+    ResourceARN: string;
+    /**
+     * ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.
+     */
+    RoleARN: string;
+};
+/**
+ * When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.
+ */
+export type KinesisStreamsOutput = {
+    /**
+     * ARN of the destination Amazon Kinesis stream to write to.
+     */
+    ResourceARN: string;
+    /**
+     * ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.
+     */
+    RoleARN: string;
+};
+/**
+ * When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf.
+ */
+export type LambdaOutput = {
+    /**
+     * Amazon Resource Name (ARN) of the destination Lambda function to write to.
+     *
+     * > To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see [Example ARNs: AWS Lambda](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda)
+     */
+    ResourceARN: string;
+    /**
+     * ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.
+     */
+    RoleARN: string;
+};
+/**
+ * Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.
+ *
+ * For limits on how many destinations an application can write and other limitations, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html) .
+ */
+export type Output = {
+    /**
+     * Describes the data format when records are written to the destination. For more information, see [Configuring Application Output](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html) .
+     */
+    DestinationSchema: DestinationSchema;
+    /**
+     * Identifies an Amazon Kinesis Firehose delivery stream as the destination.
+     */
+    KinesisFirehoseOutput?: KinesisFirehoseOutput | undefined;
+    /**
+     * Identifies an Amazon Kinesis stream as the destination.
+     */
+    KinesisStreamsOutput?: KinesisStreamsOutput | undefined;
+    /**
+     * Identifies an AWS Lambda function as the destination.
+     */
+    LambdaOutput?: LambdaOutput | undefined;
+    /**
+     * Name of the in-application stream.
+     */
+    Name?: string | undefined;
+};
+//# sourceMappingURL=aws-kinesisanalytics-applicationoutput.d.ts.map

package/out/exports/resources.generated/aws-kinesisanalytics-applicationreferencedatasource.d.ts

@@ -0,0 +1,149 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type KinesisAnalyticsApplicationReferenceDataSource = ResourceDefinitionWithAttributes<"AWS::KinesisAnalytics::ApplicationReferenceDataSource", KinesisAnalyticsApplicationReferenceDataSourceProps, KinesisAnalyticsApplicationReferenceDataSourceAttribs>;
+/**
+ * Adds a reference data source to an existing application.
+ *
+ * Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.
+ *
+ * For conceptual information, see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) . For the limits on data sources you can add to your application, see [Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html) .
+ *
+ * This operation requires permissions to perform the `kinesisanalytics:AddApplicationOutput` action.
+ */
+export type KinesisAnalyticsApplicationReferenceDataSourceProps = {
+    /**
+     * Name of an existing application.
+     */
+    ApplicationName: string;
+    /**
+     * The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.
+     */
+    ReferenceDataSource: ReferenceDataSource;
+};
+export type KinesisAnalyticsApplicationReferenceDataSourceAttribs = {
+    Id: string;
+};
+/**
+ * Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the *'\n'* as the row delimiter and a comma (",") as the column delimiter:
+ *
+ * `"name1", "address1"`
+ *
+ * `"name2", "address2"`
+ */
+export type CSVMappingParameters = {
+    /**
+     * Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
+     */
+    RecordColumnDelimiter: string;
+    /**
+     * Row delimiter. For example, in a CSV format, *'\n'* is the typical row delimiter.
+     */
+    RecordRowDelimiter: string;
+};
+/**
+ * Provides additional mapping information when JSON is the record format on the streaming source.
+ */
+export type JSONMappingParameters = {
+    /**
+     * Path to the top-level parent that contains the records.
+     */
+    RecordRowPath: string;
+};
+/**
+ * When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
+ */
+export type MappingParameters = {
+    /**
+     * Provides additional mapping information when the record format uses delimiters (for example, CSV).
+     */
+    CSVMappingParameters?: CSVMappingParameters | undefined;
+    /**
+     * Provides additional mapping information when JSON is the record format on the streaming source.
+     */
+    JSONMappingParameters?: JSONMappingParameters | undefined;
+};
+/**
+ * Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
+ *
+ * Also used to describe the format of the reference data source.
+ */
+export type RecordColumn = {
+    /**
+     * Reference to the data element in the streaming input or the reference data source. This element is required if the [RecordFormatType](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) is `JSON` .
+     */
+    Mapping?: string | undefined;
+    /**
+     * Name of the column created in the in-application input stream or reference table.
+     */
+    Name: string;
+    /**
+     * Type of column created in the in-application input stream or reference table.
+     */
+    SqlType: string;
+};
+/**
+ * Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
+ */
+export type RecordFormat = {
+    /**
+     * When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
+     */
+    MappingParameters?: MappingParameters | undefined;
+    /**
+     * The type of record format.
+     */
+    RecordFormatType: string;
+};
+/**
+ * Describes the reference data source by providing the source information (S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.
+ */
+export type ReferenceDataSource = {
+    /**
+     * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
+     */
+    ReferenceSchema: ReferenceSchema;
+    /**
+     * Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the `UpdateApplication` operation to trigger reloading of data into your application.
+     */
+    S3ReferenceDataSource?: S3ReferenceDataSource | undefined;
+    /**
+     * Name of the in-application table to create.
+     */
+    TableName?: string | undefined;
+};
+/**
+ * The ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application.
+ */
+export type ReferenceSchema = {
+    /**
+     * A list of RecordColumn objects.
+     */
+    RecordColumns: RecordColumn[];
+    /**
+     * Specifies the encoding of the records in the reference source. For example, UTF-8.
+     */
+    RecordEncoding?: string | undefined;
+    /**
+     * Specifies the format of the records on the reference source.
+     */
+    RecordFormat: RecordFormat;
+};
+/**
+ * Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.
+ *
+ * An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the [UpdateApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation to trigger reloading of data into your application.
+ */
+export type S3ReferenceDataSource = {
+    /**
+     * Amazon Resource Name (ARN) of the S3 bucket.
+     */
+    BucketARN: string;
+    /**
+     * Object key name containing reference data.
+     */
+    FileKey: string;
+    /**
+     * ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the `s3:GetObject` action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.
+     */
+    ReferenceRoleARN: string;
+};
+//# sourceMappingURL=aws-kinesisanalytics-applicationreferencedatasource.d.ts.map