@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-apprunner-service.d.ts

@@ -1,9 +1,16 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Specify an AWS App Runner service by using the `AWS::AppRunner::Service` resource in an AWS CloudFormation template.
+ *
+ * The `AWS::AppRunner::Service` resource is an AWS App Runner resource type that specifies an App Runner service.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html}
+ */
 export type AppRunnerService = ResourceDefinitionWithAttributes<"AWS::AppRunner::Service", AppRunnerServiceProps, AppRunnerServiceAttribs>;
 /**
  * Specify an AWS App Runner service by using the `AWS::AppRunner::Service` resource in an AWS CloudFormation template.
  *
  * The `AWS::AppRunner::Service` resource is an AWS App Runner resource type that specifies an App Runner service.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html}
  */
 export type AppRunnerServiceProps = {
     /**
@@ -15,26 +22,32 @@ export type AppRunnerServiceProps = {
      * @minLength 1
      * @maxLength 1011
      * @pattern arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-autoscalingconfigurationarn}
      */
     AutoScalingConfigurationArn?: string | undefined;
     /**
      * An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an AWS managed key .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-encryptionconfiguration}
      */
     EncryptionConfiguration?: EncryptionConfiguration | undefined;
     /**
      * The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-healthcheckconfiguration}
      */
     HealthCheckConfiguration?: HealthCheckConfiguration | undefined;
     /**
      * The runtime configuration of instances (scaling units) of your service.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-instanceconfiguration}
      */
     InstanceConfiguration?: InstanceConfiguration | undefined;
     /**
      * Configuration settings related to network traffic of the web application that the App Runner service runs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-networkconfiguration}
      */
     NetworkConfiguration?: NetworkConfiguration | undefined;
     /**
      * The observability configuration of your service.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-observabilityconfiguration}
      */
     ObservabilityConfiguration?: ServiceObservabilityConfiguration | undefined;
     /**
@@ -44,33 +57,42 @@ export type AppRunnerServiceProps = {
      * @minLength 4
      * @maxLength 40
      * @pattern [A-Za-z0-9][A-Za-z0-9-_]{3,39}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-servicename}
      */
     ServiceName?: string | undefined;
     /**
      * The source to deploy to the App Runner service. It can be a code or an image repository.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-sourceconfiguration}
      */
     SourceConfiguration: SourceConfiguration;
     /**
      * An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#aws-resource-apprunner-service-return-values}
+ */
 export type AppRunnerServiceAttribs = {
     /**
      * The Amazon Resource Name (ARN) of this service.
      * @minLength 1
      * @maxLength 1011
      * @pattern arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-servicearn}
      */
     ServiceArn: string;
     /**
      * An ID that App Runner generated for this service. It's unique within the AWS Region .
      * @minLength 32
      * @maxLength 32
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-serviceid}
      */
     ServiceId: string;
     /**
      * A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-serviceurl}
      */
     ServiceUrl: string;
     /**
@@ -78,15 +100,18 @@ export type AppRunnerServiceAttribs = {
      *
      * - `CREATE_FAILED` – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using `UpdateService` .
      * - `DELETE_FAILED` – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-status}
      */
     Status: string;
 };
 /**
  * Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html}
  */
 export type AuthenticationConfiguration = {
     /**
      * The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html#cfn-apprunner-service-authenticationconfiguration-accessrolearn}
      */
     AccessRoleArn?: string | undefined;
     /**
@@ -94,15 +119,18 @@ export type AuthenticationConfiguration = {
      * @minLength 1
      * @maxLength 1011
      * @pattern arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html#cfn-apprunner-service-authenticationconfiguration-connectionarn}
      */
     ConnectionArn?: string | undefined;
 };
 /**
  * Describes the configuration that AWS App Runner uses to build and run an App Runner service from a source code repository.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html}
  */
 export type CodeConfiguration = {
     /**
      * The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a `apprunner.yaml` file in the source code repository (or ignoring the file if it exists).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html#cfn-apprunner-service-codeconfiguration-codeconfigurationvalues}
      */
     CodeConfigurationValues?: CodeConfigurationValues | undefined;
     /**
@@ -110,25 +138,30 @@ export type CodeConfiguration = {
      *
      * - `REPOSITORY` – App Runner reads configuration values from the `apprunner.yaml` file in the source code repository and ignores `CodeConfigurationValues` .
      * - `API` – App Runner uses configuration values provided in `CodeConfigurationValues` and ignores the `apprunner.yaml` file in the source code repository.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html#cfn-apprunner-service-codeconfiguration-configurationsource}
      */
     ConfigurationSource: "REPOSITORY" | "API";
 };
 /**
  * Describes the basic configuration needed for building and running an AWS App Runner service. This type doesn't support the full set of possible configuration options. Fur full configuration capabilities, use a `apprunner.yaml` file in the source code repository.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html}
  */
 export type CodeConfigurationValues = {
     /**
      * The command App Runner runs to build your application.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-buildcommand}
      */
     BuildCommand?: string | undefined;
     /**
      * The port that your application listens to in the container.
      *
      * Default: `8080`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-port}
      */
     Port?: string | undefined;
     /**
      * A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtime}
      */
     Runtime: "PYTHON_3" | "NODEJS_12" | "NODEJS_14" | "CORRETTO_8" | "CORRETTO_11" | "NODEJS_16" | "GO_1" | "DOTNET_6" | "PHP_81" | "RUBY_31" | "PYTHON_311" | "NODEJS_18" | "NODEJS_22";
     /**
@@ -136,33 +169,40 @@ export type CodeConfigurationValues = {
      *
      * > - If the AWS Systems Manager Parameter Store parameter exists in the same AWS Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
      * > - Currently, cross account referencing of AWS Systems Manager Parameter Store parameter is not supported.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtimeenvironmentsecrets}
      */
     RuntimeEnvironmentSecrets?: KeyValuePair[] | undefined;
     /**
      * The environment variables that are available to your running AWS App Runner service. An array of key-value pairs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtimeenvironmentvariables}
      */
     RuntimeEnvironmentVariables?: KeyValuePair[] | undefined;
     /**
      * The command App Runner runs to start your application.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-startcommand}
      */
     StartCommand?: string | undefined;
 };
 /**
  * Describes a source code repository.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html}
  */
 export type CodeRepository = {
     /**
      * Configuration for building and running the service from a source code repository.
      *
      * > `CodeConfiguration` is required only for `CreateService` request.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-codeconfiguration}
      */
     CodeConfiguration?: CodeConfiguration | undefined;
     /**
      * The location of the repository that contains the source code.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-repositoryurl}
      */
     RepositoryUrl: string;
     /**
      * The version that should be used within the source code repository.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-sourcecodeversion}
      */
     SourceCodeVersion: SourceCodeVersion;
     /**
@@ -170,11 +210,13 @@ export type CodeRepository = {
      * @minLength 1
      * @maxLength 4096
      * @pattern [^\x00]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-sourcedirectory}
      */
     SourceDirectory?: string | undefined;
 };
 /**
  * Describes configuration settings related to outbound network traffic of an AWS App Runner service.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html}
  */
 export type EgressConfiguration = {
     /**
@@ -183,6 +225,7 @@ export type EgressConfiguration = {
      * Set to `DEFAULT` for access to resources hosted on public networks.
      *
      * Set to `VPC` to associate your service to a custom VPC specified by `VpcConnectorArn` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html#cfn-apprunner-service-egressconfiguration-egresstype}
      */
     EgressType: "DEFAULT" | "VPC";
     /**
@@ -190,11 +233,13 @@ export type EgressConfiguration = {
      * @minLength 44
      * @maxLength 1011
      * @pattern arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html#cfn-apprunner-service-egressconfiguration-vpcconnectorarn}
      */
     VpcConnectorArn?: string | undefined;
 };
 /**
  * Describes a custom encryption key that AWS App Runner uses to encrypt copies of the source repository and service logs.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-encryptionconfiguration.html}
  */
 export type EncryptionConfiguration = {
     /**
@@ -202,11 +247,13 @@ export type EncryptionConfiguration = {
      * @minLength 0
      * @maxLength 256
      * @pattern arn:aws(-[\w]+)*:kms:[a-z\-]+-[0-9]{1}:[0-9]{12}:key\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-encryptionconfiguration.html#cfn-apprunner-service-encryptionconfiguration-kmskey}
      */
     KmsKey: string;
 };
 /**
  * Describes the settings for the health check that AWS App Runner performs to monitor the health of a service.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html}
  */
 export type HealthCheckConfiguration = {
     /**
@@ -215,12 +262,14 @@ export type HealthCheckConfiguration = {
      * Default: `1`
      * @min 1
      * @max 20
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-healthythreshold}
      */
     HealthyThreshold?: number | undefined;
     /**
      * The time interval, in seconds, between health checks.
      *
      * Default: `5`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-interval}
      */
     Interval?: number | undefined;
     /**
@@ -229,6 +278,7 @@ export type HealthCheckConfiguration = {
      * `Path` is only applicable when you set `Protocol` to `HTTP` .
      *
      * Default: `"/"`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-path}
      */
     Path?: string | undefined;
     /**
@@ -237,6 +287,7 @@ export type HealthCheckConfiguration = {
      * If you set `Protocol` to `HTTP` , App Runner sends health check requests to the HTTP path specified by `Path` .
      *
      * Default: `TCP`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-protocol}
      */
     Protocol?: "TCP" | "HTTP" | undefined;
     /**
@@ -245,6 +296,7 @@ export type HealthCheckConfiguration = {
      * Default: `2`
      * @min 1
      * @max 20
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-timeout}
      */
     Timeout?: number | undefined;
     /**
@@ -253,17 +305,20 @@ export type HealthCheckConfiguration = {
      * Default: `5`
      * @min 1
      * @max 20
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-unhealthythreshold}
      */
     UnhealthyThreshold?: number | undefined;
 };
 /**
  * Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html}
  */
 export type ImageConfiguration = {
     /**
      * The port that your application listens to in the container.
      *
      * Default: `8080`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-port}
      */
     Port?: string | undefined;
     /**
@@ -271,23 +326,28 @@ export type ImageConfiguration = {
      *
      * > - If the AWS Systems Manager Parameter Store parameter exists in the same AWS Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
      * > - Currently, cross account referencing of AWS Systems Manager Parameter Store parameter is not supported.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-runtimeenvironmentsecrets}
      */
     RuntimeEnvironmentSecrets?: KeyValuePair[] | undefined;
     /**
      * Environment variables that are available to your running App Runner service. An array of key-value pairs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-runtimeenvironmentvariables}
      */
     RuntimeEnvironmentVariables?: KeyValuePair[] | undefined;
     /**
      * An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-startcommand}
      */
     StartCommand?: string | undefined;
 };
 /**
  * Describes a source image repository.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html}
  */
 export type ImageRepository = {
     /**
      * Configuration for running the identified image.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imageconfiguration}
      */
     ImageConfiguration?: ImageConfiguration | undefined;
     /**
@@ -297,24 +357,29 @@ export type ImageRepository = {
      * @minLength 1
      * @maxLength 1024
      * @pattern ([0-9]{12}.dkr.ecr.[a-z\-]+-[0-9]{1}.amazonaws.com\/.*)|(^public\.ecr\.aws\/.+\/.+)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imageidentifier}
      */
     ImageIdentifier: string;
     /**
      * The type of the image repository. This reflects the repository provider and whether the repository is private or public.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imagerepositorytype}
      */
     ImageRepositoryType: "ECR" | "ECR_PUBLIC";
 };
 /**
  * Network configuration settings for inbound network traffic.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-ingressconfiguration.html}
  */
 export type IngressConfiguration = {
     /**
      * Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to `True` . To make the service privately accessible, from only within an Amazon VPC set it to `False` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-ingressconfiguration.html#cfn-apprunner-service-ingressconfiguration-ispubliclyaccessible}
      */
     IsPubliclyAccessible: boolean;
 };
 /**
  * Describes the runtime configuration of an AWS App Runner service instance (scaling unit).
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html}
  */
 export type InstanceConfiguration = {
     /**
@@ -324,10 +389,12 @@ export type InstanceConfiguration = {
      * @minLength 3
      * @maxLength 9
      * @pattern 256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-cpu}
      */
     Cpu?: string | undefined;
     /**
      * The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-instancerolearn}
      */
     InstanceRoleArn?: string | undefined;
     /**
@@ -337,43 +404,52 @@ export type InstanceConfiguration = {
      * @minLength 3
      * @maxLength 6
      * @pattern 512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-memory}
      */
     Memory?: string | undefined;
 };
 /**
  * Describes a key-value pair, which is a string-to-string mapping.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html}
  */
 export type KeyValuePair = {
     /**
      * The key name string to map to a value.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html#cfn-apprunner-service-keyvaluepair-name}
      */
     Name?: string | undefined;
     /**
      * The value string to which the key name is mapped.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html#cfn-apprunner-service-keyvaluepair-value}
      */
     Value?: string | undefined;
 };
 /**
  * Describes configuration settings related to network traffic of an AWS App Runner service. Consists of embedded objects for each configurable network feature.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html}
  */
 export type NetworkConfiguration = {
     /**
      * Network configuration settings for outbound message traffic.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html#cfn-apprunner-service-networkconfiguration-egressconfiguration}
      */
     EgressConfiguration?: EgressConfiguration | undefined;
     /**
      * Network configuration settings for inbound message traffic.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html#cfn-apprunner-service-networkconfiguration-ingressconfiguration}
      */
     IngressConfiguration?: IngressConfiguration | undefined;
     /**
      * App Runner provides you with the option to choose between *Internet Protocol version 4 (IPv4)* and *dual stack* (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an `IpAddressType` , it defaults to select IPv4.
      *
      * > Currently, App Runner supports dual stack for only Public endpoint. Only IPv4 is supported for Private endpoint. If you update a service that's using dual-stack Public endpoint to a Private endpoint, your App Runner service will default to support only IPv4 for Private endpoint and fail to receive traffic originating from IPv6 endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html#cfn-apprunner-service-networkconfiguration-ipaddresstype}
      */
     IpAddressType?: "IPV4" | "DUAL_STACK" | undefined;
 };
 /**
  * Describes the observability configuration of an AWS App Runner service. These are additional observability features, like tracing, that you choose to enable. They're configured in a separate resource that you associate with your service.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html}
  */
 export type ServiceObservabilityConfiguration = {
     /**
@@ -385,54 +461,64 @@ export type ServiceObservabilityConfiguration = {
      * @minLength 1
      * @maxLength 1011
      * @pattern arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html#cfn-apprunner-service-serviceobservabilityconfiguration-observabilityconfigurationarn}
      */
     ObservabilityConfigurationArn?: string | undefined;
     /**
      * When `true` , an observability configuration resource is associated with the service, and an `ObservabilityConfigurationArn` is specified.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html#cfn-apprunner-service-serviceobservabilityconfiguration-observabilityenabled}
      */
     ObservabilityEnabled: boolean;
 };
 /**
  * Identifies a version of code that AWS App Runner refers to within a source code repository.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html}
  */
 export type SourceCodeVersion = {
     /**
      * The type of version identifier.
      *
      * For a git-based repository, branches represent versions.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html#cfn-apprunner-service-sourcecodeversion-type}
      */
     Type: "BRANCH";
     /**
      * A source code version.
      *
      * For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html#cfn-apprunner-service-sourcecodeversion-value}
      */
     Value: string;
 };
 /**
  * Describes the source deployed to an AWS App Runner service. It can be a code or an image repository.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html}
  */
 export type SourceConfiguration = {
     /**
      * Describes the resources that are needed to authenticate access to some source repositories.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-authenticationconfiguration}
      */
     AuthenticationConfiguration?: AuthenticationConfiguration | undefined;
     /**
      * If `true` , continuous integration from the source repository is enabled for the App Runner service. Each repository change (including any source code commit or new image version) starts a deployment.
      *
      * Default: App Runner sets to `false` for a source image that uses an ECR Public repository or an ECR repository that's in an AWS account other than the one that the service is in. App Runner sets to `true` in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-autodeploymentsenabled}
      */
     AutoDeploymentsEnabled?: boolean | undefined;
     /**
      * The description of a source code repository.
      *
      * You must provide either this member or `ImageRepository` (but not both).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-coderepository}
      */
     CodeRepository?: CodeRepository | undefined;
     /**
      * The description of a source image repository.
      *
      * You must provide either this member or `CodeRepository` (but not both).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-imagerepository}
      */
     ImageRepository?: ImageRepository | undefined;
 };

package/out/exports/resources.generated/aws-apprunner-vpcconnector.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Specify an AWS App Runner VPC connector by using the `AWS::AppRunner::VpcConnector` resource in an AWS CloudFormation template.
+ *
+ * The `AWS::AppRunner::VpcConnector` resource is an AWS App Runner resource type that specifies an App Runner VPC connector.
+ *
+ * App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud ( Amazon VPC ).
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html}
+ */
 export type AppRunnerVpcConnector = ResourceDefinitionWithAttributes<"AWS::AppRunner::VpcConnector", AppRunnerVpcConnectorProps, AppRunnerVpcConnectorAttribs>;
 /**
  * Specify an AWS App Runner VPC connector by using the `AWS::AppRunner::VpcConnector` resource in an AWS CloudFormation template.
@@ -6,22 +14,26 @@ export type AppRunnerVpcConnector = ResourceDefinitionWithAttributes<"AWS::AppRu
  * The `AWS::AppRunner::VpcConnector` resource is an AWS App Runner resource type that specifies an App Runner VPC connector.
  *
  * App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud ( Amazon VPC ).
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html}
  */
 export type AppRunnerVpcConnectorProps = {
     /**
      * A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-securitygroups}
      */
     SecurityGroups?: string[] | undefined;
     /**
      * A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
      *
      * > App Runner currently only provides support for IPv4.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-subnets}
      */
     Subnets: string[];
     /**
      * A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
      *
      * > A `VpcConnector` is immutable, so you cannot update its tags. To change the tags, replace the resource. To replace a `VpcConnector` , you must provide a new combination of security groups.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-tags}
      */
     Tags?: Tag[] | undefined;
     /**
@@ -31,21 +43,27 @@ export type AppRunnerVpcConnectorProps = {
      * @minLength 4
      * @maxLength 40
      * @pattern ^[A-Za-z0-9][A-Za-z0-9-\\_]{3,39}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-vpcconnectorname}
      */
     VpcConnectorName?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#aws-resource-apprunner-vpcconnector-return-values}
+ */
 export type AppRunnerVpcConnectorAttribs = {
     /**
      * The Amazon Resource Name (ARN) of this VPC connector.
      * @minLength 44
      * @maxLength 1011
      * @pattern arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-vpcconnectorarn}
      */
     VpcConnectorArn: string;
     /**
      * The revision of this VPC connector. It's unique among all the active connectors ( `"Status": "ACTIVE"` ) that share the same `Name` .
      *
      * > At this time, App Runner supports only one revision per name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-vpcconnectorrevision}
      */
     VpcConnectorRevision: number;
 };