UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

897 lines (896 loc) 62.1 kB
import * as constructs from 'constructs'; import * as cdk from '../../core'; import * as cfn_parse from '../../core/lib/helpers-internal'; /** * Properties for defining a `CfnObservabilityConfiguration` * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html */ export interface CfnObservabilityConfigurationProps { /** * A name for the observability configuration. When you use it for the first time in an AWS Region , App Runner creates revision number `1` of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. * * > The name `DefaultConfiguration` is reserved. You can't use it to create a new observability configuration, and you can't create a revision of it. * > * > When you want to use your own observability configuration for your App Runner service, *create a configuration with a different name* , and then provide it when you create or update your service. * * If you don't specify a name, AWS CloudFormation generates a name for your observability configuration. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#cfn-apprunner-observabilityconfiguration-observabilityconfigurationname */ readonly observabilityConfigurationName?: string; /** * A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#cfn-apprunner-observabilityconfiguration-tags */ readonly tags?: cdk.CfnTag[]; /** * The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#cfn-apprunner-observabilityconfiguration-traceconfiguration */ readonly traceConfiguration?: CfnObservabilityConfiguration.TraceConfigurationProperty | cdk.IResolvable; } /** * A CloudFormation `AWS::AppRunner::ObservabilityConfiguration` * * Specify an AWS App Runner observability configuration by using the `AWS::AppRunner::ObservabilityConfiguration` resource in an AWS CloudFormation template. * * The `AWS::AppRunner::ObservabilityConfiguration` resource is an AWS App Runner resource type that specifies an App Runner observability configuration. * * App Runner requires this resource when you specify App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services. * * Create multiple revisions of a configuration by specifying this resource multiple times using the same `ObservabilityConfigurationName` . App Runner creates multiple resources with incremental `ObservabilityConfigurationRevision` values. When you specify a service and configure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific revision. * * The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This resource takes optional parameters that describe the configuration of these features (currently one parameter, `TraceConfiguration` ). If you don't specify a feature parameter, App Runner doesn't enable the feature. * * @cloudformationResource AWS::AppRunner::ObservabilityConfiguration * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html */ export declare class CfnObservabilityConfiguration extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME = "AWS::AppRunner::ObservabilityConfiguration"; /** * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnObservabilityConfiguration; /** * It's set to `true` for the configuration with the highest `Revision` among all configurations that share the same `ObservabilityConfigurationName` . It's set to `false` otherwise. * @cloudformationAttribute Latest */ readonly attrLatest: cdk.IResolvable; /** * The Amazon Resource Name (ARN) of this observability configuration. * @cloudformationAttribute ObservabilityConfigurationArn */ readonly attrObservabilityConfigurationArn: string; /** * The revision of this observability configuration. It's unique among all the active configurations ( `"Status": "ACTIVE"` ) that share the same `ObservabilityConfigurationName` . * @cloudformationAttribute ObservabilityConfigurationRevision */ readonly attrObservabilityConfigurationRevision: number; /** * A name for the observability configuration. When you use it for the first time in an AWS Region , App Runner creates revision number `1` of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. * * > The name `DefaultConfiguration` is reserved. You can't use it to create a new observability configuration, and you can't create a revision of it. * > * > When you want to use your own observability configuration for your App Runner service, *create a configuration with a different name* , and then provide it when you create or update your service. * * If you don't specify a name, AWS CloudFormation generates a name for your observability configuration. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#cfn-apprunner-observabilityconfiguration-observabilityconfigurationname */ observabilityConfigurationName: string | undefined; /** * A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#cfn-apprunner-observabilityconfiguration-tags */ readonly tags: cdk.TagManager; /** * The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-observabilityconfiguration.html#cfn-apprunner-observabilityconfiguration-traceconfiguration */ traceConfiguration: CfnObservabilityConfiguration.TraceConfigurationProperty | cdk.IResolvable | undefined; /** * Create a new `AWS::AppRunner::ObservabilityConfiguration`. * * @param scope - scope in which this resource is defined * @param id - scoped id of the resource * @param props - resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnObservabilityConfigurationProps); /** * Examines the CloudFormation resource and discloses attributes. * * @param inspector - tree inspector to collect and process attributes * */ inspect(inspector: cdk.TreeInspector): void; protected get cfnProperties(): { [key: string]: any; }; protected renderProperties(props: { [key: string]: any; }): { [key: string]: any; }; } export declare namespace CfnObservabilityConfiguration { /** * Describes the configuration of the tracing feature within an AWS App Runner observability configuration. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-observabilityconfiguration-traceconfiguration.html */ interface TraceConfigurationProperty { /** * The implementation provider chosen for tracing App Runner services. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-observabilityconfiguration-traceconfiguration.html#cfn-apprunner-observabilityconfiguration-traceconfiguration-vendor */ readonly vendor: string; } } /** * Properties for defining a `CfnService` * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html */ export interface CfnServiceProps { /** * The source to deploy to the App Runner service. It can be a code or an image repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-sourceconfiguration */ readonly sourceConfiguration: CfnService.SourceConfigurationProperty | cdk.IResolvable; /** * The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration. * * Specify an ARN with a name and a revision number to associate that revision. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3` * * Specify just the name to associate the latest revision. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-autoscalingconfigurationarn */ readonly autoScalingConfigurationArn?: string; /** * 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 . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-encryptionconfiguration */ readonly encryptionConfiguration?: CfnService.EncryptionConfigurationProperty | cdk.IResolvable; /** * The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-healthcheckconfiguration */ readonly healthCheckConfiguration?: CfnService.HealthCheckConfigurationProperty | cdk.IResolvable; /** * The runtime configuration of instances (scaling units) of your service. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-instanceconfiguration */ readonly instanceConfiguration?: CfnService.InstanceConfigurationProperty | cdk.IResolvable; /** * Configuration settings related to network traffic of the web application that the App Runner service runs. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-networkconfiguration */ readonly networkConfiguration?: CfnService.NetworkConfigurationProperty | cdk.IResolvable; /** * The observability configuration of your service. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-observabilityconfiguration */ readonly observabilityConfiguration?: CfnService.ServiceObservabilityConfigurationProperty | cdk.IResolvable; /** * A name for the App Runner service. It must be unique across all the running App Runner services in your AWS account in the AWS Region . * * If you don't specify a name, AWS CloudFormation generates a name for your service. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-servicename */ readonly serviceName?: string; /** * An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-tags */ readonly tags?: cdk.CfnTag[]; } /** * A CloudFormation `AWS::AppRunner::Service` * * 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. * * @cloudformationResource AWS::AppRunner::Service * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html */ export declare class CfnService extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME = "AWS::AppRunner::Service"; /** * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnService; /** * The Amazon Resource Name (ARN) of this service. * @cloudformationAttribute ServiceArn */ readonly attrServiceArn: string; /** * An ID that App Runner generated for this service. It's unique within the AWS Region . * @cloudformationAttribute ServiceId */ readonly attrServiceId: string; /** * A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application. * @cloudformationAttribute ServiceUrl */ readonly attrServiceUrl: string; /** * The current state of the App Runner service. These particular values mean the following. * * - `CREATE_FAILED` – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service. * * The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service. * - `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. * @cloudformationAttribute Status */ readonly attrStatus: string; /** * The source to deploy to the App Runner service. It can be a code or an image repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-sourceconfiguration */ sourceConfiguration: CfnService.SourceConfigurationProperty | cdk.IResolvable; /** * The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration. * * Specify an ARN with a name and a revision number to associate that revision. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3` * * Specify just the name to associate the latest revision. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability` * * @link http://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 . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-encryptionconfiguration */ encryptionConfiguration: CfnService.EncryptionConfigurationProperty | cdk.IResolvable | undefined; /** * The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-healthcheckconfiguration */ healthCheckConfiguration: CfnService.HealthCheckConfigurationProperty | cdk.IResolvable | undefined; /** * The runtime configuration of instances (scaling units) of your service. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-instanceconfiguration */ instanceConfiguration: CfnService.InstanceConfigurationProperty | cdk.IResolvable | undefined; /** * Configuration settings related to network traffic of the web application that the App Runner service runs. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-networkconfiguration */ networkConfiguration: CfnService.NetworkConfigurationProperty | cdk.IResolvable | undefined; /** * The observability configuration of your service. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-observabilityconfiguration */ observabilityConfiguration: CfnService.ServiceObservabilityConfigurationProperty | cdk.IResolvable | undefined; /** * A name for the App Runner service. It must be unique across all the running App Runner services in your AWS account in the AWS Region . * * If you don't specify a name, AWS CloudFormation generates a name for your service. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-servicename */ serviceName: string | undefined; /** * An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-tags */ readonly tags: cdk.TagManager; /** * Create a new `AWS::AppRunner::Service`. * * @param scope - scope in which this resource is defined * @param id - scoped id of the resource * @param props - resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnServiceProps); /** * Examines the CloudFormation resource and discloses attributes. * * @param inspector - tree inspector to collect and process attributes * */ inspect(inspector: cdk.TreeInspector): void; protected get cfnProperties(): { [key: string]: any; }; protected renderProperties(props: { [key: string]: any; }): { [key: string]: any; }; } export declare namespace CfnService { /** * Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html */ interface AuthenticationConfigurationProperty { /** * 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). * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html#cfn-apprunner-service-authenticationconfiguration-accessrolearn */ readonly accessRoleArn?: string; /** * The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-authenticationconfiguration.html#cfn-apprunner-service-authenticationconfiguration-connectionarn */ readonly connectionArn?: string; } } export declare namespace CfnService { /** * Describes the configuration that AWS App Runner uses to build and run an App Runner service from a source code repository. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html */ interface CodeConfigurationProperty { /** * 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). * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html#cfn-apprunner-service-codeconfiguration-codeconfigurationvalues */ readonly codeConfigurationValues?: CfnService.CodeConfigurationValuesProperty | cdk.IResolvable; /** * The source of the App Runner configuration. Values are interpreted as follows: * * - `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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html#cfn-apprunner-service-codeconfiguration-configurationsource */ readonly configurationSource: string; } } export declare namespace CfnService { /** * 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. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html */ interface CodeConfigurationValuesProperty { /** * The command App Runner runs to build your application. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-buildcommand */ readonly buildCommand?: string; /** * The port that your application listens to in the container. * * Default: `8080` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-port */ readonly port?: string; /** * A runtime environment type for building and running an App Runner service. It represents a programming language runtime. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtime */ readonly runtime: string; /** * An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. * * > - 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtimeenvironmentsecrets */ readonly runtimeEnvironmentSecrets?: Array<CfnService.KeyValuePairProperty | cdk.IResolvable> | cdk.IResolvable; /** * The environment variables that are available to your running AWS App Runner service. An array of key-value pairs. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtimeenvironmentvariables */ readonly runtimeEnvironmentVariables?: Array<CfnService.KeyValuePairProperty | cdk.IResolvable> | cdk.IResolvable; /** * The command App Runner runs to start your application. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-startcommand */ readonly startCommand?: string; } } export declare namespace CfnService { /** * Describes a source code repository. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html */ interface CodeRepositoryProperty { /** * Configuration for building and running the service from a source code repository. * * > `CodeConfiguration` is required only for `CreateService` request. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-codeconfiguration */ readonly codeConfiguration?: CfnService.CodeConfigurationProperty | cdk.IResolvable; /** * The location of the repository that contains the source code. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-repositoryurl */ readonly repositoryUrl: string; /** * The version that should be used within the source code repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-sourcecodeversion */ readonly sourceCodeVersion: CfnService.SourceCodeVersionProperty | cdk.IResolvable; } } export declare namespace CfnService { /** * Describes configuration settings related to outbound network traffic of an AWS App Runner service. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html */ interface EgressConfigurationProperty { /** * The type of egress configuration. * * 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` . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html#cfn-apprunner-service-egressconfiguration-egresstype */ readonly egressType: string; /** * The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when `EgressType = VPC` . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html#cfn-apprunner-service-egressconfiguration-vpcconnectorarn */ readonly vpcConnectorArn?: string; } } export declare namespace CfnService { /** * Describes a custom encryption key that AWS App Runner uses to encrypt copies of the source repository and service logs. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-encryptionconfiguration.html */ interface EncryptionConfigurationProperty { /** * The ARN of the KMS key that's used for encryption. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-encryptionconfiguration.html#cfn-apprunner-service-encryptionconfiguration-kmskey */ readonly kmsKey: string; } } export declare namespace CfnService { /** * Describes the settings for the health check that AWS App Runner performs to monitor the health of a service. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html */ interface HealthCheckConfigurationProperty { /** * The number of consecutive checks that must succeed before App Runner decides that the service is healthy. * * Default: `1` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-healthythreshold */ readonly healthyThreshold?: number; /** * The time interval, in seconds, between health checks. * * Default: `5` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-interval */ readonly interval?: number; /** * The URL that health check requests are sent to. * * `Path` is only applicable when you set `Protocol` to `HTTP` . * * Default: `"/"` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-path */ readonly path?: string; /** * The IP protocol that App Runner uses to perform health checks for your service. * * If you set `Protocol` to `HTTP` , App Runner sends health check requests to the HTTP path specified by `Path` . * * Default: `TCP` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-protocol */ readonly protocol?: string; /** * The time, in seconds, to wait for a health check response before deciding it failed. * * Default: `2` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-timeout */ readonly timeout?: number; /** * The number of consecutive checks that must fail before App Runner decides that the service is unhealthy. * * Default: `5` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-unhealthythreshold */ readonly unhealthyThreshold?: number; } } export declare namespace CfnService { /** * Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html */ interface ImageConfigurationProperty { /** * The port that your application listens to in the container. * * Default: `8080` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-port */ readonly port?: string; /** * An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. * * > - 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-runtimeenvironmentsecrets */ readonly runtimeEnvironmentSecrets?: Array<CfnService.KeyValuePairProperty | cdk.IResolvable> | cdk.IResolvable; /** * Environment variables that are available to your running App Runner service. An array of key-value pairs. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-runtimeenvironmentvariables */ readonly runtimeEnvironmentVariables?: Array<CfnService.KeyValuePairProperty | cdk.IResolvable> | cdk.IResolvable; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-startcommand */ readonly startCommand?: string; } } export declare namespace CfnService { /** * Describes a source image repository. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html */ interface ImageRepositoryProperty { /** * Configuration for running the identified image. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imageconfiguration */ readonly imageConfiguration?: CfnService.ImageConfigurationProperty | cdk.IResolvable; /** * The identifier of an image. * * For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see [Pulling an image](https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html) in the *Amazon ECR User Guide* . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imageidentifier */ readonly imageIdentifier: string; /** * The type of the image repository. This reflects the repository provider and whether the repository is private or public. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html#cfn-apprunner-service-imagerepository-imagerepositorytype */ readonly imageRepositoryType: string; } } export declare namespace CfnService { /** * Network configuration settings for inbound network traffic. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-ingressconfiguration.html */ interface IngressConfigurationProperty { /** * 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` . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-ingressconfiguration.html#cfn-apprunner-service-ingressconfiguration-ispubliclyaccessible */ readonly isPubliclyAccessible: boolean | cdk.IResolvable; } } export declare namespace CfnService { /** * Describes the runtime configuration of an AWS App Runner service instance (scaling unit). * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html */ interface InstanceConfigurationProperty { /** * The number of CPU units reserved for each instance of your App Runner service. * * Default: `1 vCPU` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-cpu */ readonly cpu?: string; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-instancerolearn */ readonly instanceRoleArn?: string; /** * The amount of memory, in MB or GB, reserved for each instance of your App Runner service. * * Default: `2 GB` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-memory */ readonly memory?: string; } } export declare namespace CfnService { /** * Describes a key-value pair, which is a string-to-string mapping. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html */ interface KeyValuePairProperty { /** * The key name string to map to a value. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html#cfn-apprunner-service-keyvaluepair-name */ readonly name?: string; /** * The value string to which the key name is mapped. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html#cfn-apprunner-service-keyvaluepair-value */ readonly value?: string; } } export declare namespace CfnService { /** * Describes configuration settings related to network traffic of an AWS App Runner service. Consists of embedded objects for each configurable network feature. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html */ interface NetworkConfigurationProperty { /** * Network configuration settings for outbound message traffic. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html#cfn-apprunner-service-networkconfiguration-egressconfiguration */ readonly egressConfiguration?: CfnService.EgressConfigurationProperty | cdk.IResolvable; /** * Network configuration settings for inbound message traffic. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html#cfn-apprunner-service-networkconfiguration-ingressconfiguration */ readonly ingressConfiguration?: CfnService.IngressConfigurationProperty | cdk.IResolvable; } } export declare namespace CfnService { /** * 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. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html */ interface ServiceObservabilityConfigurationProperty { /** * The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when `ObservabilityEnabled` is `true` . * * Specify an ARN with a name and a revision number to associate that revision. For example: `arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3` * * Specify just the name to associate the latest revision. For example: `arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html#cfn-apprunner-service-serviceobservabilityconfiguration-observabilityconfigurationarn */ readonly observabilityConfigurationArn?: string; /** * When `true` , an observability configuration resource is associated with the service, and an `ObservabilityConfigurationArn` is specified. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html#cfn-apprunner-service-serviceobservabilityconfiguration-observabilityenabled */ readonly observabilityEnabled: boolean | cdk.IResolvable; } } export declare namespace CfnService { /** * Identifies a version of code that AWS App Runner refers to within a source code repository. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html */ interface SourceCodeVersionProperty { /** * The type of version identifier. * * For a git-based repository, branches represent versions. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html#cfn-apprunner-service-sourcecodeversion-type */ readonly type: string; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html#cfn-apprunner-service-sourcecodeversion-value */ readonly value: string; } } export declare namespace CfnService { /** * Describes the source deployed to an AWS App Runner service. It can be a code or an image repository. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html */ interface SourceConfigurationProperty { /** * Describes the resources that are needed to authenticate access to some source repositories. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-authenticationconfiguration */ readonly authenticationConfiguration?: CfnService.AuthenticationConfigurationProperty | cdk.IResolvable; /** * 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). * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-autodeploymentsenabled */ readonly autoDeploymentsEnabled?: boolean | cdk.IResolvable; /** * The description of a source code repository. * * You must provide either this member or `ImageRepository` (but not both). * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-coderepository */ readonly codeRepository?: CfnService.CodeRepositoryProperty | cdk.IResolvable; /** * The description of a source image repository. * * You must provide either this member or `CodeRepository` (but not both). * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html#cfn-apprunner-service-sourceconfiguration-imagerepository */ readonly imageRepository?: CfnService.ImageRepositoryProperty | cdk.IResolvable; } } /** * Properties for defining a `CfnVpcConnector` * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html */ export interface CfnVpcConnectorProps { /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-subnets */ readonly subnets: string[]; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-vpcconnector.html#cfn-apprunner-vpcconnector-securitygroups */ readonly securityGroups?: string[]; /** * A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair. *