Package software.amazon.awscdk.services.apprunner

Class CfnService

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apprunner.CfnService
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.990Z") @Stability(Stable) public class CfnService extends CfnResource implements IInspectable
A CloudFormation AWS::AppRunner::Service.

Specify an AWS App Runner service by using the AWS::AppRunner::Service resource in an AWS CloudFormation template.

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apprunner.*;
 CfnService cfnService = CfnService.Builder.create(this, "MyCfnService")
         .sourceConfiguration(SourceConfigurationProperty.builder()
                 .authenticationConfiguration(AuthenticationConfigurationProperty.builder()
                         .accessRoleArn("accessRoleArn")
                         .connectionArn("connectionArn")
                         .build())
                 .autoDeploymentsEnabled(false)
                 .codeRepository(CodeRepositoryProperty.builder()
                         .repositoryUrl("repositoryUrl")
                         .sourceCodeVersion(SourceCodeVersionProperty.builder()
                                 .type("type")
                                 .value("value")
                                 .build())
                         // the properties below are optional
                         .codeConfiguration(CodeConfigurationProperty.builder()
                                 .configurationSource("configurationSource")
                                 // the properties below are optional
                                 .codeConfigurationValues(CodeConfigurationValuesProperty.builder()
                                         .runtime("runtime")
                                         // the properties below are optional
                                         .buildCommand("buildCommand")
                                         .port("port")
                                         .runtimeEnvironmentSecrets(List.of(KeyValuePairProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .runtimeEnvironmentVariables(List.of(KeyValuePairProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .startCommand("startCommand")
                                         .build())
                                 .build())
                         .build())
                 .imageRepository(ImageRepositoryProperty.builder()
                         .imageIdentifier("imageIdentifier")
                         .imageRepositoryType("imageRepositoryType")
                         // the properties below are optional
                         .imageConfiguration(ImageConfigurationProperty.builder()
                                 .port("port")
                                 .runtimeEnvironmentSecrets(List.of(KeyValuePairProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .runtimeEnvironmentVariables(List.of(KeyValuePairProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .startCommand("startCommand")
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .autoScalingConfigurationArn("autoScalingConfigurationArn")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKey("kmsKey")
                 .build())
         .healthCheckConfiguration(HealthCheckConfigurationProperty.builder()
                 .healthyThreshold(123)
                 .interval(123)
                 .path("path")
                 .protocol("protocol")
                 .timeout(123)
                 .unhealthyThreshold(123)
                 .build())
         .instanceConfiguration(InstanceConfigurationProperty.builder()
                 .cpu("cpu")
                 .instanceRoleArn("instanceRoleArn")
                 .memory("memory")
                 .build())
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .egressConfiguration(EgressConfigurationProperty.builder()
                         .egressType("egressType")
                         // the properties below are optional
                         .vpcConnectorArn("vpcConnectorArn")
                         .build())
                 .ingressConfiguration(IngressConfigurationProperty.builder()
                         .isPubliclyAccessible(false)
                         .build())
                 .build())
         .observabilityConfiguration(ServiceObservabilityConfigurationProperty.builder()
                 .observabilityEnabled(false)
                 // the properties below are optional
                 .observabilityConfigurationArn("observabilityConfigurationArn")
                 .build())
         .serviceName("serviceName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnService

      protected CfnService(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnService

      protected CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnService

      @Stability(Stable) public CfnService(@NotNull Construct scope, @NotNull String id, @NotNull CfnServiceProps props)
      Create a new AWS::AppRunner::Service.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrServiceArn

      @Stability(Stable) @NotNull public String getAttrServiceArn()
      The Amazon Resource Name (ARN) of this service.

    • getAttrServiceId

      @Stability(Stable) @NotNull public String getAttrServiceId()
      An ID that App Runner generated for this service.

      It's unique within the AWS Region .

    • getAttrServiceUrl

      @Stability(Stable) @NotNull public String getAttrServiceUrl()
      A subdomain URL that App Runner generated for this service.

      You can use this URL to access your service web application.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current state of the App Runner service. These particular values mean the following.

      • CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

      The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

      • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An optional list of metadata items that you can associate with the App Runner service resource.

      A tag is a key-value pair.

    • getSourceConfiguration

      @Stability(Stable) @NotNull public Object getSourceConfiguration()
      The source to deploy to the App Runner service.

      It can be a code or an image repository.

    • setSourceConfiguration

      @Stability(Stable) public void setSourceConfiguration(@NotNull IResolvable value)
      The source to deploy to the App Runner service.

      It can be a code or an image repository.

    • setSourceConfiguration

      @Stability(Stable) public void setSourceConfiguration(@NotNull CfnService.SourceConfigurationProperty value)
      The source to deploy to the App Runner service.

      It can be a code or an image repository.

    • getAutoScalingConfigurationArn

      @Stability(Stable) @Nullable public String getAutoScalingConfigurationArn()
      The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.

      If not provided, App Runner associates the latest revision of a default auto scaling configuration.

      Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3

      Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability

    • setAutoScalingConfigurationArn

      @Stability(Stable) public void setAutoScalingConfigurationArn(@Nullable String value)
      The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.

      If not provided, App Runner associates the latest revision of a default auto scaling configuration.

      Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3

      Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      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 key .

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)
      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 key .

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnService.EncryptionConfigurationProperty value)
      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 key .

    • getHealthCheckConfiguration

      @Stability(Stable) @Nullable public Object getHealthCheckConfiguration()
      The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.

    • setHealthCheckConfiguration

      @Stability(Stable) public void setHealthCheckConfiguration(@Nullable IResolvable value)
      The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.

    • setHealthCheckConfiguration

      @Stability(Stable) public void setHealthCheckConfiguration(@Nullable CfnService.HealthCheckConfigurationProperty value)
      The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.

    • getInstanceConfiguration

      @Stability(Stable) @Nullable public Object getInstanceConfiguration()
      The runtime configuration of instances (scaling units) of your service.

    • setInstanceConfiguration

      @Stability(Stable) public void setInstanceConfiguration(@Nullable IResolvable value)
      The runtime configuration of instances (scaling units) of your service.

    • setInstanceConfiguration

      @Stability(Stable) public void setInstanceConfiguration(@Nullable CfnService.InstanceConfigurationProperty value)
      The runtime configuration of instances (scaling units) of your service.

    • getNetworkConfiguration

      @Stability(Stable) @Nullable public Object getNetworkConfiguration()
      Configuration settings related to network traffic of the web application that the App Runner service runs.

    • setNetworkConfiguration

      @Stability(Stable) public void setNetworkConfiguration(@Nullable IResolvable value)
      Configuration settings related to network traffic of the web application that the App Runner service runs.

    • setNetworkConfiguration

      @Stability(Stable) public void setNetworkConfiguration(@Nullable CfnService.NetworkConfigurationProperty value)
      Configuration settings related to network traffic of the web application that the App Runner service runs.

    • getObservabilityConfiguration

      @Stability(Stable) @Nullable public Object getObservabilityConfiguration()
      The observability configuration of your service.

    • setObservabilityConfiguration

      @Stability(Stable) public void setObservabilityConfiguration(@Nullable IResolvable value)
      The observability configuration of your service.

    • setObservabilityConfiguration

      @Stability(Stable) public void setObservabilityConfiguration(@Nullable CfnService.ServiceObservabilityConfigurationProperty value)
      The observability configuration of your service.

    • getServiceName

      @Stability(Stable) @Nullable public String getServiceName()
      A name for the App Runner service.

      It must be unique across all the running App Runner services in your AWS account in the AWS Region .

      If you don't specify a name, AWS CloudFormation generates a name for your service.

    • setServiceName

      @Stability(Stable) public void setServiceName(@Nullable String value)
      A name for the App Runner service.

      It must be unique across all the running App Runner services in your AWS account in the AWS Region .

      If you don't specify a name, AWS CloudFormation generates a name for your service.