Package software.amazon.awssdk.services.apprunner.model

Class CodeConfigurationValues

java.lang.Object
software.amazon.awssdk.services.apprunner.model.CodeConfigurationValues
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CodeConfigurationValues.Builder,CodeConfigurationValues>
@Generated("software.amazon.awssdk:codegen") public final class CodeConfigurationValues extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CodeConfigurationValues.Builder,CodeConfigurationValues>

Describes the basic configuration needed for building and running an App Runner service. This type doesn't support the full set of possible configuration options. Fur full configuration capabilities, use a apprunner.yaml file in the source code repository.

See Also:

  • Method Details

    • runtime

      public final Runtime runtime()

      A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

      If the service returns an enum value that is not available in the current SDK version, runtime will return Runtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runtimeAsString().

      Returns:
      A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
      See Also:

    • runtimeAsString

      public final String runtimeAsString()

      A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

      If the service returns an enum value that is not available in the current SDK version, runtime will return Runtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runtimeAsString().

      Returns:
      A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
      See Also:

    • buildCommand

      public final String buildCommand()

      The command App Runner runs to build your application.

      Returns:
      The command App Runner runs to build your application.

    • startCommand

      public final String startCommand()

      The command App Runner runs to start your application.

      Returns:
      The command App Runner runs to start your application.

    • port

      public final String port()

      The port that your application listens to in the container.

      Default: 8080

      Returns:
      The port that your application listens to in the container.

      Default: 8080

    • hasRuntimeEnvironmentVariables

      public final boolean hasRuntimeEnvironmentVariables()
      For responses, this returns true if the service returned a value for the RuntimeEnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • runtimeEnvironmentVariables

      public final Map<String,String> runtimeEnvironmentVariables()

      The environment variables that are available to your running App Runner service. An array of key-value pairs.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRuntimeEnvironmentVariables() method.

      Returns:
      The environment variables that are available to your running App Runner service. An array of key-value pairs.

    • hasRuntimeEnvironmentSecrets

      public final boolean hasRuntimeEnvironmentSecrets()
      For responses, this returns true if the service returned a value for the RuntimeEnvironmentSecrets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • runtimeEnvironmentSecrets

      public final Map<String,String> runtimeEnvironmentSecrets()

      An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

      • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.

      • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRuntimeEnvironmentSecrets() method.

      Returns:
      An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

      • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.

      • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.

    • toBuilder

      public CodeConfigurationValues.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CodeConfigurationValues.Builder,CodeConfigurationValues>
      Returns:
      a builder for type T

    • builder

      public static CodeConfigurationValues.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CodeConfigurationValues.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.