@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ImageConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Describes the configuration that App Runner uses to run an App Runner service using an image pulled from a source image repository.
Constructor and Description |
---|
ImageConfiguration() |
Modifier and Type | Method and Description |
---|---|
ImageConfiguration |
addRuntimeEnvironmentSecretsEntry(String key,
String value)
Add a single RuntimeEnvironmentSecrets entry
|
ImageConfiguration |
addRuntimeEnvironmentVariablesEntry(String key,
String value)
Add a single RuntimeEnvironmentVariables entry
|
ImageConfiguration |
clearRuntimeEnvironmentSecretsEntries()
Removes all the entries added into RuntimeEnvironmentSecrets.
|
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> |
getRuntimeEnvironmentSecrets()
An array of key-value pairs representing the secrets and parameters that get referenced to your service as an
environment variable.
|
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)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setPort(String port)
The port that your application listens to in the container.
|
void |
setRuntimeEnvironmentSecrets(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.
|
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 |
withRuntimeEnvironmentSecrets(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.
|
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.
|
public Map<String,String> getRuntimeEnvironmentVariables()
Environment variables that are available to your running App Runner service. An array of key-value pairs.
public void setRuntimeEnvironmentVariables(Map<String,String> runtimeEnvironmentVariables)
Environment variables that are available to your running App Runner service. An array of key-value pairs.
runtimeEnvironmentVariables
- Environment variables that are available to your running App Runner service. An array of key-value pairs.public ImageConfiguration withRuntimeEnvironmentVariables(Map<String,String> runtimeEnvironmentVariables)
Environment variables that are available to your running App Runner service. An array of key-value pairs.
runtimeEnvironmentVariables
- Environment variables that are available to your running App Runner service. An array of key-value pairs.public ImageConfiguration addRuntimeEnvironmentVariablesEntry(String key, String value)
public ImageConfiguration clearRuntimeEnvironmentVariablesEntries()
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.
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.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.
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.
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.public void setPort(String port)
The port that your application listens to in the container.
Default: 8080
port
- The port that your application listens to in the container.
Default: 8080
public String getPort()
The port that your application listens to in the container.
Default: 8080
Default: 8080
public ImageConfiguration withPort(String port)
The port that your application listens to in the container.
Default: 8080
port
- The port that your application listens to in the container.
Default: 8080
public Map<String,String> getRuntimeEnvironmentSecrets()
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.
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.
public void setRuntimeEnvironmentSecrets(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.
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.
public ImageConfiguration withRuntimeEnvironmentSecrets(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.
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.
public ImageConfiguration addRuntimeEnvironmentSecretsEntry(String key, String value)
public ImageConfiguration clearRuntimeEnvironmentSecretsEntries()
public String toString()
toString
in class Object
Object.toString()
public ImageConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.