Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppRunner.Types.ImageConfiguration

Description

Documentation

data ImageConfiguration Source #

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

See: newImageConfiguration smart constructor.

Constructors

ImageConfiguration'

Fields

port :: Maybe Text
The port that your application listens to in the container.
Default: 8080
runtimeEnvironmentSecrets :: Maybe (HashMap Text (Sensitive Text))
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.
runtimeEnvironmentVariables :: Maybe (HashMap Text (Sensitive Text))
Environment variables that are available to your running App Runner service. An array of key-value pairs.
startCommand :: Maybe (Sensitive Text)
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.

Instances

Instances details

FromJSON ImageConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.ImageConfiguration Methods parseJSON :: Value -> Parser ImageConfiguration # parseJSONList :: Value -> Parser [ImageConfiguration] #
ToJSON ImageConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.ImageConfiguration Methods toJSON :: ImageConfiguration -> Value # toEncoding :: ImageConfiguration -> Encoding # toJSONList :: [ImageConfiguration] -> Value # toEncodingList :: [ImageConfiguration] -> Encoding #
Generic ImageConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.ImageConfiguration Associated Types type Rep ImageConfiguration :: Type -> Type # Methods from :: ImageConfiguration -> Rep ImageConfiguration x # to :: Rep ImageConfiguration x -> ImageConfiguration #
Show ImageConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.ImageConfiguration Methods showsPrec :: Int -> ImageConfiguration -> ShowS # show :: ImageConfiguration -> String # showList :: [ImageConfiguration] -> ShowS #
NFData ImageConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.ImageConfiguration Methods rnf :: ImageConfiguration -> () #
Eq ImageConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.ImageConfiguration Methods (==) :: ImageConfiguration -> ImageConfiguration -> Bool # (/=) :: ImageConfiguration -> ImageConfiguration -> Bool #
Hashable ImageConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.ImageConfiguration Methods hashWithSalt :: Int -> ImageConfiguration -> Int # hash :: ImageConfiguration -> Int #
type Rep ImageConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.ImageConfiguration type Rep ImageConfiguration = D1 ('MetaData "ImageConfiguration" "Amazonka.AppRunner.Types.ImageConfiguration" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "ImageConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "runtimeEnvironmentSecrets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (Sensitive Text))))) :: (S1 ('MetaSel ('Just "runtimeEnvironmentVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (Sensitive Text)))) :*: S1 ('MetaSel ('Just "startCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))

newImageConfiguration :: ImageConfiguration Source #

Create a value of ImageConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:port:ImageConfiguration', imageConfiguration_port - The port that your application listens to in the container.

Default: 8080

$sel:runtimeEnvironmentSecrets:ImageConfiguration', imageConfiguration_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.

$sel:runtimeEnvironmentVariables:ImageConfiguration', imageConfiguration_runtimeEnvironmentVariables - Environment variables that are available to your running App Runner service. An array of key-value pairs.

$sel:startCommand:ImageConfiguration', imageConfiguration_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.

imageConfiguration_port :: Lens' ImageConfiguration (Maybe Text) Source #

The port that your application listens to in the container.

Default: 8080

imageConfiguration_runtimeEnvironmentSecrets :: Lens' ImageConfiguration (Maybe (HashMap Text Text)) Source #

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.

imageConfiguration_runtimeEnvironmentVariables :: Lens' ImageConfiguration (Maybe (HashMap Text Text)) Source #

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

imageConfiguration_startCommand :: Lens' ImageConfiguration (Maybe Text) Source #

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.