Experimental

@aws-cdk/aws-apprunner-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AutoScalingConfiguration L2 construct

The App Runner Auto Scaling Configuration.

Stability: Experimental
CloudFormation: AWS::AppRunner::AutoScalingConfiguration
L1 type: CfnAutoScalingConfiguration
Source: lib/auto-scaling-configuration.ts

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,
});

python

auto_scaling_configuration = apprunner.AutoScalingConfiguration(self, "AutoScalingConfiguration",
    auto_scaling_configuration_name="MyAutoScalingConfiguration",
    max_concurrency=150,
    max_size=20,
    min_size=5
)

apprunner.Service(self, "DemoService",
    source=apprunner.Source.from_ecr_public(
        image_configuration=apprunner.ImageConfiguration(port=8000),
        image_identifier="public.ecr.aws/aws-containers/hello-app-runner:latest"
    ),
    auto_scaling_configuration=auto_scaling_configuration
)

java

AutoScalingConfiguration autoScalingConfiguration = AutoScalingConfiguration.Builder.create(this, "AutoScalingConfiguration")
        .autoScalingConfigurationName("MyAutoScalingConfiguration")
        .maxConcurrency(150)
        .maxSize(20)
        .minSize(5)
        .build();

Service.Builder.create(this, "DemoService")
        .source(Source.fromEcrPublic(EcrPublicProps.builder()
                .imageConfiguration(ImageConfiguration.builder().port(8000).build())
                .imageIdentifier("public.ecr.aws/aws-containers/hello-app-runner:latest")
                .build()))
        .autoScalingConfiguration(autoScalingConfiguration)
        .build();

csharp

// Install: dotnet add package Amazon.CDK.AWS.AppRunner.Alpha
var autoScalingConfiguration = new AutoScalingConfiguration(this, "AutoScalingConfiguration", new AutoScalingConfigurationProps {
    AutoScalingConfigurationName = "MyAutoScalingConfiguration",
    MaxConcurrency = 150,
    MaxSize = 20,
    MinSize = 5
});

new Service(this, "DemoService", new ServiceProps {
    Source = Source.FromEcrPublic(new EcrPublicProps {
        ImageConfiguration = new ImageConfiguration { Port = 8000 },
        ImageIdentifier = "public.ecr.aws/aws-containers/hello-app-runner:latest"
    }),
    AutoScalingConfiguration = autoScalingConfiguration
});

// Install: go get github.com/aws/aws-cdk-go/awscdkapprunneralpha/v2
autoScalingConfiguration := apprunner.NewAutoScalingConfiguration(this, jsii.String("AutoScalingConfiguration"), &AutoScalingConfigurationProps{
	AutoScalingConfigurationName: jsii.String("MyAutoScalingConfiguration"),
	MaxConcurrency: jsii.Number(150),
	MaxSize: jsii.Number(20),
	MinSize: jsii.Number(5),
})

apprunner.NewService(this, jsii.String("DemoService"), &ServiceProps{
	Source: apprunner.Source_FromEcrPublic(&EcrPublicProps{
		ImageConfiguration: &ImageConfiguration{
			Port: jsii.Number(8000),
		},
		ImageIdentifier: jsii.String("public.ecr.aws/aws-containers/hello-app-runner:latest"),
	}),
	AutoScalingConfiguration: AutoScalingConfiguration,
})

Initializer

new AutoScalingConfiguration(scope: Construct, id: string, props?: AutoScalingConfigurationProps)

python

AutoScalingConfiguration(scope: Construct, id: str, props: typing.Optional[AutoScalingConfigurationProps] = None)

java

new AutoScalingConfiguration(Construct scope, String id, AutoScalingConfigurationProps props)

csharp

new AutoScalingConfiguration(Construct scope, string id, AutoScalingConfigurationProps? props = null)

NewAutoScalingConfiguration(Scope Construct, Id *string, Props AutoScalingConfigurationProps)

Construct Props

autoScalingConfigurationNameoptionalstringauto_scaling_configuration_nameoptionalstrautoScalingConfigurationNameoptionalStringAutoScalingConfigurationNameoptionalstringAutoScalingConfigurationNameoptional*string#

The name for the Auto Scaling Configuration.

Default: a name generated by CloudFormation

maxConcurrencyoptionalnumbermax_concurrencyoptionalint | floatmaxConcurrencyoptionalNumberMaxConcurrencyoptionaldoubleMaxConcurrencyoptional*float64= 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.

maxSizeoptionalnumbermax_sizeoptionalint | floatmaxSizeoptionalNumberMaxSizeoptionaldoubleMaxSizeoptional*float64= 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.

minSizeoptionalnumbermin_sizeoptionalint | floatminSizeoptionalNumberMinSizeoptionaldoubleMinSizeoptional*float64= 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

autoScalingConfigurationArnstringauto_scaling_configuration_arnstrautoScalingConfigurationArnStringAutoScalingConfigurationArnstringAutoScalingConfigurationArn*string#

The ARN of the Auto Scaling Configuration.

autoScalingConfigurationNamestringauto_scaling_configuration_namestrautoScalingConfigurationNameStringAutoScalingConfigurationNamestringAutoScalingConfigurationName*string#

The name of the Auto Scaling Configuration.

autoScalingConfigurationRevisionnumberauto_scaling_configuration_revisionint | floatautoScalingConfigurationRevisionNumberAutoScalingConfigurationRevisiondoubleAutoScalingConfigurationRevision*float64#

The revision of the Auto Scaling Configuration.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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

fromArn(scope: Construct, id: string, autoScalingConfigurationArn: string): IAutoScalingConfiguration@staticmethod def from_arn(scope: Construct, id: str, auto_scaling_configuration_arn: str) -> IAutoScalingConfigurationpublic static IAutoScalingConfiguration fromArn(Construct scope, String id, String autoScalingConfigurationArn)public static IAutoScalingConfiguration FromArn(Construct scope, string id, string autoScalingConfigurationArn)func FromArn(Scope Construct, Id *string, AutoScalingConfigurationArn *string) IAutoScalingConfigurationstatic#

Imports an App Runner Auto Scaling Configuration from its ARN.

fromAutoScalingConfigurationAttributes(scope: Construct, id: string, attrs: AutoScalingConfigurationAttributes): IAutoScalingConfiguration

@staticmethod def from_auto_scaling_configuration_attributes(scope: Construct, id: str, attrs: AutoScalingConfigurationAttributes) -> IAutoScalingConfiguration

public static IAutoScalingConfiguration fromAutoScalingConfigurationAttributes(Construct scope, String id, AutoScalingConfigurationAttributes attrs)

public static IAutoScalingConfiguration FromAutoScalingConfigurationAttributes(Construct scope, string id, AutoScalingConfigurationAttributes attrs)

func FromAutoScalingConfigurationAttributes(Scope Construct, Id *string, Attrs AutoScalingConfigurationAttributes) IAutoScalingConfiguration

static#

Imports an App Runner Auto Scaling Configuration from attributes.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

AutoScalingConfiguration L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​