Skip to content

Service

Source code in docs_src/capo_apprunner/types/service.py
class Service(TypedDict, closed=True):
    service_name: "capo_apprunner.types.service_name.ServiceName"
    """<p>The customer-provided service name.</p>"""
    service_id: "capo_apprunner.types.service_id.ServiceId"
    """<p>An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.</p>"""
    service_arn: "capo_apprunner.types.app_runner_resource_arn.AppRunnerResourceArn"
    """<p>The Amazon Resource Name (ARN) of this service.</p>"""
    service_url: NotRequired["capo_apprunner.types.string.String"]
    """<p>A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.</p>"""
    created_at: "capo_apprunner.types.timestamp.Timestamp"
    """<p>The time when the App Runner service was created. It's in the Unix time stamp format.</p>"""
    updated_at: "capo_apprunner.types.timestamp.Timestamp"
    """<p>The time when the App Runner service was last updated at. It's in the Unix time stamp format.</p>"""
    deleted_at: NotRequired["capo_apprunner.types.timestamp.Timestamp"]
    """<p>The time when the App Runner service was deleted. It's in the Unix time stamp format.</p>"""
    status: "capo_apprunner.types.service_status.ServiceStatus"
    """<p>The current state of the App Runner service. These particular values mean the following.</p> <ul> <li> <p> <code>CREATE_FAILED</code> – 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 <code>UpdateService</code>.</p> </li> <li> <p> <code>DELETE_FAILED</code> – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.</p> </li> </ul>"""
    source_configuration: (
        "capo_apprunner.types.source_configuration.SourceConfiguration"
    )
    """<p>The source deployed to the App Runner service. It can be a code or an image repository.</p>"""
    instance_configuration: (
        "capo_apprunner.types.instance_configuration.InstanceConfiguration"
    )
    """<p>The runtime configuration of instances (scaling units) of this service.</p>"""
    encryption_configuration: NotRequired[
        "capo_apprunner.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>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.</p>"""
    health_check_configuration: NotRequired[
        "capo_apprunner.types.health_check_configuration.HealthCheckConfiguration"
    ]
    """<p>The settings for the health check that App Runner performs to monitor the health of this service.</p>"""
    auto_scaling_configuration_summary: "capo_apprunner.types.auto_scaling_configuration_summary.AutoScalingConfigurationSummary"
    """<p>Summary information for the App Runner automatic scaling configuration resource that's associated with this service.</p>"""
    network_configuration: (
        "capo_apprunner.types.network_configuration.NetworkConfiguration"
    )
    """<p>Configuration settings related to network traffic of the web application that this service runs.</p>"""
    observability_configuration: NotRequired[
        "capo_apprunner.types.service_observability_configuration.ServiceObservabilityConfiguration"
    ]
    """<p>The observability configuration of this service.</p>"""

auto_scaling_configuration_summary instance-attribute

auto_scaling_configuration_summary: AutoScalingConfigurationSummary

Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

created_at instance-attribute

created_at: Timestamp

The time when the App Runner service was created. It's in the Unix time stamp format.

deleted_at instance-attribute

deleted_at: NotRequired[Timestamp]

The time when the App Runner service was deleted. It's in the Unix time stamp format.

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

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.

health_check_configuration instance-attribute

health_check_configuration: NotRequired[HealthCheckConfiguration]

The settings for the health check that App Runner performs to monitor the health of this service.

instance_configuration instance-attribute

instance_configuration: InstanceConfiguration

The runtime configuration of instances (scaling units) of this service.

network_configuration instance-attribute

network_configuration: NetworkConfiguration

Configuration settings related to network traffic of the web application that this service runs.

observability_configuration instance-attribute

observability_configuration: NotRequired[ServiceObservabilityConfiguration]

The observability configuration of this service.

service_arn instance-attribute

service_arn: AppRunnerResourceArn

The Amazon Resource Name (ARN) of this service.

service_id instance-attribute

service_id: ServiceId

An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

service_name instance-attribute

service_name: ServiceName

The customer-provided service name.

service_url instance-attribute

service_url: NotRequired[String]

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

source_configuration instance-attribute

source_configuration: SourceConfiguration

The source deployed to the App Runner service. It can be a code or an image repository.

status instance-attribute

status: ServiceStatus

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.

updated_at instance-attribute

updated_at: Timestamp

The time when the App Runner service was last updated at. It's in the Unix time stamp format.