ServiceMesh

• Implements: IServiceMesh

This class encapsulates and extends the ROS resource type ALIYUN::ASM::ServiceMesh.

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],
  access_log_enabled: typing.Union[bool, IResolvable] = None,
  access_log_file: typing.Union[str, IResolvable] = None,
  access_log_format: typing.Union[str, IResolvable] = None,
  access_log_project: typing.Union[str, IResolvable] = None,
  access_log_service_enabled: typing.Union[bool, IResolvable] = None,
  access_log_service_host: typing.Union[str, IResolvable] = None,
  access_log_service_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  api_server_load_balancer_spec: typing.Union[str, IResolvable] = None,
  api_server_public_eip: typing.Union[bool, IResolvable] = None,
  audit_project: typing.Union[str, IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  cert_chain: typing.Union[str, IResolvable] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  cluster_spec: typing.Union[str, IResolvable] = None,
  config_source_enabled: typing.Union[bool, IResolvable] = None,
  config_source_nacos_id: typing.Union[str, IResolvable] = None,
  control_plane_log_enabled: typing.Union[bool, IResolvable] = None,
  control_plane_log_project: typing.Union[str, IResolvable] = None,
  cr_aggregation_enabled: typing.Union[bool, IResolvable] = None,
  customized_prometheus: typing.Union[bool, IResolvable] = None,
  customized_zipkin: typing.Union[bool, IResolvable] = None,
  dns_proxying_enabled: typing.Union[bool, IResolvable] = None,
  dubbo_filter_enabled: typing.Union[bool, IResolvable] = None,
  edition: typing.Union[str, IResolvable] = None,
  enable_acmg: typing.Union[bool, IResolvable] = None,
  enable_ambient: typing.Union[bool, IResolvable] = None,
  enable_audit: typing.Union[bool, IResolvable] = None,
  enable_cr_history: typing.Union[bool, IResolvable] = None,
  enable_sds_server: typing.Union[bool, IResolvable] = None,
  exclude_inbound_ports: typing.Union[str, IResolvable] = None,
  exclude_ip_ranges: typing.Union[str, IResolvable] = None,
  exclude_outbound_ports: typing.Union[str, IResolvable] = None,
  existing_ca_cert: typing.Union[str, IResolvable] = None,
  existing_ca_key: typing.Union[str, IResolvable] = None,
  existing_ca_type: typing.Union[str, IResolvable] = None,
  existing_root_ca_cert: typing.Union[str, IResolvable] = None,
  existing_root_ca_key: typing.Union[str, IResolvable] = None,
  filter_gateway_cluster_config: typing.Union[bool, IResolvable] = None,
  gateway_api_enabled: typing.Union[bool, IResolvable] = None,
  guest_cluster: typing.Union[str, IResolvable] = None,
  include_ip_ranges: typing.Union[str, IResolvable] = None,
  istio_version: typing.Union[str, IResolvable] = None,
  kiali_enabled: typing.Union[bool, IResolvable] = None,
  locality_lb_conf: typing.Union[str, IResolvable] = None,
  locality_load_balancing: typing.Union[bool, IResolvable] = None,
  mse_enabled: typing.Union[bool, IResolvable] = None,
  multi_buffer_enabled: typing.Union[bool, IResolvable] = None,
  multi_buffer_poll_delay: typing.Union[str, IResolvable] = None,
  mysql_filter_enabled: typing.Union[bool, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  opa: typing.Union[IResolvable, OPAProperty] = None,
  opa_enabled: typing.Union[bool, IResolvable] = None,
  outbound_traffic_policy: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  pilot_load_balancer_spec: typing.Union[str, IResolvable] = None,
  pilot_public_eip: typing.Union[bool, IResolvable] = None,
  playground_scene: typing.Union[str, IResolvable] = None,
  prometheus_url: typing.Union[str, 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,
  use_existing_ca: typing.Union[bool, IResolvable] = None,
  web_assembly_filter_enabled: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

vpc_id^Required

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

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

v_switches^Required

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

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

access_log_enabled^Optional

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

Property accessLogEnabled: Specifies whether to enable access log.

Valid values:

• true: Enables access log.
• false: Disables access log. Default value: false.

access_log_file^Optional

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

Property accessLogFile: Enable and disable access logs.

Value:

• "" : Turn off access logs.
• /dev/stdout: Enables access logging

access_log_format^Optional

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

Property accessLogFormat: The custom format of access logs.

This parameter is available only if you enable access log. The value must be a JSON string that contains the following keys: authority_for, bytes_received, bytes_sent, downstream_local_address, downstream_remote_address, duration, istio_policy_status, method, path, protocol, requested_server_name, response_code, response_flags, route_name, start_time, trace_id, upstream_cluster, upstream_host, upstream_local_address, upstream_service_time, upstream_transport_failure_reason, user_agent, and x_forwarded_for.

access_log_project^Optional

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

Property accessLogProject: The Log Service project for access logs.

access_log_service_enabled^Optional

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

Property accessLogServiceEnabled: Whether Envoy's gRPC logging service (ALS) is enabled.

Value:

• true: Enables Envoy's gRPC logging service.
• false: Envoy's gRPC logging service is not enabled. Default value: false

access_log_service_host^Optional

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

Property accessLogServiceHost: Address where Envoy's gRPC logging service (ALS) is enabled.

access_log_service_port^Optional

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

Property accessLogServicePort: Port on which Envoy's gRPC logging service (ALS) is enabled.

api_server_load_balancer_spec^Optional

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

Property apiServerLoadBalancerSpec: CLB specification for the APIServer binding.

Value: Compact type I (slb.s1.small), Standard type I (slb.s2.small), Standard Type II (slb.s2.medium), high-order type I (slb.s3.small), high-order type II (slb.s3.medium), Super type I (slb.s3.large).

api_server_public_eip^Optional

• 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_project^Optional

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

auto_renew^Optional

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

Property autoRenew: If CLB is annual and monthly, whether it will be automatically renewed.

Value:

• true: Automatic renewal.
• false: No automatic renewal.

auto_renew_period^Optional

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

Property autoRenewPeriod: This parameter is valid only if you set ChargeType to PrePay.

The auto-renewal period. If the subscription duration is less than one year, the value of this parameter indicates the number of months for which you want to renew the instance. If the subscription duration is more than one year, the value of this parameter indicates the number of years for which you want to renew the instance.

cert_chain^Optional

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

Property certChain: The certificate chain from CaCert to RootCert contains at least two certificates.

charge_type^Optional

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

Property chargeType: CLB payment type.

Value:

• PayOnDemand: pay-as-you-go type
• PrePay: Annual and monthly.

cluster_spec^Optional

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

Property clusterSpec: Service grid instance specification, value: - standard: The standard version.

• enterprise: Enterprise Edition
• ultimate: ultimate.

config_source_enabled^Optional

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

Property configSourceEnabled: Whether to enable an external service registry.

Value:

• true: Enables the external service registry.
• false: The external service registry is not enabled. Default value: false

config_source_nacos_id^Optional

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

Property configSourceNacosId: The Nacos ID for config source.

control_plane_log_enabled^Optional

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

Property controlPlaneLogEnabled: Specifies whether to enable control plane log collection.

Valid values:

• true: Enables control plane log collection.
• false: Disables control plane log collection. Default value: false.

control_plane_log_project^Optional

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

Property controlPlaneLogProject: The Log Service project for control plane logs.

cr_aggregation_enabled^Optional

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

Property crAggregationEnabled: Whether to enable Kubernetes API for data plane cluster to access Istio resources (ASM instance v1.9.7.93 or later). Value: - true: Enable data plane cluster Kubernetes API to access Istio resources. - false: Data plane cluster Kubernetes API is not enabled to access Istio resources. Default value: false.

customized_prometheus^Optional

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

Property customizedPrometheus: Specifies whether to use a self-managed Prometheus system.

Valid values:

• true: Uses a self-managed Prometheus system.
• false: Does not use a self-managed Prometheus system. Default value: false.

customized_zipkin^Optional

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

Property customizedZipkin: Specifies whether to use a self-managed Zipkin system.

Valid values:

• true: Uses a self-managed Zipkin system.
• false: Uses Tracing Analysis. Default value: false.

dns_proxying_enabled^Optional

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

Property dnsProxyingEnabled: Specifies whether to enable DNS proxy.

Valid values:

• true: Enables DNS proxy.
• false: Disables DNS proxy. Default value: false.

dubbo_filter_enabled^Optional

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

Property dubboFilterEnabled: Specifies whether to enable the Dubbo filter.

Valid values:

• true: Enables the Dubbo filter.
• false: Disables the Dubbo filter. Default value: false.

edition^Optional

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

Property edition: The edition of the ASM instance.

enable_acmg^Optional

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

Property enableAcmg: Specifies whether to enable ACMG.

enable_ambient^Optional

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

Property enableAmbient: Specifies whether to enable ambient mode.

enable_audit^Optional

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

enable_cr_history^Optional

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

Property enableCrHistory: Specifies whether to enable the history version management feature for Istio resources in ASM.

Valid values:

• true: Enables the history version management feature.
• false: Disables the history version management feature. Default value: false.

enable_sds_server^Optional

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

Property enableSdsServer: Specifies whether to enable the Secret Discovery Service (SDS).

Valid values:

• true: Enables SDS.
• false: Disables SDS. Default value: false.

exclude_inbound_ports^Optional

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

Property excludeInboundPorts: The inbound ports to exclude from traffic management.

exclude_ip_ranges^Optional

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

Property excludeIpRanges: The IP ranges to exclude from traffic management.

exclude_outbound_ports^Optional

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

Property excludeOutboundPorts: The outbound ports to exclude from traffic management.

existing_ca_cert^Optional

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

Property existingCaCert: The existing CA certificate.

existing_ca_key^Optional

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

Property existingCaKey: The existing CA key.

existing_ca_type^Optional

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

Property existingCaType: The type of the existing certificate: - 1: A self-signed certificate of Istiod.

This corresponds to the istio-ca-secret secret in the istio-system namespace. If you use this type, you must also provide the ExistingCaCert and ExsitingCaKey parameters.

• 2: An external certificate of Istiod. For more information, see plugin ca cert. This generally corresponds to the cacerts secret in the istio-system namespace. If you use this type, you must also provide the ExisingRootCaCert and ExisingRootCaKey parameters.

existing_root_ca_cert^Optional

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

Property existingRootCaCert: The existing root CA certificate.

existing_root_ca_key^Optional

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

Property existingRootCaKey: The existing root CA key.

filter_gateway_cluster_config^Optional

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

Property filterGatewayClusterConfig: Specifies whether to enable gateway configuration filtering.

Valid values:

• true: Enables gateway configuration filtering.
• false: Disables gateway configuration filtering. Default value: false.

gateway_api_enabled^Optional

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

Property gatewayApiEnabled: Specifies whether to enable the Gateway API.

Valid values:

• true: Enables the Gateway API.
• false: Disables the Gateway API. Default value: false.

guest_cluster^Optional

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

Property guestCluster: When you create a Service Mesh instance, you can add a cluster to the instance.

If you do not specify this parameter, no cluster is added. The cluster must be in the same VPC and vSwitch as the Service Mesh instance, and must have the same domain name.

include_ip_ranges^Optional

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

Property includeIpRanges: The IP address ranges that are allowed to access the proxy.

istio_version^Optional

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

Property istioVersion: The Istio version of the ASM instance.

kiali_enabled^Optional

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

Property kialiEnabled: Specifies whether to enable the mesh topology feature.

To enable this feature, you must first enable Prometheus monitoring. If Prometheus monitoring is disabled, this feature is forcibly disabled. Valid values:

• true: Enables the mesh topology feature.
• false: Disables the mesh topology feature. Default value: false.

locality_lb_conf^Optional

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

Property localityLbConf: The locality load balancing configuration.

locality_load_balancing^Optional

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

mse_enabled^Optional

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

Property mseEnabled: Specifies whether to enable Microservices Engine (MSE).

Valid values:

• true: Enables MSE.
• false: Disables MSE. Default value: false.

multi_buffer_enabled^Optional

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

Property multiBufferEnabled: Specifies whether to enable TLS performance optimization that is based on MultiBuffer.

Valid values:

• true: Enables the feature.
• false: Disables the feature. Default value: true.

multi_buffer_poll_delay^Optional

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

Property multiBufferPollDelay: The synchronization period of the MultiBuffer enabling status.

Default value: 30s.

mysql_filter_enabled^Optional

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

Property mysqlFilterEnabled: Specifies whether to enable the MySQL filter.

Valid values:

• true: Enables the MySQL filter.
• false: Disables the MySQL filter. Default value: false.

name^Optional

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

Property name: The name of the ASM instance.

opa^Optional

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

Property opa: OPA settings.

opa_enabled^Optional

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

Property opaEnabled: Specifies whether to enable OPA.

Valid values:

• true: Enables OPA.
• false: Disables OPA. Default value: false.

outbound_traffic_policy^Optional

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

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

period^Optional

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

Property period: This parameter is valid only if you set ChargeType to PrePay.

The subscription duration of the SLB instance. Unit: months. If you want to purchase the instance for one year, enter 12.

pilot_load_balancer_spec^Optional

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

Property pilotLoadBalancerSpec: The specification of the SLB instance that is bound to Istio Pilot of the control plane.

Valid values: slb.s1.small, slb.s2.small, slb.s2.medium, slb.s3.small, slb.s3.medium, and slb.s3.large.

pilot_public_eip^Optional

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

playground_scene^Optional

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

Property playgroundScene: The playground scenario.

If you specify this parameter, an ASM playground instance is created. Valid value:

• ewmaLb: the exponentially weighted moving average (EWMA) load balancing scenario

prometheus_url^Optional

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

Property prometheusUrl: The URL for Prometheus.

proxy^Optional

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

Property proxy: Proxy settings.

telemetry^Optional

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

Property telemetry: Specifies whether to enable Prometheus monitoring.

We recommend that you use Managed Service for Prometheus. Valid values:

• true: Enables Prometheus monitoring.
• false: Disables Prometheus monitoring. Default value: false.

trace_sampling^Optional

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

Property traceSampling: The sampling percentage of tracing.

tracing^Optional

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

use_existing_ca^Optional

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

Property useExistingCa: Specifies whether to use an existing CA.

web_assembly_filter_enabled^Optional

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

Property webAssemblyFilterEnabled: Specifies whether to enable the WebAssembly filter.

Valid values:

• true: Enables the WebAssembly filter.
• false: Disables the WebAssembly filter. Default value: false.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_service_mesh_id^Required

attr_service_mesh_id: typing.Union[str, IResolvable]

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

Attribute ServiceMeshId: The ID of the ASM instance.

props^Required

props: ServiceMeshProps

• Type: ServiceMeshProps

Structs