Package com.pulumi.aws.apprunner

Class Service

  • public class Service
extends com.pulumi.resources.CustomResource
    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.ArrayList;
 import java.util.Arrays;
 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()
             .sourceConfiguration(ServiceSourceConfigurationArgs.builder()
                 .authenticationConfiguration(ServiceSourceConfigurationAuthenticationConfigurationArgs.builder()
                     .connectionArn(exampleAwsApprunnerConnection.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())
                     .sourceCodeVersion(ServiceSourceConfigurationCodeRepositorySourceCodeVersionArgs.builder()
                         .type("BRANCH")
                         .value("main")
                         .build())
                     .repositoryUrl("https://github.com/example/my-example-python-app")
                     .build())
                 .build())
             .networkConfiguration(ServiceNetworkConfigurationArgs.builder()
                 .egressConfiguration(ServiceNetworkConfigurationEgressConfigurationArgs.builder()
                     .egressType("VPC")
                     .vpcConnectorArn(connector.arn())
                     .build())
                 .build())
             .serviceName("example")
             .tags(Map.of("Name", "example-apprunner-service"))
             .build());
 
     }
 }
    ### 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.ArrayList;
 import java.util.Arrays;
 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()
             .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())
             .serviceName("example")
             .tags(Map.of("Name", "example-apprunner-service"))
             .build());
 
     }
 }
    ### 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.ArrayList;
 import java.util.Arrays;
 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()
             .traceConfiguration(ObservabilityConfigurationTraceConfigurationArgs.builder()
                 .vendor("AWSXRAY")
                 .build())
             .observabilityConfigurationName("example")
             .build());
 
         var example = new Service("example", ServiceArgs.builder()
             .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())
             .serviceName("example")
             .tags(Map.of("Name", "example-apprunner-service"))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the App Runner service. Using `pulumi import`, import App Runner Services using the `arn`. For example: ```sh $ pulumi import aws:apprunner/service:Service example arn:aws:apprunner:us-east-1:1234567890:service/example/0a03292a89764e5882c41d8f991c82fe ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Service​(java.lang.String name)  
      Service​(java.lang.String name, ServiceArgs args)  
      Service​(java.lang.String name, ServiceArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Constructor Detail

      • Service

        public Service​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Service

        public Service​(java.lang.String name,
               ServiceArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Service

        public Service​(java.lang.String name,
               ServiceArgs args,
               @Nullable
               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the App Runner service.

      • autoScalingConfigurationArn

        public com.pulumi.core.Output<java.lang.String> autoScalingConfigurationArn()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<ServiceEncryptionConfiguration>> encryptionConfiguration()
        Returns:
        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 `encryptionConfiguration` below.

      • healthCheckConfiguration

        public com.pulumi.core.Output<ServiceHealthCheckConfiguration> healthCheckConfiguration()
        Returns:
        Settings of the health check that AWS App Runner performs to monitor the health of your service. See `healthCheckConfiguration` below.

      • instanceConfiguration

        public com.pulumi.core.Output<ServiceInstanceConfiguration> instanceConfiguration()
        Returns:
        Runtime configuration of instances (scaling units) of the App Runner service. See `instanceConfiguration` below.

      • networkConfiguration

        public com.pulumi.core.Output<ServiceNetworkConfiguration> networkConfiguration()
        Returns:
        Configuration settings related to network traffic of the web application that the App Runner service runs. See `networkConfiguration` below.

      • observabilityConfiguration

        public com.pulumi.core.Output<java.util.Optional<ServiceObservabilityConfiguration>> observabilityConfiguration()
        Returns:
        Observability configuration of your service. See `observabilityConfiguration` below.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • serviceId

        public com.pulumi.core.Output<java.lang.String> serviceId()
        Returns:
        Alphanumeric ID that App Runner generated for this service. Unique within the AWS Region.

      • serviceName

        public com.pulumi.core.Output<java.lang.String> serviceName()
        Returns:
        Name of the service.

      • serviceUrl

        public com.pulumi.core.Output<java.lang.String> serviceUrl()
        Returns:
        Subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

      • sourceConfiguration

        public com.pulumi.core.Output<ServiceSourceConfiguration> sourceConfiguration()
        Returns:
        Source to deploy to the App Runner service. Can be a code or an image repository. See `sourceConfiguration` below.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Current state of the App Runner service.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Service get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          ServiceState state,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.