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

Class ImageConfiguration

java.lang.Object

software.amazon.awssdk.services.apprunner.model.ImageConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ImageConfiguration.Builder,ImageConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ImageConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ImageConfiguration.Builder,ImageConfiguration>

Describes the configuration that App Runner uses to run an App Runner service using an image pulled from a source image repository.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImageConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ImageConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRuntimeEnvironmentSecrets()	For responses, this returns true if the service returned a value for the RuntimeEnvironmentSecrets property.
boolean	hasRuntimeEnvironmentVariables()	For responses, this returns true if the service returned a value for the RuntimeEnvironmentVariables property.
String	port()	The port that your application listens to in the container.
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.
Map<String,String>	runtimeEnvironmentVariables()	Environment variables that are available to your running App Runner service.
List<SdkField<?>>	sdkFields()
static Class<? extends ImageConfiguration.Builder>	serializableBuilderClass()
String	startCommand()	An optional command that App Runner runs to start the application in the source image.
ImageConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

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:

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

startCommand

public final String startCommand()

An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

Returns:

An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

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

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 ImageConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImageConfiguration.Builder,ImageConfiguration>

builder

public static ImageConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ImageConfiguration.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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