Skip to content

CreateServiceRequest

Source code in docs_src/capo_apprunner/types/create_service_request.py
class CreateServiceRequest(TypedDict, closed=True):
    service_name: "capo_apprunner.types.service_name.ServiceName"
    """<p>A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.</p>"""
    source_configuration: (
        "capo_apprunner.types.source_configuration.SourceConfiguration"
    )
    """<p>The source to deploy to the App Runner service. It can be a code or an image repository.</p>"""
    instance_configuration: NotRequired[
        "capo_apprunner.types.instance_configuration.InstanceConfiguration"
    ]
    """<p>The runtime configuration of instances (scaling units) of your service.</p>"""
    tags: NotRequired["capo_apprunner.types.tag_list.TagList"]
    """<p>An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.</p>"""
    encryption_configuration: NotRequired[
        "capo_apprunner.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>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 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 the App Runner service.</p>"""
    auto_scaling_configuration_arn: NotRequired[
        "capo_apprunner.types.app_runner_resource_arn.AppRunnerResourceArn"
    ]
    """<p>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.</p> <p>Specify an ARN with a name and a revision number to associate that revision. For example: <code>arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3</code> </p> <p>Specify just the name to associate the latest revision. For example: <code>arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability</code> </p>"""
    network_configuration: NotRequired[
        "capo_apprunner.types.network_configuration.NetworkConfiguration"
    ]
    """<p>Configuration settings related to network traffic of the web application that the App Runner service runs.</p>"""
    observability_configuration: NotRequired[
        "capo_apprunner.types.service_observability_configuration.ServiceObservabilityConfiguration"
    ]
    """<p>The observability configuration of your service.</p>"""

auto_scaling_configuration_arn instance-attribute

auto_scaling_configuration_arn: NotRequired[AppRunnerResourceArn]

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

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

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 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 the App Runner service.

instance_configuration instance-attribute

instance_configuration: NotRequired[InstanceConfiguration]

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

network_configuration instance-attribute

network_configuration: NotRequired[NetworkConfiguration]

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

observability_configuration instance-attribute

observability_configuration: NotRequired[ServiceObservabilityConfiguration]

The observability configuration of your service.

service_name instance-attribute

service_name: ServiceName

A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

source_configuration instance-attribute

source_configuration: SourceConfiguration

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

tags instance-attribute

tags: NotRequired[TagList]

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.