RosServiceMesh

This class is a base encapsulation around the ROS resource type ALIYUN::ASM::ServiceMesh.

Initializers

import { RosServiceMesh } from '@alicloud/ros-cdk-asm'
new RosServiceMesh(scope: Construct, id: string, props: RosServiceMeshProps, enableResourcePropertyConstraint: boolean)

scope^Required

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

scope in which this resource is defined.

id^Required

• Type: string

scoped id of the resource.

props^Required

• Type: RosServiceMeshProps

resource properties.

enableResourcePropertyConstraint^Required

• Type: boolean

Methods

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.

session^Required

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

addCondition

public addCondition(con: RosCondition): void

con^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDeletionOverride

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

path^Required

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

target^Required

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

addDesc

public addDesc(desc: string): void

desc^Required

• Type: string

addMetaData

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

key^Required

• Type: string

value^Required

• 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"
       ...
     },
   ]
   ...
}

path^Required

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

value^Required

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

propertyPath^Required

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

propertyPath^Required

• Type: string

The path of the property.

value^Required

• Type: any

The value.

addRosDependency

public addRosDependency(target: string): void

target^Required

• Type: string

applyRemovalPolicy

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

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

policy^Optional

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

options^Optional

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

fetchCondition

public fetchCondition(): RosCondition

fetchDesc

public fetchDesc(): string

fetchRosDependency

public fetchRosDependency(): string[]

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.

attributeName^Required

• Type: string

The name of the attribute.

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

isRosElement

import { RosServiceMesh } from '@alicloud/ros-cdk-asm'
RosServiceMesh.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.

x^Required

• Type: any

isRosResource

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

Check whether the given construct is a RosResource.

construct^Required

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

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

logicalId^Required

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

stack^Required

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

ref^Required

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

rosOptions^Required

public readonly rosOptions: IRosResourceOptions;

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

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

rosResourceType^Required

public readonly rosResourceType: string;

• Type: string

ROS resource type.

attrServiceMeshId^Required

public readonly attrServiceMeshId: IResolvable;

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

enableResourcePropertyConstraint^Required

public readonly enableResourcePropertyConstraint: boolean;

• Type: boolean

vpcId^Required

public readonly vpcId: string | IResolvable;

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

vSwitches^Required

public readonly vSwitches: any[] | IResolvable;

• Type: any[] | @alicloud/ros-cdk-core.IResolvable

accessLogEnabled^Optional

public readonly accessLogEnabled: boolean | IResolvable;

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

accessLogFile^Optional

public readonly accessLogFile: string | IResolvable;

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

accessLogFormat^Optional

public readonly accessLogFormat: string | IResolvable;

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

accessLogProject^Optional

public readonly accessLogProject: string | IResolvable;

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

accessLogServiceEnabled^Optional

public readonly accessLogServiceEnabled: boolean | IResolvable;

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

accessLogServiceHost^Optional

public readonly accessLogServiceHost: string | IResolvable;

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

accessLogServicePort^Optional

public readonly accessLogServicePort: number | IResolvable;

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

apiServerLoadBalancerSpec^Optional

public readonly apiServerLoadBalancerSpec: string | IResolvable;

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

apiServerPublicEip^Optional

public readonly apiServerPublicEip: boolean | IResolvable;

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

auditProject^Optional

public readonly auditProject: string | IResolvable;

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

autoRenew^Optional

public readonly autoRenew: boolean | IResolvable;

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

autoRenewPeriod^Optional

public readonly autoRenewPeriod: number | IResolvable;

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

certChain^Optional

public readonly certChain: string | IResolvable;

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

chargeType^Optional

public readonly chargeType: string | IResolvable;

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

clusterSpec^Optional

public readonly clusterSpec: string | IResolvable;

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

configSourceEnabled^Optional

public readonly configSourceEnabled: boolean | IResolvable;

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

configSourceNacosId^Optional

public readonly configSourceNacosId: string | IResolvable;

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

controlPlaneLogEnabled^Optional

public readonly controlPlaneLogEnabled: boolean | IResolvable;

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

controlPlaneLogProject^Optional

public readonly controlPlaneLogProject: string | IResolvable;

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

crAggregationEnabled^Optional

public readonly crAggregationEnabled: boolean | IResolvable;

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

customizedPrometheus^Optional

public readonly customizedPrometheus: boolean | IResolvable;

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

customizedZipkin^Optional

public readonly customizedZipkin: boolean | IResolvable;

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

dnsProxyingEnabled^Optional

public readonly dnsProxyingEnabled: boolean | IResolvable;

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

dubboFilterEnabled^Optional

public readonly dubboFilterEnabled: boolean | IResolvable;

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

edition^Optional

public readonly edition: string | IResolvable;

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

enableAcmg^Optional

public readonly enableAcmg: boolean | IResolvable;

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

enableAmbient^Optional

public readonly enableAmbient: boolean | IResolvable;

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

enableAudit^Optional

public readonly enableAudit: boolean | IResolvable;

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

enableCrHistory^Optional

public readonly enableCrHistory: boolean | IResolvable;

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

enableSdsServer^Optional

public readonly enableSdsServer: boolean | IResolvable;

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

excludeInboundPorts^Optional

public readonly excludeInboundPorts: string | IResolvable;

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

excludeIpRanges^Optional

public readonly excludeIpRanges: string | IResolvable;

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

excludeOutboundPorts^Optional

public readonly excludeOutboundPorts: string | IResolvable;

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

existingCaCert^Optional

public readonly existingCaCert: string | IResolvable;

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

existingCaKey^Optional

public readonly existingCaKey: string | IResolvable;

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

existingCaType^Optional

public readonly existingCaType: string | IResolvable;

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

existingRootCaCert^Optional

public readonly existingRootCaCert: string | IResolvable;

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

existingRootCaKey^Optional

public readonly existingRootCaKey: string | IResolvable;

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

filterGatewayClusterConfig^Optional

public readonly filterGatewayClusterConfig: boolean | IResolvable;

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

gatewayApiEnabled^Optional

public readonly gatewayApiEnabled: boolean | IResolvable;

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

guestCluster^Optional

public readonly guestCluster: string | IResolvable;

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

includeIpRanges^Optional

public readonly includeIpRanges: string | IResolvable;

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

istioVersion^Optional

public readonly istioVersion: string | IResolvable;

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

kialiEnabled^Optional

public readonly kialiEnabled: boolean | IResolvable;

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

localityLbConf^Optional

public readonly localityLbConf: string | IResolvable;

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

localityLoadBalancing^Optional

public readonly localityLoadBalancing: boolean | IResolvable;

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

mseEnabled^Optional

public readonly mseEnabled: boolean | IResolvable;

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

multiBufferEnabled^Optional

public readonly multiBufferEnabled: boolean | IResolvable;

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

multiBufferPollDelay^Optional

public readonly multiBufferPollDelay: string | IResolvable;

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

mysqlFilterEnabled^Optional

public readonly mysqlFilterEnabled: boolean | IResolvable;

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

name^Optional

public readonly name: string | IResolvable;

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

opa^Optional

public readonly opa: IResolvable | OPAProperty;

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

opaEnabled^Optional

public readonly opaEnabled: boolean | IResolvable;

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

outboundTrafficPolicy^Optional

public readonly outboundTrafficPolicy: string | IResolvable;

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

period^Optional

public readonly period: number | IResolvable;

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

pilotLoadBalancerSpec^Optional

public readonly pilotLoadBalancerSpec: string | IResolvable;

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

pilotPublicEip^Optional

public readonly pilotPublicEip: boolean | IResolvable;

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

playgroundScene^Optional

public readonly playgroundScene: string | IResolvable;

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

prometheusUrl^Optional

public readonly prometheusUrl: string | IResolvable;

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

proxy^Optional

public readonly proxy: IResolvable | ProxyProperty;

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

telemetry^Optional

public readonly telemetry: boolean | IResolvable;

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

traceSampling^Optional

public readonly traceSampling: number | IResolvable;

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

tracing^Optional

public readonly tracing: boolean | IResolvable;

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

useExistingCa^Optional

public readonly useExistingCa: boolean | IResolvable;

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

webAssemblyFilterEnabled^Optional

public readonly webAssemblyFilterEnabled: boolean | IResolvable;

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

Constants

ROS_RESOURCE_TYPE_NAME^Required

public readonly ROS_RESOURCE_TYPE_NAME: string;

• Type: string

The resource type name for this resource class.