Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. apprunner
  5. Service

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

aws.apprunner.Service

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

    Manages an App Runner Service.

    Example Usage

    Service with a Code Repository Source

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.AppRunner.Service("example", new()
    {
        ServiceName = "example",
        SourceConfiguration = new Aws.AppRunner.Inputs.ServiceSourceConfigurationArgs
        {
            AuthenticationConfiguration = new Aws.AppRunner.Inputs.ServiceSourceConfigurationAuthenticationConfigurationArgs
            {
                ConnectionArn = aws_apprunner_connection.Example.Arn,
            },
            CodeRepository = new Aws.AppRunner.Inputs.ServiceSourceConfigurationCodeRepositoryArgs
            {
                CodeConfiguration = new Aws.AppRunner.Inputs.ServiceSourceConfigurationCodeRepositoryCodeConfigurationArgs
                {
                    CodeConfigurationValues = new Aws.AppRunner.Inputs.ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValuesArgs
                    {
                        BuildCommand = "python setup.py develop",
                        Port = "8000",
                        Runtime = "PYTHON_3",
                        StartCommand = "python runapp.py",
                    },
                    ConfigurationSource = "API",
                },
                RepositoryUrl = "https://github.com/example/my-example-python-app",
                SourceCodeVersion = new Aws.AppRunner.Inputs.ServiceSourceConfigurationCodeRepositorySourceCodeVersionArgs
                {
                    Type = "BRANCH",
                    Value = "main",
                },
            },
        },
        NetworkConfiguration = new Aws.AppRunner.Inputs.ServiceNetworkConfigurationArgs
        {
            EgressConfiguration = new Aws.AppRunner.Inputs.ServiceNetworkConfigurationEgressConfigurationArgs
            {
                EgressType = "VPC",
                VpcConnectorArn = aws_apprunner_vpc_connector.Connector.Arn,
            },
        },
        Tags = 
        {
            { "Name", "example-apprunner-service" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/apprunner"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apprunner.NewService(ctx, "example", &apprunner.ServiceArgs{
			ServiceName: pulumi.String("example"),
			SourceConfiguration: &apprunner.ServiceSourceConfigurationArgs{
				AuthenticationConfiguration: &apprunner.ServiceSourceConfigurationAuthenticationConfigurationArgs{
					ConnectionArn: pulumi.Any(aws_apprunner_connection.Example.Arn),
				},
				CodeRepository: &apprunner.ServiceSourceConfigurationCodeRepositoryArgs{
					CodeConfiguration: &apprunner.ServiceSourceConfigurationCodeRepositoryCodeConfigurationArgs{
						CodeConfigurationValues: &apprunner.ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValuesArgs{
							BuildCommand: pulumi.String("python setup.py develop"),
							Port:         pulumi.String("8000"),
							Runtime:      pulumi.String("PYTHON_3"),
							StartCommand: pulumi.String("python runapp.py"),
						},
						ConfigurationSource: pulumi.String("API"),
					},
					RepositoryUrl: pulumi.String("https://github.com/example/my-example-python-app"),
					SourceCodeVersion: &apprunner.ServiceSourceConfigurationCodeRepositorySourceCodeVersionArgs{
						Type:  pulumi.String("BRANCH"),
						Value: pulumi.String("main"),
					},
				},
			},
			NetworkConfiguration: &apprunner.ServiceNetworkConfigurationArgs{
				EgressConfiguration: &apprunner.ServiceNetworkConfigurationEgressConfigurationArgs{
					EgressType:      pulumi.String("VPC"),
					VpcConnectorArn: pulumi.Any(aws_apprunner_vpc_connector.Connector.Arn),
				},
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-apprunner-service"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apprunner.Service;
import com.pulumi.aws.apprunner.ServiceArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationAuthenticationConfigurationArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationCodeRepositoryArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationCodeRepositoryCodeConfigurationArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValuesArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationCodeRepositorySourceCodeVersionArgs;
import com.pulumi.aws.apprunner.inputs.ServiceNetworkConfigurationArgs;
import com.pulumi.aws.apprunner.inputs.ServiceNetworkConfigurationEgressConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Service("example", ServiceArgs.builder()        
            .serviceName("example")
            .sourceConfiguration(ServiceSourceConfigurationArgs.builder()
                .authenticationConfiguration(ServiceSourceConfigurationAuthenticationConfigurationArgs.builder()
                    .connectionArn(aws_apprunner_connection.example().arn())
                    .build())
                .codeRepository(ServiceSourceConfigurationCodeRepositoryArgs.builder()
                    .codeConfiguration(ServiceSourceConfigurationCodeRepositoryCodeConfigurationArgs.builder()
                        .codeConfigurationValues(ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValuesArgs.builder()
                            .buildCommand("python setup.py develop")
                            .port("8000")
                            .runtime("PYTHON_3")
                            .startCommand("python runapp.py")
                            .build())
                        .configurationSource("API")
                        .build())
                    .repositoryUrl("https://github.com/example/my-example-python-app")
                    .sourceCodeVersion(ServiceSourceConfigurationCodeRepositorySourceCodeVersionArgs.builder()
                        .type("BRANCH")
                        .value("main")
                        .build())
                    .build())
                .build())
            .networkConfiguration(ServiceNetworkConfigurationArgs.builder()
                .egressConfiguration(ServiceNetworkConfigurationEgressConfigurationArgs.builder()
                    .egressType("VPC")
                    .vpcConnectorArn(aws_apprunner_vpc_connector.connector().arn())
                    .build())
                .build())
            .tags(Map.of("Name", "example-apprunner-service"))
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.apprunner.Service("example",
    service_name="example",
    source_configuration=aws.apprunner.ServiceSourceConfigurationArgs(
        authentication_configuration=aws.apprunner.ServiceSourceConfigurationAuthenticationConfigurationArgs(
            connection_arn=aws_apprunner_connection["example"]["arn"],
        ),
        code_repository=aws.apprunner.ServiceSourceConfigurationCodeRepositoryArgs(
            code_configuration=aws.apprunner.ServiceSourceConfigurationCodeRepositoryCodeConfigurationArgs(
                code_configuration_values=aws.apprunner.ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValuesArgs(
                    build_command="python setup.py develop",
                    port="8000",
                    runtime="PYTHON_3",
                    start_command="python runapp.py",
                ),
                configuration_source="API",
            ),
            repository_url="https://github.com/example/my-example-python-app",
            source_code_version=aws.apprunner.ServiceSourceConfigurationCodeRepositorySourceCodeVersionArgs(
                type="BRANCH",
                value="main",
            ),
        ),
    ),
    network_configuration=aws.apprunner.ServiceNetworkConfigurationArgs(
        egress_configuration=aws.apprunner.ServiceNetworkConfigurationEgressConfigurationArgs(
            egress_type="VPC",
            vpc_connector_arn=aws_apprunner_vpc_connector["connector"]["arn"],
        ),
    ),
    tags={
        "Name": "example-apprunner-service",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.apprunner.Service("example", {
    serviceName: "example",
    sourceConfiguration: {
        authenticationConfiguration: {
            connectionArn: aws_apprunner_connection.example.arn,
        },
        codeRepository: {
            codeConfiguration: {
                codeConfigurationValues: {
                    buildCommand: "python setup.py develop",
                    port: "8000",
                    runtime: "PYTHON_3",
                    startCommand: "python runapp.py",
                },
                configurationSource: "API",
            },
            repositoryUrl: "https://github.com/example/my-example-python-app",
            sourceCodeVersion: {
                type: "BRANCH",
                value: "main",
            },
        },
    },
    networkConfiguration: {
        egressConfiguration: {
            egressType: "VPC",
            vpcConnectorArn: aws_apprunner_vpc_connector.connector.arn,
        },
    },
    tags: {
        Name: "example-apprunner-service",
    },
});

    resources:
  example:
    type: aws:apprunner:Service
    properties:
      serviceName: example
      sourceConfiguration:
        authenticationConfiguration:
          connectionArn: ${aws_apprunner_connection.example.arn}
        codeRepository:
          codeConfiguration:
            codeConfigurationValues:
              buildCommand: python setup.py develop
              port: '8000'
              runtime: PYTHON_3
              startCommand: python runapp.py
            configurationSource: API
          repositoryUrl: https://github.com/example/my-example-python-app
          sourceCodeVersion:
            type: BRANCH
            value: main
      networkConfiguration:
        egressConfiguration:
          egressType: VPC
          vpcConnectorArn: ${aws_apprunner_vpc_connector.connector.arn}
      tags:
        Name: example-apprunner-service

    Service with an Image Repository Source

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.AppRunner.Service("example", new()
    {
        ServiceName = "example",
        SourceConfiguration = new Aws.AppRunner.Inputs.ServiceSourceConfigurationArgs
        {
            AutoDeploymentsEnabled = false,
            ImageRepository = new Aws.AppRunner.Inputs.ServiceSourceConfigurationImageRepositoryArgs
            {
                ImageConfiguration = new Aws.AppRunner.Inputs.ServiceSourceConfigurationImageRepositoryImageConfigurationArgs
                {
                    Port = "8000",
                },
                ImageIdentifier = "public.ecr.aws/aws-containers/hello-app-runner:latest",
                ImageRepositoryType = "ECR_PUBLIC",
            },
        },
        Tags = 
        {
            { "Name", "example-apprunner-service" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/apprunner"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apprunner.NewService(ctx, "example", &apprunner.ServiceArgs{
			ServiceName: pulumi.String("example"),
			SourceConfiguration: &apprunner.ServiceSourceConfigurationArgs{
				AutoDeploymentsEnabled: pulumi.Bool(false),
				ImageRepository: &apprunner.ServiceSourceConfigurationImageRepositoryArgs{
					ImageConfiguration: &apprunner.ServiceSourceConfigurationImageRepositoryImageConfigurationArgs{
						Port: pulumi.String("8000"),
					},
					ImageIdentifier:     pulumi.String("public.ecr.aws/aws-containers/hello-app-runner:latest"),
					ImageRepositoryType: pulumi.String("ECR_PUBLIC"),
				},
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-apprunner-service"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apprunner.Service;
import com.pulumi.aws.apprunner.ServiceArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationImageRepositoryArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationImageRepositoryImageConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Service("example", ServiceArgs.builder()        
            .serviceName("example")
            .sourceConfiguration(ServiceSourceConfigurationArgs.builder()
                .autoDeploymentsEnabled(false)
                .imageRepository(ServiceSourceConfigurationImageRepositoryArgs.builder()
                    .imageConfiguration(ServiceSourceConfigurationImageRepositoryImageConfigurationArgs.builder()
                        .port("8000")
                        .build())
                    .imageIdentifier("public.ecr.aws/aws-containers/hello-app-runner:latest")
                    .imageRepositoryType("ECR_PUBLIC")
                    .build())
                .build())
            .tags(Map.of("Name", "example-apprunner-service"))
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.apprunner.Service("example",
    service_name="example",
    source_configuration=aws.apprunner.ServiceSourceConfigurationArgs(
        auto_deployments_enabled=False,
        image_repository=aws.apprunner.ServiceSourceConfigurationImageRepositoryArgs(
            image_configuration=aws.apprunner.ServiceSourceConfigurationImageRepositoryImageConfigurationArgs(
                port="8000",
            ),
            image_identifier="public.ecr.aws/aws-containers/hello-app-runner:latest",
            image_repository_type="ECR_PUBLIC",
        ),
    ),
    tags={
        "Name": "example-apprunner-service",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.apprunner.Service("example", {
    serviceName: "example",
    sourceConfiguration: {
        autoDeploymentsEnabled: false,
        imageRepository: {
            imageConfiguration: {
                port: "8000",
            },
            imageIdentifier: "public.ecr.aws/aws-containers/hello-app-runner:latest",
            imageRepositoryType: "ECR_PUBLIC",
        },
    },
    tags: {
        Name: "example-apprunner-service",
    },
});

    resources:
  example:
    type: aws:apprunner:Service
    properties:
      serviceName: example
      sourceConfiguration:
        autoDeploymentsEnabled: false
        imageRepository:
          imageConfiguration:
            port: '8000'
          imageIdentifier: public.ecr.aws/aws-containers/hello-app-runner:latest
          imageRepositoryType: ECR_PUBLIC
      tags:
        Name: example-apprunner-service

    Service with Observability Configuration

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleObservabilityConfiguration = new Aws.AppRunner.ObservabilityConfiguration("exampleObservabilityConfiguration", new()
    {
        ObservabilityConfigurationName = "example",
        TraceConfiguration = new Aws.AppRunner.Inputs.ObservabilityConfigurationTraceConfigurationArgs
        {
            Vendor = "AWSXRAY",
        },
    });

    var exampleService = new Aws.AppRunner.Service("exampleService", new()
    {
        ServiceName = "example",
        ObservabilityConfiguration = new Aws.AppRunner.Inputs.ServiceObservabilityConfigurationArgs
        {
            ObservabilityConfigurationArn = exampleObservabilityConfiguration.Arn,
            ObservabilityEnabled = true,
        },
        SourceConfiguration = new Aws.AppRunner.Inputs.ServiceSourceConfigurationArgs
        {
            ImageRepository = new Aws.AppRunner.Inputs.ServiceSourceConfigurationImageRepositoryArgs
            {
                ImageConfiguration = new Aws.AppRunner.Inputs.ServiceSourceConfigurationImageRepositoryImageConfigurationArgs
                {
                    Port = "8000",
                },
                ImageIdentifier = "public.ecr.aws/aws-containers/hello-app-runner:latest",
                ImageRepositoryType = "ECR_PUBLIC",
            },
            AutoDeploymentsEnabled = false,
        },
        Tags = 
        {
            { "Name", "example-apprunner-service" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/apprunner"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleObservabilityConfiguration, err := apprunner.NewObservabilityConfiguration(ctx, "exampleObservabilityConfiguration", &apprunner.ObservabilityConfigurationArgs{
			ObservabilityConfigurationName: pulumi.String("example"),
			TraceConfiguration: &apprunner.ObservabilityConfigurationTraceConfigurationArgs{
				Vendor: pulumi.String("AWSXRAY"),
			},
		})
		if err != nil {
			return err
		}
		_, err = apprunner.NewService(ctx, "exampleService", &apprunner.ServiceArgs{
			ServiceName: pulumi.String("example"),
			ObservabilityConfiguration: &apprunner.ServiceObservabilityConfigurationArgs{
				ObservabilityConfigurationArn: exampleObservabilityConfiguration.Arn,
				ObservabilityEnabled:          pulumi.Bool(true),
			},
			SourceConfiguration: &apprunner.ServiceSourceConfigurationArgs{
				ImageRepository: &apprunner.ServiceSourceConfigurationImageRepositoryArgs{
					ImageConfiguration: &apprunner.ServiceSourceConfigurationImageRepositoryImageConfigurationArgs{
						Port: pulumi.String("8000"),
					},
					ImageIdentifier:     pulumi.String("public.ecr.aws/aws-containers/hello-app-runner:latest"),
					ImageRepositoryType: pulumi.String("ECR_PUBLIC"),
				},
				AutoDeploymentsEnabled: pulumi.Bool(false),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-apprunner-service"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apprunner.ObservabilityConfiguration;
import com.pulumi.aws.apprunner.ObservabilityConfigurationArgs;
import com.pulumi.aws.apprunner.inputs.ObservabilityConfigurationTraceConfigurationArgs;
import com.pulumi.aws.apprunner.Service;
import com.pulumi.aws.apprunner.ServiceArgs;
import com.pulumi.aws.apprunner.inputs.ServiceObservabilityConfigurationArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationImageRepositoryArgs;
import com.pulumi.aws.apprunner.inputs.ServiceSourceConfigurationImageRepositoryImageConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleObservabilityConfiguration = new ObservabilityConfiguration("exampleObservabilityConfiguration", ObservabilityConfigurationArgs.builder()        
            .observabilityConfigurationName("example")
            .traceConfiguration(ObservabilityConfigurationTraceConfigurationArgs.builder()
                .vendor("AWSXRAY")
                .build())
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()        
            .serviceName("example")
            .observabilityConfiguration(ServiceObservabilityConfigurationArgs.builder()
                .observabilityConfigurationArn(exampleObservabilityConfiguration.arn())
                .observabilityEnabled(true)
                .build())
            .sourceConfiguration(ServiceSourceConfigurationArgs.builder()
                .imageRepository(ServiceSourceConfigurationImageRepositoryArgs.builder()
                    .imageConfiguration(ServiceSourceConfigurationImageRepositoryImageConfigurationArgs.builder()
                        .port("8000")
                        .build())
                    .imageIdentifier("public.ecr.aws/aws-containers/hello-app-runner:latest")
                    .imageRepositoryType("ECR_PUBLIC")
                    .build())
                .autoDeploymentsEnabled(false)
                .build())
            .tags(Map.of("Name", "example-apprunner-service"))
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example_observability_configuration = aws.apprunner.ObservabilityConfiguration("exampleObservabilityConfiguration",
    observability_configuration_name="example",
    trace_configuration=aws.apprunner.ObservabilityConfigurationTraceConfigurationArgs(
        vendor="AWSXRAY",
    ))
example_service = aws.apprunner.Service("exampleService",
    service_name="example",
    observability_configuration=aws.apprunner.ServiceObservabilityConfigurationArgs(
        observability_configuration_arn=example_observability_configuration.arn,
        observability_enabled=True,
    ),
    source_configuration=aws.apprunner.ServiceSourceConfigurationArgs(
        image_repository=aws.apprunner.ServiceSourceConfigurationImageRepositoryArgs(
            image_configuration=aws.apprunner.ServiceSourceConfigurationImageRepositoryImageConfigurationArgs(
                port="8000",
            ),
            image_identifier="public.ecr.aws/aws-containers/hello-app-runner:latest",
            image_repository_type="ECR_PUBLIC",
        ),
        auto_deployments_enabled=False,
    ),
    tags={
        "Name": "example-apprunner-service",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleObservabilityConfiguration = new aws.apprunner.ObservabilityConfiguration("exampleObservabilityConfiguration", {
    observabilityConfigurationName: "example",
    traceConfiguration: {
        vendor: "AWSXRAY",
    },
});
const exampleService = new aws.apprunner.Service("exampleService", {
    serviceName: "example",
    observabilityConfiguration: {
        observabilityConfigurationArn: exampleObservabilityConfiguration.arn,
        observabilityEnabled: true,
    },
    sourceConfiguration: {
        imageRepository: {
            imageConfiguration: {
                port: "8000",
            },
            imageIdentifier: "public.ecr.aws/aws-containers/hello-app-runner:latest",
            imageRepositoryType: "ECR_PUBLIC",
        },
        autoDeploymentsEnabled: false,
    },
    tags: {
        Name: "example-apprunner-service",
    },
});

    resources:
  exampleService:
    type: aws:apprunner:Service
    properties:
      serviceName: example
      observabilityConfiguration:
        observabilityConfigurationArn: ${exampleObservabilityConfiguration.arn}
        observabilityEnabled: true
      sourceConfiguration:
        imageRepository:
          imageConfiguration:
            port: '8000'
          imageIdentifier: public.ecr.aws/aws-containers/hello-app-runner:latest
          imageRepositoryType: ECR_PUBLIC
        autoDeploymentsEnabled: false
      tags:
        Name: example-apprunner-service
  exampleObservabilityConfiguration:
    type: aws:apprunner:ObservabilityConfiguration
    properties:
      observabilityConfigurationName: example
      traceConfiguration:
        vendor: AWSXRAY

    Create Service Resource

    new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
    @overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            auto_scaling_configuration_arn: Optional[str] = None,
            encryption_configuration: Optional[ServiceEncryptionConfigurationArgs] = None,
            health_check_configuration: Optional[ServiceHealthCheckConfigurationArgs] = None,
            instance_configuration: Optional[ServiceInstanceConfigurationArgs] = None,
            network_configuration: Optional[ServiceNetworkConfigurationArgs] = None,
            observability_configuration: Optional[ServiceObservabilityConfigurationArgs] = None,
            service_name: Optional[str] = None,
            source_configuration: Optional[ServiceSourceConfigurationArgs] = None,
            tags: Optional[Mapping[str, str]] = None)
@overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: aws:apprunner:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Service Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Service resource accepts the following input properties:

    ServiceName string

    Name of the service.

    SourceConfiguration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    AutoScalingConfigurationArn string

    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.

    EncryptionConfiguration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    HealthCheckConfiguration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    InstanceConfiguration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    NetworkConfiguration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    ObservabilityConfiguration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    Tags Dictionary<string, string>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    ServiceName string

    Name of the service.

    SourceConfiguration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    AutoScalingConfigurationArn string

    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.

    EncryptionConfiguration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    HealthCheckConfiguration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    InstanceConfiguration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    NetworkConfiguration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    ObservabilityConfiguration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    Tags map[string]string

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    serviceName String

    Name of the service.

    sourceConfiguration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    autoScalingConfigurationArn String

    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.

    encryptionConfiguration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    healthCheckConfiguration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    instanceConfiguration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    networkConfiguration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    observabilityConfiguration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    tags Map<String,String>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    serviceName string

    Name of the service.

    sourceConfiguration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    autoScalingConfigurationArn string

    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.

    encryptionConfiguration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    healthCheckConfiguration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    instanceConfiguration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    networkConfiguration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    observabilityConfiguration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    tags {[key: string]: string}

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    service_name str

    Name of the service.

    source_configuration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    auto_scaling_configuration_arn str

    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.

    encryption_configuration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    health_check_configuration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    instance_configuration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    network_configuration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    observability_configuration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    tags Mapping[str, str]

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    serviceName String

    Name of the service.

    sourceConfiguration Property Map

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    autoScalingConfigurationArn String

    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.

    encryptionConfiguration Property Map

    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 CMK. See Encryption Configuration below for more details.

    healthCheckConfiguration Property Map

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    instanceConfiguration Property Map

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    networkConfiguration Property Map

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    observabilityConfiguration Property Map

    The observability configuration of your service. See Observability Configuration below for more details.

    tags Map<String>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

    Arn string

    ARN of the App Runner service.

    Id string

    The provider-assigned unique ID for this managed resource.

    ServiceId string

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    ServiceUrl string

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

    Status string

    Current state of the App Runner service.

    TagsAll Dictionary<string, string>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Arn string

    ARN of the App Runner service.

    Id string

    The provider-assigned unique ID for this managed resource.

    ServiceId string

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    ServiceUrl string

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

    Status string

    Current state of the App Runner service.

    TagsAll map[string]string

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    ARN of the App Runner service.

    id String

    The provider-assigned unique ID for this managed resource.

    serviceId String

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    serviceUrl String

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

    status String

    Current state of the App Runner service.

    tagsAll Map<String,String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn string

    ARN of the App Runner service.

    id string

    The provider-assigned unique ID for this managed resource.

    serviceId string

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    serviceUrl string

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

    status string

    Current state of the App Runner service.

    tagsAll {[key: string]: string}

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn str

    ARN of the App Runner service.

    id str

    The provider-assigned unique ID for this managed resource.

    service_id str

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    service_url str

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

    status str

    Current state of the App Runner service.

    tags_all Mapping[str, str]

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    ARN of the App Runner service.

    id String

    The provider-assigned unique ID for this managed resource.

    serviceId String

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    serviceUrl String

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

    status String

    Current state of the App Runner service.

    tagsAll Map<String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing Service Resource

    Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        auto_scaling_configuration_arn: Optional[str] = None,
        encryption_configuration: Optional[ServiceEncryptionConfigurationArgs] = None,
        health_check_configuration: Optional[ServiceHealthCheckConfigurationArgs] = None,
        instance_configuration: Optional[ServiceInstanceConfigurationArgs] = None,
        network_configuration: Optional[ServiceNetworkConfigurationArgs] = None,
        observability_configuration: Optional[ServiceObservabilityConfigurationArgs] = None,
        service_id: Optional[str] = None,
        service_name: Optional[str] = None,
        service_url: Optional[str] = None,
        source_configuration: Optional[ServiceSourceConfigurationArgs] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    ARN of the App Runner service.

    AutoScalingConfigurationArn string

    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.

    EncryptionConfiguration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    HealthCheckConfiguration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    InstanceConfiguration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    NetworkConfiguration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    ObservabilityConfiguration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    ServiceId string

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    ServiceName string

    Name of the service.

    ServiceUrl string

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

    SourceConfiguration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    Status string

    Current state of the App Runner service.

    Tags Dictionary<string, string>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Arn string

    ARN of the App Runner service.

    AutoScalingConfigurationArn string

    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.

    EncryptionConfiguration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    HealthCheckConfiguration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    InstanceConfiguration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    NetworkConfiguration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    ObservabilityConfiguration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    ServiceId string

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    ServiceName string

    Name of the service.

    ServiceUrl string

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

    SourceConfiguration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    Status string

    Current state of the App Runner service.

    Tags map[string]string

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    ARN of the App Runner service.

    autoScalingConfigurationArn String

    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.

    encryptionConfiguration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    healthCheckConfiguration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    instanceConfiguration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    networkConfiguration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    observabilityConfiguration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    serviceId String

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    serviceName String

    Name of the service.

    serviceUrl String

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

    sourceConfiguration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    status String

    Current state of the App Runner service.

    tags Map<String,String>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn string

    ARN of the App Runner service.

    autoScalingConfigurationArn string

    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.

    encryptionConfiguration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    healthCheckConfiguration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    instanceConfiguration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    networkConfiguration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    observabilityConfiguration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    serviceId string

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    serviceName string

    Name of the service.

    serviceUrl string

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

    sourceConfiguration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    status string

    Current state of the App Runner service.

    tags {[key: string]: string}

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn str

    ARN of the App Runner service.

    auto_scaling_configuration_arn str

    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.

    encryption_configuration ServiceEncryptionConfigurationArgs

    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 CMK. See Encryption Configuration below for more details.

    health_check_configuration ServiceHealthCheckConfigurationArgs

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    instance_configuration ServiceInstanceConfigurationArgs

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    network_configuration ServiceNetworkConfigurationArgs

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    observability_configuration ServiceObservabilityConfigurationArgs

    The observability configuration of your service. See Observability Configuration below for more details.

    service_id str

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    service_name str

    Name of the service.

    service_url str

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

    source_configuration ServiceSourceConfigurationArgs

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    status str

    Current state of the App Runner service.

    tags Mapping[str, str]

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    ARN of the App Runner service.

    autoScalingConfigurationArn String

    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.

    encryptionConfiguration Property Map

    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 CMK. See Encryption Configuration below for more details.

    healthCheckConfiguration Property Map

    Settings of the health check that AWS App Runner performs to monitor the health of your service. See Health Check Configuration below for more details.

    instanceConfiguration Property Map

    The runtime configuration of instances (scaling units) of the App Runner service. See Instance Configuration below for more details.

    networkConfiguration Property Map

    Configuration settings related to network traffic of the web application that the App Runner service runs. See Network Configuration below for more details.

    observabilityConfiguration Property Map

    The observability configuration of your service. See Observability Configuration below for more details.

    serviceId String

    An alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

    serviceName String

    Name of the service.

    serviceUrl String

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

    sourceConfiguration Property Map

    The source to deploy to the App Runner service. Can be a code or an image repository. See Source Configuration below for more details.

    status String

    Current state of the App Runner service.

    tags Map<String>

    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Supporting Types

    ServiceEncryptionConfiguration

    KmsKey string

    ARN of the KMS key used for encryption.

    KmsKey string

    ARN of the KMS key used for encryption.

    kmsKey String

    ARN of the KMS key used for encryption.

    kmsKey string

    ARN of the KMS key used for encryption.

    kms_key str

    ARN of the KMS key used for encryption.

    kmsKey String

    ARN of the KMS key used for encryption.

    ServiceHealthCheckConfiguration

    HealthyThreshold int

    Number of consecutive checks that must succeed before App Runner decides that the service is healthy. Defaults to 1. Minimum value of 1. Maximum value of 20.

    Interval int

    Time interval, in seconds, between health checks. Defaults to 5. Minimum value of 1. Maximum value of 20.

    Path string

    URL to send requests to for health checks. Defaults to /. Minimum length of 0. Maximum length of 51200.

    Protocol string

    IP protocol that App Runner uses to perform health checks for your service. Valid values: TCP, HTTP. Defaults to TCP. If you set protocol to HTTP, App Runner sends health check requests to the HTTP path specified by path.

    Timeout int

    Time, in seconds, to wait for a health check response before deciding it failed. Defaults to 2. Minimum value of 1. Maximum value of 20.

    UnhealthyThreshold int

    Number of consecutive checks that must fail before App Runner decides that the service is unhealthy. Defaults to 5. Minimum value of 1. Maximum value of 20.

    HealthyThreshold int

    Number of consecutive checks that must succeed before App Runner decides that the service is healthy. Defaults to 1. Minimum value of 1. Maximum value of 20.

    Interval int

    Time interval, in seconds, between health checks. Defaults to 5. Minimum value of 1. Maximum value of 20.

    Path string

    URL to send requests to for health checks. Defaults to /. Minimum length of 0. Maximum length of 51200.

    Protocol string

    IP protocol that App Runner uses to perform health checks for your service. Valid values: TCP, HTTP. Defaults to TCP. If you set protocol to HTTP, App Runner sends health check requests to the HTTP path specified by path.

    Timeout int

    Time, in seconds, to wait for a health check response before deciding it failed. Defaults to 2. Minimum value of 1. Maximum value of 20.

    UnhealthyThreshold int

    Number of consecutive checks that must fail before App Runner decides that the service is unhealthy. Defaults to 5. Minimum value of 1. Maximum value of 20.

    healthyThreshold Integer

    Number of consecutive checks that must succeed before App Runner decides that the service is healthy. Defaults to 1. Minimum value of 1. Maximum value of 20.

    interval Integer

    Time interval, in seconds, between health checks. Defaults to 5. Minimum value of 1. Maximum value of 20.

    path String

    URL to send requests to for health checks. Defaults to /. Minimum length of 0. Maximum length of 51200.

    protocol String

    IP protocol that App Runner uses to perform health checks for your service. Valid values: TCP, HTTP. Defaults to TCP. If you set protocol to HTTP, App Runner sends health check requests to the HTTP path specified by path.

    timeout Integer

    Time, in seconds, to wait for a health check response before deciding it failed. Defaults to 2. Minimum value of 1. Maximum value of 20.

    unhealthyThreshold Integer

    Number of consecutive checks that must fail before App Runner decides that the service is unhealthy. Defaults to 5. Minimum value of 1. Maximum value of 20.

    healthyThreshold number

    Number of consecutive checks that must succeed before App Runner decides that the service is healthy. Defaults to 1. Minimum value of 1. Maximum value of 20.

    interval number

    Time interval, in seconds, between health checks. Defaults to 5. Minimum value of 1. Maximum value of 20.

    path string

    URL to send requests to for health checks. Defaults to /. Minimum length of 0. Maximum length of 51200.

    protocol string

    IP protocol that App Runner uses to perform health checks for your service. Valid values: TCP, HTTP. Defaults to TCP. If you set protocol to HTTP, App Runner sends health check requests to the HTTP path specified by path.

    timeout number

    Time, in seconds, to wait for a health check response before deciding it failed. Defaults to 2. Minimum value of 1. Maximum value of 20.

    unhealthyThreshold number

    Number of consecutive checks that must fail before App Runner decides that the service is unhealthy. Defaults to 5. Minimum value of 1. Maximum value of 20.

    healthy_threshold int

    Number of consecutive checks that must succeed before App Runner decides that the service is healthy. Defaults to 1. Minimum value of 1. Maximum value of 20.

    interval int

    Time interval, in seconds, between health checks. Defaults to 5. Minimum value of 1. Maximum value of 20.

    path str

    URL to send requests to for health checks. Defaults to /. Minimum length of 0. Maximum length of 51200.

    protocol str

    IP protocol that App Runner uses to perform health checks for your service. Valid values: TCP, HTTP. Defaults to TCP. If you set protocol to HTTP, App Runner sends health check requests to the HTTP path specified by path.

    timeout int

    Time, in seconds, to wait for a health check response before deciding it failed. Defaults to 2. Minimum value of 1. Maximum value of 20.

    unhealthy_threshold int

    Number of consecutive checks that must fail before App Runner decides that the service is unhealthy. Defaults to 5. Minimum value of 1. Maximum value of 20.

    healthyThreshold Number

    Number of consecutive checks that must succeed before App Runner decides that the service is healthy. Defaults to 1. Minimum value of 1. Maximum value of 20.

    interval Number

    Time interval, in seconds, between health checks. Defaults to 5. Minimum value of 1. Maximum value of 20.

    path String

    URL to send requests to for health checks. Defaults to /. Minimum length of 0. Maximum length of 51200.

    protocol String

    IP protocol that App Runner uses to perform health checks for your service. Valid values: TCP, HTTP. Defaults to TCP. If you set protocol to HTTP, App Runner sends health check requests to the HTTP path specified by path.

    timeout Number

    Time, in seconds, to wait for a health check response before deciding it failed. Defaults to 2. Minimum value of 1. Maximum value of 20.

    unhealthyThreshold Number

    Number of consecutive checks that must fail before App Runner decides that the service is unhealthy. Defaults to 5. Minimum value of 1. Maximum value of 20.

    ServiceInstanceConfiguration

    Cpu string

    Number of CPU units reserved for each instance of your App Runner service represented as a String. Defaults to 1024. Valid values: 256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU.

    InstanceRoleArn string

    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.

    Memory string

    Amount of memory, in MB or GB, reserved for each instance of your App Runner service. Defaults to 2048. Valid values: 512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB.

    Cpu string

    Number of CPU units reserved for each instance of your App Runner service represented as a String. Defaults to 1024. Valid values: 256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU.

    InstanceRoleArn string

    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.

    Memory string

    Amount of memory, in MB or GB, reserved for each instance of your App Runner service. Defaults to 2048. Valid values: 512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB.

    cpu String

    Number of CPU units reserved for each instance of your App Runner service represented as a String. Defaults to 1024. Valid values: 256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU.

    instanceRoleArn String

    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.

    memory String

    Amount of memory, in MB or GB, reserved for each instance of your App Runner service. Defaults to 2048. Valid values: 512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB.

    cpu string

    Number of CPU units reserved for each instance of your App Runner service represented as a String. Defaults to 1024. Valid values: 256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU.

    instanceRoleArn string

    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.

    memory string

    Amount of memory, in MB or GB, reserved for each instance of your App Runner service. Defaults to 2048. Valid values: 512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB.

    cpu str

    Number of CPU units reserved for each instance of your App Runner service represented as a String. Defaults to 1024. Valid values: 256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU.

    instance_role_arn str

    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.

    memory str

    Amount of memory, in MB or GB, reserved for each instance of your App Runner service. Defaults to 2048. Valid values: 512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB.

    cpu String

    Number of CPU units reserved for each instance of your App Runner service represented as a String. Defaults to 1024. Valid values: 256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU.

    instanceRoleArn String

    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.

    memory String

    Amount of memory, in MB or GB, reserved for each instance of your App Runner service. Defaults to 2048. Valid values: 512|1024|2048|3072|4096|6144|8192|10240|12288|(0.5|1|2|3|4|6|8|10|12) GB.

    ServiceNetworkConfiguration

    EgressConfiguration ServiceNetworkConfigurationEgressConfiguration

    Network configuration settings for outbound message traffic. See Egress Configuration below for more details.

    IngressConfiguration ServiceNetworkConfigurationIngressConfiguration

    Network configuration settings for inbound network traffic. See Ingress Configuration below for more details.

    EgressConfiguration ServiceNetworkConfigurationEgressConfiguration

    Network configuration settings for outbound message traffic. See Egress Configuration below for more details.

    IngressConfiguration ServiceNetworkConfigurationIngressConfiguration

    Network configuration settings for inbound network traffic. See Ingress Configuration below for more details.

    egressConfiguration ServiceNetworkConfigurationEgressConfiguration

    Network configuration settings for outbound message traffic. See Egress Configuration below for more details.

    ingressConfiguration ServiceNetworkConfigurationIngressConfiguration

    Network configuration settings for inbound network traffic. See Ingress Configuration below for more details.

    egressConfiguration ServiceNetworkConfigurationEgressConfiguration

    Network configuration settings for outbound message traffic. See Egress Configuration below for more details.

    ingressConfiguration ServiceNetworkConfigurationIngressConfiguration

    Network configuration settings for inbound network traffic. See Ingress Configuration below for more details.

    egress_configuration ServiceNetworkConfigurationEgressConfiguration

    Network configuration settings for outbound message traffic. See Egress Configuration below for more details.

    ingress_configuration ServiceNetworkConfigurationIngressConfiguration

    Network configuration settings for inbound network traffic. See Ingress Configuration below for more details.

    egressConfiguration Property Map

    Network configuration settings for outbound message traffic. See Egress Configuration below for more details.

    ingressConfiguration Property Map

    Network configuration settings for inbound network traffic. See Ingress Configuration below for more details.

    ServiceNetworkConfigurationEgressConfiguration

    EgressType string

    The type of egress configuration. Valid values are: DEFAULT and VPC.

    VpcConnectorArn 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.

    EgressType string

    The type of egress configuration. Valid values are: DEFAULT and VPC.

    VpcConnectorArn 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.

    egressType String

    The type of egress configuration. Valid values are: DEFAULT and VPC.

    vpcConnectorArn 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.

    egressType string

    The type of egress configuration. Valid values are: DEFAULT and VPC.

    vpcConnectorArn 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.

    egress_type str

    The type of egress configuration. Valid values are: DEFAULT and VPC.

    vpc_connector_arn str

    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.

    egressType String

    The type of egress configuration. Valid values are: DEFAULT and VPC.

    vpcConnectorArn 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.

    ServiceNetworkConfigurationIngressConfiguration

    IsPubliclyAccessible bool

    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.

    IsPubliclyAccessible bool

    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.

    isPubliclyAccessible Boolean

    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.

    isPubliclyAccessible boolean

    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.

    is_publicly_accessible bool

    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.

    isPubliclyAccessible Boolean

    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.

    ServiceObservabilityConfiguration

    ObservabilityEnabled bool

    When true, an observability configuration resource is associated with the service.

    ObservabilityConfigurationArn string

    ARN of the observability configuration that is associated with the service. Specified only when observability_enabled is true.

    ObservabilityEnabled bool

    When true, an observability configuration resource is associated with the service.

    ObservabilityConfigurationArn string

    ARN of the observability configuration that is associated with the service. Specified only when observability_enabled is true.

    observabilityEnabled Boolean

    When true, an observability configuration resource is associated with the service.

    observabilityConfigurationArn String

    ARN of the observability configuration that is associated with the service. Specified only when observability_enabled is true.

    observabilityEnabled boolean

    When true, an observability configuration resource is associated with the service.

    observabilityConfigurationArn string

    ARN of the observability configuration that is associated with the service. Specified only when observability_enabled is true.

    observability_enabled bool

    When true, an observability configuration resource is associated with the service.

    observability_configuration_arn str

    ARN of the observability configuration that is associated with the service. Specified only when observability_enabled is true.

    observabilityEnabled Boolean

    When true, an observability configuration resource is associated with the service.

    observabilityConfigurationArn String

    ARN of the observability configuration that is associated with the service. Specified only when observability_enabled is true.

    ServiceSourceConfiguration

    AuthenticationConfiguration ServiceSourceConfigurationAuthenticationConfiguration

    Describes resources needed to authenticate access to some source repositories. See Authentication Configuration below for more details.

    AutoDeploymentsEnabled bool

    Whether continuous integration from the source repository is enabled for the App Runner service. If set to true, each repository change (source code commit or new image version) starts a deployment. Defaults to true.

    CodeRepository ServiceSourceConfigurationCodeRepository

    Description of a source code repository. See Code Repository below for more details.

    ImageRepository ServiceSourceConfigurationImageRepository

    Description of a source image repository. See Image Repository below for more details.

    AuthenticationConfiguration ServiceSourceConfigurationAuthenticationConfiguration

    Describes resources needed to authenticate access to some source repositories. See Authentication Configuration below for more details.

    AutoDeploymentsEnabled bool

    Whether continuous integration from the source repository is enabled for the App Runner service. If set to true, each repository change (source code commit or new image version) starts a deployment. Defaults to true.

    CodeRepository ServiceSourceConfigurationCodeRepository

    Description of a source code repository. See Code Repository below for more details.

    ImageRepository ServiceSourceConfigurationImageRepository

    Description of a source image repository. See Image Repository below for more details.

    authenticationConfiguration ServiceSourceConfigurationAuthenticationConfiguration

    Describes resources needed to authenticate access to some source repositories. See Authentication Configuration below for more details.

    autoDeploymentsEnabled Boolean

    Whether continuous integration from the source repository is enabled for the App Runner service. If set to true, each repository change (source code commit or new image version) starts a deployment. Defaults to true.

    codeRepository ServiceSourceConfigurationCodeRepository

    Description of a source code repository. See Code Repository below for more details.

    imageRepository ServiceSourceConfigurationImageRepository

    Description of a source image repository. See Image Repository below for more details.

    authenticationConfiguration ServiceSourceConfigurationAuthenticationConfiguration

    Describes resources needed to authenticate access to some source repositories. See Authentication Configuration below for more details.

    autoDeploymentsEnabled boolean

    Whether continuous integration from the source repository is enabled for the App Runner service. If set to true, each repository change (source code commit or new image version) starts a deployment. Defaults to true.

    codeRepository ServiceSourceConfigurationCodeRepository

    Description of a source code repository. See Code Repository below for more details.

    imageRepository ServiceSourceConfigurationImageRepository

    Description of a source image repository. See Image Repository below for more details.

    authentication_configuration ServiceSourceConfigurationAuthenticationConfiguration

    Describes resources needed to authenticate access to some source repositories. See Authentication Configuration below for more details.

    auto_deployments_enabled bool

    Whether continuous integration from the source repository is enabled for the App Runner service. If set to true, each repository change (source code commit or new image version) starts a deployment. Defaults to true.

    code_repository ServiceSourceConfigurationCodeRepository

    Description of a source code repository. See Code Repository below for more details.

    image_repository ServiceSourceConfigurationImageRepository

    Description of a source image repository. See Image Repository below for more details.

    authenticationConfiguration Property Map

    Describes resources needed to authenticate access to some source repositories. See Authentication Configuration below for more details.

    autoDeploymentsEnabled Boolean

    Whether continuous integration from the source repository is enabled for the App Runner service. If set to true, each repository change (source code commit or new image version) starts a deployment. Defaults to true.

    codeRepository Property Map

    Description of a source code repository. See Code Repository below for more details.

    imageRepository Property Map

    Description of a source image repository. See Image Repository below for more details.

    ServiceSourceConfigurationAuthenticationConfiguration

    AccessRoleArn string

    ARN of the IAM role that grants the App Runner service access to a source repository. Required for ECR image repositories (but not for ECR Public)

    ConnectionArn string

    ARN of the App Runner connection that enables the App Runner service to connect to a source repository. Required for GitHub code repositories.

    AccessRoleArn string

    ARN of the IAM role that grants the App Runner service access to a source repository. Required for ECR image repositories (but not for ECR Public)

    ConnectionArn string

    ARN of the App Runner connection that enables the App Runner service to connect to a source repository. Required for GitHub code repositories.

    accessRoleArn String

    ARN of the IAM role that grants the App Runner service access to a source repository. Required for ECR image repositories (but not for ECR Public)

    connectionArn String

    ARN of the App Runner connection that enables the App Runner service to connect to a source repository. Required for GitHub code repositories.

    accessRoleArn string

    ARN of the IAM role that grants the App Runner service access to a source repository. Required for ECR image repositories (but not for ECR Public)

    connectionArn string

    ARN of the App Runner connection that enables the App Runner service to connect to a source repository. Required for GitHub code repositories.

    access_role_arn str

    ARN of the IAM role that grants the App Runner service access to a source repository. Required for ECR image repositories (but not for ECR Public)

    connection_arn str

    ARN of the App Runner connection that enables the App Runner service to connect to a source repository. Required for GitHub code repositories.

    accessRoleArn String

    ARN of the IAM role that grants the App Runner service access to a source repository. Required for ECR image repositories (but not for ECR Public)

    connectionArn String

    ARN of the App Runner connection that enables the App Runner service to connect to a source repository. Required for GitHub code repositories.

    ServiceSourceConfigurationCodeRepository

    RepositoryUrl string

    Location of the repository that contains the source code.

    SourceCodeVersion ServiceSourceConfigurationCodeRepositorySourceCodeVersion

    Version that should be used within the source code repository. See Source Code Version below for more details.

    CodeConfiguration ServiceSourceConfigurationCodeRepositoryCodeConfiguration

    Configuration for building and running the service from a source code repository. See Code Configuration below for more details.

    RepositoryUrl string

    Location of the repository that contains the source code.

    SourceCodeVersion ServiceSourceConfigurationCodeRepositorySourceCodeVersion

    Version that should be used within the source code repository. See Source Code Version below for more details.

    CodeConfiguration ServiceSourceConfigurationCodeRepositoryCodeConfiguration

    Configuration for building and running the service from a source code repository. See Code Configuration below for more details.

    repositoryUrl String

    Location of the repository that contains the source code.

    sourceCodeVersion ServiceSourceConfigurationCodeRepositorySourceCodeVersion

    Version that should be used within the source code repository. See Source Code Version below for more details.

    codeConfiguration ServiceSourceConfigurationCodeRepositoryCodeConfiguration

    Configuration for building and running the service from a source code repository. See Code Configuration below for more details.

    repositoryUrl string

    Location of the repository that contains the source code.

    sourceCodeVersion ServiceSourceConfigurationCodeRepositorySourceCodeVersion

    Version that should be used within the source code repository. See Source Code Version below for more details.

    codeConfiguration ServiceSourceConfigurationCodeRepositoryCodeConfiguration

    Configuration for building and running the service from a source code repository. See Code Configuration below for more details.

    repository_url str

    Location of the repository that contains the source code.

    source_code_version ServiceSourceConfigurationCodeRepositorySourceCodeVersion

    Version that should be used within the source code repository. See Source Code Version below for more details.

    code_configuration ServiceSourceConfigurationCodeRepositoryCodeConfiguration

    Configuration for building and running the service from a source code repository. See Code Configuration below for more details.

    repositoryUrl String

    Location of the repository that contains the source code.

    sourceCodeVersion Property Map

    Version that should be used within the source code repository. See Source Code Version below for more details.

    codeConfiguration Property Map

    Configuration for building and running the service from a source code repository. See Code Configuration below for more details.

    ServiceSourceConfigurationCodeRepositoryCodeConfiguration

    ConfigurationSource string

    Source of the App Runner configuration. Valid values: REPOSITORY, API. Values are interpreted as follows:

    CodeConfigurationValues ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues

    Basic configuration for building and running the App Runner service. Use this parameter to quickly launch an App Runner service without providing an apprunner.yaml file in the source code repository (or ignoring the file if it exists). See Code Configuration Values below for more details.

    ConfigurationSource string

    Source of the App Runner configuration. Valid values: REPOSITORY, API. Values are interpreted as follows:

    CodeConfigurationValues ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues

    Basic configuration for building and running the App Runner service. Use this parameter to quickly launch an App Runner service without providing an apprunner.yaml file in the source code repository (or ignoring the file if it exists). See Code Configuration Values below for more details.

    configurationSource String

    Source of the App Runner configuration. Valid values: REPOSITORY, API. Values are interpreted as follows:

    codeConfigurationValues ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues

    Basic configuration for building and running the App Runner service. Use this parameter to quickly launch an App Runner service without providing an apprunner.yaml file in the source code repository (or ignoring the file if it exists). See Code Configuration Values below for more details.

    configurationSource string

    Source of the App Runner configuration. Valid values: REPOSITORY, API. Values are interpreted as follows:

    codeConfigurationValues ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues

    Basic configuration for building and running the App Runner service. Use this parameter to quickly launch an App Runner service without providing an apprunner.yaml file in the source code repository (or ignoring the file if it exists). See Code Configuration Values below for more details.

    configuration_source str

    Source of the App Runner configuration. Valid values: REPOSITORY, API. Values are interpreted as follows:

    code_configuration_values ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues

    Basic configuration for building and running the App Runner service. Use this parameter to quickly launch an App Runner service without providing an apprunner.yaml file in the source code repository (or ignoring the file if it exists). See Code Configuration Values below for more details.

    configurationSource String

    Source of the App Runner configuration. Valid values: REPOSITORY, API. Values are interpreted as follows:

    codeConfigurationValues Property Map

    Basic configuration for building and running the App Runner service. Use this parameter to quickly launch an App Runner service without providing an apprunner.yaml file in the source code repository (or ignoring the file if it exists). See Code Configuration Values below for more details.

    ServiceSourceConfigurationCodeRepositoryCodeConfigurationCodeConfigurationValues

    Runtime string

    Runtime environment type for building and running an App Runner service. Represents a programming language runtime. Valid values: PYTHON_3, NODEJS_12, NODEJS_14, NODEJS_16, CORRETTO_8, CORRETTO_11, GO_1, DOTNET_6, PHP_81, RUBY_31.

    BuildCommand string

    Command App Runner runs to build your application.

    Port string

    Port that your application listens to in the container. Defaults to "8080".

    RuntimeEnvironmentSecrets Dictionary<string, string>

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    RuntimeEnvironmentVariables Dictionary<string, string>

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    StartCommand string

    Command App Runner runs to start your application.

    Runtime string

    Runtime environment type for building and running an App Runner service. Represents a programming language runtime. Valid values: PYTHON_3, NODEJS_12, NODEJS_14, NODEJS_16, CORRETTO_8, CORRETTO_11, GO_1, DOTNET_6, PHP_81, RUBY_31.

    BuildCommand string

    Command App Runner runs to build your application.

    Port string

    Port that your application listens to in the container. Defaults to "8080".

    RuntimeEnvironmentSecrets map[string]string

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    RuntimeEnvironmentVariables map[string]string

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    StartCommand string

    Command App Runner runs to start your application.

    runtime String

    Runtime environment type for building and running an App Runner service. Represents a programming language runtime. Valid values: PYTHON_3, NODEJS_12, NODEJS_14, NODEJS_16, CORRETTO_8, CORRETTO_11, GO_1, DOTNET_6, PHP_81, RUBY_31.

    buildCommand String

    Command App Runner runs to build your application.

    port String

    Port that your application listens to in the container. Defaults to "8080".

    runtimeEnvironmentSecrets Map<String,String>

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    runtimeEnvironmentVariables Map<String,String>

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    startCommand String

    Command App Runner runs to start your application.

    runtime string

    Runtime environment type for building and running an App Runner service. Represents a programming language runtime. Valid values: PYTHON_3, NODEJS_12, NODEJS_14, NODEJS_16, CORRETTO_8, CORRETTO_11, GO_1, DOTNET_6, PHP_81, RUBY_31.

    buildCommand string

    Command App Runner runs to build your application.

    port string

    Port that your application listens to in the container. Defaults to "8080".

    runtimeEnvironmentSecrets {[key: string]: string}

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    runtimeEnvironmentVariables {[key: string]: string}

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    startCommand string

    Command App Runner runs to start your application.

    runtime str

    Runtime environment type for building and running an App Runner service. Represents a programming language runtime. Valid values: PYTHON_3, NODEJS_12, NODEJS_14, NODEJS_16, CORRETTO_8, CORRETTO_11, GO_1, DOTNET_6, PHP_81, RUBY_31.

    build_command str

    Command App Runner runs to build your application.

    port str

    Port that your application listens to in the container. Defaults to "8080".

    runtime_environment_secrets Mapping[str, str]

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    runtime_environment_variables Mapping[str, str]

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    start_command str

    Command App Runner runs to start your application.

    runtime String

    Runtime environment type for building and running an App Runner service. Represents a programming language runtime. Valid values: PYTHON_3, NODEJS_12, NODEJS_14, NODEJS_16, CORRETTO_8, CORRETTO_11, GO_1, DOTNET_6, PHP_81, RUBY_31.

    buildCommand String

    Command App Runner runs to build your application.

    port String

    Port that your application listens to in the container. Defaults to "8080".

    runtimeEnvironmentSecrets Map<String>

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    runtimeEnvironmentVariables Map<String>

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    startCommand String

    Command App Runner runs to start your application.

    ServiceSourceConfigurationCodeRepositorySourceCodeVersion

    Type string

    Type of version identifier. For a git-based repository, branches represent versions. Valid values: BRANCH.

    Value string

    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.

    Type string

    Type of version identifier. For a git-based repository, branches represent versions. Valid values: BRANCH.

    Value string

    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.

    type String

    Type of version identifier. For a git-based repository, branches represent versions. Valid values: BRANCH.

    value String

    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.

    type string

    Type of version identifier. For a git-based repository, branches represent versions. Valid values: BRANCH.

    value string

    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.

    type str

    Type of version identifier. For a git-based repository, branches represent versions. Valid values: BRANCH.

    value str

    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.

    type String

    Type of version identifier. For a git-based repository, branches represent versions. Valid values: BRANCH.

    value String

    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.

    ServiceSourceConfigurationImageRepository

    ImageIdentifier string

    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 in the Amazon ECR User Guide.

    ImageRepositoryType string

    Type of the image repository. This reflects the repository provider and whether the repository is private or public. Valid values: ECR , ECR_PUBLIC.

    ImageConfiguration ServiceSourceConfigurationImageRepositoryImageConfiguration

    Configuration for running the identified image. See Image Configuration below for more details.

    ImageIdentifier string

    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 in the Amazon ECR User Guide.

    ImageRepositoryType string

    Type of the image repository. This reflects the repository provider and whether the repository is private or public. Valid values: ECR , ECR_PUBLIC.

    ImageConfiguration ServiceSourceConfigurationImageRepositoryImageConfiguration

    Configuration for running the identified image. See Image Configuration below for more details.

    imageIdentifier String

    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 in the Amazon ECR User Guide.

    imageRepositoryType String

    Type of the image repository. This reflects the repository provider and whether the repository is private or public. Valid values: ECR , ECR_PUBLIC.

    imageConfiguration ServiceSourceConfigurationImageRepositoryImageConfiguration

    Configuration for running the identified image. See Image Configuration below for more details.

    imageIdentifier string

    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 in the Amazon ECR User Guide.

    imageRepositoryType string

    Type of the image repository. This reflects the repository provider and whether the repository is private or public. Valid values: ECR , ECR_PUBLIC.

    imageConfiguration ServiceSourceConfigurationImageRepositoryImageConfiguration

    Configuration for running the identified image. See Image Configuration below for more details.

    image_identifier str

    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 in the Amazon ECR User Guide.

    image_repository_type str

    Type of the image repository. This reflects the repository provider and whether the repository is private or public. Valid values: ECR , ECR_PUBLIC.

    image_configuration ServiceSourceConfigurationImageRepositoryImageConfiguration

    Configuration for running the identified image. See Image Configuration below for more details.

    imageIdentifier String

    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 in the Amazon ECR User Guide.

    imageRepositoryType String

    Type of the image repository. This reflects the repository provider and whether the repository is private or public. Valid values: ECR , ECR_PUBLIC.

    imageConfiguration Property Map

    Configuration for running the identified image. See Image Configuration below for more details.

    ServiceSourceConfigurationImageRepositoryImageConfiguration

    Port string

    Port that your application listens to in the container. Defaults to "8080".

    RuntimeEnvironmentSecrets Dictionary<string, string>

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    RuntimeEnvironmentVariables Dictionary<string, string>

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    StartCommand string

    Command App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

    Port string

    Port that your application listens to in the container. Defaults to "8080".

    RuntimeEnvironmentSecrets map[string]string

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    RuntimeEnvironmentVariables map[string]string

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    StartCommand string

    Command App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

    port String

    Port that your application listens to in the container. Defaults to "8080".

    runtimeEnvironmentSecrets Map<String,String>

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    runtimeEnvironmentVariables Map<String,String>

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    startCommand String

    Command App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

    port string

    Port that your application listens to in the container. Defaults to "8080".

    runtimeEnvironmentSecrets {[key: string]: string}

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    runtimeEnvironmentVariables {[key: string]: string}

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    startCommand string

    Command App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

    port str

    Port that your application listens to in the container. Defaults to "8080".

    runtime_environment_secrets Mapping[str, str]

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    runtime_environment_variables Mapping[str, str]

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    start_command str

    Command App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

    port String

    Port that your application listens to in the container. Defaults to "8080".

    runtimeEnvironmentSecrets Map<String>

    Secrets and parameters available to your service as environment variables. A map of key/value pairs, where the key is the desired name of the Secret in the environment (i.e. it does not have to match the name of the secret in Secrets Manager or SSM Parameter Store), and the value is the ARN of the secret from AWS Secrets Manager or the ARN of the parameter in AWS SSM Parameter Store.

    runtimeEnvironmentVariables Map<String>

    Environment variables available to your running App Runner service. A map of key/value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

    startCommand String

    Command App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

    Import

    App Runner Services can be imported by using the arn, e.g.,

     $ pulumi import aws:apprunner/service:Service example arn:aws:apprunner:us-east-1:1234567890:service/example/0a03292a89764e5882c41d8f991c82fe

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
    pulumi/pulumi-aws