@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-kendra-faq.d.ts

@@ -0,0 +1,80 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type KendraFaq = ResourceDefinitionWithAttributes<"AWS::Kendra::Faq", KendraFaqProps, KendraFaqAttribs>;
+/**
+ * Creates an new set of frequently asked question (FAQ) questions and answers.
+ */
+export type KendraFaqProps = {
+    /**
+     * A description for the FAQ.
+     */
+    Description?: string | undefined;
+    /**
+     * The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.
+     *
+     * The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.
+     *
+     * Valid values are:
+     *
+     * - `CSV`
+     * - `CSV_WITH_HEADER`
+     * - `JSON`
+     */
+    FileFormat?: FileFormat | undefined;
+    /**
+     * The identifier of the index that contains the FAQ.
+     */
+    IndexId: string;
+    /**
+     * The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) .
+     */
+    LanguageCode?: string | undefined;
+    /**
+     * The name that you assigned the FAQ when you created or updated the FAQ.
+     */
+    Name: string;
+    /**
+     * The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.
+     */
+    RoleArn: string;
+    /**
+     * The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
+     */
+    S3Path: S3Path;
+    /**
+     * An array of key-value pairs to apply to this resource
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     */
+    Tags?: Tag[] | undefined;
+};
+export type KendraFaqAttribs = {
+    /**
+     * `arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7`
+     * @maxLength 1000
+     */
+    Arn: string;
+    /**
+     * The identifier for the FAQ. For example:
+     *
+     * `f61995a6-cd5c-4e99-9cfc-58816d8bfaa7`
+     */
+    Id: string;
+};
+/**
+ * Format of the input file
+ */
+export type FileFormat = "CSV" | "CSV_WITH_HEADER" | "JSON";
+/**
+ * Information required to find a specific file in an Amazon S3 bucket.
+ */
+export type S3Path = {
+    /**
+     * The name of the S3 bucket that contains the file.
+     */
+    Bucket: string;
+    /**
+     * The name of the file.
+     */
+    Key: string;
+};
+//# sourceMappingURL=aws-kendra-faq.d.ts.map

package/out/exports/resources.generated/aws-kendra-index.d.ts

@@ -0,0 +1,255 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type KendraIndex = ResourceDefinitionWithAttributes<"AWS::Kendra::Index", KendraIndexProps, KendraIndexAttribs>;
+/**
+ * Creates an Amazon Kendra index
+ *
+ * Once the index is active you can add documents to your index using the [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/BatchPutDocument.html) operation or using one of the supported data sources.
+ */
+export type KendraIndexProps = {
+    /**
+     * Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.
+     */
+    CapacityUnits?: CapacityUnitsConfiguration | undefined;
+    /**
+     * A description for the index.
+     */
+    Description?: string | undefined;
+    /**
+     * Specifies the properties of an index field. You can add either a custom or a built-in field. You can add and remove built-in fields at any time. When a built-in field is removed it's configuration reverts to the default for the field. Custom fields can't be removed from an index after they are added.
+     */
+    DocumentMetadataConfigurations?: DocumentMetadataConfiguration[] | undefined;
+    /**
+     * Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
+     */
+    Edition: Edition;
+    /**
+     * The name of the index.
+     */
+    Name: string;
+    /**
+     * An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/BatchPutDocument.html) operation to index documents from an Amazon S3 bucket.
+     */
+    RoleArn: string;
+    /**
+     * The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
+     */
+    ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The user context policy.
+     *
+     * ATTRIBUTE_FILTER
+     *
+     * - All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of `_user_id` and `_group_ids` or you can provide user and group information in `UserContext` .
+     *
+     * USER_TOKEN
+     *
+     * - Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
+     */
+    UserContextPolicy?: UserContextPolicy | undefined;
+    /**
+     * Defines the type of user token used for the index.
+     */
+    UserTokenConfigurations?: UserTokenConfiguration[] | undefined;
+};
+export type KendraIndexAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the index. For example: `arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef` .
+     */
+    Arn: string;
+    /**
+     * The identifier for the index. For example: `f4aeaa10-8056-4b2c-a343-522ca0f41234` .
+     */
+    Id: string;
+};
+/**
+ * Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.
+ */
+export type CapacityUnitsConfiguration = {
+    /**
+     * The amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) capacity.
+     *
+     * A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.
+     *
+     * `GetQuerySuggestions` capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and `GetQuerySuggestions` capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the `GetQuerySuggestions` capacity is 2.5 calls per second (higher than five times 0.2 queries per second).
+     */
+    QueryCapacityUnits: number;
+    /**
+     * The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
+     */
+    StorageCapacityUnits: number;
+};
+export type DocumentAttributeValueType = "STRING_VALUE" | "STRING_LIST_VALUE" | "LONG_VALUE" | "DATE_VALUE";
+/**
+ * Specifies the properties, such as relevance tuning and searchability, of an index field.
+ */
+export type DocumentMetadataConfiguration = {
+    /**
+     * The name of the index field.
+     */
+    Name: string;
+    /**
+     * Provides tuning parameters to determine how the field affects the search results.
+     */
+    Relevance?: Relevance | undefined;
+    /**
+     * Provides information about how the field is used during a search.
+     */
+    Search?: Search | undefined;
+    /**
+     * The data type of the index field.
+     */
+    Type: DocumentAttributeValueType;
+};
+/**
+ * Edition of index
+ */
+export type Edition = "DEVELOPER_EDITION" | "ENTERPRISE_EDITION" | "GEN_AI_ENTERPRISE_EDITION";
+/**
+ * Provides the configuration information for the JSON token type.
+ */
+export type JsonTokenTypeConfiguration = {
+    /**
+     * The group attribute field.
+     */
+    GroupAttributeField: string;
+    /**
+     * The user name attribute field.
+     */
+    UserNameAttributeField: string;
+};
+/**
+ * Provides the configuration information for the JWT token type.
+ */
+export type JwtTokenTypeConfiguration = {
+    /**
+     * The regular expression that identifies the claim.
+     */
+    ClaimRegex?: string | undefined;
+    /**
+     * The group attribute field.
+     */
+    GroupAttributeField?: string | undefined;
+    /**
+     * The issuer of the token.
+     */
+    Issuer?: string | undefined;
+    /**
+     * The location of the key.
+     */
+    KeyLocation: KeyLocation;
+    /**
+     * The Amazon Resource Name (arn) of the secret.
+     */
+    SecretManagerArn?: string | undefined;
+    /**
+     * The signing key URL.
+     */
+    URL?: string | undefined;
+    /**
+     * The user name attribute field.
+     */
+    UserNameAttributeField?: string | undefined;
+};
+export type KeyLocation = "URL" | "SECRET_MANAGER";
+export type Order = "ASCENDING" | "DESCENDING";
+/**
+ * Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
+ */
+export type Relevance = {
+    /**
+     * Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.
+     *
+     * Only applies to `DATE` fields.
+     */
+    Duration?: string | undefined;
+    /**
+     * Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. Only applies to `DATE` fields.
+     */
+    Freshness?: boolean | undefined;
+    /**
+     * The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
+     */
+    Importance?: number | undefined;
+    /**
+     * Determines how values should be interpreted.
+     *
+     * When the `RankOrder` field is `ASCENDING` , higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.
+     *
+     * When the `RankOrder` field is `DESCENDING` , lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.
+     *
+     * Only applies to `LONG` fields.
+     */
+    RankOrder?: Order | undefined;
+    /**
+     * An array of key-value pairs for different boosts when they appear in the search result list. For example, if you want to boost query terms that match the "department" field in the result, query terms that match this field are boosted in the result. You can add entries from the department field to boost documents with those values higher.
+     *
+     * For example, you can add entries to the map with names of departments. If you add "HR", 5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document.
+     */
+    ValueImportanceItems?: ValueImportanceItem[] | undefined;
+};
+/**
+ * Provides information about how a custom index field is used during a search.
+ */
+export type Search = {
+    /**
+     * Determines whether the field is returned in the query response. The default is `true` .
+     */
+    Displayable?: boolean | undefined;
+    /**
+     * Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is `false` .
+     */
+    Facetable?: boolean | undefined;
+    /**
+     * Determines whether the field is used in the search. If the `Searchable` field is `true` , you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is `true` for string fields and `false` for number and date fields.
+     */
+    Searchable?: boolean | undefined;
+    /**
+     * Determines whether the field can be used to sort the results of a query. The default is `false` .
+     */
+    Sortable?: boolean | undefined;
+};
+/**
+ * Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra. We suggest that you use a CMK from your account to help secure your index. Amazon Kendra doesn't support asymmetric CMKs.
+ */
+export type ServerSideEncryptionConfiguration = {
+    /**
+     * The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
+     */
+    KmsKeyId?: string | undefined;
+};
+export type UserContextPolicy = "ATTRIBUTE_FILTER" | "USER_TOKEN";
+/**
+ * Provides the configuration information for a token.
+ *
+ * > If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use `UserTokenConfigurations` to configure user context policy, Amazon Kendra returns a `ValidationException` error.
+ */
+export type UserTokenConfiguration = {
+    /**
+     * Information about the JSON token type configuration.
+     */
+    JsonTokenTypeConfiguration?: JsonTokenTypeConfiguration | undefined;
+    /**
+     * Information about the JWT token type configuration.
+     */
+    JwtTokenTypeConfiguration?: JwtTokenTypeConfiguration | undefined;
+};
+/**
+ * Specifies a key-value pair of the search boost value for a document when the key is part of the metadata of a document.
+ */
+export type ValueImportanceItem = {
+    /**
+     * The document metadata value used for the search boost.
+     */
+    Key?: string | undefined;
+    /**
+     * The boost value for a document when the key is part of the metadata of a document.
+     */
+    Value?: number | undefined;
+};
+//# sourceMappingURL=aws-kendra-index.d.ts.map

package/out/exports/resources.generated/aws-kendraranking-executionplan.d.ts

@@ -0,0 +1,47 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type KendraRankingExecutionPlan = ResourceDefinitionWithAttributes<"AWS::KendraRanking::ExecutionPlan", KendraRankingExecutionPlanProps, KendraRankingExecutionPlanAttribs>;
+/**
+ * Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.
+ *
+ * For an example of using the `CreateRescoreExecutionPlan` API, including using the Python and Java SDKs, see [Semantically ranking a search service's results](https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.html) .
+ */
+export type KendraRankingExecutionPlanProps = {
+    /**
+     * You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see [Adjusting capacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html) .
+     */
+    CapacityUnits?: CapacityUnitsConfiguration | undefined;
+    /**
+     * A description for the rescore execution plan.
+     */
+    Description?: string | undefined;
+    /**
+     * A name for the rescore execution plan.
+     */
+    Name: string;
+    /**
+     * A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white space. They can also consist of underscore, period, colon, equal, plus, and asperand.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type KendraRankingExecutionPlanAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the rescore execution plan.
+     */
+    Arn: string;
+    /**
+     * The identifier of the rescore execution plan.
+     */
+    Id: string;
+};
+/**
+ * Sets additional capacity units configured for your rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API. You can add and remove capacity units to fit your usage requirements.
+ */
+export type CapacityUnitsConfiguration = {
+    /**
+     * The amount of extra capacity for your rescore execution plan.
+     *
+     * A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.
+     */
+    RescoreCapacityUnits: number;
+};
+//# sourceMappingURL=aws-kendraranking-executionplan.d.ts.map

package/out/exports/resources.generated/aws-kinesis-resourcepolicy.d.ts

@@ -0,0 +1,27 @@
+import type { ResourceDefinition, TemplatePolicyDocument } from "../main.ts";
+export type KinesisResourcePolicy = ResourceDefinition<"AWS::Kinesis::ResourcePolicy", KinesisResourcePolicyProps>;
+/**
+ * Attaches a resource-based policy to a data stream or registered consumer. If you are using an identity other than the root user of the AWS account that owns the resource, the calling identity must have the `PutResourcePolicy` permissions on the specified Kinesis Data Streams resource and belong to the owner's account in order to use this operation. If you don't have `PutResourcePolicy` permissions, Amazon Kinesis Data Streams returns a `403 Access Denied error` . If you receive a `ResourceNotFoundException` , check to see if you passed a valid stream or consumer resource.
+ *
+ * Request patterns can be one of the following:
+ *
+ * - Data stream pattern: `arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+`
+ * - Consumer pattern: `^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+`
+ *
+ * For more information, see [Controlling Access to Amazon Kinesis Data Streams Resources Using IAM](https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html) .
+ */
+export type KinesisResourcePolicyProps = {
+    /**
+     * This is the name for the resource policy.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern arn:aws.*:kinesis:.*:\d{12}:stream/\S+
+     */
+    ResourceArn: string;
+    /**
+     * This is the description for the resource policy.
+     * @policy
+     */
+    ResourcePolicy: TemplatePolicyDocument;
+};
+//# sourceMappingURL=aws-kinesis-resourcepolicy.d.ts.map

package/out/exports/resources.generated/aws-kinesis-stream.d.ts

@@ -0,0 +1,92 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type KinesisStream = ResourceDefinitionWithAttributes<"AWS::Kinesis::Stream", KinesisStreamProps, KinesisStreamAttribs>;
+/**
+ * Creates a Kinesis stream that captures and transports data records that are emitted from data sources. For information about creating streams, see [CreateStream](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html) in the Amazon Kinesis API Reference.
+ */
+export type KinesisStreamProps = {
+    /**
+     * A list of shard-level metrics in properties to enable enhanced monitoring mode.
+     */
+    DesiredShardLevelMetrics?: EnhancedMetric[] | undefined;
+    /**
+     * The name of the Kinesis stream. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the stream name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
+     *
+     * If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-zA-Z0-9_.-]+$
+     */
+    Name?: string | undefined;
+    /**
+     * The number of hours for the data records that are stored in shards to remain accessible. The default value is 24. For more information about the stream retention period, see [Changing the Data Retention Period](https://docs.aws.amazon.com/streams/latest/dev/kinesis-extended-retention.html) in the Amazon Kinesis Developer Guide.
+     * @min 24
+     */
+    RetentionPeriodHours?: number | undefined;
+    /**
+     * The number of shards that the stream uses. For greater provisioned throughput, increase the number of shards.
+     * @min 1
+     */
+    ShardCount?: number | undefined;
+    /**
+     * When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.
+     */
+    StreamEncryption?: StreamEncryption | undefined;
+    /**
+     * Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an *on-demand* capacity mode and a *provisioned* capacity mode for your data streams.
+     * @default {"StreamMode":"PROVISIONED"}
+     */
+    StreamModeDetails?: StreamModeDetails | undefined;
+    /**
+     * An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream. For information about constraints for this property, see [Tag Restrictions](https://docs.aws.amazon.com/streams/latest/dev/tagging.html#tagging-restrictions) in the *Amazon Kinesis Developer Guide* .
+     */
+    Tags?: Tag[] | undefined;
+};
+export type KinesisStreamAttribs = {
+    /**
+     * The Amazon resource name (ARN) of the Kinesis stream, such as `arn:aws:kinesis:us-east-2:123456789012:stream/mystream` .
+     */
+    Arn: string;
+};
+/**
+ * Value of an enhanced metric
+ */
+export type EnhancedMetric = "IncomingBytes" | "IncomingRecords" | "OutgoingBytes" | "OutgoingRecords" | "WriteProvisionedThroughputExceeded" | "ReadProvisionedThroughputExceeded" | "IteratorAgeMilliseconds" | "ALL";
+/**
+ * Enables or updates server-side encryption using an AWS KMS key for a specified stream.
+ *
+ * > When invoking this API, you must use either the `StreamARN` or the `StreamName` parameter, or both. It is recommended that you use the `StreamARN` input parameter when you invoke this API.
+ *
+ * Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to `UPDATING` . After the update is complete, Kinesis Data Streams sets the status of the stream back to `ACTIVE` . Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is `UPDATING` . Once the status of the stream is `ACTIVE` , encryption begins for records written to the stream.
+ *
+ * API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.
+ *
+ * Note: It can take up to 5 seconds after the stream is in an `ACTIVE` status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from `PutRecord` or `PutRecords` .
+ */
+export type StreamEncryption = {
+    /**
+     * The encryption type to use. The only valid value is `KMS` .
+     */
+    EncryptionType: "KMS";
+    /**
+     * The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias `aws/kinesis` .
+     *
+     * - Key ARN example: `arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012`
+     * - Alias ARN example: `arn:aws:kms:us-east-1:123456789012:alias/MyAliasName`
+     * - Globally unique key ID example: `12345678-1234-1234-1234-123456789012`
+     * - Alias name example: `alias/MyAliasName`
+     * - Master key owned by Kinesis Data Streams: `alias/aws/kinesis`
+     * @minLength 1
+     * @maxLength 2048
+     */
+    KeyId: string;
+};
+/**
+ * Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an *on-demand* capacity mode and a *provisioned* capacity mode for your data streams.
+ */
+export type StreamModeDetails = {
+    /**
+     * Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an *on-demand* capacity mode and a *provisioned* capacity mode for your data streams.
+     */
+    StreamMode: "ON_DEMAND" | "PROVISIONED";
+};
+//# sourceMappingURL=aws-kinesis-stream.d.ts.map

package/out/exports/resources.generated/aws-kinesis-streamconsumer.d.ts

@@ -0,0 +1,45 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type KinesisStreamConsumer = ResourceDefinitionWithAttributes<"AWS::Kinesis::StreamConsumer", KinesisStreamConsumerProps, KinesisStreamConsumerAttribs>;
+/**
+ * Use the AWS CloudFormation `AWS::Kinesis::StreamConsumer` resource to register a consumer with a Kinesis data stream. The consumer you register can then call [SubscribeToShard](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_SubscribeToShard.html) to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
+ *
+ * You can register up to 20 consumers per stream. However, you can request a limit increase using the [Kinesis Data Streams limits form](https://docs.aws.amazon.com/support/v1?#/) . A given consumer can only be registered with one stream at a time.
+ *
+ * For more information, see [Using Consumers with Enhanced Fan-Out](https://docs.aws.amazon.com/streams/latest/dev/introduction-to-enhanced-consumers.html) .
+ */
+export type KinesisStreamConsumerProps = {
+    /**
+     * The name of the consumer is something you choose when you register the consumer.
+     */
+    ConsumerName: string;
+    /**
+     * The ARN of the stream with which you registered the consumer.
+     */
+    StreamARN: string;
+};
+export type KinesisStreamConsumerAttribs = {
+    /**
+     * When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call [SubscribeToShard](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_SubscribeToShard.html) .
+     *
+     * If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
+     */
+    ConsumerARN: string;
+    /**
+     * The time at which the consumer was created.
+     */
+    ConsumerCreationTimestamp: string;
+    /**
+     * The name you gave the consumer when you registered it.
+     */
+    ConsumerName: string;
+    /**
+     * A consumer can't read data while in the `CREATING` or `DELETING` states.
+     */
+    ConsumerStatus: string;
+    Id: string;
+    /**
+     * The ARN of the data stream with which the consumer is registered.
+     */
+    StreamARN: string;
+};
+//# sourceMappingURL=aws-kinesis-streamconsumer.d.ts.map