pulumi-aws-kotlin/com.pulumi.aws.apprunner.kotlin/ServiceArgs

ServiceArgs

data class ServiceArgs(val autoScalingConfigurationArn: Output<String>? = null, val encryptionConfiguration: Output<ServiceEncryptionConfigurationArgs>? = null, val healthCheckConfiguration: Output<ServiceHealthCheckConfigurationArgs>? = null, val instanceConfiguration: Output<ServiceInstanceConfigurationArgs>? = null, val networkConfiguration: Output<ServiceNetworkConfigurationArgs>? = null, val observabilityConfiguration: Output<ServiceObservabilityConfigurationArgs>? = null, val serviceName: Output<String>? = null, val sourceConfiguration: Output<ServiceSourceConfigurationArgs>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ServiceArgs>

Manages an App Runner Service.

Example Usage

Service with a Code Repository Source

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());
    }
}
Content copied to clipboard

Service with an Image Repository Source

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());
    }
}
Content copied to clipboard

Service with Observability Configuration

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());
    }
}
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(autoScalingConfigurationArn: Output<String>? = null, encryptionConfiguration: Output<ServiceEncryptionConfigurationArgs>? = null, healthCheckConfiguration: Output<ServiceHealthCheckConfigurationArgs>? = null, instanceConfiguration: Output<ServiceInstanceConfigurationArgs>? = null, networkConfiguration: Output<ServiceNetworkConfigurationArgs>? = null, observabilityConfiguration: Output<ServiceObservabilityConfigurationArgs>? = null, serviceName: Output<String>? = null, sourceConfiguration: Output<ServiceSourceConfigurationArgs>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val autoScalingConfigurationArn: Output<String>? = null

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.

Link copied to clipboard
val encryptionConfiguration: Output<ServiceEncryptionConfigurationArgs>? = null

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.

Link copied to clipboard
val healthCheckConfiguration: Output<ServiceHealthCheckConfigurationArgs>? = null

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.

Link copied to clipboard
val instanceConfiguration: Output<ServiceInstanceConfigurationArgs>? = null

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

Link copied to clipboard
val networkConfiguration: Output<ServiceNetworkConfigurationArgs>? = null

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

Link copied to clipboard
val observabilityConfiguration: Output<ServiceObservabilityConfigurationArgs>? = null

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

Link copied to clipboard
val serviceName: Output<String>? = null

Name of the service.

Link copied to clipboard
val sourceConfiguration: Output<ServiceSourceConfigurationArgs>? = null

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): ServiceArgs