amazonka-apprunner-2.0: Amazon App Runner SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppRunner.Types.CodeConfigurationValues

Description

 
Synopsis

Documentation

data CodeConfigurationValues Source #

Describes the basic configuration needed for building and running an App Runner service. This type doesn't support the full set of possible configuration options. Fur full configuration capabilities, use a apprunner.yaml file in the source code repository.

See: newCodeConfigurationValues smart constructor.

Constructors

CodeConfigurationValues' 

Fields

  • buildCommand :: Maybe (Sensitive Text)

    The command App Runner runs to build your application.

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

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

  • startCommand :: Maybe (Sensitive Text)

    The command App Runner runs to start your application.

  • runtime :: Runtime

    A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

Instances

Instances details
FromJSON CodeConfigurationValues Source # 
Instance details

Defined in Amazonka.AppRunner.Types.CodeConfigurationValues

ToJSON CodeConfigurationValues Source # 
Instance details

Defined in Amazonka.AppRunner.Types.CodeConfigurationValues

Generic CodeConfigurationValues Source # 
Instance details

Defined in Amazonka.AppRunner.Types.CodeConfigurationValues

Associated Types

type Rep CodeConfigurationValues :: Type -> Type #

Show CodeConfigurationValues Source # 
Instance details

Defined in Amazonka.AppRunner.Types.CodeConfigurationValues

NFData CodeConfigurationValues Source # 
Instance details

Defined in Amazonka.AppRunner.Types.CodeConfigurationValues

Methods

rnf :: CodeConfigurationValues -> () #

Eq CodeConfigurationValues Source # 
Instance details

Defined in Amazonka.AppRunner.Types.CodeConfigurationValues

Hashable CodeConfigurationValues Source # 
Instance details

Defined in Amazonka.AppRunner.Types.CodeConfigurationValues

type Rep CodeConfigurationValues Source # 
Instance details

Defined in Amazonka.AppRunner.Types.CodeConfigurationValues

type Rep CodeConfigurationValues = D1 ('MetaData "CodeConfigurationValues" "Amazonka.AppRunner.Types.CodeConfigurationValues" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "CodeConfigurationValues'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "buildCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (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))) :*: S1 ('MetaSel ('Just "runtime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Runtime)))))

newCodeConfigurationValues Source #

Create a value of CodeConfigurationValues 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:buildCommand:CodeConfigurationValues', codeConfigurationValues_buildCommand - The command App Runner runs to build your application.

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

Default: 8080

$sel:runtimeEnvironmentSecrets:CodeConfigurationValues', codeConfigurationValues_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:CodeConfigurationValues', codeConfigurationValues_runtimeEnvironmentVariables - The environment variables that are available to your running App Runner service. An array of key-value pairs.

$sel:startCommand:CodeConfigurationValues', codeConfigurationValues_startCommand - The command App Runner runs to start your application.

$sel:runtime:CodeConfigurationValues', codeConfigurationValues_runtime - A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

codeConfigurationValues_buildCommand :: Lens' CodeConfigurationValues (Maybe Text) Source #

The command App Runner runs to build your application.

codeConfigurationValues_port :: Lens' CodeConfigurationValues (Maybe Text) Source #

The port that your application listens to in the container.

Default: 8080

codeConfigurationValues_runtimeEnvironmentSecrets :: Lens' CodeConfigurationValues (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.

codeConfigurationValues_runtimeEnvironmentVariables :: Lens' CodeConfigurationValues (Maybe (HashMap Text Text)) Source #

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

codeConfigurationValues_startCommand :: Lens' CodeConfigurationValues (Maybe Text) Source #

The command App Runner runs to start your application.

codeConfigurationValues_runtime :: Lens' CodeConfigurationValues Runtime Source #

A runtime environment type for building and running an App Runner service. It represents a programming language runtime.