--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_apprunner_service{% #aws_apprunner_service %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `auto_scaling_configuration_summary`{% #auto_scaling_configuration_summary %} **Type**: `STRUCT`**Provider name**: `AutoScalingConfigurationSummary`**Description**: Summary information for the App Runner automatic scaling configuration resource that's associated with this service. - `auto_scaling_configuration_arn`**Type**: `STRING`**Provider name**: `AutoScalingConfigurationArn`**Description**: The Amazon Resource Name (ARN) of this auto scaling configuration. - `auto_scaling_configuration_name`**Type**: `STRING`**Provider name**: `AutoScalingConfigurationName`**Description**: The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration. - `auto_scaling_configuration_revision`**Type**: `INT32`**Provider name**: `AutoScalingConfigurationRevision`**Description**: The revision of this auto scaling configuration. It's unique among all the active configurations (`"Status": "ACTIVE"`) with the same `AutoScalingConfigurationName`. - `created_at`**Type**: `TIMESTAMP`**Provider name**: `CreatedAt`**Description**: The time when the auto scaling configuration was created. It's in Unix time stamp format. - `has_associated_service`**Type**: `BOOLEAN`**Provider name**: `HasAssociatedService`**Description**: Indicates if this auto scaling configuration has an App Runner service associated with it. A value of `true` indicates one or more services are associated. A value of `false` indicates no services are associated. - `is_default`**Type**: `BOOLEAN`**Provider name**: `IsDefault`**Description**: Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default `AutoScalingConfiguration` per region. The default `AutoScalingConfiguration` can be any revision under the same `AutoScalingConfigurationName`. - `status`**Type**: `STRING`**Provider name**: `Status`**Description**: The current state of the auto scaling configuration. If the status of a configuration revision is `INACTIVE`, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted. ## `created_at`{% #created_at %} **Type**: `TIMESTAMP`**Provider name**: `CreatedAt`**Description**: The time when the App Runner service was created. It's in the Unix time stamp format. ## `deleted_at`{% #deleted_at %} **Type**: `TIMESTAMP`**Provider name**: `DeletedAt`**Description**: The time when the App Runner service was deleted. It's in the Unix time stamp format. ## `encryption_configuration`{% #encryption_configuration %} **Type**: `STRUCT`**Provider name**: `EncryptionConfiguration`**Description**: The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an Amazon Web Services managed key. - `kms_key`**Type**: `STRING`**Provider name**: `KmsKey`**Description**: The ARN of the KMS key that's used for encryption. ## `health_check_configuration`{% #health_check_configuration %} **Type**: `STRUCT`**Provider name**: `HealthCheckConfiguration`**Description**: The settings for the health check that App Runner performs to monitor the health of this service. - `healthy_threshold`**Type**: `INT32`**Provider name**: `HealthyThreshold`**Description**: The number of consecutive checks that must succeed before App Runner decides that the service is healthy.**Default**: `1` - `interval`**Type**: `INT32`**Provider name**: `Interval`**Description**: The time interval, in seconds, between health checks.**Default**: `5` - `path`**Type**: `STRING`**Provider name**: `Path`**Description**: The URL that health check requests are sent to. `Path` is only applicable when you set `Protocol` to `HTTP`.**Default**: `"/"` - `protocol`**Type**: `STRING`**Provider name**: `Protocol`**Description**: 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` - `timeout`**Type**: `INT32`**Provider name**: `Timeout`**Description**: The time, in seconds, to wait for a health check response before deciding it failed.**Default**: `2` - `unhealthy_threshold`**Type**: `INT32`**Provider name**: `UnhealthyThreshold`**Description**: The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.**Default**: `5` ## `instance_configuration`{% #instance_configuration %} **Type**: `STRUCT`**Provider name**: `InstanceConfiguration`**Description**: The runtime configuration of instances (scaling units) of this service. - `cpu`**Type**: `STRING`**Provider name**: `Cpu`**Description**: The number of CPU units reserved for each instance of your App Runner service.**Default**: `1 vCPU` - `instance_role_arn`**Type**: `STRING`**Provider name**: `InstanceRoleArn`**Description**: 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 Amazon Web Services APIs. - `memory`**Type**: `STRING`**Provider name**: `Memory`**Description**: The amount of memory, in MB or GB, reserved for each instance of your App Runner service.**Default**: `2 GB` ## `network_configuration`{% #network_configuration %} **Type**: `STRUCT`**Provider name**: `NetworkConfiguration`**Description**: Configuration settings related to network traffic of the web application that this service runs. - `egress_configuration`**Type**: `STRUCT`**Provider name**: `EgressConfiguration`**Description**: Network configuration settings for outbound message traffic. - `egress_type`**Type**: `STRING`**Provider name**: `EgressType`**Description**: 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`. - `vpc_connector_arn`**Type**: `STRING`**Provider name**: `VpcConnectorArn`**Description**: 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`. - `ingress_configuration`**Type**: `STRUCT`**Provider name**: `IngressConfiguration`**Description**: Network configuration settings for inbound message traffic. - `is_publicly_accessible`**Type**: `BOOLEAN`**Provider name**: `IsPubliclyAccessible`**Description**: 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`. - `ip_address_type`**Type**: `STRING`**Provider name**: `IpAddressType`**Description**: 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. ## `observability_configuration`{% #observability_configuration %} **Type**: `STRUCT`**Provider name**: `ObservabilityConfiguration`**Description**: The observability configuration of this service. - `observability_configuration_arn`**Type**: `STRING`**Provider name**: `ObservabilityConfigurationArn`**Description**: 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` - `observability_enabled`**Type**: `BOOLEAN`**Provider name**: `ObservabilityEnabled`**Description**: When `true`, an observability configuration resource is associated with the service, and an `ObservabilityConfigurationArn` is specified. ## `service_arn`{% #service_arn %} **Type**: `STRING`**Provider name**: `ServiceArn`**Description**: The Amazon Resource Name (ARN) of this service. ## `service_id`{% #service_id %} **Type**: `STRING`**Provider name**: `ServiceId`**Description**: An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region. ## `service_name`{% #service_name %} **Type**: `STRING`**Provider name**: `ServiceName`**Description**: The customer-provided service name. ## `service_url`{% #service_url %} **Type**: `STRING`**Provider name**: `ServiceUrl`**Description**: A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application. ## `source_configuration`{% #source_configuration %} **Type**: `STRUCT`**Provider name**: `SourceConfiguration`**Description**: The source deployed to the App Runner service. It can be a code or an image repository. - `authentication_configuration`**Type**: `STRUCT`**Provider name**: `AuthenticationConfiguration`**Description**: Describes the resources that are needed to authenticate access to some source repositories. - `access_role_arn`**Type**: `STRING`**Provider name**: `AccessRoleArn`**Description**: 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). - `connection_arn`**Type**: `STRING`**Provider name**: `ConnectionArn`**Description**: 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. - `auto_deployments_enabled`**Type**: `BOOLEAN`**Provider name**: `AutoDeploymentsEnabled`**Description**: 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 Amazon Web Services 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). - `code_repository`**Type**: `STRUCT`**Provider name**: `CodeRepository`**Description**: The description of a source code repository. You must provide either this member or `ImageRepository` (but not both). - `code_configuration`**Type**: `STRUCT`**Provider name**: `CodeConfiguration`**Description**: Configuration for building and running the service from a source code repository.`CodeConfiguration` is required only for `CreateService` request. - `code_configuration_values`**Type**: `STRUCT`**Provider name**: `CodeConfigurationValues`**Description**: 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). - `build_command`**Type**: `STRING`**Provider name**: `BuildCommand`**Description**: The command App Runner runs to build your application. - `port`**Type**: `STRING`**Provider name**: `Port`**Description**: The port that your application listens to in the container.**Default**: `8080` - `runtime`**Type**: `STRING`**Provider name**: `Runtime`**Description**: A runtime environment type for building and running an App Runner service. It represents a programming language runtime. - `runtime_environment_secrets`**Type**: `MAP_STRING_STRING`**Provider name**: `RuntimeEnvironmentSecrets`**Description**: 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 Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store. - If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services 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 Amazon Web Services Systems Manager Parameter Store parameter is not supported. - `runtime_environment_variables`**Type**: `MAP_STRING_STRING`**Provider name**: `RuntimeEnvironmentVariables`**Description**: The environment variables that are available to your running App Runner service. An array of key-value pairs. - `start_command`**Type**: `STRING`**Provider name**: `StartCommand`**Description**: The command App Runner runs to start your application. - `configuration_source`**Type**: `STRING`**Provider name**: `ConfigurationSource`**Description**: 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. - `repository_url`**Type**: `STRING`**Provider name**: `RepositoryUrl`**Description**: The location of the repository that contains the source code. - `source_code_version`**Type**: `STRUCT`**Provider name**: `SourceCodeVersion`**Description**: The version that should be used within the source code repository. - `type`**Type**: `STRING`**Provider name**: `Type`**Description**: The type of version identifier. For a git-based repository, branches represent versions. - `value`**Type**: `STRING`**Provider name**: `Value`**Description**: 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. - `source_directory`**Type**: `STRING`**Provider name**: `SourceDirectory`**Description**: The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root. - `image_repository`**Type**: `STRUCT`**Provider name**: `ImageRepository`**Description**: The description of a source image repository. You must provide either this member or `CodeRepository` (but not both). - `image_configuration`**Type**: `STRUCT`**Provider name**: `ImageConfiguration`**Description**: Configuration for running the identified image. - `port`**Type**: `STRING`**Provider name**: `Port`**Description**: The port that your application listens to in the container.**Default**: `8080` - `runtime_environment_secrets`**Type**: `MAP_STRING_STRING`**Provider name**: `RuntimeEnvironmentSecrets`**Description**: 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 Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store. - If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services 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 Amazon Web Services Systems Manager Parameter Store parameter is not supported. - `runtime_environment_variables`**Type**: `MAP_STRING_STRING`**Provider name**: `RuntimeEnvironmentVariables`**Description**: Environment variables that are available to your running App Runner service. An array of key-value pairs. - `start_command`**Type**: `STRING`**Provider name**: `StartCommand`**Description**: 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. - `image_identifier`**Type**: `STRING`**Provider name**: `ImageIdentifier`**Description**: 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. - `image_repository_type`**Type**: `STRING`**Provider name**: `ImageRepositoryType`**Description**: The type of the image repository. This reflects the repository provider and whether the repository is private or public. ## `status`{% #status %} **Type**: `STRING`**Provider name**: `Status`**Description**: The current state of the App Runner service. These particular values mean the following. - `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. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `updated_at`{% #updated_at %} **Type**: `TIMESTAMP`**Provider name**: `UpdatedAt`**Description**: The time when the App Runner service was last updated at. It's in the Unix time stamp format.