@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-qbusiness-webexperience.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates an Amazon Q Business web experience.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html}
+ */
 export type QBusinessWebExperience = ResourceDefinitionWithAttributes<"AWS::QBusiness::WebExperience", QBusinessWebExperienceProps, QBusinessWebExperienceAttribs>;
 /**
  * Creates an Amazon Q Business web experience.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html}
  */
 export type QBusinessWebExperienceProps = {
     /**
@@ -9,24 +14,29 @@ export type QBusinessWebExperienceProps = {
      * @minLength 36
      * @maxLength 36
      * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-applicationid}
      */
     ApplicationId: string;
     /**
      * The container for browser extension configuration for an Amazon Q Business web experience.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-browserextensionconfiguration}
      */
     BrowserExtensionConfiguration?: BrowserExtensionConfiguration | undefined;
     /**
      * Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-customizationconfiguration}
      */
     CustomizationConfiguration?: CustomizationConfiguration | undefined;
     /**
      * Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-identityproviderconfiguration}
      */
     IdentityProviderConfiguration?: IdentityProviderConfiguration | undefined;
     /**
      * Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The *domain origin* refers to the base URL for accessing a website including the protocol ( `http/https` ), the domain name, and the port number (if specified).
      *
      * > You must only submit a *base URL* and not a full path. For example, `https://docs.aws.amazon.com` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-origins}
      */
     Origins?: string[] | undefined;
     /**
@@ -36,10 +46,12 @@ export type QBusinessWebExperienceProps = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-rolearn}
      */
     RoleArn?: string | undefined;
     /**
      * Determines whether sample prompts are enabled in the web experience for an end user.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-samplepromptscontrolmode}
      */
     SamplePromptsControlMode?: WebExperienceSamplePromptsControlMode | undefined;
     /**
@@ -47,10 +59,12 @@ export type QBusinessWebExperienceProps = {
      * @minLength 0
      * @maxLength 500
      * @pattern ^[\s\S]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-subtitle}
      */
     Subtitle?: string | undefined;
     /**
      * A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-tags}
      */
     Tags?: Tag[] | undefined;
     /**
@@ -58,19 +72,25 @@ export type QBusinessWebExperienceProps = {
      * @minLength 0
      * @maxLength 500
      * @pattern ^[\s\S]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-title}
      */
     Title?: string | undefined;
     /**
      * A message in an Amazon Q Business web experience.
      * @minLength 0
      * @maxLength 300
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-welcomemessage}
      */
     WelcomeMessage?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#aws-resource-qbusiness-webexperience-return-values}
+ */
 export type QBusinessWebExperienceAttribs = {
     /**
      * The Unix timestamp when the Amazon Q Business application was last updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-createdat}
      */
     CreatedAt: string;
     /**
@@ -78,15 +98,18 @@ export type QBusinessWebExperienceAttribs = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^(https?|ftp|file)://([^\s]*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-defaultendpoint}
      */
     DefaultEndpoint: string;
     /**
      * The status of your Amazon Q Business web experience.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-status}
      */
     Status: WebExperienceStatus;
     /**
      * The Unix timestamp when your Amazon Q Business web experience was updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-updatedat}
      */
     UpdatedAt: string;
     /**
@@ -94,6 +117,7 @@ export type QBusinessWebExperienceAttribs = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-webexperiencearn}
      */
     WebExperienceArn: string;
     /**
@@ -101,12 +125,17 @@ export type QBusinessWebExperienceAttribs = {
      * @minLength 36
      * @maxLength 36
      * @pattern ^[a-zA-Z0-9][a-zA-Z0-9-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-webexperienceid}
      */
     WebExperienceId: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-browserextension.html}
+ */
 export type BrowserExtension = "FIREFOX" | "CHROME";
 /**
  * The container for browser extension configuration for an Amazon Q Business web experience.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-browserextensionconfiguration.html}
  */
 export type BrowserExtensionConfiguration = {
     /**
@@ -115,11 +144,13 @@ export type BrowserExtensionConfiguration = {
      * - `CHROME` — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).
      * - `FIREFOX` — Enables the extension for Mozilla Firefox.
      * - `CHROME` and `FIREFOX` — Enable the extension for Chromium-based browsers and Mozilla Firefox.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-browserextensionconfiguration.html#cfn-qbusiness-webexperience-browserextensionconfiguration-enabledbrowserextensions}
      */
     EnabledBrowserExtensions: BrowserExtension[];
 };
 /**
  * Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html}
  */
 export type CustomizationConfiguration = {
     /**
@@ -127,6 +158,7 @@ export type CustomizationConfiguration = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^(https?://[a-zA-Z0-9-_.+%/]+\.css)?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html#cfn-qbusiness-webexperience-customizationconfiguration-customcssurl}
      */
     CustomCSSUrl?: string | undefined;
     /**
@@ -134,6 +166,7 @@ export type CustomizationConfiguration = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^(https?://[a-zA-Z0-9-_.+%/]+\.(svg|ico))?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html#cfn-qbusiness-webexperience-customizationconfiguration-faviconurl}
      */
     FaviconUrl?: string | undefined;
     /**
@@ -141,6 +174,7 @@ export type CustomizationConfiguration = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^(https?://[a-zA-Z0-9-_.+%/]+\.(ttf|woff|woff2|otf))?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html#cfn-qbusiness-webexperience-customizationconfiguration-fonturl}
      */
     FontUrl?: string | undefined;
     /**
@@ -148,11 +182,13 @@ export type CustomizationConfiguration = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^(https?://[a-zA-Z0-9-_.+%/]+\.(svg|png))?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html#cfn-qbusiness-webexperience-customizationconfiguration-logourl}
      */
     LogoUrl?: string | undefined;
 };
 /**
  * Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-identityproviderconfiguration.html}
  */
 export type IdentityProviderConfiguration = {
     SamlConfiguration: SamlProviderConfiguration;
@@ -161,6 +197,7 @@ export type IdentityProviderConfiguration = {
 };
 /**
  * Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.html}
  */
 export type OpenIDConnectProviderConfiguration = {
     /**
@@ -168,6 +205,7 @@ export type OpenIDConnectProviderConfiguration = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.html#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsarn}
      */
     SecretsArn: string;
     /**
@@ -175,11 +213,13 @@ export type OpenIDConnectProviderConfiguration = {
      * @minLength 0
      * @maxLength 1284
      * @pattern ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.html#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsrole}
      */
     SecretsRole: string;
 };
 /**
  * Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-samlproviderconfiguration.html}
  */
 export type SamlProviderConfiguration = {
     /**
@@ -187,9 +227,16 @@ export type SamlProviderConfiguration = {
      * @minLength 1
      * @maxLength 1284
      * @pattern ^https://.*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-samlproviderconfiguration.html#cfn-qbusiness-webexperience-samlproviderconfiguration-authenticationurl}
      */
     AuthenticationUrl: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-webexperiencesamplepromptscontrolmode.html}
+ */
 export type WebExperienceSamplePromptsControlMode = "ENABLED" | "DISABLED";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-webexperiencestatus.html}
+ */
 export type WebExperienceStatus = "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "PENDING_AUTH_CONFIG";
 //# sourceMappingURL=aws-qbusiness-webexperience.d.ts.map

package/out/exports/resources.generated/aws-qldb-ledger.d.ts

@@ -1,15 +1,23 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::QLDB::Ledger` resource specifies a new Amazon Quantum Ledger Database (Amazon QLDB) ledger in your AWS account . Amazon QLDB is a fully managed ledger database that provides a transparent, immutable, and cryptographically verifiable transaction log owned by a central trusted authority. You can use QLDB to track all application data changes, and maintain a complete and verifiable history of changes over time.
+ *
+ * For more information, see [CreateLedger](https://docs.aws.amazon.com/qldb/latest/developerguide/API_CreateLedger.html) in the *Amazon QLDB API Reference* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html}
+ */
 export type QLDBLedger = ResourceDefinitionWithAttributes<"AWS::QLDB::Ledger", QLDBLedgerProps, QLDBLedgerAttribs>;
 /**
  * The `AWS::QLDB::Ledger` resource specifies a new Amazon Quantum Ledger Database (Amazon QLDB) ledger in your AWS account . Amazon QLDB is a fully managed ledger database that provides a transparent, immutable, and cryptographically verifiable transaction log owned by a central trusted authority. You can use QLDB to track all application data changes, and maintain a complete and verifiable history of changes over time.
  *
  * For more information, see [CreateLedger](https://docs.aws.amazon.com/qldb/latest/developerguide/API_CreateLedger.html) in the *Amazon QLDB API Reference* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html}
  */
 export type QLDBLedgerProps = {
     /**
      * Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled ( `true` ) by default.
      *
      * If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the `UpdateLedger` operation to set this parameter to `false` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-deletionprotection}
      */
     DeletionProtection?: boolean | undefined;
     /**
@@ -33,12 +41,14 @@ export type QLDBLedgerProps = {
      * - Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
      *
      * For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) in the *AWS Key Management Service Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-kmskey}
      */
     KmsKey?: string | undefined;
     /**
      * The name of the ledger that you want to create. The name must be unique among all of the ledgers in your AWS account in the current Region.
      *
      * Naming constraints for ledger names are defined in [Quotas in Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) in the *Amazon QLDB Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-name}
      */
     Name?: string | undefined;
     /**
@@ -52,16 +62,24 @@ export type QLDBLedgerProps = {
      * By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the `SendCommand` API permission for the ledger. For information, see [Getting started with the standard permissions mode](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) in the *Amazon QLDB Developer Guide* .
      *
      * > We strongly recommend using the `STANDARD` permissions mode to maximize the security of your ledger data.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-permissionsmode}
      */
     PermissionsMode: string;
     /**
      * 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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#aws-resource-qldb-ledger-return-values}
+ */
 export type QLDBLedgerAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-qldb-ledger.d.ts.map

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

@@ -1,15 +1,23 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::QLDB::Stream` resource specifies a journal stream for a given Amazon Quantum Ledger Database (Amazon QLDB) ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
+ *
+ * For more information, see [StreamJournalToKinesis](https://docs.aws.amazon.com/qldb/latest/developerguide/API_StreamJournalToKinesis.html) in the *Amazon QLDB API Reference* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html}
+ */
 export type QLDBStream = ResourceDefinitionWithAttributes<"AWS::QLDB::Stream", QLDBStreamProps, QLDBStreamAttribs>;
 /**
  * The `AWS::QLDB::Stream` resource specifies a journal stream for a given Amazon Quantum Ledger Database (Amazon QLDB) ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
  *
  * For more information, see [StreamJournalToKinesis](https://docs.aws.amazon.com/qldb/latest/developerguide/API_StreamJournalToKinesis.html) in the *Amazon QLDB API Reference* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html}
  */
 export type QLDBStreamProps = {
     /**
      * The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.
      *
      * The `ExclusiveEndTime` must be in `ISO 8601` date and time format and in Universal Coordinated Time (UTC). For example: `2019-06-13T21:36:34Z` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-exclusiveendtime}
      */
     ExclusiveEndTime?: string | undefined;
     /**
@@ -18,47 +26,59 @@ export type QLDBStreamProps = {
      * The `InclusiveStartTime` cannot be in the future and must be before `ExclusiveEndTime` .
      *
      * If you provide an `InclusiveStartTime` that is before the ledger's `CreationDateTime` , QLDB effectively defaults it to the ledger's `CreationDateTime` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-inclusivestarttime}
      */
     InclusiveStartTime: string;
     /**
      * The configuration settings of the Kinesis Data Streams destination for your stream request.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-kinesisconfiguration}
      */
     KinesisConfiguration: KinesisConfiguration;
     /**
      * The name of the ledger.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-ledgername}
      */
     LedgerName: string;
     /**
      * The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
      *
      * To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the `iam:PassRole` action on the IAM role resource. This is required for all journal stream requests.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-rolearn}
      */
     RoleArn: string;
     /**
      * The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.
      *
      * Your stream name must be unique among other *active* streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in [Quotas in Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) in the *Amazon QLDB Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-streamname}
      */
     StreamName: string;
     /**
      * 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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#aws-resource-qldb-stream-return-values}
+ */
 export type QLDBStreamAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the QLDB journal stream. For example: `arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-arn}
      */
     Arn: string;
     /**
      * The unique ID that QLDB assigns to each QLDB journal stream. For example: `IiPT4brpZCqCq3f4MTHbYy` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-id}
      */
     Id: string;
 };
 /**
  * The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html}
  */
 export type KinesisConfiguration = {
     /**
@@ -67,10 +87,12 @@ export type KinesisConfiguration = {
      * Default: `True`
      *
      * > Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see [KPL Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) and [Consumer De-aggregation](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) in the *Amazon Kinesis Data Streams Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html#cfn-qldb-stream-kinesisconfiguration-aggregationenabled}
      */
     AggregationEnabled?: boolean | undefined;
     /**
      * The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html#cfn-qldb-stream-kinesisconfiguration-streamarn}
      */
     StreamArn?: string | undefined;
 };