class AutoScalingConfiguration (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppRunner.Alpha.AutoScalingConfiguration |
![]() | github.com/aws/aws-cdk-go/awscdkapprunneralpha/v2#AutoScalingConfiguration |
![]() | software.amazon.awscdk.services.apprunner.alpha.AutoScalingConfiguration |
![]() | aws_cdk.aws_apprunner_alpha.AutoScalingConfiguration |
![]() | @aws-cdk/aws-apprunner-alpha ยป AutoScalingConfiguration |
Implements
IConstruct
, IDependable
, IResource
, IAuto
The App Runner Auto Scaling Configuration.
Example
const autoScalingConfiguration = new apprunner.AutoScalingConfiguration(this, 'AutoScalingConfiguration', {
autoScalingConfigurationName: 'MyAutoScalingConfiguration',
maxConcurrency: 150,
maxSize: 20,
minSize: 5,
});
new apprunner.Service(this, 'DemoService', {
source: apprunner.Source.fromEcrPublic({
imageConfiguration: { port: 8000 },
imageIdentifier: 'public.ecr.aws/aws-containers/hello-app-runner:latest',
}),
autoScalingConfiguration,
});
Initializer
new AutoScalingConfiguration(scope: Construct, id: string, props?: AutoScalingConfigurationProps)
Parameters
- scope
Construct
- id
string
- props
Auto
Scaling Configuration Props
Construct Props
Name | Type | Description |
---|---|---|
auto | string | The name for the Auto Scaling Configuration. |
max | number | The maximum number of concurrent requests that an instance processes. |
max | number | The maximum number of instances that a service scales up to. |
min | number | The minimum number of instances that App Runner provisions for a service. |
autoScalingConfigurationName?
Type:
string
(optional, default: a name generated by CloudFormation)
The name for the Auto Scaling Configuration.
maxConcurrency?
Type:
number
(optional, default: 100)
The maximum number of concurrent requests that an instance processes.
If the number of concurrent requests exceeds this limit, App Runner scales the service up.
Must be between 1 and 200.
maxSize?
Type:
number
(optional, default: 25)
The maximum number of instances that a service scales up to.
At most maxSize instances actively serve traffic for your service.
Must be between 1 and 25.
minSize?
Type:
number
(optional, default: 1)
The minimum number of instances that App Runner provisions for a service.
The service always has at least minSize provisioned instances.
Must be between 1 and 25.
Properties
Name | Type | Description |
---|---|---|
auto | string | The ARN of the Auto Scaling Configuration. |
auto | string | The name of the Auto Scaling Configuration. |
auto | number | The revision of the Auto Scaling Configuration. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
autoScalingConfigurationArn
Type:
string
The ARN of the Auto Scaling Configuration.
autoScalingConfigurationName
Type:
string
The name of the Auto Scaling Configuration.
autoScalingConfigurationRevision
Type:
number
The revision of the Auto Scaling Configuration.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Imports an App Runner Auto Scaling Configuration from its ARN. |
static from | Imports an App Runner Auto Scaling Configuration from attributes. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromArn(scope, id, autoScalingConfigurationArn)
public static fromArn(scope: Construct, id: string, autoScalingConfigurationArn: string): IAutoScalingConfiguration
Parameters
- scope
Construct
- id
string
- autoScalingConfigurationArn
string
Returns
Imports an App Runner Auto Scaling Configuration from its ARN.
static fromAutoScalingConfigurationAttributes(scope, id, attrs)
public static fromAutoScalingConfigurationAttributes(scope: Construct, id: string, attrs: AutoScalingConfigurationAttributes): IAutoScalingConfiguration
Parameters
- scope
Construct
- id
string
- attrs
Auto
Scaling Configuration Attributes
Returns
Imports an App Runner Auto Scaling Configuration from attributes.