Skip to content

ServiceMesh

This class encapsulates and extends the ROS resource type ALIYUN::ASM::ServiceMesh, which is used to create an Alibaba Cloud Service Mesh (ASM) instance.

Initializers 

import ros_cdk_asm
ros_cdk_asm.ServiceMesh(
  scope: Construct,
  id: str,
  vpc_id: typing.Union[str, IResolvable],
  v_switches: typing.Union[typing.List[typing.Any], IResolvable],
  api_server_public_eip: typing.Union[bool, IResolvable] = None,
  audit_project: typing.Union[str, IResolvable] = None,
  customized_zipkin: typing.Union[bool, IResolvable] = None,
  enable_audit: typing.Union[bool, IResolvable] = None,
  include_ip_ranges: typing.Union[str, IResolvable] = None,
  istio_version: typing.Union[str, IResolvable] = None,
  locality_load_balancing: typing.Union[bool, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  opa: typing.Union[IResolvable, OPAProperty] = None,
  outbound_traffic_policy: typing.Union[str, IResolvable] = None,
  pilot_public_eip: typing.Union[bool, IResolvable] = None,
  proxy: typing.Union[IResolvable, ProxyProperty] = None,
  telemetry: typing.Union[bool, IResolvable] = None,
  trace_sampling: typing.Union[typing.Union[int, float], IResolvable] = None,
  tracing: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the virtual private cloud (VPC).
v_switches typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] Property vSwitches: The ID of the vSwitch, eg: ["vsw-xzegf5dndkbf4m6eg****"].
api_server_public_eip typing.Union[bool, ros_cdk_core.IResolvable] Property apiServerPublicEip: Specifies whether to expose the API server to the Internet.
audit_project typing.Union[str, ros_cdk_core.IResolvable] Property auditProject: The name of the Log Service project that is used for mesh audit.
customized_zipkin typing.Union[bool, ros_cdk_core.IResolvable] Property customizedZipkin: Specifies whether to use a user-created Zipkin system.
enable_audit typing.Union[bool, ros_cdk_core.IResolvable] Property enableAudit: Specifies whether to enable the mesh audit feature.
include_ip_ranges typing.Union[str, ros_cdk_core.IResolvable] Property includeIpRanges: The Classless Inter-Domain Routing (CIDR) block in the ASM instance that are denied to access external services.
istio_version typing.Union[str, ros_cdk_core.IResolvable] Property istioVersion: The Istio version of the ASM instance.
locality_load_balancing typing.Union[bool, ros_cdk_core.IResolvable] Property localityLoadBalancing: Specifies whether to route traffic to the nearest instance.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the ASM instance.
opa typing.Union[ros_cdk_core.IResolvable, OPAProperty] Property opa: OPA settings.
outbound_traffic_policy typing.Union[str, ros_cdk_core.IResolvable] Property outboundTrafficPolicy: The outbound traffic policy of the ASM instance.
pilot_public_eip typing.Union[bool, ros_cdk_core.IResolvable] Property pilotPublicEip: Specifies whether to expose Istio Pilot to the Internet.
proxy typing.Union[ros_cdk_core.IResolvable, ProxyProperty] Property proxy: Proxy settings.
telemetry typing.Union[bool, ros_cdk_core.IResolvable] Property telemetry: Specifies whether to enable Prometheus monitoring.
trace_sampling typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property traceSampling: The sampling percentage of tracing.
tracing typing.Union[bool, ros_cdk_core.IResolvable] Property tracing: Specifies whether to enable the tracing feature.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

vpc_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The ID of the virtual private cloud (VPC).

v_switchesRequired

  • Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property vSwitches: The ID of the vSwitch, eg: ["vsw-xzegf5dndkbf4m6eg****"].

api_server_public_eipOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property apiServerPublicEip: Specifies whether to expose the API server to the Internet.

Valid values: true and false. Default value: false. If you do not set this parameter, the API server of clusters added to the ASM instance cannot be accessed from the Internet.

audit_projectOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property auditProject: The name of the Log Service project that is used for mesh audit.

Default value: mesh-log-{meshId}.

customized_zipkinOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property customizedZipkin: Specifies whether to use a user-created Zipkin system.

enable_auditOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableAudit: Specifies whether to enable the mesh audit feature.

To enable this feature, make sure that you have activated Alibaba Cloud Log Service. Valid values: true and false. Default value: false.

include_ip_rangesOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property includeIpRanges: The Classless Inter-Domain Routing (CIDR) block in the ASM instance that are denied to access external services.

istio_versionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property istioVersion: The Istio version of the ASM instance.

locality_load_balancingOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property localityLoadBalancing: Specifies whether to route traffic to the nearest instance.

Valid values: true and false. Default value: false.

nameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name of the ASM instance.

opaOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, OPAProperty]

Property opa: OPA settings.

outbound_traffic_policyOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property outboundTrafficPolicy: The outbound traffic policy of the ASM instance.

pilot_public_eipOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property pilotPublicEip: Specifies whether to expose Istio Pilot to the Internet.

Valid values: true and false. Default value: false. If you do not set this parameter, only clusters in the same VPC as the ASM instance can access Istio Pilot of the instance.

proxyOptional

Property proxy: Proxy settings.

telemetryOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property telemetry: Specifies whether to enable Prometheus monitoring.

We recommend that you use Application Real-Time Monitoring Service (ARMS).

trace_samplingOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property traceSampling: The sampling percentage of tracing.

tracingOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property tracing: Specifies whether to enable the tracing feature.

To enable this feature, make sure that you have activated Alibaba Cloud Tracing Analysis. Valid values: true and false. Default value: false.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_asm
ros_cdk_asm.ServiceMesh.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_service_mesh_id ros_cdk_core.IResolvable Attribute ServiceMeshId: The ID of the ASM instance.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_service_mesh_idRequired 

attr_service_mesh_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ServiceMeshId: The ID of the ASM instance.

Structs