com.amazonaws.services.apprunner.model

Class ImageConfiguration

java.lang.Object

com.amazonaws.services.apprunner.model.ImageConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ImageConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImageConfiguration()

Method Summary

Modifier and Type	Method and Description
ImageConfiguration	addRuntimeEnvironmentVariablesEntry(String key, String value) Add a single RuntimeEnvironmentVariables entry
ImageConfiguration	clearRuntimeEnvironmentVariablesEntries() Removes all the entries added into RuntimeEnvironmentVariables.
ImageConfiguration	clone()
boolean	equals(Object obj)
String	getPort() The port that your application listens to in the container.
Map<String,String>	getRuntimeEnvironmentVariables() Environment variables that are available to your running App Runner service.
String	getStartCommand() An optional command that App Runner runs to start the application in the source image.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setPort(String port) The port that your application listens to in the container.
void	setRuntimeEnvironmentVariables(Map<String,String> runtimeEnvironmentVariables) Environment variables that are available to your running App Runner service.
void	setStartCommand(String startCommand) An optional command that App Runner runs to start the application in the source image.
String	toString() Returns a string representation of this object.
ImageConfiguration	withPort(String port) The port that your application listens to in the container.
ImageConfiguration	withRuntimeEnvironmentVariables(Map<String,String> runtimeEnvironmentVariables) Environment variables that are available to your running App Runner service.
ImageConfiguration	withStartCommand(String startCommand) An optional command that App Runner runs to start the application in the source image.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageConfiguration

public ImageConfiguration()

Method Detail

getRuntimeEnvironmentVariables

public Map<String,String> getRuntimeEnvironmentVariables()

Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

Returns:

Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

setRuntimeEnvironmentVariables

public void setRuntimeEnvironmentVariables(Map<String,String> runtimeEnvironmentVariables)

Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

Parameters:

runtimeEnvironmentVariables - Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

withRuntimeEnvironmentVariables

public ImageConfiguration withRuntimeEnvironmentVariables(Map<String,String> runtimeEnvironmentVariables)

Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

Parameters:

runtimeEnvironmentVariables - Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

Returns:

Returns a reference to this object so that method calls can be chained together.

addRuntimeEnvironmentVariablesEntry

public ImageConfiguration addRuntimeEnvironmentVariablesEntry(String key,
                                                              String value)

Add a single RuntimeEnvironmentVariables entry

See Also:

withRuntimeEnvironmentVariables(java.util.Map<java.lang.String, java.lang.String>)

clearRuntimeEnvironmentVariablesEntries

public ImageConfiguration clearRuntimeEnvironmentVariablesEntries()

Removes all the entries added into RuntimeEnvironmentVariables.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartCommand

public void setStartCommand(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.

Parameters:

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.

getStartCommand

public String getStartCommand()

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.

withStartCommand

public ImageConfiguration withStartCommand(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setPort

public void setPort(String port)

The port that your application listens to in the container.

Default: 8080

Parameters:

port - The port that your application listens to in the container.

Default: 8080

getPort

public String getPort()

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

withPort

public ImageConfiguration withPort(String port)

The port that your application listens to in the container.

Default: 8080

Parameters:

port - The port that your application listens to in the container.

Default: 8080

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ImageConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo