Skip to content

RosEciScalingConfiguration

This class is a base encapsulation around the ROS resource type ALIYUN::ESS::EciScalingConfiguration.

Initializers

import { RosEciScalingConfiguration } from '@alicloud/ros-cdk-ess'
new RosEciScalingConfiguration(scope: Construct, id: string, props: RosEciScalingConfigurationProps, enableResourcePropertyConstraint: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct - scope in which this resource is defined.
id string - scoped id of the resource.
props RosEciScalingConfigurationProps - resource properties.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

scope in which this resource is defined.


idRequired

  • Type: string

scoped id of the resource.


propsRequired

resource properties.


enableResourcePropertyConstraintRequired

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
addCondition No description.
addCount No description.
addDeletionOverride Syntactic sugar for addOverride(path, undefined).
addDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDesc No description.
addMetaData No description.
addOverride Adds an override to the synthesized ROS resource.
addPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride Adds an override to a resource property.
addRosDependency No description.
applyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
getAtt Returns a token for an runtime attribute of this resource.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: string

The new logical ID to use for this stack element.


addCondition

public addCondition(con: RosCondition): void

conRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDeletionOverride

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: string

The path of the value to delete.


addDependsOn

public addDependsOn(target: RosResource): void

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

targetRequired

  • Type: @alicloud/ros-cdk-core.RosResource

addDesc

public addDesc(desc: string): void

descRequired

  • Type: string

addMetaData

public addMetaData(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

addOverride

public addOverride(path: string, value: any): void

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


valueRequired

  • Type: any

The value.

Could be primitive or complex.


addPropertyDeletionOverride

public addPropertyDeletionOverride(propertyPath: string): void

Adds an override that deletes the value of a property from the resource definition.

propertyPathRequired

  • Type: string

The path to the property.


addPropertyOverride

public addPropertyOverride(propertyPath: string, value: any): void

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPathRequired

  • Type: string

The path of the property.


valueRequired

  • Type: any

The value.


addRosDependency

public addRosDependency(target: string): void

targetRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

optionsOptional

  • Type: @alicloud/ros-cdk-core.RemovalPolicyOptions

getAtt

public getAtt(attributeName: string): Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeNameRequired

  • Type: string

The name of the attribute.


Static Functions

Name Description
isConstruct Return whether the given object is a Construct.
isRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
isRosResource Check whether the given construct is a RosResource.

isConstruct

import { RosEciScalingConfiguration } from '@alicloud/ros-cdk-ess'
RosEciScalingConfiguration.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

isRosElement

import { RosEciScalingConfiguration } from '@alicloud/ros-cdk-ess'
RosEciScalingConfiguration.isRosElement(x: any)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

xRequired

  • Type: any

isRosResource

import { RosEciScalingConfiguration } from '@alicloud/ros-cdk-ess'
RosEciScalingConfiguration.isRosResource(construct: IConstruct)

Check whether the given construct is a RosResource.

constructRequired

  • Type: @alicloud/ros-cdk-core.IConstruct

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
creationStack string[] No description.
logicalId string The logical ID for this stack element.
stack @alicloud/ros-cdk-core.Stack The stack in which this element is defined.
ref string Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions @alicloud/ros-cdk-core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
rosResourceType string ROS resource type.
attrScalingConfigurationId @alicloud/ros-cdk-core.IResolvable No description.
containerGroupName string | @alicloud/ros-cdk-core.IResolvable No description.
enableResourcePropertyConstraint boolean No description.
scalingConfigurationName string | @alicloud/ros-cdk-core.IResolvable No description.
scalingGroupId string | @alicloud/ros-cdk-core.IResolvable No description.
securityGroupId string | @alicloud/ros-cdk-core.IResolvable No description.
acrRegistryInfos @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AcrRegistryInfosProperty[] No description.
activeDeadlineSeconds number | @alicloud/ros-cdk-core.IResolvable No description.
autoCreateEip boolean | @alicloud/ros-cdk-core.IResolvable No description.
autoMatchImageCache boolean | @alicloud/ros-cdk-core.IResolvable No description.
containers @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ContainersProperty[] No description.
costOptimization boolean | @alicloud/ros-cdk-core.IResolvable No description.
cpu number | @alicloud/ros-cdk-core.IResolvable No description.
cpuOptionsCore number | @alicloud/ros-cdk-core.IResolvable No description.
cpuOptionsThreadsPerCore number | @alicloud/ros-cdk-core.IResolvable No description.
dataCacheBucket string | @alicloud/ros-cdk-core.IResolvable No description.
dataCacheBurstingEnabled boolean | @alicloud/ros-cdk-core.IResolvable No description.
dataCachePl string | @alicloud/ros-cdk-core.IResolvable No description.
dataCacheProvisionedIops number | @alicloud/ros-cdk-core.IResolvable No description.
dnsConfigNameServers @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] No description.
dnsConfigOptions @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DnsConfigOptionsProperty[] No description.
dnsConfigSearches @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] No description.
dnsPolicy string | @alicloud/ros-cdk-core.IResolvable No description.
egressBandwidth number | @alicloud/ros-cdk-core.IResolvable No description.
eipBandwidth number | @alicloud/ros-cdk-core.IResolvable No description.
ephemeralStorage number | @alicloud/ros-cdk-core.IResolvable No description.
hostAliases @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | HostAliasesProperty[] No description.
hostName string | @alicloud/ros-cdk-core.IResolvable No description.
imageRegistryCredentials @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ImageRegistryCredentialsProperty[] No description.
imageSnapshotId string | @alicloud/ros-cdk-core.IResolvable No description.
ingressBandwidth number | @alicloud/ros-cdk-core.IResolvable No description.
initContainers @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | InitContainersProperty[] No description.
instanceFamilyLevel string | @alicloud/ros-cdk-core.IResolvable No description.
instanceTypes @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] No description.
ipv6AddressCount number | @alicloud/ros-cdk-core.IResolvable No description.
loadBalancerWeight number | @alicloud/ros-cdk-core.IResolvable No description.
memory number | @alicloud/ros-cdk-core.IResolvable No description.
ntpServers @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] No description.
ramRoleName string | @alicloud/ros-cdk-core.IResolvable No description.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable No description.
restartPolicy string | @alicloud/ros-cdk-core.IResolvable No description.
securityContextSysctls @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | SecurityContextSysctlsProperty[] No description.
spotPriceLimit number | @alicloud/ros-cdk-core.IResolvable No description.
spotStrategy string | @alicloud/ros-cdk-core.IResolvable No description.
tags TagsProperty[] No description.
terminationGracePeriodSeconds number | @alicloud/ros-cdk-core.IResolvable No description.
volumes @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | VolumesProperty[] No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


creationStackRequired

public readonly creationStack: string[];
  • Type: string[]

logicalIdRequired

public readonly logicalId: string;
  • Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


refRequired

public readonly ref: string;
  • Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


rosOptionsRequired

public readonly rosOptions: IRosResourceOptions;
  • Type: @alicloud/ros-cdk-core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


rosResourceTypeRequired

public readonly rosResourceType: string;
  • Type: string

ROS resource type.


attrScalingConfigurationIdRequired

public readonly attrScalingConfigurationId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

containerGroupNameRequired

public readonly containerGroupName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

enableResourcePropertyConstraintRequired

public readonly enableResourcePropertyConstraint: boolean;
  • Type: boolean

scalingConfigurationNameRequired

public readonly scalingConfigurationName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

scalingGroupIdRequired

public readonly scalingGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

securityGroupIdRequired

public readonly securityGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

acrRegistryInfosOptional

public readonly acrRegistryInfos: IResolvable | IResolvable | AcrRegistryInfosProperty[];

activeDeadlineSecondsOptional

public readonly activeDeadlineSeconds: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

autoCreateEipOptional

public readonly autoCreateEip: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

autoMatchImageCacheOptional

public readonly autoMatchImageCache: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

containersOptional

public readonly containers: IResolvable | IResolvable | ContainersProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ContainersProperty[]

costOptimizationOptional

public readonly costOptimization: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

cpuOptional

public readonly cpu: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

cpuOptionsCoreOptional

public readonly cpuOptionsCore: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

cpuOptionsThreadsPerCoreOptional

public readonly cpuOptionsThreadsPerCore: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

dataCacheBucketOptional

public readonly dataCacheBucket: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

dataCacheBurstingEnabledOptional

public readonly dataCacheBurstingEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

dataCachePlOptional

public readonly dataCachePl: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

dataCacheProvisionedIopsOptional

public readonly dataCacheProvisionedIops: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

dnsConfigNameServersOptional

public readonly dnsConfigNameServers: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

dnsConfigOptionsOptional

public readonly dnsConfigOptions: IResolvable | IResolvable | DnsConfigOptionsProperty[];

dnsConfigSearchesOptional

public readonly dnsConfigSearches: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

dnsPolicyOptional

public readonly dnsPolicy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

egressBandwidthOptional

public readonly egressBandwidth: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

eipBandwidthOptional

public readonly eipBandwidth: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

ephemeralStorageOptional

public readonly ephemeralStorage: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

hostAliasesOptional

public readonly hostAliases: IResolvable | IResolvable | HostAliasesProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | HostAliasesProperty[]

hostNameOptional

public readonly hostName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

imageRegistryCredentialsOptional

public readonly imageRegistryCredentials: IResolvable | IResolvable | ImageRegistryCredentialsProperty[];

imageSnapshotIdOptional

public readonly imageSnapshotId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

ingressBandwidthOptional

public readonly ingressBandwidth: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

initContainersOptional

public readonly initContainers: IResolvable | IResolvable | InitContainersProperty[];

instanceFamilyLevelOptional

public readonly instanceFamilyLevel: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

instanceTypesOptional

public readonly instanceTypes: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

ipv6AddressCountOptional

public readonly ipv6AddressCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

loadBalancerWeightOptional

public readonly loadBalancerWeight: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

memoryOptional

public readonly memory: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

ntpServersOptional

public readonly ntpServers: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

ramRoleNameOptional

public readonly ramRoleName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

resourceGroupIdOptional

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

restartPolicyOptional

public readonly restartPolicy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

securityContextSysctlsOptional

public readonly securityContextSysctls: IResolvable | IResolvable | SecurityContextSysctlsProperty[];

spotPriceLimitOptional

public readonly spotPriceLimit: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

spotStrategyOptional

public readonly spotStrategy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

tagsOptional

public readonly tags: TagsProperty[];

terminationGracePeriodSecondsOptional

public readonly terminationGracePeriodSeconds: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

volumesOptional

public readonly volumes: IResolvable | IResolvable | VolumesProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | VolumesProperty[]

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME string The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired

public readonly ROS_RESOURCE_TYPE_NAME: string;
  • Type: string

The resource type name for this resource class.