ServiceMeshProps

Properties for defining a ServiceMesh.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-asm-servicemesh

Initializer

import ros_cdk_asm
ros_cdk_asm.ServiceMeshProps(
  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
)

Properties

vpc_id^Required

vpc_id: typing.Union[str, IResolvable]

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

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

v_switches^Required

v_switches: typing.Union[typing.List[typing.Any], IResolvable]

• 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

access_log_enabled: typing.Union[bool, IResolvable]

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

Property accessLogEnabled: Specifies whether to enable access logging.

access_log_file^Optional

access_log_file: typing.Union[str, IResolvable]

• 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

access_log_format: typing.Union[str, IResolvable]

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

Property accessLogFormat: The format of access logs.

access_log_project^Optional

access_log_project: typing.Union[str, IResolvable]

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

Property accessLogProject: The Log Service project for access logs.

access_log_service_enabled^Optional

access_log_service_enabled: typing.Union[bool, IResolvable]

• 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

access_log_service_host: typing.Union[str, IResolvable]

• 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

access_log_service_port: typing.Union[typing.Union[int, float], IResolvable]

• 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

api_server_load_balancer_spec: typing.Union[str, IResolvable]

• 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

api_server_public_eip: typing.Union[bool, IResolvable]

• 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

audit_project: typing.Union[str, IResolvable]

• 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

auto_renew: typing.Union[bool, IResolvable]

• 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

auto_renew_period: typing.Union[typing.Union[int, float], IResolvable]

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

Property autoRenewPeriod: ChargeType is a PrePay.

Indicates the automatic renewal time when purchasing a CLB of the year and month type. If the purchase is less than 1 year old, this parameter indicates how many months the auto-renewal will take. If the purchase is longer than 1 year, this parameter indicates how many years the automatic renewal will be made.

cert_chain^Optional

cert_chain: typing.Union[str, IResolvable]

• 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

charge_type: typing.Union[str, IResolvable]

• 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

cluster_spec: typing.Union[str, IResolvable]

• 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

config_source_enabled: typing.Union[bool, IResolvable]

• 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

config_source_nacos_id: typing.Union[str, IResolvable]

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

Property configSourceNacosId: The Nacos ID for config source.

control_plane_log_enabled^Optional

control_plane_log_enabled: typing.Union[bool, IResolvable]

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

Property controlPlaneLogEnabled: Specifies whether to enable control plane logging.

control_plane_log_project^Optional

control_plane_log_project: typing.Union[str, IResolvable]

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

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

cr_aggregation_enabled^Optional

cr_aggregation_enabled: typing.Union[bool, IResolvable]

• 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

customized_prometheus: typing.Union[bool, IResolvable]

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

Property customizedPrometheus: Specifies whether to use a customized Prometheus system.

customized_zipkin^Optional

customized_zipkin: typing.Union[bool, IResolvable]

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

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

dns_proxying_enabled^Optional

dns_proxying_enabled: typing.Union[bool, IResolvable]

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

Property dnsProxyingEnabled: Specifies whether to enable DNS proxying.

dubbo_filter_enabled^Optional

dubbo_filter_enabled: typing.Union[bool, IResolvable]

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

Property dubboFilterEnabled: Specifies whether to enable Dubbo filter.

edition^Optional

edition: typing.Union[str, IResolvable]

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

Property edition: The edition of the ASM instance.

enable_acmg^Optional

enable_acmg: typing.Union[bool, IResolvable]

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

Property enableAcmg: Specifies whether to enable ACMG.

enable_ambient^Optional

enable_ambient: typing.Union[bool, IResolvable]

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

Property enableAmbient: Specifies whether to enable ambient mode.

enable_audit^Optional

enable_audit: typing.Union[bool, IResolvable]

• 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

enable_cr_history: typing.Union[bool, IResolvable]

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

Property enableCrHistory: Specifies whether to enable CR history.

enable_sds_server^Optional

enable_sds_server: typing.Union[bool, IResolvable]

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

Property enableSdsServer: Specifies whether to enable SDS server.

exclude_inbound_ports^Optional

exclude_inbound_ports: typing.Union[str, IResolvable]

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

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

exclude_ip_ranges^Optional

exclude_ip_ranges: typing.Union[str, IResolvable]

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

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

exclude_outbound_ports^Optional

exclude_outbound_ports: typing.Union[str, IResolvable]

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

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

existing_ca_cert^Optional

existing_ca_cert: typing.Union[str, IResolvable]

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

Property existingCaCert: The existing CA certificate.

existing_ca_key^Optional

existing_ca_key: typing.Union[str, IResolvable]

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

Property existingCaKey: The existing CA key.

existing_ca_type^Optional

existing_ca_type: typing.Union[str, IResolvable]

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

Property existingCaType: The type of existing CA.

existing_root_ca_cert^Optional

existing_root_ca_cert: typing.Union[str, IResolvable]

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

Property existingRootCaCert: The existing root CA certificate.

existing_root_ca_key^Optional

existing_root_ca_key: typing.Union[str, IResolvable]

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

Property existingRootCaKey: The existing root CA key.

filter_gateway_cluster_config^Optional

filter_gateway_cluster_config: typing.Union[bool, IResolvable]

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

Property filterGatewayClusterConfig: Specifies whether to filter gateway cluster configuration.

gateway_api_enabled^Optional

gateway_api_enabled: typing.Union[bool, IResolvable]

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

Property gatewayApiEnabled: Specifies whether to enable Gateway API.

guest_cluster^Optional

guest_cluster: typing.Union[str, IResolvable]

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

Property guestCluster: The guest cluster configuration.

include_ip_ranges^Optional

include_ip_ranges: typing.Union[str, IResolvable]

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

istio_version: typing.Union[str, IResolvable]

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

Property istioVersion: The Istio version of the ASM instance.

kiali_enabled^Optional

kiali_enabled: typing.Union[bool, IResolvable]

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

Property kialiEnabled: Specifies whether to enable Kiali.

locality_lb_conf^Optional

locality_lb_conf: typing.Union[str, IResolvable]

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

Property localityLbConf: The locality load balancing configuration.

locality_load_balancing^Optional

locality_load_balancing: typing.Union[bool, IResolvable]

• 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

mse_enabled: typing.Union[bool, IResolvable]

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

Property mseEnabled: Specifies whether to enable MSE.

multi_buffer_enabled^Optional

multi_buffer_enabled: typing.Union[bool, IResolvable]

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

Property multiBufferEnabled: Specifies whether to enable multi-buffer.

multi_buffer_poll_delay^Optional

multi_buffer_poll_delay: typing.Union[str, IResolvable]

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

Property multiBufferPollDelay: The poll delay for multi-buffer.

mysql_filter_enabled^Optional

mysql_filter_enabled: typing.Union[bool, IResolvable]

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

Property mysqlFilterEnabled: Specifies whether to enable MySQL filter.

name^Optional

name: typing.Union[str, IResolvable]

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

Property name: The name of the ASM instance.

opa^Optional

opa: typing.Union[IResolvable, OPAProperty]

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

Property opa: OPA settings.

opa_enabled^Optional

opa_enabled: typing.Union[bool, IResolvable]

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

Property opaEnabled: Specifies whether to enable OPA.

outbound_traffic_policy^Optional

outbound_traffic_policy: typing.Union[str, IResolvable]

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

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

period^Optional

period: typing.Union[typing.Union[int, float], IResolvable]

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

Property period: The subscription period.

pilot_load_balancer_spec^Optional

pilot_load_balancer_spec: typing.Union[str, IResolvable]

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

Property pilotLoadBalancerSpec: The specification for the pilot load balancer.

pilot_public_eip^Optional

pilot_public_eip: typing.Union[bool, IResolvable]

• 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

playground_scene: typing.Union[str, IResolvable]

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

Property playgroundScene: The playground scene configuration.

prometheus_url^Optional

prometheus_url: typing.Union[str, IResolvable]

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

Property prometheusUrl: The URL for Prometheus.

proxy^Optional

proxy: typing.Union[IResolvable, ProxyProperty]

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

Property proxy: Proxy settings.

telemetry^Optional

telemetry: typing.Union[bool, IResolvable]

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

trace_sampling: typing.Union[typing.Union[int, float], IResolvable]

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

Property traceSampling: The sampling percentage of tracing.

tracing^Optional

tracing: typing.Union[bool, IResolvable]

• 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

use_existing_ca: typing.Union[bool, IResolvable]

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

Property useExistingCa: Specifies whether to use an existing CA.

web_assembly_filter_enabled^Optional

web_assembly_filter_enabled: typing.Union[bool, IResolvable]

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

Property webAssemblyFilterEnabled: Specifies whether to enable WebAssembly filter.

Protocols