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.CreateAutoScalingConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.

Create multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName. The call returns incremental AutoScalingConfigurationRevision values. When you create a service and configure an auto scaling configuration resource, the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific revision.

Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.

Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.

Synopsis

Creating a Request

data CreateAutoScalingConfiguration Source #

See: newCreateAutoScalingConfiguration smart constructor.

Constructors

CreateAutoScalingConfiguration'

Fields

maxConcurrency :: Maybe Natural
The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales up your service.
Default: 100
maxSize :: Maybe Natural
The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traffic for your service.
Default: 25
minSize :: Maybe Natural
The minimum number of instances that App Runner provisions for your service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.
App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
Default: 1
tags :: Maybe [Tag]
A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.
autoScalingConfigurationName :: Text
A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
The name DefaultConfiguration is reserved (it's the configuration that App Runner uses if you don't provide a custome one). You can't use it to create a new auto scaling configuration, and you can't create a revision of it.
When you want to use your own auto scaling configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.

Instances

Instances details

ToJSON CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods toJSON :: CreateAutoScalingConfiguration -> Value # toEncoding :: CreateAutoScalingConfiguration -> Encoding # toJSONList :: [CreateAutoScalingConfiguration] -> Value # toEncodingList :: [CreateAutoScalingConfiguration] -> Encoding #
ToHeaders CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods toHeaders :: CreateAutoScalingConfiguration -> [Header] #
ToPath CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods toPath :: CreateAutoScalingConfiguration -> ByteString #
ToQuery CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods toQuery :: CreateAutoScalingConfiguration -> QueryString #
AWSRequest CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Associated Types type AWSResponse CreateAutoScalingConfiguration # Methods request :: (Service -> Service) -> CreateAutoScalingConfiguration -> Request CreateAutoScalingConfiguration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAutoScalingConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAutoScalingConfiguration))) #
Generic CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Associated Types type Rep CreateAutoScalingConfiguration :: Type -> Type # Methods from :: CreateAutoScalingConfiguration -> Rep CreateAutoScalingConfiguration x # to :: Rep CreateAutoScalingConfiguration x -> CreateAutoScalingConfiguration #
Read CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods readsPrec :: Int -> ReadS CreateAutoScalingConfiguration # readList :: ReadS [CreateAutoScalingConfiguration] # readPrec :: ReadPrec CreateAutoScalingConfiguration # readListPrec :: ReadPrec [CreateAutoScalingConfiguration] #
Show CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods showsPrec :: Int -> CreateAutoScalingConfiguration -> ShowS # show :: CreateAutoScalingConfiguration -> String # showList :: [CreateAutoScalingConfiguration] -> ShowS #
NFData CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods rnf :: CreateAutoScalingConfiguration -> () #
Eq CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods (==) :: CreateAutoScalingConfiguration -> CreateAutoScalingConfiguration -> Bool # (/=) :: CreateAutoScalingConfiguration -> CreateAutoScalingConfiguration -> Bool #
Hashable CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods hashWithSalt :: Int -> CreateAutoScalingConfiguration -> Int # hash :: CreateAutoScalingConfiguration -> Int #
type AWSResponse CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration type AWSResponse CreateAutoScalingConfiguration = CreateAutoScalingConfigurationResponse
type Rep CreateAutoScalingConfiguration Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration type Rep CreateAutoScalingConfiguration = D1 ('MetaData "CreateAutoScalingConfiguration" "Amazonka.AppRunner.CreateAutoScalingConfiguration" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "CreateAutoScalingConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxConcurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "maxSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "minSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "autoScalingConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateAutoScalingConfiguration Source #

Arguments

:: Text	`CreateAutoScalingConfiguration`
-> CreateAutoScalingConfiguration

Create a value of CreateAutoScalingConfiguration 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:

CreateAutoScalingConfiguration, createAutoScalingConfiguration_maxConcurrency - The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales up your service.

Default: 100

CreateAutoScalingConfiguration, createAutoScalingConfiguration_maxSize - The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traffic for your service.

Default: 25

CreateAutoScalingConfiguration, createAutoScalingConfiguration_minSize - The minimum number of instances that App Runner provisions for your service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

Default: 1

$sel:tags:CreateAutoScalingConfiguration', createAutoScalingConfiguration_tags - A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.

CreateAutoScalingConfiguration, createAutoScalingConfiguration_autoScalingConfigurationName - A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

The name DefaultConfiguration is reserved (it's the configuration that App Runner uses if you don't provide a custome one). You can't use it to create a new auto scaling configuration, and you can't create a revision of it.

When you want to use your own auto scaling configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.

Request Lenses

createAutoScalingConfiguration_maxConcurrency :: Lens' CreateAutoScalingConfiguration (Maybe Natural) Source #

The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales up your service.

Default: 100

createAutoScalingConfiguration_maxSize :: Lens' CreateAutoScalingConfiguration (Maybe Natural) Source #

The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traffic for your service.

Default: 25

createAutoScalingConfiguration_minSize :: Lens' CreateAutoScalingConfiguration (Maybe Natural) Source #

The minimum number of instances that App Runner provisions for your service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

Default: 1

createAutoScalingConfiguration_tags :: Lens' CreateAutoScalingConfiguration (Maybe [Tag]) Source #

A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.

createAutoScalingConfiguration_autoScalingConfigurationName :: Lens' CreateAutoScalingConfiguration Text Source #

A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

The name DefaultConfiguration is reserved (it's the configuration that App Runner uses if you don't provide a custome one). You can't use it to create a new auto scaling configuration, and you can't create a revision of it.

When you want to use your own auto scaling configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.

Destructuring the Response

data CreateAutoScalingConfigurationResponse Source #

See: newCreateAutoScalingConfigurationResponse smart constructor.

Constructors

CreateAutoScalingConfigurationResponse'
Fields httpStatus :: Int The response's http status code. autoScalingConfiguration :: AutoScalingConfiguration A description of the App Runner auto scaling configuration that's created by this request.

Instances

Instances details

Generic CreateAutoScalingConfigurationResponse Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Associated Types type Rep CreateAutoScalingConfigurationResponse :: Type -> Type # Methods from :: CreateAutoScalingConfigurationResponse -> Rep CreateAutoScalingConfigurationResponse x # to :: Rep CreateAutoScalingConfigurationResponse x -> CreateAutoScalingConfigurationResponse #
Read CreateAutoScalingConfigurationResponse Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods readsPrec :: Int -> ReadS CreateAutoScalingConfigurationResponse # readList :: ReadS [CreateAutoScalingConfigurationResponse] # readPrec :: ReadPrec CreateAutoScalingConfigurationResponse # readListPrec :: ReadPrec [CreateAutoScalingConfigurationResponse] #
Show CreateAutoScalingConfigurationResponse Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods showsPrec :: Int -> CreateAutoScalingConfigurationResponse -> ShowS # show :: CreateAutoScalingConfigurationResponse -> String # showList :: [CreateAutoScalingConfigurationResponse] -> ShowS #
NFData CreateAutoScalingConfigurationResponse Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods rnf :: CreateAutoScalingConfigurationResponse -> () #
Eq CreateAutoScalingConfigurationResponse Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration Methods (==) :: CreateAutoScalingConfigurationResponse -> CreateAutoScalingConfigurationResponse -> Bool # (/=) :: CreateAutoScalingConfigurationResponse -> CreateAutoScalingConfigurationResponse -> Bool #
type Rep CreateAutoScalingConfigurationResponse Source #
Instance details Defined in Amazonka.AppRunner.CreateAutoScalingConfiguration type Rep CreateAutoScalingConfigurationResponse = D1 ('MetaData "CreateAutoScalingConfigurationResponse" "Amazonka.AppRunner.CreateAutoScalingConfiguration" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "CreateAutoScalingConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "autoScalingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AutoScalingConfiguration)))

newCreateAutoScalingConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAutoScalingConfigurationResponse'`
-> AutoScalingConfiguration	`$sel:autoScalingConfiguration:CreateAutoScalingConfigurationResponse'`
-> CreateAutoScalingConfigurationResponse

Create a value of CreateAutoScalingConfigurationResponse 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:httpStatus:CreateAutoScalingConfigurationResponse', createAutoScalingConfigurationResponse_httpStatus - The response's http status code.

$sel:autoScalingConfiguration:CreateAutoScalingConfigurationResponse', createAutoScalingConfigurationResponse_autoScalingConfiguration - A description of the App Runner auto scaling configuration that's created by this request.

Response Lenses

createAutoScalingConfigurationResponse_httpStatus :: Lens' CreateAutoScalingConfigurationResponse Int Source #

The response's http status code.

createAutoScalingConfigurationResponse_autoScalingConfiguration :: Lens' CreateAutoScalingConfigurationResponse AutoScalingConfiguration Source #

A description of the App Runner auto scaling configuration that's created by this request.