Class CodeConfigurationValues

    • Method Detail

      • 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:
        Runtime
      • 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:
        Runtime
      • 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.

      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)