Class ImageConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ImageConfiguration.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RuntimeEnvironmentSecrets property.final boolean
For responses, this returns true if the service returned a value for the RuntimeEnvironmentVariables property.final String
port()
The port that your application listens to in the container.An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable.Environment variables that are available to your running App Runner service.static Class
<? extends ImageConfiguration.Builder> final String
An optional command that App Runner runs to start the application in the source image.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<ImageConfiguration.Builder,
ImageConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-