@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-appstream-user.d.ts

@@ -1,35 +1,51 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * The `AWS::AppStream::User` resource creates a new user in the AppStream 2.0 user pool.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html}
+ */
 export type AppStreamUser = ResourceDefinitionWithAttributes<"AWS::AppStream::User", AppStreamUserProps, AppStreamUserAttribs>;
 /**
  * The `AWS::AppStream::User` resource creates a new user in the AppStream 2.0 user pool.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html}
  */
 export type AppStreamUserProps = {
     /**
      * The authentication type for the user. You must specify USERPOOL.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-authenticationtype}
      */
     AuthenticationType: string;
     /**
      * The first name, or given name, of the user.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-firstname}
      */
     FirstName?: string | undefined;
     /**
      * The last name, or surname, of the user.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-lastname}
      */
     LastName?: string | undefined;
     /**
      * The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
      *
      * > The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-messageaction}
      */
     MessageAction?: string | undefined;
     /**
      * The email address of the user.
      *
      * Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-username}
      */
     UserName: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#aws-resource-appstream-user-return-values}
+ */
 export type AppStreamUserAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-appstream-user.d.ts.map

package/out/exports/resources.generated/aws-appsync-api.d.ts

@@ -1,147 +1,187 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::AppSync::Api` resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html}
+ */
 export type AppSyncApi = ResourceDefinitionWithAttributes<"AWS::AppSync::Api", AppSyncApiProps, AppSyncApiAttribs>;
 /**
  * The `AWS::AppSync::Api` resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html}
  */
 export type AppSyncApiProps = {
     /**
      * Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-eventconfig}
      */
     EventConfig?: EventConfig | undefined;
     /**
      * The name of the `Api` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-name}
      */
     Name: string;
     /**
      * The owner contact information for an API resource.
      *
      * This field accepts any string input with a length of 0 - 256 characters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-ownercontact}
      */
     OwnerContact?: string | undefined;
     /**
      * A set of tags (key-value pairs) for this API.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#aws-resource-appsync-api-return-values}
+ */
 export type AppSyncApiAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the AWS AppSync Api.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-apiarn}
      */
     ApiArn: string;
     /**
      * The unique identifier for the AWS AppSync Api generated by the service.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-apiid}
      */
     ApiId: string;
     /**
      * The domain name of the Api's HTTP endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-dnsmap.html#cfn-appsync-api-dnsmap-http}
      */
     "Dns.Http": string;
     /**
      * The domain name of the Api's real-time endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-dnsmap.html#cfn-appsync-api-dnsmap-realtime}
      */
     "Dns.Realtime": string;
 };
 /**
  * Describes an authorization configuration. Use `AuthMode` to specify the publishing and subscription authorization configuration for an Event API.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authmode.html}
  */
 export type AuthMode = {
     /**
      * The authorization type.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authmode.html#cfn-appsync-api-authmode-authtype}
      */
     AuthType?: AuthenticationType | undefined;
 };
 /**
  * Describes an authorization provider.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html}
  */
 export type AuthProvider = {
     /**
      * The authorization type.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-authtype}
      */
     AuthType: AuthenticationType;
     /**
      * Describes an Amazon Cognito user pool configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-cognitoconfig}
      */
     CognitoConfig?: CognitoConfig | undefined;
     /**
      * A `LambdaAuthorizerConfig` specifies how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode. Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-lambdaauthorizerconfig}
      */
     LambdaAuthorizerConfig?: LambdaAuthorizerConfig | undefined;
     /**
      * Describes an OpenID Connect (OIDC) configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-openidconnectconfig}
      */
     OpenIDConnectConfig?: OpenIDConnectConfig | undefined;
 };
 /**
  * Security configuration for your AppSync API.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authenticationtype.html}
  */
 export type AuthenticationType = "AMAZON_COGNITO_USER_POOLS" | "AWS_IAM" | "API_KEY" | "OPENID_CONNECT" | "AWS_LAMBDA";
 /**
  * Describes an Amazon Cognito configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html}
  */
 export type CognitoConfig = {
     /**
      * A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-appidclientregex}
      */
     AppIdClientRegex?: string | undefined;
     /**
      * The AWS Region in which the user pool was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-awsregion}
      */
     AwsRegion: string;
     /**
      * The user pool ID.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-userpoolid}
      */
     UserPoolId: string;
 };
 /**
  * Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html}
  */
 export type EventConfig = {
     /**
      * A list of authorization providers.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-authproviders}
      */
     AuthProviders: AuthProvider[];
     /**
      * A list of valid authorization modes for the Event API connections.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-connectionauthmodes}
      */
     ConnectionAuthModes: AuthMode[];
     /**
      * A list of valid authorization modes for the Event API publishing.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-defaultpublishauthmodes}
      */
     DefaultPublishAuthModes: AuthMode[];
     /**
      * A list of valid authorization modes for the Event API subscriptions.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-defaultsubscribeauthmodes}
      */
     DefaultSubscribeAuthModes: AuthMode[];
     /**
      * The CloudWatch Logs configuration for the Event API.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.html#cfn-appsync-api-eventconfig-logconfig}
      */
     LogConfig?: EventLogConfig | undefined;
 };
 /**
  * Describes the CloudWatch Logs configuration for the Event API.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventlogconfig.html}
  */
 export type EventLogConfig = {
     /**
      * The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventlogconfig.html#cfn-appsync-api-eventlogconfig-cloudwatchlogsrolearn}
      */
     CloudWatchLogsRoleArn: string;
     /**
      * The type of information to log for the Event API.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventlogconfig.html#cfn-appsync-api-eventlogconfig-loglevel}
      */
     LogLevel: EventLogLevel;
 };
 /**
  * Logging level for the AppSync API.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventloglevel.html}
  */
 export type EventLogLevel = "NONE" | "ERROR" | "ALL" | "INFO" | "DEBUG";
 /**
  * A `LambdaAuthorizerConfig` specifies how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode. Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-lambdaauthorizerconfig.html}
  */
 export type LambdaAuthorizerConfig = {
     /**
      * The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for `authorizerResultTtlInSeconds` , the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a `ttlOverride` key in its response.
      * @min 0
      * @max 3600
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-lambdaauthorizerconfig.html#cfn-appsync-api-lambdaauthorizerconfig-authorizerresultttlinseconds}
      */
     AuthorizerResultTtlInSeconds?: number | undefined;
     /**
@@ -150,31 +190,38 @@ export type LambdaAuthorizerConfig = {
      * *Note* : This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the AWS Command Line Interface ( AWS CLI ), run the following:
      *
      * `aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-lambdaauthorizerconfig.html#cfn-appsync-api-lambdaauthorizerconfig-authorizeruri}
      */
     AuthorizerUri: string;
     /**
      * A regular expression for validation of tokens before the Lambda function is called.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-lambdaauthorizerconfig.html#cfn-appsync-api-lambdaauthorizerconfig-identityvalidationexpression}
      */
     IdentityValidationExpression?: string | undefined;
 };
 /**
  * Describes an OpenID Connect (OIDC) configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html}
  */
 export type OpenIDConnectConfig = {
     /**
      * The number of milliseconds that a token is valid after being authenticated.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-authttl}
      */
     AuthTTL?: number | undefined;
     /**
      * The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AWS AppSync can validate against multiple client identifiers at a time.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-clientid}
      */
     ClientId?: string | undefined;
     /**
      * The number of milliseconds that a token is valid after it's issued to a user.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-iatttl}
      */
     IatTTL?: number | undefined;
     /**
      * The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of `iss` in the ID token.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-issuer}
      */
     Issuer: string;
 };

package/out/exports/resources.generated/aws-appsync-apicache.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * The `AWS::AppSync::ApiCache` resource represents the input of a `CreateApiCache` operation.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html}
+ */
 export type AppSyncApiCache = ResourceDefinitionWithAttributes<"AWS::AppSync::ApiCache", AppSyncApiCacheProps, AppSyncApiCacheAttribs>;
 /**
  * The `AWS::AppSync::ApiCache` resource represents the input of a `CreateApiCache` operation.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html}
  */
 export type AppSyncApiCacheProps = {
     /**
@@ -10,14 +15,17 @@ export type AppSyncApiCacheProps = {
      * - *FULL_REQUEST_CACHING* : All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
      * - *PER_RESOLVER_CACHING* : Individual resolvers that you specify are cached.
      * - *OPERATION_LEVEL_CACHING* : Full requests are cached together and returned without executing resolvers.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apicachingbehavior}
      */
     ApiCachingBehavior: string;
     /**
      * The GraphQL API ID.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apiid}
      */
     ApiId: string;
     /**
      * At-rest encryption flag for cache. You cannot update this setting after creation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-atrestencryptionenabled}
      */
     AtRestEncryptionEnabled?: boolean | undefined;
     /**
@@ -27,16 +35,19 @@ export type AppSyncApiCacheProps = {
      * - *EngineCPUUtilization* : The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.
      *
      * Metrics will be recorded by API ID. You can set the value to `ENABLED` or `DISABLED` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-healthmetricsconfig}
      */
     HealthMetricsConfig?: string | undefined;
     /**
      * Transit encryption flag when connecting to cache. You cannot update this setting after creation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-transitencryptionenabled}
      */
     TransitEncryptionEnabled?: boolean | undefined;
     /**
      * TTL in seconds for cache entries.
      *
      * Valid values are 1–3,600 seconds.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-ttl}
      */
     Ttl: number;
     /**
@@ -62,10 +73,17 @@ export type AppSyncApiCacheProps = {
      * - *R4_2XLARGE* : A r4.2xlarge instance type.
      * - *R4_4XLARGE* : A r4.4xlarge instance type.
      * - *R4_8XLARGE* : A r4.8xlarge instance type.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-type}
      */
     Type: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#aws-resource-appsync-apicache-return-values}
+ */
 export type AppSyncApiCacheAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-appsync-apicache.d.ts.map

package/out/exports/resources.generated/aws-appsync-apikey.d.ts

@@ -1,33 +1,47 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * The `AWS::AppSync::ApiKey` resource creates a unique key that you can distribute to clients who are executing GraphQL operations with AWS AppSync that require an API key.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html}
+ */
 export type AppSyncApiKey = ResourceDefinitionWithAttributes<"AWS::AppSync::ApiKey", AppSyncApiKeyProps, AppSyncApiKeyAttribs>;
 /**
  * The `AWS::AppSync::ApiKey` resource creates a unique key that you can distribute to clients who are executing GraphQL operations with AWS AppSync that require an API key.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html}
  */
 export type AppSyncApiKeyProps = {
     /**
      * Unique AWS AppSync GraphQL API ID for this API key.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apiid}
      */
     ApiId: string;
     /**
      * Unique description of your API key.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-description}
      */
     Description?: string | undefined;
     /**
      * The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-expires}
      */
     Expires?: number | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#aws-resource-appsync-apikey-return-values}
+ */
 export type AppSyncApiKeyAttribs = {
     /**
      * The API key.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apikey}
      */
     ApiKey: string;
     /**
      * The API key ID.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apikeyid}
      */
     ApiKeyId: string;
     /**
      * The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-arn}
      */
     Arn: string;
 };

package/out/exports/resources.generated/aws-appsync-channelnamespace.d.ts

@@ -1,90 +1,150 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::AppSync::ChannelNamespace` resource creates a channel namespace associated with an `Api` . The `ChannelNamespace` contains the definitions for code handlers for the `Api` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html}
+ */
 export type AppSyncChannelNamespace = ResourceDefinitionWithAttributes<"AWS::AppSync::ChannelNamespace", AppSyncChannelNamespaceProps, AppSyncChannelNamespaceAttribs>;
 /**
  * The `AWS::AppSync::ChannelNamespace` resource creates a channel namespace associated with an `Api` . The `ChannelNamespace` contains the definitions for code handlers for the `Api` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html}
  */
 export type AppSyncChannelNamespaceProps = {
     /**
      * The `Api` ID.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-apiid}
      */
     ApiId: string;
     /**
      * The event handler functions that run custom business logic to process published events and subscribe requests.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-codehandlers}
      */
     CodeHandlers?: string | undefined;
     /**
      * The Amazon S3 endpoint where the code is located.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-codes3location}
      */
     CodeS3Location?: string | undefined;
+    /**
+     * The configuration for the `OnPublish` and `OnSubscribe` handlers.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-handlerconfigs}
+     */
     HandlerConfigs?: HandlerConfigs | undefined;
     /**
      * The name of the channel namespace. This name must be unique within the `Api` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-name}
      */
     Name: string;
     /**
      * The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default `Api` authorization configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-publishauthmodes}
      */
     PublishAuthModes?: AuthMode[] | undefined;
     /**
      * The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default `Api` authorization configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-subscribeauthmodes}
      */
     SubscribeAuthModes?: AuthMode[] | undefined;
     /**
      * A set of tags (key-value pairs) for this channel namespace.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#aws-resource-appsync-channelnamespace-return-values}
+ */
 export type AppSyncChannelNamespaceAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the channel namespace.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-channelnamespacearn}
      */
     ChannelNamespaceArn: string;
 };
 /**
  * Describes an authorization configuration. Use `AuthMode` to specify the publishing and subscription authorization configuration for an Event API.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-authmode.html}
  */
 export type AuthMode = {
     /**
      * The authorization type.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-authmode.html#cfn-appsync-channelnamespace-authmode-authtype}
      */
     AuthType?: AuthenticationType | undefined;
 };
 /**
  * Security configuration for your AppSync API.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-authenticationtype.html}
  */
 export type AuthenticationType = "AMAZON_COGNITO_USER_POOLS" | "AWS_IAM" | "API_KEY" | "OPENID_CONNECT" | "AWS_LAMBDA";
 /**
  * Integration behavior for a handler configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerbehavior.html}
  */
 export type HandlerBehavior = "CODE" | "DIRECT";
+/**
+ * The `HandlerConfig` property type specifies the configuration for the handler.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfig.html}
+ */
 export type HandlerConfig = {
     /**
-     * Integration behavior for a handler configuration.
+     * The behavior for the handler.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfig.html#cfn-appsync-channelnamespace-handlerconfig-behavior}
      */
     Behavior: HandlerBehavior;
+    /**
+     * The integration data source configuration for the handler.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfig.html#cfn-appsync-channelnamespace-handlerconfig-integration}
+     */
     Integration: Integration;
 };
+/**
+ * The `HandlerConfigs` property type specifies the configuration for the `OnPublish` and `OnSubscribe` handlers.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfigs.html}
+ */
 export type HandlerConfigs = {
+    /**
+     * The configuration for the `OnPublish` handler.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfigs.html#cfn-appsync-channelnamespace-handlerconfigs-onpublish}
+     */
     OnPublish?: HandlerConfig | undefined;
+    /**
+     * The configuration for the `OnSubscribe` handler.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfigs.html#cfn-appsync-channelnamespace-handlerconfigs-onsubscribe}
+     */
     OnSubscribe?: HandlerConfig | undefined;
 };
+/**
+ * The `Integration` property type specifies the integration data source configuration for the handler.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-integration.html}
+ */
 export type Integration = {
     /**
-     * Data source to invoke for this integration.
+     * The unique name of the data source that has been configured on the API.
      * @minLength 1
      * @maxLength 512
      * @pattern ([_A-Za-z][_0-9A-Za-z]{0,511})?
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-integration.html#cfn-appsync-channelnamespace-integration-datasourcename}
      */
     DataSourceName: string;
+    /**
+     * The configuration for a Lambda data source.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-integration.html#cfn-appsync-channelnamespace-integration-lambdaconfig}
+     */
     LambdaConfig?: LambdaConfig | undefined;
 };
 /**
  * Invocation type for direct lambda integrations.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-invoketype.html}
  */
 export type InvokeType = "REQUEST_RESPONSE" | "EVENT";
+/**
+ * The `LambdaConfig` property type specifies the integration configuration for a Lambda data source.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-lambdaconfig.html}
+ */
 export type LambdaConfig = {
     /**
-     * Invocation type for direct lambda integrations.
+     * The invocation type for a Lambda data source.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-lambdaconfig.html#cfn-appsync-channelnamespace-lambdaconfig-invoketype}
      */
     InvokeType: InvokeType;
 };