{ "name": "volcenginecc", "description": "A Pulumi package to safely use volcengine resource in Pulumi programs.", "keywords": [ "volcengine", "volcenginecc", "category/cloud" ], "homepage": "https://github.com/volcengine/pulumi-volcenginecc", "license": "MPL-2.0", "attribution": "This Pulumi package is based on the [`volcenginecc` Terraform Provider](https://github.com/volcengine/terraform-provider-volcenginecc).", "repository": "https://github.com/volcengine/pulumi-volcenginecc", "logoUrl": "https://avatars.githubusercontent.com/u/67365215", "pluginDownloadURL": "github://api.github.com/volcengine", "publisher": "Volcengine", "meta": { "moduleFormat": "(.*)(?:/[^/]*)" }, "language": { "csharp": { "packageReferences": { "Pulumi": "3.*" }, "compatibility": "tfbridge20", "rootNamespace": "Volcengine.Pulumi" }, "go": { "importBasePath": "github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc", "generateResourceContainerTypes": true, "generateExtraInputTypes": true, "respectSchemaVersion": true }, "java": { "basePackage": "com.volcengine", "buildFiles": "", "gradleNexusPublishPluginVersion": "", "gradleTest": "" }, "nodejs": { "packageName": "@volcengine/pulumi-volcenginecc", "packageDescription": "A Pulumi package to safely use volcengine resource in Pulumi programs.", "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/volcengine/terraform-provider-volcenginecc)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-volcenginecc` repo](https://github.com/volcengine/pulumi-volcenginecc/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-volcenginecc` repo](https://github.com/volcengine/terraform-provider-volcenginecc/issues).", "devDependencies": { "@types/mime": "^2.0.0", "@types/node": "^10.0.0" }, "compatibility": "tfbridge20", "disableUnionOutputTypes": true }, "python": { "packageName": "pulumi_volcenginecc", "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/volcengine/terraform-provider-volcenginecc)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-volcenginecc` repo](https://github.com/volcengine/pulumi-volcenginecc/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-volcenginecc` repo](https://github.com/volcengine/terraform-provider-volcenginecc/issues).", "compatibility": "tfbridge20", "pyproject": {} } }, "config": { "variables": { "accessKey": { "type": "string", "description": "The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the `VOLCENGINE_ACCESS_KEY`\nenvironment variable\n", "defaultInfo": { "environment": [ "VOLCENGINE_ACCESS_KEY" ] } }, "assumeRole": { "$ref": "#/types/volcenginecc:config/assumeRole:assumeRole", "description": "An `assume_role` block (documented below). Only one `assume_role` block may be in the configuration.\n" }, "customerHeaders": { "type": "string", "description": "CUSTOMER HEADERS for Volcengine Provider. The customer_headers field uses commas (,) to separate multiple headers, and\ncolons (:) to separate each header key from its corresponding value.\n", "defaultInfo": { "environment": [ "VOLCENGINE_CUSTOMER_HEADERS" ] } }, "disableSsl": { "type": "boolean", "description": "Disable SSL for Volcengine Provider\n", "defaultInfo": { "environment": [ "VOLCENGINE_DISABLE_SSL" ] } }, "endpoints": { "$ref": "#/types/volcenginecc:config/endpoints:endpoints", "description": "An `endpoints` block (documented below). Only one `endpoints` block may be in the configuration.\n" }, "filePath": { "type": "string", "description": "The file path for Volcengine Provider configuration. It can be sourced from the `VOLCENGINE_FILE_PATH` environment\nvariable\n", "defaultInfo": { "environment": [ "VOLCENGINE_FILE_PATH" ] } }, "profile": { "type": "string", "description": "The profile for Volcengine Provider. It can be sourced from the `VOLCENGINE_PROFILE` environment variable\n", "defaultInfo": { "environment": [ "VOLCENGINE_PROFILE" ] } }, "proxyUrl": { "type": "string", "description": "PROXY URL for Volcengine Provider\n", "defaultInfo": { "environment": [ "VOLCENGINE_PROXY_URL" ] } }, "region": { "type": "string", "description": "The Region for Volcengine Provider. It must be provided, but it can also be sourced from the `VOLCENGINE_REGION`\nenvironment variable\n", "defaultInfo": { "environment": [ "VOLCENGINE_REGION" ] } }, "secretKey": { "type": "string", "description": "he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the `VOLCENGINE_SECRET_KEY`\nenvironment variable\n", "defaultInfo": { "environment": [ "VOLCENGINE_SECRET_KEY" ] } } } }, "types": { "volcenginecc:alb/AclAclEntry:AclAclEntry": { "properties": { "description": { "type": "string", "description": "Description of the IP entry. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n" }, "entry": { "type": "string", "description": "IP entry address range. Only CIDR addresses are supported.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "entry" ] } } }, "volcenginecc:alb/AclListener:AclListener": { "properties": { "aclType": { "type": "string", "description": "Listener control mode for this access control policy group. white: allowlist mode; black: denylist mode\n" }, "listenerId": { "type": "string", "description": "Listener ID\n" }, "listenerName": { "type": "string", "description": "Listener name\n" }, "port": { "type": "integer", "description": "Listener port\n" }, "protocol": { "type": "string", "description": "Listener protocol\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aclType", "listenerId", "listenerName", "port", "protocol" ] } } }, "volcenginecc:alb/AclTag:AclTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Length must be between 1 and 128 characters. Case sensitive. Cannot start with any combination of volc: or sys: in any case. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.\n" }, "value": { "type": "string", "description": "User tag value. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:alb/CertificateTag:CertificateTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:alb/CustomizedCfgListener:CustomizedCfgListener": { "properties": { "listenerId": { "type": "string", "description": "Listener ID.\n" }, "listenerName": { "type": "string", "description": "Listener name.\n" }, "port": { "type": "integer", "description": "Listener port.\n" }, "protocol": { "type": "string", "description": "Listener protocol.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "listenerId", "listenerName", "port", "protocol" ] } } }, "volcenginecc:alb/CustomizedCfgTag:CustomizedCfgTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:alb/HealthCheckTemplateTag:HealthCheckTemplateTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.\n" }, "value": { "type": "string", "description": "Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:alb/ListenerDomainExtension:ListenerDomainExtension": { "properties": { "certCenterCertificateId": { "type": "string", "description": "Server certificate ID used by the domain name. Effective when the certificate source is cert_center.\n" }, "certificateId": { "type": "string", "description": "Server certificate ID used by the domain. Effective when the certificate source is alb.\n" }, "certificateSource": { "type": "string", "description": "Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded via Volcano Engine Certificate Center.\n" }, "domain": { "type": "string", "description": "Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '*' are allowed. Length limit: 1–128 characters. Wildcard domain: use '*' to replace one or more characters. '*' must be at the beginning or end of the domain name. '*' cannot appear twice in the same domain name. No characters other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.\n" }, "pcaLeafCertificateId": { "type": "string", "description": "Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.\n" }, "san": { "type": "string", "description": "If the instance supports automatic selection of extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certCenterCertificateId", "certificateId", "certificateSource", "domain", "pcaLeafCertificateId", "san" ] } } }, "volcenginecc:alb/ListenerServerGroup:ListenerServerGroup": { "properties": { "serverGroupId": { "type": "string", "description": "Server group ID.\n" }, "serverGroupName": { "type": "string", "description": "Server group name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "serverGroupId", "serverGroupName" ] } } }, "volcenginecc:alb/ListenerTag:ListenerTag": { "properties": { "key": { "type": "string", "description": "User tag key. Rules: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.\n" }, "value": { "type": "string", "description": "User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:alb/LoadBalancerEipBillingConfig:LoadBalancerEipBillingConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of EIP, in Mbps.\n" }, "billingType": { "type": "integer", "description": "EIP billing method: 2 for bandwidth-based, 3 for traffic-based.\n" }, "isp": { "type": "string", "description": "Line type of the public IP, BGP indicates multi-line.\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "When creating an ALB public instance, if IP protection resources are used, you must specify a DDoS native protection instance ID.\n" }, "securityProtectionTypes": { "type": "string", "description": "When creating a public ALB instance, ALB allows you to purchase multiple public IP protection resources. The rules for public IP protection resources are as follows: separate multiple protection resources with a comma (,). The values for protection resources are: AntiDDoS_Enhanced: You are requesting an enhanced protection type public IP, which can be added to a native DDoS protection instance. If not specified: You are requesting a basic protection type public IP.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "billingType", "isp", "securityProtectionInstanceId", "securityProtectionTypes" ] } } }, "volcenginecc:alb/LoadBalancerGlobalAccelerator:LoadBalancerGlobalAccelerator": { "properties": { "acceleratorId": { "type": "string", "description": "ID of the bound Global Accelerator instance.\n" }, "acceleratorListenerId": { "type": "string", "description": "ID of the bound Global Accelerator listener.\n" }, "endpointGroupId": { "type": "string", "description": "ID of the bound endpoint group.\n" }, "weight": { "type": "integer", "description": "Weight of the backend server, determines traffic distribution ratio.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "acceleratorId", "acceleratorListenerId", "endpointGroupId", "weight" ] } } }, "volcenginecc:alb/LoadBalancerIpv6EipBillingConfig:LoadBalancerIpv6EipBillingConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of IPv6 EIP, in Mbps.\n" }, "billingType": { "type": "integer", "description": "Billing method for IPv6 EIP: 2 for bandwidth-based, 3 for traffic-based.\n" }, "isp": { "type": "string", "description": "Line type of IPv6 public IP; BGP indicates multi-line.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "billingType", "isp" ] } } }, "volcenginecc:alb/LoadBalancerTag:LoadBalancerTag": { "properties": { "key": { "type": "string", "description": "Tag key, used to identify the tag category.\n" }, "value": { "type": "string", "description": "Tag value used to identify the specific tag content.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:alb/LoadBalancerZoneMapping:LoadBalancerZoneMapping": { "properties": { "subnetId": { "type": "string", "description": "Subnet ID providing services within the availability zone.\n" }, "zoneId": { "type": "string", "description": "Unique identifier of the availability zone.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "subnetId", "zoneId" ] } } }, "volcenginecc:alb/RuleForwardGroupConfig:RuleForwardGroupConfig": { "properties": { "serverGroupTuples": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/RuleForwardGroupConfigServerGroupTuple:RuleForwardGroupConfigServerGroupTuple" } }, "stickySessionEnabled": { "type": "string", "description": "Whether to enable inter-group session persistence. on: enabled. off: disabled.\n" }, "stickySessionTimeout": { "type": "integer", "description": "Component session stickiness timeout. Unit: seconds.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "serverGroupTuples", "stickySessionEnabled", "stickySessionTimeout" ] } } }, "volcenginecc:alb/RuleForwardGroupConfigServerGroupTuple:RuleForwardGroupConfigServerGroupTuple": { "properties": { "serverGroupId": { "type": "string", "description": "Destination server group ID.\n" }, "weight": { "type": "integer", "description": "Server group weight.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "serverGroupId", "weight" ] } } }, "volcenginecc:alb/RuleRedirectConfig:RuleRedirectConfig": { "properties": { "redirectDomain": { "type": "string", "description": "Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.\n" }, "redirectHttpCode": { "type": "string", "description": "Redirect status codes: 301, 302, 307, 308.\n" }, "redirectPort": { "type": "string", "description": "Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.\n" }, "redirectProtocol": { "type": "string", "description": "Protocol used for redirect. HTTP, HTTPS.\n" }, "redirectUri": { "type": "string", "description": "Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${request*uri}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${request*uri} is not supported when creating or modifying rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "redirectDomain", "redirectHttpCode", "redirectPort", "redirectProtocol", "redirectUri" ] } } }, "volcenginecc:alb/RuleRewriteConfig:RuleRewriteConfig": { "properties": { "rewritePath": { "type": "string", "description": "Rewrite path.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "rewritePath" ] } } }, "volcenginecc:alb/RuleRuleAction:RuleRuleAction": { "properties": { "fixedResponseConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleActionFixedResponseConfig:RuleRuleActionFixedResponseConfig", "description": "FixedResponseConfig\n" }, "forwardGroupConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleActionForwardGroupConfig:RuleRuleActionForwardGroupConfig", "description": "ForwardGroupConfig\n" }, "redirectConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleActionRedirectConfig:RuleRuleActionRedirectConfig", "description": "RedirectConfig\n" }, "rewriteConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleActionRewriteConfig:RuleRuleActionRewriteConfig", "description": "RewriteConfig\n" }, "trafficLimitConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleActionTrafficLimitConfig:RuleRuleActionTrafficLimitConfig", "description": "TrafficLimitConfig\n" }, "type": { "type": "string", "description": "Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fixedResponseConfig", "forwardGroupConfig", "redirectConfig", "rewriteConfig", "trafficLimitConfig", "type" ] } } }, "volcenginecc:alb/RuleRuleActionFixedResponseConfig:RuleRuleActionFixedResponseConfig": { "properties": { "content": { "type": "string", "description": "Fixed response content.\n" }, "contentType": { "type": "string", "description": "Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json\n" }, "httpCode": { "type": "string", "description": "Returned HTTP status code.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "content", "contentType", "httpCode" ] } } }, "volcenginecc:alb/RuleRuleActionForwardGroupConfig:RuleRuleActionForwardGroupConfig": { "properties": { "serverGroupStickySession": { "$ref": "#/types/volcenginecc:alb/RuleRuleActionForwardGroupConfigServerGroupStickySession:RuleRuleActionForwardGroupConfigServerGroupStickySession", "description": "ServerGroupStickySession\n" }, "serverGroupTuples": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/RuleRuleActionForwardGroupConfigServerGroupTuple:RuleRuleActionForwardGroupConfigServerGroupTuple" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "serverGroupStickySession", "serverGroupTuples" ] } } }, "volcenginecc:alb/RuleRuleActionForwardGroupConfigServerGroupStickySession:RuleRuleActionForwardGroupConfigServerGroupStickySession": { "properties": { "enabled": { "type": "string", "description": "Whether to enable inter-group session persistence. on: enabled. off: disabled.\n" }, "timeout": { "type": "integer", "description": "Component session stickiness timeout. Unit: seconds.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "timeout" ] } } }, "volcenginecc:alb/RuleRuleActionForwardGroupConfigServerGroupTuple:RuleRuleActionForwardGroupConfigServerGroupTuple": { "properties": { "serverGroupId": { "type": "string", "description": "Destination server group ID.\n" }, "weight": { "type": "integer", "description": "Server group weight.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "serverGroupId", "weight" ] } } }, "volcenginecc:alb/RuleRuleActionRedirectConfig:RuleRuleActionRedirectConfig": { "properties": { "host": { "type": "string", "description": "Redirect domain. Only exact domains are supported.\n" }, "httpCode": { "type": "string", "description": "Redirect status codes supported: 301, 302, 307, 308.\n" }, "path": { "type": "string", "description": "Redirect URI..\n" }, "port": { "type": "string", "description": "Redirect port.\n" }, "protocol": { "type": "string", "description": "Protocol used for redirect. Supports HTTP and HTTPS.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "host", "httpCode", "path", "port", "protocol" ] } } }, "volcenginecc:alb/RuleRuleActionRewriteConfig:RuleRuleActionRewriteConfig": { "properties": { "path": { "type": "string", "description": "Rewrite path.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "path" ] } } }, "volcenginecc:alb/RuleRuleActionTrafficLimitConfig:RuleRuleActionTrafficLimitConfig": { "properties": { "qps": { "type": "integer", "description": "Requests per second.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "qps" ] } } }, "volcenginecc:alb/RuleRuleCondition:RuleRuleCondition": { "properties": { "headerConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleConditionHeaderConfig:RuleRuleConditionHeaderConfig", "description": "HeaderConfig。\n" }, "hostConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleConditionHostConfig:RuleRuleConditionHostConfig", "description": "HostConfig。\n" }, "methodConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleConditionMethodConfig:RuleRuleConditionMethodConfig", "description": "MethodConfig。\n" }, "pathConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleConditionPathConfig:RuleRuleConditionPathConfig", "description": "PathConfig。\n" }, "queryStringConfig": { "$ref": "#/types/volcenginecc:alb/RuleRuleConditionQueryStringConfig:RuleRuleConditionQueryStringConfig", "description": "QueryStringConfig。\n" }, "type": { "type": "string", "description": "Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "headerConfig", "hostConfig", "methodConfig", "pathConfig", "queryStringConfig", "type" ] } } }, "volcenginecc:alb/RuleRuleConditionHeaderConfig:RuleRuleConditionHeaderConfig": { "properties": { "key": { "type": "string", "description": "Header field key.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Header field value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "values" ] } } }, "volcenginecc:alb/RuleRuleConditionHostConfig:RuleRuleConditionHostConfig": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Domain name of the forwarding rule. Supports wildcard and exact domains.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "values" ] } } }, "volcenginecc:alb/RuleRuleConditionMethodConfig:RuleRuleConditionMethodConfig": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "values" ] } } }, "volcenginecc:alb/RuleRuleConditionPathConfig:RuleRuleConditionPathConfig": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Forwarding rule URL. Only absolute paths are supported.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "values" ] } } }, "volcenginecc:alb/RuleRuleConditionQueryStringConfig:RuleRuleConditionQueryStringConfig": { "properties": { "values": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/RuleRuleConditionQueryStringConfigValue:RuleRuleConditionQueryStringConfigValue" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "values" ] } } }, "volcenginecc:alb/RuleRuleConditionQueryStringConfigValue:RuleRuleConditionQueryStringConfigValue": { "properties": { "key": { "type": "string", "description": "Query string key.\n" }, "value": { "type": "string", "description": "Query string value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:alb/ServerGroupHealthCheck:ServerGroupHealthCheck": { "properties": { "domain": { "type": "string", "description": "The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.\n" }, "enabled": { "type": "string", "description": "Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.\n" }, "healthyThreshold": { "type": "integer", "description": "Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.\n" }, "httpCode": { "type": "string", "description": "HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http*2xx (default), http*3xx (default), http*4xx, http*5xx.\n" }, "httpVersion": { "type": "string", "description": "HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.\n" }, "interval": { "type": "integer", "description": "After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.\n" }, "method": { "type": "string", "description": "After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.\n" }, "port": { "type": "integer", "description": "Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.\n" }, "protocol": { "type": "string", "description": "Health check protocol. Currently supports HTTP and TCP. Default: HTTP.\n" }, "timeout": { "type": "integer", "description": "Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.\n" }, "unhealthyThreshold": { "type": "integer", "description": "Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.\n" }, "uri": { "type": "string", "description": "Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '\u0026', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "domain", "enabled", "healthyThreshold", "httpCode", "httpVersion", "interval", "method", "port", "protocol", "timeout", "unhealthyThreshold", "uri" ] } } }, "volcenginecc:alb/ServerGroupListener:ServerGroupListener": { "properties": { "listenerId": { "type": "string", "description": "Listener ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "listenerId" ] } } }, "volcenginecc:alb/ServerGroupServer:ServerGroupServer": { "properties": { "description": { "type": "string", "description": "Description of the backend server.\n" }, "instanceId": { "type": "string", "description": "ID of the cloud server instance or network interface.\n" }, "ip": { "type": "string", "description": "Private IP address of the backend server.\n" }, "port": { "type": "integer", "description": "Port number on which the backend server receives requests.\n" }, "remoteEnabled": { "type": "string", "description": "Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.\n" }, "serverId": { "type": "string", "description": "Backend server ID.\n" }, "type": { "type": "string", "description": "Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).\n" }, "weight": { "type": "integer", "description": "Backend server weight.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "instanceId", "ip", "port", "remoteEnabled", "serverId", "type", "weight" ] } } }, "volcenginecc:alb/ServerGroupStickySessionConfig:ServerGroupStickySessionConfig": { "properties": { "cookie": { "type": "string", "description": "Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.\n" }, "cookieTimeout": { "type": "integer", "description": "Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.\n" }, "stickySessionEnabled": { "type": "string", "description": "Enable session persistence. on: Enable; off (default): Disable.\n" }, "stickySessionType": { "type": "string", "description": "Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cookie", "cookieTimeout", "stickySessionEnabled", "stickySessionType" ] } } }, "volcenginecc:alb/ServerGroupTag:ServerGroupTag": { "properties": { "key": { "type": "string", "description": "Tag key. Duplicate tag keys are not allowed for the same resource.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:alb/getAclAclEntry:getAclAclEntry": { "properties": { "description": { "type": "string", "description": "Description of the IP entry. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n" }, "entry": { "type": "string", "description": "IP entry address range. Only CIDR addresses are supported.\n" } }, "type": "object", "required": [ "description", "entry" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getAclListener:getAclListener": { "properties": { "aclType": { "type": "string", "description": "Listener control mode for this access control policy group. white: allowlist mode; black: denylist mode\n" }, "listenerId": { "type": "string", "description": "Listener ID\n" }, "listenerName": { "type": "string", "description": "Listener name\n" }, "port": { "type": "integer", "description": "Listener port\n" }, "protocol": { "type": "string", "description": "Listener protocol\n" } }, "type": "object", "required": [ "aclType", "listenerId", "listenerName", "port", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getAclTag:getAclTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Length must be between 1 and 128 characters. Case sensitive. Cannot start with any combination of volc: or sys: in any case. Cannot start or end with a space. Can include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource must be unique.\n" }, "value": { "type": "string", "description": "User tag value. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getCertificateTag:getCertificateTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getCustomizedCfgListener:getCustomizedCfgListener": { "properties": { "listenerId": { "type": "string", "description": "Listener ID.\n" }, "listenerName": { "type": "string", "description": "Listener name.\n" }, "port": { "type": "integer", "description": "Listener port.\n" }, "protocol": { "type": "string", "description": "Listener protocol.\n" } }, "type": "object", "required": [ "listenerId", "listenerName", "port", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getCustomizedCfgTag:getCustomizedCfgTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getHealthCheckTemplateTag:getHealthCheckTemplateTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.\n" }, "value": { "type": "string", "description": "Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getListenerDomainExtension:getListenerDomainExtension": { "properties": { "certCenterCertificateId": { "type": "string", "description": "Server certificate ID used by the domain name. Effective when the certificate source is cert_center.\n" }, "certificateId": { "type": "string", "description": "Server certificate ID used by the domain. Effective when the certificate source is alb.\n" }, "certificateSource": { "type": "string", "description": "Source of the server certificate used by the domain. Values: alb: certificate uploaded via ALB. cert_center: SSL certificate purchased or uploaded via Volcano Engine Certificate Center.\n" }, "domain": { "type": "string", "description": "Domain name. Usually cannot be empty. If the instance supports automatic selection of extension certificates (SniAutoMatch is on), Domain must be set to an empty string. Must contain at least one '.' and cannot start or end with '.'. Only lowercase letters, digits, '.', '-', and '*' are allowed. Length limit: 1–128 characters. Wildcard domain: use '*' to replace one or more characters. '*' must be at the beginning or end of the domain name. '*' cannot appear twice in the same domain name. No characters other than '.' can appear before or after '*'. Exact domain: an exact domain name that complies with domain name specifications. Domain names under the same HTTPS listener cannot be duplicated. Domain name matching is case-insensitive.\n" }, "domainExtensionId": { "type": "string", "description": "Extension domain name ID.\n" }, "listenerId": { "type": "string", "description": "Listener ID associated with the extended domain name.\n" }, "pcaLeafCertificateId": { "type": "string", "description": "Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.\n" }, "san": { "type": "string", "description": "If the instance supports automatic selection of extension certificates, that is, when SniAutoMatch is set to on, Domain is an empty string. San refers to the certificate's extension domain names, separated by commas.\n" } }, "type": "object", "required": [ "certCenterCertificateId", "certificateId", "certificateSource", "domain", "domainExtensionId", "listenerId", "pcaLeafCertificateId", "san" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getListenerServerGroup:getListenerServerGroup": { "properties": { "serverGroupId": { "type": "string", "description": "Server group ID.\n" }, "serverGroupName": { "type": "string", "description": "Server group name.\n" } }, "type": "object", "required": [ "serverGroupId", "serverGroupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getListenerTag:getListenerTag": { "properties": { "key": { "type": "string", "description": "User tag key. Rules: Length must be between 1 and 128 characters. Case sensitive. Cannot start with any case combination of volc:. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Tag keys for the same resource cannot be duplicated.\n" }, "value": { "type": "string", "description": "User tag value. Rules: Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Allowed characters include all languages, numbers, spaces, parentheses (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getLoadBalancerEipBillingConfig:getLoadBalancerEipBillingConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of EIP, in Mbps.\n" }, "billingType": { "type": "integer", "description": "EIP billing method: 2 for bandwidth-based, 3 for traffic-based.\n" }, "isp": { "type": "string", "description": "Line type of the public IP, BGP indicates multi-line.\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "When creating an ALB public instance, if IP protection resources are used, you must specify a DDoS native protection instance ID.\n" }, "securityProtectionTypes": { "type": "string", "description": "When creating a public ALB instance, ALB allows you to purchase multiple public IP protection resources. The rules for public IP protection resources are as follows: separate multiple protection resources with a comma (,). The values for protection resources are: AntiDDoS_Enhanced: You are requesting an enhanced protection type public IP, which can be added to a native DDoS protection instance. If not specified: You are requesting a basic protection type public IP.\n" } }, "type": "object", "required": [ "bandwidth", "billingType", "isp", "securityProtectionInstanceId", "securityProtectionTypes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getLoadBalancerGlobalAccelerator:getLoadBalancerGlobalAccelerator": { "properties": { "acceleratorId": { "type": "string", "description": "ID of the bound Global Accelerator instance.\n" }, "acceleratorListenerId": { "type": "string", "description": "ID of the bound Global Accelerator listener.\n" }, "endpointGroupId": { "type": "string", "description": "ID of the bound endpoint group.\n" }, "weight": { "type": "integer", "description": "Weight of the backend server, determines traffic distribution ratio.\n" } }, "type": "object", "required": [ "acceleratorId", "acceleratorListenerId", "endpointGroupId", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getLoadBalancerIpv6EipBillingConfig:getLoadBalancerIpv6EipBillingConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of IPv6 EIP, in Mbps.\n" }, "billingType": { "type": "integer", "description": "Billing method for IPv6 EIP: 2 for bandwidth-based, 3 for traffic-based.\n" }, "isp": { "type": "string", "description": "Line type of IPv6 public IP; BGP indicates multi-line.\n" } }, "type": "object", "required": [ "bandwidth", "billingType", "isp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getLoadBalancerTag:getLoadBalancerTag": { "properties": { "key": { "type": "string", "description": "Tag key, used to identify the tag category.\n" }, "value": { "type": "string", "description": "Tag value used to identify the specific tag content.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getLoadBalancerZoneMapping:getLoadBalancerZoneMapping": { "properties": { "loadBalancerAddresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/getLoadBalancerZoneMappingLoadBalancerAddress:getLoadBalancerZoneMappingLoadBalancerAddress" }, "description": "List of IP addresses provided by the load balancer in this availability zone.\n" }, "subnetId": { "type": "string", "description": "Subnet ID providing services within the availability zone.\n" }, "zoneId": { "type": "string", "description": "Unique identifier of the availability zone.\n" } }, "type": "object", "required": [ "loadBalancerAddresses", "subnetId", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getLoadBalancerZoneMappingLoadBalancerAddress:getLoadBalancerZoneMappingLoadBalancerAddress": { "properties": { "eip": { "$ref": "#/types/volcenginecc:alb/getLoadBalancerZoneMappingLoadBalancerAddressEip:getLoadBalancerZoneMappingLoadBalancerAddressEip", "description": "Detailed information of the Elastic Public IP (EIP).\n" }, "eipAddress": { "type": "string", "description": "Address of the bound Elastic Public IP (EIP).\n" }, "eipId": { "type": "string", "description": "ID of the bound Elastic IP (EIP).\n" }, "eniAddress": { "type": "string", "description": "Private IP address on the Elastic Network Interface (ENI).\n" }, "eniId": { "type": "string", "description": "ID of the Elastic Network Interface (ENI) to which the IP address belongs.\n" }, "eniIpv6Address": { "type": "string", "description": "IPv6 private address on the Elastic Network Interface (ENI).\n" }, "ipv6Eip": { "$ref": "#/types/volcenginecc:alb/getLoadBalancerZoneMappingLoadBalancerAddressIpv6Eip:getLoadBalancerZoneMappingLoadBalancerAddressIpv6Eip", "description": "Detailed information about the IPv6 Elastic Public IP.\n" }, "ipv6EipId": { "type": "string", "description": "ID of the bound IPv6 EIP.\n" } }, "type": "object", "required": [ "eip", "eipAddress", "eipId", "eniAddress", "eniId", "eniIpv6Address", "ipv6Eip", "ipv6EipId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getLoadBalancerZoneMappingLoadBalancerAddressEip:getLoadBalancerZoneMappingLoadBalancerAddressEip": { "properties": { "associationMode": { "type": "string", "description": "EIP binding mode, such as Default or Normal.\n" }, "bandwidth": { "type": "integer", "description": "Peak bandwidth of EIP, in Mbps.\n" }, "eipAddress": { "type": "string", "description": "Address of the Elastic IP (EIP).\n" }, "eipBillingType": { "type": "integer", "description": "EIP billing method: 2 for bandwidth-based, 3 for traffic-based.\n" }, "eipType": { "type": "string", "description": "EIP type, such as static BGP.\n" }, "isp": { "type": "string", "description": "Line type of the public IP, BGP indicates multi-line.\n" }, "popLocations": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/getLoadBalancerZoneMappingLoadBalancerAddressEipPopLocation:getLoadBalancerZoneMappingLoadBalancerAddressEipPopLocation" }, "description": "List of EIP access point location information.\n" } }, "type": "object", "required": [ "associationMode", "bandwidth", "eipAddress", "eipBillingType", "eipType", "isp", "popLocations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getLoadBalancerZoneMappingLoadBalancerAddressEipPopLocation:getLoadBalancerZoneMappingLoadBalancerAddressEipPopLocation": { "properties": { "popId": { "type": "string", "description": "Unique ID of the access point (PoP).\n" }, "popName": { "type": "string", "description": "Name of the access point (PoP).\n" } }, "type": "object", "required": [ "popId", "popName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getLoadBalancerZoneMappingLoadBalancerAddressIpv6Eip:getLoadBalancerZoneMappingLoadBalancerAddressIpv6Eip": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of IPv6 EIP, in Mbps.\n" }, "billingType": { "type": "integer", "description": "Billing method for IPv6 EIP: 2 for bandwidth-based, 3 for traffic-based.\n" }, "isp": { "type": "string", "description": "Line type of IPv6 public IP; BGP indicates multi-line.\n" } }, "type": "object", "required": [ "bandwidth", "billingType", "isp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleForwardGroupConfig:getRuleForwardGroupConfig": { "properties": { "serverGroupTuples": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/getRuleForwardGroupConfigServerGroupTuple:getRuleForwardGroupConfigServerGroupTuple" }, "description": "Destination server group list.\n" }, "stickySessionEnabled": { "type": "string", "description": "Whether to enable inter-group session persistence. on: enabled. off: disabled.\n" }, "stickySessionTimeout": { "type": "integer", "description": "Component session stickiness timeout. Unit: seconds.\n" } }, "type": "object", "required": [ "serverGroupTuples", "stickySessionEnabled", "stickySessionTimeout" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleForwardGroupConfigServerGroupTuple:getRuleForwardGroupConfigServerGroupTuple": { "properties": { "serverGroupId": { "type": "string", "description": "Destination server group ID.\n" }, "weight": { "type": "integer", "description": "Server group weight.\n" } }, "type": "object", "required": [ "serverGroupId", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRedirectConfig:getRuleRedirectConfig": { "properties": { "redirectDomain": { "type": "string", "description": "Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.\n" }, "redirectHttpCode": { "type": "string", "description": "Redirect status codes: 301, 302, 307, 308.\n" }, "redirectPort": { "type": "string", "description": "Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.\n" }, "redirectProtocol": { "type": "string", "description": "Protocol used for redirect. HTTP, HTTPS.\n" }, "redirectUri": { "type": "string", "description": "Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${request*uri}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${request*uri} is not supported when creating or modifying rules.\n" } }, "type": "object", "required": [ "redirectDomain", "redirectHttpCode", "redirectPort", "redirectProtocol", "redirectUri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRewriteConfig:getRuleRewriteConfig": { "properties": { "rewritePath": { "type": "string", "description": "Rewrite path.\n" } }, "type": "object", "required": [ "rewritePath" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleAction:getRuleRuleAction": { "properties": { "fixedResponseConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleActionFixedResponseConfig:getRuleRuleActionFixedResponseConfig", "description": "FixedResponseConfig\n" }, "forwardGroupConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleActionForwardGroupConfig:getRuleRuleActionForwardGroupConfig", "description": "ForwardGroupConfig\n" }, "redirectConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleActionRedirectConfig:getRuleRuleActionRedirectConfig", "description": "RedirectConfig\n" }, "rewriteConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleActionRewriteConfig:getRuleRuleActionRewriteConfig", "description": "RewriteConfig\n" }, "trafficLimitConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleActionTrafficLimitConfig:getRuleRuleActionTrafficLimitConfig", "description": "TrafficLimitConfig\n" }, "type": { "type": "string", "description": "Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.\n" } }, "type": "object", "required": [ "fixedResponseConfig", "forwardGroupConfig", "redirectConfig", "rewriteConfig", "trafficLimitConfig", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleActionFixedResponseConfig:getRuleRuleActionFixedResponseConfig": { "properties": { "content": { "type": "string", "description": "Fixed response content.\n" }, "contentType": { "type": "string", "description": "Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json\n" }, "httpCode": { "type": "string", "description": "Returned HTTP status code.\n" } }, "type": "object", "required": [ "content", "contentType", "httpCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleActionForwardGroupConfig:getRuleRuleActionForwardGroupConfig": { "properties": { "serverGroupStickySession": { "$ref": "#/types/volcenginecc:alb/getRuleRuleActionForwardGroupConfigServerGroupStickySession:getRuleRuleActionForwardGroupConfigServerGroupStickySession", "description": "ServerGroupStickySession\n" }, "serverGroupTuples": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/getRuleRuleActionForwardGroupConfigServerGroupTuple:getRuleRuleActionForwardGroupConfigServerGroupTuple" }, "description": "ServerGroupTuples\n" } }, "type": "object", "required": [ "serverGroupStickySession", "serverGroupTuples" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleActionForwardGroupConfigServerGroupStickySession:getRuleRuleActionForwardGroupConfigServerGroupStickySession": { "properties": { "enabled": { "type": "string", "description": "Whether to enable inter-group session persistence. on: enabled. off: disabled.\n" }, "timeout": { "type": "integer", "description": "Component session stickiness timeout. Unit: seconds.\n" } }, "type": "object", "required": [ "enabled", "timeout" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleActionForwardGroupConfigServerGroupTuple:getRuleRuleActionForwardGroupConfigServerGroupTuple": { "properties": { "serverGroupId": { "type": "string", "description": "Destination server group ID.\n" }, "weight": { "type": "integer", "description": "Server group weight.\n" } }, "type": "object", "required": [ "serverGroupId", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleActionRedirectConfig:getRuleRuleActionRedirectConfig": { "properties": { "host": { "type": "string", "description": "Redirect domain. Only exact domains are supported.\n" }, "httpCode": { "type": "string", "description": "Redirect status codes supported: 301, 302, 307, 308.\n" }, "path": { "type": "string", "description": "Redirect URI..\n" }, "port": { "type": "string", "description": "Redirect port.\n" }, "protocol": { "type": "string", "description": "Protocol used for redirect. Supports HTTP and HTTPS.\n" } }, "type": "object", "required": [ "host", "httpCode", "path", "port", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleActionRewriteConfig:getRuleRuleActionRewriteConfig": { "properties": { "path": { "type": "string", "description": "Rewrite path.\n" } }, "type": "object", "required": [ "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleActionTrafficLimitConfig:getRuleRuleActionTrafficLimitConfig": { "properties": { "qps": { "type": "integer", "description": "Requests per second.\n" } }, "type": "object", "required": [ "qps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleCondition:getRuleRuleCondition": { "properties": { "headerConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleConditionHeaderConfig:getRuleRuleConditionHeaderConfig", "description": "HeaderConfig。\n" }, "hostConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleConditionHostConfig:getRuleRuleConditionHostConfig", "description": "HostConfig。\n" }, "methodConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleConditionMethodConfig:getRuleRuleConditionMethodConfig", "description": "MethodConfig。\n" }, "pathConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleConditionPathConfig:getRuleRuleConditionPathConfig", "description": "PathConfig。\n" }, "queryStringConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRuleConditionQueryStringConfig:getRuleRuleConditionQueryStringConfig", "description": "QueryStringConfig。\n" }, "type": { "type": "string", "description": "Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.\n" } }, "type": "object", "required": [ "headerConfig", "hostConfig", "methodConfig", "pathConfig", "queryStringConfig", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleConditionHeaderConfig:getRuleRuleConditionHeaderConfig": { "properties": { "key": { "type": "string", "description": "Header field key.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Header field value.\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleConditionHostConfig:getRuleRuleConditionHostConfig": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Domain name of the forwarding rule. Supports wildcard and exact domains.\n" } }, "type": "object", "required": [ "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleConditionMethodConfig:getRuleRuleConditionMethodConfig": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.\n" } }, "type": "object", "required": [ "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleConditionPathConfig:getRuleRuleConditionPathConfig": { "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "Forwarding rule URL. Only absolute paths are supported.\n" } }, "type": "object", "required": [ "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleConditionQueryStringConfig:getRuleRuleConditionQueryStringConfig": { "properties": { "values": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/getRuleRuleConditionQueryStringConfigValue:getRuleRuleConditionQueryStringConfigValue" }, "description": "Values。\n" } }, "type": "object", "required": [ "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getRuleRuleConditionQueryStringConfigValue:getRuleRuleConditionQueryStringConfigValue": { "properties": { "key": { "type": "string", "description": "Query string key.\n" }, "value": { "type": "string", "description": "Query string value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getServerGroupHealthCheck:getServerGroupHealthCheck": { "properties": { "domain": { "type": "string", "description": "The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.\n" }, "enabled": { "type": "string", "description": "Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.\n" }, "healthyThreshold": { "type": "integer", "description": "Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.\n" }, "httpCode": { "type": "string", "description": "HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http*2xx (default), http*3xx (default), http*4xx, http*5xx.\n" }, "httpVersion": { "type": "string", "description": "HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.\n" }, "interval": { "type": "integer", "description": "After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.\n" }, "method": { "type": "string", "description": "After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.\n" }, "port": { "type": "integer", "description": "Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.\n" }, "protocol": { "type": "string", "description": "Health check protocol. Currently supports HTTP and TCP. Default: HTTP.\n" }, "timeout": { "type": "integer", "description": "Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.\n" }, "unhealthyThreshold": { "type": "integer", "description": "Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.\n" }, "uri": { "type": "string", "description": "Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '\u0026', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.\n" } }, "type": "object", "required": [ "domain", "enabled", "healthyThreshold", "httpCode", "httpVersion", "interval", "method", "port", "protocol", "timeout", "unhealthyThreshold", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getServerGroupListener:getServerGroupListener": { "properties": { "listenerId": { "type": "string", "description": "Listener ID.\n" } }, "type": "object", "required": [ "listenerId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getServerGroupServer:getServerGroupServer": { "properties": { "description": { "type": "string", "description": "Description of the backend server.\n" }, "instanceId": { "type": "string", "description": "ID of the cloud server instance or network interface.\n" }, "ip": { "type": "string", "description": "Private IP address of the backend server.\n" }, "port": { "type": "integer", "description": "Port number on which the backend server receives requests.\n" }, "remoteEnabled": { "type": "string", "description": "Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.\n" }, "serverId": { "type": "string", "description": "Backend server ID.\n" }, "type": { "type": "string", "description": "Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).\n" }, "weight": { "type": "integer", "description": "Backend server weight.\n" } }, "type": "object", "required": [ "description", "instanceId", "ip", "port", "remoteEnabled", "serverId", "type", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getServerGroupStickySessionConfig:getServerGroupStickySessionConfig": { "properties": { "cookie": { "type": "string", "description": "Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.\n" }, "cookieTimeout": { "type": "integer", "description": "Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.\n" }, "stickySessionEnabled": { "type": "string", "description": "Enable session persistence. on: Enable; off (default): Disable.\n" }, "stickySessionType": { "type": "string", "description": "Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.\n" } }, "type": "object", "required": [ "cookie", "cookieTimeout", "stickySessionEnabled", "stickySessionType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:alb/getServerGroupTag:getServerGroupTag": { "properties": { "key": { "type": "string", "description": "Tag key. Duplicate tag keys are not allowed for the same resource.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/GatewayBackendSpec:GatewayBackendSpec": { "properties": { "isVkeWithFlannelCniSupported": { "type": "boolean", "description": "Whether VKE Flannel CNI is supported\n" }, "vkePodCidr": { "type": "string", "description": "VKE Pod CIDR。\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isVkeWithFlannelCniSupported", "vkePodCidr" ] } } }, "volcenginecc:apig/GatewayCustomLog:GatewayCustomLog": { "properties": { "customVariables": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayCustomLogCustomVariable:GatewayCustomLogCustomVariable" } }, "requestHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayCustomLogRequestHeader:GatewayCustomLogRequestHeader" } }, "responseHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayCustomLogResponseHeader:GatewayCustomLogResponseHeader" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customVariables", "requestHeaders", "responseHeaders" ] } } }, "volcenginecc:apig/GatewayCustomLogCustomVariable:GatewayCustomLogCustomVariable": { "properties": { "aliasesInLog": { "type": "string", "description": "Field alias\n" }, "key": { "type": "string", "description": "Request header key\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aliasesInLog", "key" ] } } }, "volcenginecc:apig/GatewayCustomLogRequestHeader:GatewayCustomLogRequestHeader": { "properties": { "aliasesInLog": { "type": "string", "description": "Field alias\n" }, "key": { "type": "string", "description": "Request header key\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aliasesInLog", "key" ] } } }, "volcenginecc:apig/GatewayCustomLogResponseHeader:GatewayCustomLogResponseHeader": { "properties": { "aliasesInLog": { "type": "string", "description": "Field alias\n" }, "key": { "type": "string", "description": "Request header key\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aliasesInLog", "key" ] } } }, "volcenginecc:apig/GatewayEvent:GatewayEvent": { "properties": { "code": { "type": "string", "description": "Event code\n" }, "createdTime": { "type": "string", "description": "Event creation time\n" }, "data": { "type": "string", "description": "Additional information\n" }, "description": { "type": "string", "description": "Event description\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "code", "createdTime", "data", "description" ] } } }, "volcenginecc:apig/GatewayLogSpec:GatewayLogSpec": { "properties": { "enable": { "type": "boolean", "description": "Whether to enable log service\n" }, "projectId": { "type": "string", "description": "Log project ID\n" }, "topicId": { "type": "string", "description": "Log topic ID. ProjectId specifies the log topic within the project\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enable", "projectId", "topicId" ] } } }, "volcenginecc:apig/GatewayMonitorSpec:GatewayMonitorSpec": { "properties": { "enable": { "type": "boolean", "description": "Managed Prometheus (VMP) service\n" }, "workspaceId": { "type": "string", "description": "Prometheus workspace ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enable", "workspaceId" ] } } }, "volcenginecc:apig/GatewayNetworkSpec:GatewayNetworkSpec": { "properties": { "subnets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayNetworkSpecSubnet:GatewayNetworkSpecSubnet" } }, "vpcId": { "type": "string", "description": "VPC ID。\n" }, "vpcName": { "type": "string", "description": "VPC name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "subnets", "vpcId", "vpcName" ] } } }, "volcenginecc:apig/GatewayNetworkSpecSubnet:GatewayNetworkSpecSubnet": { "properties": { "az": { "type": "string", "description": "Availability zone\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" }, "subnetName": { "type": "string", "description": "Subnet name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "az", "subnetId", "subnetName" ] } } }, "volcenginecc:apig/GatewayResourceSpec:GatewayResourceSpec": { "properties": { "clbSpecCode": { "type": "string", "description": "CLB specification code. CLB specifications. Options: small*1: Small I; small*2: Small II; medium*1: Medium I; medium*2: Medium II; large*1: Large I; large*2: Large II\n" }, "instanceSpecCode": { "type": "string", "description": "Node specifications. Options: 1c2g, 2c4g, 4c8g, 8c16g\n" }, "networkType": { "$ref": "#/types/volcenginecc:apig/GatewayResourceSpecNetworkType:GatewayResourceSpecNetworkType", "description": "Network type. Default value: enable public network, enable private network\n" }, "publicNetworkBandwidth": { "type": "integer", "description": "Public network bandwidth limit. This field is only used for the 'bandwidth limit billing' public network billing method. Unit: Mbps. Value range: 0–500. Default value: 0\n" }, "publicNetworkBillingType": { "type": "string", "description": "Public network billing method. Options: traffic: billed by actual traffic; bandwidth: billed by bandwidth limit\n" }, "replicas": { "type": "integer", "description": "Node count. Value range: 2–100\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "clbSpecCode", "instanceSpecCode", "networkType", "publicNetworkBandwidth", "publicNetworkBillingType", "replicas" ] } } }, "volcenginecc:apig/GatewayResourceSpecNetworkType:GatewayResourceSpecNetworkType": { "properties": { "enablePrivateNetwork": { "type": "boolean", "description": "Whether to enable private network\n" }, "enablePublicNetwork": { "type": "boolean", "description": "Whether to enable public network\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enablePrivateNetwork", "enablePublicNetwork" ] } } }, "volcenginecc:apig/GatewayServiceAuthSpec:GatewayServiceAuthSpec": { "properties": { "enable": { "type": "boolean", "description": "Whether authentication is enabled.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enable" ] } } }, "volcenginecc:apig/GatewayServiceCustomDomain:GatewayServiceCustomDomain": { "type": "object" }, "volcenginecc:apig/GatewayServiceDomain:GatewayServiceDomain": { "properties": { "domain": { "type": "string", "description": "Domain.\n" }, "type": { "type": "string", "description": "Domain type. Options: public: Public network. private: Private network.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "domain", "type" ] } } }, "volcenginecc:apig/GatewayServiceDomainSpec:GatewayServiceDomainSpec": { "properties": { "enablePublicResolution": { "type": "boolean", "description": "Enable public resolution for private network domains.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enablePublicResolution" ] } } }, "volcenginecc:apig/GatewayServiceServiceNetworkSpec:GatewayServiceServiceNetworkSpec": { "properties": { "enablePrivateNetwork": { "type": "boolean", "description": "Enable private network.\n" }, "enablePublicNetwork": { "type": "boolean", "description": "Enable public network.\n" }, "privateNetworkIps": { "type": "array", "items": { "type": "string" }, "description": "Target IP for private network domain resolution.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enablePrivateNetwork", "enablePublicNetwork", "privateNetworkIps" ] } } }, "volcenginecc:apig/GatewayTraceSpec:GatewayTraceSpec": { "properties": { "apmTraceSpec": { "$ref": "#/types/volcenginecc:apig/GatewayTraceSpecApmTraceSpec:GatewayTraceSpecApmTraceSpec", "description": "Application performance monitoring full-link trace configuration\n" }, "enable": { "type": "boolean", "description": "Whether to enable trace\n" }, "tlsTraceSpec": { "$ref": "#/types/volcenginecc:apig/GatewayTraceSpecTlsTraceSpec:GatewayTraceSpecTlsTraceSpec", "description": "Link tracing configuration information.\n" }, "traceType": { "type": "string", "description": "Link tracing type. Possible values: tls: Log Service. apm: Application Performance Monitoring (APM) end-to-end version.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "apmTraceSpec", "enable", "tlsTraceSpec", "traceType" ] } } }, "volcenginecc:apig/GatewayTraceSpecApmTraceSpec:GatewayTraceSpecApmTraceSpec": { "properties": { "apiKey": { "type": "string", "description": "API Key。\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "apiKey" ] } } }, "volcenginecc:apig/GatewayTraceSpecTlsTraceSpec:GatewayTraceSpecTlsTraceSpec": { "properties": { "iamUserAk": { "type": "string", "description": "Access key。\n" }, "iamUserSk": { "type": "string", "description": "Secret key。\n" }, "projectId": { "type": "string", "description": "Log project ID\n" }, "traceId": { "type": "string", "description": "Trace ID。\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "iamUserAk", "iamUserSk", "projectId", "traceId" ] } } }, "volcenginecc:apig/UpstreamBackendTarget:UpstreamBackendTarget": { "properties": { "healthStatus": { "type": "string", "description": "Health Check Status\n" }, "ip": { "type": "string", "description": "Backend node IP\n" }, "port": { "type": "integer", "description": "Backend node port\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "healthStatus", "ip", "port" ] } } }, "volcenginecc:apig/UpstreamCircuitBreakingSettings:UpstreamCircuitBreakingSettings": { "properties": { "baseEjectionTime": { "type": "integer", "description": "Minimum pop time, in milliseconds. Value range: 1–86400000. Default: 30 seconds\n" }, "consecutiveErrors": { "type": "integer", "description": "Consecutive failure count. Value range: 1~100. Default: 5\n" }, "enable": { "type": "boolean", "description": "Enable\n" }, "interval": { "type": "integer", "description": "Calculation cycle, in milliseconds. Value range: 1–86400000. Default: 10 seconds\n" }, "maxEjectionPercent": { "type": "integer", "description": "Maximum circuit breaking ratio. Value range: 1~100. Default: 20%\n" }, "minHealthPercent": { "type": "integer", "description": "Minimum health ratio. Value range: 0~100. Default: 60%\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "baseEjectionTime", "consecutiveErrors", "enable", "interval", "maxEjectionPercent", "minHealthPercent" ] } } }, "volcenginecc:apig/UpstreamConnectionPoolSettings:UpstreamConnectionPoolSettings": { "properties": { "enable": { "type": "boolean", "description": "Enable\n" }, "http1MaxPendingRequests": { "type": "integer", "description": "Maximum HTTP/1 pending requests. Value range: 0~2^31-1. 0 means unlimited\n" }, "idleTimeout": { "type": "integer", "description": "Idle timeout, in seconds. Value range: 0–2^31-1. 0 means no limit\n" }, "maxConnections": { "type": "integer", "description": "Maximum TCP connections. Value range: 0~2^31-1. 0 means unlimited\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enable", "http1MaxPendingRequests", "idleTimeout", "maxConnections" ] } } }, "volcenginecc:apig/UpstreamLoadBalancerSettings:UpstreamLoadBalancerSettings": { "properties": { "consistentHashLb": { "$ref": "#/types/volcenginecc:apig/UpstreamLoadBalancerSettingsConsistentHashLb:UpstreamLoadBalancerSettingsConsistentHashLb", "description": "Consistent Hash Load Balancing\n" }, "lbPolicy": { "type": "string", "description": "Load balancing policy. Options: SimpleLB: simple load balancing. ConsistentHashLB: consistent hash load balancing\n" }, "simpleLb": { "type": "string", "description": "Simple load balancing. Options: ROUND*ROBIN: round robin. LEAST*CONN: least connections. RANDOM: random\n" }, "warmupDuration": { "type": "integer", "description": "Warm-up time (seconds)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "consistentHashLb", "lbPolicy", "simpleLb", "warmupDuration" ] } } }, "volcenginecc:apig/UpstreamLoadBalancerSettingsConsistentHashLb:UpstreamLoadBalancerSettingsConsistentHashLb": { "properties": { "hashBalanceFactor": { "type": "integer", "description": "Overload protection parameter. Value range: 100–200. When set to 120, overload protection is triggered if the current active request count of an upstream node exceeds 120% of the average active request count. When overload protection is triggered, even if the request hash matches a specific upstream node, the load balancer will randomly select an upstream node\n" }, "hashKey": { "type": "string", "description": "Consistent hash method. Options: UseSourceIp: based on source IP address. HttpQueryParameterName: based on parameter. HttpHeaderName: based on header. HTTPCookie: based on cookie\n" }, "httpCookie": { "$ref": "#/types/volcenginecc:apig/UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie:UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie", "description": "Cookie。\n" }, "httpHeaderName": { "type": "string", "description": "Parameter. Supports printable ASCII characters, length: 1–256 characters\n" }, "httpQueryParameterName": { "type": "string", "description": "Parameter. Supports printable ASCII characters, length: 1–256 characters\n" }, "useSourceIp": { "type": "string", "description": "Source IP address\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "hashBalanceFactor", "hashKey", "httpCookie", "httpHeaderName", "httpQueryParameterName", "useSourceIp" ] } } }, "volcenginecc:apig/UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie:UpstreamLoadBalancerSettingsConsistentHashLbHttpCookie": { "properties": { "name": { "type": "string", "description": "Name. Supports printable ASCII characters. Length: 0~256 characters\n" }, "path": { "type": "string", "description": "Path. Supports printable ASCII characters. Length: 1~256 characters\n" }, "ttl": { "type": "integer", "description": "Validity period, in seconds\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "path", "ttl" ] } } }, "volcenginecc:apig/UpstreamSourceIngressSettings:UpstreamSourceIngressSettings": { "properties": { "enableAllIngressClasses": { "type": "boolean", "description": "Whether to enable all Ingress classes\n" }, "enableAllNamespaces": { "type": "boolean", "description": "Whether all namespaces\n" }, "enableIngress": { "type": "boolean", "description": "Whether enabled\n" }, "enableIngressWithoutIngressClass": { "type": "boolean", "description": "Whether to monitor resources with empty IngressClass\n" }, "ingressClasses": { "type": "array", "items": { "type": "string" }, "description": "Specify IngressClass\n" }, "updateStatus": { "type": "boolean", "description": "Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address\n" }, "watchNamespaces": { "type": "array", "items": { "type": "string" }, "description": "Specify namespace\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableAllIngressClasses", "enableAllNamespaces", "enableIngress", "enableIngressWithoutIngressClass", "ingressClasses", "updateStatus", "watchNamespaces" ] } } }, "volcenginecc:apig/UpstreamSourceSourceSpec:UpstreamSourceSourceSpec": { "properties": { "k8SSource": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceSourceSpecK8SSource:UpstreamSourceSourceSpecK8SSource", "description": "Container cluster source\n" }, "nacosSource": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceSourceSpecNacosSource:UpstreamSourceSourceSpecNacosSource", "description": "Registry source\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "k8SSource", "nacosSource" ] } } }, "volcenginecc:apig/UpstreamSourceSourceSpecK8SSource:UpstreamSourceSourceSpecK8SSource": { "properties": { "clusterId": { "type": "string", "description": "Cluster ID\n" }, "clusterType": { "type": "string", "description": "Cluster type\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "clusterId", "clusterType" ] } } }, "volcenginecc:apig/UpstreamSourceSourceSpecNacosSource:UpstreamSourceSourceSpecNacosSource": { "properties": { "authConfig": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceSourceSpecNacosSourceAuthConfig:UpstreamSourceSourceSpecNacosSourceAuthConfig", "description": "Authentication configuration\n" }, "nacosId": { "type": "string", "description": "Nacos ID。\n" }, "nacosName": { "type": "string", "description": "Nacos name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authConfig", "nacosId", "nacosName" ] } } }, "volcenginecc:apig/UpstreamSourceSourceSpecNacosSourceAuthConfig:UpstreamSourceSourceSpecNacosSourceAuthConfig": { "properties": { "basic": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceSourceSpecNacosSourceAuthConfigBasic:UpstreamSourceSourceSpecNacosSourceAuthConfigBasic", "description": "Basic authentication\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "basic" ] } } }, "volcenginecc:apig/UpstreamSourceSourceSpecNacosSourceAuthConfigBasic:UpstreamSourceSourceSpecNacosSourceAuthConfigBasic": { "properties": { "password": { "type": "string", "description": "Password\n" }, "username": { "type": "string", "description": "Username\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "password", "username" ] } } }, "volcenginecc:apig/UpstreamTlsSettings:UpstreamTlsSettings": { "properties": { "sni": { "type": "string", "description": "SNI. If left blank, the domain name accessed by the gateway will be passed through to the upstream\n" }, "tlsMode": { "type": "string", "description": "TLS mode. Options: DISABLE: disable TLS. SIMPLE: one-way TLS\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "sni", "tlsMode" ] } } }, "volcenginecc:apig/UpstreamUpstreamSpec:UpstreamUpstreamSpec": { "properties": { "aiProvider": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpecAiProvider:UpstreamUpstreamSpecAiProvider", "description": "AI model proxy\n" }, "domain": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpecDomain:UpstreamUpstreamSpecDomain", "description": "Fixed domain name\n" }, "ecsInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpecEcsInstance:UpstreamUpstreamSpecEcsInstance" } }, "k8SService": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpecK8SService:UpstreamUpstreamSpecK8SService", "description": "Container Service\n" }, "nacosService": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpecNacosService:UpstreamUpstreamSpecNacosService", "description": "Registry Center\n" }, "veFaas": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpecVeFaas:UpstreamUpstreamSpecVeFaas", "description": "Function service\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aiProvider", "domain", "ecsInstances", "k8SService", "nacosService", "veFaas" ] } } }, "volcenginecc:apig/UpstreamUpstreamSpecAiProvider:UpstreamUpstreamSpecAiProvider": { "properties": { "baseUrl": { "type": "string", "description": "Model address\n" }, "customModelService": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpecAiProviderCustomModelService:UpstreamUpstreamSpecAiProviderCustomModelService", "description": "Volcano Engine self-hosted model service\n" }, "name": { "type": "string", "description": "Model Service Provider Name\n" }, "token": { "type": "string", "description": "Model API key\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "baseUrl", "customModelService", "name", "token" ] } } }, "volcenginecc:apig/UpstreamUpstreamSpecAiProviderCustomModelService:UpstreamUpstreamSpecAiProviderCustomModelService": { "properties": { "name": { "type": "string", "description": "Model Service Name\n" }, "namespace": { "type": "string", "description": "Namespace\n" }, "port": { "type": "integer", "description": "Port\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "namespace", "port" ] } } }, "volcenginecc:apig/UpstreamUpstreamSpecDomain:UpstreamUpstreamSpecDomain": { "properties": { "domainLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpecDomainDomainList:UpstreamUpstreamSpecDomainDomainList" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "domainLists" ] } } }, "volcenginecc:apig/UpstreamUpstreamSpecDomainDomainList:UpstreamUpstreamSpecDomainDomainList": { "properties": { "domain": { "type": "string", "description": "Domain name\n" }, "port": { "type": "integer", "description": "Port. Default: 80 for HTTP, 443 for HTTPS\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "domain", "port" ] } } }, "volcenginecc:apig/UpstreamUpstreamSpecEcsInstance:UpstreamUpstreamSpecEcsInstance": { "properties": { "ecsId": { "type": "string", "description": "Cloud server ID\n" }, "ip": { "type": "string", "description": "IP address\n" }, "port": { "type": "integer", "description": "Port\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ecsId", "ip", "port" ] } } }, "volcenginecc:apig/UpstreamUpstreamSpecK8SService:UpstreamUpstreamSpecK8SService": { "properties": { "name": { "type": "string", "description": "Container Service Name. Length: 2–63 characters\n" }, "namespace": { "type": "string", "description": "Namespace. Length: 2~63 characters\n" }, "port": { "type": "integer", "description": "Port\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "namespace", "port" ] } } }, "volcenginecc:apig/UpstreamUpstreamSpecNacosService:UpstreamUpstreamSpecNacosService": { "properties": { "group": { "type": "string", "description": "Group\n" }, "namespace": { "type": "string", "description": "Namespace\n" }, "namespaceId": { "type": "string", "description": "Namespace ID\n" }, "service": { "type": "string", "description": "Service\n" }, "upstreamSourceId": { "type": "string", "description": "Upstream source ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "group", "namespace", "namespaceId", "service", "upstreamSourceId" ] } } }, "volcenginecc:apig/UpstreamUpstreamSpecVeFaas:UpstreamUpstreamSpecVeFaas": { "properties": { "functionId": { "type": "string", "description": "Function ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "functionId" ] } } }, "volcenginecc:apig/UpstreamVersionDetail:UpstreamVersionDetail": { "properties": { "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/UpstreamVersionDetailLabel:UpstreamVersionDetailLabel" } }, "name": { "type": "string", "description": "Version name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length: 2~63 characters. Cannot start with a hyphen (-)\n" }, "updateTime": { "type": "string", "description": "Update time\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "labels", "name", "updateTime" ] } } }, "volcenginecc:apig/UpstreamVersionDetailLabel:UpstreamVersionDetailLabel": { "properties": { "key": { "type": "string", "description": "Key\n" }, "value": { "type": "string", "description": "Value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:apig/getGatewayBackendSpec:getGatewayBackendSpec": { "properties": { "isVkeWithFlannelCniSupported": { "type": "boolean", "description": "Whether VKE Flannel CNI is supported\n" }, "vkePodCidr": { "type": "string", "description": "VKE Pod CIDR。\n" } }, "type": "object", "required": [ "isVkeWithFlannelCniSupported", "vkePodCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayCustomLog:getGatewayCustomLog": { "properties": { "customVariables": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/getGatewayCustomLogCustomVariable:getGatewayCustomLogCustomVariable" }, "description": "Custom variable information\n" }, "requestHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/getGatewayCustomLogRequestHeader:getGatewayCustomLogRequestHeader" }, "description": "Request header information\n" }, "responseHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/getGatewayCustomLogResponseHeader:getGatewayCustomLogResponseHeader" }, "description": "Response header information\n" } }, "type": "object", "required": [ "customVariables", "requestHeaders", "responseHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayCustomLogCustomVariable:getGatewayCustomLogCustomVariable": { "properties": { "aliasesInLog": { "type": "string", "description": "Field alias\n" }, "key": { "type": "string", "description": "Request header key\n" } }, "type": "object", "required": [ "aliasesInLog", "key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayCustomLogRequestHeader:getGatewayCustomLogRequestHeader": { "properties": { "aliasesInLog": { "type": "string", "description": "Field alias\n" }, "key": { "type": "string", "description": "Request header key\n" } }, "type": "object", "required": [ "aliasesInLog", "key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayCustomLogResponseHeader:getGatewayCustomLogResponseHeader": { "properties": { "aliasesInLog": { "type": "string", "description": "Field alias\n" }, "key": { "type": "string", "description": "Request header key\n" } }, "type": "object", "required": [ "aliasesInLog", "key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayEvent:getGatewayEvent": { "properties": { "code": { "type": "string", "description": "Event code\n" }, "createdTime": { "type": "string", "description": "Event creation time\n" }, "data": { "type": "string", "description": "Additional information\n" }, "description": { "type": "string", "description": "Event description\n" } }, "type": "object", "required": [ "code", "createdTime", "data", "description" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayLogSpec:getGatewayLogSpec": { "properties": { "enable": { "type": "boolean", "description": "Whether to enable log service\n" }, "projectId": { "type": "string", "description": "Log project ID\n" }, "topicId": { "type": "string", "description": "Log topic ID. ProjectId specifies the log topic within the project\n" } }, "type": "object", "required": [ "enable", "projectId", "topicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayMonitorSpec:getGatewayMonitorSpec": { "properties": { "enable": { "type": "boolean", "description": "Managed Prometheus (VMP) service\n" }, "workspaceId": { "type": "string", "description": "Prometheus workspace ID\n" } }, "type": "object", "required": [ "enable", "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayNetworkSpec:getGatewayNetworkSpec": { "properties": { "subnets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/getGatewayNetworkSpecSubnet:getGatewayNetworkSpecSubnet" }, "description": "Subnet configuration information list\n" }, "vpcId": { "type": "string", "description": "VPC ID。\n" }, "vpcName": { "type": "string", "description": "VPC name\n" } }, "type": "object", "required": [ "subnets", "vpcId", "vpcName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayNetworkSpecSubnet:getGatewayNetworkSpecSubnet": { "properties": { "az": { "type": "string", "description": "Availability zone\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" }, "subnetName": { "type": "string", "description": "Subnet name\n" } }, "type": "object", "required": [ "az", "subnetId", "subnetName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayResourceSpec:getGatewayResourceSpec": { "properties": { "clbSpecCode": { "type": "string", "description": "CLB specification code. CLB specifications. Options: small*1: Small I; small*2: Small II; medium*1: Medium I; medium*2: Medium II; large*1: Large I; large*2: Large II\n" }, "instanceSpecCode": { "type": "string", "description": "Node specifications. Options: 1c2g, 2c4g, 4c8g, 8c16g\n" }, "networkType": { "$ref": "#/types/volcenginecc:apig/getGatewayResourceSpecNetworkType:getGatewayResourceSpecNetworkType", "description": "Network type. Default value: enable public network, enable private network\n" }, "publicNetworkBandwidth": { "type": "integer", "description": "Public network bandwidth limit. This field is only used for the 'bandwidth limit billing' public network billing method. Unit: Mbps. Value range: 0–500. Default value: 0\n" }, "publicNetworkBillingType": { "type": "string", "description": "Public network billing method. Options: traffic: billed by actual traffic; bandwidth: billed by bandwidth limit\n" }, "replicas": { "type": "integer", "description": "Node count. Value range: 2–100\n" } }, "type": "object", "required": [ "clbSpecCode", "instanceSpecCode", "networkType", "publicNetworkBandwidth", "publicNetworkBillingType", "replicas" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayResourceSpecNetworkType:getGatewayResourceSpecNetworkType": { "properties": { "enablePrivateNetwork": { "type": "boolean", "description": "Whether to enable private network\n" }, "enablePublicNetwork": { "type": "boolean", "description": "Whether to enable public network\n" } }, "type": "object", "required": [ "enablePrivateNetwork", "enablePublicNetwork" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayServiceAuthSpec:getGatewayServiceAuthSpec": { "properties": { "enable": { "type": "boolean", "description": "Whether authentication is enabled.\n" } }, "type": "object", "required": [ "enable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayServiceCustomDomain:getGatewayServiceCustomDomain": { "properties": { "domain": { "type": "string", "description": "Custom domain.\n" }, "domainId": { "type": "string", "description": "Custom domain ID.\n" } }, "type": "object", "required": [ "domain", "domainId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayServiceDomain:getGatewayServiceDomain": { "properties": { "domain": { "type": "string", "description": "Domain.\n" }, "type": { "type": "string", "description": "Domain type. Options: public: Public network. private: Private network.\n" } }, "type": "object", "required": [ "domain", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayServiceDomainSpec:getGatewayServiceDomainSpec": { "properties": { "enablePublicResolution": { "type": "boolean", "description": "Enable public resolution for private network domains.\n" } }, "type": "object", "required": [ "enablePublicResolution" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayServiceServiceNetworkSpec:getGatewayServiceServiceNetworkSpec": { "properties": { "enablePrivateNetwork": { "type": "boolean", "description": "Enable private network.\n" }, "enablePublicNetwork": { "type": "boolean", "description": "Enable public network.\n" }, "privateNetworkIps": { "type": "array", "items": { "type": "string" }, "description": "Target IP for private network domain resolution.\n" } }, "type": "object", "required": [ "enablePrivateNetwork", "enablePublicNetwork", "privateNetworkIps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayTraceSpec:getGatewayTraceSpec": { "properties": { "apmTraceSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayTraceSpecApmTraceSpec:getGatewayTraceSpecApmTraceSpec", "description": "Application performance monitoring full-link trace configuration\n" }, "enable": { "type": "boolean", "description": "Whether to enable trace\n" }, "tlsTraceSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayTraceSpecTlsTraceSpec:getGatewayTraceSpecTlsTraceSpec", "description": "Link tracing configuration information.\n" }, "traceType": { "type": "string", "description": "Link tracing type. Possible values: tls: Log Service. apm: Application Performance Monitoring (APM) end-to-end version.\n" } }, "type": "object", "required": [ "apmTraceSpec", "enable", "tlsTraceSpec", "traceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayTraceSpecApmTraceSpec:getGatewayTraceSpecApmTraceSpec": { "properties": { "apiKey": { "type": "string", "description": "API Key。\n" } }, "type": "object", "required": [ "apiKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getGatewayTraceSpecTlsTraceSpec:getGatewayTraceSpecTlsTraceSpec": { "properties": { "iamUserAk": { "type": "string", "description": "Access key。\n" }, "iamUserSk": { "type": "string", "description": "Secret key。\n" }, "projectId": { "type": "string", "description": "Log project ID\n" }, "traceId": { "type": "string", "description": "Trace ID。\n" } }, "type": "object", "required": [ "iamUserAk", "iamUserSk", "projectId", "traceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamBackendTarget:getUpstreamBackendTarget": { "properties": { "healthStatus": { "type": "string", "description": "Health Check Status\n" }, "ip": { "type": "string", "description": "Backend node IP\n" }, "port": { "type": "integer", "description": "Backend node port\n" } }, "type": "object", "required": [ "healthStatus", "ip", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamCircuitBreakingSettings:getUpstreamCircuitBreakingSettings": { "properties": { "baseEjectionTime": { "type": "integer", "description": "Minimum pop time, in milliseconds. Value range: 1–86400000. Default: 30 seconds\n" }, "consecutiveErrors": { "type": "integer", "description": "Consecutive failure count. Value range: 1~100. Default: 5\n" }, "enable": { "type": "boolean", "description": "Enable\n" }, "interval": { "type": "integer", "description": "Calculation cycle, in milliseconds. Value range: 1–86400000. Default: 10 seconds\n" }, "maxEjectionPercent": { "type": "integer", "description": "Maximum circuit breaking ratio. Value range: 1~100. Default: 20%\n" }, "minHealthPercent": { "type": "integer", "description": "Minimum health ratio. Value range: 0~100. Default: 60%\n" } }, "type": "object", "required": [ "baseEjectionTime", "consecutiveErrors", "enable", "interval", "maxEjectionPercent", "minHealthPercent" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamConnectionPoolSettings:getUpstreamConnectionPoolSettings": { "properties": { "enable": { "type": "boolean", "description": "Enable\n" }, "http1MaxPendingRequests": { "type": "integer", "description": "Maximum HTTP/1 pending requests. Value range: 0~2^31-1. 0 means unlimited\n" }, "idleTimeout": { "type": "integer", "description": "Idle timeout, in seconds. Value range: 0–2^31-1. 0 means no limit\n" }, "maxConnections": { "type": "integer", "description": "Maximum TCP connections. Value range: 0~2^31-1. 0 means unlimited\n" } }, "type": "object", "required": [ "enable", "http1MaxPendingRequests", "idleTimeout", "maxConnections" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamLoadBalancerSettings:getUpstreamLoadBalancerSettings": { "properties": { "consistentHashLb": { "$ref": "#/types/volcenginecc:apig/getUpstreamLoadBalancerSettingsConsistentHashLb:getUpstreamLoadBalancerSettingsConsistentHashLb", "description": "Consistent Hash Load Balancing\n" }, "lbPolicy": { "type": "string", "description": "Load balancing policy. Options: SimpleLB: simple load balancing. ConsistentHashLB: consistent hash load balancing\n" }, "simpleLb": { "type": "string", "description": "Simple load balancing. Options: ROUND*ROBIN: round robin. LEAST*CONN: least connections. RANDOM: random\n" }, "warmupDuration": { "type": "integer", "description": "Warm-up time (seconds)\n" } }, "type": "object", "required": [ "consistentHashLb", "lbPolicy", "simpleLb", "warmupDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamLoadBalancerSettingsConsistentHashLb:getUpstreamLoadBalancerSettingsConsistentHashLb": { "properties": { "hashBalanceFactor": { "type": "integer", "description": "Overload protection parameter. Value range: 100–200. When set to 120, overload protection is triggered if the current active request count of an upstream node exceeds 120% of the average active request count. When overload protection is triggered, even if the request hash matches a specific upstream node, the load balancer will randomly select an upstream node\n" }, "hashKey": { "type": "string", "description": "Consistent hash method. Options: UseSourceIp: based on source IP address. HttpQueryParameterName: based on parameter. HttpHeaderName: based on header. HTTPCookie: based on cookie\n" }, "httpCookie": { "$ref": "#/types/volcenginecc:apig/getUpstreamLoadBalancerSettingsConsistentHashLbHttpCookie:getUpstreamLoadBalancerSettingsConsistentHashLbHttpCookie", "description": "Cookie。\n" }, "httpHeaderName": { "type": "string", "description": "Parameter. Supports printable ASCII characters, length: 1–256 characters\n" }, "httpQueryParameterName": { "type": "string", "description": "Parameter. Supports printable ASCII characters, length: 1–256 characters\n" }, "useSourceIp": { "type": "string", "description": "Source IP address\n" } }, "type": "object", "required": [ "hashBalanceFactor", "hashKey", "httpCookie", "httpHeaderName", "httpQueryParameterName", "useSourceIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamLoadBalancerSettingsConsistentHashLbHttpCookie:getUpstreamLoadBalancerSettingsConsistentHashLbHttpCookie": { "properties": { "name": { "type": "string", "description": "Name. Supports printable ASCII characters. Length: 0~256 characters\n" }, "path": { "type": "string", "description": "Path. Supports printable ASCII characters. Length: 1~256 characters\n" }, "ttl": { "type": "integer", "description": "Validity period, in seconds\n" } }, "type": "object", "required": [ "name", "path", "ttl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamSourceIngressSettings:getUpstreamSourceIngressSettings": { "properties": { "enableAllIngressClasses": { "type": "boolean", "description": "Whether to enable all Ingress classes\n" }, "enableAllNamespaces": { "type": "boolean", "description": "Whether all namespaces\n" }, "enableIngress": { "type": "boolean", "description": "Whether enabled\n" }, "enableIngressWithoutIngressClass": { "type": "boolean", "description": "Whether to monitor resources with empty IngressClass\n" }, "ingressClasses": { "type": "array", "items": { "type": "string" }, "description": "Specify IngressClass\n" }, "updateStatus": { "type": "boolean", "description": "Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address\n" }, "watchNamespaces": { "type": "array", "items": { "type": "string" }, "description": "Specify namespace\n" } }, "type": "object", "required": [ "enableAllIngressClasses", "enableAllNamespaces", "enableIngress", "enableIngressWithoutIngressClass", "ingressClasses", "updateStatus", "watchNamespaces" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamSourceSourceSpec:getUpstreamSourceSourceSpec": { "properties": { "k8SSource": { "$ref": "#/types/volcenginecc:apig/getUpstreamSourceSourceSpecK8SSource:getUpstreamSourceSourceSpecK8SSource", "description": "Container cluster source\n" }, "nacosSource": { "$ref": "#/types/volcenginecc:apig/getUpstreamSourceSourceSpecNacosSource:getUpstreamSourceSourceSpecNacosSource", "description": "Registry source\n" } }, "type": "object", "required": [ "k8SSource", "nacosSource" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamSourceSourceSpecK8SSource:getUpstreamSourceSourceSpecK8SSource": { "properties": { "clusterId": { "type": "string", "description": "Cluster ID\n" }, "clusterType": { "type": "string", "description": "Cluster type\n" } }, "type": "object", "required": [ "clusterId", "clusterType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamSourceSourceSpecNacosSource:getUpstreamSourceSourceSpecNacosSource": { "properties": { "authConfig": { "$ref": "#/types/volcenginecc:apig/getUpstreamSourceSourceSpecNacosSourceAuthConfig:getUpstreamSourceSourceSpecNacosSourceAuthConfig", "description": "Authentication configuration\n" }, "nacosId": { "type": "string", "description": "Nacos ID。\n" }, "nacosName": { "type": "string", "description": "Nacos name\n" } }, "type": "object", "required": [ "authConfig", "nacosId", "nacosName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamSourceSourceSpecNacosSourceAuthConfig:getUpstreamSourceSourceSpecNacosSourceAuthConfig": { "properties": { "basic": { "$ref": "#/types/volcenginecc:apig/getUpstreamSourceSourceSpecNacosSourceAuthConfigBasic:getUpstreamSourceSourceSpecNacosSourceAuthConfigBasic", "description": "Basic authentication\n" } }, "type": "object", "required": [ "basic" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamSourceSourceSpecNacosSourceAuthConfigBasic:getUpstreamSourceSourceSpecNacosSourceAuthConfigBasic": { "properties": { "password": { "type": "string", "description": "Password\n" }, "username": { "type": "string", "description": "Username\n" } }, "type": "object", "required": [ "password", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamTlsSettings:getUpstreamTlsSettings": { "properties": { "sni": { "type": "string", "description": "SNI. If left blank, the domain name accessed by the gateway will be passed through to the upstream\n" }, "tlsMode": { "type": "string", "description": "TLS mode. Options: DISABLE: disable TLS. SIMPLE: one-way TLS\n" } }, "type": "object", "required": [ "sni", "tlsMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamUpstreamSpec:getUpstreamUpstreamSpec": { "properties": { "aiProvider": { "$ref": "#/types/volcenginecc:apig/getUpstreamUpstreamSpecAiProvider:getUpstreamUpstreamSpecAiProvider", "description": "AI model proxy\n" }, "domain": { "$ref": "#/types/volcenginecc:apig/getUpstreamUpstreamSpecDomain:getUpstreamUpstreamSpecDomain", "description": "Fixed domain name\n" }, "ecsInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/getUpstreamUpstreamSpecEcsInstance:getUpstreamUpstreamSpecEcsInstance" }, "description": "Cloud server\n" }, "k8SService": { "$ref": "#/types/volcenginecc:apig/getUpstreamUpstreamSpecK8SService:getUpstreamUpstreamSpecK8SService", "description": "Container Service\n" }, "nacosService": { "$ref": "#/types/volcenginecc:apig/getUpstreamUpstreamSpecNacosService:getUpstreamUpstreamSpecNacosService", "description": "Registry Center\n" }, "veFaas": { "$ref": "#/types/volcenginecc:apig/getUpstreamUpstreamSpecVeFaas:getUpstreamUpstreamSpecVeFaas", "description": "Function service\n" } }, "type": "object", "required": [ "aiProvider", "domain", "ecsInstances", "k8SService", "nacosService", "veFaas" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamUpstreamSpecAiProvider:getUpstreamUpstreamSpecAiProvider": { "properties": { "baseUrl": { "type": "string", "description": "Model address\n" }, "customModelService": { "$ref": "#/types/volcenginecc:apig/getUpstreamUpstreamSpecAiProviderCustomModelService:getUpstreamUpstreamSpecAiProviderCustomModelService", "description": "Volcano Engine self-hosted model service\n" }, "name": { "type": "string", "description": "Model Service Provider Name\n" }, "token": { "type": "string", "description": "Model API key\n" } }, "type": "object", "required": [ "baseUrl", "customModelService", "name", "token" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamUpstreamSpecAiProviderCustomModelService:getUpstreamUpstreamSpecAiProviderCustomModelService": { "properties": { "name": { "type": "string", "description": "Model Service Name\n" }, "namespace": { "type": "string", "description": "Namespace\n" }, "port": { "type": "integer", "description": "Port\n" } }, "type": "object", "required": [ "name", "namespace", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamUpstreamSpecDomain:getUpstreamUpstreamSpecDomain": { "properties": { "domainLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/getUpstreamUpstreamSpecDomainDomainList:getUpstreamUpstreamSpecDomainDomainList" }, "description": "Domain name list\n" } }, "type": "object", "required": [ "domainLists" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamUpstreamSpecDomainDomainList:getUpstreamUpstreamSpecDomainDomainList": { "properties": { "domain": { "type": "string", "description": "Domain name\n" }, "port": { "type": "integer", "description": "Port. Default: 80 for HTTP, 443 for HTTPS\n" } }, "type": "object", "required": [ "domain", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamUpstreamSpecEcsInstance:getUpstreamUpstreamSpecEcsInstance": { "properties": { "ecsId": { "type": "string", "description": "Cloud server ID\n" }, "ip": { "type": "string", "description": "IP address\n" }, "port": { "type": "integer", "description": "Port\n" } }, "type": "object", "required": [ "ecsId", "ip", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamUpstreamSpecK8SService:getUpstreamUpstreamSpecK8SService": { "properties": { "name": { "type": "string", "description": "Container Service Name. Length: 2–63 characters\n" }, "namespace": { "type": "string", "description": "Namespace. Length: 2~63 characters\n" }, "port": { "type": "integer", "description": "Port\n" } }, "type": "object", "required": [ "name", "namespace", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamUpstreamSpecNacosService:getUpstreamUpstreamSpecNacosService": { "properties": { "group": { "type": "string", "description": "Group\n" }, "namespace": { "type": "string", "description": "Namespace\n" }, "namespaceId": { "type": "string", "description": "Namespace ID\n" }, "service": { "type": "string", "description": "Service\n" }, "upstreamSourceId": { "type": "string", "description": "Upstream source ID\n" } }, "type": "object", "required": [ "group", "namespace", "namespaceId", "service", "upstreamSourceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamUpstreamSpecVeFaas:getUpstreamUpstreamSpecVeFaas": { "properties": { "functionId": { "type": "string", "description": "Function ID\n" } }, "type": "object", "required": [ "functionId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamVersionDetail:getUpstreamVersionDetail": { "properties": { "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/getUpstreamVersionDetailLabel:getUpstreamVersionDetailLabel" }, "description": "Tag\n" }, "name": { "type": "string", "description": "Version name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length: 2~63 characters. Cannot start with a hyphen (-)\n" }, "updateTime": { "type": "string", "description": "Update time\n" } }, "type": "object", "required": [ "labels", "name", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:apig/getUpstreamVersionDetailLabel:getUpstreamVersionDetailLabel": { "properties": { "key": { "type": "string", "description": "Key\n" }, "value": { "type": "string", "description": "Value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ark/EndpointCertificate:EndpointCertificate": { "properties": { "notAfter": { "type": "integer", "description": "X509 private certificate expiration time, represented as a timestamp in seconds\n" }, "notBefore": { "type": "integer", "description": "X509 private certificate activation time, represented as a timestamp in seconds\n" }, "pcaHost": { "type": "string", "description": "Certificate subject\n" }, "pcaInstanceCertificate": { "type": "string", "description": "PEM format leaf certificate\n" }, "pcaName": { "type": "string", "description": "Certificate name\n" }, "pcaRootCaCertificate": { "type": "string", "description": "PEM format root certificate\n" }, "pcaSubCaCertificate": { "type": "string", "description": "Intermediate certificate and root certificate in PEM format\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "notAfter", "notBefore", "pcaHost", "pcaInstanceCertificate", "pcaName", "pcaRootCaCertificate", "pcaSubCaCertificate" ] } } }, "volcenginecc:ark/EndpointModelReference:EndpointModelReference": { "properties": { "customModelId": { "type": "string", "description": "Custom model ID\n" }, "foundationModel": { "$ref": "#/types/volcenginecc:ark/EndpointModelReferenceFoundationModel:EndpointModelReferenceFoundationModel", "description": "Base model\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customModelId", "foundationModel" ] } } }, "volcenginecc:ark/EndpointModelReferenceFoundationModel:EndpointModelReferenceFoundationModel": { "properties": { "modelVersion": { "type": "string", "description": "Base model version\n" }, "name": { "type": "string", "description": "Base model name. Note: Model names are lowercase. The model name format for doubao 1.5 generation models is \"doubao-1-5-**\".\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "modelVersion", "name" ] } } }, "volcenginecc:ark/EndpointModeration:EndpointModeration": { "properties": { "strategy": { "type": "string", "description": "Content safety guardrail scheme. Values: Default: default scheme. Lower latency, broadly covers general content safety requirements; Basic: basic scheme (public beta). Supports providing triggered risk categories in interface responses, currently only includes two risk types: severe violations and aggressive behavior. Note: If using streaming interface calls, this scheme is not recommended, as it will increase the length of each output fragment and raise latency\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "strategy" ] } } }, "volcenginecc:ark/EndpointRateLimit:EndpointRateLimit": { "properties": { "rpm": { "type": "integer", "description": "Requests Per Minute, number of requests per minute\n" }, "tpm": { "type": "integer", "description": "Tokens Per Minute, number of tokens requested per minute\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "rpm", "tpm" ] } } }, "volcenginecc:ark/EndpointTag:EndpointTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ark/getEndpointCertificate:getEndpointCertificate": { "properties": { "notAfter": { "type": "integer", "description": "X509 private certificate expiration time, represented as a timestamp in seconds\n" }, "notBefore": { "type": "integer", "description": "X509 private certificate activation time, represented as a timestamp in seconds\n" }, "pcaHost": { "type": "string", "description": "Certificate subject\n" }, "pcaInstanceCertificate": { "type": "string", "description": "PEM format leaf certificate\n" }, "pcaName": { "type": "string", "description": "Certificate name\n" }, "pcaRootCaCertificate": { "type": "string", "description": "PEM format root certificate\n" }, "pcaSubCaCertificate": { "type": "string", "description": "Intermediate certificate and root certificate in PEM format\n" } }, "type": "object", "required": [ "notAfter", "notBefore", "pcaHost", "pcaInstanceCertificate", "pcaName", "pcaRootCaCertificate", "pcaSubCaCertificate" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ark/getEndpointModelReference:getEndpointModelReference": { "properties": { "customModelId": { "type": "string", "description": "Custom model ID\n" }, "foundationModel": { "$ref": "#/types/volcenginecc:ark/getEndpointModelReferenceFoundationModel:getEndpointModelReferenceFoundationModel", "description": "Base model\n" } }, "type": "object", "required": [ "customModelId", "foundationModel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ark/getEndpointModelReferenceFoundationModel:getEndpointModelReferenceFoundationModel": { "properties": { "modelVersion": { "type": "string", "description": "Base model version\n" }, "name": { "type": "string", "description": "Base model name. Note: Model names are lowercase. The model name format for doubao 1.5 generation models is \"doubao-1-5-**\".\n" } }, "type": "object", "required": [ "modelVersion", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ark/getEndpointModeration:getEndpointModeration": { "properties": { "strategy": { "type": "string", "description": "Content safety guardrail scheme. Values: Default: default scheme. Lower latency, broadly covers general content safety requirements; Basic: basic scheme (public beta). Supports providing triggered risk categories in interface responses, currently only includes two risk types: severe violations and aggressive behavior. Note: If using streaming interface calls, this scheme is not recommended, as it will increase the length of each output fragment and raise latency\n" } }, "type": "object", "required": [ "strategy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ark/getEndpointRateLimit:getEndpointRateLimit": { "properties": { "rpm": { "type": "integer", "description": "Requests Per Minute, number of requests per minute\n" }, "tpm": { "type": "integer", "description": "Tokens Per Minute, number of tokens requested per minute\n" } }, "type": "object", "required": [ "rpm", "tpm" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ark/getEndpointTag:getEndpointTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/ScalingConfigurationEip:ScalingConfigurationEip": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth for the public IP. Default is 1, unit: Mbps. Value: When Eip.BillingType is set to PostPaidByBandwidth, the value is 1–500. When Eip.BillingType is set to PostPaidByTraffic, the value is 1–200.\n" }, "bandwidthPackageId": { "type": "string", "description": "ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. You can call the DescribeBandwidthPackages API to query the shared bandwidth package ID. The public IP can be added to the shared bandwidth package only if the following conditions are met: Both have the same security protection type. Both have the same line type. The shared bandwidth package is IPv4 type.\n" }, "billingType": { "type": "string", "description": "Billing type for public IP. Options: PostPaidByBandwidth (default): Pay-as-you-go, billed by bandwidth cap. PostPaidByTraffic: Pay-as-you-go, billed by actual traffic.\n" }, "isp": { "type": "string", "description": "Line type. Values: BGP (default): BGP line. If your account has applied for static single line, ISP can also be set to ChinaMobile (China Mobile), ChinaTelecom (China Telecom), or ChinaUnicom (China Unicom).\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether the public IP is deleted along with the instance. This applies only to pay-as-you-go public IPs and takes effect when deleting the instance in the ECS console. For retention details after deleting an instance in a scaling group, see the detailed instructions in instance management. Values: true: The public IP is deleted with the instance. false: The public IP is not deleted with the instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "bandwidthPackageId", "billingType", "isp", "releaseWithInstance" ] } } }, "volcenginecc:autoscaling/ScalingConfigurationInstanceTypeOverride:ScalingConfigurationInstanceTypeOverride": { "properties": { "instanceType": { "type": "string", "description": "Specify the specifications for preemptible instances. Parameter - N: Indicates the sequence number of the instance specification, value range 1–10. Value - InstanceType: Specifies the specification for the preemptible instance. Use \u0026 to separate multiple specifications.\n" }, "priceLimit": { "type": "number", "description": "Specify the maximum hourly price for preemptible instance types. Parameter - N: Indicates the instance type sequence number. Value: 1–10. PriceLimit: Specifies the maximum hourly price for the preemptible instance type. Value: Greater than 0, up to three decimal places. Use \u0026 to separate multiple prices.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceType", "priceLimit" ] } } }, "volcenginecc:autoscaling/ScalingConfigurationTag:ScalingConfigurationTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:autoscaling/ScalingConfigurationVolume:ScalingConfigurationVolume": { "properties": { "deleteWithInstance": { "type": "boolean", "description": "Whether the cloud disk is released with the instance: true (default): The cloud disk is released with the instance. false: The cloud disk is not released with the instance. When set to false, this does not apply to system disks. System disks are always released with the instance and cannot be retained.\n" }, "extraPerformanceIops": { "type": "integer", "description": "You can use this parameter to configure the extra performance package IOPS size for cloud disks. Only ESSD FlexPL is supported. Parameter - N: Indicates the disk sequence number. '1' represents the system disk; '2' or greater represents a data disk. Only data disks support extra performance packages. Value: 2–16. ExtraPerformanceIOPS specifies the extra performance package IOPS size for the Nth disk: IOPS: 1–50000. Balance: 1–50000.\n" }, "extraPerformanceThroughputMb": { "type": "integer", "description": "You can use this parameter to configure the extra performance package throughput size for cloud disks, in MB/s. Only ESSD FlexPL is supported. Parameter - N: Indicates the disk sequence number. '1' represents the system disk; '2' or greater represents a data disk. Only data disks support extra performance packages. Value: 2–16. ExtraPerformanceThroughputMB specifies the extra performance package throughput size for the Nth disk: Throughput: 1–650.\n" }, "extraPerformanceTypeId": { "type": "string", "description": "This parameter allows you to purchase extra performance for cloud disks. Only ESSD FlexPL is supported. Parameter - N: Indicates the disk sequence number. \"1\" is the system disk; \"2\" or greater indicates a data disk. Only data disks support extra performance packages. Value: 2–16. ExtraPerformanceTypeId specifies the extra performance package type for the Nth disk: IOPS: IOPS type, use the ExtraPerformanceIOPS parameter. Balance: Balanced type, use the ExtraPerformanceIOPS parameter. Throughput: Throughput type, use the ExtraPerformanceThroughputMB parameter.\n" }, "size": { "type": "integer", "description": "Cloud disk capacity, in GiB. System disk range: 10–500. Data disk range: 10–8192. If using ESSD_FlexPL with additional performance, size must be \u003e= 500 GB\n" }, "volumeType": { "type": "string", "description": "Cloud disk types: ESSD*FlexPL: Extreme SSD FlexPL. ESSD*PL0: Extreme SSD PL0.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deleteWithInstance", "extraPerformanceIops", "extraPerformanceThroughputMb", "extraPerformanceTypeId", "size", "volumeType" ] } } }, "volcenginecc:autoscaling/ScalingGroupInstance:ScalingGroupInstance": { "properties": { "createdTime": { "type": "string", "description": "Time when the instance joined the scaling group\n" }, "creationType": { "type": "string", "description": "How the instance joined the scaling group (Attached / AutoCreated)\n" }, "entrusted": { "type": "boolean", "description": "Whether to enable managed mode for the instance when AttachInstances is performed\n" }, "instanceId": { "type": "string", "description": "ECS instance ID, unique identifier of the subresource\n" }, "launchTemplateId": { "type": "string", "description": "Launch template ID used by the instance\n" }, "launchTemplateVersion": { "type": "string", "description": "Launch template version used by the instance\n" }, "lifecycleHook": { "type": "boolean", "description": "Whether to trigger lifecycle hooks when the instance is attached, detached, or removed\n" }, "scalingConfigurationId": { "type": "string", "description": "Scaling configuration ID associated with the instance\n" }, "scalingPolicyId": { "type": "string", "description": "Scaling policy ID associated with the instance\n" }, "status": { "type": "string", "description": "Current status of the instance in the scaling group\n" }, "zoneId": { "type": "string", "description": "Availability zone of the instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createdTime", "creationType", "entrusted", "instanceId", "launchTemplateId", "launchTemplateVersion", "lifecycleHook", "scalingConfigurationId", "scalingPolicyId", "status", "zoneId" ] } } }, "volcenginecc:autoscaling/ScalingGroupInstanceRemovePolicy:ScalingGroupInstanceRemovePolicy": { "properties": { "decreaseDesiredCapacity": { "type": "boolean", "description": "Whether to decrease the desired instance count synchronously when DetachInstances or RemoveInstances is performed\n" }, "detachOption": { "type": "string", "description": "Instance removal policy for DetachInstances\n" }, "forceDelete": { "type": "boolean", "description": "Whether to force delete the instance when RemoveInstances is performed\n" }, "instanceId": { "type": "string", "description": "ECS instance ID, unique identifier of the subresource\n" }, "lifecycleHook": { "type": "boolean", "description": "Whether to trigger lifecycle hooks when the instance is attached, detached, or removed\n" }, "mode": { "type": "string", "description": "Mode: How to handle an instance when it is removed from the scaling group: Detach means only remove from the scaling group, Remove means remove and delete the instance\n" }, "removeMode": { "type": "string", "description": "Removal mode for RemoveInstances\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "decreaseDesiredCapacity", "detachOption", "forceDelete", "instanceId", "lifecycleHook", "mode", "removeMode" ] } } }, "volcenginecc:autoscaling/ScalingGroupInstancesDistribution:ScalingGroupInstancesDistribution": { "properties": { "compensateWithOnDemand": { "type": "boolean", "description": "Whether pay-as-you-go instances are allowed to supplement spot capacity if spot instances cannot be created due to price or inventory constraints. true: allowed. false (default): not allowed.\n" }, "onDemandBaseCapacity": { "type": "integer", "description": "Minimum number of pay-as-you-go instances in the scaling group. Value range: 0~2000. If the number of pay-as-you-go instances in the group is less than this value, pay-as-you-go instances will be prioritized for creation.\n" }, "onDemandPercentageAboveBaseCapacity": { "type": "integer", "description": "After the scaling group meets the minimum number of pay-as-you-go instances, the proportion of pay-as-you-go instances among the excess instances. Value range: 0–100.\n" }, "spotInstanceRemedy": { "type": "boolean", "description": "Whether to allow preemptible instance replacement upon expiration. If enabled, the scaling group will proactively create a new preemptible instance to replace the current one about 5 minutes before the preemptible instance is reclaimed. true: allowed. false (default): not allowed.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compensateWithOnDemand", "onDemandBaseCapacity", "onDemandPercentageAboveBaseCapacity", "spotInstanceRemedy" ] } } }, "volcenginecc:autoscaling/ScalingGroupLaunchTemplateOverride:ScalingGroupLaunchTemplateOverride": { "properties": { "instanceType": { "type": "string", "description": "Specify the instance type. This parameter is valid only when the LaunchTemplateId parameter is set.\n" }, "priceLimit": { "type": "number", "description": "Specify the maximum hourly price for spot instance types. This parameter is valid only when the LaunchTemplateId parameter is set and the launch template's billing mode is SpotWithPriceLimit.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceType", "priceLimit" ] } } }, "volcenginecc:autoscaling/ScalingGroupServerGroupAttribute:ScalingGroupServerGroupAttribute": { "properties": { "port": { "type": "integer", "description": "Port number of the server in the backend server group for load balancing. Range: 1–65535.\n" }, "serverGroupId": { "type": "string", "description": "Backend server group ID for load balancing.\n" }, "type": { "type": "string", "description": "Load balancing server group type. A single CLB/ALB supports up to 20 backend server groups, and the total number of backend servers supported by all CLB/ALB is 100. ALB: Application Load Balancer. CLB: Classic Load Balancer (default).\n" }, "weight": { "type": "integer", "description": "Weight of servers in the backend server group of the load balancer\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "port", "serverGroupId", "type", "weight" ] } } }, "volcenginecc:autoscaling/ScalingGroupTag:ScalingGroupTag": { "properties": { "key": { "type": "string", "description": "User label tag key\n" }, "value": { "type": "string", "description": "The value of the user tag.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:autoscaling/ScalingLifecycleHookLifecycleCommand:ScalingLifecycleHookLifecycleCommand": { "properties": { "commandId": { "type": "string", "description": "Cloud Assistant command ID, indicates that after the lifecycle hook is triggered, the Cloud Assistant command is executed on the instance. If the command executes successfully, the post-suspend policy is executed according to CONTINUE. If the command fails, times out, or the lifecycle hook times out, the post-suspend policy is executed according to the LifecycleHookPolicy parameter configuration.\n" }, "parameters": { "type": "string", "description": "Parameters and values in the Cloud Assistant command. The number of parameters ranges from 0 to 60. Note: Parameters cannot be empty strings and can have up to 64 characters. Values can be empty strings. After Base64 encoding, the combined length of parameters and the original command content must not exceed 16 KB. The set of parameter names must be a subset of the parameter set defined when creating the command. Default values are used for parameters not provided.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "commandId", "parameters" ] } } }, "volcenginecc:autoscaling/ScalingPolicyAlarmPolicy:ScalingPolicyAlarmPolicy": { "properties": { "condition": { "$ref": "#/types/volcenginecc:autoscaling/ScalingPolicyAlarmPolicyCondition:ScalingPolicyAlarmPolicyCondition", "description": "Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.\n" }, "conditionOperator": { "type": "string", "description": "Determination conditions for multi-metric alarms. \u0026\u0026: Alarm is triggered only when all metrics meet the conditions. || (default): Alarm is triggered when any metric meets the condition.\n" }, "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingPolicyAlarmPolicyCondition:ScalingPolicyAlarmPolicyCondition" } }, "effective": { "type": "string", "description": "The effective period for the alarm task.\n" }, "evaluationCount": { "type": "integer", "description": "Scaling actions are triggered when monitoring metric data reaches the threshold for several consecutive times. Valid only when ScalingPolicyType is set to Alarm and required.\n" }, "ruleType": { "type": "string", "description": "Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "conditionOperator", "conditions", "effective", "evaluationCount", "ruleType" ] } } }, "volcenginecc:autoscaling/ScalingPolicyAlarmPolicyCondition:ScalingPolicyAlarmPolicyCondition": { "properties": { "comparisonOperator": { "type": "string", "description": "Rule expression object for metric alarms. \u003e: Greater than. \u003c: Less than. =: Equal to.\n" }, "metricName": { "type": "string", "description": "Monitoring metric names for metric alarms. CpuTotal*Max: Maximum in-band CPU usage. CpuTotal*Min: Minimum in-band CPU usage. CpuTotal*Avg: Average in-band CPU usage. MemoryUsedUtilization*Max: Maximum in-band memory usage. MemoryUsedUtilization*Min: Minimum in-band memory usage. MemoryUsedUtilization*Avg: Average in-band memory usage. Instance*CpuBusy*Max: Maximum out-of-band CPU utilization. Instance*CpuBusy*Min: Minimum out-of-band CPU utilization. Instance*CpuBusy*Avg: Average out-of-band CPU utilization. Instance*NetTxBits*Avg: Average out-of-band network outbound rate. Instance*NetRxBits*Avg: Average out-of-band network inbound rate. Instance*NetTxPackets*Avg: Average out-of-band network packet send rate. Instance*NetRxPackets*Avg: Average out-of-band network packet receive rate. SystemDiskReadBytes*Avg: Average in-band system disk read bandwidth. SystemDiskWriteBytes*Avg: Average in-band system disk write bandwidth. SystemDiskReadIOPS*Avg: Average in-band system disk read IOPS. SystemDiskWriteIOPS*Avg: Average in-band system disk write IOPS. NetTcpConnection_Avg: Average in-band TCP connection count.\n" }, "metricUnit": { "type": "string", "description": "The unit for the monitoring metric threshold when an alarm is triggered. When the AlarmPolicy.Conditions.MetricName parameter is set to CPU/memory usage: Percent. When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write bandwidth: Bytes/Second(IEC). When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write IOPS: Count/Second. When the AlarmPolicy.Conditions.MetricName parameter is set to TCP connections: Count. When the AlarmPolicy.Condition.MetricName parameter is set to network inbound/outbound rate: Bits/Second(IEC). When the AlarmPolicy.Condition.MetricName parameter is set to network packet transmission rate: Packet/Second.\n" }, "threshold": { "type": "string", "description": "The threshold value for the monitoring metric when an alarm is triggered. When AlarmPolicy.Conditions.MetricUnit is set to Percent: 1–100. When AlarmPolicy.Conditions.MetricUnit is set to Bytes/Second(IEC): an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count/Second: an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count: an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Bits/Second(IEC): an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Packet/Second: an integer greater than 0.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "comparisonOperator", "metricName", "metricUnit", "threshold" ] } } }, "volcenginecc:autoscaling/ScalingPolicyScheduledPolicy:ScalingPolicyScheduledPolicy": { "properties": { "launchTime": { "type": "string", "description": "Indicates the trigger time for the task. The default is the current time. When ScalingPolicyType is set to Scheduled, this specifies the trigger time for the scheduled task. When ScalingPolicyType is set to Recurrence: If ScheduledPolicy.RecurrenceType is empty, the task is executed only once at the specified date and time. If ScheduledPolicy.RecurrenceType is not empty, this specifies the start time for the recurring task.\n" }, "launchTimeRead": { "type": "string", "description": "Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.\n" }, "recurrenceEndTime": { "type": "string", "description": "Indicates the end time for the recurring task. Only supports selecting a time within 365 days from the creation date. If not configured, defaults to one day/week/month after the current time based on the recurrence cycle (ScheduledPolicy.RecurrenceType). If set to empty, the task never stops. Valid only when ScalingPolicyType is set to Recurrence and required.\n" }, "recurrenceEndTimeRead": { "type": "string", "description": "Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.\n" }, "recurrenceStartTime": { "type": "string", "description": "Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.\n" }, "recurrenceType": { "type": "string", "description": "Indicates the recurrence cycle for scheduled tasks. Values: Daily: Executes once every XX days. Weekly: Select specific days of the week, executes once per day. Monthly: Select XX to XX days of the month, executes once per day. Cron: Executes according to the specified Cron expression. Required and valid only when ScalingPolicyType is set to Recurrence.\n" }, "recurrenceValue": { "type": "string", "description": "Specifies the value for recurring tasks. When the ScheduledPolicy.RecurrenceType parameter is set to Daily, only one value can be entered: 1–31. When the ScheduledPolicy.RecurrenceType parameter is set to Weekly, multiple values can be entered, separated by commas (,). Values for Monday to Sunday are: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday). When the ScheduledPolicy.RecurrenceType parameter is set to Monthly, the format is A-B. Both A and B range from 1–31, and B must be greater than or equal to A. When the ScheduledPolicy.RecurrenceType parameter is set to Cron, it uses UTC+8 time and supports a five-field expression for minute, hour, day, month, and week. Wildcards supported include comma (,), question mark (?), hyphen (-), asterisk (*), hash (#), slash (/), L, and W. This field is valid and required when ScalingPolicyType is set to Recurrence.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "launchTime", "launchTimeRead", "recurrenceEndTime", "recurrenceEndTimeRead", "recurrenceStartTime", "recurrenceType", "recurrenceValue" ] } } }, "volcenginecc:autoscaling/getScalingConfigurationEip:getScalingConfigurationEip": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth for the public IP. Default is 1, unit: Mbps. Value: When Eip.BillingType is set to PostPaidByBandwidth, the value is 1–500. When Eip.BillingType is set to PostPaidByTraffic, the value is 1–200.\n" }, "bandwidthPackageId": { "type": "string", "description": "ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. You can call the DescribeBandwidthPackages API to query the shared bandwidth package ID. The public IP can be added to the shared bandwidth package only if the following conditions are met: Both have the same security protection type. Both have the same line type. The shared bandwidth package is IPv4 type.\n" }, "billingType": { "type": "string", "description": "Billing type for public IP. Options: PostPaidByBandwidth (default): Pay-as-you-go, billed by bandwidth cap. PostPaidByTraffic: Pay-as-you-go, billed by actual traffic.\n" }, "isp": { "type": "string", "description": "Line type. Values: BGP (default): BGP line. If your account has applied for static single line, ISP can also be set to ChinaMobile (China Mobile), ChinaTelecom (China Telecom), or ChinaUnicom (China Unicom).\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether the public IP is deleted along with the instance. This applies only to pay-as-you-go public IPs and takes effect when deleting the instance in the ECS console. For retention details after deleting an instance in a scaling group, see the detailed instructions in instance management. Values: true: The public IP is deleted with the instance. false: The public IP is not deleted with the instance\n" } }, "type": "object", "required": [ "bandwidth", "bandwidthPackageId", "billingType", "isp", "releaseWithInstance" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingConfigurationInstanceTypeOverride:getScalingConfigurationInstanceTypeOverride": { "properties": { "instanceType": { "type": "string", "description": "Specify the specifications for preemptible instances. Parameter - N: Indicates the sequence number of the instance specification, value range 1–10. Value - InstanceType: Specifies the specification for the preemptible instance. Use \u0026 to separate multiple specifications.\n" }, "priceLimit": { "type": "number", "description": "Specify the maximum hourly price for preemptible instance types. Parameter - N: Indicates the instance type sequence number. Value: 1–10. PriceLimit: Specifies the maximum hourly price for the preemptible instance type. Value: Greater than 0, up to three decimal places. Use \u0026 to separate multiple prices.\n" } }, "type": "object", "required": [ "instanceType", "priceLimit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingConfigurationTag:getScalingConfigurationTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingConfigurationVolume:getScalingConfigurationVolume": { "properties": { "deleteWithInstance": { "type": "boolean", "description": "Whether the cloud disk is released with the instance: true (default): The cloud disk is released with the instance. false: The cloud disk is not released with the instance. When set to false, this does not apply to system disks. System disks are always released with the instance and cannot be retained.\n" }, "extraPerformanceIops": { "type": "integer", "description": "You can use this parameter to configure the extra performance package IOPS size for cloud disks. Only ESSD FlexPL is supported. Parameter - N: Indicates the disk sequence number. '1' represents the system disk; '2' or greater represents a data disk. Only data disks support extra performance packages. Value: 2–16. ExtraPerformanceIOPS specifies the extra performance package IOPS size for the Nth disk: IOPS: 1–50000. Balance: 1–50000.\n" }, "extraPerformanceThroughputMb": { "type": "integer", "description": "You can use this parameter to configure the extra performance package throughput size for cloud disks, in MB/s. Only ESSD FlexPL is supported. Parameter - N: Indicates the disk sequence number. '1' represents the system disk; '2' or greater represents a data disk. Only data disks support extra performance packages. Value: 2–16. ExtraPerformanceThroughputMB specifies the extra performance package throughput size for the Nth disk: Throughput: 1–650.\n" }, "extraPerformanceTypeId": { "type": "string", "description": "This parameter allows you to purchase extra performance for cloud disks. Only ESSD FlexPL is supported. Parameter - N: Indicates the disk sequence number. \"1\" is the system disk; \"2\" or greater indicates a data disk. Only data disks support extra performance packages. Value: 2–16. ExtraPerformanceTypeId specifies the extra performance package type for the Nth disk: IOPS: IOPS type, use the ExtraPerformanceIOPS parameter. Balance: Balanced type, use the ExtraPerformanceIOPS parameter. Throughput: Throughput type, use the ExtraPerformanceThroughputMB parameter.\n" }, "size": { "type": "integer", "description": "Cloud disk capacity, in GiB. System disk range: 10–500. Data disk range: 10–8192. If using ESSD_FlexPL with additional performance, size must be \u003e= 500 GB\n" }, "volumeType": { "type": "string", "description": "Cloud disk types: ESSD*FlexPL: Extreme SSD FlexPL. ESSD*PL0: Extreme SSD PL0.\n" } }, "type": "object", "required": [ "deleteWithInstance", "extraPerformanceIops", "extraPerformanceThroughputMb", "extraPerformanceTypeId", "size", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingGroupInstance:getScalingGroupInstance": { "properties": { "createdTime": { "type": "string", "description": "Time when the instance joined the scaling group\n" }, "creationType": { "type": "string", "description": "How the instance joined the scaling group (Attached / AutoCreated)\n" }, "entrusted": { "type": "boolean", "description": "Whether to enable managed mode for the instance when AttachInstances is performed\n" }, "instanceId": { "type": "string", "description": "ECS instance ID, unique identifier of the subresource\n" }, "launchTemplateId": { "type": "string", "description": "Launch template ID used by the instance\n" }, "launchTemplateVersion": { "type": "string", "description": "Launch template version used by the instance\n" }, "lifecycleHook": { "type": "boolean", "description": "Whether to trigger lifecycle hooks when the instance is attached, detached, or removed\n" }, "scalingConfigurationId": { "type": "string", "description": "Scaling configuration ID associated with the instance\n" }, "scalingPolicyId": { "type": "string", "description": "Scaling policy ID associated with the instance\n" }, "status": { "type": "string", "description": "Current status of the instance in the scaling group\n" }, "zoneId": { "type": "string", "description": "Availability zone of the instance\n" } }, "type": "object", "required": [ "createdTime", "creationType", "entrusted", "instanceId", "launchTemplateId", "launchTemplateVersion", "lifecycleHook", "scalingConfigurationId", "scalingPolicyId", "status", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingGroupInstanceRemovePolicy:getScalingGroupInstanceRemovePolicy": { "properties": { "decreaseDesiredCapacity": { "type": "boolean", "description": "Whether to decrease the desired instance count synchronously when DetachInstances or RemoveInstances is performed\n" }, "detachOption": { "type": "string", "description": "Instance removal policy for DetachInstances\n" }, "forceDelete": { "type": "boolean", "description": "Whether to force delete the instance when RemoveInstances is performed\n" }, "instanceId": { "type": "string", "description": "ECS instance ID, unique identifier of the subresource\n" }, "lifecycleHook": { "type": "boolean", "description": "Whether to trigger lifecycle hooks when the instance is attached, detached, or removed\n" }, "mode": { "type": "string", "description": "Mode: How to handle an instance when it is removed from the scaling group: Detach means only remove from the scaling group, Remove means remove and delete the instance\n" }, "removeMode": { "type": "string", "description": "Removal mode for RemoveInstances\n" } }, "type": "object", "required": [ "decreaseDesiredCapacity", "detachOption", "forceDelete", "instanceId", "lifecycleHook", "mode", "removeMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingGroupInstancesDistribution:getScalingGroupInstancesDistribution": { "properties": { "compensateWithOnDemand": { "type": "boolean", "description": "Whether pay-as-you-go instances are allowed to supplement spot capacity if spot instances cannot be created due to price or inventory constraints. true: allowed. false (default): not allowed.\n" }, "onDemandBaseCapacity": { "type": "integer", "description": "Minimum number of pay-as-you-go instances in the scaling group. Value range: 0~2000. If the number of pay-as-you-go instances in the group is less than this value, pay-as-you-go instances will be prioritized for creation.\n" }, "onDemandPercentageAboveBaseCapacity": { "type": "integer", "description": "After the scaling group meets the minimum number of pay-as-you-go instances, the proportion of pay-as-you-go instances among the excess instances. Value range: 0–100.\n" }, "spotInstanceRemedy": { "type": "boolean", "description": "Whether to allow preemptible instance replacement upon expiration. If enabled, the scaling group will proactively create a new preemptible instance to replace the current one about 5 minutes before the preemptible instance is reclaimed. true: allowed. false (default): not allowed.\n" } }, "type": "object", "required": [ "compensateWithOnDemand", "onDemandBaseCapacity", "onDemandPercentageAboveBaseCapacity", "spotInstanceRemedy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingGroupLaunchTemplateOverride:getScalingGroupLaunchTemplateOverride": { "properties": { "instanceType": { "type": "string", "description": "Specify the instance type. This parameter is valid only when the LaunchTemplateId parameter is set.\n" }, "priceLimit": { "type": "number", "description": "Specify the maximum hourly price for spot instance types. This parameter is valid only when the LaunchTemplateId parameter is set and the launch template's billing mode is SpotWithPriceLimit.\n" }, "weightedCapacity": { "type": "integer", "description": "Instance type weight\n" } }, "type": "object", "required": [ "instanceType", "priceLimit", "weightedCapacity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingGroupServerGroupAttribute:getScalingGroupServerGroupAttribute": { "properties": { "loadBalancerId": { "type": "string", "description": "ID of the load balancer instance.\n" }, "port": { "type": "integer", "description": "Port number of the server in the backend server group for load balancing. Range: 1–65535.\n" }, "serverGroupId": { "type": "string", "description": "Backend server group ID for load balancing.\n" }, "type": { "type": "string", "description": "Load balancing server group type. A single CLB/ALB supports up to 20 backend server groups, and the total number of backend servers supported by all CLB/ALB is 100. ALB: Application Load Balancer. CLB: Classic Load Balancer (default).\n" }, "weight": { "type": "integer", "description": "Weight of servers in the backend server group of the load balancer\n" } }, "type": "object", "required": [ "loadBalancerId", "port", "serverGroupId", "type", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingGroupTag:getScalingGroupTag": { "properties": { "key": { "type": "string", "description": "User label tag key\n" }, "value": { "type": "string", "description": "The value of the user tag.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingLifecycleHookLifecycleCommand:getScalingLifecycleHookLifecycleCommand": { "properties": { "commandId": { "type": "string", "description": "Cloud Assistant command ID, indicates that after the lifecycle hook is triggered, the Cloud Assistant command is executed on the instance. If the command executes successfully, the post-suspend policy is executed according to CONTINUE. If the command fails, times out, or the lifecycle hook times out, the post-suspend policy is executed according to the LifecycleHookPolicy parameter configuration.\n" }, "parameters": { "type": "string", "description": "Parameters and values in the Cloud Assistant command. The number of parameters ranges from 0 to 60. Note: Parameters cannot be empty strings and can have up to 64 characters. Values can be empty strings. After Base64 encoding, the combined length of parameters and the original command content must not exceed 16 KB. The set of parameter names must be a subset of the parameter set defined when creating the command. Default values are used for parameters not provided.\n" } }, "type": "object", "required": [ "commandId", "parameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingPolicyAlarmPolicy:getScalingPolicyAlarmPolicy": { "properties": { "condition": { "$ref": "#/types/volcenginecc:autoscaling/getScalingPolicyAlarmPolicyCondition:getScalingPolicyAlarmPolicyCondition", "description": "Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.\n" }, "conditionOperator": { "type": "string", "description": "Determination conditions for multi-metric alarms. \u0026\u0026: Alarm is triggered only when all metrics meet the conditions. || (default): Alarm is triggered when any metric meets the condition.\n" }, "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/getScalingPolicyAlarmPolicyCondition:getScalingPolicyAlarmPolicyCondition" }, "description": "Detailed information about monitoring metrics for multi-metric monitoring. Valid only when ScalingPolicyType is set to Alarm. You must configure either AlarmPolicy.Condition.x or AlarmPolicy.Conditions.x parameters. If both are configured, only AlarmPolicy.Conditions.x takes effect.\n" }, "effective": { "type": "string", "description": "The effective period for the alarm task.\n" }, "evaluationCount": { "type": "integer", "description": "Scaling actions are triggered when monitoring metric data reaches the threshold for several consecutive times. Valid only when ScalingPolicyType is set to Alarm and required.\n" }, "ruleType": { "type": "string", "description": "Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.\n" } }, "type": "object", "required": [ "condition", "conditionOperator", "conditions", "effective", "evaluationCount", "ruleType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingPolicyAlarmPolicyCondition:getScalingPolicyAlarmPolicyCondition": { "properties": { "comparisonOperator": { "type": "string", "description": "Rule expression object for metric alarms. \u003e: Greater than. \u003c: Less than. =: Equal to.\n" }, "metricName": { "type": "string", "description": "Monitoring metric names for metric alarms. CpuTotal*Max: Maximum in-band CPU usage. CpuTotal*Min: Minimum in-band CPU usage. CpuTotal*Avg: Average in-band CPU usage. MemoryUsedUtilization*Max: Maximum in-band memory usage. MemoryUsedUtilization*Min: Minimum in-band memory usage. MemoryUsedUtilization*Avg: Average in-band memory usage. Instance*CpuBusy*Max: Maximum out-of-band CPU utilization. Instance*CpuBusy*Min: Minimum out-of-band CPU utilization. Instance*CpuBusy*Avg: Average out-of-band CPU utilization. Instance*NetTxBits*Avg: Average out-of-band network outbound rate. Instance*NetRxBits*Avg: Average out-of-band network inbound rate. Instance*NetTxPackets*Avg: Average out-of-band network packet send rate. Instance*NetRxPackets*Avg: Average out-of-band network packet receive rate. SystemDiskReadBytes*Avg: Average in-band system disk read bandwidth. SystemDiskWriteBytes*Avg: Average in-band system disk write bandwidth. SystemDiskReadIOPS*Avg: Average in-band system disk read IOPS. SystemDiskWriteIOPS*Avg: Average in-band system disk write IOPS. NetTcpConnection_Avg: Average in-band TCP connection count.\n" }, "metricUnit": { "type": "string", "description": "The unit for the monitoring metric threshold when an alarm is triggered. When the AlarmPolicy.Conditions.MetricName parameter is set to CPU/memory usage: Percent. When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write bandwidth: Bytes/Second(IEC). When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write IOPS: Count/Second. When the AlarmPolicy.Conditions.MetricName parameter is set to TCP connections: Count. When the AlarmPolicy.Condition.MetricName parameter is set to network inbound/outbound rate: Bits/Second(IEC). When the AlarmPolicy.Condition.MetricName parameter is set to network packet transmission rate: Packet/Second.\n" }, "threshold": { "type": "string", "description": "The threshold value for the monitoring metric when an alarm is triggered. When AlarmPolicy.Conditions.MetricUnit is set to Percent: 1–100. When AlarmPolicy.Conditions.MetricUnit is set to Bytes/Second(IEC): an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count/Second: an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count: an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Bits/Second(IEC): an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Packet/Second: an integer greater than 0.\n" } }, "type": "object", "required": [ "comparisonOperator", "metricName", "metricUnit", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:autoscaling/getScalingPolicyScheduledPolicy:getScalingPolicyScheduledPolicy": { "properties": { "launchTime": { "type": "string", "description": "Indicates the trigger time for the task. The default is the current time. When ScalingPolicyType is set to Scheduled, this specifies the trigger time for the scheduled task. When ScalingPolicyType is set to Recurrence: If ScheduledPolicy.RecurrenceType is empty, the task is executed only once at the specified date and time. If ScheduledPolicy.RecurrenceType is not empty, this specifies the start time for the recurring task.\n" }, "launchTimeRead": { "type": "string", "description": "Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.\n" }, "recurrenceEndTime": { "type": "string", "description": "Indicates the end time for the recurring task. Only supports selecting a time within 365 days from the creation date. If not configured, defaults to one day/week/month after the current time based on the recurrence cycle (ScheduledPolicy.RecurrenceType). If set to empty, the task never stops. Valid only when ScalingPolicyType is set to Recurrence and required.\n" }, "recurrenceEndTimeRead": { "type": "string", "description": "Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.\n" }, "recurrenceStartTime": { "type": "string", "description": "Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.\n" }, "recurrenceType": { "type": "string", "description": "Indicates the recurrence cycle for scheduled tasks. Values: Daily: Executes once every XX days. Weekly: Select specific days of the week, executes once per day. Monthly: Select XX to XX days of the month, executes once per day. Cron: Executes according to the specified Cron expression. Required and valid only when ScalingPolicyType is set to Recurrence.\n" }, "recurrenceValue": { "type": "string", "description": "Specifies the value for recurring tasks. When the ScheduledPolicy.RecurrenceType parameter is set to Daily, only one value can be entered: 1–31. When the ScheduledPolicy.RecurrenceType parameter is set to Weekly, multiple values can be entered, separated by commas (,). Values for Monday to Sunday are: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday). When the ScheduledPolicy.RecurrenceType parameter is set to Monthly, the format is A-B. Both A and B range from 1–31, and B must be greater than or equal to A. When the ScheduledPolicy.RecurrenceType parameter is set to Cron, it uses UTC+8 time and supports a five-field expression for minute, hour, day, month, and week. Wildcards supported include comma (,), question mark (?), hyphen (-), asterisk (*), hash (#), slash (/), L, and W. This field is valid and required when ScalingPolicyType is set to Recurrence.\n" } }, "type": "object", "required": [ "launchTime", "launchTimeRead", "recurrenceEndTime", "recurrenceEndTimeRead", "recurrenceStartTime", "recurrenceType", "recurrenceValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/GroupResetInfo:GroupResetInfo": { "properties": { "offsetType": { "type": "string", "description": "If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.\n" }, "partitionId": { "type": "integer", "description": "Partition number\n" }, "resetBy": { "type": "string", "description": "Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.\n" }, "resetValue": { "type": "integer", "description": "Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.\n" }, "topicId": { "type": "string", "description": "Topic ID。\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "offsetType", "partitionId", "resetBy", "resetValue", "topicId" ] } } }, "volcenginecc:bmq/GroupTopicInfo:GroupTopicInfo": { "properties": { "createTime": { "type": "string", "description": "Topic creation time\n" }, "description": { "type": "string", "description": "Topic description\n" }, "lag": { "type": "integer", "description": "Number of unconsumed messages in the Topic\n" }, "partitionInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/GroupTopicInfoPartitionInfo:GroupTopicInfoPartitionInfo" } }, "partitions": { "type": "integer", "description": "Number of Topic partitions\n" }, "retention": { "type": "integer", "description": "Retention period of data in the Topic, in hours\n" }, "status": { "type": "string", "description": "Topic status\n" }, "topicId": { "type": "string", "description": "Topic ID。\n" }, "topicName": { "type": "string", "description": "Topic name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createTime", "description", "lag", "partitionInfos", "partitions", "retention", "status", "topicId", "topicName" ] } } }, "volcenginecc:bmq/GroupTopicInfoPartitionInfo:GroupTopicInfoPartitionInfo": { "properties": { "currentOffset": { "type": "integer", "description": "Current consumption offset\n" }, "groupName": { "type": "string", "description": "Consumer Group name\n" }, "lag": { "type": "integer", "description": "Number of unconsumed messages in the partition\n" }, "latestOffset": { "type": "integer", "description": "Latest consumption offset\n" }, "partitionId": { "type": "integer", "description": "Partition number\n" }, "topicName": { "type": "string", "description": "Name of the Topic subscribed by the Consumer Group\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "currentOffset", "groupName", "lag", "latestOffset", "partitionId", "topicName" ] } } }, "volcenginecc:bmq/InstanceEndpoints:InstanceEndpoints": { "properties": { "overlay": { "$ref": "#/types/volcenginecc:bmq/InstanceEndpointsOverlay:InstanceEndpointsOverlay", "description": "Instance private network access endpoint response data\n" }, "public": { "$ref": "#/types/volcenginecc:bmq/InstanceEndpointsPublic:InstanceEndpointsPublic", "description": "Instance public access endpoint response data\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "overlay", "public" ] } } }, "volcenginecc:bmq/InstanceEndpointsOverlay:InstanceEndpointsOverlay": { "properties": { "address": { "type": "string", "description": "Domain mapping address\n" }, "eipId": { "type": "string", "description": "ID of the EIP bound to the instance\n" }, "plain": { "type": "string", "description": "Private network Plain access point\n" }, "plainPort": { "type": "integer", "description": "Standard endpoint port\n" }, "sasl": { "type": "string", "description": "Private network SASL authentication access point\n" }, "saslPort": { "type": "integer", "description": "Authentication endpoint port\n" }, "ssl": { "type": "string", "description": "Encrypted endpoint\n" }, "sslPort": { "type": "integer", "description": "Encrypted endpoint port\n" }, "status": { "type": "string", "description": "Endpoint status\n" }, "vpcIds": { "type": "array", "items": { "type": "string" }, "description": "List of VPC IDs associated with the sales zone network\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "address", "eipId", "plain", "plainPort", "sasl", "saslPort", "ssl", "sslPort", "status", "vpcIds" ] } } }, "volcenginecc:bmq/InstanceEndpointsPublic:InstanceEndpointsPublic": { "properties": { "address": { "type": "string", "description": "Domain mapping address\n" }, "eipId": { "type": "string", "description": "ID of the EIP bound to the instance\n" }, "plain": { "type": "string", "description": "Private network Plain access point\n" }, "plainPort": { "type": "integer", "description": "Standard endpoint port\n" }, "sasl": { "type": "string", "description": "Private network SASL authentication access point\n" }, "saslPort": { "type": "integer", "description": "Authentication endpoint port\n" }, "ssl": { "type": "string", "description": "Encrypted endpoint\n" }, "sslPort": { "type": "integer", "description": "Encrypted endpoint port\n" }, "status": { "type": "string", "description": "Endpoint status\n" }, "vpcIds": { "type": "array", "items": { "type": "string" }, "description": "List of VPC IDs associated with the sales zone network\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "address", "eipId", "plain", "plainPort", "sasl", "saslPort", "ssl", "sslPort", "status", "vpcIds" ] } } }, "volcenginecc:bmq/InstanceResourceTag:InstanceResourceTag": { "properties": { "tagKvs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/InstanceResourceTagTagKv:InstanceResourceTagTagKv" } }, "type": { "type": "string", "description": "Tag type. Options: CUSTOM—custom tag; SYSTEM—system tag\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "tagKvs", "type" ] } } }, "volcenginecc:bmq/InstanceResourceTagTagKv:InstanceResourceTagTagKv": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "type": { "type": "string", "description": "Type of instance tag. Options: CUSTOM—custom tag; SYSTEM—system tag\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "type", "value" ] } } }, "volcenginecc:bmq/InstanceResources:InstanceResources": { "properties": { "storage": { "$ref": "#/types/volcenginecc:bmq/InstanceResourcesStorage:InstanceResourcesStorage", "description": "Resource statistics response data\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "storage" ] } } }, "volcenginecc:bmq/InstanceResourcesStorage:InstanceResourcesStorage": { "properties": { "size": { "type": "integer", "description": "Resource size\n" }, "unit": { "type": "string", "description": "Resource unit\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "size", "unit" ] } } }, "volcenginecc:bmq/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "type": { "type": "string", "description": "Type of instance tag. Options: CUSTOM—custom tag; SYSTEM—system tag\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "type", "value" ] } } }, "volcenginecc:bmq/getGroupResetInfo:getGroupResetInfo": { "properties": { "offsetType": { "type": "string", "description": "If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.\n" }, "partitionId": { "type": "integer", "description": "Partition number\n" }, "resetBy": { "type": "string", "description": "Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.\n" }, "resetValue": { "type": "integer", "description": "Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.\n" }, "topicId": { "type": "string", "description": "Topic ID。\n" } }, "type": "object", "required": [ "offsetType", "partitionId", "resetBy", "resetValue", "topicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getGroupTopicInfo:getGroupTopicInfo": { "properties": { "createTime": { "type": "string", "description": "Topic creation time\n" }, "description": { "type": "string", "description": "Topic description\n" }, "lag": { "type": "integer", "description": "Number of unconsumed messages in the Topic\n" }, "partitionInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/getGroupTopicInfoPartitionInfo:getGroupTopicInfoPartitionInfo" }, "description": "Partition list\n" }, "partitions": { "type": "integer", "description": "Number of Topic partitions\n" }, "retention": { "type": "integer", "description": "Retention period of data in the Topic, in hours\n" }, "status": { "type": "string", "description": "Topic status\n" }, "topicId": { "type": "string", "description": "Topic ID。\n" }, "topicName": { "type": "string", "description": "Topic name\n" } }, "type": "object", "required": [ "createTime", "description", "lag", "partitionInfos", "partitions", "retention", "status", "topicId", "topicName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getGroupTopicInfoPartitionInfo:getGroupTopicInfoPartitionInfo": { "properties": { "currentOffset": { "type": "integer", "description": "Current consumption offset\n" }, "groupName": { "type": "string", "description": "Consumer Group name\n" }, "lag": { "type": "integer", "description": "Number of unconsumed messages in the partition\n" }, "latestOffset": { "type": "integer", "description": "Latest consumption offset\n" }, "partitionId": { "type": "integer", "description": "Partition number\n" }, "topicName": { "type": "string", "description": "Name of the Topic subscribed by the Consumer Group\n" } }, "type": "object", "required": [ "currentOffset", "groupName", "lag", "latestOffset", "partitionId", "topicName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getInstanceEndpoints:getInstanceEndpoints": { "properties": { "overlay": { "$ref": "#/types/volcenginecc:bmq/getInstanceEndpointsOverlay:getInstanceEndpointsOverlay", "description": "Instance private network access endpoint response data\n" }, "public": { "$ref": "#/types/volcenginecc:bmq/getInstanceEndpointsPublic:getInstanceEndpointsPublic", "description": "Instance public access endpoint response data\n" } }, "type": "object", "required": [ "overlay", "public" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getInstanceEndpointsOverlay:getInstanceEndpointsOverlay": { "properties": { "address": { "type": "string", "description": "Domain mapping address\n" }, "eipId": { "type": "string", "description": "ID of the EIP bound to the instance\n" }, "plain": { "type": "string", "description": "Private network Plain access point\n" }, "plainPort": { "type": "integer", "description": "Standard endpoint port\n" }, "sasl": { "type": "string", "description": "Private network SASL authentication access point\n" }, "saslPort": { "type": "integer", "description": "Authentication endpoint port\n" }, "ssl": { "type": "string", "description": "Encrypted endpoint\n" }, "sslPort": { "type": "integer", "description": "Encrypted endpoint port\n" }, "status": { "type": "string", "description": "Endpoint status\n" }, "vpcIds": { "type": "array", "items": { "type": "string" }, "description": "List of VPC IDs associated with the sales zone network\n" } }, "type": "object", "required": [ "address", "eipId", "plain", "plainPort", "sasl", "saslPort", "ssl", "sslPort", "status", "vpcIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getInstanceEndpointsPublic:getInstanceEndpointsPublic": { "properties": { "address": { "type": "string", "description": "Domain mapping address\n" }, "eipId": { "type": "string", "description": "ID of the EIP bound to the instance\n" }, "plain": { "type": "string", "description": "Private network Plain access point\n" }, "plainPort": { "type": "integer", "description": "Standard endpoint port\n" }, "sasl": { "type": "string", "description": "Private network SASL authentication access point\n" }, "saslPort": { "type": "integer", "description": "Authentication endpoint port\n" }, "ssl": { "type": "string", "description": "Encrypted endpoint\n" }, "sslPort": { "type": "integer", "description": "Encrypted endpoint port\n" }, "status": { "type": "string", "description": "Endpoint status\n" }, "vpcIds": { "type": "array", "items": { "type": "string" }, "description": "List of VPC IDs associated with the sales zone network\n" } }, "type": "object", "required": [ "address", "eipId", "plain", "plainPort", "sasl", "saslPort", "ssl", "sslPort", "status", "vpcIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getInstanceResourceTag:getInstanceResourceTag": { "properties": { "tagKvs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/getInstanceResourceTagTagKv:getInstanceResourceTagTagKv" }, "description": "Tag key-value pair\n" }, "type": { "type": "string", "description": "Tag type. Options: CUSTOM—custom tag; SYSTEM—system tag\n" } }, "type": "object", "required": [ "tagKvs", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getInstanceResourceTagTagKv:getInstanceResourceTagTagKv": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "type": { "type": "string", "description": "Type of instance tag. Options: CUSTOM—custom tag; SYSTEM—system tag\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getInstanceResources:getInstanceResources": { "properties": { "storage": { "$ref": "#/types/volcenginecc:bmq/getInstanceResourcesStorage:getInstanceResourcesStorage", "description": "Resource statistics response data\n" } }, "type": "object", "required": [ "storage" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getInstanceResourcesStorage:getInstanceResourcesStorage": { "properties": { "size": { "type": "integer", "description": "Resource size\n" }, "unit": { "type": "string", "description": "Resource unit\n" } }, "type": "object", "required": [ "size", "unit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:bmq/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "type": { "type": "string", "description": "Type of instance tag. Options: CUSTOM—custom tag; SYSTEM—system tag\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cbr/BackupPlanPolicy:BackupPlanPolicy": { "properties": { "accountId": { "type": "string", "description": "Account ID that created this policy\n" }, "backupType": { "type": "string", "description": "Backup type. Options: FULL: Full backup. INCREMENTAL: Incremental backup\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "crontab": { "type": "string", "description": "Specifies the backup schedule. Supports standard crontab expressions\n" }, "enablePolicy": { "type": "boolean", "description": "Whether the policy is enabled. Options: true: Enable policy. false: Disable policy\n" }, "name": { "type": "string", "description": "Policy Name\n" }, "planNumber": { "type": "integer", "description": "Number of backup plans associated with this policy\n" }, "policyId": { "type": "string", "description": "Backup Policy ID\n" }, "retentionDay": { "type": "integer", "description": "Retention time for recovery points. -1 means retain indefinitely\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountId", "backupType", "createdTime", "crontab", "enablePolicy", "name", "planNumber", "policyId", "retentionDay", "updatedTime" ] } } }, "volcenginecc:cbr/BackupPlanResourceList:BackupPlanResourceList": { "properties": { "metaInformation": { "$ref": "#/types/volcenginecc:cbr/BackupPlanResourceListMetaInformation:BackupPlanResourceListMetaInformation", "description": "Resource meta information, used to store additional configuration when creating a backup plan\n" }, "resourceId": { "type": "string", "description": "Backup Source ID\n" }, "resourceType": { "type": "string", "description": "Backup source type. Options: ECS: ECS full machine backup. vePFS: vePFS file system backup\n" } }, "type": "object", "required": [ "metaInformation", "resourceId", "resourceType" ] }, "volcenginecc:cbr/BackupPlanResourceListMetaInformation:BackupPlanResourceListMetaInformation": { "properties": { "ecsMeta": { "type": "string", "description": "ECS metadata, which is a JSON string\n" }, "vepfsMeta": { "type": "string", "description": "vePFS backup source metadata, which is a JSON string\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ecsMeta", "vepfsMeta" ] } } }, "volcenginecc:cbr/BackupResourceMetaInformation:BackupResourceMetaInformation": { "properties": { "ecsMeta": { "type": "string", "description": "ECS metadata, as a JSON string. For format, see the EcsBackupConfiguration structure in the data structure.\n" }, "vepfsMeta": { "type": "string", "description": "vePFS backup source metadata, as a JSON string. For format, see the VePFSBackupConfiguration structure in the data structure.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ecsMeta", "vepfsMeta" ] } } }, "volcenginecc:cbr/BackupResourcePlan:BackupResourcePlan": { "properties": { "planId": { "type": "string", "description": "Backup Plan ID\n" }, "planName": { "type": "string", "description": "Backup Plan Name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "planId", "planName" ] } } }, "volcenginecc:cbr/VaultTag:VaultTag": { "properties": { "key": { "type": "string", "description": "Tag Key\n" }, "value": { "type": "string", "description": "Tag Value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:cbr/getBackupPlanPolicy:getBackupPlanPolicy": { "properties": { "accountId": { "type": "string", "description": "Account ID that created this policy\n" }, "backupType": { "type": "string", "description": "Backup type. Options: FULL: Full backup. INCREMENTAL: Incremental backup\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "crontab": { "type": "string", "description": "Specifies the backup schedule. Supports standard crontab expressions\n" }, "enablePolicy": { "type": "boolean", "description": "Whether the policy is enabled. Options: true: Enable policy. false: Disable policy\n" }, "name": { "type": "string", "description": "Policy Name\n" }, "planNumber": { "type": "integer", "description": "Number of backup plans associated with this policy\n" }, "policyId": { "type": "string", "description": "Backup Policy ID\n" }, "retentionDay": { "type": "integer", "description": "Retention time for recovery points. -1 means retain indefinitely\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "type": "object", "required": [ "accountId", "backupType", "createdTime", "crontab", "enablePolicy", "name", "planNumber", "policyId", "retentionDay", "updatedTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cbr/getBackupPlanResourceList:getBackupPlanResourceList": { "properties": { "metaInformation": { "$ref": "#/types/volcenginecc:cbr/getBackupPlanResourceListMetaInformation:getBackupPlanResourceListMetaInformation", "description": "Resource meta information, used to store additional configuration when creating a backup plan\n" }, "resourceId": { "type": "string", "description": "Backup Source ID\n" }, "resourceType": { "type": "string", "description": "Backup source type. Options: ECS: ECS full machine backup. vePFS: vePFS file system backup\n" } }, "type": "object", "required": [ "metaInformation", "resourceId", "resourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cbr/getBackupPlanResourceListMetaInformation:getBackupPlanResourceListMetaInformation": { "properties": { "ecsMeta": { "type": "string", "description": "ECS metadata, which is a JSON string\n" }, "vepfsMeta": { "type": "string", "description": "vePFS backup source metadata, which is a JSON string\n" } }, "type": "object", "required": [ "ecsMeta", "vepfsMeta" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cbr/getBackupResourceMetaInformation:getBackupResourceMetaInformation": { "properties": { "ecsMeta": { "type": "string", "description": "ECS metadata, as a JSON string. For format, see the EcsBackupConfiguration structure in the data structure.\n" }, "vepfsMeta": { "type": "string", "description": "vePFS backup source metadata, as a JSON string. For format, see the VePFSBackupConfiguration structure in the data structure.\n" } }, "type": "object", "required": [ "ecsMeta", "vepfsMeta" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cbr/getBackupResourcePlan:getBackupResourcePlan": { "properties": { "planId": { "type": "string", "description": "Backup Plan ID\n" }, "planName": { "type": "string", "description": "Backup Plan Name\n" } }, "type": "object", "required": [ "planId", "planName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cbr/getVaultTag:getVaultTag": { "properties": { "key": { "type": "string", "description": "Tag Key\n" }, "value": { "type": "string", "description": "Tag Value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/DomainAreaAccessRule:DomainAreaAccessRule": { "properties": { "areas": { "type": "array", "items": { "type": "string" }, "description": "Indicates a list of countries to which an allowlist or denylist is applied. When Switch is true, this parameter is required. Country names are represented in abbreviated form. Multiple country names are separated by commas (,).\n" }, "ruleType": { "type": "string", "description": "Indicates the rule type for the 'region access control' feature. This parameter has the following values: deny: indicates Denylist. allow: indicates Allowlist.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areas", "ruleType", "switch" ] } } }, "volcenginecc:cdn/DomainBrowserCach:DomainBrowserCach": { "properties": { "cacheAction": { "$ref": "#/types/volcenginecc:cdn/DomainBrowserCachCacheAction:DomainBrowserCachCacheAction", "description": "Indicates the relevant configuration for cache behavior.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/DomainBrowserCachCondition:DomainBrowserCachCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheAction", "condition" ] } } }, "volcenginecc:cdn/DomainBrowserCachCacheAction:DomainBrowserCachCacheAction": { "properties": { "action": { "type": "string", "description": "Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.\n" }, "defaultPolicy": { "type": "string", "description": "This parameter is shared by multiple CDN features.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "defaultPolicy", "ignoreCase", "ttl" ] } } }, "volcenginecc:cdn/DomainBrowserCachCondition:DomainBrowserCachCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainBrowserCachConditionConditionRule:DomainBrowserCachConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainBrowserCachConditionConditionRule:DomainBrowserCachConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainCach:DomainCach": { "properties": { "cacheAction": { "$ref": "#/types/volcenginecc:cdn/DomainCachCacheAction:DomainCachCacheAction", "description": "Indicates the relevant configuration for cache behavior.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/DomainCachCondition:DomainCachCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheAction", "condition" ] } } }, "volcenginecc:cdn/DomainCachCacheAction:DomainCachCacheAction": { "properties": { "action": { "type": "string", "description": "Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.\n" }, "defaultPolicy": { "type": "string", "description": "This parameter is shared by multiple CDN features.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "defaultPolicy", "ignoreCase", "ttl" ] } } }, "volcenginecc:cdn/DomainCachCondition:DomainCachCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCachConditionConditionRule:DomainCachConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainCachConditionConditionRule:DomainCachConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainCacheHost:DomainCacheHost": { "properties": { "cacheHostRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCacheHostCacheHostRule:DomainCacheHostCacheHostRule" } }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheHostRules", "switch" ] } } }, "volcenginecc:cdn/DomainCacheHostCacheHostRule:DomainCacheHostCacheHostRule": { "properties": { "cacheHostAction": { "$ref": "#/types/volcenginecc:cdn/DomainCacheHostCacheHostRuleCacheHostAction:DomainCacheHostCacheHostRuleCacheHostAction", "description": "Indicates the target domain. The target domain must be an accelerated domain under your account. This parameter specifies that the Domain shares the cache of CacheHost.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/DomainCacheHostCacheHostRuleCondition:DomainCacheHostCacheHostRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheHostAction", "condition" ] } } }, "volcenginecc:cdn/DomainCacheHostCacheHostRuleCacheHostAction:DomainCacheHostCacheHostRuleCacheHostAction": { "properties": { "cacheHost": { "type": "string", "description": "Specifies the target domain name. The target domain name must be an acceleration domain under your account. This parameter indicates that Domain shares the cache of CacheHost.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheHost" ] } } }, "volcenginecc:cdn/DomainCacheHostCacheHostRuleCondition:DomainCacheHostCacheHostRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCacheHostCacheHostRuleConditionConditionRule:DomainCacheHostCacheHostRuleConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainCacheHostCacheHostRuleConditionConditionRule:DomainCacheHostCacheHostRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainCacheKey:DomainCacheKey": { "properties": { "cacheKeyAction": { "$ref": "#/types/volcenginecc:cdn/DomainCacheKeyCacheKeyAction:DomainCacheKeyCacheKeyAction", "description": "Indicates the action performed by the content delivery network under the Condition scenario.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/DomainCacheKeyCondition:DomainCacheKeyCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheKeyAction", "condition" ] } } }, "volcenginecc:cdn/DomainCacheKeyCacheKeyAction:DomainCacheKeyCacheKeyAction": { "properties": { "cacheKeyComponents": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCacheKeyCacheKeyActionCacheKeyComponent:DomainCacheKeyCacheKeyActionCacheKeyComponent" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheKeyComponents" ] } } }, "volcenginecc:cdn/DomainCacheKeyCacheKeyActionCacheKeyComponent:DomainCacheKeyCacheKeyActionCacheKeyComponent": { "properties": { "action": { "type": "string", "description": "Specifies the action to perform; required when modifying. This parameter has the following values: exclude: The cache key does not include any query parameters, which means parameters are removed from the cache. include: The cache key includes all query parameters, which means parameters are retained in the cache. includePart: The cache key includes query parameters in Subobject, which means some parameters are retained in the cache. excludePart: The cache key does not include query parameters in Subobject, which means some parameters are removed from the cache.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether the content delivery network ignores case when matching Value. The parameter values are: true: ignore case. false: do not ignore case. The default value is false.\n" }, "object": { "type": "string", "description": "Indicates the object to be set. Currently, you can only specify queryString. queryString refers to the query parameters in the request URL.\n" }, "subobject": { "type": "string", "description": "Specify one or more objects of the Object type. Parameter details: If Action is include or exclude, Subobject must be *. * means all query parameters. If Action is includePart or excludePart, you can specify one or more query parameters. The query parameters you specify cannot be *, and cannot contain consecutive slashes (//), percent signs (%), or spaces. Use a semicolon (;) to separate multiple query parameter names. The default value for Subobject is *.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "ignoreCase", "object", "subobject" ] } } }, "volcenginecc:cdn/DomainCacheKeyCondition:DomainCacheKeyCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCacheKeyConditionConditionRule:DomainCacheKeyConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainCacheKeyConditionConditionRule:DomainCacheKeyConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainCompression:DomainCompression": { "properties": { "compressionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCompressionCompressionRule:DomainCompressionCompressionRule" } }, "switch": { "type": "boolean", "description": "Smart compression configuration switch. This parameter has the following values: true: enables smart compression. false: disables smart compression.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compressionRules", "switch" ] } } }, "volcenginecc:cdn/DomainCompressionCompressionRule:DomainCompressionCompressionRule": { "properties": { "compressionAction": { "$ref": "#/types/volcenginecc:cdn/DomainCompressionCompressionRuleCompressionAction:DomainCompressionCompressionRuleCompressionAction", "description": "Represents the configuration for compression operations.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/DomainCompressionCompressionRuleCondition:DomainCompressionCompressionRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compressionAction", "condition" ] } } }, "volcenginecc:cdn/DomainCompressionCompressionRuleCompressionAction:DomainCompressionCompressionRuleCompressionAction": { "properties": { "compressionFormat": { "type": "string", "description": "If the matching condition is based on the Content-Type header (when Condition is null or not specified), this parameter specifies the matching criteria for Content-Type. The values are as follows: default: matches file types included in the default Content-Type list. customize: matches custom file types in the Content-Type header. If Condition is not null, the matching criteria are defined in ConditionRule. In this case, this parameter must be set to all.\n" }, "compressionTarget": { "type": "string", "description": "Specifies the file types to compress. The parameter is described as follows: If CompressionFormat is default, this parameter must be set to *, indicating the default Content-Type list. The list includes the following file types: text/html, text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, text/javascript, image/tiff, image/svg+xml, application/json, application/xml, text/plain; charset=utf-8. If CompressionFormat is customize, you need to specify one or more file types. Multiple file types are separated by commas (,). If CompressionFormat is all, this parameter must be set to *.\n" }, "compressionTypes": { "type": "array", "items": { "type": "string" }, "description": "Compression algorithm: gzip and br specify the compression type. default: compresses all files by default, with the target count as *. customize: compresses custom file types. Choices: [default, customize]\n" }, "maxFileSizeKb": { "type": "integer", "description": "Indicates the minimum value for the file size range. CDN only compresses files within the range specified by MinFileSizeKB and MaxFileSizeKB. The parameter value range is 0 - 2,147,483,647, the unit is KB, and the base is 1,024. The default value is 0.\n" }, "minFileSizeKb": { "type": "integer", "description": "Indicates the maximum value for the file size range. The value range is 0 - 2,147,483,647, in KB, using a base of 1,024. If this parameter is not specified, there is no upper limit for file size.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compressionFormat", "compressionTarget", "compressionTypes", "maxFileSizeKb", "minFileSizeKb" ] } } }, "volcenginecc:cdn/DomainCompressionCompressionRuleCondition:DomainCompressionCompressionRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCompressionCompressionRuleConditionConditionRule:DomainCompressionCompressionRuleConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainCompressionCompressionRuleConditionConditionRule:DomainCompressionCompressionRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainConditionalOrigin:DomainConditionalOrigin": { "properties": { "originRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainConditionalOriginOriginRule:DomainConditionalOriginOriginRule" }, "description": "Indicates a list of rules. Each rule in the list defines a filter and the action the content delivery network performs on requests that meet the filter criteria.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "originRules", "switch" ] } } }, "volcenginecc:cdn/DomainConditionalOriginOriginRule:DomainConditionalOriginOriginRule": { "properties": { "actions": { "$ref": "#/types/volcenginecc:cdn/DomainConditionalOriginOriginRuleActions:DomainConditionalOriginOriginRuleActions", "description": "Indicates the operation configuration for a rule in the list.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/DomainConditionalOriginOriginRuleCondition:DomainConditionalOriginOriginRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "actions", "condition" ] } } }, "volcenginecc:cdn/DomainConditionalOriginOriginRuleActions:DomainConditionalOriginOriginRuleActions": { "properties": { "originLines": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainConditionalOriginOriginRuleActionsOriginLine:DomainConditionalOriginOriginRuleActionsOriginLine" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "originLines" ] } } }, "volcenginecc:cdn/DomainConditionalOriginOriginRuleActionsOriginLine:DomainConditionalOriginOriginRuleActionsOriginLine": { "properties": { "address": { "type": "string", "description": "Represents the address of an origin server. When InstanceType is ip, Address specifies an IPv4 or IPv6 address. When InstanceType is domain, Address specifies a domain name. The domain name cannot be a wildcard domain. If you specify OriginLines, Address is required.\n" }, "httpPort": { "type": "string", "description": "Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The valid range is 1–65535, with a default value of 80. If the origin server does not have this port open, you do not need to specify this parameter.\n" }, "httpsPort": { "type": "string", "description": "Specifies the port used by the content delivery network to access the origin server via HTTPS. The value range is 1–65535, and the default is 443. If the origin server does not open this port, you do not need to specify this parameter.\n" }, "instanceType": { "type": "string", "description": "Indicates the type of origin. The parameter has the following values: ip: indicates an IP address. domain: indicates a domain name. InstanceType is required if OriginLines is specified.\n" }, "originHost": { "type": "string", "description": "If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter takes precedence over the global OriginHost parameter. The value of this parameter cannot exceed 1,024 characters. The default value is the same as the global OriginHost.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "address", "httpPort", "httpsPort", "instanceType", "originHost" ] } } }, "volcenginecc:cdn/DomainConditionalOriginOriginRuleCondition:DomainConditionalOriginOriginRuleCondition": { "properties": { "conditionGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainConditionalOriginOriginRuleConditionConditionGroup:DomainConditionalOriginOriginRuleConditionConditionGroup" } }, "connective": { "type": "string", "description": "Specifies the relationship between these condition groups. This parameter has the following values: or: Indicates an 'or' relationship. In this case, if any condition group is met, the user request matches the rule. and: Indicates an 'and' relationship. In this case, all condition groups must be met for the user request to match the rule. The default value is or.\n" }, "isGroup": { "type": "boolean", "description": "Indicates whether each filter condition is a condition group. The value of this parameter is always true, meaning each filter condition is a condition group. Currently, each condition group can only contain one filter condition.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionGroups", "connective", "isGroup" ] } } }, "volcenginecc:cdn/DomainConditionalOriginOriginRuleConditionConditionGroup:DomainConditionalOriginOriginRuleConditionConditionGroup": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainConditionalOriginOriginRuleConditionConditionGroupCondition:DomainConditionalOriginOriginRuleConditionConditionGroupCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition" ] } } }, "volcenginecc:cdn/DomainConditionalOriginOriginRuleConditionConditionGroupCondition:DomainConditionalOriginOriginRuleConditionConditionGroupCondition": { "properties": { "object": { "type": "string", "description": "Indicates a filter type. This parameter has the following values: path: The full path in the request URL. directory: Any directory in the path. For example, if the path is /a/b/c/d/file, then /a/, /b/c/, and /d/ are directories. filetype: The extension at the end of the path. full*querystring: The query string in the request URL. client*ip: The client's IP address or the location associated with the IP address. If you specify Condition, Object is required.\n" }, "operator": { "type": "string", "description": "Specifies a comparison type. Different Objects correspond to different values. When Object is path, directory, or filetype, the parameter values are equal and not*equal. When Object is path, additional values are regex*match and regex*not*match. When Object is full*querystring, the values are regex*match and regex*not*match. When Object is client*ip, the values are equal, not*equal, belong, and not*belong. The comparison types are explained as follows: equal: If Object matches any filter value in Value, the request meets this filter condition. not*equal: If Object does not match any filter value in Value, the request meets this filter condition. regex*match: If any regular expression in Value matches any part of Object, the request meets this filter condition. regex*not*match: If none of the regular expressions in Value match any part of Object, the request meets this filter condition. belong: If the client IP address belongs to any country or region listed in Value, the request meets this filter condition. not*belong: If the client IP address does not belong to any country or region listed in Value, the request meets this filter condition. If you specify Condition, Operator is required.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Represents one or more filter values. Filter values are separated by semicolons (;). The input requirements for this parameter are as follows: When Object is path, directory, or filetype, the total length of all filter values must not exceed 1,024 characters and must not contain the following characters: consecutive slashes (//), spaces, dollar sign ($), question mark (?), or Delete (ASCII code 127). When Object is path, this parameter has the following additional requirements: each filter value must start with a slash (/) but must not end with a slash (/). You can use one or more asterisks (*) in the filter value, where each asterisk represents one or more characters. For example: /www/img/my*image.png. When Object is directory, this parameter has the following additional requirements: each filter value must start and end with a slash (/). For example: /www/img/. When Object is filetype, this parameter has the following additional requirements: each filter value does not need to start with a period (.). For example: png;txt. When Object is full*querystring, the input requirements for this parameter are as follows: the total length of all filter values must not exceed 256 characters. Filter values can include numbers, letters, percent sign (%), underscore (*), and hyphen (-). When Object is client*ip, if Operator is equal or not*equal, the input requirements for this parameter are as follows: the number of IP addresses must not exceed 5. IP addresses must be IPv4 addresses. If you specify Condition, Value is required.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "object", "operator", "values" ] } } }, "volcenginecc:cdn/DomainCustomErrorPage:DomainCustomErrorPage": { "properties": { "errorPageRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCustomErrorPageErrorPageRule:DomainCustomErrorPageErrorPageRule" } }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "errorPageRules", "switch" ] } } }, "volcenginecc:cdn/DomainCustomErrorPageErrorPageRule:DomainCustomErrorPageErrorPageRule": { "properties": { "errorPageAction": { "$ref": "#/types/volcenginecc:cdn/DomainCustomErrorPageErrorPageRuleErrorPageAction:DomainCustomErrorPageErrorPageRuleErrorPageAction", "description": "Indicates the relevant configuration for the rule.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "errorPageAction" ] } } }, "volcenginecc:cdn/DomainCustomErrorPageErrorPageRuleErrorPageAction:DomainCustomErrorPageErrorPageRuleErrorPageAction": { "properties": { "action": { "type": "string", "description": "Indicates the actual operation. Currently, you can only set this parameter to redirect. This means the client request will be redirected.\n" }, "redirectCode": { "type": "string", "description": "Indicates the response status code for redirection. You can select an appropriate status code as needed. The available values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original request and will not be changed.\n" }, "redirectUrl": { "type": "string", "description": "Indicates the target address for redirection. The length must not exceed 1,024 characters. The address must include the protocol, domain name, and path, and comply with URL specifications.\n" }, "statusCode": { "type": "string", "description": "Indicates a status code, with a value range of 400–599. You can enter 4xx or 5xx. 4xx covers all status codes from 400 to 499. 5xx covers all status codes from 500 to 599.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "redirectCode", "redirectUrl", "statusCode" ] } } }, "volcenginecc:cdn/DomainCustomizeAccessRule:DomainCustomizeAccessRule": { "properties": { "customizeInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstance:DomainCustomizeAccessRuleCustomizeInstance" } }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customizeInstances", "switch" ] } } }, "volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstance:DomainCustomizeAccessRuleCustomizeInstance": { "properties": { "customizeRule": { "$ref": "#/types/volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstanceCustomizeRule:DomainCustomizeAccessRuleCustomizeInstanceCustomizeRule", "description": "Describes the configuration for a rule in the list.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customizeRule" ] } } }, "volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstanceCustomizeRule:DomainCustomizeAccessRuleCustomizeInstanceCustomizeRule": { "properties": { "accessAction": { "$ref": "#/types/volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction:DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction", "description": "Indicates the configuration of the denylist or allowlist in this rule.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition:DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessAction", "condition" ] } } }, "volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction:DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction": { "properties": { "allowEmpty": { "type": "boolean", "description": "Indicates whether the CDN accepts user requests where the RequestHeader value is empty. An empty header value refers to either of the following situations: The user request does not include RequestHeader. The user request includes RequestHeader, but the header value is empty (\"\").\n" }, "listRules": { "type": "array", "items": { "type": "string" }, "description": "Indicates a list of regular expressions used to match the value of the request header. The list can contain up to 20 regular expressions, and the total length of all expressions cannot exceed 1,024 characters. The relationship between the regular expressions is OR. That is, if the value of RequestHeader in a user request matches any regular expression, the rule applies to the request.\n" }, "requestHeader": { "type": "string", "description": "Indicates a specified request header. Header names are case-insensitive and must meet the following requirements: The name must not exceed 1,024 characters. The name cannot be Referer, User-Agent, or Origin. The name can contain letters, digits, underscores (_), and hyphens (-). The name cannot start with a digit.\n" }, "ruleType": { "type": "string", "description": "Indicates the type of list. This parameter has the following values: allow: defines an allowlist in this rule. If a user request does not match the allowlist, the CDN rejects the request and returns a 403 status code. deny: defines a denylist in this rule. If a user request matches the denylist, the CDN rejects the request and returns a 403 status code.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allowEmpty", "listRules", "requestHeader", "ruleType" ] } } }, "volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition:DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule:DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule:DomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainDomainLock:DomainDomainLock": { "properties": { "remark": { "type": "string", "description": "Indicates the reason why the acceleration domain is locked. If Status is on, this parameter provides a description of the reason. If Status is off, this parameter is empty (\"\")\n" }, "status": { "type": "string", "description": "Indicates the lock status of the acceleration domain name. The parameter has the following values: on: the acceleration domain name is locked. off: the acceleration domain name is not locked.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "remark", "status" ] } } }, "volcenginecc:cdn/DomainDownloadSpeedLimit:DomainDownloadSpeedLimit": { "properties": { "downloadSpeedLimitRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRule:DomainDownloadSpeedLimitDownloadSpeedLimitRule" } }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "downloadSpeedLimitRules", "switch" ] } } }, "volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRule:DomainDownloadSpeedLimitDownloadSpeedLimitRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition:DomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "downloadSpeedLimitAction": { "$ref": "#/types/volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction:DomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction", "description": "Indicates the rate limiting configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "downloadSpeedLimitAction" ] } } }, "volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition:DomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule:DomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule:DomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction:DomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction": { "properties": { "speedLimitRate": { "type": "integer", "description": "Indicates the maximum download speed for a single request, measured in B/S. The parameter range is 1–1,073,741,824,000,000, using a base conversion of 1,024.\n" }, "speedLimitRateAfter": { "type": "integer", "description": "Represents a data volume. Download throttling is enabled for a request only when the amount of data downloaded in a single request reaches this value. Unit: Byte. The parameter range is 0–1,073,741,824,000,000, using a base of 1,024 for conversion.\n" }, "speedLimitTime": { "$ref": "#/types/volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime:DomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime", "description": "Indicates the date and time period when rate limiting occurs.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "speedLimitRate", "speedLimitRateAfter", "speedLimitTime" ] } } }, "volcenginecc:cdn/DomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime:DomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime": { "properties": { "beginTime": { "type": "string", "description": "Indicates the start time for rate limiting. The time format is mm:ss. If the DayWeek parameter value is unlimited, the default values for BeginTime and EndTime will be set to 00:00 and 23:59, respectively.\n" }, "dayWeek": { "type": "string", "description": "Specifies the date when rate limiting occurs. This parameter has the following values: monday, tuesday, wednesday, thursday, friday, saturday, sunday, unlimited. unlimited means every day. You can specify one or more values. Separate multiple values with a semicolon (;).\n" }, "endTime": { "type": "string", "description": "Indicates the end time for rate limiting. The time format is mm:ss. If the DayWeek parameter is set to unlimited, the default values for BeginTime and EndTime are 00:00 and 23:59, respectively.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "beginTime", "dayWeek", "endTime" ] } } }, "volcenginecc:cdn/DomainHttpForcedRedirect:DomainHttpForcedRedirect": { "properties": { "enableForcedRedirect": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are: true: enables the feature. When enabled, the content delivery network redirects incoming HTTPS requests to HTTP requests. false: disables the feature. The content delivery network does not redirect HTTPS requests to HTTP requests. To enable this feature, your acceleration domain must have HTTPS enabled.\n" }, "statusCode": { "type": "string", "description": "Indicates the redirect status code returned by the content delivery network when it receives an HTTPS request. This parameter has the following values: 301: indicates the 301 response status code. 302: indicates the 302 response status code. The default value for this parameter is 301.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableForcedRedirect", "statusCode" ] } } }, "volcenginecc:cdn/DomainHttps:DomainHttps": { "properties": { "certCheck": { "$ref": "#/types/volcenginecc:cdn/DomainHttpsCertCheck:DomainHttpsCertCheck", "description": "Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.\n" }, "certInfo": { "$ref": "#/types/volcenginecc:cdn/DomainHttpsCertInfo:DomainHttpsCertInfo", "description": "Indicates the single certificate to be associated with the acceleration domain name.\n" }, "certInfoLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainHttpsCertInfoList:DomainHttpsCertInfoList" } }, "disableHttp": { "type": "boolean", "description": "Indicates whether to allow requests where the URL scheme is HTTP. The parameter values are: true: allows requests with HTTP scheme. false: does not allow requests with HTTP scheme. The default value is false.\n" }, "forcedRedirect": { "$ref": "#/types/volcenginecc:cdn/DomainHttpsForcedRedirect:DomainHttpsForcedRedirect", "description": "Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.\n" }, "hsts": { "$ref": "#/types/volcenginecc:cdn/DomainHttpsHsts:DomainHttpsHsts", "description": "Indicates the configuration module for the HSTS feature. This feature is disabled by default.\n" }, "http2": { "type": "boolean", "description": "HTTP/2 configuration switch. This parameter has the following values: true: enables HTTP/2. false: disables HTTP/2. To enable HTTP/2, you must first enable HTTPS. This feature is disabled by default. However, HTTP/2 is enabled by default in the following scenarios: The business type of the accelerated domain is web (ServiceType is web). The accelerated domain has already enabled HTTPS.\n" }, "ocsp": { "type": "boolean", "description": "Specify whether to enable OCSP stapling. This parameter has the following values: true: enables OCSP stapling. false: disables OCSP stapling. To enable OCSP stapling, you must first enable HTTPS. The default value is false.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable the HTTPS feature. This parameter has the following values: true: enables the feature; false: disables the feature. If Switch is true, you must specify a certificate. If you specify a single certificate, you need to provide CertInfo. If you specify dual certificates, you need to provide CertInfoList. The certificate you specify can be hosted in the certificate center or on the content delivery network.\n" }, "tlsVersions": { "type": "array", "items": { "type": "string" }, "description": "Indicates the configuration module for the \"TLS Version\" feature. This parameter specifies the TLS versions that user requests can use, with the following options: tlsv1.0: TLS 1.0 tlsv1.1: TLS 1.1 tlsv1.2: TLS 1.2 tlsv1.3: TLS 1.3 The default value for this parameter is [\"tlsv1.1\", \"tlsv1.2\", \"tlsv1.3\"]\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certCheck", "certInfo", "certInfoLists", "disableHttp", "forcedRedirect", "hsts", "http2", "ocsp", "switch", "tlsVersions" ] } } }, "volcenginecc:cdn/DomainHttpsCertCheck:DomainHttpsCertCheck": { "properties": { "certInfoLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainHttpsCertCheckCertInfoList:DomainHttpsCertCheckCertInfoList" } }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certInfoLists", "switch" ] } } }, "volcenginecc:cdn/DomainHttpsCertCheckCertInfoList:DomainHttpsCertCheckCertInfoList": { "properties": { "certId": { "type": "string", "description": "Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.\n" }, "certName": { "type": "string", "description": "Represents the content of the Common Name (CN) field in the CA certificate.\n" }, "certificate": { "$ref": "#/types/volcenginecc:cdn/DomainHttpsCertCheckCertInfoListCertificate:DomainHttpsCertCheckCertInfoListCertificate", "description": "Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.\n" }, "effectiveTime": { "type": "integer", "description": "Indicates the issuance time of the certificate, in Unix timestamp.\n" }, "encryType": { "type": "string", "description": "Indicates the encryption algorithm used by the certificate. The parameter has the following values: inter*cert: RSA or ECC encryption algorithm. sm*cert: SM2 encryption algorithm.\n" }, "expireTime": { "type": "integer", "description": "Indicates the expiration time of the certificate, as a Unix timestamp.\n" }, "source": { "type": "string", "description": "Specifies the certificate hosting location. The parameter values are: volc*cert*center: certificate center; cdn*cert*hosting: content delivery network.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certId", "certName", "certificate", "effectiveTime", "encryType", "expireTime", "source" ] } } }, "volcenginecc:cdn/DomainHttpsCertCheckCertInfoListCertificate:DomainHttpsCertCheckCertInfoListCertificate": { "properties": { "certificate": { "type": "string", "description": "Indicates the content of the certificate file. Line breaks in the content must be replaced with \\r\\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.\n" }, "encryptionCert": { "type": "string", "description": "Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \\r\\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid\n" }, "encryptionKey": { "type": "string", "description": "Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \\r\\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to \u003cdomain\u003e_encrypt.key.\n" }, "privateKey": { "type": "string", "description": "Indicates the content of the private key file. Line breaks in the content must be replaced with \\r\\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to \u003cdomain\u003e.key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to \u003cdomain\u003e_sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certificate", "encryptionCert", "encryptionKey", "privateKey" ] } } }, "volcenginecc:cdn/DomainHttpsCertInfo:DomainHttpsCertInfo": { "properties": { "certId": { "type": "string", "description": "Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.\n" }, "certName": { "type": "string", "description": "Indicates the content of the Common Name (CN) field in the CA certificate.\n" }, "certificate": { "$ref": "#/types/volcenginecc:cdn/DomainHttpsCertInfoCertificate:DomainHttpsCertInfoCertificate", "description": "Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.\n" }, "effectiveTime": { "type": "integer", "description": "Indicates the issuance time of the certificate, in Unix timestamp.\n" }, "encryType": { "type": "string", "description": "Indicates the encryption algorithm used by the certificate. The parameter has the following values: inter*cert: RSA or ECC encryption algorithm. sm*cert: SM2 encryption algorithm.\n" }, "expireTime": { "type": "integer", "description": "Indicates the expiration time of the certificate, in Unix timestamp.\n" }, "source": { "type": "string", "description": "Indicates the location where the certificate is hosted. This parameter has the following values: volc*cert*center: Certificate Center. cdn*cert*hosting: Content Delivery Network.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certId", "certName", "certificate", "effectiveTime", "encryType", "expireTime", "source" ] } } }, "volcenginecc:cdn/DomainHttpsCertInfoCertificate:DomainHttpsCertInfoCertificate": { "properties": { "certificate": { "type": "string", "description": "Indicates the content of the certificate file. Line breaks in the content must be replaced with \\r\\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.\n" }, "encryptionCert": { "type": "string", "description": "Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \\r\\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid\n" }, "encryptionKey": { "type": "string", "description": "Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \\r\\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to \u003cdomain\u003e_encrypt.key.\n" }, "privateKey": { "type": "string", "description": "Indicates the content of the private key file. Line breaks in the content must be replaced with \\r\\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to \u003cdomain\u003e.key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to \u003cdomain\u003e_sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certificate", "encryptionCert", "encryptionKey", "privateKey" ] } } }, "volcenginecc:cdn/DomainHttpsCertInfoList:DomainHttpsCertInfoList": { "properties": { "certId": { "type": "string", "description": "Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.\n" }, "certName": { "type": "string", "description": "Represents the content of the Common Name (CN) field in the CA certificate.\n" }, "certificate": { "$ref": "#/types/volcenginecc:cdn/DomainHttpsCertInfoListCertificate:DomainHttpsCertInfoListCertificate", "description": "Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.\n" }, "effectiveTime": { "type": "integer", "description": "Indicates the issuance time of the certificate, in Unix timestamp.\n" }, "encryType": { "type": "string", "description": "Indicates the encryption algorithm used by the certificate. The parameter has the following values: inter*cert: RSA or ECC encryption algorithm. sm*cert: SM2 encryption algorithm.\n" }, "expireTime": { "type": "integer", "description": "Indicates the expiration time of the certificate, as a Unix timestamp.\n" }, "source": { "type": "string", "description": "Specifies the certificate hosting location. The parameter values are: volc*cert*center: certificate center; cdn*cert*hosting: content delivery network.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certId", "certName", "certificate", "effectiveTime", "encryType", "expireTime", "source" ] } } }, "volcenginecc:cdn/DomainHttpsCertInfoListCertificate:DomainHttpsCertInfoListCertificate": { "properties": { "certificate": { "type": "string", "description": "Indicates the content of the certificate file. Line breaks in the content must be replaced with \\r\\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.\n" }, "encryptionCert": { "type": "string", "description": "Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \\r\\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid\n" }, "encryptionKey": { "type": "string", "description": "Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \\r\\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to \u003cdomain\u003e_encrypt.key.\n" }, "privateKey": { "type": "string", "description": "Indicates the content of the private key file. Line breaks in the content must be replaced with \\r\\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to \u003cdomain\u003e.key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to \u003cdomain\u003e_sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certificate", "encryptionCert", "encryptionKey", "privateKey" ] } } }, "volcenginecc:cdn/DomainHttpsForcedRedirect:DomainHttpsForcedRedirect": { "properties": { "enableForcedRedirect": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: enables the feature. When enabled, the content delivery network redirects HTTP requests to HTTPS requests. false: disables the feature. When disabled, the content delivery network does not redirect HTTP requests to HTTPS requests. To enable this feature, your acceleration domain must have HTTPS enabled.\n" }, "statusCode": { "type": "string", "description": "Indicates the redirect response status code for the CDN when receiving HTTPS requests. The parameter values are: 301: returns status code 301. 302: returns status code 302. The default value is 301.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableForcedRedirect", "statusCode" ] } } }, "volcenginecc:cdn/DomainHttpsHsts:DomainHttpsHsts": { "properties": { "subdomain": { "type": "string", "description": "Indicates whether the HSTS configuration also applies to subdomains of the accelerated domain. The parameter has the following values: include: applies HSTS configuration to subdomain sites. exclude: does not apply HSTS configuration to subdomain sites. The default value is exclude.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache expiration time for the Strict-Transport-Security response header in the browser, in seconds. If Switch is true, this parameter is required. The value range is 0–31,536,000. 31,536,000 seconds equals 365 days. If the value is 0, it is equivalent to disabling the HSTS setting.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "subdomain", "switch", "ttl" ] } } }, "volcenginecc:cdn/DomainIPv6:DomainIPv6": { "properties": { "switch": { "type": "boolean", "description": "Specifies whether to enable IPv6 configuration. This parameter has the following values: true: Enables IPv6. false: Disables IPv6.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "switch" ] } } }, "volcenginecc:cdn/DomainIpAccessRule:DomainIpAccessRule": { "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "Specifies IP addresses in the denylist or allowlist. This parameter is required when Switch is true. You can specify one or more IP addresses and IP address ranges. IP addresses and ranges can be in IPv4 or IPv6 format. You can enter up to 1,000 addresses. If you specify SharedConfig, you cannot specify this parameter.\n" }, "ruleType": { "type": "string", "description": "Indicates the type of IP list. This parameter is required when Switch is true. Valid values are: allow: indicates Allowlist. deny: indicates Denylist. If you specify SharedConfig, you cannot specify this parameter.\n" }, "sharedConfig": { "$ref": "#/types/volcenginecc:cdn/DomainIpAccessRuleSharedConfig:DomainIpAccessRuleSharedConfig", "description": "Represents a global configuration. If you specify this parameter, you cannot specify RuleType and Ip.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ips", "ruleType", "sharedConfig", "switch" ] } } }, "volcenginecc:cdn/DomainIpAccessRuleSharedConfig:DomainIpAccessRuleSharedConfig": { "properties": { "configName": { "type": "string", "description": "Indicates the name of a global configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configName" ] } } }, "volcenginecc:cdn/DomainMethodDeniedRule:DomainMethodDeniedRule": { "properties": { "methods": { "type": "string", "description": "Indicates one or more HTTP request methods that are disabled. When Switch is true, this parameter is required. Use commas (,) to separate multiple methods. The parameter values are: get: disables the GET request method. post: disables the POST request method. delete: disables the DELETE request method. put: disables the PUT request method. head: disables the HEAD request method. patch: disables the PATCH request method. connect: disables the CONNECT request method. options: disables the OPTIONS request method.\n" }, "switch": { "type": "boolean", "description": "Configuration switch for disabling methods. Use commas to separate multiple methods. Required when enabled. choices: [get, post, head, delete, put]\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "methods", "switch" ] } } }, "volcenginecc:cdn/DomainMultiRange:DomainMultiRange": { "properties": { "switch": { "type": "boolean", "description": "Indicates whether the feature is enabled. This parameter has the following values: true: enables the feature. When enabled, CDN allows Range requests with multiple ranges. false: disables the feature. If a Range request with multiple ranges is received, CDN rejects the request and returns a 416 response status code. The default value is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "switch" ] } } }, "volcenginecc:cdn/DomainNegativeCach:DomainNegativeCach": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainNegativeCachCondition:DomainNegativeCachCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "negativeCacheRule": { "$ref": "#/types/volcenginecc:cdn/DomainNegativeCachNegativeCacheRule:DomainNegativeCachNegativeCacheRule", "description": "Represents a list. Each element in the list is a status code cache rule.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "negativeCacheRule" ] } } }, "volcenginecc:cdn/DomainNegativeCachCondition:DomainNegativeCachCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainNegativeCachConditionConditionRule:DomainNegativeCachConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainNegativeCachConditionConditionRule:DomainNegativeCachConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainNegativeCachNegativeCacheRule:DomainNegativeCachNegativeCacheRule": { "properties": { "action": { "type": "string", "description": "Represents the cache behavior. Currently, you can only specify cache. cache means the behavior is caching.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether the CDN ignores case when matching files in a request with ConditionRule. The parameter has the following options: true: ignore case. false: do not ignore case. The default value is false.\n" }, "statusCode": { "type": "string", "description": "Specify a status code to cache. The status code range is 400–599. You can also specify 4xx or 5xx. 4xx refers to all status codes from 400 to 499. 5xx refers to all status codes from 500 to 599.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache duration for status codes, in seconds. The range is 1–315,360,000. 315,360,000 means 10 years.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "ignoreCase", "statusCode", "ttl" ] } } }, "volcenginecc:cdn/DomainOfflineCache:DomainOfflineCache": { "properties": { "object": { "type": "string", "description": "Indicates the trigger conditions for this feature. The parameter has the following values: request*error: indicates an origin request exception. When an origin request exception occurs, the CDN cannot retrieve files from the origin and does not receive any response status code from the origin. error*code: indicates the CDN cannot retrieve files from the origin, and the origin's response status code is 5xx. request*error,error*code: indicates both conditions are included.\n" }, "statusCode": { "type": "string", "description": "Specifies the specific 5xx response status codes, ranging from 500 to 599. Separate multiple status codes with a semicolon (;). You can also enter 5xx to indicate any status code starting with the digit 5. This parameter is valid only when Object is error*code or request*error,error_code.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "object", "statusCode", "switch" ] } } }, "volcenginecc:cdn/DomainOrigin:DomainOrigin": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainOriginCondition:DomainOriginCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "originAction": { "$ref": "#/types/volcenginecc:cdn/DomainOriginOriginAction:DomainOriginOriginAction", "description": "Indicates origin configuration.\n" } }, "type": "object", "required": [ "originAction" ], "language": { "nodejs": { "requiredOutputs": [ "condition", "originAction" ] } } }, "volcenginecc:cdn/DomainOriginAccessRule:DomainOriginAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Specifies whether requests are allowed when the Origin header in the user request is empty (\"\"). The parameter values are: true: allow; false: do not allow. The default value is false.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether Origin is case sensitive. This parameter has the following values: true: Origin is case insensitive; false: Origin is case sensitive. The default value is true.\n" }, "origins": { "type": "array", "items": { "type": "string" }, "description": "The address list corresponding to RuleType. When Switch is true, this parameter is required. You can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domain names. Domain names can be second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 100 addresses. When entering domain names, you do not need to include http:// or https://. The value length cannot exceed 3,000 characters.\n" }, "ruleType": { "type": "string", "description": "Origin list configuration type. When Switch is true, this parameter is required. The parameter has the following values: allow: indicates allowlist. deny: indicates denylist.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allowEmpty", "ignoreCase", "origins", "ruleType", "switch" ] } } }, "volcenginecc:cdn/DomainOriginArg:DomainOriginArg": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainOriginArgCondition:DomainOriginArgCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "originArgAction": { "$ref": "#/types/volcenginecc:cdn/DomainOriginArgOriginArgAction:DomainOriginArgOriginArgAction", "description": "Represents the action performed when the Condition is met.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "originArgAction" ] } } }, "volcenginecc:cdn/DomainOriginArgCondition:DomainOriginArgCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOriginArgConditionConditionRule:DomainOriginArgConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainOriginArgConditionConditionRule:DomainOriginArgConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainOriginArgOriginArgAction:DomainOriginArgOriginArgAction": { "properties": { "originArgComponents": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOriginArgOriginArgActionOriginArgComponent:DomainOriginArgOriginArgActionOriginArgComponent" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "originArgComponents" ] } } }, "volcenginecc:cdn/DomainOriginArgOriginArgActionOriginArgComponent:DomainOriginArgOriginArgActionOriginArgComponent": { "properties": { "action": { "type": "string", "description": "include: Indicates that the origin request URL includes all query parameters from the user request URL. exclude: Indicates that the origin request URL does not include any query parameters from the user request URL. addPart: Indicates that the origin request URL includes all query parameters from the user request URL, plus the query parameters specified in the Subobject. includePart: Indicates that if the user request URL contains the query parameters specified in the Subobject, the origin request URL will include these specified query parameters. excludePart: Indicates that the origin request URL includes all query parameters from the user request URL except those specified in the Subobject. set: Indicates that the origin request URL includes all query parameters from the user request URL. For the query parameters and values you specify in the Subobject, CDN will perform the following actions: If these query parameters exist in the user request URL, CDN will set their values in the origin request URL to the values you specify. If the user request URL does not contain these query parameters, CDN will add them to the origin request URL.\n" }, "object": { "type": "string", "description": "Indicates which object the CDN performs the Action on. Currently, this parameter can only be set to queryString, which refers to the query string in the request URL.\n" }, "subobject": { "type": "string", "description": "Represents one or more query parameters. Use semicolons (;) to separate multiple query parameters. The total length must not exceed 1,024 characters. Subobject can only contain letters, numbers, underscores (_), commas (,), hyphens (-), periods (.), and exclamation marks (!). When matching query parameters in the request URL, parameters in Subobject are case-sensitive. Additional notes for Subobject: When Action is include or exclude, Subobject must be *, which represents all query parameters in the request URL. When Action is includePart or excludePart, Subobject represents one or more query parameters, for example, param1;param2. When Action is addPart or set, Subobject represents one or more query parameters and their values in the format key=value, for example, param1=val1;param2=val2;param3=val3.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "object", "subobject" ] } } }, "volcenginecc:cdn/DomainOriginCertCheck:DomainOriginCertCheck": { "properties": { "switch": { "type": "boolean", "description": "Switch\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "switch" ] } } }, "volcenginecc:cdn/DomainOriginCondition:DomainOriginCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOriginConditionConditionRule:DomainOriginConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainOriginConditionConditionRule:DomainOriginConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainOriginOriginAction:DomainOriginOriginAction": { "properties": { "originLines": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOriginOriginActionOriginLine:DomainOriginOriginActionOriginLine" } } }, "type": "object", "required": [ "originLines" ] }, "volcenginecc:cdn/DomainOriginOriginActionOriginLine:DomainOriginOriginActionOriginLine": { "properties": { "address": { "type": "string", "description": "Indicates the origin address. The parameter has the following instructions: If InstanceType is ip, you can set an IP address. The IP address can be either IPv4 or IPv6. If InstanceType is domain, you can set a domain name. The domain name cannot be a wildcard domain. If InstanceType is tos, you can set the domain name of an object storage bucket. The bucket can be from Alibaba Cloud, Tencent Cloud, or AWS. If you specify multiple origin configurations in this API request: All primary origin configurations must have the same InstanceType. All backup origin configurations must also have the same InstanceType. If the InstanceType in the primary origin configuration is ip or domain, the InstanceType in the backup origin configuration must also be ip or domain. The total number of primary and backup origin addresses cannot exceed 50.\n" }, "httpPort": { "type": "string", "description": "Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The value range is 1–65535, and the default value is 80. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.\n" }, "httpsPort": { "type": "string", "description": "Indicates the port used by the content delivery network to access the origin server via HTTPS. The value range is 1-65535, and the default value is 443. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.\n" }, "instanceType": { "type": "string", "description": "Indicates the type of origin server. This parameter has the following values: ip: The origin server is accessed via IP address. domain: The origin server is accessed via domain name. tos: The origin server is an object storage bucket.\n" }, "originHost": { "type": "string", "description": "If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.\n" }, "originType": { "type": "string", "description": "Indicates the type of origin server. This parameter has the following values: - primary: Primary origin server. - backup: Backup origin server. At least one primary origin server configuration must be included in this API request. Backup origin server configuration is optional.\n" }, "privateBucketAccess": { "type": "boolean", "description": "Indicates whether private read permissions are enabled for the object storage bucket. This parameter is only valid when InstanceType is tos. The parameter values are: true: Enabled. false: Not enabled. The default value is false.\n" }, "privateBucketAuth": { "$ref": "#/types/volcenginecc:cdn/DomainOriginOriginActionOriginLinePrivateBucketAuth:DomainOriginOriginActionOriginLinePrivateBucketAuth", "description": "Represents the authentication information for the object storage bucket of a third-party cloud provider.\n" }, "region": { "type": "string", "description": "This parameter is not currently available externally. Do not use this parameter.\n" }, "weight": { "type": "string", "description": "Specifies the weight of the origin. Value range is 1–100, default is 1. The higher the weight, the more likely this origin is selected when the content delivery network sends a request to the origin. This parameter is only valid when InstanceType is ip or domain.\n" } }, "type": "object", "required": [ "address", "instanceType", "originType" ], "language": { "nodejs": { "requiredOutputs": [ "address", "httpPort", "httpsPort", "instanceType", "originHost", "originType", "privateBucketAccess", "privateBucketAuth", "region", "weight" ] } } }, "volcenginecc:cdn/DomainOriginOriginActionOriginLinePrivateBucketAuth:DomainOriginOriginActionOriginLinePrivateBucketAuth": { "properties": { "authType": { "type": "string", "description": "Indicates the third-party cloud provider where the object storage bucket is located. The parameter values are: cos: Tencent Cloud. oss: Alibaba Cloud. aws: Amazon AWS.\n" }, "switch": { "type": "boolean", "description": "Indicates whether the object storage bucket is from a third-party cloud provider. This parameter has the following values: true: the object storage bucket is from a third-party cloud provider. The default value is false\n" }, "tosAuthInformation": { "$ref": "#/types/volcenginecc:cdn/DomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation:DomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation", "description": "Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authType", "switch", "tosAuthInformation" ] } } }, "volcenginecc:cdn/DomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation:DomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation": { "properties": { "accessKeyId": { "type": "string", "description": "Specifies the AccessKey ID for your Alibaba Cloud account, SecretId for your Tencent Cloud account, or access key ID for your AWS account.\n" }, "accessKeySecret": { "type": "string", "description": "Indicates the AccessKey Secret for your Alibaba Cloud account, the SecretKey for your Tencent Cloud account, or the secret access key for your AWS account.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessKeyId", "accessKeySecret" ] } } }, "volcenginecc:cdn/DomainOriginRetry:DomainOriginRetry": { "properties": { "statusCode": { "type": "string", "description": "Indicates one or more status codes in the range 400–599. Separate multiple status codes with a semicolon (;). You can enter 4xx or 5xx to represent all status codes starting with the digit 4 or 5.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "statusCode", "switch" ] } } }, "volcenginecc:cdn/DomainOriginRewrite:DomainOriginRewrite": { "properties": { "originRewriteRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRewriteOriginRewriteRule:DomainOriginRewriteOriginRewriteRule" } }, "switch": { "type": "boolean", "description": "Indicates whether to enable this module. The parameter has the following values: true: enables the module. false: disables the module. The default value is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "originRewriteRules", "switch" ] } } }, "volcenginecc:cdn/DomainOriginRewriteOriginRewriteRule:DomainOriginRewriteOriginRewriteRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRewriteOriginRewriteRuleCondition:DomainOriginRewriteOriginRewriteRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "originRewriteAction": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRewriteOriginRewriteRuleOriginRewriteAction:DomainOriginRewriteOriginRewriteRuleOriginRewriteAction", "description": "Indicates a rule configuration for origin path rewrite.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "originRewriteAction" ] } } }, "volcenginecc:cdn/DomainOriginRewriteOriginRewriteRuleCondition:DomainOriginRewriteOriginRewriteRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRewriteOriginRewriteRuleConditionConditionRule:DomainOriginRewriteOriginRewriteRuleConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainOriginRewriteOriginRewriteRuleConditionConditionRule:DomainOriginRewriteOriginRewriteRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainOriginRewriteOriginRewriteRuleOriginRewriteAction:DomainOriginRewriteOriginRewriteRuleOriginRewriteAction": { "properties": { "rewriteType": { "type": "string", "description": "Indicates the rewrite type. This parameter supports the following values: rewrite*path: rewrites the path in the request URL. rewrite*url: rewrites both the path and query string in the request URL. The default value is rewrite_path.\n" }, "sourcePath": { "type": "string", "description": "Indicates a regular expression, with a maximum length of 1,024 characters, used to match objects in the user's request URL. For a user request, if the regular expression matches any part of the object, this rule applies to the request. When RewriteType is rewrite*path, the object refers to the path in the request URL. When RewriteType is rewrite*url, the object refers to both the path and query string in the request URL.\n" }, "targetPath": { "type": "string", "description": "Indicates the object in the origin request URL after rewriting. When RewriteType is rewrite*path, this object is the path in the origin request URL. When RewriteType is rewrite*url, this object is the path and query string in the origin request URL. You can use $1, $2, $3, etc. in TargetPath to represent groups defined in the regular expression of SourcePath.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "rewriteType", "sourcePath", "targetPath" ] } } }, "volcenginecc:cdn/DomainOriginSni:DomainOriginSni": { "properties": { "sniDomain": { "type": "string", "description": "Specifies the domain name for origin SNI. When Switch is true, this parameter is required. The value cannot exceed 1,024 characters.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "sniDomain", "switch" ] } } }, "volcenginecc:cdn/DomainPageOptimization:DomainPageOptimization": { "properties": { "optimizationTypes": { "type": "array", "items": { "type": "string" }, "description": "Specifies the optimization target. This parameter has the following values: html: HTML page. js: JavaScript code. css: CSS code. The default value is html. If you specify js or css, html must also be specified.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are: true: The feature is enabled. false: The feature is disabled.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "optimizationTypes", "switch" ] } } }, "volcenginecc:cdn/DomainQuic:DomainQuic": { "properties": { "switch": { "type": "boolean", "description": "QUIC configuration switch. The parameter values are as follows: true: enables QUIC. false: disables QUIC. To enable QUIC, you must first enable HTTPS.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "switch" ] } } }, "volcenginecc:cdn/DomainRedirectionRewrite:DomainRedirectionRewrite": { "properties": { "redirectionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRedirectionRewriteRedirectionRule:DomainRedirectionRewriteRedirectionRule" } }, "switch": { "type": "boolean", "description": "Indicates whether this configuration is enabled. This parameter has the following values: true: enables URL redirect rewrite. false: disables URL redirect rewrite.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "redirectionRules", "switch" ] } } }, "volcenginecc:cdn/DomainRedirectionRewriteRedirectionRule:DomainRedirectionRewriteRedirectionRule": { "properties": { "redirectionAction": { "$ref": "#/types/volcenginecc:cdn/DomainRedirectionRewriteRedirectionRuleRedirectionAction:DomainRedirectionRewriteRedirectionRuleRedirectionAction", "description": "Indicates a URL redirect rewrite rule\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "redirectionAction" ] } } }, "volcenginecc:cdn/DomainRedirectionRewriteRedirectionRuleRedirectionAction:DomainRedirectionRewriteRedirectionRuleRedirectionAction": { "properties": { "redirectCode": { "type": "string", "description": "Indicates the response status code for URL redirection. Valid values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original and is not changed.\n" }, "sourcePath": { "type": "string", "description": "Specifies the original file path, which is the path included in the request. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value of this parameter cannot exceed 1,024 characters.\n" }, "targetHost": { "type": "string", "description": "Indicates the domain name or IP address of the site to which the target path belongs. The IP address must be IPv4. The parameter value cannot exceed 1,024 characters. The default value is your acceleration domain name.\n" }, "targetPath": { "type": "string", "description": "Indicates the target path after redirection. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value cannot exceed 1,024 characters.\n" }, "targetProtocol": { "type": "string", "description": "Specifies the protocol used for the new request after URL redirection. The parameter values are: followclient: use the protocol of the original request; http: force the new request to use HTTP; https: force the new request to use HTTPS.\n" }, "targetQueryComponents": { "$ref": "#/types/volcenginecc:cdn/DomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents:DomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents", "description": "Indicates how the query parameters in the original request URL are handled.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "redirectCode", "sourcePath", "targetHost", "targetPath", "targetProtocol", "targetQueryComponents" ] } } }, "volcenginecc:cdn/DomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents:DomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents": { "properties": { "action": { "type": "string", "description": "Indicates how to handle query parameters in the original request URL. This parameter has the following values: include: includes all query parameters from the original request URL in the redirected URL. exclude: excludes all query parameters from the original request URL in the redirected URL. includePart: includes specific query parameters from the original request URL in the redirected URL. excludePart: excludes specific query parameters from the original request URL in the redirected URL.\n" }, "value": { "type": "string", "description": "Indicates the query parameters to retain or remove. Multiple query parameters are separated by a semicolon (;). The specified query parameters cannot contain consecutive slashes (//), percent signs (\"), or spaces. The default value of Value is *, which means all query parameters. If Action is include or exclude, Value must be *. If Action is includePart or excludePart, you can specify one or more query parameters. In this case, the specified query parameters cannot be *.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "value" ] } } }, "volcenginecc:cdn/DomainRefererAccessRule:DomainRefererAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Specifies whether the content delivery network accepts a request when the Referer header in the user's request is empty (\"\"). This parameter has the following values: true: accepts the request; false: rejects the request. The default value is false.\n" }, "referers": { "type": "array", "items": { "type": "string" }, "description": "Indicates a list of Referers. The input requirements for this parameter are consistent with those for Referers under the CommonType of ReferersType. We recommend using ReferersType to specify the Referer list. If you specify SharedConfig, you cannot specify this parameter.\n" }, "referersType": { "$ref": "#/types/volcenginecc:cdn/DomainRefererAccessRuleReferersType:DomainRefererAccessRuleReferersType", "description": "Indicates a ReferersType object. It contains a CommonType object and a RegularType object, representing a standard Referer list and a Referer regular expression list, respectively. If you specify SharedConfig, you cannot specify this parameter.\n" }, "ruleType": { "type": "string", "description": "Indicates the type of Referer list. This parameter is required when Switch is true. This parameter has the following values: allow: indicates Allowlist. deny: indicates Denylist.\n" }, "sharedConfig": { "$ref": "#/types/volcenginecc:cdn/DomainRefererAccessRuleSharedConfig:DomainRefererAccessRuleSharedConfig", "description": "Represents a global configuration. If you specify this parameter, you cannot specify Referers or ReferersType.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allowEmpty", "referers", "referersType", "ruleType", "sharedConfig", "switch" ] } } }, "volcenginecc:cdn/DomainRefererAccessRuleReferersType:DomainRefererAccessRuleReferersType": { "properties": { "commonType": { "$ref": "#/types/volcenginecc:cdn/DomainRefererAccessRuleReferersTypeCommonType:DomainRefererAccessRuleReferersTypeCommonType", "description": "Indicates a CommonType object that contains a list of standard Referers.\n" }, "regularType": { "$ref": "#/types/volcenginecc:cdn/DomainRefererAccessRuleReferersTypeRegularType:DomainRefererAccessRuleReferersTypeRegularType", "description": "Specifies a RegularType object, which contains a list of regular expressions used to match the Referer header value in requests This parameter provides the allowlist feature To use this parameter, submit a ticket Note that if the Referer header value in a request matches the Referers list under CommonType or the Referers list under RegularType, the content delivery network considers it a match\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "commonType", "regularType" ] } } }, "volcenginecc:cdn/DomainRefererAccessRuleReferersTypeCommonType:DomainRefererAccessRuleReferersTypeCommonType": { "properties": { "ignoreCase": { "type": "boolean", "description": "Specifies whether the Referers list under CommonType is case sensitive during matching. The parameter supports the following values: true: not case sensitive. false: case sensitive. The default value is true.\n" }, "ignoreScheme": { "type": "boolean", "description": "Indicates whether the Referer header value in this Referers list under CommonType must start with HTTP or HTTPS. This parameter has the following values: true: Referer header values that do not start with HTTP or HTTPS are valid. In this case, the content delivery network will attempt to match them with the Referers list. false: Referer header values that do not start with HTTP or HTTPS are invalid. In this case, the content delivery network determines that they do not match the Referers list under CommonType. The default value is false.\n" }, "referers": { "type": "array", "items": { "type": "string" }, "description": "Represents a standard Referer list. In this list, you can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domains. Domain names can include second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 1,000 IP addresses. The domain names entered must not include http:// or https://. During matching, the content delivery network compares the domain name in the Referer header of the request with the Referer list. The value of this parameter must not exceed 30,000 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ignoreCase", "ignoreScheme", "referers" ] } } }, "volcenginecc:cdn/DomainRefererAccessRuleReferersTypeRegularType:DomainRefererAccessRuleReferersTypeRegularType": { "properties": { "referers": { "type": "array", "items": { "type": "string" }, "description": "Indicates a list of Referer regular expressions. The value of this parameter cannot exceed 30,000 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "referers" ] } } }, "volcenginecc:cdn/DomainRefererAccessRuleSharedConfig:DomainRefererAccessRuleSharedConfig": { "properties": { "configName": { "type": "string", "description": "Indicates the name of a global configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configName" ] } } }, "volcenginecc:cdn/DomainRemoteAuth:DomainRemoteAuth": { "properties": { "remoteAuthRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRule:DomainRemoteAuthRemoteAuthRule" } }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are as follows: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "remoteAuthRules", "switch" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRule:DomainRemoteAuthRemoteAuthRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleCondition:DomainRemoteAuthRemoteAuthRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "remoteAuthRuleAction": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction", "description": "Indicates the specific authentication configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "remoteAuthRuleAction" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleCondition:DomainRemoteAuthRemoteAuthRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleConditionConditionRule:DomainRemoteAuthRemoteAuthRuleConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleConditionConditionRule:DomainRemoteAuthRemoteAuthRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction": { "properties": { "authModeConfig": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig", "description": "Indicates the configuration of the authentication server.\n" }, "authResponseConfig": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig", "description": "The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.\n" }, "queryStringRules": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules", "description": "Represents the parameter settings for authentication requests.\n" }, "requestBodyRules": { "type": "string", "description": "Indicates the rule for the authentication request body. You can leave this parameter unspecified or set its value to default. default means the request body is empty (\"\").\n" }, "requestHeaderRules": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules", "description": "Indicates the settings for authentication request headers. You can set up to 50 request headers.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authModeConfig", "authResponseConfig", "queryStringRules", "requestBodyRules", "requestHeaderRules" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig": { "properties": { "backupRemoteAddr": { "type": "string", "description": "Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.\n" }, "masterRemoteAddr": { "type": "string", "description": "Indicates the primary address of the authentication server. The length must not exceed 100 characters. The primary address format is \\n\\n://\\n\\n:\\n\\n or \\n\\n://\\n\\n:\\n\\n, where: \\n\\n is http or https. \\n\\n cannot be localhost. \\n\\n cannot be 127.0.0.1. \\n\\n is optional.\n" }, "pathType": { "type": "string", "description": "Indicates the path for the authentication request. The authentication address and request path together form the complete authentication URL. The content delivery network forwards the user's request to this authentication URL. The parameter accepts the following values: constant: The path in the authentication request is the same as the path in the user's request. variable: You need to specify a path for the authentication request in the pathValue parameter.\n" }, "pathValue": { "type": "string", "description": "Represents the path for an authentication request. The path cannot exceed 100 characters. It must start with a slash (/), and can include any printable ASCII characters except the following: consecutive slashes (//), percent sign (%), dollar sign ($), space, question mark (?), and Delete (ASCII code 127).\n" }, "requestMethod": { "type": "string", "description": "Indicates the request method used by the content delivery network when sending authentication requests. The parameter has the following values: default: uses the same method as the user's request. get: uses the GET method. post: uses the POST method. head: uses the HEAD method.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "backupRemoteAddr", "masterRemoteAddr", "pathType", "pathValue", "requestMethod" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig": { "properties": { "cacheAction": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction", "description": "The content delivery network can cache authentication status codes. This parameter indicates the related configuration.\n" }, "responseAction": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction", "description": "Indicates how the content delivery network responds to users when authentication fails.\n" }, "statusCodeAction": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction", "description": "Specifies how the content delivery network handles authentication status codes.\n" }, "timeOutAction": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction", "description": "Specifies how the content delivery network handles authentication requests after authentication timeout.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheAction", "responseAction", "statusCodeAction", "timeOutAction" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction": { "properties": { "action": { "type": "string", "description": "Indicates whether the CDN caches authentication status codes. The parameter values are: nocache: CDN does not cache authentication status codes. cache: CDN caches authentication status codes.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "The cache key specifies the query parameters used to distinguish different request URIs. Each parameter must start with $.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache duration for authentication status codes, measured in seconds. The range is 1–86400. 86400 seconds equals 24 hours.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "cacheKeys", "ttl" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction": { "properties": { "statusCode": { "type": "string", "description": "Indicates the status code returned by the content delivery network to the user when authentication fails. You can specify any status code in the range 400–499. The default value is 403.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "statusCode" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction": { "properties": { "defaultAction": { "type": "string", "description": "Specifies how the content delivery network handles authentication requests when the authentication status code is neither FailCode nor SuccessCode. This parameter has the following values: reject: the content delivery network considers authentication failed; pass: the content delivery network considers authentication successful.\n" }, "failCode": { "type": "string", "description": "Indicates the authentication status code returned when authentication fails. You can specify one or more status codes in the range 400–499. Separate multiple status codes with a semicolon (;). You can also specify 4xx to indicate any status code between 400 and 499. The default value for this parameter is 401.\n" }, "successCode": { "type": "string", "description": "Indicates the authentication status code for successful authentication. You can specify one or more status codes in the range 200–299. Separate multiple status codes with a semicolon (;). You can also specify 2xx to represent any status code from 200–299. The default value is 200.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "defaultAction", "failCode", "successCode" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction": { "properties": { "action": { "type": "string", "description": "Indicates the strategy for handling authentication requests after a timeout in the content delivery network. This parameter supports the following values: reject: The content delivery network considers authentication failed. pass: The content delivery network considers authentication successful.\n" }, "time": { "type": "integer", "description": "Specifies the authentication timeout in milliseconds. The default value is 200. The valid range is 200–3600.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "time" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules": { "properties": { "queryStringComponents": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents", "description": "Indicates the strategy for setting authentication request parameters.\n" }, "queryStringInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "queryStringComponents", "queryStringInstances" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents": { "properties": { "action": { "type": "string", "description": "Indicates whether the authentication request includes query parameters from the user's request URL. The parameter accepts the following values: exclude: The authentication request does not include any query parameters. include: The authentication request includes all query parameters. includePart: The authentication request includes specified query parameters.\n" }, "value": { "type": "string", "description": "Indicates the parameter value corresponding to the Action parameter. The length cannot exceed 1,024 characters. The parameter accepts the following values: If Action is exclude or include, Value must be *. If Action is includePart, you need to specify one or more query parameters from the user's request URL in the Value parameter, separated by semicolons (;). You cannot specify *. Query parameters are case-sensitive and can include printable ASCII characters except for the following: double quotes (\") , spaces, and Delete (ASCII code 127). The default value for this parameter is *.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "value" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance": { "properties": { "action": { "type": "string", "description": "Describes how to set authentication request parameters. Currently, you can only set Action to set. set means to configure parameters. You need to specify the authentication request parameter to set in Key. If the specified authentication request parameter does not exist, the content delivery network adds the parameter to the authentication request. If the specified authentication request parameter already exists, the content delivery network uses the value of Value as the parameter's value.\n" }, "key": { "type": "string", "description": "Indicates the authentication request parameter you need to set. The length must not exceed 1,024 characters. The authentication request parameter can contain printable ASCII characters except for the following: double quotes (\"), space, and Delete (ASCII code 127)\n" }, "value": { "type": "string", "description": "Indicates the value of the authentication request parameter. The length cannot exceed 1,024 characters and is case-sensitive. Value has the following options: When ValueType is constant, the authentication request parameter value is a constant. You need to specify this constant value. The constant value cannot start with a dollar sign ($) and can include any printable ASCII character except the following: double quotes (\") and Delete (ASCII code 127). When ValueType is variable, the authentication request parameter value comes from a variable. You can specify a variable from the variable list. When ValueType is customize, the authentication request parameter value is a string formed by concatenating variables from the list with fixed strings. In the concatenated string, variables are represented as ${variable*name}. Example value: bind${request*uri}to${local_ip}done\n" }, "valueType": { "type": "string", "description": "Indicates the type of authentication request parameter set in Key. ValueType has the following options: constant: The authentication request parameter is a constant. In this case, you need to specify the constant value in Value. variable: The authentication request parameter value comes from a variable. See the description for Value. customize: The authentication request parameter value is a string formed by concatenating a variable and a fixed string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "key", "value", "valueType" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules": { "properties": { "requestHeaderComponents": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents", "description": "Indicates the configuration policy for authentication request headers.\n" }, "requestHeaderInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance" } }, "requestHost": { "type": "string", "description": "Indicates the value of the HOST header in authentication requests. The default value for this parameter is default, meaning the HOST header matches your acceleration domain name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "requestHeaderComponents", "requestHeaderInstances", "requestHost" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents": { "properties": { "action": { "type": "string", "description": "Indicates whether the authentication request header includes user request headers. The parameter values are: exclude: the authentication request header does not include any user request headers. include: the authentication request header includes all user request headers. includePart: the authentication request header includes specified user request headers.\n" }, "value": { "type": "string", "description": "Indicates the parameter value corresponding to the Action parameter. The length must not exceed 1,024 characters. The parameter has the following notes: If Action is exclude or include, Value must be *. If Action is includePart, the Value parameter can be one or more headers from the user's request. Multiple headers are separated by a semicolon (;). The value cannot be only *, and can include printable ASCII characters except for the following: underscore (_), space, double quotes (\"), Delete (ASCII code 127). The default value for this parameter is *.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "value" ] } } }, "volcenginecc:cdn/DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance:DomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance": { "properties": { "action": { "type": "string", "description": "Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.\n" }, "key": { "type": "string", "description": "Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes (\"), and Delete (ASCII code 127).\n" }, "value": { "type": "string", "description": "Indicates the value of the Key. This parameter is only valid when Action equals \"set\". If Action does not equal \"set\", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)\n" }, "valueType": { "type": "string", "description": "Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "key", "value", "valueType" ] } } }, "volcenginecc:cdn/DomainRequestBlockRule:DomainRequestBlockRule": { "properties": { "blockRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRequestBlockRuleBlockRule:DomainRequestBlockRuleBlockRule" } }, "switch": { "type": "boolean", "description": "Indicates the configuration switch for this module. This parameter has the following values: true: enables the module. false: disables the module. The default value is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "blockRules", "switch" ] } } }, "volcenginecc:cdn/DomainRequestBlockRuleBlockRule:DomainRequestBlockRuleBlockRule": { "properties": { "blockAction": { "$ref": "#/types/volcenginecc:cdn/DomainRequestBlockRuleBlockRuleBlockAction:DomainRequestBlockRuleBlockRuleBlockAction", "description": "Indicates the interception configuration for a rule in the list.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/DomainRequestBlockRuleBlockRuleCondition:DomainRequestBlockRuleBlockRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "ruleName": { "type": "string", "description": "Indicates the name of the rule, which must not exceed 20 characters and can include letters, numbers, underscores (_), hyphens (-), and Chinese characters. One Chinese character counts as 3 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "blockAction", "condition", "ruleName" ] } } }, "volcenginecc:cdn/DomainRequestBlockRuleBlockRuleBlockAction:DomainRequestBlockRuleBlockRuleBlockAction": { "properties": { "action": { "type": "string", "description": "Specifies how the content delivery network intercepts matching requests. This parameter has the following values: refuse: The content delivery network rejects the request and returns a 4xx error code. The error code is specified in StatusCode. redirect: The content delivery network redirects the request to the URL specified in RedirectUrl.\n" }, "errorPage": { "type": "string", "description": "When Action is refuse, this parameter is optional, as explained below: If specified, this parameter indicates the name of a custom response page under global configuration. When the content delivery network refuses a request, it returns this custom page. Note that 'global configuration' is an Allowlist feature. To use this feature, submit a ticket. If this parameter is not specified, the content delivery network uses the standard response body for the error code specified in StatusCode. When Action is redirect, this parameter is invalid and can be omitted.\n" }, "redirectUrl": { "type": "string", "description": "When Action is redirect, this parameter is required and specifies the redirect URL. The URL must start with http:// or https:// and cannot exceed 1,024 characters. When Action is refuse, this parameter is invalid and can be omitted.\n" }, "statusCode": { "type": "string", "description": "Represents the response status code from the content delivery network for intercepted requests. When Action is refuse, this parameter specifies an error code in the range 400–499. When Action is redirect, this parameter can be: 301: The response status code is 301. 302: The response status code is 302.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "errorPage", "redirectUrl", "statusCode" ] } } }, "volcenginecc:cdn/DomainRequestBlockRuleBlockRuleCondition:DomainRequestBlockRuleBlockRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRequestBlockRuleBlockRuleConditionConditionRule:DomainRequestBlockRuleBlockRuleConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainRequestBlockRuleBlockRuleConditionConditionRule:DomainRequestBlockRuleBlockRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainRequestHeader:DomainRequestHeader": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainRequestHeaderCondition:DomainRequestHeaderCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "requestHeaderAction": { "$ref": "#/types/volcenginecc:cdn/DomainRequestHeaderRequestHeaderAction:DomainRequestHeaderRequestHeaderAction", "description": "Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "requestHeaderAction" ] } } }, "volcenginecc:cdn/DomainRequestHeaderCondition:DomainRequestHeaderCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRequestHeaderConditionConditionRule:DomainRequestHeaderConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainRequestHeaderConditionConditionRule:DomainRequestHeaderConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainRequestHeaderRequestHeaderAction:DomainRequestHeaderRequestHeaderAction": { "properties": { "requestHeaderInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRequestHeaderRequestHeaderActionRequestHeaderInstance:DomainRequestHeaderRequestHeaderActionRequestHeaderInstance" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "requestHeaderInstances" ] } } }, "volcenginecc:cdn/DomainRequestHeaderRequestHeaderActionRequestHeaderInstance:DomainRequestHeaderRequestHeaderActionRequestHeaderInstance": { "properties": { "action": { "type": "string", "description": "Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.\n" }, "key": { "type": "string", "description": "Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes (\"), and Delete (ASCII code 127).\n" }, "value": { "type": "string", "description": "Indicates the value of the Key. This parameter is only valid when Action equals \"set\". If Action does not equal \"set\", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)\n" }, "valueType": { "type": "string", "description": "Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "action", "key", "value", "valueType" ] } } }, "volcenginecc:cdn/DomainResponseHeader:DomainResponseHeader": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainResponseHeaderCondition:DomainResponseHeaderCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "responseHeaderAction": { "$ref": "#/types/volcenginecc:cdn/DomainResponseHeaderResponseHeaderAction:DomainResponseHeaderResponseHeaderAction", "description": "Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "responseHeaderAction" ] } } }, "volcenginecc:cdn/DomainResponseHeaderCondition:DomainResponseHeaderCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainResponseHeaderConditionConditionRule:DomainResponseHeaderConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainResponseHeaderConditionConditionRule:DomainResponseHeaderConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainResponseHeaderResponseHeaderAction:DomainResponseHeaderResponseHeaderAction": { "properties": { "responseHeaderInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainResponseHeaderResponseHeaderActionResponseHeaderInstance:DomainResponseHeaderResponseHeaderActionResponseHeaderInstance" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "responseHeaderInstances" ] } } }, "volcenginecc:cdn/DomainResponseHeaderResponseHeaderActionResponseHeaderInstance:DomainResponseHeaderResponseHeaderActionResponseHeaderInstance": { "properties": { "accessOriginControl": { "type": "boolean", "description": "Indicates whether the Origin field in the request header is validated when the content delivery network responds to user requests. Valid values are: true: The content delivery network validates the Origin field. If validation succeeds, the response header includes the Access-Control-Allow-Origin field, with the value matching the Origin field. If validation fails, the response header does not include the Access-Control-Allow-Origin field. false: The content delivery network does not validate the Origin field. The response header includes the Access-Control-Allow-Origin field, with the value set to your configured Access-Control-Allow-Origin content. The default value is false. This parameter is only effective when all the following conditions are met: Action is set. Key is Access-Control-Allow-Origin. ValueType is constant.\n" }, "action": { "type": "string", "description": "Specifies the operation on the response header. This parameter has the following values: set: sets a header. The set operation includes adding and modifying. If the header already exists in the origin response, its value will be overwritten. If the header does not exist in the origin response, it will be added. delete: deletes a header\n" }, "key": { "type": "string", "description": "Specifies the name of a header. The name cannot exceed 1,024 characters, is case-insensitive, and can include any printable ASCII character except the following: underscore (_), space, double quotes (\"), and Delete (ASCII code 127)\n" }, "value": { "type": "string", "description": "Indicates the value of the Key. This parameter is valid only when Action is set. If Action is not set, this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can include printable ASCII characters except for the following: dollar sign ($), Delete (ASCII code 127).\n" }, "valueType": { "type": "string", "description": "Specifies the value type for Key. This parameter is only valid when Action is set. If Action is not set, this parameter is invalid. The parameter supports the following values: constant: Key is a fixed string. variable: Key is sourced from a variable. customize: Key is a string formed by concatenating a variable and a fixed string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessOriginControl", "action", "key", "value", "valueType" ] } } }, "volcenginecc:cdn/DomainRewriteHls:DomainRewriteHls": { "properties": { "signName": { "type": "string", "description": "Indicates the name of the signature parameter, which cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!). The default value is DrmAuthToken.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "signName", "switch" ] } } }, "volcenginecc:cdn/DomainSignedUrlAuth:DomainSignedUrlAuth": { "properties": { "signedUrlAuthRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRule:DomainSignedUrlAuthSignedUrlAuthRule" } }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "signedUrlAuthRules", "switch" ] } } }, "volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRule:DomainSignedUrlAuthSignedUrlAuthRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleCondition:DomainSignedUrlAuthSignedUrlAuthRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "signedUrlAuthAction": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction:DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction", "description": "Indicates the configuration for signature calculation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "signedUrlAuthAction" ] } } }, "volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleCondition:DomainSignedUrlAuthSignedUrlAuthRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule:DomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule:DomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction:DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction": { "properties": { "authAlgorithm": { "type": "string", "description": "Indicates the algorithm used for signature calculation. This configuration has the following values: md5: MD5 algorithm. sha256: SHA-256 algorithm. The default value for this parameter is md5.\n" }, "backupSecretKey": { "type": "string", "description": "Indicates the backup secret key. The backup secret key must be 6–40 characters long and can contain any printable ASCII character except Delete (ASCII code 127).\n" }, "customVariableRules": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules:DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules", "description": "Indicates custom signature calculation variables.\n" }, "duration": { "type": "integer", "description": "The validity period of the signature, in seconds. This parameter is used with the timestamp included in the request to calculate the expiration time of the signature. The value range for this parameter is 0–315,360,000. Signature expiration time = timestamp + Duration. When the content delivery network receives a request, if the signature expiration time is less than the current time, the content delivery network determines that the signature has expired.\n" }, "keepOriginArg": { "type": "boolean", "description": "This parameter is not currently available to external users. Do not use this parameter.\n" }, "masterSecretKey": { "type": "string", "description": "Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)\n" }, "rewriteM3U8": { "type": "boolean", "description": "Indicates whether the content delivery network adds signature parameters to the URL of each segment file in a .m3u8 file when responding to a .m3u8 file request. The signature for each segment URL is calculated based on the rewritten segment URL using the signature rules. The parameter values are as follows: true: enabled. false: disabled.\n" }, "rewriteM3U8Rule": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule:DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule", "description": "Specifies the configuration for the 'M3U8 Rewrite' feature. This configuration is valid only when both of the following conditions are met: RewriteM3u8 is true; URLAuthType is not typee.\n" }, "signName": { "type": "string", "description": "Indicates the name of the signature parameter. The length cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!).\n" }, "signatureRules": { "type": "array", "items": { "type": "string" }, "description": "When URLAuthType is set to typee, this parameter is required and specifies the fields to be included in the signature calculation. The following fields must be included in the signature calculation: key: the secret key, which is the parameter value for MasterSecretKey or BackupSecretKey. uri: the URI of the resource requested by the user. If the URI contains Chinese characters, you need to encode the URI. TimeName: the parameter value for the timestamp. The following fields can optionally be included in the signature calculation: domain: the acceleration domain name. referer: the referer value carried in the user's request. ua: the User-Agent value carried in the user's request. ip: the client IP of the user's request. origin: the Origin value carried in the user's request. Custom variables: the variable names you define in CustomVariableInstances. The order in which the fields are listed determines the order of values in MD5() during signature calculation.\n" }, "timeFormat": { "type": "string", "description": "Numeral system configuration. This parameter has the following values: decimal: decimal system; hexadecimal: hexadecimal system. When URLAuthType is typed or typee, this parameter is required. When URLAuthType is typec, regardless of your setting, this parameter is forcibly set to hexadecimal. For other URLAuthType values, this parameter is not effective.\n" }, "timeName": { "type": "string", "description": "Indicates the name of the timestamp parameter. The value of TimeName can include English letters, numbers, underscores (_), hyphens (-), periods (.), commas (,), and exclamation marks (!), with a length of 1–100 characters. TimeName cannot be the same as SignName. When URLAuthType is typed or typee, this parameter is required. For other types, this parameter does not apply.\n" }, "urlAuthType": { "type": "string", "description": "Signature type\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authAlgorithm", "backupSecretKey", "customVariableRules", "duration", "keepOriginArg", "masterSecretKey", "rewriteM3U8", "rewriteM3U8Rule", "signName", "signatureRules", "timeFormat", "timeName", "urlAuthType" ] } } }, "volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules:DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules": { "properties": { "customVariableInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRulesCustomVariableInstance:DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRulesCustomVariableInstance" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customVariableInstances" ] } } }, "volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRulesCustomVariableInstance:DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRulesCustomVariableInstance": { "properties": { "operator": { "type": "string", "description": "Indicates the matching method for the variable. The value of this parameter can only be match.\n" }, "type": { "type": "string", "description": "Indicates the variable type. This parameter has the following values: queryString: indicates the variable is a query parameter in the request. requestHeader: indicates the variable is a header field in the request.\n" }, "value": { "type": "string", "description": "Specifies the variable name, with a maximum length of 100 characters. Variable name requirements are as follows: If Type is queryString, the variable name can include letters, numbers, hyphens (-), commas (,), periods (.), and exclamation marks (!). If Type is requestHeader, the variable name can include any printable ASCII character except: underscore (_), space, double quotes (\"), colon (:), and Delete (ASCII code 127).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule:DomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule": { "properties": { "deleteParam": { "type": "boolean", "description": "Indicates whether to retain the original parameters in the URL when rewriting the shard URL. This parameter has the following values: true: removes the original parameters. false: retains the original parameters.\n" }, "keepM3U8Param": { "type": "boolean", "description": "Indicates whether to add unsigned query parameters from the M3U8 file request to the segment URL. The parameter has the following options: true: add query parameters to the segment URL. false: do not add query parameters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deleteParam", "keepM3U8Param" ] } } }, "volcenginecc:cdn/DomainTag:DomainTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:cdn/DomainTimeout:DomainTimeout": { "properties": { "switch": { "type": "boolean", "description": "Specify whether to enable origin timeout configuration. This parameter has the following values: true: enables origin timeout configuration. false: disables origin timeout configuration. In this case, the system default timeout values are used for TCP and HTTP requests, which are 2 seconds and 60 seconds respectively.\n" }, "timeoutRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainTimeoutTimeoutRule:DomainTimeoutTimeoutRule" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "switch", "timeoutRules" ] } } }, "volcenginecc:cdn/DomainTimeoutTimeoutRule:DomainTimeoutTimeoutRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/DomainTimeoutTimeoutRuleCondition:DomainTimeoutTimeoutRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "timeoutAction": { "$ref": "#/types/volcenginecc:cdn/DomainTimeoutTimeoutRuleTimeoutAction:DomainTimeoutTimeoutRuleTimeoutAction", "description": "Indicates the timeout configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "timeoutAction" ] } } }, "volcenginecc:cdn/DomainTimeoutTimeoutRuleCondition:DomainTimeoutTimeoutRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainTimeoutTimeoutRuleConditionConditionRule:DomainTimeoutTimeoutRuleConditionConditionRule" } }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionRules", "connective" ] } } }, "volcenginecc:cdn/DomainTimeoutTimeoutRuleConditionConditionRule:DomainTimeoutTimeoutRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "object", "operator", "type", "value" ] } } }, "volcenginecc:cdn/DomainTimeoutTimeoutRuleTimeoutAction:DomainTimeoutTimeoutRuleTimeoutAction": { "properties": { "httpTimeout": { "type": "integer", "description": "Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.\n" }, "tcpTimeout": { "type": "integer", "description": "Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "httpTimeout", "tcpTimeout" ] } } }, "volcenginecc:cdn/DomainUaAccessRule:DomainUaAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Indicates whether requests with an empty UA (\"\") or without a UA field are allowed to access the acceleration domain. The parameter has the following values: true: allowed. false: not allowed. The default value is false.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether the UA string is case-sensitive. The parameter has the following options: true: The UA string is case-insensitive. false: The UA string is case-sensitive. The default value for this parameter is false.\n" }, "ruleType": { "type": "string", "description": "Specifies whether a denylist or allowlist is used. When Switch is true, this parameter is required. The parameter values are as follows: deny: specifies a denylist. allow: specifies an allowlist.\n" }, "switch": { "type": "boolean", "description": "Indicates whether the UA allowlist and blocklist feature is enabled. This parameter has the following values: true: enabled. false: disabled.\n" }, "userAgents": { "type": "array", "items": { "type": "string" }, "description": "Represents a list of UAs. When Switch is true, this parameter is required. The list can contain up to 1,000 UAs. The parameter details are as follows: The value length cannot exceed 30,000 characters. If RuleType is allow, only requests containing UAs in the list are permitted to access the acceleration domain. If RuleType is deny, requests containing UAs in the list are not permitted to access the acceleration domain. UA character restrictions are as follows: You can use * in a UA to represent one or more characters. * can only appear at the beginning or end of the UA. A UA cannot consist only of * or spaces. A UA can contain printable ASCII characters except Delete (ASCII code 127). If a UA contains symbols, the symbols must be HTML encoded.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allowEmpty", "ignoreCase", "ruleType", "switch", "userAgents" ] } } }, "volcenginecc:cdn/DomainUrlNormalize:DomainUrlNormalize": { "properties": { "normalizeObjects": { "type": "array", "items": { "type": "string" }, "description": "This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dot*segments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. back*slashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).\n" }, "switch": { "type": "boolean", "description": "This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dot*segments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. back*slashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "normalizeObjects", "switch" ] } } }, "volcenginecc:cdn/DomainVideoDrag:DomainVideoDrag": { "properties": { "switch": { "type": "boolean", "description": "Smart compression configuration switch. The parameter has the following options: true: enable video seeking. false: disable video seeking.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "switch" ] } } }, "volcenginecc:cdn/ShareConfigAllowIpAccessRule:ShareConfigAllowIpAccessRule": { "properties": { "rules": { "type": "array", "items": { "type": "string" }, "description": "Specifies a list of entries. Each entry in the list is an IP address or CIDR block. IP addresses and blocks can be in IPv4 or IPv6 format. List limits: For AddSharedConfig, the number of entries in the list cannot exceed 30,000.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "rules" ] } } }, "volcenginecc:cdn/ShareConfigAllowRefererAccessRule:ShareConfigAllowRefererAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Indicates whether requests with an empty Referer header or without a Referer header are not allowed. This parameter has the following values: true: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. false: Allowed. The default value is false.\n" }, "commonType": { "$ref": "#/types/volcenginecc:cdn/ShareConfigAllowRefererAccessRuleCommonType:ShareConfigAllowRefererAccessRuleCommonType", "description": "Specifies the contents of the common list.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allowEmpty", "commonType" ] } } }, "volcenginecc:cdn/ShareConfigAllowRefererAccessRuleCommonType:ShareConfigAllowRefererAccessRuleCommonType": { "properties": { "ignoreCase": { "type": "boolean", "description": "Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.\n" }, "rules": { "type": "array", "items": { "type": "string" }, "description": "Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ignoreCase", "rules" ] } } }, "volcenginecc:cdn/ShareConfigCommonMatchList:ShareConfigCommonMatchList": { "properties": { "commonType": { "$ref": "#/types/volcenginecc:cdn/ShareConfigCommonMatchListCommonType:ShareConfigCommonMatchListCommonType", "description": "Specifies the contents of the common list.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "commonType" ] } } }, "volcenginecc:cdn/ShareConfigCommonMatchListCommonType:ShareConfigCommonMatchListCommonType": { "properties": { "ignoreCase": { "type": "boolean", "description": "Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.\n" }, "rules": { "type": "array", "items": { "type": "string" }, "description": "Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ignoreCase", "rules" ] } } }, "volcenginecc:cdn/ShareConfigDenyIpAccessRule:ShareConfigDenyIpAccessRule": { "properties": { "rules": { "type": "array", "items": { "type": "string" }, "description": "Specifies the configuration for an IP denylist, where ConfigType is deny*ip*access_rule.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "rules" ] } } }, "volcenginecc:cdn/ShareConfigDenyRefererAccessRule:ShareConfigDenyRefererAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Indicates whether requests with an empty Referer header or without a Referer header are allowed. This parameter has the following values: true: Allowed. false: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. The default value is true.\n" }, "commonType": { "$ref": "#/types/volcenginecc:cdn/ShareConfigDenyRefererAccessRuleCommonType:ShareConfigDenyRefererAccessRuleCommonType", "description": "Specifies the contents of the common list.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allowEmpty", "commonType" ] } } }, "volcenginecc:cdn/ShareConfigDenyRefererAccessRuleCommonType:ShareConfigDenyRefererAccessRuleCommonType": { "properties": { "ignoreCase": { "type": "boolean", "description": "Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.\n" }, "rules": { "type": "array", "items": { "type": "string" }, "description": "Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ignoreCase", "rules" ] } } }, "volcenginecc:cdn/getDomainAreaAccessRule:getDomainAreaAccessRule": { "properties": { "areas": { "type": "array", "items": { "type": "string" }, "description": "Indicates a list of countries to which an allowlist or denylist is applied. When Switch is true, this parameter is required. Country names are represented in abbreviated form. Multiple country names are separated by commas (,).\n" }, "ruleType": { "type": "string", "description": "Indicates the rule type for the 'region access control' feature. This parameter has the following values: deny: indicates Denylist. allow: indicates Allowlist.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.\n" } }, "type": "object", "required": [ "areas", "ruleType", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainBrowserCach:getDomainBrowserCach": { "properties": { "cacheAction": { "$ref": "#/types/volcenginecc:cdn/getDomainBrowserCachCacheAction:getDomainBrowserCachCacheAction", "description": "Indicates the relevant configuration for cache behavior.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainBrowserCachCondition:getDomainBrowserCachCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "required": [ "cacheAction", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainBrowserCachCacheAction:getDomainBrowserCachCacheAction": { "properties": { "action": { "type": "string", "description": "Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.\n" }, "defaultPolicy": { "type": "string", "description": "This parameter is shared by multiple CDN features.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.\n" } }, "type": "object", "required": [ "action", "defaultPolicy", "ignoreCase", "ttl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainBrowserCachCondition:getDomainBrowserCachCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainBrowserCachConditionConditionRule:getDomainBrowserCachConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainBrowserCachConditionConditionRule:getDomainBrowserCachConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCach:getDomainCach": { "properties": { "cacheAction": { "$ref": "#/types/volcenginecc:cdn/getDomainCachCacheAction:getDomainCachCacheAction", "description": "Indicates the relevant configuration for cache behavior.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainCachCondition:getDomainCachCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "required": [ "cacheAction", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCachCacheAction:getDomainCachCacheAction": { "properties": { "action": { "type": "string", "description": "Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.\n" }, "defaultPolicy": { "type": "string", "description": "This parameter is shared by multiple CDN features.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.\n" } }, "type": "object", "required": [ "action", "defaultPolicy", "ignoreCase", "ttl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCachCondition:getDomainCachCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCachConditionConditionRule:getDomainCachConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCachConditionConditionRule:getDomainCachConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheHost:getDomainCacheHost": { "properties": { "cacheHostRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheHostCacheHostRule:getDomainCacheHostCacheHostRule" }, "description": "Indicates a set of shared cache HOST configurations. Currently, you can only create one configuration. When Switch is true, this parameter is required.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.\n" } }, "type": "object", "required": [ "cacheHostRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheHostCacheHostRule:getDomainCacheHostCacheHostRule": { "properties": { "cacheHostAction": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheHostCacheHostRuleCacheHostAction:getDomainCacheHostCacheHostRuleCacheHostAction", "description": "Indicates the target domain. The target domain must be an accelerated domain under your account. This parameter specifies that the Domain shares the cache of CacheHost.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheHostCacheHostRuleCondition:getDomainCacheHostCacheHostRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "required": [ "cacheHostAction", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheHostCacheHostRuleCacheHostAction:getDomainCacheHostCacheHostRuleCacheHostAction": { "properties": { "cacheHost": { "type": "string", "description": "Specifies the target domain name. The target domain name must be an acceleration domain under your account. This parameter indicates that Domain shares the cache of CacheHost.\n" } }, "type": "object", "required": [ "cacheHost" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheHostCacheHostRuleCondition:getDomainCacheHostCacheHostRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheHostCacheHostRuleConditionConditionRule:getDomainCacheHostCacheHostRuleConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheHostCacheHostRuleConditionConditionRule:getDomainCacheHostCacheHostRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheKey:getDomainCacheKey": { "properties": { "cacheKeyAction": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheKeyCacheKeyAction:getDomainCacheKeyCacheKeyAction", "description": "Indicates the action performed by the content delivery network under the Condition scenario.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheKeyCondition:getDomainCacheKeyCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "required": [ "cacheKeyAction", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheKeyCacheKeyAction:getDomainCacheKeyCacheKeyAction": { "properties": { "cacheKeyComponents": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheKeyCacheKeyActionCacheKeyComponent:getDomainCacheKeyCacheKeyActionCacheKeyComponent" }, "description": "Indicates a list of operation configurations. Currently, you can only set one operation configuration.\n" } }, "type": "object", "required": [ "cacheKeyComponents" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheKeyCacheKeyActionCacheKeyComponent:getDomainCacheKeyCacheKeyActionCacheKeyComponent": { "properties": { "action": { "type": "string", "description": "Specifies the action to perform; required when modifying. This parameter has the following values: exclude: The cache key does not include any query parameters, which means parameters are removed from the cache. include: The cache key includes all query parameters, which means parameters are retained in the cache. includePart: The cache key includes query parameters in Subobject, which means some parameters are retained in the cache. excludePart: The cache key does not include query parameters in Subobject, which means some parameters are removed from the cache.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether the content delivery network ignores case when matching Value. The parameter values are: true: ignore case. false: do not ignore case. The default value is false.\n" }, "object": { "type": "string", "description": "Indicates the object to be set. Currently, you can only specify queryString. queryString refers to the query parameters in the request URL.\n" }, "subobject": { "type": "string", "description": "Specify one or more objects of the Object type. Parameter details: If Action is include or exclude, Subobject must be *. * means all query parameters. If Action is includePart or excludePart, you can specify one or more query parameters. The query parameters you specify cannot be *, and cannot contain consecutive slashes (//), percent signs (%), or spaces. Use a semicolon (;) to separate multiple query parameter names. The default value for Subobject is *.\n" } }, "type": "object", "required": [ "action", "ignoreCase", "object", "subobject" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheKeyCondition:getDomainCacheKeyCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheKeyConditionConditionRule:getDomainCacheKeyConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCacheKeyConditionConditionRule:getDomainCacheKeyConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCompression:getDomainCompression": { "properties": { "compressionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCompressionCompressionRule:getDomainCompressionCompressionRule" }, "description": "Indicates a set of smart compression configuration rules. This parameter is required when Switch is true.\n" }, "switch": { "type": "boolean", "description": "Smart compression configuration switch. This parameter has the following values: true: enables smart compression. false: disables smart compression.\n" } }, "type": "object", "required": [ "compressionRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCompressionCompressionRule:getDomainCompressionCompressionRule": { "properties": { "compressionAction": { "$ref": "#/types/volcenginecc:cdn/getDomainCompressionCompressionRuleCompressionAction:getDomainCompressionCompressionRuleCompressionAction", "description": "Represents the configuration for compression operations.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainCompressionCompressionRuleCondition:getDomainCompressionCompressionRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "required": [ "compressionAction", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCompressionCompressionRuleCompressionAction:getDomainCompressionCompressionRuleCompressionAction": { "properties": { "compressionFormat": { "type": "string", "description": "If the matching condition is based on the Content-Type header (when Condition is null or not specified), this parameter specifies the matching criteria for Content-Type. The values are as follows: default: matches file types included in the default Content-Type list. customize: matches custom file types in the Content-Type header. If Condition is not null, the matching criteria are defined in ConditionRule. In this case, this parameter must be set to all.\n" }, "compressionTarget": { "type": "string", "description": "Specifies the file types to compress. The parameter is described as follows: If CompressionFormat is default, this parameter must be set to *, indicating the default Content-Type list. The list includes the following file types: text/html, text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, text/javascript, image/tiff, image/svg+xml, application/json, application/xml, text/plain; charset=utf-8. If CompressionFormat is customize, you need to specify one or more file types. Multiple file types are separated by commas (,). If CompressionFormat is all, this parameter must be set to *.\n" }, "compressionTypes": { "type": "array", "items": { "type": "string" }, "description": "Compression algorithm: gzip and br specify the compression type. default: compresses all files by default, with the target count as *. customize: compresses custom file types. Choices: [default, customize]\n" }, "maxFileSizeKb": { "type": "integer", "description": "Indicates the minimum value for the file size range. CDN only compresses files within the range specified by MinFileSizeKB and MaxFileSizeKB. The parameter value range is 0 - 2,147,483,647, the unit is KB, and the base is 1,024. The default value is 0.\n" }, "minFileSizeKb": { "type": "integer", "description": "Indicates the maximum value for the file size range. The value range is 0 - 2,147,483,647, in KB, using a base of 1,024. If this parameter is not specified, there is no upper limit for file size.\n" } }, "type": "object", "required": [ "compressionFormat", "compressionTarget", "compressionTypes", "maxFileSizeKb", "minFileSizeKb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCompressionCompressionRuleCondition:getDomainCompressionCompressionRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCompressionCompressionRuleConditionConditionRule:getDomainCompressionCompressionRuleConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCompressionCompressionRuleConditionConditionRule:getDomainCompressionCompressionRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainConditionalOrigin:getDomainConditionalOrigin": { "properties": { "originRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainConditionalOriginOriginRule:getDomainConditionalOriginOriginRule" }, "description": "Indicates a list of rules. Each rule in the list defines a filter and the action the content delivery network performs on requests that meet the filter criteria.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.\n" } }, "type": "object", "required": [ "originRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainConditionalOriginOriginRule:getDomainConditionalOriginOriginRule": { "properties": { "actions": { "$ref": "#/types/volcenginecc:cdn/getDomainConditionalOriginOriginRuleActions:getDomainConditionalOriginOriginRuleActions", "description": "Indicates the operation configuration for a rule in the list.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainConditionalOriginOriginRuleCondition:getDomainConditionalOriginOriginRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "required": [ "actions", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainConditionalOriginOriginRuleActions:getDomainConditionalOriginOriginRuleActions": { "properties": { "originLines": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainConditionalOriginOriginRuleActionsOriginLine:getDomainConditionalOriginOriginRuleActionsOriginLine" }, "description": "Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.\n" } }, "type": "object", "required": [ "originLines" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainConditionalOriginOriginRuleActionsOriginLine:getDomainConditionalOriginOriginRuleActionsOriginLine": { "properties": { "address": { "type": "string", "description": "Represents the address of an origin server. When InstanceType is ip, Address specifies an IPv4 or IPv6 address. When InstanceType is domain, Address specifies a domain name. The domain name cannot be a wildcard domain. If you specify OriginLines, Address is required.\n" }, "httpPort": { "type": "string", "description": "Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The valid range is 1–65535, with a default value of 80. If the origin server does not have this port open, you do not need to specify this parameter.\n" }, "httpsPort": { "type": "string", "description": "Specifies the port used by the content delivery network to access the origin server via HTTPS. The value range is 1–65535, and the default is 443. If the origin server does not open this port, you do not need to specify this parameter.\n" }, "instanceType": { "type": "string", "description": "Indicates the type of origin. The parameter has the following values: ip: indicates an IP address. domain: indicates a domain name. InstanceType is required if OriginLines is specified.\n" }, "originHost": { "type": "string", "description": "If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter takes precedence over the global OriginHost parameter. The value of this parameter cannot exceed 1,024 characters. The default value is the same as the global OriginHost.\n" } }, "type": "object", "required": [ "address", "httpPort", "httpsPort", "instanceType", "originHost" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainConditionalOriginOriginRuleCondition:getDomainConditionalOriginOriginRuleCondition": { "properties": { "conditionGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainConditionalOriginOriginRuleConditionConditionGroup:getDomainConditionalOriginOriginRuleConditionConditionGroup" }, "description": "ConditionGroups\n" }, "connective": { "type": "string", "description": "Specifies the relationship between these condition groups. This parameter has the following values: or: Indicates an 'or' relationship. In this case, if any condition group is met, the user request matches the rule. and: Indicates an 'and' relationship. In this case, all condition groups must be met for the user request to match the rule. The default value is or.\n" }, "isGroup": { "type": "boolean", "description": "Indicates whether each filter condition is a condition group. The value of this parameter is always true, meaning each filter condition is a condition group. Currently, each condition group can only contain one filter condition.\n" } }, "type": "object", "required": [ "conditionGroups", "connective", "isGroup" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainConditionalOriginOriginRuleConditionConditionGroup:getDomainConditionalOriginOriginRuleConditionConditionGroup": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainConditionalOriginOriginRuleConditionConditionGroupCondition:getDomainConditionalOriginOriginRuleConditionConditionGroupCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "required": [ "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainConditionalOriginOriginRuleConditionConditionGroupCondition:getDomainConditionalOriginOriginRuleConditionConditionGroupCondition": { "properties": { "object": { "type": "string", "description": "Indicates a filter type. This parameter has the following values: path: The full path in the request URL. directory: Any directory in the path. For example, if the path is /a/b/c/d/file, then /a/, /b/c/, and /d/ are directories. filetype: The extension at the end of the path. full*querystring: The query string in the request URL. client*ip: The client's IP address or the location associated with the IP address. If you specify Condition, Object is required.\n" }, "operator": { "type": "string", "description": "Specifies a comparison type. Different Objects correspond to different values. When Object is path, directory, or filetype, the parameter values are equal and not*equal. When Object is path, additional values are regex*match and regex*not*match. When Object is full*querystring, the values are regex*match and regex*not*match. When Object is client*ip, the values are equal, not*equal, belong, and not*belong. The comparison types are explained as follows: equal: If Object matches any filter value in Value, the request meets this filter condition. not*equal: If Object does not match any filter value in Value, the request meets this filter condition. regex*match: If any regular expression in Value matches any part of Object, the request meets this filter condition. regex*not*match: If none of the regular expressions in Value match any part of Object, the request meets this filter condition. belong: If the client IP address belongs to any country or region listed in Value, the request meets this filter condition. not*belong: If the client IP address does not belong to any country or region listed in Value, the request meets this filter condition. If you specify Condition, Operator is required.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Represents one or more filter values. Filter values are separated by semicolons (;). The input requirements for this parameter are as follows: When Object is path, directory, or filetype, the total length of all filter values must not exceed 1,024 characters and must not contain the following characters: consecutive slashes (//), spaces, dollar sign ($), question mark (?), or Delete (ASCII code 127). When Object is path, this parameter has the following additional requirements: each filter value must start with a slash (/) but must not end with a slash (/). You can use one or more asterisks (*) in the filter value, where each asterisk represents one or more characters. For example: /www/img/my*image.png. When Object is directory, this parameter has the following additional requirements: each filter value must start and end with a slash (/). For example: /www/img/. When Object is filetype, this parameter has the following additional requirements: each filter value does not need to start with a period (.). For example: png;txt. When Object is full*querystring, the input requirements for this parameter are as follows: the total length of all filter values must not exceed 256 characters. Filter values can include numbers, letters, percent sign (%), underscore (*), and hyphen (-). When Object is client*ip, if Operator is equal or not*equal, the input requirements for this parameter are as follows: the number of IP addresses must not exceed 5. IP addresses must be IPv4 addresses. If you specify Condition, Value is required.\n" } }, "type": "object", "required": [ "object", "operator", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCustomErrorPage:getDomainCustomErrorPage": { "properties": { "errorPageRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCustomErrorPageErrorPageRule:getDomainCustomErrorPageErrorPageRule" }, "description": "Indicates a set of configuration rules. You can add up to 50 rules.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.\n" } }, "type": "object", "required": [ "errorPageRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCustomErrorPageErrorPageRule:getDomainCustomErrorPageErrorPageRule": { "properties": { "errorPageAction": { "$ref": "#/types/volcenginecc:cdn/getDomainCustomErrorPageErrorPageRuleErrorPageAction:getDomainCustomErrorPageErrorPageRuleErrorPageAction", "description": "Indicates the relevant configuration for the rule.\n" } }, "type": "object", "required": [ "errorPageAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCustomErrorPageErrorPageRuleErrorPageAction:getDomainCustomErrorPageErrorPageRuleErrorPageAction": { "properties": { "action": { "type": "string", "description": "Indicates the actual operation. Currently, you can only set this parameter to redirect. This means the client request will be redirected.\n" }, "redirectCode": { "type": "string", "description": "Indicates the response status code for redirection. You can select an appropriate status code as needed. The available values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original request and will not be changed.\n" }, "redirectUrl": { "type": "string", "description": "Indicates the target address for redirection. The length must not exceed 1,024 characters. The address must include the protocol, domain name, and path, and comply with URL specifications.\n" }, "statusCode": { "type": "string", "description": "Indicates a status code, with a value range of 400–599. You can enter 4xx or 5xx. 4xx covers all status codes from 400 to 499. 5xx covers all status codes from 500 to 599.\n" } }, "type": "object", "required": [ "action", "redirectCode", "redirectUrl", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCustomizeAccessRule:getDomainCustomizeAccessRule": { "properties": { "customizeInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstance:getDomainCustomizeAccessRuleCustomizeInstance" }, "description": "Describes a rule list. Each rule in the list defines a Denylist or Allowlist configuration. The list can contain up to 10 rules.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.\n" } }, "type": "object", "required": [ "customizeInstances", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstance:getDomainCustomizeAccessRuleCustomizeInstance": { "properties": { "customizeRule": { "$ref": "#/types/volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule:getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule", "description": "Describes the configuration for a rule in the list.\n" } }, "type": "object", "required": [ "customizeRule" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule:getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule": { "properties": { "accessAction": { "$ref": "#/types/volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction:getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction", "description": "Indicates the configuration of the denylist or allowlist in this rule.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition:getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" } }, "type": "object", "required": [ "accessAction", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction:getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction": { "properties": { "allowEmpty": { "type": "boolean", "description": "Indicates whether the CDN accepts user requests where the RequestHeader value is empty. An empty header value refers to either of the following situations: The user request does not include RequestHeader. The user request includes RequestHeader, but the header value is empty (\"\").\n" }, "listRules": { "type": "array", "items": { "type": "string" }, "description": "Indicates a list of regular expressions used to match the value of the request header. The list can contain up to 20 regular expressions, and the total length of all expressions cannot exceed 1,024 characters. The relationship between the regular expressions is OR. That is, if the value of RequestHeader in a user request matches any regular expression, the rule applies to the request.\n" }, "requestHeader": { "type": "string", "description": "Indicates a specified request header. Header names are case-insensitive and must meet the following requirements: The name must not exceed 1,024 characters. The name cannot be Referer, User-Agent, or Origin. The name can contain letters, digits, underscores (_), and hyphens (-). The name cannot start with a digit.\n" }, "ruleType": { "type": "string", "description": "Indicates the type of list. This parameter has the following values: allow: defines an allowlist in this rule. If a user request does not match the allowlist, the CDN rejects the request and returns a 403 status code. deny: defines a denylist in this rule. If a user request matches the denylist, the CDN rejects the request and returns a 403 status code.\n" } }, "type": "object", "required": [ "allowEmpty", "listRules", "requestHeader", "ruleType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition:getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule:getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule:getDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainDomainLock:getDomainDomainLock": { "properties": { "remark": { "type": "string", "description": "Indicates the reason why the acceleration domain is locked. If Status is on, this parameter provides a description of the reason. If Status is off, this parameter is empty (\"\")\n" }, "status": { "type": "string", "description": "Indicates the lock status of the acceleration domain name. The parameter has the following values: on: the acceleration domain name is locked. off: the acceleration domain name is not locked.\n" } }, "type": "object", "required": [ "remark", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainDownloadSpeedLimit:getDomainDownloadSpeedLimit": { "properties": { "downloadSpeedLimitRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRule:getDomainDownloadSpeedLimitDownloadSpeedLimitRule" }, "description": "Indicates the rule for download rate limiting. This parameter is required when Switch is true.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.\n" } }, "type": "object", "required": [ "downloadSpeedLimitRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRule:getDomainDownloadSpeedLimitDownloadSpeedLimitRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition:getDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "downloadSpeedLimitAction": { "$ref": "#/types/volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction:getDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction", "description": "Indicates the rate limiting configuration.\n" } }, "type": "object", "required": [ "condition", "downloadSpeedLimitAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition:getDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule:getDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule:getDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction:getDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction": { "properties": { "speedLimitRate": { "type": "integer", "description": "Indicates the maximum download speed for a single request, measured in B/S. The parameter range is 1–1,073,741,824,000,000, using a base conversion of 1,024.\n" }, "speedLimitRateAfter": { "type": "integer", "description": "Represents a data volume. Download throttling is enabled for a request only when the amount of data downloaded in a single request reaches this value. Unit: Byte. The parameter range is 0–1,073,741,824,000,000, using a base of 1,024 for conversion.\n" }, "speedLimitTime": { "$ref": "#/types/volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime:getDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime", "description": "Indicates the date and time period when rate limiting occurs.\n" } }, "type": "object", "required": [ "speedLimitRate", "speedLimitRateAfter", "speedLimitTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime:getDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime": { "properties": { "beginTime": { "type": "string", "description": "Indicates the start time for rate limiting. The time format is mm:ss. If the DayWeek parameter value is unlimited, the default values for BeginTime and EndTime will be set to 00:00 and 23:59, respectively.\n" }, "dayWeek": { "type": "string", "description": "Specifies the date when rate limiting occurs. This parameter has the following values: monday, tuesday, wednesday, thursday, friday, saturday, sunday, unlimited. unlimited means every day. You can specify one or more values. Separate multiple values with a semicolon (;).\n" }, "endTime": { "type": "string", "description": "Indicates the end time for rate limiting. The time format is mm:ss. If the DayWeek parameter is set to unlimited, the default values for BeginTime and EndTime are 00:00 and 23:59, respectively.\n" } }, "type": "object", "required": [ "beginTime", "dayWeek", "endTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpForcedRedirect:getDomainHttpForcedRedirect": { "properties": { "enableForcedRedirect": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are: true: enables the feature. When enabled, the content delivery network redirects incoming HTTPS requests to HTTP requests. false: disables the feature. The content delivery network does not redirect HTTPS requests to HTTP requests. To enable this feature, your acceleration domain must have HTTPS enabled.\n" }, "statusCode": { "type": "string", "description": "Indicates the redirect status code returned by the content delivery network when it receives an HTTPS request. This parameter has the following values: 301: indicates the 301 response status code. 302: indicates the 302 response status code. The default value for this parameter is 301.\n" } }, "type": "object", "required": [ "enableForcedRedirect", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttps:getDomainHttps": { "properties": { "certCheck": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpsCertCheck:getDomainHttpsCertCheck", "description": "Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.\n" }, "certInfo": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpsCertInfo:getDomainHttpsCertInfo", "description": "Indicates the single certificate to be associated with the acceleration domain name.\n" }, "certInfoLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpsCertInfoList:getDomainHttpsCertInfoList" }, "description": "Indicates the dual certificate to be associated with the acceleration domain name.\n" }, "disableHttp": { "type": "boolean", "description": "Indicates whether to allow requests where the URL scheme is HTTP. The parameter values are: true: allows requests with HTTP scheme. false: does not allow requests with HTTP scheme. The default value is false.\n" }, "forcedRedirect": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpsForcedRedirect:getDomainHttpsForcedRedirect", "description": "Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.\n" }, "hsts": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpsHsts:getDomainHttpsHsts", "description": "Indicates the configuration module for the HSTS feature. This feature is disabled by default.\n" }, "http2": { "type": "boolean", "description": "HTTP/2 configuration switch. This parameter has the following values: true: enables HTTP/2. false: disables HTTP/2. To enable HTTP/2, you must first enable HTTPS. This feature is disabled by default. However, HTTP/2 is enabled by default in the following scenarios: The business type of the accelerated domain is web (ServiceType is web). The accelerated domain has already enabled HTTPS.\n" }, "ocsp": { "type": "boolean", "description": "Specify whether to enable OCSP stapling. This parameter has the following values: true: enables OCSP stapling. false: disables OCSP stapling. To enable OCSP stapling, you must first enable HTTPS. The default value is false.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable the HTTPS feature. This parameter has the following values: true: enables the feature; false: disables the feature. If Switch is true, you must specify a certificate. If you specify a single certificate, you need to provide CertInfo. If you specify dual certificates, you need to provide CertInfoList. The certificate you specify can be hosted in the certificate center or on the content delivery network.\n" }, "tlsVersions": { "type": "array", "items": { "type": "string" }, "description": "Indicates the configuration module for the \"TLS Version\" feature. This parameter specifies the TLS versions that user requests can use, with the following options: tlsv1.0: TLS 1.0 tlsv1.1: TLS 1.1 tlsv1.2: TLS 1.2 tlsv1.3: TLS 1.3 The default value for this parameter is [\"tlsv1.1\", \"tlsv1.2\", \"tlsv1.3\"]\n" } }, "type": "object", "required": [ "certCheck", "certInfo", "certInfoLists", "disableHttp", "forcedRedirect", "hsts", "http2", "ocsp", "switch", "tlsVersions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpsCertCheck:getDomainHttpsCertCheck": { "properties": { "certInfoLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpsCertCheckCertInfoList:getDomainHttpsCertCheckCertInfoList" }, "description": "Specifies a list of CA certificates to associate with the accelerated domain name. The list can contain up to two CA certificates. These CA certificates can be already hosted on the content delivery network or pending upload. The encryption algorithm for CA certificates can be RSA, ECC, or SM2. If a CA certificate is hosted on the content delivery network, you need to specify its ID in CertId. If the certificate is pending upload, you need to specify the Certificate structure and define the certificate within it. After you upload the certificate, it will be hosted on the content delivery network.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.\n" } }, "type": "object", "required": [ "certInfoLists", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpsCertCheckCertInfoList:getDomainHttpsCertCheckCertInfoList": { "properties": { "certId": { "type": "string", "description": "Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.\n" }, "certName": { "type": "string", "description": "Represents the content of the Common Name (CN) field in the CA certificate.\n" }, "certificate": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpsCertCheckCertInfoListCertificate:getDomainHttpsCertCheckCertInfoListCertificate", "description": "Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.\n" }, "effectiveTime": { "type": "integer", "description": "Indicates the issuance time of the certificate, in Unix timestamp.\n" }, "encryType": { "type": "string", "description": "Indicates the encryption algorithm used by the certificate. The parameter has the following values: inter*cert: RSA or ECC encryption algorithm. sm*cert: SM2 encryption algorithm.\n" }, "expireTime": { "type": "integer", "description": "Indicates the expiration time of the certificate, as a Unix timestamp.\n" }, "source": { "type": "string", "description": "Specifies the certificate hosting location. The parameter values are: volc*cert*center: certificate center; cdn*cert*hosting: content delivery network.\n" } }, "type": "object", "required": [ "certId", "certName", "certificate", "effectiveTime", "encryType", "expireTime", "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpsCertCheckCertInfoListCertificate:getDomainHttpsCertCheckCertInfoListCertificate": { "properties": { "certificate": { "type": "string", "description": "Indicates the content of the certificate file. Line breaks in the content must be replaced with \\r\\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.\n" }, "encryptionCert": { "type": "string", "description": "Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \\r\\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid\n" }, "encryptionKey": { "type": "string", "description": "Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \\r\\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to \u003cdomain\u003e_encrypt.key.\n" }, "privateKey": { "type": "string", "description": "Indicates the content of the private key file. Line breaks in the content must be replaced with \\r\\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to \u003cdomain\u003e.key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to \u003cdomain\u003e_sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.\n" } }, "type": "object", "required": [ "certificate", "encryptionCert", "encryptionKey", "privateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpsCertInfo:getDomainHttpsCertInfo": { "properties": { "certId": { "type": "string", "description": "Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.\n" }, "certName": { "type": "string", "description": "Indicates the content of the Common Name (CN) field in the CA certificate.\n" }, "certificate": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpsCertInfoCertificate:getDomainHttpsCertInfoCertificate", "description": "Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.\n" }, "effectiveTime": { "type": "integer", "description": "Indicates the issuance time of the certificate, in Unix timestamp.\n" }, "encryType": { "type": "string", "description": "Indicates the encryption algorithm used by the certificate. The parameter has the following values: inter*cert: RSA or ECC encryption algorithm. sm*cert: SM2 encryption algorithm.\n" }, "expireTime": { "type": "integer", "description": "Indicates the expiration time of the certificate, in Unix timestamp.\n" }, "source": { "type": "string", "description": "Indicates the location where the certificate is hosted. This parameter has the following values: volc*cert*center: Certificate Center. cdn*cert*hosting: Content Delivery Network.\n" } }, "type": "object", "required": [ "certId", "certName", "certificate", "effectiveTime", "encryType", "expireTime", "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpsCertInfoCertificate:getDomainHttpsCertInfoCertificate": { "properties": { "certificate": { "type": "string", "description": "Indicates the content of the certificate file. Line breaks in the content must be replaced with \\r\\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.\n" }, "encryptionCert": { "type": "string", "description": "Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \\r\\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid\n" }, "encryptionKey": { "type": "string", "description": "Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \\r\\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to \u003cdomain\u003e_encrypt.key.\n" }, "privateKey": { "type": "string", "description": "Indicates the content of the private key file. Line breaks in the content must be replaced with \\r\\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to \u003cdomain\u003e.key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to \u003cdomain\u003e_sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.\n" } }, "type": "object", "required": [ "certificate", "encryptionCert", "encryptionKey", "privateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpsCertInfoList:getDomainHttpsCertInfoList": { "properties": { "certId": { "type": "string", "description": "Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.\n" }, "certName": { "type": "string", "description": "Represents the content of the Common Name (CN) field in the CA certificate.\n" }, "certificate": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpsCertInfoListCertificate:getDomainHttpsCertInfoListCertificate", "description": "Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.\n" }, "effectiveTime": { "type": "integer", "description": "Indicates the issuance time of the certificate, in Unix timestamp.\n" }, "encryType": { "type": "string", "description": "Indicates the encryption algorithm used by the certificate. The parameter has the following values: inter*cert: RSA or ECC encryption algorithm. sm*cert: SM2 encryption algorithm.\n" }, "expireTime": { "type": "integer", "description": "Indicates the expiration time of the certificate, as a Unix timestamp.\n" }, "source": { "type": "string", "description": "Specifies the certificate hosting location. The parameter values are: volc*cert*center: certificate center; cdn*cert*hosting: content delivery network.\n" } }, "type": "object", "required": [ "certId", "certName", "certificate", "effectiveTime", "encryType", "expireTime", "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpsCertInfoListCertificate:getDomainHttpsCertInfoListCertificate": { "properties": { "certificate": { "type": "string", "description": "Indicates the content of the certificate file. Line breaks in the content must be replaced with \\r\\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.\n" }, "encryptionCert": { "type": "string", "description": "Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \\r\\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid\n" }, "encryptionKey": { "type": "string", "description": "Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \\r\\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to \u003cdomain\u003e_encrypt.key.\n" }, "privateKey": { "type": "string", "description": "Indicates the content of the private key file. Line breaks in the content must be replaced with \\r\\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to \u003cdomain\u003e.key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to \u003cdomain\u003e_sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.\n" } }, "type": "object", "required": [ "certificate", "encryptionCert", "encryptionKey", "privateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpsForcedRedirect:getDomainHttpsForcedRedirect": { "properties": { "enableForcedRedirect": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: enables the feature. When enabled, the content delivery network redirects HTTP requests to HTTPS requests. false: disables the feature. When disabled, the content delivery network does not redirect HTTP requests to HTTPS requests. To enable this feature, your acceleration domain must have HTTPS enabled.\n" }, "statusCode": { "type": "string", "description": "Indicates the redirect response status code for the CDN when receiving HTTPS requests. The parameter values are: 301: returns status code 301. 302: returns status code 302. The default value is 301.\n" } }, "type": "object", "required": [ "enableForcedRedirect", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainHttpsHsts:getDomainHttpsHsts": { "properties": { "subdomain": { "type": "string", "description": "Indicates whether the HSTS configuration also applies to subdomains of the accelerated domain. The parameter has the following values: include: applies HSTS configuration to subdomain sites. exclude: does not apply HSTS configuration to subdomain sites. The default value is exclude.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache expiration time for the Strict-Transport-Security response header in the browser, in seconds. If Switch is true, this parameter is required. The value range is 0–31,536,000. 31,536,000 seconds equals 365 days. If the value is 0, it is equivalent to disabling the HSTS setting.\n" } }, "type": "object", "required": [ "subdomain", "switch", "ttl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainIPv6:getDomainIPv6": { "properties": { "switch": { "type": "boolean", "description": "Specifies whether to enable IPv6 configuration. This parameter has the following values: true: Enables IPv6. false: Disables IPv6.\n" } }, "type": "object", "required": [ "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainIpAccessRule:getDomainIpAccessRule": { "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "Specifies IP addresses in the denylist or allowlist. This parameter is required when Switch is true. You can specify one or more IP addresses and IP address ranges. IP addresses and ranges can be in IPv4 or IPv6 format. You can enter up to 1,000 addresses. If you specify SharedConfig, you cannot specify this parameter.\n" }, "ruleType": { "type": "string", "description": "Indicates the type of IP list. This parameter is required when Switch is true. Valid values are: allow: indicates Allowlist. deny: indicates Denylist. If you specify SharedConfig, you cannot specify this parameter.\n" }, "sharedConfig": { "$ref": "#/types/volcenginecc:cdn/getDomainIpAccessRuleSharedConfig:getDomainIpAccessRuleSharedConfig", "description": "Represents a global configuration. If you specify this parameter, you cannot specify RuleType and Ip.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "required": [ "ips", "ruleType", "sharedConfig", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainIpAccessRuleSharedConfig:getDomainIpAccessRuleSharedConfig": { "properties": { "configName": { "type": "string", "description": "Indicates the name of a global configuration.\n" } }, "type": "object", "required": [ "configName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainMethodDeniedRule:getDomainMethodDeniedRule": { "properties": { "methods": { "type": "string", "description": "Indicates one or more HTTP request methods that are disabled. When Switch is true, this parameter is required. Use commas (,) to separate multiple methods. The parameter values are: get: disables the GET request method. post: disables the POST request method. delete: disables the DELETE request method. put: disables the PUT request method. head: disables the HEAD request method. patch: disables the PATCH request method. connect: disables the CONNECT request method. options: disables the OPTIONS request method.\n" }, "switch": { "type": "boolean", "description": "Configuration switch for disabling methods. Use commas to separate multiple methods. Required when enabled. choices: [get, post, head, delete, put]\n" } }, "type": "object", "required": [ "methods", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainMultiRange:getDomainMultiRange": { "properties": { "switch": { "type": "boolean", "description": "Indicates whether the feature is enabled. This parameter has the following values: true: enables the feature. When enabled, CDN allows Range requests with multiple ranges. false: disables the feature. If a Range request with multiple ranges is received, CDN rejects the request and returns a 416 response status code. The default value is false.\n" } }, "type": "object", "required": [ "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainNegativeCach:getDomainNegativeCach": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainNegativeCachCondition:getDomainNegativeCachCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "negativeCacheRule": { "$ref": "#/types/volcenginecc:cdn/getDomainNegativeCachNegativeCacheRule:getDomainNegativeCachNegativeCacheRule", "description": "Represents a list. Each element in the list is a status code cache rule.\n" } }, "type": "object", "required": [ "condition", "negativeCacheRule" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainNegativeCachCondition:getDomainNegativeCachCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainNegativeCachConditionConditionRule:getDomainNegativeCachConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainNegativeCachConditionConditionRule:getDomainNegativeCachConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainNegativeCachNegativeCacheRule:getDomainNegativeCachNegativeCacheRule": { "properties": { "action": { "type": "string", "description": "Represents the cache behavior. Currently, you can only specify cache. cache means the behavior is caching.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether the CDN ignores case when matching files in a request with ConditionRule. The parameter has the following options: true: ignore case. false: do not ignore case. The default value is false.\n" }, "statusCode": { "type": "string", "description": "Specify a status code to cache. The status code range is 400–599. You can also specify 4xx or 5xx. 4xx refers to all status codes from 400 to 499. 5xx refers to all status codes from 500 to 599.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache duration for status codes, in seconds. The range is 1–315,360,000. 315,360,000 means 10 years.\n" } }, "type": "object", "required": [ "action", "ignoreCase", "statusCode", "ttl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOfflineCache:getDomainOfflineCache": { "properties": { "object": { "type": "string", "description": "Indicates the trigger conditions for this feature. The parameter has the following values: request*error: indicates an origin request exception. When an origin request exception occurs, the CDN cannot retrieve files from the origin and does not receive any response status code from the origin. error*code: indicates the CDN cannot retrieve files from the origin, and the origin's response status code is 5xx. request*error,error*code: indicates both conditions are included.\n" }, "statusCode": { "type": "string", "description": "Specifies the specific 5xx response status codes, ranging from 500 to 599. Separate multiple status codes with a semicolon (;). You can also enter 5xx to indicate any status code starting with the digit 5. This parameter is valid only when Object is error*code or request*error,error_code.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "required": [ "object", "statusCode", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOrigin:getDomainOrigin": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginCondition:getDomainOriginCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "originAction": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginOriginAction:getDomainOriginOriginAction", "description": "Indicates origin configuration.\n" } }, "type": "object", "required": [ "condition", "originAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginAccessRule:getDomainOriginAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Specifies whether requests are allowed when the Origin header in the user request is empty (\"\"). The parameter values are: true: allow; false: do not allow. The default value is false.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether Origin is case sensitive. This parameter has the following values: true: Origin is case insensitive; false: Origin is case sensitive. The default value is true.\n" }, "origins": { "type": "array", "items": { "type": "string" }, "description": "The address list corresponding to RuleType. When Switch is true, this parameter is required. You can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domain names. Domain names can be second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 100 addresses. When entering domain names, you do not need to include http:// or https://. The value length cannot exceed 3,000 characters.\n" }, "ruleType": { "type": "string", "description": "Origin list configuration type. When Switch is true, this parameter is required. The parameter has the following values: allow: indicates allowlist. deny: indicates denylist.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "required": [ "allowEmpty", "ignoreCase", "origins", "ruleType", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginArg:getDomainOriginArg": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginArgCondition:getDomainOriginArgCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "originArgAction": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginArgOriginArgAction:getDomainOriginArgOriginArgAction", "description": "Represents the action performed when the Condition is met.\n" } }, "type": "object", "required": [ "condition", "originArgAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginArgCondition:getDomainOriginArgCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginArgConditionConditionRule:getDomainOriginArgConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginArgConditionConditionRule:getDomainOriginArgConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginArgOriginArgAction:getDomainOriginArgOriginArgAction": { "properties": { "originArgComponents": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginArgOriginArgActionOriginArgComponent:getDomainOriginArgOriginArgActionOriginArgComponent" }, "description": "Indicates a list of operations. These operations define how the CDN sets query parameters in origin requests. Currently, only one operation can be included in the list.\n" } }, "type": "object", "required": [ "originArgComponents" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginArgOriginArgActionOriginArgComponent:getDomainOriginArgOriginArgActionOriginArgComponent": { "properties": { "action": { "type": "string", "description": "include: Indicates that the origin request URL includes all query parameters from the user request URL. exclude: Indicates that the origin request URL does not include any query parameters from the user request URL. addPart: Indicates that the origin request URL includes all query parameters from the user request URL, plus the query parameters specified in the Subobject. includePart: Indicates that if the user request URL contains the query parameters specified in the Subobject, the origin request URL will include these specified query parameters. excludePart: Indicates that the origin request URL includes all query parameters from the user request URL except those specified in the Subobject. set: Indicates that the origin request URL includes all query parameters from the user request URL. For the query parameters and values you specify in the Subobject, CDN will perform the following actions: If these query parameters exist in the user request URL, CDN will set their values in the origin request URL to the values you specify. If the user request URL does not contain these query parameters, CDN will add them to the origin request URL.\n" }, "object": { "type": "string", "description": "Indicates which object the CDN performs the Action on. Currently, this parameter can only be set to queryString, which refers to the query string in the request URL.\n" }, "subobject": { "type": "string", "description": "Represents one or more query parameters. Use semicolons (;) to separate multiple query parameters. The total length must not exceed 1,024 characters. Subobject can only contain letters, numbers, underscores (_), commas (,), hyphens (-), periods (.), and exclamation marks (!). When matching query parameters in the request URL, parameters in Subobject are case-sensitive. Additional notes for Subobject: When Action is include or exclude, Subobject must be *, which represents all query parameters in the request URL. When Action is includePart or excludePart, Subobject represents one or more query parameters, for example, param1;param2. When Action is addPart or set, Subobject represents one or more query parameters and their values in the format key=value, for example, param1=val1;param2=val2;param3=val3.\n" } }, "type": "object", "required": [ "action", "object", "subobject" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginCertCheck:getDomainOriginCertCheck": { "properties": { "switch": { "type": "boolean", "description": "Switch\n" } }, "type": "object", "required": [ "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginCondition:getDomainOriginCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginConditionConditionRule:getDomainOriginConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginConditionConditionRule:getDomainOriginConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginOriginAction:getDomainOriginOriginAction": { "properties": { "originLines": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginOriginActionOriginLine:getDomainOriginOriginActionOriginLine" }, "description": "Indicates a list of origin configurations. Each configuration can include one or more origins.\n" } }, "type": "object", "required": [ "originLines" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginOriginActionOriginLine:getDomainOriginOriginActionOriginLine": { "properties": { "address": { "type": "string", "description": "Indicates the origin address. The parameter has the following instructions: If InstanceType is ip, you can set an IP address. The IP address can be either IPv4 or IPv6. If InstanceType is domain, you can set a domain name. The domain name cannot be a wildcard domain. If InstanceType is tos, you can set the domain name of an object storage bucket. The bucket can be from Alibaba Cloud, Tencent Cloud, or AWS. If you specify multiple origin configurations in this API request: All primary origin configurations must have the same InstanceType. All backup origin configurations must also have the same InstanceType. If the InstanceType in the primary origin configuration is ip or domain, the InstanceType in the backup origin configuration must also be ip or domain. The total number of primary and backup origin addresses cannot exceed 50.\n" }, "httpPort": { "type": "string", "description": "Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The value range is 1–65535, and the default value is 80. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.\n" }, "httpsPort": { "type": "string", "description": "Indicates the port used by the content delivery network to access the origin server via HTTPS. The value range is 1-65535, and the default value is 443. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.\n" }, "instanceType": { "type": "string", "description": "Indicates the type of origin server. This parameter has the following values: ip: The origin server is accessed via IP address. domain: The origin server is accessed via domain name. tos: The origin server is an object storage bucket.\n" }, "originHost": { "type": "string", "description": "If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.\n" }, "originType": { "type": "string", "description": "Indicates the type of origin server. This parameter has the following values: - primary: Primary origin server. - backup: Backup origin server. At least one primary origin server configuration must be included in this API request. Backup origin server configuration is optional.\n" }, "privateBucketAccess": { "type": "boolean", "description": "Indicates whether private read permissions are enabled for the object storage bucket. This parameter is only valid when InstanceType is tos. The parameter values are: true: Enabled. false: Not enabled. The default value is false.\n" }, "privateBucketAuth": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginOriginActionOriginLinePrivateBucketAuth:getDomainOriginOriginActionOriginLinePrivateBucketAuth", "description": "Represents the authentication information for the object storage bucket of a third-party cloud provider.\n" }, "region": { "type": "string", "description": "This parameter is not currently available externally. Do not use this parameter.\n" }, "weight": { "type": "string", "description": "Specifies the weight of the origin. Value range is 1–100, default is 1. The higher the weight, the more likely this origin is selected when the content delivery network sends a request to the origin. This parameter is only valid when InstanceType is ip or domain.\n" } }, "type": "object", "required": [ "address", "httpPort", "httpsPort", "instanceType", "originHost", "originType", "privateBucketAccess", "privateBucketAuth", "region", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginOriginActionOriginLinePrivateBucketAuth:getDomainOriginOriginActionOriginLinePrivateBucketAuth": { "properties": { "authType": { "type": "string", "description": "Indicates the third-party cloud provider where the object storage bucket is located. The parameter values are: cos: Tencent Cloud. oss: Alibaba Cloud. aws: Amazon AWS.\n" }, "switch": { "type": "boolean", "description": "Indicates whether the object storage bucket is from a third-party cloud provider. This parameter has the following values: true: the object storage bucket is from a third-party cloud provider. The default value is false\n" }, "tosAuthInformation": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation:getDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation", "description": "Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.\n" } }, "type": "object", "required": [ "authType", "switch", "tosAuthInformation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation:getDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation": { "properties": { "accessKeyId": { "type": "string", "description": "Specifies the AccessKey ID for your Alibaba Cloud account, SecretId for your Tencent Cloud account, or access key ID for your AWS account.\n" }, "accessKeySecret": { "type": "string", "description": "Indicates the AccessKey Secret for your Alibaba Cloud account, the SecretKey for your Tencent Cloud account, or the secret access key for your AWS account.\n" } }, "type": "object", "required": [ "accessKeyId", "accessKeySecret" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginRetry:getDomainOriginRetry": { "properties": { "statusCode": { "type": "string", "description": "Indicates one or more status codes in the range 400–599. Separate multiple status codes with a semicolon (;). You can enter 4xx or 5xx to represent all status codes starting with the digit 4 or 5.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.\n" } }, "type": "object", "required": [ "statusCode", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginRewrite:getDomainOriginRewrite": { "properties": { "originRewriteRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginRewriteOriginRewriteRule:getDomainOriginRewriteOriginRewriteRule" }, "description": "Represents a list of rules. This parameter is required when Switch is true. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The SourcePath in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable this module. The parameter has the following values: true: enables the module. false: disables the module. The default value is false.\n" } }, "type": "object", "required": [ "originRewriteRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginRewriteOriginRewriteRule:getDomainOriginRewriteOriginRewriteRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginRewriteOriginRewriteRuleCondition:getDomainOriginRewriteOriginRewriteRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "originRewriteAction": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginRewriteOriginRewriteRuleOriginRewriteAction:getDomainOriginRewriteOriginRewriteRuleOriginRewriteAction", "description": "Indicates a rule configuration for origin path rewrite.\n" } }, "type": "object", "required": [ "condition", "originRewriteAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginRewriteOriginRewriteRuleCondition:getDomainOriginRewriteOriginRewriteRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginRewriteOriginRewriteRuleConditionConditionRule:getDomainOriginRewriteOriginRewriteRuleConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginRewriteOriginRewriteRuleConditionConditionRule:getDomainOriginRewriteOriginRewriteRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginRewriteOriginRewriteRuleOriginRewriteAction:getDomainOriginRewriteOriginRewriteRuleOriginRewriteAction": { "properties": { "rewriteType": { "type": "string", "description": "Indicates the rewrite type. This parameter supports the following values: rewrite*path: rewrites the path in the request URL. rewrite*url: rewrites both the path and query string in the request URL. The default value is rewrite_path.\n" }, "sourcePath": { "type": "string", "description": "Indicates a regular expression, with a maximum length of 1,024 characters, used to match objects in the user's request URL. For a user request, if the regular expression matches any part of the object, this rule applies to the request. When RewriteType is rewrite*path, the object refers to the path in the request URL. When RewriteType is rewrite*url, the object refers to both the path and query string in the request URL.\n" }, "targetPath": { "type": "string", "description": "Indicates the object in the origin request URL after rewriting. When RewriteType is rewrite*path, this object is the path in the origin request URL. When RewriteType is rewrite*url, this object is the path and query string in the origin request URL. You can use $1, $2, $3, etc. in TargetPath to represent groups defined in the regular expression of SourcePath.\n" } }, "type": "object", "required": [ "rewriteType", "sourcePath", "targetPath" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainOriginSni:getDomainOriginSni": { "properties": { "sniDomain": { "type": "string", "description": "Specifies the domain name for origin SNI. When Switch is true, this parameter is required. The value cannot exceed 1,024 characters.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.\n" } }, "type": "object", "required": [ "sniDomain", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainPageOptimization:getDomainPageOptimization": { "properties": { "optimizationTypes": { "type": "array", "items": { "type": "string" }, "description": "Specifies the optimization target. This parameter has the following values: html: HTML page. js: JavaScript code. css: CSS code. The default value is html. If you specify js or css, html must also be specified.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are: true: The feature is enabled. false: The feature is disabled.\n" } }, "type": "object", "required": [ "optimizationTypes", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainQuic:getDomainQuic": { "properties": { "switch": { "type": "boolean", "description": "QUIC configuration switch. The parameter values are as follows: true: enables QUIC. false: disables QUIC. To enable QUIC, you must first enable HTTPS.\n" } }, "type": "object", "required": [ "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRedirectionRewrite:getDomainRedirectionRewrite": { "properties": { "redirectionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRedirectionRewriteRedirectionRule:getDomainRedirectionRewriteRedirectionRule" }, "description": "Indicates a list of URL redirect rewrite rules. When Switch is true, this parameter is required. The list can contain up to 50 rules.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this configuration is enabled. This parameter has the following values: true: enables URL redirect rewrite. false: disables URL redirect rewrite.\n" } }, "type": "object", "required": [ "redirectionRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRedirectionRewriteRedirectionRule:getDomainRedirectionRewriteRedirectionRule": { "properties": { "redirectionAction": { "$ref": "#/types/volcenginecc:cdn/getDomainRedirectionRewriteRedirectionRuleRedirectionAction:getDomainRedirectionRewriteRedirectionRuleRedirectionAction", "description": "Indicates a URL redirect rewrite rule\n" } }, "type": "object", "required": [ "redirectionAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRedirectionRewriteRedirectionRuleRedirectionAction:getDomainRedirectionRewriteRedirectionRuleRedirectionAction": { "properties": { "redirectCode": { "type": "string", "description": "Indicates the response status code for URL redirection. Valid values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original and is not changed.\n" }, "sourcePath": { "type": "string", "description": "Specifies the original file path, which is the path included in the request. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value of this parameter cannot exceed 1,024 characters.\n" }, "targetHost": { "type": "string", "description": "Indicates the domain name or IP address of the site to which the target path belongs. The IP address must be IPv4. The parameter value cannot exceed 1,024 characters. The default value is your acceleration domain name.\n" }, "targetPath": { "type": "string", "description": "Indicates the target path after redirection. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value cannot exceed 1,024 characters.\n" }, "targetProtocol": { "type": "string", "description": "Specifies the protocol used for the new request after URL redirection. The parameter values are: followclient: use the protocol of the original request; http: force the new request to use HTTP; https: force the new request to use HTTPS.\n" }, "targetQueryComponents": { "$ref": "#/types/volcenginecc:cdn/getDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents:getDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents", "description": "Indicates how the query parameters in the original request URL are handled.\n" } }, "type": "object", "required": [ "redirectCode", "sourcePath", "targetHost", "targetPath", "targetProtocol", "targetQueryComponents" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents:getDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents": { "properties": { "action": { "type": "string", "description": "Indicates how to handle query parameters in the original request URL. This parameter has the following values: include: includes all query parameters from the original request URL in the redirected URL. exclude: excludes all query parameters from the original request URL in the redirected URL. includePart: includes specific query parameters from the original request URL in the redirected URL. excludePart: excludes specific query parameters from the original request URL in the redirected URL.\n" }, "value": { "type": "string", "description": "Indicates the query parameters to retain or remove. Multiple query parameters are separated by a semicolon (;). The specified query parameters cannot contain consecutive slashes (//), percent signs (\"), or spaces. The default value of Value is *, which means all query parameters. If Action is include or exclude, Value must be *. If Action is includePart or excludePart, you can specify one or more query parameters. In this case, the specified query parameters cannot be *.\n" } }, "type": "object", "required": [ "action", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRefererAccessRule:getDomainRefererAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Specifies whether the content delivery network accepts a request when the Referer header in the user's request is empty (\"\"). This parameter has the following values: true: accepts the request; false: rejects the request. The default value is false.\n" }, "referers": { "type": "array", "items": { "type": "string" }, "description": "Indicates a list of Referers. The input requirements for this parameter are consistent with those for Referers under the CommonType of ReferersType. We recommend using ReferersType to specify the Referer list. If you specify SharedConfig, you cannot specify this parameter.\n" }, "referersType": { "$ref": "#/types/volcenginecc:cdn/getDomainRefererAccessRuleReferersType:getDomainRefererAccessRuleReferersType", "description": "Indicates a ReferersType object. It contains a CommonType object and a RegularType object, representing a standard Referer list and a Referer regular expression list, respectively. If you specify SharedConfig, you cannot specify this parameter.\n" }, "ruleType": { "type": "string", "description": "Indicates the type of Referer list. This parameter is required when Switch is true. This parameter has the following values: allow: indicates Allowlist. deny: indicates Denylist.\n" }, "sharedConfig": { "$ref": "#/types/volcenginecc:cdn/getDomainRefererAccessRuleSharedConfig:getDomainRefererAccessRuleSharedConfig", "description": "Represents a global configuration. If you specify this parameter, you cannot specify Referers or ReferersType.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "required": [ "allowEmpty", "referers", "referersType", "ruleType", "sharedConfig", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRefererAccessRuleReferersType:getDomainRefererAccessRuleReferersType": { "properties": { "commonType": { "$ref": "#/types/volcenginecc:cdn/getDomainRefererAccessRuleReferersTypeCommonType:getDomainRefererAccessRuleReferersTypeCommonType", "description": "Indicates a CommonType object that contains a list of standard Referers.\n" }, "regularType": { "$ref": "#/types/volcenginecc:cdn/getDomainRefererAccessRuleReferersTypeRegularType:getDomainRefererAccessRuleReferersTypeRegularType", "description": "Specifies a RegularType object, which contains a list of regular expressions used to match the Referer header value in requests This parameter provides the allowlist feature To use this parameter, submit a ticket Note that if the Referer header value in a request matches the Referers list under CommonType or the Referers list under RegularType, the content delivery network considers it a match\n" } }, "type": "object", "required": [ "commonType", "regularType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRefererAccessRuleReferersTypeCommonType:getDomainRefererAccessRuleReferersTypeCommonType": { "properties": { "ignoreCase": { "type": "boolean", "description": "Specifies whether the Referers list under CommonType is case sensitive during matching. The parameter supports the following values: true: not case sensitive. false: case sensitive. The default value is true.\n" }, "ignoreScheme": { "type": "boolean", "description": "Indicates whether the Referer header value in this Referers list under CommonType must start with HTTP or HTTPS. This parameter has the following values: true: Referer header values that do not start with HTTP or HTTPS are valid. In this case, the content delivery network will attempt to match them with the Referers list. false: Referer header values that do not start with HTTP or HTTPS are invalid. In this case, the content delivery network determines that they do not match the Referers list under CommonType. The default value is false.\n" }, "referers": { "type": "array", "items": { "type": "string" }, "description": "Represents a standard Referer list. In this list, you can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domains. Domain names can include second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 1,000 IP addresses. The domain names entered must not include http:// or https://. During matching, the content delivery network compares the domain name in the Referer header of the request with the Referer list. The value of this parameter must not exceed 30,000 characters.\n" } }, "type": "object", "required": [ "ignoreCase", "ignoreScheme", "referers" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRefererAccessRuleReferersTypeRegularType:getDomainRefererAccessRuleReferersTypeRegularType": { "properties": { "referers": { "type": "array", "items": { "type": "string" }, "description": "Indicates a list of Referer regular expressions. The value of this parameter cannot exceed 30,000 characters.\n" } }, "type": "object", "required": [ "referers" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRefererAccessRuleSharedConfig:getDomainRefererAccessRuleSharedConfig": { "properties": { "configName": { "type": "string", "description": "Indicates the name of a global configuration.\n" } }, "type": "object", "required": [ "configName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuth:getDomainRemoteAuth": { "properties": { "remoteAuthRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRule:getDomainRemoteAuthRemoteAuthRule" }, "description": "Specifies the list of remote authentication configuration rules. When Switch is true, this parameter is required. You can add only one configuration rule.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. The parameter values are as follows: true: enables the feature. false: disables the feature.\n" } }, "type": "object", "required": [ "remoteAuthRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRule:getDomainRemoteAuthRemoteAuthRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleCondition:getDomainRemoteAuthRemoteAuthRuleCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "remoteAuthRuleAction": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction", "description": "Indicates the specific authentication configuration.\n" } }, "type": "object", "required": [ "condition", "remoteAuthRuleAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleCondition:getDomainRemoteAuthRemoteAuthRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleConditionConditionRule:getDomainRemoteAuthRemoteAuthRuleConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleConditionConditionRule:getDomainRemoteAuthRemoteAuthRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction": { "properties": { "authModeConfig": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig", "description": "Indicates the configuration of the authentication server.\n" }, "authResponseConfig": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig", "description": "The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.\n" }, "queryStringRules": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules", "description": "Represents the parameter settings for authentication requests.\n" }, "requestBodyRules": { "type": "string", "description": "Indicates the rule for the authentication request body. You can leave this parameter unspecified or set its value to default. default means the request body is empty (\"\").\n" }, "requestHeaderRules": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules", "description": "Indicates the settings for authentication request headers. You can set up to 50 request headers.\n" } }, "type": "object", "required": [ "authModeConfig", "authResponseConfig", "queryStringRules", "requestBodyRules", "requestHeaderRules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig": { "properties": { "backupRemoteAddr": { "type": "string", "description": "Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.\n" }, "masterRemoteAddr": { "type": "string", "description": "Indicates the primary address of the authentication server. The length must not exceed 100 characters. The primary address format is \\n\\n://\\n\\n:\\n\\n or \\n\\n://\\n\\n:\\n\\n, where: \\n\\n is http or https. \\n\\n cannot be localhost. \\n\\n cannot be 127.0.0.1. \\n\\n is optional.\n" }, "pathType": { "type": "string", "description": "Indicates the path for the authentication request. The authentication address and request path together form the complete authentication URL. The content delivery network forwards the user's request to this authentication URL. The parameter accepts the following values: constant: The path in the authentication request is the same as the path in the user's request. variable: You need to specify a path for the authentication request in the pathValue parameter.\n" }, "pathValue": { "type": "string", "description": "Represents the path for an authentication request. The path cannot exceed 100 characters. It must start with a slash (/), and can include any printable ASCII characters except the following: consecutive slashes (//), percent sign (%), dollar sign ($), space, question mark (?), and Delete (ASCII code 127).\n" }, "requestMethod": { "type": "string", "description": "Indicates the request method used by the content delivery network when sending authentication requests. The parameter has the following values: default: uses the same method as the user's request. get: uses the GET method. post: uses the POST method. head: uses the HEAD method.\n" } }, "type": "object", "required": [ "backupRemoteAddr", "masterRemoteAddr", "pathType", "pathValue", "requestMethod" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig": { "properties": { "cacheAction": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction", "description": "The content delivery network can cache authentication status codes. This parameter indicates the related configuration.\n" }, "responseAction": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction", "description": "Indicates how the content delivery network responds to users when authentication fails.\n" }, "statusCodeAction": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction", "description": "Specifies how the content delivery network handles authentication status codes.\n" }, "timeOutAction": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction", "description": "Specifies how the content delivery network handles authentication requests after authentication timeout.\n" } }, "type": "object", "required": [ "cacheAction", "responseAction", "statusCodeAction", "timeOutAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction": { "properties": { "action": { "type": "string", "description": "Indicates whether the CDN caches authentication status codes. The parameter values are: nocache: CDN does not cache authentication status codes. cache: CDN caches authentication status codes.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "The cache key specifies the query parameters used to distinguish different request URIs. Each parameter must start with $.\n" }, "ttl": { "type": "integer", "description": "Indicates the cache duration for authentication status codes, measured in seconds. The range is 1–86400. 86400 seconds equals 24 hours.\n" } }, "type": "object", "required": [ "action", "cacheKeys", "ttl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction": { "properties": { "statusCode": { "type": "string", "description": "Indicates the status code returned by the content delivery network to the user when authentication fails. You can specify any status code in the range 400–499. The default value is 403.\n" } }, "type": "object", "required": [ "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction": { "properties": { "defaultAction": { "type": "string", "description": "Specifies how the content delivery network handles authentication requests when the authentication status code is neither FailCode nor SuccessCode. This parameter has the following values: reject: the content delivery network considers authentication failed; pass: the content delivery network considers authentication successful.\n" }, "failCode": { "type": "string", "description": "Indicates the authentication status code returned when authentication fails. You can specify one or more status codes in the range 400–499. Separate multiple status codes with a semicolon (;). You can also specify 4xx to indicate any status code between 400 and 499. The default value for this parameter is 401.\n" }, "successCode": { "type": "string", "description": "Indicates the authentication status code for successful authentication. You can specify one or more status codes in the range 200–299. Separate multiple status codes with a semicolon (;). You can also specify 2xx to represent any status code from 200–299. The default value is 200.\n" } }, "type": "object", "required": [ "defaultAction", "failCode", "successCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction": { "properties": { "action": { "type": "string", "description": "Indicates the strategy for handling authentication requests after a timeout in the content delivery network. This parameter supports the following values: reject: The content delivery network considers authentication failed. pass: The content delivery network considers authentication successful.\n" }, "time": { "type": "integer", "description": "Specifies the authentication timeout in milliseconds. The default value is 200. The valid range is 200–3600.\n" } }, "type": "object", "required": [ "action", "time" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules": { "properties": { "queryStringComponents": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents", "description": "Indicates the strategy for setting authentication request parameters.\n" }, "queryStringInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance" }, "description": "Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.\n" } }, "type": "object", "required": [ "queryStringComponents", "queryStringInstances" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents": { "properties": { "action": { "type": "string", "description": "Indicates whether the authentication request includes query parameters from the user's request URL. The parameter accepts the following values: exclude: The authentication request does not include any query parameters. include: The authentication request includes all query parameters. includePart: The authentication request includes specified query parameters.\n" }, "value": { "type": "string", "description": "Indicates the parameter value corresponding to the Action parameter. The length cannot exceed 1,024 characters. The parameter accepts the following values: If Action is exclude or include, Value must be *. If Action is includePart, you need to specify one or more query parameters from the user's request URL in the Value parameter, separated by semicolons (;). You cannot specify *. Query parameters are case-sensitive and can include printable ASCII characters except for the following: double quotes (\") , spaces, and Delete (ASCII code 127). The default value for this parameter is *.\n" } }, "type": "object", "required": [ "action", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance": { "properties": { "action": { "type": "string", "description": "Describes how to set authentication request parameters. Currently, you can only set Action to set. set means to configure parameters. You need to specify the authentication request parameter to set in Key. If the specified authentication request parameter does not exist, the content delivery network adds the parameter to the authentication request. If the specified authentication request parameter already exists, the content delivery network uses the value of Value as the parameter's value.\n" }, "key": { "type": "string", "description": "Indicates the authentication request parameter you need to set. The length must not exceed 1,024 characters. The authentication request parameter can contain printable ASCII characters except for the following: double quotes (\"), space, and Delete (ASCII code 127)\n" }, "value": { "type": "string", "description": "Indicates the value of the authentication request parameter. The length cannot exceed 1,024 characters and is case-sensitive. Value has the following options: When ValueType is constant, the authentication request parameter value is a constant. You need to specify this constant value. The constant value cannot start with a dollar sign ($) and can include any printable ASCII character except the following: double quotes (\") and Delete (ASCII code 127). When ValueType is variable, the authentication request parameter value comes from a variable. You can specify a variable from the variable list. When ValueType is customize, the authentication request parameter value is a string formed by concatenating variables from the list with fixed strings. In the concatenated string, variables are represented as ${variable*name}. Example value: bind${request*uri}to${local_ip}done\n" }, "valueType": { "type": "string", "description": "Indicates the type of authentication request parameter set in Key. ValueType has the following options: constant: The authentication request parameter is a constant. In this case, you need to specify the constant value in Value. variable: The authentication request parameter value comes from a variable. See the description for Value. customize: The authentication request parameter value is a string formed by concatenating a variable and a fixed string.\n" } }, "type": "object", "required": [ "action", "key", "value", "valueType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules": { "properties": { "requestHeaderComponents": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents", "description": "Indicates the configuration policy for authentication request headers.\n" }, "requestHeaderInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance" }, "description": "Specifies a set of authentication request header settings Note that when the content delivery network initiates an authentication request, the following headers may already be included in the request: X-Forwarded-Protocol, X-Forwarded-Proto, X-Client-Scheme: all three headers indicate the protocol used by the user request and are equivalent X-Real-IP: indicates the user's real IP address This header value is not affected by proxy servers X-Forwarded-For: indicates the user's IP address If the user's request passes through a proxy server, this header value becomes the proxy server's IP address It is not recommended to configure these headers in this parameter If you set these headers, their original values will be overwritten\n" }, "requestHost": { "type": "string", "description": "Indicates the value of the HOST header in authentication requests. The default value for this parameter is default, meaning the HOST header matches your acceleration domain name.\n" } }, "type": "object", "required": [ "requestHeaderComponents", "requestHeaderInstances", "requestHost" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents": { "properties": { "action": { "type": "string", "description": "Indicates whether the authentication request header includes user request headers. The parameter values are: exclude: the authentication request header does not include any user request headers. include: the authentication request header includes all user request headers. includePart: the authentication request header includes specified user request headers.\n" }, "value": { "type": "string", "description": "Indicates the parameter value corresponding to the Action parameter. The length must not exceed 1,024 characters. The parameter has the following notes: If Action is exclude or include, Value must be *. If Action is includePart, the Value parameter can be one or more headers from the user's request. Multiple headers are separated by a semicolon (;). The value cannot be only *, and can include printable ASCII characters except for the following: underscore (_), space, double quotes (\"), Delete (ASCII code 127). The default value for this parameter is *.\n" } }, "type": "object", "required": [ "action", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance:getDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance": { "properties": { "action": { "type": "string", "description": "Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.\n" }, "key": { "type": "string", "description": "Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes (\"), and Delete (ASCII code 127).\n" }, "value": { "type": "string", "description": "Indicates the value of the Key. This parameter is only valid when Action equals \"set\". If Action does not equal \"set\", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)\n" }, "valueType": { "type": "string", "description": "Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.\n" } }, "type": "object", "required": [ "action", "key", "value", "valueType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestBlockRule:getDomainRequestBlockRule": { "properties": { "blockRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestBlockRuleBlockRule:getDomainRequestBlockRuleBlockRule" }, "description": "Represents a list of interception rules. The list can contain up to 10 rules. When Switch is true, this parameter is required.\n" }, "switch": { "type": "boolean", "description": "Indicates the configuration switch for this module. This parameter has the following values: true: enables the module. false: disables the module. The default value is false.\n" } }, "type": "object", "required": [ "blockRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestBlockRuleBlockRule:getDomainRequestBlockRuleBlockRule": { "properties": { "blockAction": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestBlockRuleBlockRuleBlockAction:getDomainRequestBlockRuleBlockRuleBlockAction", "description": "Indicates the interception configuration for a rule in the list.\n" }, "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestBlockRuleBlockRuleCondition:getDomainRequestBlockRuleBlockRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "ruleName": { "type": "string", "description": "Indicates the name of the rule, which must not exceed 20 characters and can include letters, numbers, underscores (_), hyphens (-), and Chinese characters. One Chinese character counts as 3 characters.\n" } }, "type": "object", "required": [ "blockAction", "condition", "ruleName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestBlockRuleBlockRuleBlockAction:getDomainRequestBlockRuleBlockRuleBlockAction": { "properties": { "action": { "type": "string", "description": "Specifies how the content delivery network intercepts matching requests. This parameter has the following values: refuse: The content delivery network rejects the request and returns a 4xx error code. The error code is specified in StatusCode. redirect: The content delivery network redirects the request to the URL specified in RedirectUrl.\n" }, "errorPage": { "type": "string", "description": "When Action is refuse, this parameter is optional, as explained below: If specified, this parameter indicates the name of a custom response page under global configuration. When the content delivery network refuses a request, it returns this custom page. Note that 'global configuration' is an Allowlist feature. To use this feature, submit a ticket. If this parameter is not specified, the content delivery network uses the standard response body for the error code specified in StatusCode. When Action is redirect, this parameter is invalid and can be omitted.\n" }, "redirectUrl": { "type": "string", "description": "When Action is redirect, this parameter is required and specifies the redirect URL. The URL must start with http:// or https:// and cannot exceed 1,024 characters. When Action is refuse, this parameter is invalid and can be omitted.\n" }, "statusCode": { "type": "string", "description": "Represents the response status code from the content delivery network for intercepted requests. When Action is refuse, this parameter specifies an error code in the range 400–499. When Action is redirect, this parameter can be: 301: The response status code is 301. 302: The response status code is 302.\n" } }, "type": "object", "required": [ "action", "errorPage", "redirectUrl", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestBlockRuleBlockRuleCondition:getDomainRequestBlockRuleBlockRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestBlockRuleBlockRuleConditionConditionRule:getDomainRequestBlockRuleBlockRuleConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestBlockRuleBlockRuleConditionConditionRule:getDomainRequestBlockRuleBlockRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestHeader:getDomainRequestHeader": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestHeaderCondition:getDomainRequestHeaderCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "requestHeaderAction": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestHeaderRequestHeaderAction:getDomainRequestHeaderRequestHeaderAction", "description": "Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.\n" } }, "type": "object", "required": [ "condition", "requestHeaderAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestHeaderCondition:getDomainRequestHeaderCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestHeaderConditionConditionRule:getDomainRequestHeaderConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestHeaderConditionConditionRule:getDomainRequestHeaderConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestHeaderRequestHeaderAction:getDomainRequestHeaderRequestHeaderAction": { "properties": { "requestHeaderInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestHeaderRequestHeaderActionRequestHeaderInstance:getDomainRequestHeaderRequestHeaderActionRequestHeaderInstance" }, "description": "Indicates a list of configuration rules for request headers. Each rule includes settings for header-related operations. You can add up to 50 rules.\n" } }, "type": "object", "required": [ "requestHeaderInstances" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRequestHeaderRequestHeaderActionRequestHeaderInstance:getDomainRequestHeaderRequestHeaderActionRequestHeaderInstance": { "properties": { "action": { "type": "string", "description": "Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.\n" }, "key": { "type": "string", "description": "Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes (\"), and Delete (ASCII code 127).\n" }, "value": { "type": "string", "description": "Indicates the value of the Key. This parameter is only valid when Action equals \"set\". If Action does not equal \"set\", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)\n" }, "valueType": { "type": "string", "description": "Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.\n" } }, "type": "object", "required": [ "action", "key", "value", "valueType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainResponseHeader:getDomainResponseHeader": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainResponseHeaderCondition:getDomainResponseHeaderCondition", "description": "Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "responseHeaderAction": { "$ref": "#/types/volcenginecc:cdn/getDomainResponseHeaderResponseHeaderAction:getDomainResponseHeaderResponseHeaderAction", "description": "Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.\n" } }, "type": "object", "required": [ "condition", "responseHeaderAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainResponseHeaderCondition:getDomainResponseHeaderCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainResponseHeaderConditionConditionRule:getDomainResponseHeaderConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainResponseHeaderConditionConditionRule:getDomainResponseHeaderConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainResponseHeaderResponseHeaderAction:getDomainResponseHeaderResponseHeaderAction": { "properties": { "responseHeaderInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainResponseHeaderResponseHeaderActionResponseHeaderInstance:getDomainResponseHeaderResponseHeaderActionResponseHeaderInstance" }, "description": "Specifies a list of configuration rules for response headers Each rule includes settings for header-related operations You can add up to 50 rules\n" } }, "type": "object", "required": [ "responseHeaderInstances" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainResponseHeaderResponseHeaderActionResponseHeaderInstance:getDomainResponseHeaderResponseHeaderActionResponseHeaderInstance": { "properties": { "accessOriginControl": { "type": "boolean", "description": "Indicates whether the Origin field in the request header is validated when the content delivery network responds to user requests. Valid values are: true: The content delivery network validates the Origin field. If validation succeeds, the response header includes the Access-Control-Allow-Origin field, with the value matching the Origin field. If validation fails, the response header does not include the Access-Control-Allow-Origin field. false: The content delivery network does not validate the Origin field. The response header includes the Access-Control-Allow-Origin field, with the value set to your configured Access-Control-Allow-Origin content. The default value is false. This parameter is only effective when all the following conditions are met: Action is set. Key is Access-Control-Allow-Origin. ValueType is constant.\n" }, "action": { "type": "string", "description": "Specifies the operation on the response header. This parameter has the following values: set: sets a header. The set operation includes adding and modifying. If the header already exists in the origin response, its value will be overwritten. If the header does not exist in the origin response, it will be added. delete: deletes a header\n" }, "key": { "type": "string", "description": "Specifies the name of a header. The name cannot exceed 1,024 characters, is case-insensitive, and can include any printable ASCII character except the following: underscore (_), space, double quotes (\"), and Delete (ASCII code 127)\n" }, "value": { "type": "string", "description": "Indicates the value of the Key. This parameter is valid only when Action is set. If Action is not set, this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can include printable ASCII characters except for the following: dollar sign ($), Delete (ASCII code 127).\n" }, "valueType": { "type": "string", "description": "Specifies the value type for Key. This parameter is only valid when Action is set. If Action is not set, this parameter is invalid. The parameter supports the following values: constant: Key is a fixed string. variable: Key is sourced from a variable. customize: Key is a string formed by concatenating a variable and a fixed string.\n" } }, "type": "object", "required": [ "accessOriginControl", "action", "key", "value", "valueType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainRewriteHls:getDomainRewriteHls": { "properties": { "signName": { "type": "string", "description": "Indicates the name of the signature parameter, which cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!). The default value is DrmAuthToken.\n" }, "switch": { "type": "boolean", "description": "Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.\n" } }, "type": "object", "required": [ "signName", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainSignedUrlAuth:getDomainSignedUrlAuth": { "properties": { "signedUrlAuthRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRule:getDomainSignedUrlAuthSignedUrlAuthRule" }, "description": "Represents the configuration module for the 'URL authentication' feature. This feature is disabled by default.\n" }, "switch": { "type": "boolean", "description": "Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.\n" } }, "type": "object", "required": [ "signedUrlAuthRules", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRule:getDomainSignedUrlAuthSignedUrlAuthRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleCondition:getDomainSignedUrlAuthSignedUrlAuthRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "signedUrlAuthAction": { "$ref": "#/types/volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction:getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction", "description": "Indicates the configuration for signature calculation.\n" } }, "type": "object", "required": [ "condition", "signedUrlAuthAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleCondition:getDomainSignedUrlAuthSignedUrlAuthRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule:getDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule:getDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction:getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction": { "properties": { "authAlgorithm": { "type": "string", "description": "Indicates the algorithm used for signature calculation. This configuration has the following values: md5: MD5 algorithm. sha256: SHA-256 algorithm. The default value for this parameter is md5.\n" }, "backupSecretKey": { "type": "string", "description": "Indicates the backup secret key. The backup secret key must be 6–40 characters long and can contain any printable ASCII character except Delete (ASCII code 127).\n" }, "customVariableRules": { "$ref": "#/types/volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules:getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules", "description": "Indicates custom signature calculation variables.\n" }, "duration": { "type": "integer", "description": "The validity period of the signature, in seconds. This parameter is used with the timestamp included in the request to calculate the expiration time of the signature. The value range for this parameter is 0–315,360,000. Signature expiration time = timestamp + Duration. When the content delivery network receives a request, if the signature expiration time is less than the current time, the content delivery network determines that the signature has expired.\n" }, "keepOriginArg": { "type": "boolean", "description": "This parameter is not currently available to external users. Do not use this parameter.\n" }, "masterSecretKey": { "type": "string", "description": "Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)\n" }, "rewriteM3U8": { "type": "boolean", "description": "Indicates whether the content delivery network adds signature parameters to the URL of each segment file in a .m3u8 file when responding to a .m3u8 file request. The signature for each segment URL is calculated based on the rewritten segment URL using the signature rules. The parameter values are as follows: true: enabled. false: disabled.\n" }, "rewriteM3U8Rule": { "$ref": "#/types/volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule:getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule", "description": "Specifies the configuration for the 'M3U8 Rewrite' feature. This configuration is valid only when both of the following conditions are met: RewriteM3u8 is true; URLAuthType is not typee.\n" }, "signName": { "type": "string", "description": "Indicates the name of the signature parameter. The length cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!).\n" }, "signatureRules": { "type": "array", "items": { "type": "string" }, "description": "When URLAuthType is set to typee, this parameter is required and specifies the fields to be included in the signature calculation. The following fields must be included in the signature calculation: key: the secret key, which is the parameter value for MasterSecretKey or BackupSecretKey. uri: the URI of the resource requested by the user. If the URI contains Chinese characters, you need to encode the URI. TimeName: the parameter value for the timestamp. The following fields can optionally be included in the signature calculation: domain: the acceleration domain name. referer: the referer value carried in the user's request. ua: the User-Agent value carried in the user's request. ip: the client IP of the user's request. origin: the Origin value carried in the user's request. Custom variables: the variable names you define in CustomVariableInstances. The order in which the fields are listed determines the order of values in MD5() during signature calculation.\n" }, "timeFormat": { "type": "string", "description": "Numeral system configuration. This parameter has the following values: decimal: decimal system; hexadecimal: hexadecimal system. When URLAuthType is typed or typee, this parameter is required. When URLAuthType is typec, regardless of your setting, this parameter is forcibly set to hexadecimal. For other URLAuthType values, this parameter is not effective.\n" }, "timeName": { "type": "string", "description": "Indicates the name of the timestamp parameter. The value of TimeName can include English letters, numbers, underscores (_), hyphens (-), periods (.), commas (,), and exclamation marks (!), with a length of 1–100 characters. TimeName cannot be the same as SignName. When URLAuthType is typed or typee, this parameter is required. For other types, this parameter does not apply.\n" }, "urlAuthType": { "type": "string", "description": "Signature type\n" } }, "type": "object", "required": [ "authAlgorithm", "backupSecretKey", "customVariableRules", "duration", "keepOriginArg", "masterSecretKey", "rewriteM3U8", "rewriteM3U8Rule", "signName", "signatureRules", "timeFormat", "timeName", "urlAuthType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules:getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules": { "properties": { "customVariableInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRulesCustomVariableInstance:getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRulesCustomVariableInstance" }, "description": "Indicates a variable list\n" } }, "type": "object", "required": [ "customVariableInstances" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRulesCustomVariableInstance:getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRulesCustomVariableInstance": { "properties": { "operator": { "type": "string", "description": "Indicates the matching method for the variable. The value of this parameter can only be match.\n" }, "type": { "type": "string", "description": "Indicates the variable type. This parameter has the following values: queryString: indicates the variable is a query parameter in the request. requestHeader: indicates the variable is a header field in the request.\n" }, "value": { "type": "string", "description": "Specifies the variable name, with a maximum length of 100 characters. Variable name requirements are as follows: If Type is queryString, the variable name can include letters, numbers, hyphens (-), commas (,), periods (.), and exclamation marks (!). If Type is requestHeader, the variable name can include any printable ASCII character except: underscore (_), space, double quotes (\"), colon (:), and Delete (ASCII code 127).\n" } }, "type": "object", "required": [ "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule:getDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule": { "properties": { "deleteParam": { "type": "boolean", "description": "Indicates whether to retain the original parameters in the URL when rewriting the shard URL. This parameter has the following values: true: removes the original parameters. false: retains the original parameters.\n" }, "keepM3U8Param": { "type": "boolean", "description": "Indicates whether to add unsigned query parameters from the M3U8 file request to the segment URL. The parameter has the following options: true: add query parameters to the segment URL. false: do not add query parameters.\n" } }, "type": "object", "required": [ "deleteParam", "keepM3U8Param" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainTag:getDomainTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainTimeout:getDomainTimeout": { "properties": { "switch": { "type": "boolean", "description": "Specify whether to enable origin timeout configuration. This parameter has the following values: true: enables origin timeout configuration. false: disables origin timeout configuration. In this case, the system default timeout values are used for TCP and HTTP requests, which are 2 seconds and 60 seconds respectively.\n" }, "timeoutRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainTimeoutTimeoutRule:getDomainTimeoutTimeoutRule" }, "description": "Represents a set of timeout configurations. Currently, you can specify only one configuration. This parameter is required when Switch is true.\n" } }, "type": "object", "required": [ "switch", "timeoutRules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainTimeoutTimeoutRule:getDomainTimeoutTimeoutRule": { "properties": { "condition": { "$ref": "#/types/volcenginecc:cdn/getDomainTimeoutTimeoutRuleCondition:getDomainTimeoutTimeoutRuleCondition", "description": "Represents the conditions under which this configuration module takes effect, consisting of a set of rules.\n" }, "timeoutAction": { "$ref": "#/types/volcenginecc:cdn/getDomainTimeoutTimeoutRuleTimeoutAction:getDomainTimeoutTimeoutRuleTimeoutAction", "description": "Indicates the timeout configuration.\n" } }, "type": "object", "required": [ "condition", "timeoutAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainTimeoutTimeoutRuleCondition:getDomainTimeoutTimeoutRuleCondition": { "properties": { "conditionRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainTimeoutTimeoutRuleConditionConditionRule:getDomainTimeoutTimeoutRuleConditionConditionRule" }, "description": "Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.\n" }, "connective": { "type": "string", "description": "Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.\n" } }, "type": "object", "required": [ "conditionRules", "connective" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainTimeoutTimeoutRuleConditionConditionRule:getDomainTimeoutTimeoutRuleConditionConditionRule": { "properties": { "name": { "type": "string", "description": "When Object is query*name or customize, this parameter is valid. If Object is query*name, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).\n" }, "object": { "type": "string", "description": "Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.\n" }, "operator": { "type": "string", "description": "Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.\n" }, "type": { "type": "string", "description": "Specifies the target type. The value of this parameter is url, indicating the target is a URL.\n" }, "value": { "type": "string", "description": "Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks (*) in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks (*) in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).\n" } }, "type": "object", "required": [ "name", "object", "operator", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainTimeoutTimeoutRuleTimeoutAction:getDomainTimeoutTimeoutRuleTimeoutAction": { "properties": { "httpTimeout": { "type": "integer", "description": "Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.\n" }, "tcpTimeout": { "type": "integer", "description": "Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.\n" } }, "type": "object", "required": [ "httpTimeout", "tcpTimeout" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainUaAccessRule:getDomainUaAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Indicates whether requests with an empty UA (\"\") or without a UA field are allowed to access the acceleration domain. The parameter has the following values: true: allowed. false: not allowed. The default value is false.\n" }, "ignoreCase": { "type": "boolean", "description": "Indicates whether the UA string is case-sensitive. The parameter has the following options: true: The UA string is case-insensitive. false: The UA string is case-sensitive. The default value for this parameter is false.\n" }, "ruleType": { "type": "string", "description": "Specifies whether a denylist or allowlist is used. When Switch is true, this parameter is required. The parameter values are as follows: deny: specifies a denylist. allow: specifies an allowlist.\n" }, "switch": { "type": "boolean", "description": "Indicates whether the UA allowlist and blocklist feature is enabled. This parameter has the following values: true: enabled. false: disabled.\n" }, "userAgents": { "type": "array", "items": { "type": "string" }, "description": "Represents a list of UAs. When Switch is true, this parameter is required. The list can contain up to 1,000 UAs. The parameter details are as follows: The value length cannot exceed 30,000 characters. If RuleType is allow, only requests containing UAs in the list are permitted to access the acceleration domain. If RuleType is deny, requests containing UAs in the list are not permitted to access the acceleration domain. UA character restrictions are as follows: You can use * in a UA to represent one or more characters. * can only appear at the beginning or end of the UA. A UA cannot consist only of * or spaces. A UA can contain printable ASCII characters except Delete (ASCII code 127). If a UA contains symbols, the symbols must be HTML encoded.\n" } }, "type": "object", "required": [ "allowEmpty", "ignoreCase", "ruleType", "switch", "userAgents" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainUrlNormalize:getDomainUrlNormalize": { "properties": { "normalizeObjects": { "type": "array", "items": { "type": "string" }, "description": "This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dot*segments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. back*slashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).\n" }, "switch": { "type": "boolean", "description": "This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dot*segments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. back*slashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).\n" } }, "type": "object", "required": [ "normalizeObjects", "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getDomainVideoDrag:getDomainVideoDrag": { "properties": { "switch": { "type": "boolean", "description": "Smart compression configuration switch. The parameter has the following options: true: enable video seeking. false: disable video seeking.\n" } }, "type": "object", "required": [ "switch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getShareConfigAllowIpAccessRule:getShareConfigAllowIpAccessRule": { "properties": { "rules": { "type": "array", "items": { "type": "string" }, "description": "Specifies a list of entries. Each entry in the list is an IP address or CIDR block. IP addresses and blocks can be in IPv4 or IPv6 format. List limits: For AddSharedConfig, the number of entries in the list cannot exceed 30,000.\n" } }, "type": "object", "required": [ "rules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getShareConfigAllowRefererAccessRule:getShareConfigAllowRefererAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Indicates whether requests with an empty Referer header or without a Referer header are not allowed. This parameter has the following values: true: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. false: Allowed. The default value is false.\n" }, "commonType": { "$ref": "#/types/volcenginecc:cdn/getShareConfigAllowRefererAccessRuleCommonType:getShareConfigAllowRefererAccessRuleCommonType", "description": "Specifies the contents of the common list.\n" } }, "type": "object", "required": [ "allowEmpty", "commonType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getShareConfigAllowRefererAccessRuleCommonType:getShareConfigAllowRefererAccessRuleCommonType": { "properties": { "ignoreCase": { "type": "boolean", "description": "Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.\n" }, "rules": { "type": "array", "items": { "type": "string" }, "description": "Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.\n" } }, "type": "object", "required": [ "ignoreCase", "rules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getShareConfigCommonMatchList:getShareConfigCommonMatchList": { "properties": { "commonType": { "$ref": "#/types/volcenginecc:cdn/getShareConfigCommonMatchListCommonType:getShareConfigCommonMatchListCommonType", "description": "Specifies the contents of the common list.\n" } }, "type": "object", "required": [ "commonType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getShareConfigCommonMatchListCommonType:getShareConfigCommonMatchListCommonType": { "properties": { "ignoreCase": { "type": "boolean", "description": "Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.\n" }, "rules": { "type": "array", "items": { "type": "string" }, "description": "Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.\n" } }, "type": "object", "required": [ "ignoreCase", "rules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getShareConfigDenyIpAccessRule:getShareConfigDenyIpAccessRule": { "properties": { "rules": { "type": "array", "items": { "type": "string" }, "description": "Specifies the configuration for an IP denylist, where ConfigType is deny*ip*access_rule.\n" } }, "type": "object", "required": [ "rules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getShareConfigDenyRefererAccessRule:getShareConfigDenyRefererAccessRule": { "properties": { "allowEmpty": { "type": "boolean", "description": "Indicates whether requests with an empty Referer header or without a Referer header are allowed. This parameter has the following values: true: Allowed. false: Not allowed. If the Referer header is empty or missing, the content delivery network rejects the request. The default value is true.\n" }, "commonType": { "$ref": "#/types/volcenginecc:cdn/getShareConfigDenyRefererAccessRuleCommonType:getShareConfigDenyRefererAccessRuleCommonType", "description": "Specifies the contents of the common list.\n" } }, "type": "object", "required": [ "allowEmpty", "commonType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cdn/getShareConfigDenyRefererAccessRuleCommonType:getShareConfigDenyRefererAccessRuleCommonType": { "properties": { "ignoreCase": { "type": "boolean", "description": "Indicates whether entries in Rules are case-sensitive. This parameter has the following values: true: Not case-sensitive. false: Case-sensitive. The default value is true.\n" }, "rules": { "type": "array", "items": { "type": "string" }, "description": "Indicates an entry list, where each entry is a string. List quotas are as follows: The list can contain up to 4,000 entries. The total length of all entries cannot exceed 200,000 characters. When the CDN creates this global configuration, duplicate entries in the list are removed. Duplicate entries do not count toward the quota.\n" } }, "type": "object", "required": [ "ignoreCase", "rules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cen/BandwidthPackageTag:BandwidthPackageTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Parameter - N: indicates the tag key index, value range: 1–20. Use \u0026 to separate multiple tag keys. Cannot start with sys:, in any case. Length range: 1–128 characters. Supports all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If a tag key starts or ends with a space, the system automatically removes it.\n" }, "value": { "type": "string", "description": "Tag value for user tags. Parameter - N indicates the tag value index, range: 1–20. Use \u0026 to separate multiple tag values. Length range: 0–256 characters. If not specified, defaults to empty. Supports all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system automatically removes it.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:cen/CenInstance:CenInstance": { "properties": { "instanceId": { "type": "string", "description": "Network instance ID\n" }, "instanceOwnerId": { "type": "string", "description": "Account ID for the network instance\n" }, "instanceRegionId": { "type": "string", "description": "Region where the network instance is located\n" }, "instanceType": { "type": "string", "description": "Type of the network instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId", "instanceOwnerId", "instanceRegionId", "instanceType" ] } } }, "volcenginecc:cen/CenTag:CenTag": { "properties": { "key": { "type": "string", "description": "Tag key for user labels. Length limit: 1–128 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Duplicate tag keys are not allowed for the same resource\n" }, "value": { "type": "string", "description": "Tag value for user labels. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:cen/ServiceRouteEntryPublishToInstance:ServiceRouteEntryPublishToInstance": { "properties": { "instanceId": { "type": "string", "description": "Network instance ID for published cloud service access route.\n" }, "instanceRegionId": { "type": "string", "description": "Region for published cloud service access route.\n" }, "instanceType": { "type": "string", "description": "Network instance type for published cloud service access route.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId", "instanceRegionId", "instanceType" ] } } }, "volcenginecc:cen/getBandwidthPackageTag:getBandwidthPackageTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Parameter - N: indicates the tag key index, value range: 1–20. Use \u0026 to separate multiple tag keys. Cannot start with sys:, in any case. Length range: 1–128 characters. Supports all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If a tag key starts or ends with a space, the system automatically removes it.\n" }, "value": { "type": "string", "description": "Tag value for user tags. Parameter - N indicates the tag value index, range: 1–20. Use \u0026 to separate multiple tag values. Length range: 0–256 characters. If not specified, defaults to empty. Supports all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system automatically removes it.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cen/getCenInstance:getCenInstance": { "properties": { "cenId": { "type": "string", "description": "CEN instance ID\n" }, "creationTime": { "type": "string", "description": "Creation time of the network instance\n" }, "instanceId": { "type": "string", "description": "Network instance ID\n" }, "instanceOwnerId": { "type": "string", "description": "Account ID for the network instance\n" }, "instanceRegionId": { "type": "string", "description": "Region where the network instance is located\n" }, "instanceType": { "type": "string", "description": "Type of the network instance\n" }, "status": { "type": "string", "description": "Loading status of the network instance. Attaching: Loading; Available: Available\n" } }, "type": "object", "required": [ "cenId", "creationTime", "instanceId", "instanceOwnerId", "instanceRegionId", "instanceType", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cen/getCenTag:getCenTag": { "properties": { "key": { "type": "string", "description": "Tag key for user labels. Length limit: 1–128 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @. Duplicate tag keys are not allowed for the same resource\n" }, "value": { "type": "string", "description": "Tag value for user labels. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cen/getServiceRouteEntryPublishToInstance:getServiceRouteEntryPublishToInstance": { "properties": { "instanceId": { "type": "string", "description": "Network instance ID for published cloud service access route.\n" }, "instanceRegionId": { "type": "string", "description": "Region for published cloud service access route.\n" }, "instanceType": { "type": "string", "description": "Network instance type for published cloud service access route.\n" } }, "type": "object", "required": [ "instanceId", "instanceRegionId", "instanceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/AclAclEntry:AclAclEntry": { "properties": { "description": { "type": "string", "description": "Description of the IP entry. Default value is an empty string. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters.\n" }, "entry": { "type": "string", "description": "Address range of the IP entry. Only CIDR addresses are supported. Both IPv4 and IPv6 entries can be provided.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "entry" ] } } }, "volcenginecc:clb/AclListener:AclListener": { "properties": { "aclType": { "type": "string", "description": "Listener control mode for this access control policy group. white: allowlist. When the listener monitors CLB traffic, CLB only forwards requests from IP addresses associated with the allowlist access control policy group. black: denylist. When the listener monitors CLB traffic, CLB rejects requests from IP addresses associated with the denylist access control policy group.\n" }, "listenerId": { "type": "string", "description": "Listener ID\n" }, "listenerName": { "type": "string", "description": "Listener name\n" }, "port": { "type": "integer", "description": "Listener port\n" }, "protocol": { "type": "string", "description": "Listener protocol. Includes TCP, UDP, HTTP, HTTPS.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aclType", "listenerId", "listenerName", "port", "protocol" ] } } }, "volcenginecc:clb/AclTag:AclTag": { "properties": { "key": { "type": "string", "description": "User tag key. Length must be 1–128 characters. Supports input of characters in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system automatically removes it.\n" }, "value": { "type": "string", "description": "User tag value. Supports input of characters in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system automatically removes it.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/CertificateTag:CertificateTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/ClbAccessLog:ClbAccessLog": { "properties": { "bucketName": { "type": "string", "description": "Name of the object storage bucket for storing Layer 7 access logs\n" }, "deliveryType": { "type": "string", "description": "Log delivery type. Available values: tos (default): Deliver logs to object storage service TOS. tls: Deliver logs to log service TLS\n" }, "enabled": { "type": "boolean", "description": "Enable access log (Layer 7) delivery to object storage TOS\n" }, "tlsProjectId": { "type": "string", "description": "Log project\n" }, "tlsTopicId": { "type": "string", "description": "Log topic\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucketName", "deliveryType", "enabled", "tlsProjectId", "tlsTopicId" ] } } }, "volcenginecc:clb/ClbEip:ClbEip": { "properties": { "bandwidth": { "type": "number", "description": "Peak bandwidth\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID\n" }, "eipBillingType": { "type": "number", "description": "Billing method\n" }, "isp": { "type": "string", "description": "Line type\n" }, "securityProtectionInstanceId": { "type": "number", "description": "Protection package ID\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Security protection type\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "bandwidthPackageId", "eipBillingType", "isp", "securityProtectionInstanceId", "securityProtectionTypes" ] } } }, "volcenginecc:clb/ClbEni:ClbEni": { "properties": { "eniAddress": { "type": "string", "description": "Private IP address of the load balancer instance\n" }, "eniId": { "type": "string", "description": "Network interface ID occupied by the load balancer instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "eniAddress", "eniId" ] } } }, "volcenginecc:clb/ClbEnis:ClbEnis": { "properties": { "eniAddress": { "type": "string", "description": "Private IP address of the load balancer instance\n" }, "eniId": { "type": "string", "description": "Network interface ID occupied by the load balancer instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "eniAddress", "eniId" ] } } }, "volcenginecc:clb/ClbIpv6AddressBandwidth:ClbIpv6AddressBandwidth": { "properties": { "bandwidth": { "type": "number", "description": "Peak bandwidth of IPv6 public bandwidth, in Mbps\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID associated with IPv6 public bandwidth\n" }, "billingType": { "type": "number", "description": "Billing type for IPv6 public bandwidth\n" }, "isp": { "type": "string", "description": "Line type of IPv6 public bandwidth\n" }, "networkType": { "type": "string", "description": "Network type of the load balancer instance's IPv6 address\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "bandwidthPackageId", "billingType", "isp", "networkType" ] } } }, "volcenginecc:clb/ClbListener:ClbListener": { "properties": { "listenerId": { "type": "string", "description": "Listener ID\n" }, "listenerName": { "type": "string", "description": "Listener name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "listenerId", "listenerName" ] } } }, "volcenginecc:clb/ClbServerGroup:ClbServerGroup": { "properties": { "serverGroupId": { "type": "string", "description": "ID of the backend server group in the load balancer instance\n" }, "serverGroupName": { "type": "string", "description": "Name of the backend server group in the load balancer instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "serverGroupId", "serverGroupName" ] } } }, "volcenginecc:clb/ClbTag:ClbTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/ListenerDomainExtension:ListenerDomainExtension": { "properties": { "certCenterCertificateId": { "type": "string", "description": "Certificate ID of the extended domain name.\n" }, "certificateSource": { "type": "string", "description": "Certificate source for the extended domain name to be added. Value: cert_center: SSL certificate from Volcano Engine Certificate Center. This parameter is required when adding an extended domain name.\n" }, "domain": { "type": "string", "description": "Domain name. Supports both wildcard and exact domain names. Specifications: 1. Must contain at least one '.', and cannot start or end with '.'. 2. Only letters, numbers, '.', '-', and '*' are allowed. 3. Length must be between 1 and 128 characters. 4. Wildcard domain: Use '*' to replace one or more characters. 5. Exact domain: A domain name that strictly follows domain name specifications.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certCenterCertificateId", "certificateSource", "domain" ] } } }, "volcenginecc:clb/ListenerHealthCheck:ListenerHealthCheck": { "properties": { "domain": { "type": "string", "description": "Domain name for health check. Must be set to the actual address provided by the backend server. This parameter takes effect when Protocol is set to HTTP or HTTPS and HealthCheck.Enabled is on. Must contain at least one period (.), and cannot start or end with a period (.). Each string can include letters, numbers, hyphens (-), and periods (.), with hyphens (-) not allowed at the beginning or end of the string. Length limit: 1 to 128 characters. If this parameter is not provided or no value is specified, the default is empty, meaning CLB uses the private IP address of each backend server for health checks.\n" }, "enabled": { "type": "string", "description": "Whether health check is enabled for the listener. on (default): enabled. off: disabled.\n" }, "healthyThreshold": { "type": "integer", "description": "Health threshold, i.e., the number of consecutive successful health checks. Range: 2–10, default is 3, unit: times.\n" }, "httpCode": { "type": "string", "description": "HTTP status codes for healthy checks. This parameter is effective when Protocol is HTTP or HTTPS and HealthCheck.Enabled is on. Values: http*2xx (default), http*3xx, http*4xx, http*5xx. Separate multiple status codes with a comma (,).\n" }, "interval": { "type": "integer", "description": "Interval for performing health checks. Range: 1–300, default is 2, in seconds.\n" }, "method": { "type": "string", "description": "Listener health check method. GET: server must support the GET method. HEAD: server returns only HEAD header information, which reduces backend overhead, but requires server support for the HEAD method.\n" }, "port": { "type": "integer", "description": "Health check port. Value range: 1–65535.\n" }, "timeout": { "type": "integer", "description": "Health check response timeout. If the backend server does not respond correctly within the specified time, the health check is considered 'abnormal'. Value range: 1 to 60. Default: 2. Unit: seconds.\n" }, "udpExpect": { "type": "string", "description": "Expected response string for health check. Only letters and numbers are allowed, with a maximum length of 64 characters. This parameter takes effect when Protocol is set to UDP and HealthCheck.Enabled is set to on. HealthCheck.UdpRequest and HealthCheck.UdpExpect must either both be empty or both be non-empty.\n" }, "udpRequest": { "type": "string", "description": "Request string for performing health checks. Only letters and numbers are allowed, with a maximum length of 64 characters. This parameter takes effect when Protocol is set to UDP and HealthCheck.Enabled is set to on. The values of HealthCheck.UdpRequest and HealthCheck.UdpExpect must either both be empty or both be non-empty.\n" }, "unhealthyThreshold": { "type": "integer", "description": "Unhealthy threshold, which is the number of consecutive health check failures. Value range: 2–10. Default: 3. Unit: occurrences.\n" }, "uri": { "type": "string", "description": "Health check path. Must be configured as the actual address provided by the backend server. This parameter takes effect when Protocol is set to HTTP or HTTPS and HealthCheck.Enabled is on. Must start with '/'. Only letters, digits, hyphens (-), underscores (_), slashes (/), periods (.), percent signs (%), question marks (?), #, \u0026, and equals signs (=) are allowed. Length: 1–128 characters. If not specified or no value is provided, the default is '/'.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "domain", "enabled", "healthyThreshold", "httpCode", "interval", "method", "port", "timeout", "udpExpect", "udpRequest", "unhealthyThreshold", "uri" ] } } }, "volcenginecc:clb/ListenerTag:ListenerTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Length range: 1–128 characters. Supports input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system automatically removes it.\n" }, "value": { "type": "string", "description": "Tag value for user tags. Supports input of characters from any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system will automatically remove it.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/NlbAccessLog:NlbAccessLog": { "properties": { "accessLogEnabled": { "type": "boolean", "description": "Enable access logs. true: yes. false: no.\n" }, "projectId": { "type": "string", "description": "Log project ID.\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessLogEnabled", "projectId", "topicId" ] } } }, "volcenginecc:clb/NlbListenerHealth:NlbListenerHealth": { "properties": { "instanceId": { "type": "string", "description": "Backend server instance ID or IP address\n" }, "ip": { "type": "string", "description": "Backend server IP address\n" }, "port": { "type": "integer", "description": "Port on which the backend server provides services\n" }, "serverId": { "type": "string", "description": "Backend server ID\n" }, "serverType": { "type": "string", "description": "Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)\n" }, "status": { "type": "string", "description": "Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)\n" }, "updatedTime": { "type": "string", "description": "Last update time of health status\n" }, "zoneId": { "type": "string", "description": "Zone ID where the backend server receives traffic\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId", "ip", "port", "serverId", "serverType", "status", "updatedTime", "zoneId" ] } } }, "volcenginecc:clb/NlbListenerTag:NlbListenerTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/NlbSecurityPolicyTag:NlbSecurityPolicyTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/NlbServerGroupHealthCheck:NlbServerGroupHealthCheck": { "properties": { "domain": { "type": "string", "description": "Health check domain name\n" }, "enabled": { "type": "boolean", "description": "Enable health check\n" }, "healthyThreshold": { "type": "integer", "description": "Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'\n" }, "httpCode": { "type": "string", "description": "HTTP status codes indicating a healthy health check.\n" }, "interval": { "type": "integer", "description": "Health check interval, range: 1–300 seconds, default: 10 seconds.\n" }, "method": { "type": "string", "description": "Health check request method\n" }, "port": { "type": "integer", "description": "Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified\n" }, "timeout": { "type": "integer", "description": "Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'\n" }, "type": { "type": "string", "description": "Health check protocol type. Options: TCP (default), HTTP, UDP\n" }, "udpExpect": { "type": "string", "description": "UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.\n" }, "udpRequest": { "type": "string", "description": "Expected response string for UDP health check\n" }, "unhealthyThreshold": { "type": "integer", "description": "Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal\n" }, "uri": { "type": "string", "description": "Health check path\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "domain", "enabled", "healthyThreshold", "httpCode", "interval", "method", "port", "timeout", "type", "udpExpect", "udpRequest", "unhealthyThreshold", "uri" ] } } }, "volcenginecc:clb/NlbServerGroupServer:NlbServerGroupServer": { "properties": { "description": { "type": "string", "description": "Description of the backend server, default is an empty string.\n" }, "instanceId": { "type": "string", "description": "Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.\n" }, "ip": { "type": "string", "description": "Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.\n" }, "port": { "type": "integer", "description": "Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.\n" }, "serverId": { "type": "string", "description": "Backend server ID\n" }, "type": { "type": "string", "description": "Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.\n" }, "weight": { "type": "integer", "description": "Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.\n" }, "zoneId": { "type": "string", "description": "Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "instanceId", "ip", "port", "serverId", "type", "weight", "zoneId" ] } } }, "volcenginecc:clb/NlbServerGroupTag:NlbServerGroupTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/NlbTag:NlbTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/NlbZoneMapping:NlbZoneMapping": { "properties": { "eniId": { "type": "string", "description": "Network interface card ID.\n" }, "ipv4Address": { "type": "string", "description": "Private IPv4 VIP address of the NLB instance. If this parameter is not provided, the system automatically assigns an available IPv4 address from the subnet.\n" }, "ipv4EipAddress": { "type": "string", "description": "Public IPv4 EIP address of the NLB instance.\n" }, "ipv4EipId": { "type": "string", "description": "Public IPv4 EIP ID of the NLB instance.\n" }, "ipv4HcStatus": { "type": "string", "description": "Health status of the NLB instance's private IPv4 address. Healthy: healthy. Unhealthy: abnormal.\n" }, "ipv4LocalAddresses": { "type": "array", "items": { "type": "string" }, "description": "Private IPv4 LIP address of the NLB instance.\n" }, "ipv6Address": { "type": "string", "description": "Private IPv6 VIP address of the NLB instance.\n" }, "ipv6EipId": { "type": "string", "description": "ID of the IPv6 public bandwidth associated with the NLB instance.\n" }, "ipv6HcStatus": { "type": "string", "description": "Health status of the NLB instance's private IPv6 address. Healthy: healthy. Unhealthy: abnormal.\n" }, "ipv6LocalAddresses": { "type": "array", "items": { "type": "string" }, "description": "Private IPv6 LIP address of the NLB instance.\n" }, "subnetId": { "type": "string", "description": "Subnet ID to which the NLB instance belongs.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID to which the NLB instance belongs.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "eniId", "ipv4Address", "ipv4EipAddress", "ipv4EipId", "ipv4HcStatus", "ipv4LocalAddresses", "ipv6Address", "ipv6EipId", "ipv6HcStatus", "ipv6LocalAddresses", "subnetId", "zoneId" ] } } }, "volcenginecc:clb/RuleRedirectConfig:RuleRedirectConfig": { "properties": { "host": { "type": "string", "description": "The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.\n" }, "path": { "type": "string", "description": "Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '\u0026', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.\n" }, "port": { "type": "string", "description": "Port for forwarding rule redirection. Value range: 1~65535.\n" }, "protocol": { "type": "string", "description": "Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).\n" }, "statusCode": { "type": "string", "description": "Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "host", "path", "port", "protocol", "statusCode" ] } } }, "volcenginecc:clb/RuleTag:RuleTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/ServerGroupListener:ServerGroupListener": { "properties": { "listenerId": { "type": "string", "description": "Listener ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "listenerId" ] } } }, "volcenginecc:clb/ServerGroupServer:ServerGroupServer": { "properties": { "description": { "type": "string", "description": "Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "instanceId": { "type": "string", "description": "Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.\n" }, "ip": { "type": "string", "description": "Private IP address of the backend server. Use '\u0026' to separate multiple backend server IP addresses.\n" }, "port": { "type": "integer", "description": "Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.\n" }, "type": { "type": "string", "description": "Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.\n" }, "weight": { "type": "integer", "description": "Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "instanceId", "ip", "port", "type", "weight" ] } } }, "volcenginecc:clb/ServerGroupTag:ServerGroupTag": { "properties": { "key": { "type": "string", "description": "Information about bound tag keys.\n" }, "value": { "type": "string", "description": "Bound tag value information.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:clb/getAclAclEntry:getAclAclEntry": { "properties": { "description": { "type": "string", "description": "Description of the IP entry. Default value is an empty string. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters.\n" }, "entry": { "type": "string", "description": "Address range of the IP entry. Only CIDR addresses are supported. Both IPv4 and IPv6 entries can be provided.\n" } }, "type": "object", "required": [ "description", "entry" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getAclListener:getAclListener": { "properties": { "aclType": { "type": "string", "description": "Listener control mode for this access control policy group. white: allowlist. When the listener monitors CLB traffic, CLB only forwards requests from IP addresses associated with the allowlist access control policy group. black: denylist. When the listener monitors CLB traffic, CLB rejects requests from IP addresses associated with the denylist access control policy group.\n" }, "listenerId": { "type": "string", "description": "Listener ID\n" }, "listenerName": { "type": "string", "description": "Listener name\n" }, "port": { "type": "integer", "description": "Listener port\n" }, "protocol": { "type": "string", "description": "Listener protocol. Includes TCP, UDP, HTTP, HTTPS.\n" } }, "type": "object", "required": [ "aclType", "listenerId", "listenerName", "port", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getAclTag:getAclTag": { "properties": { "key": { "type": "string", "description": "User tag key. Length must be 1–128 characters. Supports input of characters in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system automatically removes it.\n" }, "value": { "type": "string", "description": "User tag value. Supports input of characters in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system automatically removes it.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getCertificateTag:getCertificateTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getClbAccessLog:getClbAccessLog": { "properties": { "bucketName": { "type": "string", "description": "Name of the object storage bucket for storing Layer 7 access logs\n" }, "deliveryType": { "type": "string", "description": "Log delivery type. Available values: tos (default): Deliver logs to object storage service TOS. tls: Deliver logs to log service TLS\n" }, "enabled": { "type": "boolean", "description": "Enable access log (Layer 7) delivery to object storage TOS\n" }, "tlsProjectId": { "type": "string", "description": "Log project\n" }, "tlsTopicId": { "type": "string", "description": "Log topic\n" } }, "type": "object", "required": [ "bucketName", "deliveryType", "enabled", "tlsProjectId", "tlsTopicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getClbEip:getClbEip": { "properties": { "bandwidth": { "type": "number", "description": "Peak bandwidth\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID\n" }, "eipBillingType": { "type": "number", "description": "Billing method\n" }, "isp": { "type": "string", "description": "Line type\n" }, "securityProtectionInstanceId": { "type": "number", "description": "Protection package ID\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Security protection type\n" } }, "type": "object", "required": [ "bandwidth", "bandwidthPackageId", "eipBillingType", "isp", "securityProtectionInstanceId", "securityProtectionTypes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getClbEni:getClbEni": { "properties": { "eniAddress": { "type": "string", "description": "Private IP address of the load balancer instance\n" }, "eniId": { "type": "string", "description": "Network interface ID occupied by the load balancer instance\n" } }, "type": "object", "required": [ "eniAddress", "eniId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getClbEnis:getClbEnis": { "properties": { "eniAddress": { "type": "string", "description": "Private IP address of the load balancer instance\n" }, "eniId": { "type": "string", "description": "Network interface ID occupied by the load balancer instance\n" } }, "type": "object", "required": [ "eniAddress", "eniId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getClbIpv6AddressBandwidth:getClbIpv6AddressBandwidth": { "properties": { "bandwidth": { "type": "number", "description": "Peak bandwidth of IPv6 public bandwidth, in Mbps\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID associated with IPv6 public bandwidth\n" }, "billingType": { "type": "number", "description": "Billing type for IPv6 public bandwidth\n" }, "isp": { "type": "string", "description": "Line type of IPv6 public bandwidth\n" }, "networkType": { "type": "string", "description": "Network type of the load balancer instance's IPv6 address\n" } }, "type": "object", "required": [ "bandwidth", "bandwidthPackageId", "billingType", "isp", "networkType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getClbListener:getClbListener": { "properties": { "listenerId": { "type": "string", "description": "Listener ID\n" }, "listenerName": { "type": "string", "description": "Listener name\n" } }, "type": "object", "required": [ "listenerId", "listenerName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getClbServerGroup:getClbServerGroup": { "properties": { "serverGroupId": { "type": "string", "description": "ID of the backend server group in the load balancer instance\n" }, "serverGroupName": { "type": "string", "description": "Name of the backend server group in the load balancer instance\n" } }, "type": "object", "required": [ "serverGroupId", "serverGroupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getClbTag:getClbTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getListenerDomainExtension:getListenerDomainExtension": { "properties": { "certCenterCertificateId": { "type": "string", "description": "Certificate ID of the extended domain name.\n" }, "certificateSource": { "type": "string", "description": "Certificate source for the extended domain name to be added. Value: cert_center: SSL certificate from Volcano Engine Certificate Center. This parameter is required when adding an extended domain name.\n" }, "domain": { "type": "string", "description": "Domain name. Supports both wildcard and exact domain names. Specifications: 1. Must contain at least one '.', and cannot start or end with '.'. 2. Only letters, numbers, '.', '-', and '*' are allowed. 3. Length must be between 1 and 128 characters. 4. Wildcard domain: Use '*' to replace one or more characters. 5. Exact domain: A domain name that strictly follows domain name specifications.\n" }, "domainExtensionId": { "type": "string", "description": "Extended domain name ID.\n" } }, "type": "object", "required": [ "certCenterCertificateId", "certificateSource", "domain", "domainExtensionId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getListenerHealthCheck:getListenerHealthCheck": { "properties": { "domain": { "type": "string", "description": "Domain name for health check. Must be set to the actual address provided by the backend server. This parameter takes effect when Protocol is set to HTTP or HTTPS and HealthCheck.Enabled is on. Must contain at least one period (.), and cannot start or end with a period (.). Each string can include letters, numbers, hyphens (-), and periods (.), with hyphens (-) not allowed at the beginning or end of the string. Length limit: 1 to 128 characters. If this parameter is not provided or no value is specified, the default is empty, meaning CLB uses the private IP address of each backend server for health checks.\n" }, "enabled": { "type": "string", "description": "Whether health check is enabled for the listener. on (default): enabled. off: disabled.\n" }, "healthyThreshold": { "type": "integer", "description": "Health threshold, i.e., the number of consecutive successful health checks. Range: 2–10, default is 3, unit: times.\n" }, "httpCode": { "type": "string", "description": "HTTP status codes for healthy checks. This parameter is effective when Protocol is HTTP or HTTPS and HealthCheck.Enabled is on. Values: http*2xx (default), http*3xx, http*4xx, http*5xx. Separate multiple status codes with a comma (,).\n" }, "interval": { "type": "integer", "description": "Interval for performing health checks. Range: 1–300, default is 2, in seconds.\n" }, "method": { "type": "string", "description": "Listener health check method. GET: server must support the GET method. HEAD: server returns only HEAD header information, which reduces backend overhead, but requires server support for the HEAD method.\n" }, "port": { "type": "integer", "description": "Health check port. Value range: 1–65535.\n" }, "timeout": { "type": "integer", "description": "Health check response timeout. If the backend server does not respond correctly within the specified time, the health check is considered 'abnormal'. Value range: 1 to 60. Default: 2. Unit: seconds.\n" }, "udpExpect": { "type": "string", "description": "Expected response string for health check. Only letters and numbers are allowed, with a maximum length of 64 characters. This parameter takes effect when Protocol is set to UDP and HealthCheck.Enabled is set to on. HealthCheck.UdpRequest and HealthCheck.UdpExpect must either both be empty or both be non-empty.\n" }, "udpRequest": { "type": "string", "description": "Request string for performing health checks. Only letters and numbers are allowed, with a maximum length of 64 characters. This parameter takes effect when Protocol is set to UDP and HealthCheck.Enabled is set to on. The values of HealthCheck.UdpRequest and HealthCheck.UdpExpect must either both be empty or both be non-empty.\n" }, "unhealthyThreshold": { "type": "integer", "description": "Unhealthy threshold, which is the number of consecutive health check failures. Value range: 2–10. Default: 3. Unit: occurrences.\n" }, "uri": { "type": "string", "description": "Health check path. Must be configured as the actual address provided by the backend server. This parameter takes effect when Protocol is set to HTTP or HTTPS and HealthCheck.Enabled is on. Must start with '/'. Only letters, digits, hyphens (-), underscores (_), slashes (/), periods (.), percent signs (%), question marks (?), #, \u0026, and equals signs (=) are allowed. Length: 1–128 characters. If not specified or no value is provided, the default is '/'.\n" } }, "type": "object", "required": [ "domain", "enabled", "healthyThreshold", "httpCode", "interval", "method", "port", "timeout", "udpExpect", "udpRequest", "unhealthyThreshold", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getListenerTag:getListenerTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Length range: 1–128 characters. Supports input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system automatically removes it.\n" }, "value": { "type": "string", "description": "Tag value for user tags. Supports input of characters from any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system will automatically remove it.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getNlbAccessLog:getNlbAccessLog": { "properties": { "accessLogEnabled": { "type": "boolean", "description": "Enable access logs. true: yes. false: no.\n" }, "projectId": { "type": "string", "description": "Log project ID.\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" } }, "type": "object", "required": [ "accessLogEnabled", "projectId", "topicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getNlbListenerHealth:getNlbListenerHealth": { "properties": { "instanceId": { "type": "string", "description": "Backend server instance ID or IP address\n" }, "ip": { "type": "string", "description": "Backend server IP address\n" }, "port": { "type": "integer", "description": "Port on which the backend server provides services\n" }, "serverId": { "type": "string", "description": "Backend server ID\n" }, "serverType": { "type": "string", "description": "Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)\n" }, "status": { "type": "string", "description": "Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)\n" }, "updatedTime": { "type": "string", "description": "Last update time of health status\n" }, "zoneId": { "type": "string", "description": "Zone ID where the backend server receives traffic\n" } }, "type": "object", "required": [ "instanceId", "ip", "port", "serverId", "serverType", "status", "updatedTime", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getNlbListenerTag:getNlbListenerTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getNlbSecurityPolicyTag:getNlbSecurityPolicyTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getNlbServerGroupHealthCheck:getNlbServerGroupHealthCheck": { "properties": { "domain": { "type": "string", "description": "Health check domain name\n" }, "enabled": { "type": "boolean", "description": "Enable health check\n" }, "healthyThreshold": { "type": "integer", "description": "Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'\n" }, "httpCode": { "type": "string", "description": "HTTP status codes indicating a healthy health check.\n" }, "interval": { "type": "integer", "description": "Health check interval, range: 1–300 seconds, default: 10 seconds.\n" }, "method": { "type": "string", "description": "Health check request method\n" }, "port": { "type": "integer", "description": "Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified\n" }, "timeout": { "type": "integer", "description": "Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'\n" }, "type": { "type": "string", "description": "Health check protocol type. Options: TCP (default), HTTP, UDP\n" }, "udpExpect": { "type": "string", "description": "UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.\n" }, "udpRequest": { "type": "string", "description": "Expected response string for UDP health check\n" }, "unhealthyThreshold": { "type": "integer", "description": "Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal\n" }, "uri": { "type": "string", "description": "Health check path\n" } }, "type": "object", "required": [ "domain", "enabled", "healthyThreshold", "httpCode", "interval", "method", "port", "timeout", "type", "udpExpect", "udpRequest", "unhealthyThreshold", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getNlbServerGroupServer:getNlbServerGroupServer": { "properties": { "description": { "type": "string", "description": "Description of the backend server, default is an empty string.\n" }, "instanceId": { "type": "string", "description": "Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.\n" }, "ip": { "type": "string", "description": "Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.\n" }, "port": { "type": "integer", "description": "Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.\n" }, "serverId": { "type": "string", "description": "Backend server ID\n" }, "type": { "type": "string", "description": "Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.\n" }, "weight": { "type": "integer", "description": "Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.\n" }, "zoneId": { "type": "string", "description": "Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone\n" } }, "type": "object", "required": [ "description", "instanceId", "ip", "port", "serverId", "type", "weight", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getNlbServerGroupTag:getNlbServerGroupTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getNlbTag:getNlbTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getNlbZoneMapping:getNlbZoneMapping": { "properties": { "eniId": { "type": "string", "description": "Network interface card ID.\n" }, "ipv4Address": { "type": "string", "description": "Private IPv4 VIP address of the NLB instance. If this parameter is not provided, the system automatically assigns an available IPv4 address from the subnet.\n" }, "ipv4EipAddress": { "type": "string", "description": "Public IPv4 EIP address of the NLB instance.\n" }, "ipv4EipId": { "type": "string", "description": "Public IPv4 EIP ID of the NLB instance.\n" }, "ipv4HcStatus": { "type": "string", "description": "Health status of the NLB instance's private IPv4 address. Healthy: healthy. Unhealthy: abnormal.\n" }, "ipv4LocalAddresses": { "type": "array", "items": { "type": "string" }, "description": "Private IPv4 LIP address of the NLB instance.\n" }, "ipv6Address": { "type": "string", "description": "Private IPv6 VIP address of the NLB instance.\n" }, "ipv6EipId": { "type": "string", "description": "ID of the IPv6 public bandwidth associated with the NLB instance.\n" }, "ipv6HcStatus": { "type": "string", "description": "Health status of the NLB instance's private IPv6 address. Healthy: healthy. Unhealthy: abnormal.\n" }, "ipv6LocalAddresses": { "type": "array", "items": { "type": "string" }, "description": "Private IPv6 LIP address of the NLB instance.\n" }, "subnetId": { "type": "string", "description": "Subnet ID to which the NLB instance belongs.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID to which the NLB instance belongs.\n" } }, "type": "object", "required": [ "eniId", "ipv4Address", "ipv4EipAddress", "ipv4EipId", "ipv4HcStatus", "ipv4LocalAddresses", "ipv6Address", "ipv6EipId", "ipv6HcStatus", "ipv6LocalAddresses", "subnetId", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getRuleRedirectConfig:getRuleRedirectConfig": { "properties": { "host": { "type": "string", "description": "The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.\n" }, "path": { "type": "string", "description": "Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '\u0026', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.\n" }, "port": { "type": "string", "description": "Port for forwarding rule redirection. Value range: 1~65535.\n" }, "protocol": { "type": "string", "description": "Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).\n" }, "statusCode": { "type": "string", "description": "Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.\n" } }, "type": "object", "required": [ "host", "path", "port", "protocol", "statusCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getRuleTag:getRuleTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getServerGroupListener:getServerGroupListener": { "properties": { "listenerId": { "type": "string", "description": "Listener ID.\n" } }, "type": "object", "required": [ "listenerId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getServerGroupServer:getServerGroupServer": { "properties": { "anyPortEnabled": { "type": "string", "description": "Enable all-port forwarding. on: enabled. off (default): disabled.\n" }, "description": { "type": "string", "description": "Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "instanceId": { "type": "string", "description": "Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.\n" }, "ip": { "type": "string", "description": "Private IP address of the backend server. Use '\u0026' to separate multiple backend server IP addresses.\n" }, "port": { "type": "integer", "description": "Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.\n" }, "serverId": { "type": "string", "description": "Backend server ID.\n" }, "type": { "type": "string", "description": "Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.\n" }, "weight": { "type": "integer", "description": "Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.\n" } }, "type": "object", "required": [ "anyPortEnabled", "description", "instanceId", "ip", "port", "serverId", "type", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:clb/getServerGroupTag:getServerGroupTag": { "properties": { "key": { "type": "string", "description": "Information about bound tag keys.\n" }, "value": { "type": "string", "description": "Bound tag value information.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudidentity/GroupMember:GroupMember": { "properties": { "userId": { "type": "string", "description": "User ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "userId" ] } } }, "volcenginecc:cloudidentity/PermissionSetPermissionPolicy:PermissionSetPermissionPolicy": { "properties": { "permissionPolicyDocument": { "type": "string", "description": "Policy syntax content. Refer to policy syntax documentation\n" }, "permissionPolicyName": { "type": "string", "description": "Policy Name\n" }, "permissionPolicyType": { "type": "string", "description": "Policy Type: System or Inline\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "permissionPolicyDocument", "permissionPolicyName", "permissionPolicyType" ] } } }, "volcenginecc:cloudidentity/getGroupMember:getGroupMember": { "properties": { "description": { "type": "string", "description": "User Description\n" }, "displayName": { "type": "string", "description": "User Display Name\n" }, "email": { "type": "string", "description": "User Email\n" }, "identityType": { "type": "string", "description": "User Identity Type\n" }, "joinTime": { "type": "string", "description": "User Group Join Time\n" }, "phone": { "type": "string", "description": "User Phone Number\n" }, "source": { "type": "string", "description": "User Source\n" }, "userId": { "type": "string", "description": "User ID\n" }, "userName": { "type": "string", "description": "Username\n" } }, "type": "object", "required": [ "description", "displayName", "email", "identityType", "joinTime", "phone", "source", "userId", "userName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudidentity/getPermissionSetPermissionPolicy:getPermissionSetPermissionPolicy": { "properties": { "createdTime": { "type": "string", "description": "Policy Creation Time\n" }, "permissionPolicyDocument": { "type": "string", "description": "Policy syntax content. Refer to policy syntax documentation\n" }, "permissionPolicyName": { "type": "string", "description": "Policy Name\n" }, "permissionPolicyType": { "type": "string", "description": "Policy Type: System or Inline\n" } }, "type": "object", "required": [ "createdTime", "permissionPolicyDocument", "permissionPolicyName", "permissionPolicyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/RuleCondition:RuleCondition": { "properties": { "comparisonOperator": { "type": "string", "description": "Comparison operators. Supports standard threshold alerting: \u003e, \u003e=, \u003c, \u003c=, !=, =, as well as the following period-over-period alerting: last*period*increase*pct: Increased compared to last period. last*period*decrease*pct: Decreased compared to last period. last*period*abs*pct: Increased or decreased compared to last period. last*day*increase*pct: Increased compared to the same period yesterday. last*day*decrease*pct: Decreased compared to the same period yesterday. last*day*abs*pct: Increased or decreased compared to the same period yesterday. last*week*increase*pct: Increased compared to the same period last week. last*week*decrease*pct: Decreased compared to the same period last week. last*week*abs_pct: Increased or decreased compared to the same period last week.\n" }, "metricName": { "type": "string", "description": "Monitoring metric name. For details, see MetricName for each product in Cloud Monitoring Metric Query.\n" }, "metricUnit": { "type": "string", "description": "Unit of the monitoring metric. For details, see MetricUnit for each product in Cloud Monitoring Metric Query. For period-over-period alerting, MetricUnit must be set to \"Percent.\" Whether IEC is included in MetricUnit indicates different base values: With IEC: base is 1024; Without IEC: base is 1000.\n" }, "period": { "type": "string", "description": "Statistical period for monitoring metrics. For details, see Period for each product in Cloud Monitoring Metric Query.\n" }, "statistics": { "type": "string", "description": "Statistical method. Options: avg: average, max: maximum, min: minimum. The statistical method is applied to data within the detection time period. For example, the default detection time span is 1 minute. If the statistical method is avg, the average value of data within 1 minute is used.\n" }, "threshold": { "type": "string", "description": "Metric threshold. Supports positive numbers or 0. Up to three decimal places allowed.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "comparisonOperator", "metricName", "metricUnit", "period", "statistics", "threshold" ] } } }, "volcenginecc:cloudmonitor/RuleDimensionConditions:RuleDimensionConditions": { "properties": { "metaCondition": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleDimensionConditionsMetaCondition:RuleDimensionConditionsMetaCondition", "description": "Condition for selecting alert objects based on resource name. Required when Type is meta.\n" }, "projectCondition": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleDimensionConditionsProjectCondition:RuleDimensionConditionsProjectCondition", "description": "Condition for selecting alert targets by project. Required when Type is project.\n" }, "tagCondition": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleDimensionConditionsTagCondition:RuleDimensionConditionsTagCondition", "description": "Condition for selecting alert objects by tag. Required when Type is tag.\n" }, "type": { "type": "string", "description": "Dimensions type. Values: project: Select alert targets by project. tag: Select alert targets by tag. meta: Select alert targets by resource name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "metaCondition", "projectCondition", "tagCondition", "type" ] } } }, "volcenginecc:cloudmonitor/RuleDimensionConditionsMetaCondition:RuleDimensionConditionsMetaCondition": { "properties": { "allDimensions": { "type": "boolean", "description": "Whether all resources are included. true: All resources. false: Partial resources.\n" }, "condition": { "type": "string", "description": "Condition. and: All conditions met. or: Any condition met.\n" }, "metas": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleDimensionConditionsMetaConditionMeta:RuleDimensionConditionsMetaConditionMeta" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allDimensions", "condition", "metas" ] } } }, "volcenginecc:cloudmonitor/RuleDimensionConditionsMetaConditionMeta:RuleDimensionConditionsMetaConditionMeta": { "properties": { "comparator": { "type": "string", "description": "Tag match operator. contain: Contains not*contain: Does not contain prefix*match: Prefix match suffix*match: Suffix match equal: Equals not*equal: Does not equal exist: Exists.\n" }, "key": { "type": "string", "description": "Tag key.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Tag value (Value). When Comparator is exist, includes all Values corresponding to the Key and does not support input. When Comparator is equal or not*equal, supports multiple Value inputs. When Comparator is contain, not*contain, prefix*match, or suffix*match, only one Value can be entered.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "comparator", "key", "values" ] } } }, "volcenginecc:cloudmonitor/RuleDimensionConditionsProjectCondition:RuleDimensionConditionsProjectCondition": { "properties": { "projects": { "type": "array", "items": { "type": "string" }, "description": "Project name list, in array format. Separate multiple values with commas.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "projects" ] } } }, "volcenginecc:cloudmonitor/RuleDimensionConditionsTagCondition:RuleDimensionConditionsTagCondition": { "properties": { "condition": { "type": "string", "description": "Condition. and: All conditions met. or: Any condition met.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleDimensionConditionsTagConditionTag:RuleDimensionConditionsTagConditionTag" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "tags" ] } } }, "volcenginecc:cloudmonitor/RuleDimensionConditionsTagConditionTag:RuleDimensionConditionsTagConditionTag": { "properties": { "comparator": { "type": "string", "description": "Tag match operator. contain: Contains not*contain: Does not contain prefix*match: Prefix match suffix*match: Suffix match equal: Equals not*equal: Does not equal exist: Exists.\n" }, "key": { "type": "string", "description": "Tag key.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Tag value (Value). When Comparator is exist, includes all Values corresponding to the Key and does not support input. When Comparator is equal or not*equal, supports multiple Value inputs. When Comparator is contain, not*contain, prefix*match, or suffix*match, only one Value can be entered.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "comparator", "key", "values" ] } } }, "volcenginecc:cloudmonitor/RuleLevelCondition:RuleLevelCondition": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleLevelConditionCondition:RuleLevelConditionCondition" } }, "level": { "type": "string", "description": "Alert notification level. Options: notice: notification, warning: warning, critical: critical, recovery: recovery.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditions", "level" ] } } }, "volcenginecc:cloudmonitor/RuleLevelConditionCondition:RuleLevelConditionCondition": { "properties": { "comparisonOperator": { "type": "string", "description": "Comparison operators. Supports standard threshold alerting: \u003e, \u003e=, \u003c, \u003c=, !=, =, as well as the following period-over-period alerting: last*period*increase*pct: Increased compared to last period. last*period*decrease*pct: Decreased compared to last period. last*period*abs*pct: Increased or decreased compared to last period. last*day*increase*pct: Increased compared to the same period yesterday. last*day*decrease*pct: Decreased compared to the same period yesterday. last*day*abs*pct: Increased or decreased compared to the same period yesterday. last*week*increase*pct: Increased compared to the same period last week. last*week*decrease*pct: Decreased compared to the same period last week. last*week*abs_pct: Increased or decreased compared to the same period last week.\n" }, "displayName": { "type": "string", "description": "Metric display name.\n" }, "metricName": { "type": "string", "description": "Monitoring metric name. For details, see MetricName for each product in Cloud Monitoring Metric Query.\n" }, "metricUnit": { "type": "string", "description": "Unit of the monitoring metric. For details, see MetricUnit for each product in Cloud Monitoring Metric Query. For period-over-period alerting, MetricUnit must be set to \"Percent.\" Whether IEC is included in MetricUnit indicates different base values: With IEC: base is 1024; Without IEC: base is 1000.\n" }, "period": { "type": "string", "description": "Statistical period for monitoring metrics. For details, see Period for each product in Cloud Monitoring Metric Query.\n" }, "statistics": { "type": "string", "description": "Statistical method. Options: avg: average, max: maximum, min: minimum. The statistical method is applied to data within the detection time period. For example, the default detection time span is 1 minute. If the statistical method is avg, the average value of data within 1 minute is used.\n" }, "threshold": { "type": "string", "description": "Metric threshold. Supports positive numbers or 0. Up to three decimal places allowed.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "comparisonOperator", "displayName", "metricName", "metricUnit", "period", "statistics", "threshold" ] } } }, "volcenginecc:cloudmonitor/RuleNoData:RuleNoData": { "properties": { "enable": { "type": "boolean", "description": "Enable no data alert. Values: true: enable no data alert. false (default): disable no data alert.\n" }, "evaluationCount": { "type": "integer", "description": "No data alert trigger threshold. If no data is reported within the configured threshold period, a no data alert will be triggered. When Enable is set to true, this field is required. Integer format; value range is 3–20.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enable", "evaluationCount" ] } } }, "volcenginecc:cloudmonitor/RuleNotifyTemplate:RuleNotifyTemplate": { "properties": { "channel": { "type": "string", "description": "Notification channel. Options: email: Email sms: SMS phone: Phone feishu: Feishu dingtalk: DingTalk wecom: WeCom slack: Slack api: Callback URL.\n" }, "notifyTemplateId": { "type": "string", "description": "Notification template ID. Note: Each notification channel supports only one notification template ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "channel", "notifyTemplateId" ] } } }, "volcenginecc:cloudmonitor/RuleOriginalDimensions:RuleOriginalDimensions": { "properties": { "key": { "type": "string", "description": "Metric Dimension name, such as ResourceID, NodeName, etc. Dimension names vary by cloud product. For details, see Cloud Monitoring Metric Query. ResourceID is required, and its capitalization must match Cloud Monitoring Metric Query. Supports multiple Dimension names and grouping by multiple Dimension names. For example: If you only enter ResourceID, the system groups alerts by ResourceID. If you enter both ResourceID and NodeName, the system first groups alerts by ResourceID, then groups within each ResourceID group by NodeName.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Metric Dimension values, in array format. Separate multiple values with commas. Wildcard * can be used to select all instance values. For example: [\"*\"] .\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "values" ] } } }, "volcenginecc:cloudmonitor/RuleRecoveryNotify:RuleRecoveryNotify": { "properties": { "enable": { "type": "boolean", "description": "Enable alert recovery notification. Options: true: (default) enable alert recovery notification, false: disable alert recovery notification.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enable" ] } } }, "volcenginecc:cloudmonitor/RuleTag:RuleTag": { "properties": { "key": { "type": "string", "description": "Tag key. Supports Chinese, uppercase and lowercase English letters, numbers, and spaces. The following special characters are supported: _ . : / = + - @. Cannot start or end with a space. volc: and /sys: are system-reserved tag keys. When adding a tag, the tag key cannot start with any case form of volc: or /sys:. Tag key length must be 1–128 characters.\n" }, "value": { "type": "string", "description": "Tag value. Supports Chinese, uppercase and lowercase English letters, numbers, and spaces. The following special characters are supported: _ . : / = + - @. Cannot start or end with a space. Tag key length must be 0–255 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:cloudmonitor/getRuleCondition:getRuleCondition": { "properties": { "comparisonOperator": { "type": "string", "description": "Comparison operators. Supports standard threshold alerting: \u003e, \u003e=, \u003c, \u003c=, !=, =, as well as the following period-over-period alerting: last*period*increase*pct: Increased compared to last period. last*period*decrease*pct: Decreased compared to last period. last*period*abs*pct: Increased or decreased compared to last period. last*day*increase*pct: Increased compared to the same period yesterday. last*day*decrease*pct: Decreased compared to the same period yesterday. last*day*abs*pct: Increased or decreased compared to the same period yesterday. last*week*increase*pct: Increased compared to the same period last week. last*week*decrease*pct: Decreased compared to the same period last week. last*week*abs_pct: Increased or decreased compared to the same period last week.\n" }, "displayName": { "type": "string", "description": "Metric display name.\n" }, "metricName": { "type": "string", "description": "Monitoring metric name. For details, see MetricName for each product in Cloud Monitoring Metric Query.\n" }, "metricUnit": { "type": "string", "description": "Unit of the monitoring metric. For details, see MetricUnit for each product in Cloud Monitoring Metric Query. For period-over-period alerting, MetricUnit must be set to \"Percent.\" Whether IEC is included in MetricUnit indicates different base values: With IEC: base is 1024; Without IEC: base is 1000.\n" }, "period": { "type": "string", "description": "Statistical period for monitoring metrics. For details, see Period for each product in Cloud Monitoring Metric Query.\n" }, "statistics": { "type": "string", "description": "Statistical method. Options: avg: average, max: maximum, min: minimum. The statistical method is applied to data within the detection time period. For example, the default detection time span is 1 minute. If the statistical method is avg, the average value of data within 1 minute is used.\n" }, "threshold": { "type": "string", "description": "Metric threshold. Supports positive numbers or 0. Up to three decimal places allowed.\n" } }, "type": "object", "required": [ "comparisonOperator", "displayName", "metricName", "metricUnit", "period", "statistics", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleDimensionConditions:getRuleDimensionConditions": { "properties": { "metaCondition": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleDimensionConditionsMetaCondition:getRuleDimensionConditionsMetaCondition", "description": "Condition for selecting alert objects based on resource name. Required when Type is meta.\n" }, "projectCondition": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleDimensionConditionsProjectCondition:getRuleDimensionConditionsProjectCondition", "description": "Condition for selecting alert targets by project. Required when Type is project.\n" }, "tagCondition": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleDimensionConditionsTagCondition:getRuleDimensionConditionsTagCondition", "description": "Condition for selecting alert objects by tag. Required when Type is tag.\n" }, "type": { "type": "string", "description": "Dimensions type. Values: project: Select alert targets by project. tag: Select alert targets by tag. meta: Select alert targets by resource name.\n" } }, "type": "object", "required": [ "metaCondition", "projectCondition", "tagCondition", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleDimensionConditionsMetaCondition:getRuleDimensionConditionsMetaCondition": { "properties": { "allDimensions": { "type": "boolean", "description": "Whether all resources are included. true: All resources. false: Partial resources.\n" }, "condition": { "type": "string", "description": "Condition. and: All conditions met. or: Any condition met.\n" }, "metas": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleDimensionConditionsMetaConditionMeta:getRuleDimensionConditionsMetaConditionMeta" }, "description": "Condition. and: All conditions met. or: Any condition met.\n" } }, "type": "object", "required": [ "allDimensions", "condition", "metas" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleDimensionConditionsMetaConditionMeta:getRuleDimensionConditionsMetaConditionMeta": { "properties": { "comparator": { "type": "string", "description": "Tag match operator. contain: Contains not*contain: Does not contain prefix*match: Prefix match suffix*match: Suffix match equal: Equals not*equal: Does not equal exist: Exists.\n" }, "key": { "type": "string", "description": "Tag key.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Tag value (Value). When Comparator is exist, includes all Values corresponding to the Key and does not support input. When Comparator is equal or not*equal, supports multiple Value inputs. When Comparator is contain, not*contain, prefix*match, or suffix*match, only one Value can be entered.\n" } }, "type": "object", "required": [ "comparator", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleDimensionConditionsProjectCondition:getRuleDimensionConditionsProjectCondition": { "properties": { "projects": { "type": "array", "items": { "type": "string" }, "description": "Project name list, in array format. Separate multiple values with commas.\n" } }, "type": "object", "required": [ "projects" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleDimensionConditionsTagCondition:getRuleDimensionConditionsTagCondition": { "properties": { "condition": { "type": "string", "description": "Condition. and: All conditions met. or: Any condition met.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleDimensionConditionsTagConditionTag:getRuleDimensionConditionsTagConditionTag" }, "description": "Tag list. Supports up to 10 tag lists. Tag value cannot exceed 50 characters.\n" } }, "type": "object", "required": [ "condition", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleDimensionConditionsTagConditionTag:getRuleDimensionConditionsTagConditionTag": { "properties": { "comparator": { "type": "string", "description": "Tag match operator. contain: Contains not*contain: Does not contain prefix*match: Prefix match suffix*match: Suffix match equal: Equals not*equal: Does not equal exist: Exists.\n" }, "key": { "type": "string", "description": "Tag key.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Tag value (Value). When Comparator is exist, includes all Values corresponding to the Key and does not support input. When Comparator is equal or not*equal, supports multiple Value inputs. When Comparator is contain, not*contain, prefix*match, or suffix*match, only one Value can be entered.\n" } }, "type": "object", "required": [ "comparator", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleLevelCondition:getRuleLevelCondition": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleLevelConditionCondition:getRuleLevelConditionCondition" }, "description": "Alert severity configuration.\n" }, "level": { "type": "string", "description": "Alert notification level. Options: notice: notification, warning: warning, critical: critical, recovery: recovery.\n" } }, "type": "object", "required": [ "conditions", "level" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleLevelConditionCondition:getRuleLevelConditionCondition": { "properties": { "comparisonOperator": { "type": "string", "description": "Comparison operators. Supports standard threshold alerting: \u003e, \u003e=, \u003c, \u003c=, !=, =, as well as the following period-over-period alerting: last*period*increase*pct: Increased compared to last period. last*period*decrease*pct: Decreased compared to last period. last*period*abs*pct: Increased or decreased compared to last period. last*day*increase*pct: Increased compared to the same period yesterday. last*day*decrease*pct: Decreased compared to the same period yesterday. last*day*abs*pct: Increased or decreased compared to the same period yesterday. last*week*increase*pct: Increased compared to the same period last week. last*week*decrease*pct: Decreased compared to the same period last week. last*week*abs_pct: Increased or decreased compared to the same period last week.\n" }, "displayName": { "type": "string", "description": "Metric display name.\n" }, "metricName": { "type": "string", "description": "Monitoring metric name. For details, see MetricName for each product in Cloud Monitoring Metric Query.\n" }, "metricUnit": { "type": "string", "description": "Unit of the monitoring metric. For details, see MetricUnit for each product in Cloud Monitoring Metric Query. For period-over-period alerting, MetricUnit must be set to \"Percent.\" Whether IEC is included in MetricUnit indicates different base values: With IEC: base is 1024; Without IEC: base is 1000.\n" }, "period": { "type": "string", "description": "Statistical period for monitoring metrics. For details, see Period for each product in Cloud Monitoring Metric Query.\n" }, "statistics": { "type": "string", "description": "Statistical method. Options: avg: average, max: maximum, min: minimum. The statistical method is applied to data within the detection time period. For example, the default detection time span is 1 minute. If the statistical method is avg, the average value of data within 1 minute is used.\n" }, "threshold": { "type": "string", "description": "Metric threshold. Supports positive numbers or 0. Up to three decimal places allowed.\n" } }, "type": "object", "required": [ "comparisonOperator", "displayName", "metricName", "metricUnit", "period", "statistics", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleNoData:getRuleNoData": { "properties": { "enable": { "type": "boolean", "description": "Enable no data alert. Values: true: enable no data alert. false (default): disable no data alert.\n" }, "evaluationCount": { "type": "integer", "description": "No data alert trigger threshold. If no data is reported within the configured threshold period, a no data alert will be triggered. When Enable is set to true, this field is required. Integer format; value range is 3–20.\n" } }, "type": "object", "required": [ "enable", "evaluationCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleNotifyTemplate:getRuleNotifyTemplate": { "properties": { "channel": { "type": "string", "description": "Notification channel. Options: email: Email sms: SMS phone: Phone feishu: Feishu dingtalk: DingTalk wecom: WeCom slack: Slack api: Callback URL.\n" }, "notifyTemplateId": { "type": "string", "description": "Notification template ID. Note: Each notification channel supports only one notification template ID.\n" } }, "type": "object", "required": [ "channel", "notifyTemplateId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleOriginalDimensions:getRuleOriginalDimensions": { "properties": { "key": { "type": "string", "description": "Metric Dimension name, such as ResourceID, NodeName, etc. Dimension names vary by cloud product. For details, see Cloud Monitoring Metric Query. ResourceID is required, and its capitalization must match Cloud Monitoring Metric Query. Supports multiple Dimension names and grouping by multiple Dimension names. For example: If you only enter ResourceID, the system groups alerts by ResourceID. If you enter both ResourceID and NodeName, the system first groups alerts by ResourceID, then groups within each ResourceID group by NodeName.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Metric Dimension values, in array format. Separate multiple values with commas. Wildcard * can be used to select all instance values. For example: [\"*\"] .\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleRecoveryNotify:getRuleRecoveryNotify": { "properties": { "enable": { "type": "boolean", "description": "Enable alert recovery notification. Options: true: (default) enable alert recovery notification, false: disable alert recovery notification.\n" } }, "type": "object", "required": [ "enable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cloudmonitor/getRuleTag:getRuleTag": { "properties": { "key": { "type": "string", "description": "Tag key. Supports Chinese, uppercase and lowercase English letters, numbers, and spaces. The following special characters are supported: _ . : / = + - @. Cannot start or end with a space. volc: and /sys: are system-reserved tag keys. When adding a tag, the tag key cannot start with any case form of volc: or /sys:. Tag key length must be 1–128 characters.\n" }, "value": { "type": "string", "description": "Tag value. Supports Chinese, uppercase and lowercase English letters, numbers, and spaces. The following special characters are supported: _ . : / = + - @. Cannot start or end with a space. Tag key length must be 0–255 characters.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:config/assumeRole:assumeRole": { "properties": { "assumeRoleTrn": { "type": "string", "description": "he TRN of the role to assume.\n" }, "durationSeconds": { "type": "integer", "description": "The duration of the session when making the AssumeRole call. Its value ranges from 900 to 43200(seconds), and default is 3600 seconds.\n" }, "policy": { "type": "string", "description": "A more restrictive policy when making the AssumeRole call\n" } }, "type": "object", "required": [ "assumeRoleTrn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:config/endpoints:endpoints": { "properties": { "cloudcontrolapi": { "type": "string", "description": "Use this to override the default Cloud Control API service endpoint URL\n" }, "sts": { "type": "string", "description": "Use this to override the default STS service endpoint URL\n" } }, "type": "object" }, "volcenginecc:cr/RegistryEndpoint:RegistryEndpoint": { "properties": { "aclPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cr/RegistryEndpointAclPolicy:RegistryEndpointAclPolicy" } }, "enabled": { "type": "boolean", "description": "Whether to enable the public endpoint. Options: false: not enabled; true: enabled. Default is false\n" }, "status": { "type": "string", "description": "Current status of the public endpoint. Parameter values: Enabling: enabling; Enabled: enabled; Disabling: disabling; Updating: updating; Failed: failed; Disabled: disabled\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "aclPolicies", "enabled", "status" ] } } }, "volcenginecc:cr/RegistryEndpointAclPolicy:RegistryEndpointAclPolicy": { "properties": { "description": { "type": "string", "description": "IP entry address\n" }, "entry": { "type": "string", "description": "IP entry description\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "entry" ] } } }, "volcenginecc:cr/RegistryProxyCache:RegistryProxyCache": { "properties": { "type": { "type": "string", "description": "Instance types supported by ProxyCache. Parameter value description: DockerHub: DockerHub image repository.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "volcenginecc:cr/RegistryStatus:RegistryStatus": { "properties": { "conditions": { "type": "array", "items": { "type": "string" }, "description": "Creating, [ Progressing ]: Creating. Running, [ Ok ]: Running. Running, [ Degraded ]: Running. Stopped, [ Balance ]: Suspended due to overdue payment. Stopped, [ Released ]: Pending recycle. Stopped, [ Released, Balance ]: Suspended due to overdue payment. Starting, [ Progressing ]: Starting. Deleting, [ Progressing ]: Deleting. Failed, [ Unknown ]: Error.\n" }, "phase": { "type": "string", "description": "Creating, [ Progressing ]: Creating. Running, [ Ok ]: Running. Running, [ Degraded ]: Running. Stopped, [ Balance ]: Suspended due to overdue payment. Stopped, [ Released ]: Pending recycle. Stopped, [ Released, Balance ]: Suspended due to overdue payment. Starting, [ Progressing ]: Starting. Deleting, [ Progressing ]: Deleting. Failed, [ Unknown ]: Error.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditions", "phase" ] } } }, "volcenginecc:cr/RegistryTag:RegistryTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "List of tag values\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:cr/getRegistryEndpoint:getRegistryEndpoint": { "properties": { "aclPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cr/getRegistryEndpointAclPolicy:getRegistryEndpointAclPolicy" }, "description": "Public IP allowlist\n" }, "enabled": { "type": "boolean", "description": "Whether to enable the public endpoint. Options: false: not enabled; true: enabled. Default is false\n" }, "status": { "type": "string", "description": "Current status of the public endpoint. Parameter values: Enabling: enabling; Enabled: enabled; Disabling: disabling; Updating: updating; Failed: failed; Disabled: disabled\n" } }, "type": "object", "required": [ "aclPolicies", "enabled", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cr/getRegistryEndpointAclPolicy:getRegistryEndpointAclPolicy": { "properties": { "description": { "type": "string", "description": "IP entry address\n" }, "entry": { "type": "string", "description": "IP entry description\n" } }, "type": "object", "required": [ "description", "entry" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cr/getRegistryProxyCache:getRegistryProxyCache": { "properties": { "type": { "type": "string", "description": "Instance types supported by ProxyCache. Parameter value description: DockerHub: DockerHub image repository.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cr/getRegistryStatus:getRegistryStatus": { "properties": { "conditions": { "type": "array", "items": { "type": "string" }, "description": "Creating, [ Progressing ]: Creating. Running, [ Ok ]: Running. Running, [ Degraded ]: Running. Stopped, [ Balance ]: Suspended due to overdue payment. Stopped, [ Released ]: Pending recycle. Stopped, [ Released, Balance ]: Suspended due to overdue payment. Starting, [ Progressing ]: Starting. Deleting, [ Progressing ]: Deleting. Failed, [ Unknown ]: Error.\n" }, "phase": { "type": "string", "description": "Creating, [ Progressing ]: Creating. Running, [ Ok ]: Running. Running, [ Degraded ]: Running. Stopped, [ Balance ]: Suspended due to overdue payment. Stopped, [ Released ]: Pending recycle. Stopped, [ Released, Balance ]: Suspended due to overdue payment. Starting, [ Progressing ]: Starting. Deleting, [ Progressing ]: Deleting. Failed, [ Unknown ]: Error.\n" } }, "type": "object", "required": [ "conditions", "phase" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:cr/getRegistryTag:getRegistryTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "List of tag values\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:directconnect/DirectConnectGatewayAssociateCen:DirectConnectGatewayAssociateCen": { "properties": { "cenId": { "type": "string", "description": "ID of CEN.\n" }, "cenOwnerId": { "type": "string", "description": "User ID of CEN.\n" }, "cenStatus": { "type": "string", "description": "Status of the instance in CEN. Attaching: attaching. Attached: attached.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cenId", "cenOwnerId", "cenStatus" ] } } }, "volcenginecc:directconnect/DirectConnectGatewayAssociateEic:DirectConnectGatewayAssociateEic": { "properties": { "eicId": { "type": "string", "description": "ID of EIC.\n" }, "eicOwnerId": { "type": "string", "description": "User ID of EIC.\n" }, "eicStatus": { "type": "string", "description": "Status of the instance in EIC.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "eicId", "eicOwnerId", "eicStatus" ] } } }, "volcenginecc:directconnect/DirectConnectGatewayTag:DirectConnectGatewayTag": { "properties": { "key": { "type": "string", "description": "User label tag key. Length must be between 1 and 128 characters.\n" }, "value": { "type": "string", "description": "User label tag value. Length must be between 0 and 256 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:directconnect/getDirectConnectGatewayAssociateCen:getDirectConnectGatewayAssociateCen": { "properties": { "cenId": { "type": "string", "description": "ID of CEN.\n" }, "cenOwnerId": { "type": "string", "description": "User ID of CEN.\n" }, "cenStatus": { "type": "string", "description": "Status of the instance in CEN. Attaching: attaching. Attached: attached.\n" } }, "type": "object", "required": [ "cenId", "cenOwnerId", "cenStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:directconnect/getDirectConnectGatewayAssociateEic:getDirectConnectGatewayAssociateEic": { "properties": { "eicId": { "type": "string", "description": "ID of EIC.\n" }, "eicOwnerId": { "type": "string", "description": "User ID of EIC.\n" }, "eicStatus": { "type": "string", "description": "Status of the instance in EIC.\n" } }, "type": "object", "required": [ "eicId", "eicOwnerId", "eicStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:directconnect/getDirectConnectGatewayTag:getDirectConnectGatewayTag": { "properties": { "key": { "type": "string", "description": "User label tag key. Length must be between 1 and 128 characters.\n" }, "value": { "type": "string", "description": "User label tag value. Length must be between 0 and 256 characters.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:dns/ZoneTag:ZoneTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:dns/getZoneTag:getZoneTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/CommandParameterDefinition:CommandParameterDefinition": { "properties": { "decimalPrecision": { "type": "integer", "description": "Allowed decimal places for custom parameter (number).\n" }, "defaultValue": { "type": "string", "description": "Default value for custom parameter.\n" }, "maxLength": { "type": "integer", "description": "Maximum length for custom parameter (string).\n" }, "maxValue": { "type": "string", "description": "Maximum value for custom parameter (number).\n" }, "minLength": { "type": "integer", "description": "Minimum length for custom parameter (string).\n" }, "minValue": { "type": "string", "description": "Minimum value for custom parameter (number).\n" }, "name": { "type": "string", "description": "Custom parameter name. Define it in the script using {{Param}}. Each parameter name must not exceed 64 bytes. Follow Shell variable naming rules: combinations of a-z, A-Z, 0-9, -, and _. The first character cannot be a digit. No spaces allowed; underscores can be used instead.\n" }, "required": { "type": "boolean", "description": "Whether it is required.\n" }, "type": { "type": "string", "description": "Custom parameter type. Values: String: Indicates the custom parameter type is String (string type). Digit: Indicates the custom parameter type is Digit (numeric type).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "decimalPrecision", "defaultValue", "maxLength", "maxValue", "minLength", "minValue", "name", "required", "type" ] } } }, "volcenginecc:ecs/CommandTag:CommandTag": { "properties": { "key": { "type": "string", "description": "User tag key. Naming rules: must not start with any case combination of volc: or sys:. Only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.\n" }, "value": { "type": "string", "description": "User tag value. Naming rules: only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ecs/DeploymentSetCapacity:DeploymentSetCapacity": { "properties": { "availableCount": { "type": "integer", "description": "You can also include the number of ECS instances in the current deployment set within this availability zone.\n" }, "usedCount": { "type": "integer", "description": "Number of ECS instances in the deployment set that belong to this availability zone.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID. Only returns the availability zone ID for ECS instances in the deployment set.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "availableCount", "usedCount", "zoneId" ] } } }, "volcenginecc:ecs/HpcClusterTag:HpcClusterTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ecs/ImageDetectionResults:ImageDetectionResults": { "properties": { "detectionStatus": { "type": "string", "description": "Check status. Options: Finished (completed), Processing (in progress).\n" }, "items": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/ImageDetectionResultsItem:ImageDetectionResultsItem" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "detectionStatus", "items" ] } } }, "volcenginecc:ecs/ImageDetectionResultsItem:ImageDetectionResultsItem": { "properties": { "name": { "type": "string", "description": "Check item name\n" }, "result": { "type": "string", "description": "Result for this check item.\n" }, "riskCode": { "type": "string", "description": "Risk description code\n" }, "riskLevel": { "type": "string", "description": "Risk level. If this parameter is empty, it means no risk\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "result", "riskCode", "riskLevel" ] } } }, "volcenginecc:ecs/ImageImportImage:ImageImportImage": { "properties": { "importDataVolumes": { "type": "array", "items": { "type": "string" }, "description": "Data disk files included in the custom image, at the TOS bucket URL.\n" }, "url": { "type": "string", "description": "System disk files included in the custom image, at the TOS bucket URL.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "importDataVolumes", "url" ] } } }, "volcenginecc:ecs/ImageSnapshot:ImageSnapshot": { "properties": { "size": { "type": "integer", "description": "Snapshot size (GiB)\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID\n" }, "volumeKind": { "type": "string", "description": "Cloud disk type. system: System disk. data: Data disk.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "size", "snapshotId", "volumeKind" ] } } }, "volcenginecc:ecs/ImageTag:ImageTag": { "properties": { "key": { "type": "string", "description": "Tag key for the image label.\n" }, "value": { "type": "string", "description": "Image tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ecs/InstanceCpuMemory:InstanceCpuMemory": { "properties": { "coreCount": { "type": "integer", "description": "Number of instance cores.\n" }, "cpuNumber": { "type": "integer", "description": "Number of vCPUs for the instance.\n" }, "memorySize": { "type": "integer", "description": "Instance memory size (MB).\n" }, "threadsPerCore": { "type": "integer", "description": "Threads per core for the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "coreCount", "cpuNumber", "memorySize", "threadsPerCore" ] } } }, "volcenginecc:ecs/InstanceEipAddress:InstanceEipAddress": { "properties": { "allocationId": { "type": "string", "description": "Instance allocation ID\n" }, "bandwidthMbps": { "type": "integer", "description": "Maximum bandwidth for public IP. Default value is 1, unit: Mbps.\n - If `ChargeType` is `PayByBandwidth`: value range is 1–500.\n - If `ChargeType` is `PayByTraffic`: value range is 1–200.\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID, used to add a public IP to the shared bandwidth package.\n - You can call the [DescribeBandwidthPackages](https://www.volcengine.com/docs/6623/100685) API to query the shared bandwidth package ID.\n - To add a public IP to a shared bandwidth package, all of the following conditions must be met:\n - Both must have the same security protection type.\n - Both must be in the same region.\n - The public IP must use pay-as-you-go billing.\n - The shared bandwidth package must be IPv4 type.\n" }, "chargeType": { "type": "string", "description": "Public IP billing method. Values:\n - PayByBandwidth (default): Pay-as-you-go—billed by bandwidth cap.\n - PayByTraffic: Pay-as-you-go—billed by actual traffic.\n - PrePaid: Subscription.\n \n **Note:**\n When `InstanceChargeType` is set to `PostPaid`, this parameter cannot be set to `PrePaid`.\n" }, "ipAddress": { "type": "string", "description": "Instance IP address.\n" }, "isp": { "type": "string", "description": "Line type for the public IP. Default is BGP. Values:\n - BGP: BGP (multi-line)\n - If your account has applied for and enabled static single-line permissions, you can use the following values:\n - ChinaMobile: China Mobile static single-line\n - ChinaTelecom: China Telecom static single-line\n - ChinaUnicom: China Unicom static single-line\n - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP.\n - If your account has applied for and enabled static BGP permissions, you can use Static_BGP\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether this resource is released when the instance is released.\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "DDoS Native Protection (Enterprise Edition) ID.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Public IP security protection type.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allocationId", "bandwidthMbps", "bandwidthPackageId", "chargeType", "ipAddress", "isp", "releaseWithInstance", "securityProtectionInstanceId", "securityProtectionTypes" ] } } }, "volcenginecc:ecs/InstanceImage:InstanceImage": { "properties": { "imageId": { "type": "string", "description": "Instance image ID.\n" }, "imageReleaseVersion": { "type": "string", "description": "The image release version of the instance.\n" }, "keepImageCredential": { "type": "boolean", "description": "Whether the instance retains image credentials\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Instance security enhancement policy. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images\n" } }, "type": "object", "required": [ "imageId" ], "language": { "nodejs": { "requiredOutputs": [ "imageId", "imageReleaseVersion", "keepImageCredential", "securityEnhancementStrategy" ] } } }, "volcenginecc:ecs/InstanceKeyPair:InstanceKeyPair": { "properties": { "keyPairId": { "type": "string", "description": "Instance public key\n" }, "keyPairName": { "type": "string", "description": "Instance key pair name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "keyPairId", "keyPairName" ] } } }, "volcenginecc:ecs/InstanceLocalVolume:InstanceLocalVolume": { "properties": { "count": { "type": "integer", "description": "The number of local disks attached to the instance.\n" }, "size": { "type": "integer", "description": "Capacity of each local disk mounted to the instance (GiB).\n" }, "volumeType": { "type": "string", "description": "Local disk type. Values: LOCAL_SSD: SSD local disk. LOCAL_HDD: HDD local disk.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "count", "size", "volumeType" ] } } }, "volcenginecc:ecs/InstanceOperationSystem:InstanceOperationSystem": { "properties": { "name": { "type": "string", "description": "Instance operating system name.\n" }, "type": { "type": "string", "description": "Operating system type of the instance. Linux: Linux system. Windows: Windows system.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "type" ] } } }, "volcenginecc:ecs/InstancePlacement:InstancePlacement": { "properties": { "affinity": { "type": "string", "description": "For ECS instances in economy stop mode, some resources are released after stopping. This parameter indicates whether the ECS instance will remain deployed on the original host when restarted. Values: Host: When restarting an instance in economy stop mode, it will remain on the original host. Default: When restarting an instance in economy stop mode, it will preferentially migrate to a host that supports automatic deployment; if resources are insufficient, it will start on the original host.\n" }, "dedicatedHostClusterId": { "type": "string", "description": "Instance dedicated host cluster ID.\n" }, "dedicatedHostId": { "type": "string", "description": "Dedicated host ID for the instance.\n" }, "tenancy": { "type": "string", "description": "Whether to create the instance on a dedicated host. Values: Default: Create a regular cloud server instance. Host: Create a dedicated host instance. If you do not specify DedicatedHostId, the system automatically selects a dedicated host to place the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "affinity", "dedicatedHostClusterId", "dedicatedHostId", "tenancy" ] } } }, "volcenginecc:ecs/InstancePrimaryNetworkInterface:InstancePrimaryNetworkInterface": { "properties": { "ipv6AddressCount": { "type": "integer", "description": "The number of IPv6 addresses for the instance.\n" }, "ipv6Addresses": { "type": "array", "items": { "type": "string" }, "description": "IPv6 address of the instance.\n" }, "macAddress": { "type": "string", "description": "Instance MAC address.\n" }, "networkInterfaceId": { "type": "string", "description": "The network interface ID of the instance.\n" }, "primaryIpAddress": { "type": "string", "description": "Instance primary IP address\n" }, "privateIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "Instance private IP address.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Instance security group ID\n" }, "subnetId": { "type": "string", "description": "Instance subnet ID.\n" }, "vpcId": { "type": "string", "description": "VPC ID of the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6AddressCount", "ipv6Addresses", "macAddress", "networkInterfaceId", "primaryIpAddress", "privateIpAddresses", "securityGroupIds", "subnetId", "vpcId" ] } } }, "volcenginecc:ecs/InstanceRdmaNetworkInterfaceDetail:InstanceRdmaNetworkInterfaceDetail": { "properties": { "gateway": { "type": "string", "description": "Gateway address.\n" }, "ip": { "type": "string", "description": "IP address\n" }, "mask": { "type": "string", "description": "Subnet mask.\n" }, "switchName": { "type": "string", "description": "Switch name.\n" }, "switchPort": { "type": "string", "description": "Switch port.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "gateway", "ip", "mask", "switchName", "switchPort" ] } } }, "volcenginecc:ecs/InstanceRenewInfo:InstanceRenewInfo": { "properties": { "period": { "type": "integer", "description": "Number of months for renewal. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.\n" }, "periodUnit": { "type": "string", "description": "Time unit for renewal duration, i.e., the unit for the Period parameter. Value: Month (default)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "period", "periodUnit" ] } } }, "volcenginecc:ecs/InstanceSecondaryNetworkInterface:InstanceSecondaryNetworkInterface": { "properties": { "ipv6AddressCount": { "type": "integer", "description": "The number of IPv6 addresses for the instance.\n" }, "ipv6Addresses": { "type": "array", "items": { "type": "string" }, "description": "IPv6 address of the instance.\n" }, "macAddress": { "type": "string", "description": "Instance MAC address.\n" }, "networkInterfaceId": { "type": "string", "description": "The network interface ID of the instance.\n" }, "primaryIpAddress": { "type": "string", "description": "Instance primary IP address\n" }, "privateIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "Instance private IP address.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Instance security group ID\n" }, "subnetId": { "type": "string", "description": "Instance subnet ID.\n" }, "vpcId": { "type": "string", "description": "VPC ID of the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6AddressCount", "ipv6Addresses", "macAddress", "networkInterfaceId", "primaryIpAddress", "privateIpAddresses", "securityGroupIds", "subnetId", "vpcId" ] } } }, "volcenginecc:ecs/InstanceSystemVolume:InstanceSystemVolume": { "properties": { "deleteWithInstance": { "type": "boolean", "description": "Whether the attached resources are deleted along with the instance.\n" }, "extraPerformanceIops": { "type": "integer", "description": "Additional performance IOPS for the instance\n" }, "extraPerformanceThroughputMb": { "type": "integer", "description": "The additional performance throughput of the instance, in MB.\n" }, "extraPerformanceTypeId": { "type": "string", "description": "Type of additional performance. Values:\n Balance: Balanced additional performance\n IOPS: IOPS additional performance\n Throughput: Throughput additional performance\n" }, "size": { "type": "integer", "description": "Instance size, in GiB\n" }, "snapshotId": { "type": "string", "description": "Instance snapshot ID\n" }, "volumeId": { "type": "string", "description": "Instance volume ID.\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. Values:\n PTSSD: Performance SSD.\n ESSD_PL0: Ultra SSD disk, PL0 specification.\n ESSD_FlexPL: Ultra SSD disk, FlexPL specification.\n TSSD_TL0: Throughput SSD disk.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deleteWithInstance", "extraPerformanceIops", "extraPerformanceThroughputMb", "extraPerformanceTypeId", "size", "snapshotId", "volumeId", "volumeType" ] } } }, "volcenginecc:ecs/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Instance key.\n" }, "value": { "type": "string", "description": "Instance value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ecs/InvocationInvocationResult:InvocationInvocationResult": { "properties": { "commandId": { "type": "string", "description": "Command ID.\n" }, "endTime": { "type": "string", "description": "Command execution completion time.\n" }, "errorCode": { "type": "string", "description": "Error codes for command execution failure. TaskDeliveryTimeout: Indicates command delivery timeout. TaskExecutionTimeout: Indicates command execution timeout. TaskExecutionFailed: Indicates command execution failure.\n" }, "errorMessage": { "type": "string", "description": "Error message for command execution failure.\n" }, "exitCode": { "type": "integer", "description": "Exit status code after script execution.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "invocationId": { "type": "string", "description": "Task execution ID.\n" }, "invocationResultId": { "type": "string", "description": "Task execution result ID.\n" }, "invocationResultStatus": { "type": "string", "description": "Command progress status for a single instance.\n" }, "output": { "type": "string", "description": "Output information after command execution, encoded in Base64.\n" }, "startTime": { "type": "string", "description": "Time when the command starts executing in the instance.\n" }, "username": { "type": "string", "description": "User name for executing the command in the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "commandId", "endTime", "errorCode", "errorMessage", "exitCode", "instanceId", "invocationId", "invocationResultId", "invocationResultStatus", "output", "startTime", "username" ] } } }, "volcenginecc:ecs/InvocationParameterDefinition:InvocationParameterDefinition": { "properties": { "decimalPrecision": { "type": "integer", "description": "Allowed number of decimal places for custom parameter values (numeric).\n" }, "defaultValue": { "type": "string", "description": "Default value for custom parameter.\n" }, "maxLength": { "type": "integer", "description": "Maximum length for custom parameter value (string).\n" }, "maxValue": { "type": "string", "description": "Maximum value for custom parameter (numeric).\n" }, "minLength": { "type": "integer", "description": "Minimum length for custom parameter values (string).\n" }, "minValue": { "type": "string", "description": "Minimum value for custom parameter (numeric).\n" }, "name": { "type": "string", "description": "Custom parameter name. Must be defined in the script using {{Param}}.\n" }, "required": { "type": "boolean", "description": "Required. true: Required. false: Optional.\n" }, "type": { "type": "string", "description": "Custom parameter type. String: Indicates custom parameter type is string. Digit: Indicates custom parameter type is numeric.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "decimalPrecision", "defaultValue", "maxLength", "maxValue", "minLength", "minValue", "name", "required", "type" ] } } }, "volcenginecc:ecs/InvocationTag:InvocationTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Naming rules: Cannot start with any combination of 'volc:' or 'sys:' in any case. Can only contain letters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.\n" }, "value": { "type": "string", "description": "User tag value. Naming rules: Only letters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty; length must be between 0 and 256 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ecs/KeypairTag:KeypairTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ecs/LaunchTemplateLaunchTemplateTag:LaunchTemplateLaunchTemplateTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags added to the resource.\n" }, "value": { "type": "string", "description": "User tag value added to the resource\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ecs/LaunchTemplateLaunchTemplateVersion:LaunchTemplateLaunchTemplateVersion": { "properties": { "deploymentSetGroupNumber": { "type": "integer", "description": "When the ECS instance needs to join or adjust the deployment set strategy to the deployment set group high availability strategy (AvailabilityGroup), you can use this parameter to specify the group number of the instance in the deployment set.\n" }, "deploymentSetId": { "type": "string", "description": "Deployment set ID the instance needs to join.\n" }, "description": { "type": "string", "description": "Instance description\n" }, "eip": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionEip:LaunchTemplateLaunchTemplateVersionEip", "description": "Public IP information bound to the instance\n" }, "hostName": { "type": "string", "description": "Instance hostname. For Linux, the hostname length must be 2–59 characters. For Windows, the hostname length must be 2–10 characters.\n" }, "hpcClusterId": { "type": "string", "description": "When creating a high-performance computing GPU instance, please specify the high-performance computing cluster ID.\n" }, "imageId": { "type": "string", "description": "Image ID.\n" }, "imageName": { "type": "string", "description": "Image name.\n" }, "instanceChargeType": { "type": "string", "description": "Billing type for the instance and cloud disk. Options: PostPaid: Pay-as-you-go. PrePaid: Yearly/monthly subscription. Esi: Elastic reservation instance. Segmented: Time-based elastic reservation instance.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "instanceTypeId": { "type": "string", "description": "Instance specification\n" }, "keepImageCredential": { "type": "boolean", "description": "Whether to retain image settings. Values: true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. false (default): Do not retain image settings.\n" }, "keyPairName": { "type": "string", "description": "Key pair bound to the instance.\n" }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionNetworkInterface:LaunchTemplateLaunchTemplateVersionNetworkInterface" } }, "projectName": { "type": "string", "description": "Project associated with the instance.\n" }, "scheduledInstance": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionScheduledInstance:LaunchTemplateLaunchTemplateVersionScheduledInstance", "description": "Elastic reservation order information\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Enable security hardening. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images.\n" }, "spotPriceLimit": { "type": "number", "description": "Maximum hourly price for preemptible instances\n" }, "spotStrategy": { "type": "string", "description": "Preemptible strategy for pay-as-you-go billing. Options: NoSpot: Create a regular pay-as-you-go instance. SpotAsPriceGo: System automatically bids, follows the current market price for preemptible instances. SpotWithPriceLimit: Preemptible instance with a bid limit.\n" }, "suffixIndex": { "type": "integer", "description": "Starting number for the sequential suffix\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionTag:LaunchTemplateLaunchTemplateVersionTag" } }, "uniqueSuffix": { "type": "boolean", "description": "Indicates whether to automatically add sequential suffixes to Hostname and InstanceName when creating multiple instances\n" }, "userData": { "type": "string", "description": "Custom data for the instance.\n" }, "versionDescription": { "type": "string", "description": "Template version description.\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionVolume:LaunchTemplateLaunchTemplateVersionVolume" } }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "zoneId": { "type": "string", "description": "Instance availability zone ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deploymentSetGroupNumber", "deploymentSetId", "description", "eip", "hostName", "hpcClusterId", "imageId", "imageName", "instanceChargeType", "instanceName", "instanceTypeId", "keepImageCredential", "keyPairName", "networkInterfaces", "projectName", "scheduledInstance", "securityEnhancementStrategy", "spotPriceLimit", "spotStrategy", "suffixIndex", "tags", "uniqueSuffix", "userData", "versionDescription", "volumes", "vpcId", "zoneId" ] } } }, "volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionEip:LaunchTemplateLaunchTemplateVersionEip": { "properties": { "bandwidth": { "type": "integer", "description": "Public IP bandwidth cap, unit: Mbps. Value range: 1–200. Default: 1.\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID, indicates adding the public IP to the shared bandwidth package.\n" }, "billingType": { "type": "integer", "description": "Billing method for public IP. Values: 2: Pay-as-you-go—by bandwidth cap. 3: Pay-as-you-go—by actual traffic.\n" }, "isp": { "type": "string", "description": "Line type for the public IP. Options: BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line.\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether the public IP is released with the instance; only applies to pay-as-you-go public IPs\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "Security protection package ID\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Security protection type for public IP. Value: AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS Native Protection (Enterprise Edition) instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "bandwidthPackageId", "billingType", "isp", "releaseWithInstance", "securityProtectionInstanceId", "securityProtectionTypes" ] } } }, "volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionNetworkInterface:LaunchTemplateLaunchTemplateVersionNetworkInterface": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group ID associated with the network interface.\n" }, "subnetId": { "type": "string", "description": "Instance VPC subnet ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "securityGroupIds", "subnetId" ] } } }, "volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionScheduledInstance:LaunchTemplateLaunchTemplateVersionScheduledInstance": { "properties": { "scheduledInstanceDescription": { "type": "string", "description": "Description of the elastic reservation order\n" }, "scheduledInstanceName": { "type": "string", "description": "Name of the elastic reservation order\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "scheduledInstanceDescription", "scheduledInstanceName" ] } } }, "volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionTag:LaunchTemplateLaunchTemplateVersionTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags added to the resource.\n" }, "value": { "type": "string", "description": "User tag value added to the resource\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ecs/LaunchTemplateLaunchTemplateVersionVolume:LaunchTemplateLaunchTemplateVersionVolume": { "properties": { "deleteWithInstance": { "type": "boolean", "description": "Whether the cloud disk is released with the instance\n" }, "extraPerformanceIops": { "type": "integer", "description": "Cloud disk extra IOPS performance size, supported only by ESSD FlexPL data disks, unit: operations/second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. The value ranges for each extra performance type are as follows: IOPS type: 1–50000. Balance type: 1–50000.\n" }, "extraPerformanceThroughputMb": { "type": "integer", "description": "Extra throughput performance size for the cloud disk, in MB/s. Only supported by ESSD FlexPL data disks. This parameter must be set when ExtraPerformanceTypeId is Throughput. Value range: 1–650.\n" }, "extraPerformanceTypeId": { "type": "string", "description": "Type of cloud disk extra performance, supported only by ESSD FlexPL data disks. For more information about extra performance, see Cloud Disk Extra Performance. Values: Balance: Balanced extra performance. IOPS: IOPS extra performance. Throughput: Throughput extra performance.\n" }, "size": { "type": "integer", "description": "Cloud disk size, unit: GB. System disk: ESSD*PL0: 20–2048, PTSSD: 10–500. Data disk: ESSD*PL0: 10–32768, PTSSD: 20–8192\n" }, "snapshotId": { "type": "string", "description": "Create a cloud disk using a snapshot, only supports creating data disks. You can call the DescribeSnapshots API to query the snapshot ID.\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. ESSD_PL0: Ultra-fast SSD PL0. PTSSD: Performance SSD.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deleteWithInstance", "extraPerformanceIops", "extraPerformanceThroughputMb", "extraPerformanceTypeId", "size", "snapshotId", "volumeType" ] } } }, "volcenginecc:ecs/LaunchTemplateVersionEip:LaunchTemplateVersionEip": { "properties": { "bandwidth": { "type": "integer", "description": "Maximum bandwidth for the public IP, measured in Mbps. Value range: 1–200. Default: 1\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID, indicating that the public IP is added to the shared bandwidth package\n" }, "billingType": { "type": "integer", "description": "Billing method for the public IP. Values: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic\n" }, "isp": { "type": "string", "description": "Line type of the public IP. Values: BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether the public IP is released with the instance. Only applies to pay-as-you-go public IPs.\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "Security protection package ID.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Security protection type for public IP. Value: AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "bandwidthPackageId", "billingType", "isp", "releaseWithInstance", "securityProtectionInstanceId", "securityProtectionTypes" ] } } }, "volcenginecc:ecs/LaunchTemplateVersionNetworkInterface:LaunchTemplateVersionNetworkInterface": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group ID associated with the network interface.\n" }, "subnetId": { "type": "string", "description": "Private network subnet ID of the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "securityGroupIds", "subnetId" ] } } }, "volcenginecc:ecs/LaunchTemplateVersionScheduledInstance:LaunchTemplateVersionScheduledInstance": { "properties": { "scheduledInstanceDescription": { "type": "string", "description": "Description of the elastic reservation order\n" }, "scheduledInstanceName": { "type": "string", "description": "Name of the elastic reservation order\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "scheduledInstanceDescription", "scheduledInstanceName" ] } } }, "volcenginecc:ecs/LaunchTemplateVersionTag:LaunchTemplateVersionTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags added to the resource.\n" }, "value": { "type": "string", "description": "Tag value for user tags added to the resource\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:ecs/LaunchTemplateVersionVolume:LaunchTemplateVersionVolume": { "properties": { "deleteWithInstance": { "type": "boolean", "description": "Whether the disk is released with the instance\n" }, "extraPerformanceIops": { "type": "integer", "description": "Extra IOPS performance size for the disk, supported only by ESSD FlexPL data disks, measured in operations per second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. Value ranges for each type: IOPS: 1–50000. Balance: 1–50000\n" }, "extraPerformanceThroughputMb": { "type": "integer", "description": "Additional disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when ExtraPerformanceTypeId is Throughput. Value range: 1–650.\n" }, "extraPerformanceTypeId": { "type": "string", "description": "Type of extra disk performance, supported only by ESSD FlexPL data disks. For more information about extra performance, see Extra Disk Performance. Values: Balance: Balanced extra performance. IOPS: IOPS extra performance. Throughput: Throughput extra performance\n" }, "size": { "type": "integer", "description": "Disk size, measured in GB. System disk: ESSD*PL0: 20–2048, PTSSD: 10–500. Data disk: ESSD*PL0: 10–32768, PTSSD: 20–8192\n" }, "snapshotId": { "type": "string", "description": "Create a cloud disk from a snapshot. Only data disks are supported. You can call the DescribeSnapshots API to query the snapshot ID.\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. ESSD_PL0: Ultra-fast SSD PL0. PTSSD: Performance SSD.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deleteWithInstance", "extraPerformanceIops", "extraPerformanceThroughputMb", "extraPerformanceTypeId", "size", "snapshotId", "volumeType" ] } } }, "volcenginecc:ecs/getCommandParameterDefinition:getCommandParameterDefinition": { "properties": { "decimalPrecision": { "type": "integer", "description": "Allowed decimal places for custom parameter (number).\n" }, "defaultValue": { "type": "string", "description": "Default value for custom parameter.\n" }, "maxLength": { "type": "integer", "description": "Maximum length for custom parameter (string).\n" }, "maxValue": { "type": "string", "description": "Maximum value for custom parameter (number).\n" }, "minLength": { "type": "integer", "description": "Minimum length for custom parameter (string).\n" }, "minValue": { "type": "string", "description": "Minimum value for custom parameter (number).\n" }, "name": { "type": "string", "description": "Custom parameter name. Define it in the script using {{Param}}. Each parameter name must not exceed 64 bytes. Follow Shell variable naming rules: combinations of a-z, A-Z, 0-9, -, and _. The first character cannot be a digit. No spaces allowed; underscores can be used instead.\n" }, "required": { "type": "boolean", "description": "Whether it is required.\n" }, "type": { "type": "string", "description": "Custom parameter type. Values: String: Indicates the custom parameter type is String (string type). Digit: Indicates the custom parameter type is Digit (numeric type).\n" } }, "type": "object", "required": [ "decimalPrecision", "defaultValue", "maxLength", "maxValue", "minLength", "minValue", "name", "required", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getCommandTag:getCommandTag": { "properties": { "key": { "type": "string", "description": "User tag key. Naming rules: must not start with any case combination of volc: or sys:. Only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.\n" }, "value": { "type": "string", "description": "User tag value. Naming rules: only language characters, digits, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getDeploymentSetCapacity:getDeploymentSetCapacity": { "properties": { "availableCount": { "type": "integer", "description": "You can also include the number of ECS instances in the current deployment set within this availability zone.\n" }, "usedCount": { "type": "integer", "description": "Number of ECS instances in the deployment set that belong to this availability zone.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID. Only returns the availability zone ID for ECS instances in the deployment set.\n" } }, "type": "object", "required": [ "availableCount", "usedCount", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getHpcClusterTag:getHpcClusterTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getImageDetectionResults:getImageDetectionResults": { "properties": { "detectionStatus": { "type": "string", "description": "Check status. Options: Finished (completed), Processing (in progress).\n" }, "items": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/getImageDetectionResultsItem:getImageDetectionResultsItem" }, "description": "Details of image check items.\n" } }, "type": "object", "required": [ "detectionStatus", "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getImageDetectionResultsItem:getImageDetectionResultsItem": { "properties": { "name": { "type": "string", "description": "Check item name\n" }, "result": { "type": "string", "description": "Result for this check item.\n" }, "riskCode": { "type": "string", "description": "Risk description code\n" }, "riskLevel": { "type": "string", "description": "Risk level. If this parameter is empty, it means no risk\n" } }, "type": "object", "required": [ "name", "result", "riskCode", "riskLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getImageImportImage:getImageImportImage": { "properties": { "importDataVolumes": { "type": "array", "items": { "type": "string" }, "description": "Data disk files included in the custom image, at the TOS bucket URL.\n" }, "url": { "type": "string", "description": "System disk files included in the custom image, at the TOS bucket URL.\n" } }, "type": "object", "required": [ "importDataVolumes", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getImageSnapshot:getImageSnapshot": { "properties": { "size": { "type": "integer", "description": "Snapshot size (GiB)\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID\n" }, "volumeKind": { "type": "string", "description": "Cloud disk type. system: System disk. data: Data disk.\n" } }, "type": "object", "required": [ "size", "snapshotId", "volumeKind" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getImageTag:getImageTag": { "properties": { "key": { "type": "string", "description": "Tag key for the image label.\n" }, "value": { "type": "string", "description": "Image tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceCpuMemory:getInstanceCpuMemory": { "properties": { "coreCount": { "type": "integer", "description": "Number of instance cores.\n" }, "cpuNumber": { "type": "integer", "description": "Number of vCPUs for the instance.\n" }, "memorySize": { "type": "integer", "description": "Instance memory size (MB).\n" }, "threadsPerCore": { "type": "integer", "description": "Threads per core for the instance.\n" } }, "type": "object", "required": [ "coreCount", "cpuNumber", "memorySize", "threadsPerCore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceEipAddress:getInstanceEipAddress": { "properties": { "allocationId": { "type": "string", "description": "Instance allocation ID\n" }, "bandwidthMbps": { "type": "integer", "description": "Maximum bandwidth for public IP. Default value is 1, unit: Mbps.\n - If `ChargeType` is `PayByBandwidth`: value range is 1–500.\n - If `ChargeType` is `PayByTraffic`: value range is 1–200.\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID, used to add a public IP to the shared bandwidth package.\n - You can call the [DescribeBandwidthPackages](https://www.volcengine.com/docs/6623/100685) API to query the shared bandwidth package ID.\n - To add a public IP to a shared bandwidth package, all of the following conditions must be met:\n - Both must have the same security protection type.\n - Both must be in the same region.\n - The public IP must use pay-as-you-go billing.\n - The shared bandwidth package must be IPv4 type.\n" }, "chargeType": { "type": "string", "description": "Public IP billing method. Values:\n - PayByBandwidth (default): Pay-as-you-go—billed by bandwidth cap.\n - PayByTraffic: Pay-as-you-go—billed by actual traffic.\n - PrePaid: Subscription.\n \n **Note:**\n When `InstanceChargeType` is set to `PostPaid`, this parameter cannot be set to `PrePaid`.\n" }, "ipAddress": { "type": "string", "description": "Instance IP address.\n" }, "isp": { "type": "string", "description": "Line type for the public IP. Default is BGP. Values:\n - BGP: BGP (multi-line)\n - If your account has applied for and enabled static single-line permissions, you can use the following values:\n - ChinaMobile: China Mobile static single-line\n - ChinaTelecom: China Telecom static single-line\n - ChinaUnicom: China Unicom static single-line\n - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP.\n - If your account has applied for and enabled static BGP permissions, you can use Static_BGP\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether this resource is released when the instance is released.\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "DDoS Native Protection (Enterprise Edition) ID.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Public IP security protection type.\n" } }, "type": "object", "required": [ "allocationId", "bandwidthMbps", "bandwidthPackageId", "chargeType", "ipAddress", "isp", "releaseWithInstance", "securityProtectionInstanceId", "securityProtectionTypes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceImage:getInstanceImage": { "properties": { "imageId": { "type": "string", "description": "Instance image ID.\n" }, "imageReleaseVersion": { "type": "string", "description": "The image release version of the instance.\n" }, "keepImageCredential": { "type": "boolean", "description": "Whether the instance retains image credentials\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Instance security enhancement policy. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images\n" } }, "type": "object", "required": [ "imageId", "imageReleaseVersion", "keepImageCredential", "securityEnhancementStrategy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceKeyPair:getInstanceKeyPair": { "properties": { "keyPairId": { "type": "string", "description": "Instance public key\n" }, "keyPairName": { "type": "string", "description": "Instance key pair name\n" } }, "type": "object", "required": [ "keyPairId", "keyPairName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceLocalVolume:getInstanceLocalVolume": { "properties": { "count": { "type": "integer", "description": "The number of local disks attached to the instance.\n" }, "size": { "type": "integer", "description": "Capacity of each local disk mounted to the instance (GiB).\n" }, "volumeType": { "type": "string", "description": "Local disk type. Values: LOCAL_SSD: SSD local disk. LOCAL_HDD: HDD local disk.\n" } }, "type": "object", "required": [ "count", "size", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceOperationSystem:getInstanceOperationSystem": { "properties": { "name": { "type": "string", "description": "Instance operating system name.\n" }, "type": { "type": "string", "description": "Operating system type of the instance. Linux: Linux system. Windows: Windows system.\n" } }, "type": "object", "required": [ "name", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstancePlacement:getInstancePlacement": { "properties": { "affinity": { "type": "string", "description": "For ECS instances in economy stop mode, some resources are released after stopping. This parameter indicates whether the ECS instance will remain deployed on the original host when restarted. Values: Host: When restarting an instance in economy stop mode, it will remain on the original host. Default: When restarting an instance in economy stop mode, it will preferentially migrate to a host that supports automatic deployment; if resources are insufficient, it will start on the original host.\n" }, "dedicatedHostClusterId": { "type": "string", "description": "Instance dedicated host cluster ID.\n" }, "dedicatedHostId": { "type": "string", "description": "Dedicated host ID for the instance.\n" }, "tenancy": { "type": "string", "description": "Whether to create the instance on a dedicated host. Values: Default: Create a regular cloud server instance. Host: Create a dedicated host instance. If you do not specify DedicatedHostId, the system automatically selects a dedicated host to place the instance.\n" } }, "type": "object", "required": [ "affinity", "dedicatedHostClusterId", "dedicatedHostId", "tenancy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstancePrimaryNetworkInterface:getInstancePrimaryNetworkInterface": { "properties": { "ipv6AddressCount": { "type": "integer", "description": "The number of IPv6 addresses for the instance.\n" }, "ipv6Addresses": { "type": "array", "items": { "type": "string" }, "description": "IPv6 address of the instance.\n" }, "macAddress": { "type": "string", "description": "Instance MAC address.\n" }, "networkInterfaceId": { "type": "string", "description": "The network interface ID of the instance.\n" }, "primaryIpAddress": { "type": "string", "description": "Instance primary IP address\n" }, "privateIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "Instance private IP address.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Instance security group ID\n" }, "subnetId": { "type": "string", "description": "Instance subnet ID.\n" }, "vpcId": { "type": "string", "description": "VPC ID of the instance.\n" } }, "type": "object", "required": [ "ipv6AddressCount", "ipv6Addresses", "macAddress", "networkInterfaceId", "primaryIpAddress", "privateIpAddresses", "securityGroupIds", "subnetId", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceRdmaNetworkInterfaceDetail:getInstanceRdmaNetworkInterfaceDetail": { "properties": { "gateway": { "type": "string", "description": "Gateway address.\n" }, "ip": { "type": "string", "description": "IP address\n" }, "mask": { "type": "string", "description": "Subnet mask.\n" }, "switchName": { "type": "string", "description": "Switch name.\n" }, "switchPort": { "type": "string", "description": "Switch port.\n" } }, "type": "object", "required": [ "gateway", "ip", "mask", "switchName", "switchPort" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceRenewInfo:getInstanceRenewInfo": { "properties": { "period": { "type": "integer", "description": "Number of months for renewal. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.\n" }, "periodUnit": { "type": "string", "description": "Time unit for renewal duration, i.e., the unit for the Period parameter. Value: Month (default)\n" } }, "type": "object", "required": [ "period", "periodUnit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceSecondaryNetworkInterface:getInstanceSecondaryNetworkInterface": { "properties": { "ipv6AddressCount": { "type": "integer", "description": "The number of IPv6 addresses for the instance.\n" }, "ipv6Addresses": { "type": "array", "items": { "type": "string" }, "description": "IPv6 address of the instance.\n" }, "macAddress": { "type": "string", "description": "Instance MAC address.\n" }, "networkInterfaceId": { "type": "string", "description": "The network interface ID of the instance.\n" }, "primaryIpAddress": { "type": "string", "description": "Instance primary IP address\n" }, "privateIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "Instance private IP address.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Instance security group ID\n" }, "subnetId": { "type": "string", "description": "Instance subnet ID.\n" }, "vpcId": { "type": "string", "description": "VPC ID of the instance.\n" } }, "type": "object", "required": [ "ipv6AddressCount", "ipv6Addresses", "macAddress", "networkInterfaceId", "primaryIpAddress", "privateIpAddresses", "securityGroupIds", "subnetId", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceSystemVolume:getInstanceSystemVolume": { "properties": { "deleteWithInstance": { "type": "boolean", "description": "Whether the attached resources are deleted along with the instance.\n" }, "extraPerformanceIops": { "type": "integer", "description": "Additional performance IOPS for the instance\n" }, "extraPerformanceThroughputMb": { "type": "integer", "description": "The additional performance throughput of the instance, in MB.\n" }, "extraPerformanceTypeId": { "type": "string", "description": "Type of additional performance. Values:\n Balance: Balanced additional performance\n IOPS: IOPS additional performance\n Throughput: Throughput additional performance\n" }, "size": { "type": "integer", "description": "Instance size, in GiB\n" }, "snapshotId": { "type": "string", "description": "Instance snapshot ID\n" }, "volumeId": { "type": "string", "description": "Instance volume ID.\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. Values:\n PTSSD: Performance SSD.\n ESSD_PL0: Ultra SSD disk, PL0 specification.\n ESSD_FlexPL: Ultra SSD disk, FlexPL specification.\n TSSD_TL0: Throughput SSD disk.\n" } }, "type": "object", "required": [ "deleteWithInstance", "extraPerformanceIops", "extraPerformanceThroughputMb", "extraPerformanceTypeId", "size", "snapshotId", "volumeId", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Instance key.\n" }, "value": { "type": "string", "description": "Instance value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInvocationInvocationResult:getInvocationInvocationResult": { "properties": { "commandId": { "type": "string", "description": "Command ID.\n" }, "endTime": { "type": "string", "description": "Command execution completion time.\n" }, "errorCode": { "type": "string", "description": "Error codes for command execution failure. TaskDeliveryTimeout: Indicates command delivery timeout. TaskExecutionTimeout: Indicates command execution timeout. TaskExecutionFailed: Indicates command execution failure.\n" }, "errorMessage": { "type": "string", "description": "Error message for command execution failure.\n" }, "exitCode": { "type": "integer", "description": "Exit status code after script execution.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "invocationId": { "type": "string", "description": "Task execution ID.\n" }, "invocationResultId": { "type": "string", "description": "Task execution result ID.\n" }, "invocationResultStatus": { "type": "string", "description": "Command progress status for a single instance.\n" }, "output": { "type": "string", "description": "Output information after command execution, encoded in Base64.\n" }, "startTime": { "type": "string", "description": "Time when the command starts executing in the instance.\n" }, "username": { "type": "string", "description": "User name for executing the command in the instance.\n" } }, "type": "object", "required": [ "commandId", "endTime", "errorCode", "errorMessage", "exitCode", "instanceId", "invocationId", "invocationResultId", "invocationResultStatus", "output", "startTime", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInvocationParameterDefinition:getInvocationParameterDefinition": { "properties": { "decimalPrecision": { "type": "integer", "description": "Allowed number of decimal places for custom parameter values (numeric).\n" }, "defaultValue": { "type": "string", "description": "Default value for custom parameter.\n" }, "maxLength": { "type": "integer", "description": "Maximum length for custom parameter value (string).\n" }, "maxValue": { "type": "string", "description": "Maximum value for custom parameter (numeric).\n" }, "minLength": { "type": "integer", "description": "Minimum length for custom parameter values (string).\n" }, "minValue": { "type": "string", "description": "Minimum value for custom parameter (numeric).\n" }, "name": { "type": "string", "description": "Custom parameter name. Must be defined in the script using {{Param}}.\n" }, "required": { "type": "boolean", "description": "Required. true: Required. false: Optional.\n" }, "type": { "type": "string", "description": "Custom parameter type. String: Indicates custom parameter type is string. Digit: Indicates custom parameter type is numeric.\n" } }, "type": "object", "required": [ "decimalPrecision", "defaultValue", "maxLength", "maxValue", "minLength", "minValue", "name", "required", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getInvocationTag:getInvocationTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Naming rules: Cannot start with any combination of 'volc:' or 'sys:' in any case. Can only contain letters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.\n" }, "value": { "type": "string", "description": "User tag value. Naming rules: Only letters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty; length must be between 0 and 256 characters.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getKeypairTag:getKeypairTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateLaunchTemplateTag:getLaunchTemplateLaunchTemplateTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags added to the resource.\n" }, "value": { "type": "string", "description": "User tag value added to the resource\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersion:getLaunchTemplateLaunchTemplateVersion": { "properties": { "deploymentSetGroupNumber": { "type": "integer", "description": "When the ECS instance needs to join or adjust the deployment set strategy to the deployment set group high availability strategy (AvailabilityGroup), you can use this parameter to specify the group number of the instance in the deployment set.\n" }, "deploymentSetId": { "type": "string", "description": "Deployment set ID the instance needs to join.\n" }, "description": { "type": "string", "description": "Instance description\n" }, "eip": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionEip:getLaunchTemplateLaunchTemplateVersionEip", "description": "Public IP information bound to the instance\n" }, "hostName": { "type": "string", "description": "Instance hostname. For Linux, the hostname length must be 2–59 characters. For Windows, the hostname length must be 2–10 characters.\n" }, "hpcClusterId": { "type": "string", "description": "When creating a high-performance computing GPU instance, please specify the high-performance computing cluster ID.\n" }, "imageId": { "type": "string", "description": "Image ID.\n" }, "imageName": { "type": "string", "description": "Image name.\n" }, "instanceChargeType": { "type": "string", "description": "Billing type for the instance and cloud disk. Options: PostPaid: Pay-as-you-go. PrePaid: Yearly/monthly subscription. Esi: Elastic reservation instance. Segmented: Time-based elastic reservation instance.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "instanceTypeId": { "type": "string", "description": "Instance specification\n" }, "keepImageCredential": { "type": "boolean", "description": "Whether to retain image settings. Values: true: Retain image settings. If retained, the instance will use the preset password or key pair from the image for login. false (default): Do not retain image settings.\n" }, "keyPairName": { "type": "string", "description": "Key pair bound to the instance.\n" }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionNetworkInterface:getLaunchTemplateLaunchTemplateVersionNetworkInterface" }, "description": "Network interface information mounted to the instance.\n" }, "projectName": { "type": "string", "description": "Project associated with the instance.\n" }, "scheduledInstance": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionScheduledInstance:getLaunchTemplateLaunchTemplateVersionScheduledInstance", "description": "Elastic reservation order information\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Enable security hardening. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images.\n" }, "spotPriceLimit": { "type": "number", "description": "Maximum hourly price for preemptible instances\n" }, "spotStrategy": { "type": "string", "description": "Preemptible strategy for pay-as-you-go billing. Options: NoSpot: Create a regular pay-as-you-go instance. SpotAsPriceGo: System automatically bids, follows the current market price for preemptible instances. SpotWithPriceLimit: Preemptible instance with a bid limit.\n" }, "suffixIndex": { "type": "integer", "description": "Starting number for the sequential suffix\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionTag:getLaunchTemplateLaunchTemplateVersionTag" }, "description": "Tag information for the instance.\n" }, "uniqueSuffix": { "type": "boolean", "description": "Indicates whether to automatically add sequential suffixes to Hostname and InstanceName when creating multiple instances\n" }, "userData": { "type": "string", "description": "Custom data for the instance.\n" }, "versionDescription": { "type": "string", "description": "Template version description.\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionVolume:getLaunchTemplateLaunchTemplateVersionVolume" }, "description": "Cloud disk information bound to the instance\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "zoneId": { "type": "string", "description": "Instance availability zone ID\n" } }, "type": "object", "required": [ "deploymentSetGroupNumber", "deploymentSetId", "description", "eip", "hostName", "hpcClusterId", "imageId", "imageName", "instanceChargeType", "instanceName", "instanceTypeId", "keepImageCredential", "keyPairName", "networkInterfaces", "projectName", "scheduledInstance", "securityEnhancementStrategy", "spotPriceLimit", "spotStrategy", "suffixIndex", "tags", "uniqueSuffix", "userData", "versionDescription", "volumes", "vpcId", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionEip:getLaunchTemplateLaunchTemplateVersionEip": { "properties": { "bandwidth": { "type": "integer", "description": "Public IP bandwidth cap, unit: Mbps. Value range: 1–200. Default: 1.\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID, indicates adding the public IP to the shared bandwidth package.\n" }, "billingType": { "type": "integer", "description": "Billing method for public IP. Values: 2: Pay-as-you-go—by bandwidth cap. 3: Pay-as-you-go—by actual traffic.\n" }, "isp": { "type": "string", "description": "Line type for the public IP. Options: BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line.\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether the public IP is released with the instance; only applies to pay-as-you-go public IPs\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "Security protection package ID\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Security protection type for public IP. Value: AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS Native Protection (Enterprise Edition) instance.\n" } }, "type": "object", "required": [ "bandwidth", "bandwidthPackageId", "billingType", "isp", "releaseWithInstance", "securityProtectionInstanceId", "securityProtectionTypes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionNetworkInterface:getLaunchTemplateLaunchTemplateVersionNetworkInterface": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group ID associated with the network interface.\n" }, "subnetId": { "type": "string", "description": "Instance VPC subnet ID\n" } }, "type": "object", "required": [ "securityGroupIds", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionScheduledInstance:getLaunchTemplateLaunchTemplateVersionScheduledInstance": { "properties": { "scheduledInstanceDescription": { "type": "string", "description": "Description of the elastic reservation order\n" }, "scheduledInstanceName": { "type": "string", "description": "Name of the elastic reservation order\n" } }, "type": "object", "required": [ "scheduledInstanceDescription", "scheduledInstanceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionTag:getLaunchTemplateLaunchTemplateVersionTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags added to the resource.\n" }, "value": { "type": "string", "description": "User tag value added to the resource\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersionVolume:getLaunchTemplateLaunchTemplateVersionVolume": { "properties": { "deleteWithInstance": { "type": "boolean", "description": "Whether the cloud disk is released with the instance\n" }, "extraPerformanceIops": { "type": "integer", "description": "Cloud disk extra IOPS performance size, supported only by ESSD FlexPL data disks, unit: operations/second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. The value ranges for each extra performance type are as follows: IOPS type: 1–50000. Balance type: 1–50000.\n" }, "extraPerformanceThroughputMb": { "type": "integer", "description": "Extra throughput performance size for the cloud disk, in MB/s. Only supported by ESSD FlexPL data disks. This parameter must be set when ExtraPerformanceTypeId is Throughput. Value range: 1–650.\n" }, "extraPerformanceTypeId": { "type": "string", "description": "Type of cloud disk extra performance, supported only by ESSD FlexPL data disks. For more information about extra performance, see Cloud Disk Extra Performance. Values: Balance: Balanced extra performance. IOPS: IOPS extra performance. Throughput: Throughput extra performance.\n" }, "size": { "type": "integer", "description": "Cloud disk size, unit: GB. System disk: ESSD*PL0: 20–2048, PTSSD: 10–500. Data disk: ESSD*PL0: 10–32768, PTSSD: 20–8192\n" }, "snapshotId": { "type": "string", "description": "Create a cloud disk using a snapshot, only supports creating data disks. You can call the DescribeSnapshots API to query the snapshot ID.\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. ESSD_PL0: Ultra-fast SSD PL0. PTSSD: Performance SSD.\n" } }, "type": "object", "required": [ "deleteWithInstance", "extraPerformanceIops", "extraPerformanceThroughputMb", "extraPerformanceTypeId", "size", "snapshotId", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateVersionEip:getLaunchTemplateVersionEip": { "properties": { "bandwidth": { "type": "integer", "description": "Maximum bandwidth for the public IP, measured in Mbps. Value range: 1–200. Default: 1\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID, indicating that the public IP is added to the shared bandwidth package\n" }, "billingType": { "type": "integer", "description": "Billing method for the public IP. Values: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic\n" }, "isp": { "type": "string", "description": "Line type of the public IP. Values: BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether the public IP is released with the instance. Only applies to pay-as-you-go public IPs.\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "Security protection package ID.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Security protection type for public IP. Value: AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.\n" } }, "type": "object", "required": [ "bandwidth", "bandwidthPackageId", "billingType", "isp", "releaseWithInstance", "securityProtectionInstanceId", "securityProtectionTypes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateVersionNetworkInterface:getLaunchTemplateVersionNetworkInterface": { "properties": { "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group ID associated with the network interface.\n" }, "subnetId": { "type": "string", "description": "Private network subnet ID of the instance.\n" } }, "type": "object", "required": [ "securityGroupIds", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateVersionScheduledInstance:getLaunchTemplateVersionScheduledInstance": { "properties": { "scheduledInstanceDescription": { "type": "string", "description": "Description of the elastic reservation order\n" }, "scheduledInstanceName": { "type": "string", "description": "Name of the elastic reservation order\n" } }, "type": "object", "required": [ "scheduledInstanceDescription", "scheduledInstanceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateVersionTag:getLaunchTemplateVersionTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags added to the resource.\n" }, "value": { "type": "string", "description": "Tag value for user tags added to the resource\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:ecs/getLaunchTemplateVersionVolume:getLaunchTemplateVersionVolume": { "properties": { "deleteWithInstance": { "type": "boolean", "description": "Whether the disk is released with the instance\n" }, "extraPerformanceIops": { "type": "integer", "description": "Extra IOPS performance size for the disk, supported only by ESSD FlexPL data disks, measured in operations per second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. Value ranges for each type: IOPS: 1–50000. Balance: 1–50000\n" }, "extraPerformanceThroughputMb": { "type": "integer", "description": "Additional disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when ExtraPerformanceTypeId is Throughput. Value range: 1–650.\n" }, "extraPerformanceTypeId": { "type": "string", "description": "Type of extra disk performance, supported only by ESSD FlexPL data disks. For more information about extra performance, see Extra Disk Performance. Values: Balance: Balanced extra performance. IOPS: IOPS extra performance. Throughput: Throughput extra performance\n" }, "size": { "type": "integer", "description": "Disk size, measured in GB. System disk: ESSD*PL0: 20–2048, PTSSD: 10–500. Data disk: ESSD*PL0: 10–32768, PTSSD: 20–8192\n" }, "snapshotId": { "type": "string", "description": "Create a cloud disk from a snapshot. Only data disks are supported. You can call the DescribeSnapshots API to query the snapshot ID.\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. ESSD_PL0: Ultra-fast SSD PL0. PTSSD: Performance SSD.\n" } }, "type": "object", "required": [ "deleteWithInstance", "extraPerformanceIops", "extraPerformanceThroughputMb", "extraPerformanceTypeId", "size", "snapshotId", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:efs/FileSystemChargeConfig:FileSystemChargeConfig": { "properties": { "chargeStatus": { "type": "string", "description": "Billing status. Value description: WaitingPaid: Waiting for payment, Pending: Creating, Modifying: Reconfiguring, Failed: Failed, Normal: Normal, Expired: Expired, Overdue: Overdue, Reclaimed: Reclaimed, Terminated: Unsubscribed.\n" }, "chargeType": { "type": "string", "description": "Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.\n" }, "expireTime": { "type": "string", "description": "Expiration time.\n" }, "reclaimTime": { "type": "string", "description": "Recycle time.\n" }, "stopTime": { "type": "string", "description": "Shutdown time.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "chargeStatus", "chargeType", "expireTime", "reclaimTime", "stopTime" ] } } }, "volcenginecc:efs/FileSystemPerformance:FileSystemPerformance": { "properties": { "bandwidthMode": { "type": "string", "description": "Bandwidth mode. Value description: Baseline: Baseline bandwidth mode, Provisioned: Provisioned bandwidth mode.\n" }, "baselineBandwidth": { "type": "integer", "description": "Baseline bandwidth.\n" }, "baselineIops": { "type": "integer", "description": "Baseline IOPS.\n" }, "burstBandwidth": { "type": "integer", "description": "Burst bandwidth.\n" }, "burstIops": { "type": "integer", "description": "Burst IOPS.\n" }, "provisionedBandwidth": { "type": "integer", "description": "Provisioned bandwidth.\n" }, "provisionedIops": { "type": "integer", "description": "Provisioned IOPS.\n" } }, "type": "object", "required": [ "bandwidthMode" ], "language": { "nodejs": { "requiredOutputs": [ "bandwidthMode", "baselineBandwidth", "baselineIops", "burstBandwidth", "burstIops", "provisionedBandwidth", "provisionedIops" ] } } }, "volcenginecc:efs/FileSystemStorage:FileSystemStorage": { "properties": { "capacityLimit": { "type": "integer", "description": "Capacity limit, in MiB.\n" }, "capacityUsed": { "type": "integer", "description": "Used capacity, in MiB.\n" }, "inodeLimit": { "type": "integer", "description": "File count limit.\n" }, "inodeUsed": { "type": "integer", "description": "Used file count.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "capacityLimit", "capacityUsed", "inodeLimit", "inodeUsed" ] } } }, "volcenginecc:efs/FileSystemTag:FileSystemTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "type": { "type": "string", "description": "Tag type. Value description: System: System tag, Custom: Custom tag.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "type", "value" ] } } }, "volcenginecc:efs/getFileSystemChargeConfig:getFileSystemChargeConfig": { "properties": { "chargeStatus": { "type": "string", "description": "Billing status. Value description: WaitingPaid: Waiting for payment, Pending: Creating, Modifying: Reconfiguring, Failed: Failed, Normal: Normal, Expired: Expired, Overdue: Overdue, Reclaimed: Reclaimed, Terminated: Unsubscribed.\n" }, "chargeType": { "type": "string", "description": "Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.\n" }, "expireTime": { "type": "string", "description": "Expiration time.\n" }, "reclaimTime": { "type": "string", "description": "Recycle time.\n" }, "stopTime": { "type": "string", "description": "Shutdown time.\n" } }, "type": "object", "required": [ "chargeStatus", "chargeType", "expireTime", "reclaimTime", "stopTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:efs/getFileSystemPerformance:getFileSystemPerformance": { "properties": { "bandwidthMode": { "type": "string", "description": "Bandwidth mode. Value description: Baseline: Baseline bandwidth mode, Provisioned: Provisioned bandwidth mode.\n" }, "baselineBandwidth": { "type": "integer", "description": "Baseline bandwidth.\n" }, "baselineIops": { "type": "integer", "description": "Baseline IOPS.\n" }, "burstBandwidth": { "type": "integer", "description": "Burst bandwidth.\n" }, "burstIops": { "type": "integer", "description": "Burst IOPS.\n" }, "provisionedBandwidth": { "type": "integer", "description": "Provisioned bandwidth.\n" }, "provisionedIops": { "type": "integer", "description": "Provisioned IOPS.\n" } }, "type": "object", "required": [ "bandwidthMode", "baselineBandwidth", "baselineIops", "burstBandwidth", "burstIops", "provisionedBandwidth", "provisionedIops" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:efs/getFileSystemStorage:getFileSystemStorage": { "properties": { "capacityLimit": { "type": "integer", "description": "Capacity limit, in MiB.\n" }, "capacityUsed": { "type": "integer", "description": "Used capacity, in MiB.\n" }, "inodeLimit": { "type": "integer", "description": "File count limit.\n" }, "inodeUsed": { "type": "integer", "description": "Used file count.\n" } }, "type": "object", "required": [ "capacityLimit", "capacityUsed", "inodeLimit", "inodeUsed" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:efs/getFileSystemTag:getFileSystemTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "type": { "type": "string", "description": "Tag type. Value description: System: System tag, Custom: Custom tag.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/ClusterApplication:ClusterApplication": { "properties": { "applicationConfigHome": { "type": "string", "description": "Application configuration path.\n" }, "applicationHome": { "type": "string", "description": "Application installation path.\n" }, "applicationName": { "type": "string", "description": "Application name.\n" }, "applicationState": { "type": "string", "description": "Service status. NORMAL: normal; WARNING: alert; STOPPED: stopped; INIT: initializing; INSTALLING: installing; INSTALLED: installed; STARTING: starting; STARTED: started; STOPPING: stopping; UNINSTALLING: uninstalling; UNINSTALLED: uninstalled; EXCEPTION: exception.\n" }, "applicationVersion": { "type": "string", "description": "Application version.\n" }, "group": { "type": "string", "description": "Application user group.\n" }, "supportClient": { "type": "boolean", "description": "Whether client is supported.\n" }, "user": { "type": "string", "description": "Application user.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "applicationConfigHome", "applicationHome", "applicationName", "applicationState", "applicationVersion", "group", "supportClient", "user" ] } } }, "volcenginecc:emr/ClusterApplicationExtra:ClusterApplicationExtra": { "properties": { "applicationComponentLayouts": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterApplicationExtraApplicationComponentLayout:ClusterApplicationExtraApplicationComponentLayout" } }, "applicationConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterApplicationExtraApplicationConfig:ClusterApplicationExtraApplicationConfig" } }, "applicationName": { "type": "string", "description": "Application name.\n" }, "connectionId": { "type": "string", "description": "Metadata connection ID.\n" }, "connectionType": { "type": "string", "description": "Metadata connection type. BUILT*IN*MYSQL: built-in database. EXTERNAL*MYSQL: external database. HIVE*METASTORE: HMS.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "applicationComponentLayouts", "applicationConfigs", "applicationName", "connectionId", "connectionType" ] } } }, "volcenginecc:emr/ClusterApplicationExtraApplicationComponentLayout:ClusterApplicationExtraApplicationComponentLayout": { "properties": { "componentName": { "type": "string", "description": "Component name.\n" }, "effectiveScope": { "$ref": "#/types/volcenginecc:emr/ClusterApplicationExtraApplicationComponentLayoutEffectiveScope:ClusterApplicationExtraApplicationComponentLayoutEffectiveScope", "description": "Component layout scope.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "componentName", "effectiveScope" ] } } }, "volcenginecc:emr/ClusterApplicationExtraApplicationComponentLayoutEffectiveScope:ClusterApplicationExtraApplicationComponentLayoutEffectiveScope": { "properties": { "componentNames": { "type": "array", "items": { "type": "string" }, "description": "Component name list. Required when EffectiveType=COMPONENT_NAME.\n" }, "effectiveType": { "type": "string", "description": "Effective type. CLUSTER, NODE*GROUP*NAME, NODE*GROUP*ID, NODE*GROUP*TYPE, NODE*NAME, NODE*ID, COMPONENT_NAME.\n" }, "nodeGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Node group ID list. Required when EffectiveType=NODE*GROUP*ID.\n" }, "nodeGroupNames": { "type": "array", "items": { "type": "string" }, "description": "Node group name list. Required when EffectiveType=NODE*GROUP*NAME.\n" }, "nodeGroupTypes": { "type": "array", "items": { "type": "string" }, "description": "Node group type list. Required when EffectiveType=NODE*GROUP*TYPE. Currently includes MASTER, CORE, TASK.\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node ID list. Required when EffectiveType=NODE_ID.\n" }, "nodeNames": { "type": "array", "items": { "type": "string" }, "description": "Node name list. Required when EffectiveType=NODE_NAME.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "componentNames", "effectiveType", "nodeGroupIds", "nodeGroupNames", "nodeGroupTypes", "nodeIds", "nodeNames" ] } } }, "volcenginecc:emr/ClusterApplicationExtraApplicationConfig:ClusterApplicationExtraApplicationConfig": { "properties": { "componentInstanceName": { "type": "string", "description": "Component instance name.\n" }, "componentName": { "type": "string", "description": "Component name.\n" }, "configFileName": { "type": "string", "description": "Configuration file name.\n" }, "configItemKey": { "type": "string", "description": "Configuration item name.\n" }, "configItemValue": { "type": "string", "description": "Configuration item value.\n" }, "deleted": { "type": "boolean", "description": "Whether to delete.\n" }, "effectiveScope": { "$ref": "#/types/volcenginecc:emr/ClusterApplicationExtraApplicationConfigEffectiveScope:ClusterApplicationExtraApplicationConfigEffectiveScope", "description": "Affected component.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "componentInstanceName", "componentName", "configFileName", "configItemKey", "configItemValue", "deleted", "effectiveScope" ] } } }, "volcenginecc:emr/ClusterApplicationExtraApplicationConfigEffectiveScope:ClusterApplicationExtraApplicationConfigEffectiveScope": { "properties": { "componentNames": { "type": "array", "items": { "type": "string" }, "description": "Component name list. Required when EffectiveType=COMPONENT_NAME.\n" }, "effectiveType": { "type": "string", "description": "Effective type. CLUSTER, NODE*GROUP*NAME, NODE*GROUP*ID, NODE*GROUP*TYPE, NODE*NAME, NODE*ID, COMPONENT_NAME.\n" }, "nodeGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Node group ID list. Required when EffectiveType=NODE*GROUP*ID.\n" }, "nodeGroupNames": { "type": "array", "items": { "type": "string" }, "description": "Node group name list. Required when EffectiveType=NODE*GROUP*NAME.\n" }, "nodeGroupTypes": { "type": "array", "items": { "type": "string" }, "description": "Node group type list. Required when EffectiveType=NODE*GROUP*TYPE. Currently includes MASTER, CORE, TASK.\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node ID list. Required when EffectiveType=NODE_ID.\n" }, "nodeNames": { "type": "array", "items": { "type": "string" }, "description": "Node name list. Required when EffectiveType=NODE_NAME.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "componentNames", "effectiveType", "nodeGroupIds", "nodeGroupNames", "nodeGroupTypes", "nodeIds", "nodeNames" ] } } }, "volcenginecc:emr/ClusterBootstrapScript:ClusterBootstrapScript": { "properties": { "effectiveScope": { "$ref": "#/types/volcenginecc:emr/ClusterBootstrapScriptEffectiveScope:ClusterBootstrapScriptEffectiveScope", "description": "Script execution scope.\n" }, "executionFailStrategy": { "type": "string", "description": "Execution failure policy. Range: FAILED*CONTINUE: Continue with other tasks after failure. FAILED*BLOCK: Stop and do not execute subsequent tasks after failure. If the script is BOOTSTRAP, this will interrupt and fail cluster creation or node group expansion. Default: FAILED_BLOCK.\n" }, "executionMoment": { "type": "string", "description": "Script execution timing. Only effective when scriptType=BOOTSTRAP. BEFORE*APPLICATION*INSTALL: before application installation. AFTER*APPLICATION*STARTED: after application startup. Default: BEFORE*APP*INSTALL.\n" }, "priority": { "type": "string", "description": "Script execution priority. Range: 1~1000. Default: 1.\n" }, "scriptArgs": { "type": "string", "description": "Script parameters.\n" }, "scriptName": { "type": "string", "description": "Script name (required). Length: 1–128 characters. Must start with an uppercase or lowercase letter or Chinese character. Cannot start with http: or https:. Can include Chinese, English, numbers, underscores (_), or hyphens (-).\n" }, "scriptPath": { "type": "string", "description": "Script TOS path. Required. Must start with 'tos:'.\n" }, "scriptType": { "type": "string", "description": "Script type. NORMAL: normal script. BOOTSTRAP: bootstrap script.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "effectiveScope", "executionFailStrategy", "executionMoment", "priority", "scriptArgs", "scriptName", "scriptPath", "scriptType" ] } } }, "volcenginecc:emr/ClusterBootstrapScriptEffectiveScope:ClusterBootstrapScriptEffectiveScope": { "properties": { "componentNames": { "type": "array", "items": { "type": "string" }, "description": "Component name list. Required when EffectiveType=COMPONENT_NAME.\n" }, "effectiveType": { "type": "string", "description": "Effective type. CLUSTER, NODE*GROUP*NAME, NODE*GROUP*ID, NODE*GROUP*TYPE, NODE*NAME, NODE*ID, COMPONENT_NAME.\n" }, "nodeGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Node group ID list. Required when EffectiveType=NODE*GROUP*ID.\n" }, "nodeGroupNames": { "type": "array", "items": { "type": "string" }, "description": "Node group name list. Required when EffectiveType=NODE*GROUP*NAME.\n" }, "nodeGroupTypes": { "type": "array", "items": { "type": "string" }, "description": "Node group type list. Required when EffectiveType=NODE*GROUP*TYPE. Currently includes MASTER, CORE, TASK.\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node ID list. Required when EffectiveType=NODE_ID.\n" }, "nodeNames": { "type": "array", "items": { "type": "string" }, "description": "Node name list. Required when EffectiveType=NODE_NAME.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "componentNames", "effectiveType", "nodeGroupIds", "nodeGroupNames", "nodeGroupTypes", "nodeIds", "nodeNames" ] } } }, "volcenginecc:emr/ClusterChargePreConfig:ClusterChargePreConfig": { "properties": { "autoRenew": { "type": "boolean", "description": "Enable auto-renewal. Options: true (enabled), false (disabled).\n" }, "autoRenewPeriod": { "type": "integer", "description": "Renewal duration when auto-renewal is triggered. When AutoRenew=true, the default value is 1.\n" }, "autoRenewPeriodUnit": { "type": "string", "description": "Renewal duration unit when auto-renewal is triggered. When AutoRenew=true, default is Month. Options: Month, Year.\n" }, "chargePeriod": { "type": "integer", "description": "When chargeType=PRE, default value=1. Unit for monthly subscription duration.\n" }, "chargePeriodUnit": { "type": "string", "description": "When chargeType=PRE, default value=Month. Unit for monthly subscription duration. Range: Month: month. Year: year.\n" }, "chargeType": { "type": "string", "description": "Payment type. Options: PRE, POST.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "autoRenewPeriod", "autoRenewPeriodUnit", "chargePeriod", "chargePeriodUnit", "chargeType" ] } } }, "volcenginecc:emr/ClusterNodeAttribute:ClusterNodeAttribute": { "properties": { "ecsIamRole": { "type": "string", "description": "ECS instance role.\n" }, "zoneId": { "type": "string", "description": "Zone ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ecsIamRole", "zoneId" ] } } }, "volcenginecc:emr/ClusterNodeGroupAttribute:ClusterNodeGroupAttribute": { "properties": { "bandwidth": { "type": "integer", "description": "Public bandwidth. Default is 8M. If the user changes it later, EMR needs to synchronize this information.\n" }, "chargeType": { "type": "string", "description": "Node group billing type. If empty, reuses the cluster's chargeType. Master and Core groups must reuse the cluster-level billing type. When the cluster's chargeType is PRE, the task node group's chargeType can be set to POST. When the cluster's chargeType is POST, the node group's chargeType defaults to POST, and this parameter setting on the node group is invalid.\n" }, "dataDisks": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterNodeGroupAttributeDataDisk:ClusterNodeGroupAttributeDataDisk" } }, "ecsInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "Node group's ECS instance type list. Only one instance type can be set. The list length is limited to 1.\n" }, "ecsKeyPairName": { "type": "string", "description": "ECS key pair name.\n" }, "ecsPassword": { "type": "string", "description": "Password for ECS root account.\n" }, "nodeCount": { "type": "integer", "description": "Current expected number of nodes to purchase for the node group.\n" }, "nodeGroupName": { "type": "string", "description": "Length: 1–128 characters. Cannot start with http: or https:. Can include Chinese, English, numbers, underscores (_), or hyphens (-).\n" }, "nodeGroupType": { "type": "string", "description": "Node group type.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID list. Currently, only one parameter can be passed, and all node groups must use the same subnet ID.\n" }, "systemDisk": { "$ref": "#/types/volcenginecc:emr/ClusterNodeGroupAttributeSystemDisk:ClusterNodeGroupAttributeSystemDisk", "description": "System disk configuration.\n" }, "withPublicIp": { "type": "boolean", "description": "Whether to attach public IP.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "chargeType", "dataDisks", "ecsInstanceTypes", "ecsKeyPairName", "ecsPassword", "nodeCount", "nodeGroupName", "nodeGroupType", "subnetIds", "systemDisk", "withPublicIp", "zoneId" ] } } }, "volcenginecc:emr/ClusterNodeGroupAttributeDataDisk:ClusterNodeGroupAttributeDataDisk": { "properties": { "count": { "type": "integer", "description": "Number of disk blocks. Default is 4, maximum is 15, minimum is 1.\n" }, "size": { "type": "integer", "description": "Disk size. Default is 80GB, minimum is 60GB, maximum is 2048GB, unit: GB.\n" }, "volumeType": { "type": "string", "description": "Disk type. ESSD*PL0: Ultra SSD*PL0. ESSD*PL1: Ultra SSD*PL1. ESSD*PL2: Ultra SSD*PL2. ESSD*PL3: Ultra SSD*PL3. ESSD*FLEXPL: Ultra SSD*FlexPL. ULTRA*DISK: Efficient cloud disk. PTSSD: Performance SSD. SSD: General SSD. EHDD: Efficient cloud disk. ZENYA*SSD: Zenya. LOCAL*HDD: Big data HDD. LOCAL*SSD: Local SSD. LOCAL*SSD*SRIOV: Local SSD SRIOV.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "count", "size", "volumeType" ] } } }, "volcenginecc:emr/ClusterNodeGroupAttributeSystemDisk:ClusterNodeGroupAttributeSystemDisk": { "properties": { "size": { "type": "integer", "description": "Disk size.\n" }, "volumeType": { "type": "string", "description": "Disk type.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "size", "volumeType" ] } } }, "volcenginecc:emr/ClusterStateChangeReason:ClusterStateChangeReason": { "properties": { "code": { "type": "string", "description": "Status update code.\n" }, "reason": { "type": "string", "description": "Status update reason.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "code", "reason" ] } } }, "volcenginecc:emr/ClusterTag:ClusterTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:emr/NodeGroupApplicationLayout:NodeGroupApplicationLayout": { "properties": { "applicationName": { "type": "string", "description": "Application name.\n" }, "layoutComponentNames": { "type": "array", "items": { "type": "string" }, "description": "Custom configuration parameter list for the component.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "applicationName", "layoutComponentNames" ] } } }, "volcenginecc:emr/NodeGroupChargePreConfig:NodeGroupChargePreConfig": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether to enable auto-renewal.\n" }, "autoRenewPeriod": { "type": "integer", "description": "Renewal duration when auto-renewal is triggered. When autoRenew=true, the default value is 1.\n" }, "autoRenewPeriodUnit": { "type": "string", "description": "Renewal duration unit when auto-renewal is triggered. When autoRenew=true, the default value is Month. Value range: Month: month. Year: year.\n" }, "chargePeriod": { "type": "integer", "description": "When chargeType=PRE, the default value is 1. The unit for the purchase duration when chargeType=PRE is monthly subscription.\n" }, "chargePeriodUnit": { "type": "string", "description": "When chargeType=PRE, the default value is Month. The unit for the purchase duration when chargeType=PRE is monthly subscription. Value range: Month (month), Year (year).\n" }, "chargeType": { "type": "string", "description": "Payment type. Enum values: POST, PRE.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "autoRenewPeriod", "autoRenewPeriodUnit", "chargePeriod", "chargePeriodUnit", "chargeType" ] } } }, "volcenginecc:emr/NodeGroupDataDisk:NodeGroupDataDisk": { "properties": { "count": { "type": "integer", "description": "Number of disk blocks. Default value: 4. Maximum: 15. Minimum: 1.\n" }, "size": { "type": "integer", "description": "Disk size. Default value: 80GB. Minimum: 60GB. Maximum: 2048GB. Unit: GB.\n" }, "volumeType": { "type": "string", "description": "Disk type. ESSD*PL0: Ultra-fast SSD*PL0. ESSD*PL1: Ultra-fast SSD*PL1. ESSD*PL2: Ultra-fast SSD*PL2. ESSD*PL3: Ultra-fast SSD*PL3. ESSD*FLEXPL: Ultra-fast SSD*FlexPL. ULTRA*DISK: Efficient cloud disk. PTSSD: Performance SSD. SSD: General SSD. EHDD: Efficient cloud disk. ZENYA*SSD: Zenya. LOCAL*HDD: Big data HDD. LOCAL*SSD: Local SSD. LOCAL*SSD*SRIOV: Local SSD SRIOV.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "count", "size", "volumeType" ] } } }, "volcenginecc:emr/NodeGroupNode:NodeGroupNode": { "properties": { "createdTime": { "type": "integer", "description": "Node creation time.\n" }, "ecsInstanceType": { "type": "string", "description": "ecs instance specification.\n" }, "nodeFqdn": { "type": "string", "description": "Node FQDN.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodeName": { "type": "string", "description": "Node name.\n" }, "nodeState": { "type": "string", "description": "Node status. UNKNOWN: Unknown. CREATING: Creating. RUNNING: Running. STOPPING: Stopping. STOPPED: Stopped. REBOOTING: Rebooting. DELETED: Deleted.\n" }, "privateIp": { "type": "string", "description": "Private IP.\n" }, "publicIp": { "type": "string", "description": "Public IP.\n" }, "readyTime": { "type": "integer", "description": "Ready time.\n" }, "terminateTime": { "type": "integer", "description": "Cluster termination time.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createdTime", "ecsInstanceType", "nodeFqdn", "nodeId", "nodeName", "nodeState", "privateIp", "publicIp", "readyTime", "terminateTime" ] } } }, "volcenginecc:emr/NodeGroupSystemDisk:NodeGroupSystemDisk": { "properties": { "size": { "type": "integer", "description": "System disk size. Default value: 80GB. Minimum: 60GB. Maximum: 2048GB. Unit: GB.\n" }, "volumeType": { "type": "string", "description": "Disk type. ESSD*PL0: Ultra-fast SSD*PL0. ESSD*PL1: Ultra-fast SSD*PL1. ESSD*PL2: Ultra-fast SSD*PL2. ESSD*PL3: Ultra-fast SSD*PL3. ESSD*FLEXPL: Ultra-fast SSD*FlexPL. ULTRA*DISK: Efficient cloud disk. PTSSD: Performance SSD. SSD: General SSD. EHDD: Efficient cloud disk. ZENYA*SSD: Zenya. LOCAL*HDD: Big data HDD. LOCAL*SSD: Local SSD. LOCAL*SSD*SRIOV: Local SSD SRIOV.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "size", "volumeType" ] } } }, "volcenginecc:emr/getClusterApplication:getClusterApplication": { "properties": { "applicationConfigHome": { "type": "string", "description": "Application configuration path.\n" }, "applicationHome": { "type": "string", "description": "Application installation path.\n" }, "applicationName": { "type": "string", "description": "Application name.\n" }, "applicationState": { "type": "string", "description": "Service status. NORMAL: normal; WARNING: alert; STOPPED: stopped; INIT: initializing; INSTALLING: installing; INSTALLED: installed; STARTING: starting; STARTED: started; STOPPING: stopping; UNINSTALLING: uninstalling; UNINSTALLED: uninstalled; EXCEPTION: exception.\n" }, "applicationVersion": { "type": "string", "description": "Application version.\n" }, "group": { "type": "string", "description": "Application user group.\n" }, "supportClient": { "type": "boolean", "description": "Whether client is supported.\n" }, "user": { "type": "string", "description": "Application user.\n" } }, "type": "object", "required": [ "applicationConfigHome", "applicationHome", "applicationName", "applicationState", "applicationVersion", "group", "supportClient", "user" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterApplicationExtra:getClusterApplicationExtra": { "properties": { "applicationComponentLayouts": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/getClusterApplicationExtraApplicationComponentLayout:getClusterApplicationExtraApplicationComponentLayout" }, "description": "Custom deployment topology list for service components.\n" }, "applicationConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/getClusterApplicationExtraApplicationConfig:getClusterApplicationExtraApplicationConfig" }, "description": "Custom configuration parameter list for services.\n" }, "applicationName": { "type": "string", "description": "Application name.\n" }, "connectionId": { "type": "string", "description": "Metadata connection ID.\n" }, "connectionType": { "type": "string", "description": "Metadata connection type. BUILT*IN*MYSQL: built-in database. EXTERNAL*MYSQL: external database. HIVE*METASTORE: HMS.\n" } }, "type": "object", "required": [ "applicationComponentLayouts", "applicationConfigs", "applicationName", "connectionId", "connectionType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterApplicationExtraApplicationComponentLayout:getClusterApplicationExtraApplicationComponentLayout": { "properties": { "componentName": { "type": "string", "description": "Component name.\n" }, "effectiveScope": { "$ref": "#/types/volcenginecc:emr/getClusterApplicationExtraApplicationComponentLayoutEffectiveScope:getClusterApplicationExtraApplicationComponentLayoutEffectiveScope", "description": "Component layout scope.\n" } }, "type": "object", "required": [ "componentName", "effectiveScope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterApplicationExtraApplicationComponentLayoutEffectiveScope:getClusterApplicationExtraApplicationComponentLayoutEffectiveScope": { "properties": { "componentNames": { "type": "array", "items": { "type": "string" }, "description": "Component name list. Required when EffectiveType=COMPONENT_NAME.\n" }, "effectiveType": { "type": "string", "description": "Effective type. CLUSTER, NODE*GROUP*NAME, NODE*GROUP*ID, NODE*GROUP*TYPE, NODE*NAME, NODE*ID, COMPONENT_NAME.\n" }, "nodeGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Node group ID list. Required when EffectiveType=NODE*GROUP*ID.\n" }, "nodeGroupNames": { "type": "array", "items": { "type": "string" }, "description": "Node group name list. Required when EffectiveType=NODE*GROUP*NAME.\n" }, "nodeGroupTypes": { "type": "array", "items": { "type": "string" }, "description": "Node group type list. Required when EffectiveType=NODE*GROUP*TYPE. Currently includes MASTER, CORE, TASK.\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node ID list. Required when EffectiveType=NODE_ID.\n" }, "nodeNames": { "type": "array", "items": { "type": "string" }, "description": "Node name list. Required when EffectiveType=NODE_NAME.\n" } }, "type": "object", "required": [ "componentNames", "effectiveType", "nodeGroupIds", "nodeGroupNames", "nodeGroupTypes", "nodeIds", "nodeNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterApplicationExtraApplicationConfig:getClusterApplicationExtraApplicationConfig": { "properties": { "componentInstanceName": { "type": "string", "description": "Component instance name.\n" }, "componentName": { "type": "string", "description": "Component name.\n" }, "configFileName": { "type": "string", "description": "Configuration file name.\n" }, "configItemKey": { "type": "string", "description": "Configuration item name.\n" }, "configItemValue": { "type": "string", "description": "Configuration item value.\n" }, "deleted": { "type": "boolean", "description": "Whether to delete.\n" }, "effectiveScope": { "$ref": "#/types/volcenginecc:emr/getClusterApplicationExtraApplicationConfigEffectiveScope:getClusterApplicationExtraApplicationConfigEffectiveScope", "description": "Affected component.\n" } }, "type": "object", "required": [ "componentInstanceName", "componentName", "configFileName", "configItemKey", "configItemValue", "deleted", "effectiveScope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterApplicationExtraApplicationConfigEffectiveScope:getClusterApplicationExtraApplicationConfigEffectiveScope": { "properties": { "componentNames": { "type": "array", "items": { "type": "string" }, "description": "Component name list. Required when EffectiveType=COMPONENT_NAME.\n" }, "effectiveType": { "type": "string", "description": "Effective type. CLUSTER, NODE*GROUP*NAME, NODE*GROUP*ID, NODE*GROUP*TYPE, NODE*NAME, NODE*ID, COMPONENT_NAME.\n" }, "nodeGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Node group ID list. Required when EffectiveType=NODE*GROUP*ID.\n" }, "nodeGroupNames": { "type": "array", "items": { "type": "string" }, "description": "Node group name list. Required when EffectiveType=NODE*GROUP*NAME.\n" }, "nodeGroupTypes": { "type": "array", "items": { "type": "string" }, "description": "Node group type list. Required when EffectiveType=NODE*GROUP*TYPE. Currently includes MASTER, CORE, TASK.\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node ID list. Required when EffectiveType=NODE_ID.\n" }, "nodeNames": { "type": "array", "items": { "type": "string" }, "description": "Node name list. Required when EffectiveType=NODE_NAME.\n" } }, "type": "object", "required": [ "componentNames", "effectiveType", "nodeGroupIds", "nodeGroupNames", "nodeGroupTypes", "nodeIds", "nodeNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterBootstrapScript:getClusterBootstrapScript": { "properties": { "effectiveScope": { "$ref": "#/types/volcenginecc:emr/getClusterBootstrapScriptEffectiveScope:getClusterBootstrapScriptEffectiveScope", "description": "Script execution scope.\n" }, "executionFailStrategy": { "type": "string", "description": "Execution failure policy. Range: FAILED*CONTINUE: Continue with other tasks after failure. FAILED*BLOCK: Stop and do not execute subsequent tasks after failure. If the script is BOOTSTRAP, this will interrupt and fail cluster creation or node group expansion. Default: FAILED_BLOCK.\n" }, "executionMoment": { "type": "string", "description": "Script execution timing. Only effective when scriptType=BOOTSTRAP. BEFORE*APPLICATION*INSTALL: before application installation. AFTER*APPLICATION*STARTED: after application startup. Default: BEFORE*APP*INSTALL.\n" }, "priority": { "type": "string", "description": "Script execution priority. Range: 1~1000. Default: 1.\n" }, "scriptArgs": { "type": "string", "description": "Script parameters.\n" }, "scriptName": { "type": "string", "description": "Script name (required). Length: 1–128 characters. Must start with an uppercase or lowercase letter or Chinese character. Cannot start with http: or https:. Can include Chinese, English, numbers, underscores (_), or hyphens (-).\n" }, "scriptPath": { "type": "string", "description": "Script TOS path. Required. Must start with 'tos:'.\n" }, "scriptType": { "type": "string", "description": "Script type. NORMAL: normal script. BOOTSTRAP: bootstrap script.\n" } }, "type": "object", "required": [ "effectiveScope", "executionFailStrategy", "executionMoment", "priority", "scriptArgs", "scriptName", "scriptPath", "scriptType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterBootstrapScriptEffectiveScope:getClusterBootstrapScriptEffectiveScope": { "properties": { "componentNames": { "type": "array", "items": { "type": "string" }, "description": "Component name list. Required when EffectiveType=COMPONENT_NAME.\n" }, "effectiveType": { "type": "string", "description": "Effective type. CLUSTER, NODE*GROUP*NAME, NODE*GROUP*ID, NODE*GROUP*TYPE, NODE*NAME, NODE*ID, COMPONENT_NAME.\n" }, "nodeGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Node group ID list. Required when EffectiveType=NODE*GROUP*ID.\n" }, "nodeGroupNames": { "type": "array", "items": { "type": "string" }, "description": "Node group name list. Required when EffectiveType=NODE*GROUP*NAME.\n" }, "nodeGroupTypes": { "type": "array", "items": { "type": "string" }, "description": "Node group type list. Required when EffectiveType=NODE*GROUP*TYPE. Currently includes MASTER, CORE, TASK.\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node ID list. Required when EffectiveType=NODE_ID.\n" }, "nodeNames": { "type": "array", "items": { "type": "string" }, "description": "Node name list. Required when EffectiveType=NODE_NAME.\n" } }, "type": "object", "required": [ "componentNames", "effectiveType", "nodeGroupIds", "nodeGroupNames", "nodeGroupTypes", "nodeIds", "nodeNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterChargePreConfig:getClusterChargePreConfig": { "properties": { "autoRenew": { "type": "boolean", "description": "Enable auto-renewal. Options: true (enabled), false (disabled).\n" }, "autoRenewPeriod": { "type": "integer", "description": "Renewal duration when auto-renewal is triggered. When AutoRenew=true, the default value is 1.\n" }, "autoRenewPeriodUnit": { "type": "string", "description": "Renewal duration unit when auto-renewal is triggered. When AutoRenew=true, default is Month. Options: Month, Year.\n" }, "chargePeriod": { "type": "integer", "description": "When chargeType=PRE, default value=1. Unit for monthly subscription duration.\n" }, "chargePeriodUnit": { "type": "string", "description": "When chargeType=PRE, default value=Month. Unit for monthly subscription duration. Range: Month: month. Year: year.\n" }, "chargeType": { "type": "string", "description": "Payment type. Options: PRE, POST.\n" } }, "type": "object", "required": [ "autoRenew", "autoRenewPeriod", "autoRenewPeriodUnit", "chargePeriod", "chargePeriodUnit", "chargeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterNodeAttribute:getClusterNodeAttribute": { "properties": { "ecsIamRole": { "type": "string", "description": "ECS instance role.\n" }, "zoneId": { "type": "string", "description": "Zone ID.\n" } }, "type": "object", "required": [ "ecsIamRole", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterNodeGroupAttribute:getClusterNodeGroupAttribute": { "properties": { "bandwidth": { "type": "integer", "description": "Public bandwidth. Default is 8M. If the user changes it later, EMR needs to synchronize this information.\n" }, "chargeType": { "type": "string", "description": "Node group billing type. If empty, reuses the cluster's chargeType. Master and Core groups must reuse the cluster-level billing type. When the cluster's chargeType is PRE, the task node group's chargeType can be set to POST. When the cluster's chargeType is POST, the node group's chargeType defaults to POST, and this parameter setting on the node group is invalid.\n" }, "createTime": { "type": "integer", "description": "Node group creation time.\n" }, "dataDisks": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/getClusterNodeGroupAttributeDataDisk:getClusterNodeGroupAttributeDataDisk" }, "description": "Data disk configuration. Only disks of the same specification are supported within a single node group. The list length is limited to 1.\n" }, "ecsInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "Node group's ECS instance type list. Only one instance type can be set. The list length is limited to 1.\n" }, "ecsKeyPairName": { "type": "string", "description": "ECS key pair name.\n" }, "ecsPassword": { "type": "string", "description": "Password for ECS root account.\n" }, "layoutComponentNames": { "type": "array", "items": { "type": "string" }, "description": "List of deployed component names.\n" }, "nodeCount": { "type": "integer", "description": "Current expected number of nodes to purchase for the node group.\n" }, "nodeGroupId": { "type": "string", "description": "Node group ID.\n" }, "nodeGroupName": { "type": "string", "description": "Length: 1–128 characters. Cannot start with http: or https:. Can include Chinese, English, numbers, underscores (_), or hyphens (-).\n" }, "nodeGroupState": { "type": "string", "description": "Node group status. RUNNING: running. EXTENDING: scaling out. REDUCING: scaling in. DISK_EXTENDING: disk scaling out. MODIFYING: configuration change.\n" }, "nodeGroupType": { "type": "string", "description": "Node group type.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID list. Currently, only one parameter can be passed, and all node groups must use the same subnet ID.\n" }, "systemDisk": { "$ref": "#/types/volcenginecc:emr/getClusterNodeGroupAttributeSystemDisk:getClusterNodeGroupAttributeSystemDisk", "description": "System disk configuration.\n" }, "withPublicIp": { "type": "boolean", "description": "Whether to attach public IP.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "type": "object", "required": [ "bandwidth", "chargeType", "createTime", "dataDisks", "ecsInstanceTypes", "ecsKeyPairName", "ecsPassword", "layoutComponentNames", "nodeCount", "nodeGroupId", "nodeGroupName", "nodeGroupState", "nodeGroupType", "subnetIds", "systemDisk", "withPublicIp", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterNodeGroupAttributeDataDisk:getClusterNodeGroupAttributeDataDisk": { "properties": { "count": { "type": "integer", "description": "Number of disk blocks. Default is 4, maximum is 15, minimum is 1.\n" }, "size": { "type": "integer", "description": "Disk size. Default is 80GB, minimum is 60GB, maximum is 2048GB, unit: GB.\n" }, "volumeType": { "type": "string", "description": "Disk type. ESSD*PL0: Ultra SSD*PL0. ESSD*PL1: Ultra SSD*PL1. ESSD*PL2: Ultra SSD*PL2. ESSD*PL3: Ultra SSD*PL3. ESSD*FLEXPL: Ultra SSD*FlexPL. ULTRA*DISK: Efficient cloud disk. PTSSD: Performance SSD. SSD: General SSD. EHDD: Efficient cloud disk. ZENYA*SSD: Zenya. LOCAL*HDD: Big data HDD. LOCAL*SSD: Local SSD. LOCAL*SSD*SRIOV: Local SSD SRIOV.\n" } }, "type": "object", "required": [ "count", "size", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterNodeGroupAttributeSystemDisk:getClusterNodeGroupAttributeSystemDisk": { "properties": { "size": { "type": "integer", "description": "Disk size.\n" }, "volumeType": { "type": "string", "description": "Disk type.\n" } }, "type": "object", "required": [ "size", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterStateChangeReason:getClusterStateChangeReason": { "properties": { "code": { "type": "string", "description": "Status update code.\n" }, "reason": { "type": "string", "description": "Status update reason.\n" } }, "type": "object", "required": [ "code", "reason" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getClusterTag:getClusterTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getNodeGroupApplicationLayout:getNodeGroupApplicationLayout": { "properties": { "applicationName": { "type": "string", "description": "Application name.\n" }, "layoutComponentNames": { "type": "array", "items": { "type": "string" }, "description": "Custom configuration parameter list for the component.\n" } }, "type": "object", "required": [ "applicationName", "layoutComponentNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getNodeGroupChargePreConfig:getNodeGroupChargePreConfig": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether to enable auto-renewal.\n" }, "autoRenewPeriod": { "type": "integer", "description": "Renewal duration when auto-renewal is triggered. When autoRenew=true, the default value is 1.\n" }, "autoRenewPeriodUnit": { "type": "string", "description": "Renewal duration unit when auto-renewal is triggered. When autoRenew=true, the default value is Month. Value range: Month: month. Year: year.\n" }, "chargePeriod": { "type": "integer", "description": "When chargeType=PRE, the default value is 1. The unit for the purchase duration when chargeType=PRE is monthly subscription.\n" }, "chargePeriodUnit": { "type": "string", "description": "When chargeType=PRE, the default value is Month. The unit for the purchase duration when chargeType=PRE is monthly subscription. Value range: Month (month), Year (year).\n" }, "chargeType": { "type": "string", "description": "Payment type. Enum values: POST, PRE.\n" } }, "type": "object", "required": [ "autoRenew", "autoRenewPeriod", "autoRenewPeriodUnit", "chargePeriod", "chargePeriodUnit", "chargeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getNodeGroupDataDisk:getNodeGroupDataDisk": { "properties": { "count": { "type": "integer", "description": "Number of disk blocks. Default value: 4. Maximum: 15. Minimum: 1.\n" }, "size": { "type": "integer", "description": "Disk size. Default value: 80GB. Minimum: 60GB. Maximum: 2048GB. Unit: GB.\n" }, "volumeType": { "type": "string", "description": "Disk type. ESSD*PL0: Ultra-fast SSD*PL0. ESSD*PL1: Ultra-fast SSD*PL1. ESSD*PL2: Ultra-fast SSD*PL2. ESSD*PL3: Ultra-fast SSD*PL3. ESSD*FLEXPL: Ultra-fast SSD*FlexPL. ULTRA*DISK: Efficient cloud disk. PTSSD: Performance SSD. SSD: General SSD. EHDD: Efficient cloud disk. ZENYA*SSD: Zenya. LOCAL*HDD: Big data HDD. LOCAL*SSD: Local SSD. LOCAL*SSD*SRIOV: Local SSD SRIOV.\n" } }, "type": "object", "required": [ "count", "size", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getNodeGroupNode:getNodeGroupNode": { "properties": { "createdTime": { "type": "integer", "description": "Node creation time.\n" }, "ecsInstanceType": { "type": "string", "description": "ecs instance specification.\n" }, "nodeFqdn": { "type": "string", "description": "Node FQDN.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodeName": { "type": "string", "description": "Node name.\n" }, "nodeState": { "type": "string", "description": "Node status. UNKNOWN: Unknown. CREATING: Creating. RUNNING: Running. STOPPING: Stopping. STOPPED: Stopped. REBOOTING: Rebooting. DELETED: Deleted.\n" }, "privateIp": { "type": "string", "description": "Private IP.\n" }, "publicIp": { "type": "string", "description": "Public IP.\n" }, "readyTime": { "type": "integer", "description": "Ready time.\n" }, "terminateTime": { "type": "integer", "description": "Cluster termination time.\n" } }, "type": "object", "required": [ "createdTime", "ecsInstanceType", "nodeFqdn", "nodeId", "nodeName", "nodeState", "privateIp", "publicIp", "readyTime", "terminateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:emr/getNodeGroupSystemDisk:getNodeGroupSystemDisk": { "properties": { "size": { "type": "integer", "description": "System disk size. Default value: 80GB. Minimum: 60GB. Maximum: 2048GB. Unit: GB.\n" }, "volumeType": { "type": "string", "description": "Disk type. ESSD*PL0: Ultra-fast SSD*PL0. ESSD*PL1: Ultra-fast SSD*PL1. ESSD*PL2: Ultra-fast SSD*PL2. ESSD*PL3: Ultra-fast SSD*PL3. ESSD*FLEXPL: Ultra-fast SSD*FlexPL. ULTRA*DISK: Efficient cloud disk. PTSSD: Performance SSD. SSD: General SSD. EHDD: Efficient cloud disk. ZENYA*SSD: Zenya. LOCAL*HDD: Big data HDD. LOCAL*SSD: Local SSD. LOCAL*SSD*SRIOV: Local SSD SRIOV.\n" } }, "type": "object", "required": [ "size", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/InstanceInstanceConfiguration:InstanceInstanceConfiguration": { "properties": { "adminPassword": { "type": "string", "description": "Administrator password.\n" }, "adminUserName": { "type": "string", "description": "Administrator username.\n" }, "autoRenew": { "type": "boolean", "description": "Whether the subscription instance is set to auto-renewal. true: Auto-renewal; the system will automatically renew the instance before each expiration. false: Auto-renewal is not enabled; manual renewal is required before the instance expires. For more information, see Instance renewal.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. PostPaid: Pay-as-you-go. PrePaid: Subscription\n" }, "coldNodeNumber": { "type": "integer", "description": "Number of cold nodes.\n" }, "coldNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationColdNodeResourceSpec:InstanceInstanceConfigurationColdNodeResourceSpec", "description": "Node specification details for cold nodes\n" }, "coldNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationColdNodeStorageSpec:InstanceInstanceConfigurationColdNodeStorageSpec", "description": "Details of cold node storage specification configuration\n" }, "configurationCode": { "type": "string", "description": "Billing configuration code, obtainable via the DescribeNodeAvailableSpecs API.\n" }, "coordinatorNodeNumber": { "type": "integer", "description": "Coordinator node count\n" }, "coordinatorNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationCoordinatorNodeResourceSpec:InstanceInstanceConfigurationCoordinatorNodeResourceSpec", "description": "Node specification configuration details for coordinator node.\n" }, "coordinatorNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationCoordinatorNodeStorageSpec:InstanceInstanceConfigurationCoordinatorNodeStorageSpec", "description": "Storage specification configuration details for coordinator node.\n" }, "deletionProtection": { "type": "boolean", "description": "Enable instance deletion protection. Values: true: Enable instance deletion protection. false: Disable instance deletion protection. Note: After enabling deletion protection, you cannot delete the instance via console or API\n" }, "enableHttps": { "type": "boolean", "description": "Enable HTTPS access protocol. true: Enable HTTPS access. false: Disable HTTPS, use HTTP access. Note: If you choose HTTP access, you can access without security authentication and transmit data in plain HTTP. Ensure the security of your access environment and do not expose the API to the public network. After the instance is created, you can modify the transmission protocol as needed. For related documentation, see Switch Instance Transmission Protocol\n" }, "enablePureMaster": { "type": "boolean", "description": "Whether the master node is dedicated. true: Master node is dedicated. false: Master node is combined with data node, that is, uses Hot node.\n" }, "hotNodeNumber": { "type": "integer", "description": "Number of data nodes\n" }, "hotNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationHotNodeResourceSpec:InstanceInstanceConfigurationHotNodeResourceSpec", "description": "Node specification configuration details for data node.\n" }, "hotNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationHotNodeStorageSpec:InstanceInstanceConfigurationHotNodeStorageSpec", "description": "Data node storage specification configuration details\n" }, "instanceName": { "type": "string", "description": "Set a custom instance name. Only Chinese characters, letters, numbers, hyphens (-), and underscores (_) are allowed. The name cannot start or end with a number or hyphen (-). Length must be between 1 and 128 characters.\n" }, "kibanaNodeNumber": { "type": "integer", "description": "Number of Kibana nodes\n" }, "kibanaNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationKibanaNodeResourceSpec:InstanceInstanceConfigurationKibanaNodeResourceSpec", "description": "Kibana node specification configuration details\n" }, "masterNodeNumber": { "type": "integer", "description": "Number of master nodes.\n" }, "masterNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationMasterNodeResourceSpec:InstanceInstanceConfigurationMasterNodeResourceSpec", "description": "Master node specification configuration details\n" }, "masterNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationMasterNodeStorageSpec:InstanceInstanceConfigurationMasterNodeStorageSpec", "description": "Storage specification details for master node\n" }, "networkSpecs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationNetworkSpec:InstanceInstanceConfigurationNetworkSpec" } }, "nodeSpecsAssigns": { "type": "array", "items": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationNodeSpecsAssign:InstanceInstanceConfigurationNodeSpecsAssign" } }, "period": { "type": "integer", "description": "Subscription instance purchase duration, in months.\n" }, "projectName": { "type": "string", "description": "Set the project for your cloud search instance as needed to facilitate grouping and management of cloud resources. Projects provide a resource management method that helps maintain resource independence and data security. You can also view resource consumption bills by project, making it easier to calculate cloud resource usage costs. For more information, see Project Overview\n" }, "regionId": { "type": "string", "description": "Instance region\n" }, "subnet": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationSubnet:InstanceInstanceConfigurationSubnet", "description": "Set subnet information for the instance. Note: The subnet must be in the primary zone.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationTag:InstanceInstanceConfigurationTag" } }, "version": { "type": "string", "description": "API version. Value: 2023-01-01.\n" }, "vpc": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationVpc:InstanceInstanceConfigurationVpc", "description": "Set VPC information for the instance\n" }, "warmNodeNumber": { "type": "integer", "description": "Warm node count.\n" }, "warmNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationWarmNodeResourceSpec:InstanceInstanceConfigurationWarmNodeResourceSpec", "description": "Warm node specification configuration details.\n" }, "warmNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationWarmNodeStorageSpec:InstanceInstanceConfigurationWarmNodeStorageSpec", "description": "Storage specification details for warm nodes\n" }, "zoneId": { "type": "string", "description": "Zone where the instance is located. Note: For multi-zone deployment, enter multiple ZoneIds separated by commas, e.g., cn-beijing-a,cn-beijing-c. The leftmost ZoneId is the primary zone, others are backup zones.\n" }, "zoneNumber": { "type": "integer", "description": "Number of instance availability zones.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "adminPassword", "adminUserName", "autoRenew", "chargeType", "coldNodeNumber", "coldNodeResourceSpec", "coldNodeStorageSpec", "configurationCode", "coordinatorNodeNumber", "coordinatorNodeResourceSpec", "coordinatorNodeStorageSpec", "deletionProtection", "enableHttps", "enablePureMaster", "hotNodeNumber", "hotNodeResourceSpec", "hotNodeStorageSpec", "instanceName", "kibanaNodeNumber", "kibanaNodeResourceSpec", "masterNodeNumber", "masterNodeResourceSpec", "masterNodeStorageSpec", "networkSpecs", "nodeSpecsAssigns", "period", "projectName", "regionId", "subnet", "tags", "version", "vpc", "warmNodeNumber", "warmNodeResourceSpec", "warmNodeStorageSpec", "zoneId", "zoneNumber" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationColdNodeResourceSpec:InstanceInstanceConfigurationColdNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources for node specification, measured in cores.\n" }, "description": { "type": "string", "description": "Description of node specifications\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity for node specification, measured in GiB\n" }, "name": { "type": "string", "description": "Node specification. For details on node specification types and details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cpu", "description", "displayName", "memory", "name" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationColdNodeStorageSpec:InstanceInstanceConfigurationColdNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification\n" }, "displayName": { "type": "string", "description": "Display name of storage specification\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, measured in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum storage specification, measured in GiB\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Current storage specification value, in GiB.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "displayName", "maxSize", "minSize", "name", "size" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationCoordinatorNodeResourceSpec:InstanceInstanceConfigurationCoordinatorNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources of node specification, unit: cores.\n" }, "description": { "type": "string", "description": "Description of node specifications\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity of node specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Node specification. For details on node specification types and details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cpu", "description", "displayName", "memory", "name" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationCoordinatorNodeStorageSpec:InstanceInstanceConfigurationCoordinatorNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification.\n" }, "displayName": { "type": "string", "description": "Display name of storage specification\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum value for storage specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Current storage specification value, in GiB.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "displayName", "maxSize", "minSize", "name", "size" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationHotNodeResourceSpec:InstanceInstanceConfigurationHotNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources of node specification, measured in cores\n" }, "description": { "type": "string", "description": "Description of node specification.\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity for node specification, measured in GiB.\n" }, "name": { "type": "string", "description": "Node specification. For details on node specification types and details, see Product Specifications.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cpu", "description", "displayName", "memory", "name" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationHotNodeStorageSpec:InstanceInstanceConfigurationHotNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification\n" }, "displayName": { "type": "string", "description": "Display name of storage specification.\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum storage specification, measured in GiB.\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Configured available disk space size\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "displayName", "maxSize", "minSize", "name", "size" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationKibanaNodeResourceSpec:InstanceInstanceConfigurationKibanaNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources for node specification, measured in cores.\n" }, "description": { "type": "string", "description": "Description of node specifications\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity for node specification, measured in GiB\n" }, "name": { "type": "string", "description": "Node specification. For information about node specification types and details, please refer to the documentation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cpu", "description", "displayName", "memory", "name" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationMasterNodeResourceSpec:InstanceInstanceConfigurationMasterNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources of node specification, unit: cores.\n" }, "description": { "type": "string", "description": "Description of node specifications\n" }, "displayName": { "type": "string", "description": "Display name of node specification\n" }, "memory": { "type": "integer", "description": "Memory capacity of node specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Node specification. For information about node specification types and details, please refer to the documentation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cpu", "description", "displayName", "memory", "name" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationMasterNodeStorageSpec:InstanceInstanceConfigurationMasterNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification.\n" }, "displayName": { "type": "string", "description": "Display name of storage specification.\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, measured in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum value for storage specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Current storage specification value, in GiB.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "displayName", "maxSize", "minSize", "name", "size" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationNetworkSpec:InstanceInstanceConfigurationNetworkSpec": { "properties": { "bandwidth": { "type": "integer", "description": "Public IP bandwidth limit. Default is '1', unit: Mbps.\n" }, "isOpen": { "type": "boolean", "description": "Enable/Disable\n" }, "specName": { "type": "string", "description": "Instance public resource specification name\n" }, "type": { "type": "string", "description": "Public network application types: Elasticsearch—for ES instance usage. Kibana—for Dashboard usage\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "isOpen", "specName", "type" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationNodeSpecsAssign:InstanceInstanceConfigurationNodeSpecsAssign": { "properties": { "extraPerformance": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfigurationNodeSpecsAssignExtraPerformance:InstanceInstanceConfigurationNodeSpecsAssignExtraPerformance", "description": "Disk extra performance package configuration.\n" }, "number": { "type": "integer", "description": "Node count. When configuring the number of data nodes, note the following based on deployment mode: Single availability zone deployment: For production environments, configure at least 3 data nodes. Configuring 2 nodes poses a split-brain risk. If dedicated master nodes are enabled, 2 data nodes will not result in split-brain. Dual availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 4 data nodes—2 per availability zone. Triple availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 6 data nodes—2 per availability zone. You can set the number of data nodes from 1 to 100. If you need more, apply to increase the quota to 200. Master node configuration: If dedicated master nodes are not enabled, master node configuration matches data nodes; otherwise, master node configuration is independent. Dedicated master node configuration: If you need to enable dedicated master nodes, the default number is 3. Kibana node configuration: The number is fixed at 1. Coordinator node configuration: If enabled, configure at least 2 coordinator nodes for production environments. The configurable range is 2–50. Warm data nodes: If enabled, configure at least 3 warm data nodes for production environments, up to 100. Cold data nodes: If enabled, configure at least 2 cold data nodes for production environments, up to 100.\n" }, "resourceSpecName": { "type": "string", "description": "Compute resource specification name. You can call the DescribeNodeAvailableSpecs API to get the list of available node specifications. For details, see V2 instance specifications.\n" }, "storageSize": { "type": "integer", "description": "Storage capacity, measured in GiB. Default value is 100 GiB, adjustment step is 10 GiB. Note: StorageSize for Kibana nodes is set to 0, i.e., \"StorageSize\": 0. StorageSize for dedicated master and coordinator nodes defaults to 20\n" }, "storageSpecName": { "type": "string", "description": "Storage specification name. Currently supported specifications: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0. es.volume.essd.flexpl-standard: Standard Edition - High Performance Cloud Disk - flexpl. Note: StorageSpecName for Kibana nodes is set to empty, i.e., \"StorageSpecName\": \"\"\n" }, "type": { "type": "string", "description": "Node type. Please understand the function of each node type first, then determine whether to create based on your business needs. For details, see node types. Master: Master node. Hot: Data node. Cold: Cold data node. Warm: Warm data node. Kibana: Kibana node. Coordinator: Coordinator node\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "extraPerformance", "number", "resourceSpecName", "storageSize", "storageSpecName", "type" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationNodeSpecsAssignExtraPerformance:InstanceInstanceConfigurationNodeSpecsAssignExtraPerformance": { "properties": { "throughput": { "type": "integer", "description": "When your data node uses the FlexPL storage type and the storage specification is 500 GiB or above, you can purchase a bandwidth package to increase disk bandwidth. Unit: MiB; adjustment step: 10 MiB. Supported storage specifications and corresponding maximum throughput for additional performance packages are as follows: es.volume.essd.flexpl-standard: 650.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "throughput" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationSubnet:InstanceInstanceConfigurationSubnet": { "properties": { "subnetId": { "type": "string", "description": "Subnet ID。\n" }, "subnetName": { "type": "string", "description": "Subnet name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "subnetId", "subnetName" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationTag:InstanceInstanceConfigurationTag": { "properties": { "key": { "type": "string", "description": "Tag key for user labels. Length limit: 1–128 characters. Case-sensitive. Cannot start or end with a space. Letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), minus (-), and @ are allowed. Duplicate tag keys are not allowed for the same resource\n" }, "value": { "type": "string", "description": "Tag value for user tag. Length limit: 0–256 characters. Case-sensitive, cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscore (_), period (.), colon (:), slash (/), equals (=), plus (+), minus (-), and @\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationVpc:InstanceInstanceConfigurationVpc": { "properties": { "vpcId": { "type": "string", "description": "VPC ID。\n" }, "vpcName": { "type": "string", "description": "VPC name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "vpcId", "vpcName" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationWarmNodeResourceSpec:InstanceInstanceConfigurationWarmNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources for node specification, measured in cores.\n" }, "description": { "type": "string", "description": "Description of node specification\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity for node specification, measured in GiB\n" }, "name": { "type": "string", "description": "Node specification. For details on node specification types and details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cpu", "description", "displayName", "memory", "name" ] } } }, "volcenginecc:escloud/InstanceInstanceConfigurationWarmNodeStorageSpec:InstanceInstanceConfigurationWarmNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification.\n" }, "displayName": { "type": "string", "description": "Display name of storage specification.\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, measured in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum value for storage specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Current storage specification value, in GiB.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "displayName", "maxSize", "minSize", "name", "size" ] } } }, "volcenginecc:escloud/InstanceKibanaConfig:InstanceKibanaConfig": { "properties": { "requestTimeout": { "type": "integer", "description": "API request timeout duration. Default is 30000 milliseconds. If the backend response exceeds 30 seconds, a 503 Request timed out error will occur. To receive responses normally and reduce 503 errors, you can increase the request timeout duration\n" }, "sessionKeepAlive": { "type": "boolean", "description": "Whether to proactively extend session validity. true: Default value, session validity is extended with each page request. false: Session validity is not proactively extended. With this setting, session timeout can occur; when login duration reaches the session validity period, you will be automatically logged out.\n" }, "sessionTtl": { "type": "integer", "description": "Session validity duration. Default is 3600000 milliseconds (1 hour). If you set Session activity retention to No, you will be automatically logged out when the login duration reaches the session validity duration\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "requestTimeout", "sessionKeepAlive", "sessionTtl" ] } } }, "volcenginecc:escloud/InstanceSubInstance:InstanceSubInstance": { "properties": { "subInstanceId": { "type": "string", "description": "Enterprise-level SQL analysis instance ID.\n" }, "subInstanceStatus": { "type": "string", "description": "Instance status\n" }, "subInstanceType": { "type": "string", "description": "Instance type\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "subInstanceId", "subInstanceStatus", "subInstanceType" ] } } }, "volcenginecc:escloud/InstanceTransferInfo:InstanceTransferInfo": { "properties": { "forbidStop": { "type": "boolean", "description": "ForbidStop\n" }, "reduceSpecConfig": { "$ref": "#/types/volcenginecc:escloud/InstanceTransferInfoReduceSpecConfig:InstanceTransferInfoReduceSpecConfig", "description": "Resource information\n" }, "transferProgress": { "type": "number", "description": "Data migration task progress, percentage\n" }, "transferStatus": { "type": "string", "description": "Data migration task status\n" }, "transferTaskId": { "type": "string", "description": "Data migration task ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "forbidStop", "reduceSpecConfig", "transferProgress", "transferStatus", "transferTaskId" ] } } }, "volcenginecc:escloud/InstanceTransferInfoReduceSpecConfig:InstanceTransferInfoReduceSpecConfig": { "properties": { "coldNodeNum": { "type": "integer", "description": "Number of cold nodes.\n" }, "dataNodeNum": { "type": "integer", "description": "Number of data nodes\n" }, "enablePureMaster": { "type": "boolean", "description": "Whether the master node is independent. true: Master node is independent. false: Master node overlaps with data node, declared as Hot\n" }, "masterNodeNum": { "type": "integer", "description": "Number of master nodes.\n" }, "warmNodeNum": { "type": "integer", "description": "Number of warm nodes\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "coldNodeNum", "dataNodeNum", "enablePureMaster", "masterNodeNum", "warmNodeNum" ] } } }, "volcenginecc:escloud/getInstanceInstanceConfiguration:getInstanceInstanceConfiguration": { "properties": { "adminPassword": { "type": "string", "description": "Administrator password.\n" }, "adminUserName": { "type": "string", "description": "Administrator username.\n" }, "autoRenew": { "type": "boolean", "description": "Whether the subscription instance is set to auto-renewal. true: Auto-renewal; the system will automatically renew the instance before each expiration. false: Auto-renewal is not enabled; manual renewal is required before the instance expires. For more information, see Instance renewal.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. PostPaid: Pay-as-you-go. PrePaid: Subscription\n" }, "coldNodeNumber": { "type": "integer", "description": "Number of cold nodes.\n" }, "coldNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationColdNodeResourceSpec:getInstanceInstanceConfigurationColdNodeResourceSpec", "description": "Node specification details for cold nodes\n" }, "coldNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationColdNodeStorageSpec:getInstanceInstanceConfigurationColdNodeStorageSpec", "description": "Details of cold node storage specification configuration\n" }, "configurationCode": { "type": "string", "description": "Billing configuration code, obtainable via the DescribeNodeAvailableSpecs API.\n" }, "coordinatorNodeNumber": { "type": "integer", "description": "Coordinator node count\n" }, "coordinatorNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationCoordinatorNodeResourceSpec:getInstanceInstanceConfigurationCoordinatorNodeResourceSpec", "description": "Node specification configuration details for coordinator node.\n" }, "coordinatorNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationCoordinatorNodeStorageSpec:getInstanceInstanceConfigurationCoordinatorNodeStorageSpec", "description": "Storage specification configuration details for coordinator node.\n" }, "deletionProtection": { "type": "boolean", "description": "Enable instance deletion protection. Values: true: Enable instance deletion protection. false: Disable instance deletion protection. Note: After enabling deletion protection, you cannot delete the instance via console or API\n" }, "enableHttps": { "type": "boolean", "description": "Enable HTTPS access protocol. true: Enable HTTPS access. false: Disable HTTPS, use HTTP access. Note: If you choose HTTP access, you can access without security authentication and transmit data in plain HTTP. Ensure the security of your access environment and do not expose the API to the public network. After the instance is created, you can modify the transmission protocol as needed. For related documentation, see Switch Instance Transmission Protocol\n" }, "enablePureMaster": { "type": "boolean", "description": "Whether the master node is dedicated. true: Master node is dedicated. false: Master node is combined with data node, that is, uses Hot node.\n" }, "hotNodeNumber": { "type": "integer", "description": "Number of data nodes\n" }, "hotNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationHotNodeResourceSpec:getInstanceInstanceConfigurationHotNodeResourceSpec", "description": "Node specification configuration details for data node.\n" }, "hotNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationHotNodeStorageSpec:getInstanceInstanceConfigurationHotNodeStorageSpec", "description": "Data node storage specification configuration details\n" }, "instanceName": { "type": "string", "description": "Set a custom instance name. Only Chinese characters, letters, numbers, hyphens (-), and underscores (_) are allowed. The name cannot start or end with a number or hyphen (-). Length must be between 1 and 128 characters.\n" }, "kibanaNodeNumber": { "type": "integer", "description": "Number of Kibana nodes\n" }, "kibanaNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationKibanaNodeResourceSpec:getInstanceInstanceConfigurationKibanaNodeResourceSpec", "description": "Kibana node specification configuration details\n" }, "masterNodeNumber": { "type": "integer", "description": "Number of master nodes.\n" }, "masterNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationMasterNodeResourceSpec:getInstanceInstanceConfigurationMasterNodeResourceSpec", "description": "Master node specification configuration details\n" }, "masterNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationMasterNodeStorageSpec:getInstanceInstanceConfigurationMasterNodeStorageSpec", "description": "Storage specification details for master node\n" }, "networkSpecs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationNetworkSpec:getInstanceInstanceConfigurationNetworkSpec" }, "description": "Instance public network specification configuration\n" }, "nodeSpecsAssigns": { "type": "array", "items": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationNodeSpecsAssign:getInstanceInstanceConfigurationNodeSpecsAssign" }, "description": "Configuration of node counts and specifications in the instance\n" }, "period": { "type": "integer", "description": "Subscription instance purchase duration, in months.\n" }, "projectName": { "type": "string", "description": "Set the project for your cloud search instance as needed to facilitate grouping and management of cloud resources. Projects provide a resource management method that helps maintain resource independence and data security. You can also view resource consumption bills by project, making it easier to calculate cloud resource usage costs. For more information, see Project Overview\n" }, "regionId": { "type": "string", "description": "Instance region\n" }, "subnet": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationSubnet:getInstanceInstanceConfigurationSubnet", "description": "Set subnet information for the instance. Note: The subnet must be in the primary zone.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationTag:getInstanceInstanceConfigurationTag" }, "description": "Tag information\n" }, "version": { "type": "string", "description": "API version. Value: 2023-01-01.\n" }, "vpc": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationVpc:getInstanceInstanceConfigurationVpc", "description": "Set VPC information for the instance\n" }, "warmNodeNumber": { "type": "integer", "description": "Warm node count.\n" }, "warmNodeResourceSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationWarmNodeResourceSpec:getInstanceInstanceConfigurationWarmNodeResourceSpec", "description": "Warm node specification configuration details.\n" }, "warmNodeStorageSpec": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationWarmNodeStorageSpec:getInstanceInstanceConfigurationWarmNodeStorageSpec", "description": "Storage specification details for warm nodes\n" }, "zoneId": { "type": "string", "description": "Zone where the instance is located. Note: For multi-zone deployment, enter multiple ZoneIds separated by commas, e.g., cn-beijing-a,cn-beijing-c. The leftmost ZoneId is the primary zone, others are backup zones.\n" }, "zoneNumber": { "type": "integer", "description": "Number of instance availability zones.\n" } }, "type": "object", "required": [ "adminPassword", "adminUserName", "autoRenew", "chargeType", "coldNodeNumber", "coldNodeResourceSpec", "coldNodeStorageSpec", "configurationCode", "coordinatorNodeNumber", "coordinatorNodeResourceSpec", "coordinatorNodeStorageSpec", "deletionProtection", "enableHttps", "enablePureMaster", "hotNodeNumber", "hotNodeResourceSpec", "hotNodeStorageSpec", "instanceName", "kibanaNodeNumber", "kibanaNodeResourceSpec", "masterNodeNumber", "masterNodeResourceSpec", "masterNodeStorageSpec", "networkSpecs", "nodeSpecsAssigns", "period", "projectName", "regionId", "subnet", "tags", "version", "vpc", "warmNodeNumber", "warmNodeResourceSpec", "warmNodeStorageSpec", "zoneId", "zoneNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationColdNodeResourceSpec:getInstanceInstanceConfigurationColdNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources for node specification, measured in cores.\n" }, "description": { "type": "string", "description": "Description of node specifications\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity for node specification, measured in GiB\n" }, "name": { "type": "string", "description": "Node specification. For details on node specification types and details.\n" } }, "type": "object", "required": [ "cpu", "description", "displayName", "memory", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationColdNodeStorageSpec:getInstanceInstanceConfigurationColdNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification\n" }, "displayName": { "type": "string", "description": "Display name of storage specification\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, measured in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum storage specification, measured in GiB\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Current storage specification value, in GiB.\n" } }, "type": "object", "required": [ "description", "displayName", "maxSize", "minSize", "name", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationCoordinatorNodeResourceSpec:getInstanceInstanceConfigurationCoordinatorNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources of node specification, unit: cores.\n" }, "description": { "type": "string", "description": "Description of node specifications\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity of node specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Node specification. For details on node specification types and details.\n" } }, "type": "object", "required": [ "cpu", "description", "displayName", "memory", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationCoordinatorNodeStorageSpec:getInstanceInstanceConfigurationCoordinatorNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification.\n" }, "displayName": { "type": "string", "description": "Display name of storage specification\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum value for storage specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Current storage specification value, in GiB.\n" } }, "type": "object", "required": [ "description", "displayName", "maxSize", "minSize", "name", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationHotNodeResourceSpec:getInstanceInstanceConfigurationHotNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources of node specification, measured in cores\n" }, "description": { "type": "string", "description": "Description of node specification.\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity for node specification, measured in GiB.\n" }, "name": { "type": "string", "description": "Node specification. For details on node specification types and details, see Product Specifications.\n" } }, "type": "object", "required": [ "cpu", "description", "displayName", "memory", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationHotNodeStorageSpec:getInstanceInstanceConfigurationHotNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification\n" }, "displayName": { "type": "string", "description": "Display name of storage specification.\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum storage specification, measured in GiB.\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Configured available disk space size\n" } }, "type": "object", "required": [ "description", "displayName", "maxSize", "minSize", "name", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationKibanaNodeResourceSpec:getInstanceInstanceConfigurationKibanaNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources for node specification, measured in cores.\n" }, "description": { "type": "string", "description": "Description of node specifications\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity for node specification, measured in GiB\n" }, "name": { "type": "string", "description": "Node specification. For information about node specification types and details, please refer to the documentation.\n" } }, "type": "object", "required": [ "cpu", "description", "displayName", "memory", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationMasterNodeResourceSpec:getInstanceInstanceConfigurationMasterNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources of node specification, unit: cores.\n" }, "description": { "type": "string", "description": "Description of node specifications\n" }, "displayName": { "type": "string", "description": "Display name of node specification\n" }, "memory": { "type": "integer", "description": "Memory capacity of node specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Node specification. For information about node specification types and details, please refer to the documentation.\n" } }, "type": "object", "required": [ "cpu", "description", "displayName", "memory", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationMasterNodeStorageSpec:getInstanceInstanceConfigurationMasterNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification.\n" }, "displayName": { "type": "string", "description": "Display name of storage specification.\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, measured in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum value for storage specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Current storage specification value, in GiB.\n" } }, "type": "object", "required": [ "description", "displayName", "maxSize", "minSize", "name", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationNetworkSpec:getInstanceInstanceConfigurationNetworkSpec": { "properties": { "bandwidth": { "type": "integer", "description": "Public IP bandwidth limit. Default is '1', unit: Mbps.\n" }, "isOpen": { "type": "boolean", "description": "Enable/Disable\n" }, "specName": { "type": "string", "description": "Instance public resource specification name\n" }, "type": { "type": "string", "description": "Public network application types: Elasticsearch—for ES instance usage. Kibana—for Dashboard usage\n" } }, "type": "object", "required": [ "bandwidth", "isOpen", "specName", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationNodeSpecsAssign:getInstanceInstanceConfigurationNodeSpecsAssign": { "properties": { "extraPerformance": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance:getInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance", "description": "Disk extra performance package configuration.\n" }, "number": { "type": "integer", "description": "Node count. When configuring the number of data nodes, note the following based on deployment mode: Single availability zone deployment: For production environments, configure at least 3 data nodes. Configuring 2 nodes poses a split-brain risk. If dedicated master nodes are enabled, 2 data nodes will not result in split-brain. Dual availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 4 data nodes—2 per availability zone. Triple availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 6 data nodes—2 per availability zone. You can set the number of data nodes from 1 to 100. If you need more, apply to increase the quota to 200. Master node configuration: If dedicated master nodes are not enabled, master node configuration matches data nodes; otherwise, master node configuration is independent. Dedicated master node configuration: If you need to enable dedicated master nodes, the default number is 3. Kibana node configuration: The number is fixed at 1. Coordinator node configuration: If enabled, configure at least 2 coordinator nodes for production environments. The configurable range is 2–50. Warm data nodes: If enabled, configure at least 3 warm data nodes for production environments, up to 100. Cold data nodes: If enabled, configure at least 2 cold data nodes for production environments, up to 100.\n" }, "resourceSpecName": { "type": "string", "description": "Compute resource specification name. You can call the DescribeNodeAvailableSpecs API to get the list of available node specifications. For details, see V2 instance specifications.\n" }, "storageSize": { "type": "integer", "description": "Storage capacity, measured in GiB. Default value is 100 GiB, adjustment step is 10 GiB. Note: StorageSize for Kibana nodes is set to 0, i.e., \"StorageSize\": 0. StorageSize for dedicated master and coordinator nodes defaults to 20\n" }, "storageSpecName": { "type": "string", "description": "Storage specification name. Currently supported specifications: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0. es.volume.essd.flexpl-standard: Standard Edition - High Performance Cloud Disk - flexpl. Note: StorageSpecName for Kibana nodes is set to empty, i.e., \"StorageSpecName\": \"\"\n" }, "type": { "type": "string", "description": "Node type. Please understand the function of each node type first, then determine whether to create based on your business needs. For details, see node types. Master: Master node. Hot: Data node. Cold: Cold data node. Warm: Warm data node. Kibana: Kibana node. Coordinator: Coordinator node\n" } }, "type": "object", "required": [ "extraPerformance", "number", "resourceSpecName", "storageSize", "storageSpecName", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance:getInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance": { "properties": { "throughput": { "type": "integer", "description": "When your data node uses the FlexPL storage type and the storage specification is 500 GiB or above, you can purchase a bandwidth package to increase disk bandwidth. Unit: MiB; adjustment step: 10 MiB. Supported storage specifications and corresponding maximum throughput for additional performance packages are as follows: es.volume.essd.flexpl-standard: 650.\n" } }, "type": "object", "required": [ "throughput" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationSubnet:getInstanceInstanceConfigurationSubnet": { "properties": { "subnetId": { "type": "string", "description": "Subnet ID。\n" }, "subnetName": { "type": "string", "description": "Subnet name\n" } }, "type": "object", "required": [ "subnetId", "subnetName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationTag:getInstanceInstanceConfigurationTag": { "properties": { "key": { "type": "string", "description": "Tag key for user labels. Length limit: 1–128 characters. Case-sensitive. Cannot start or end with a space. Letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), minus (-), and @ are allowed. Duplicate tag keys are not allowed for the same resource\n" }, "value": { "type": "string", "description": "Tag value for user tag. Length limit: 0–256 characters. Case-sensitive, cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscore (_), period (.), colon (:), slash (/), equals (=), plus (+), minus (-), and @\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationVpc:getInstanceInstanceConfigurationVpc": { "properties": { "vpcId": { "type": "string", "description": "VPC ID。\n" }, "vpcName": { "type": "string", "description": "VPC name\n" } }, "type": "object", "required": [ "vpcId", "vpcName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationWarmNodeResourceSpec:getInstanceInstanceConfigurationWarmNodeResourceSpec": { "properties": { "cpu": { "type": "integer", "description": "CPU resources for node specification, measured in cores.\n" }, "description": { "type": "string", "description": "Description of node specification\n" }, "displayName": { "type": "string", "description": "Display name of node specification.\n" }, "memory": { "type": "integer", "description": "Memory capacity for node specification, measured in GiB\n" }, "name": { "type": "string", "description": "Node specification. For details on node specification types and details.\n" } }, "type": "object", "required": [ "cpu", "description", "displayName", "memory", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceInstanceConfigurationWarmNodeStorageSpec:getInstanceInstanceConfigurationWarmNodeStorageSpec": { "properties": { "description": { "type": "string", "description": "Description of storage specification.\n" }, "displayName": { "type": "string", "description": "Display name of storage specification.\n" }, "maxSize": { "type": "integer", "description": "Maximum storage specification, measured in GiB\n" }, "minSize": { "type": "integer", "description": "Minimum value for storage specification, unit: GiB.\n" }, "name": { "type": "string", "description": "Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0\n" }, "size": { "type": "integer", "description": "Current storage specification value, in GiB.\n" } }, "type": "object", "required": [ "description", "displayName", "maxSize", "minSize", "name", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceKibanaConfig:getInstanceKibanaConfig": { "properties": { "requestTimeout": { "type": "integer", "description": "API request timeout duration. Default is 30000 milliseconds. If the backend response exceeds 30 seconds, a 503 Request timed out error will occur. To receive responses normally and reduce 503 errors, you can increase the request timeout duration\n" }, "sessionKeepAlive": { "type": "boolean", "description": "Whether to proactively extend session validity. true: Default value, session validity is extended with each page request. false: Session validity is not proactively extended. With this setting, session timeout can occur; when login duration reaches the session validity period, you will be automatically logged out.\n" }, "sessionTtl": { "type": "integer", "description": "Session validity duration. Default is 3600000 milliseconds (1 hour). If you set Session activity retention to No, you will be automatically logged out when the login duration reaches the session validity duration\n" } }, "type": "object", "required": [ "requestTimeout", "sessionKeepAlive", "sessionTtl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceSubInstance:getInstanceSubInstance": { "properties": { "subInstanceId": { "type": "string", "description": "Enterprise-level SQL analysis instance ID.\n" }, "subInstanceStatus": { "type": "string", "description": "Instance status\n" }, "subInstanceType": { "type": "string", "description": "Instance type\n" } }, "type": "object", "required": [ "subInstanceId", "subInstanceStatus", "subInstanceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceTransferInfo:getInstanceTransferInfo": { "properties": { "forbidStop": { "type": "boolean", "description": "ForbidStop\n" }, "reduceSpecConfig": { "$ref": "#/types/volcenginecc:escloud/getInstanceTransferInfoReduceSpecConfig:getInstanceTransferInfoReduceSpecConfig", "description": "Resource information\n" }, "transferProgress": { "type": "number", "description": "Data migration task progress, percentage\n" }, "transferStatus": { "type": "string", "description": "Data migration task status\n" }, "transferTaskId": { "type": "string", "description": "Data migration task ID\n" } }, "type": "object", "required": [ "forbidStop", "reduceSpecConfig", "transferProgress", "transferStatus", "transferTaskId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:escloud/getInstanceTransferInfoReduceSpecConfig:getInstanceTransferInfoReduceSpecConfig": { "properties": { "coldNodeNum": { "type": "integer", "description": "Number of cold nodes.\n" }, "dataNodeNum": { "type": "integer", "description": "Number of data nodes\n" }, "enablePureMaster": { "type": "boolean", "description": "Whether the master node is independent. true: Master node is independent. false: Master node overlaps with data node, declared as Hot\n" }, "masterNodeNum": { "type": "integer", "description": "Number of master nodes.\n" }, "warmNodeNum": { "type": "integer", "description": "Number of warm nodes\n" } }, "type": "object", "required": [ "coldNodeNum", "dataNodeNum", "enablePureMaster", "masterNodeNum", "warmNodeNum" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:filenas/InstanceCachePerformance:InstanceCachePerformance": { "properties": { "cacheBandwidth": { "type": "integer", "description": "Provisioned bandwidth, used to increase file system bandwidth\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cacheBandwidth" ] } } }, "volcenginecc:filenas/InstanceCapacity:InstanceCapacity": { "properties": { "total": { "type": "number", "description": "Total available file system capacity, in GiB\n" }, "used": { "type": "number", "description": "Used file system capacity, in MiB\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "total", "used" ] } } }, "volcenginecc:filenas/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "type": { "type": "string", "description": "Tag type\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "type", "value" ] } } }, "volcenginecc:filenas/MountPointClient:MountPointClient": { "properties": { "ip": { "type": "string", "description": "Client's private network IP address.\n" }, "protocolVersion": { "type": "string", "description": "Mount protocol version. Value: NFSv3.\n" }, "vpcName": { "type": "string", "description": "Private network name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ip", "protocolVersion", "vpcName" ] } } }, "volcenginecc:filenas/MountPointPermissionGroup:MountPointPermissionGroup": { "properties": { "createTime": { "type": "string", "description": "Permission group creation time.\n" }, "description": { "type": "string", "description": "Permission group description information.\n" }, "fileSystemCount": { "type": "integer", "description": "Number of file systems associated with this permission group.\n" }, "fileSystemType": { "type": "string", "description": "File system type. Value explanation: Extreme: NAS extreme type. Capacity: NAS capacity type. Cache: NAS cache type.\n" }, "mountPoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:filenas/MountPointPermissionGroupMountPoint:MountPointPermissionGroupMountPoint" } }, "permissionGroupName": { "type": "string", "description": "Permission group name.\n" }, "permissionRuleCount": { "type": "integer", "description": "Number of permission rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createTime", "description", "fileSystemCount", "fileSystemType", "mountPoints", "permissionGroupName", "permissionRuleCount" ] } } }, "volcenginecc:filenas/MountPointPermissionGroupMountPoint:MountPointPermissionGroupMountPoint": { "properties": { "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "mountPointId": { "type": "string", "description": "Mount point ID.\n" }, "mountPointName": { "type": "string", "description": "Mount point name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fileSystemId", "mountPointId", "mountPointName" ] } } }, "volcenginecc:filenas/getInstanceCachePerformance:getInstanceCachePerformance": { "properties": { "cacheBandwidth": { "type": "integer", "description": "Provisioned bandwidth, used to increase file system bandwidth\n" } }, "type": "object", "required": [ "cacheBandwidth" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:filenas/getInstanceCapacity:getInstanceCapacity": { "properties": { "total": { "type": "number", "description": "Total available file system capacity, in GiB\n" }, "used": { "type": "number", "description": "Used file system capacity, in MiB\n" } }, "type": "object", "required": [ "total", "used" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:filenas/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "type": { "type": "string", "description": "Tag type\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:filenas/getMountPointClient:getMountPointClient": { "properties": { "ip": { "type": "string", "description": "Client's private network IP address.\n" }, "protocolVersion": { "type": "string", "description": "Mount protocol version. Value: NFSv3.\n" }, "vpcName": { "type": "string", "description": "Private network name.\n" } }, "type": "object", "required": [ "ip", "protocolVersion", "vpcName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:filenas/getMountPointPermissionGroup:getMountPointPermissionGroup": { "properties": { "createTime": { "type": "string", "description": "Permission group creation time.\n" }, "description": { "type": "string", "description": "Permission group description information.\n" }, "fileSystemCount": { "type": "integer", "description": "Number of file systems associated with this permission group.\n" }, "fileSystemType": { "type": "string", "description": "File system type. Value explanation: Extreme: NAS extreme type. Capacity: NAS capacity type. Cache: NAS cache type.\n" }, "mountPoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:filenas/getMountPointPermissionGroupMountPoint:getMountPointPermissionGroupMountPoint" }, "description": "Information about mount points that use this permission group.\n" }, "permissionGroupName": { "type": "string", "description": "Permission group name.\n" }, "permissionRuleCount": { "type": "integer", "description": "Number of permission rules.\n" } }, "type": "object", "required": [ "createTime", "description", "fileSystemCount", "fileSystemType", "mountPoints", "permissionGroupName", "permissionRuleCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:filenas/getMountPointPermissionGroupMountPoint:getMountPointPermissionGroupMountPoint": { "properties": { "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "mountPointId": { "type": "string", "description": "Mount point ID.\n" }, "mountPointName": { "type": "string", "description": "Mount point name.\n" } }, "type": "object", "required": [ "fileSystemId", "mountPointId", "mountPointName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:fwcenter/DnsControlPolicyDomainListV1:DnsControlPolicyDomainListV1": { "properties": { "address": { "type": "string", "description": "Specific address information.\n" }, "description": { "type": "string", "description": "Description information.\n" }, "type": { "type": "string", "description": "Address type. Supported values are as follows. ip: IPv4 address; ipv6: IPv6 address; domain: domain name; port: port number.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "address", "description", "type" ] } } }, "volcenginecc:fwcenter/DnsControlPolicySource:DnsControlPolicySource": { "properties": { "region": { "type": "string", "description": "VPC region information.\n" }, "vpcId": { "type": "string", "description": "VPC ID。\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "region", "vpcId" ] } } }, "volcenginecc:fwcenter/getDnsControlPolicyDomainListV1:getDnsControlPolicyDomainListV1": { "properties": { "address": { "type": "string", "description": "Specific address information.\n" }, "description": { "type": "string", "description": "Description information.\n" }, "type": { "type": "string", "description": "Address type. Supported values are as follows. ip: IPv4 address; ipv6: IPv6 address; domain: domain name; port: port number.\n" } }, "type": "object", "required": [ "address", "description", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:fwcenter/getDnsControlPolicySource:getDnsControlPolicySource": { "properties": { "region": { "type": "string", "description": "VPC region information.\n" }, "vpcId": { "type": "string", "description": "VPC ID。\n" } }, "type": "object", "required": [ "region", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:hbase/InstanceEndpoint:InstanceEndpoint": { "properties": { "addressType": { "type": "string", "description": "Connection address type. For more information about connection addresses, see Connection Address Types. The value range is as follows: Zk: ZK address. Thrift: Thrift2 address. HBaseReUsedEipId: When public access is enabled for the ZK or Thrift2 connection address, this parameter is returned, indicating the EIP ID information shared and used by other components in the instance (such as RS nodes, Master nodes, etc.)\n" }, "eipId": { "type": "string", "description": "When the ZK connection address or Thrift2 connection address enables public access, this parameter is returned, indicating the EIP ID.\n" }, "endpointId": { "type": "string", "description": "Connection address ID. By default, only the ZK private network connection address is returned. If you apply for a Thrift2 connection address or enable public access for the ZK or Thrift2 connection address, the corresponding connection address ID will also be returned. When the connection address type is HBaseReUsedEipId, the connection address ID is fixed as HBaseReUsedEipId\n" }, "endpointStr": { "type": "string", "description": "Connection string for the connection address. By default, only the ZK private network connection address is returned. If you have requested a Thrift2 connection address, or enabled public access for ZK or Thrift2 connection addresses, the corresponding connection string will also be provided. When the connection address type is HBaseReUsedEipId, the connection string is always set to HBaseReUsedEipId.\n" }, "networkType": { "type": "string", "description": "Connection address network type. Value range: Public: public access address. Private: private access address.\n" }, "privateDnsVisibility": { "type": "boolean", "description": "Whether public DNS resolution is enabled for the private network domain name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "addressType", "eipId", "endpointId", "endpointStr", "networkType", "privateDnsVisibility" ] } } }, "volcenginecc:hbase/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key of the tags bound to the instance\n" }, "value": { "type": "string", "description": "Tag values bound to the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:hbase/getInstanceEndpoint:getInstanceEndpoint": { "properties": { "addressType": { "type": "string", "description": "Connection address type. For more information about connection addresses, see Connection Address Types. The value range is as follows: Zk: ZK address. Thrift: Thrift2 address. HBaseReUsedEipId: When public access is enabled for the ZK or Thrift2 connection address, this parameter is returned, indicating the EIP ID information shared and used by other components in the instance (such as RS nodes, Master nodes, etc.)\n" }, "eipId": { "type": "string", "description": "When the ZK connection address or Thrift2 connection address enables public access, this parameter is returned, indicating the EIP ID.\n" }, "endpointId": { "type": "string", "description": "Connection address ID. By default, only the ZK private network connection address is returned. If you apply for a Thrift2 connection address or enable public access for the ZK or Thrift2 connection address, the corresponding connection address ID will also be returned. When the connection address type is HBaseReUsedEipId, the connection address ID is fixed as HBaseReUsedEipId\n" }, "endpointStr": { "type": "string", "description": "Connection string for the connection address. By default, only the ZK private network connection address is returned. If you have requested a Thrift2 connection address, or enabled public access for ZK or Thrift2 connection addresses, the corresponding connection string will also be provided. When the connection address type is HBaseReUsedEipId, the connection string is always set to HBaseReUsedEipId.\n" }, "networkType": { "type": "string", "description": "Connection address network type. Value range: Public: public access address. Private: private access address.\n" }, "privateDnsVisibility": { "type": "boolean", "description": "Whether public DNS resolution is enabled for the private network domain name.\n" } }, "type": "object", "required": [ "addressType", "eipId", "endpointId", "endpointStr", "networkType", "privateDnsVisibility" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:hbase/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key of the tags bound to the instance\n" }, "value": { "type": "string", "description": "Tag values bound to the instance.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/GroupAttachedPolicy:GroupAttachedPolicy": { "properties": { "policyName": { "type": "string", "description": "Policy name.\n" }, "policyScopes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/GroupAttachedPolicyPolicyScope:GroupAttachedPolicyPolicyScope" } }, "policyType": { "type": "string", "description": "Policy type. System indicates a system predefined policy; Custom indicates a custom policy.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "policyName", "policyScopes", "policyType" ] } } }, "volcenginecc:iam/GroupAttachedPolicyPolicyScope:GroupAttachedPolicyPolicyScope": { "properties": { "attachTime": { "type": "string", "description": "Project authorization time.\n" }, "policyScopeType": { "type": "string", "description": "Authorization type. Global indicates global authorization (not limited by project); Project indicates project-based authorization.\n" }, "projectDisplayName": { "type": "string", "description": "Project display name for project-based authorization.\n" }, "projectName": { "type": "string", "description": "Project name for project-based authorization.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attachTime", "policyScopeType", "projectDisplayName", "projectName" ] } } }, "volcenginecc:iam/GroupUser:GroupUser": { "properties": { "userName": { "type": "string", "description": "Username.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "userName" ] } } }, "volcenginecc:iam/PolicyPolicyRole:PolicyPolicyRole": { "properties": { "name": { "type": "string", "description": "Name of the corresponding user, role, or user group.\n" }, "policyScopes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyRolePolicyScope:PolicyPolicyRolePolicyScope" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "policyScopes" ] } } }, "volcenginecc:iam/PolicyPolicyRolePolicyScope:PolicyPolicyRolePolicyScope": { "properties": { "projectName": { "type": "string", "description": "Project name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "projectName" ] } } }, "volcenginecc:iam/PolicyPolicyUser:PolicyPolicyUser": { "properties": { "name": { "type": "string", "description": "Name of the corresponding user, role, or user group.\n" }, "policyScopes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyUserPolicyScope:PolicyPolicyUserPolicyScope" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "policyScopes" ] } } }, "volcenginecc:iam/PolicyPolicyUserGroup:PolicyPolicyUserGroup": { "properties": { "name": { "type": "string", "description": "Name of the corresponding user, role, or user group.\n" }, "policyScopes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyUserGroupPolicyScope:PolicyPolicyUserGroupPolicyScope" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "policyScopes" ] } } }, "volcenginecc:iam/PolicyPolicyUserGroupPolicyScope:PolicyPolicyUserGroupPolicyScope": { "properties": { "projectName": { "type": "string", "description": "Project name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "projectName" ] } } }, "volcenginecc:iam/PolicyPolicyUserPolicyScope:PolicyPolicyUserPolicyScope": { "properties": { "projectName": { "type": "string", "description": "Project name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "projectName" ] } } }, "volcenginecc:iam/RolePolicy:RolePolicy": { "properties": { "policyName": { "type": "string", "description": "Policy name\n" }, "policyType": { "type": "string", "description": "Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "policyName", "policyType" ] } } }, "volcenginecc:iam/RoleTag:RoleTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:iam/SamlProviderCertificate:SamlProviderCertificate": { "properties": { "certificateId": { "type": "string", "description": "Certificate ID\n" }, "createDate": { "type": "string", "description": "Certificate Upload Time\n" }, "issuer": { "type": "string", "description": "Certificate Authority\n" }, "notAfter": { "type": "string", "description": "Certificate Expiration Time\n" }, "notBefore": { "type": "string", "description": "Certificate Validity Period\n" }, "serialNumber": { "type": "string", "description": "Certificate Serial Number\n" }, "signatureAlgorithm": { "type": "string", "description": "Certificate Signature Algorithm\n" }, "subject": { "type": "string", "description": "Certificate Subject\n" }, "updateDate": { "type": "string", "description": "Certificate Update Time\n" }, "version": { "type": "string", "description": "Certificate Version\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certificateId", "createDate", "issuer", "notAfter", "notBefore", "serialNumber", "signatureAlgorithm", "subject", "updateDate", "version" ] } } }, "volcenginecc:iam/UserAccessKey:UserAccessKey": { "properties": { "accessKeyId": { "type": "string", "description": "Access key ID.\n" }, "createDate": { "type": "string", "description": "Access key creation time.\n" }, "region": { "type": "string", "description": "Most recently used service region.\n" }, "requestTime": { "type": "string", "description": "Last used time of the access key.\n" }, "service": { "type": "string", "description": "Name of the most recently used service.\n" }, "status": { "type": "string", "description": "Access key status. 'Active' means enabled, 'Inactive' means disabled.\n" }, "updateDate": { "type": "string", "description": "Access key update time.\n" }, "userName": { "type": "string", "description": "Access key Secret.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessKeyId", "createDate", "region", "requestTime", "service", "status", "updateDate", "userName" ] } } }, "volcenginecc:iam/UserLoginProfile:UserLoginProfile": { "properties": { "createDate": { "type": "string", "description": "Login configuration creation time.\n" }, "lastLoginDate": { "type": "string", "description": "Last login time.\n" }, "lastLoginIp": { "type": "string", "description": "Last login IP.\n" }, "lastResetPasswordTime": { "type": "integer", "description": "Last password reset time. Last password reset time. 0 means no password has been set; a non-zero value means the timestamp when the password expires.\n" }, "loginAllowed": { "type": "boolean", "description": "Whether login is allowed. 'true' means allowed, 'false' means not allowed. Default is 'false'.\n" }, "loginLocked": { "type": "boolean", "description": "Whether login is locked. 'true' means locked, 'false' means not locked. After the administrator sets a limit for incorrect password retry attempts, login will be locked if the user exceeds the limit.\n" }, "password": { "type": "string", "description": "Login password.\n" }, "passwordExpireAt": { "type": "integer", "description": "Password expiration time. '0' means never expires; non-zero means the expiration timestamp.\n" }, "passwordResetRequired": { "type": "boolean", "description": "Whether password reset is required on next login. Whether password reset is required on next login. 'true' means password reset is required, 'false' means not required. Default is 'false'.\n" }, "safeAuthExemptDuration": { "type": "number", "description": "Login protection exemption duration. Supports setting 1 to 7 (days), 1 to 168 (hours), or 5 to 1440 (minutes). For unit settings, refer to the SafeAuthExemptUnit parameter.\n" }, "safeAuthExemptRequired": { "type": "number", "description": "Whether login protection exemption is enabled. Whether login protection exemption is enabled. 0 means disabled, 1 means enabled. When login protection exemption is enabled, after verification is completed, login will not require verification again within a certain period.\n" }, "safeAuthExemptUnit": { "type": "number", "description": "Login protection exemption time unit. Login protection exemption time unit. 0 represents minutes, 1 represents hours, 2 represents days.\n" }, "safeAuthFlag": { "type": "boolean", "description": "Whether login protection is enabled. 'true' means enabled, 'false' means disabled. Default is 'false'.\n" }, "safeAuthType": { "type": "string", "description": "Login protection type. Login protection type. 'phone' represents mobile verification, 'email' represents email verification, 'vmfa' represents MFA device verification. Multiple login protection types can be set, separated by commas. Options: vmfa, phone, email, separated by commas.\n" }, "updateDate": { "type": "string", "description": "Login configuration update time.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createDate", "lastLoginDate", "lastLoginIp", "lastResetPasswordTime", "loginAllowed", "loginLocked", "password", "passwordExpireAt", "passwordResetRequired", "safeAuthExemptDuration", "safeAuthExemptRequired", "safeAuthExemptUnit", "safeAuthFlag", "safeAuthType", "updateDate" ] } } }, "volcenginecc:iam/UserPolicy:UserPolicy": { "properties": { "policyName": { "type": "string", "description": "Permission policy name. Length: 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.\n" }, "policyType": { "type": "string", "description": "Permission policy type. 'System' indicates system preset policy, 'Custom' indicates custom policy.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "policyName", "policyType" ] } } }, "volcenginecc:iam/UserSecurityConfig:UserSecurityConfig": { "properties": { "safeAuthClose": { "type": "number", "description": "Whether operation protection is enabled. 0 means enabled, 1 means disabled.\n" }, "safeAuthExemptDuration": { "type": "number", "description": "Operation protection exemption time. After verification is completed, no further verification is required within the exemption period. Supports values from 5 to 30; the default value is 10. Unit: minutes.\n" }, "safeAuthType": { "type": "string", "description": "Operation protection type. 'phone' indicates phone verification, 'email' indicates email verification, 'vmfa' indicates MFA device verification. Multiple operation protection types can be set, separated by commas.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "safeAuthClose", "safeAuthExemptDuration", "safeAuthType" ] } } }, "volcenginecc:iam/UserTag:UserTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:iam/getGroupAttachedPolicy:getGroupAttachedPolicy": { "properties": { "attachTime": { "type": "string", "description": "Policy binding time.\n" }, "description": { "type": "string", "description": "Policy description.\n" }, "policyName": { "type": "string", "description": "Policy name.\n" }, "policyScopes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/getGroupAttachedPolicyPolicyScope:getGroupAttachedPolicyPolicyScope" }, "description": "Scope of policy authorization, specifically the project scope.\n" }, "policyTrn": { "type": "string", "description": "Policy TRN.\n" }, "policyType": { "type": "string", "description": "Policy type. System indicates a system predefined policy; Custom indicates a custom policy.\n" } }, "type": "object", "required": [ "attachTime", "description", "policyName", "policyScopes", "policyTrn", "policyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getGroupAttachedPolicyPolicyScope:getGroupAttachedPolicyPolicyScope": { "properties": { "attachTime": { "type": "string", "description": "Project authorization time.\n" }, "policyScopeType": { "type": "string", "description": "Authorization type. Global indicates global authorization (not limited by project); Project indicates project-based authorization.\n" }, "projectDisplayName": { "type": "string", "description": "Project display name for project-based authorization.\n" }, "projectName": { "type": "string", "description": "Project name for project-based authorization.\n" } }, "type": "object", "required": [ "attachTime", "policyScopeType", "projectDisplayName", "projectName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getGroupUser:getGroupUser": { "properties": { "description": { "type": "string", "description": "User description.\n" }, "displayName": { "type": "string", "description": "User display name.\n" }, "joinTime": { "type": "string", "description": "Time when the user joined the user group.\n" }, "userId": { "type": "integer", "description": "User ID.\n" }, "userName": { "type": "string", "description": "Username.\n" } }, "type": "object", "required": [ "description", "displayName", "joinTime", "userId", "userName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getPolicyPolicyRole:getPolicyPolicyRole": { "properties": { "createdTime": { "type": "string", "description": "Policy binding time.\n" }, "description": { "type": "string", "description": "Policy description.\n" }, "displayName": { "type": "string", "description": "Display name.\n" }, "entitiesId": { "type": "integer", "description": "Unique identifier.\n" }, "name": { "type": "string", "description": "Name of the corresponding user, role, or user group.\n" }, "policyScopes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/getPolicyPolicyRolePolicyScope:getPolicyPolicyRolePolicyScope" }, "description": "List of projects bound to the policy.\n" } }, "type": "object", "required": [ "createdTime", "description", "displayName", "entitiesId", "name", "policyScopes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getPolicyPolicyRolePolicyScope:getPolicyPolicyRolePolicyScope": { "properties": { "createdTime": { "type": "string", "description": "Project authorization time.\n" }, "policyScopeType": { "type": "string", "description": "Authorization type. Global indicates global authorization; Project indicates project-based authorization.\n" }, "projectDisplayName": { "type": "string", "description": "Project display name.\n" }, "projectName": { "type": "string", "description": "Project name.\n" } }, "type": "object", "required": [ "createdTime", "policyScopeType", "projectDisplayName", "projectName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getPolicyPolicyUser:getPolicyPolicyUser": { "properties": { "createdTime": { "type": "string", "description": "Policy binding time.\n" }, "description": { "type": "string", "description": "Policy description.\n" }, "displayName": { "type": "string", "description": "Display name.\n" }, "entitiesId": { "type": "integer", "description": "Unique identifier.\n" }, "name": { "type": "string", "description": "Name of the corresponding user, role, or user group.\n" }, "policyScopes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/getPolicyPolicyUserPolicyScope:getPolicyPolicyUserPolicyScope" }, "description": "List of projects bound to the policy.\n" } }, "type": "object", "required": [ "createdTime", "description", "displayName", "entitiesId", "name", "policyScopes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getPolicyPolicyUserGroup:getPolicyPolicyUserGroup": { "properties": { "createdTime": { "type": "string", "description": "Policy binding time.\n" }, "description": { "type": "string", "description": "Policy description.\n" }, "displayName": { "type": "string", "description": "Display name.\n" }, "entitiesId": { "type": "integer", "description": "Unique identifier.\n" }, "name": { "type": "string", "description": "Name of the corresponding user, role, or user group.\n" }, "policyScopes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/getPolicyPolicyUserGroupPolicyScope:getPolicyPolicyUserGroupPolicyScope" }, "description": "List of projects bound to the policy.\n" } }, "type": "object", "required": [ "createdTime", "description", "displayName", "entitiesId", "name", "policyScopes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getPolicyPolicyUserGroupPolicyScope:getPolicyPolicyUserGroupPolicyScope": { "properties": { "createdTime": { "type": "string", "description": "Project authorization time.\n" }, "policyScopeType": { "type": "string", "description": "Authorization type. Global indicates global authorization; Project indicates project-based authorization.\n" }, "projectDisplayName": { "type": "string", "description": "Project display name.\n" }, "projectName": { "type": "string", "description": "Project name.\n" } }, "type": "object", "required": [ "createdTime", "policyScopeType", "projectDisplayName", "projectName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getPolicyPolicyUserPolicyScope:getPolicyPolicyUserPolicyScope": { "properties": { "createdTime": { "type": "string", "description": "Project authorization time.\n" }, "policyScopeType": { "type": "string", "description": "Authorization type. Global indicates global authorization; Project indicates project-based authorization.\n" }, "projectDisplayName": { "type": "string", "description": "Project display name.\n" }, "projectName": { "type": "string", "description": "Project name.\n" } }, "type": "object", "required": [ "createdTime", "policyScopeType", "projectDisplayName", "projectName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getRolePolicy:getRolePolicy": { "properties": { "policyName": { "type": "string", "description": "Policy name\n" }, "policyType": { "type": "string", "description": "Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.\n" } }, "type": "object", "required": [ "policyName", "policyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getRoleTag:getRoleTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getSamlProviderCertificate:getSamlProviderCertificate": { "properties": { "certificateId": { "type": "string", "description": "Certificate ID\n" }, "createDate": { "type": "string", "description": "Certificate Upload Time\n" }, "issuer": { "type": "string", "description": "Certificate Authority\n" }, "notAfter": { "type": "string", "description": "Certificate Expiration Time\n" }, "notBefore": { "type": "string", "description": "Certificate Validity Period\n" }, "serialNumber": { "type": "string", "description": "Certificate Serial Number\n" }, "signatureAlgorithm": { "type": "string", "description": "Certificate Signature Algorithm\n" }, "subject": { "type": "string", "description": "Certificate Subject\n" }, "updateDate": { "type": "string", "description": "Certificate Update Time\n" }, "version": { "type": "string", "description": "Certificate Version\n" } }, "type": "object", "required": [ "certificateId", "createDate", "issuer", "notAfter", "notBefore", "serialNumber", "signatureAlgorithm", "subject", "updateDate", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getUserAccessKey:getUserAccessKey": { "properties": { "accessKeyId": { "type": "string", "description": "Access key ID.\n" }, "createDate": { "type": "string", "description": "Access key creation time.\n" }, "region": { "type": "string", "description": "Most recently used service region.\n" }, "requestTime": { "type": "string", "description": "Last used time of the access key.\n" }, "service": { "type": "string", "description": "Name of the most recently used service.\n" }, "status": { "type": "string", "description": "Access key status. 'Active' means enabled, 'Inactive' means disabled.\n" }, "updateDate": { "type": "string", "description": "Access key update time.\n" }, "userName": { "type": "string", "description": "Access key Secret.\n" } }, "type": "object", "required": [ "accessKeyId", "createDate", "region", "requestTime", "service", "status", "updateDate", "userName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getUserLoginProfile:getUserLoginProfile": { "properties": { "createDate": { "type": "string", "description": "Login configuration creation time.\n" }, "lastLoginDate": { "type": "string", "description": "Last login time.\n" }, "lastLoginIp": { "type": "string", "description": "Last login IP.\n" }, "lastResetPasswordTime": { "type": "integer", "description": "Last password reset time. Last password reset time. 0 means no password has been set; a non-zero value means the timestamp when the password expires.\n" }, "loginAllowed": { "type": "boolean", "description": "Whether login is allowed. 'true' means allowed, 'false' means not allowed. Default is 'false'.\n" }, "loginLocked": { "type": "boolean", "description": "Whether login is locked. 'true' means locked, 'false' means not locked. After the administrator sets a limit for incorrect password retry attempts, login will be locked if the user exceeds the limit.\n" }, "password": { "type": "string", "description": "Login password.\n" }, "passwordExpireAt": { "type": "integer", "description": "Password expiration time. '0' means never expires; non-zero means the expiration timestamp.\n" }, "passwordResetRequired": { "type": "boolean", "description": "Whether password reset is required on next login. Whether password reset is required on next login. 'true' means password reset is required, 'false' means not required. Default is 'false'.\n" }, "safeAuthExemptDuration": { "type": "number", "description": "Login protection exemption duration. Supports setting 1 to 7 (days), 1 to 168 (hours), or 5 to 1440 (minutes). For unit settings, refer to the SafeAuthExemptUnit parameter.\n" }, "safeAuthExemptRequired": { "type": "number", "description": "Whether login protection exemption is enabled. Whether login protection exemption is enabled. 0 means disabled, 1 means enabled. When login protection exemption is enabled, after verification is completed, login will not require verification again within a certain period.\n" }, "safeAuthExemptUnit": { "type": "number", "description": "Login protection exemption time unit. Login protection exemption time unit. 0 represents minutes, 1 represents hours, 2 represents days.\n" }, "safeAuthFlag": { "type": "boolean", "description": "Whether login protection is enabled. 'true' means enabled, 'false' means disabled. Default is 'false'.\n" }, "safeAuthType": { "type": "string", "description": "Login protection type. Login protection type. 'phone' represents mobile verification, 'email' represents email verification, 'vmfa' represents MFA device verification. Multiple login protection types can be set, separated by commas. Options: vmfa, phone, email, separated by commas.\n" }, "updateDate": { "type": "string", "description": "Login configuration update time.\n" } }, "type": "object", "required": [ "createDate", "lastLoginDate", "lastLoginIp", "lastResetPasswordTime", "loginAllowed", "loginLocked", "password", "passwordExpireAt", "passwordResetRequired", "safeAuthExemptDuration", "safeAuthExemptRequired", "safeAuthExemptUnit", "safeAuthFlag", "safeAuthType", "updateDate" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getUserPolicy:getUserPolicy": { "properties": { "policyName": { "type": "string", "description": "Permission policy name. Length: 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.\n" }, "policyType": { "type": "string", "description": "Permission policy type. 'System' indicates system preset policy, 'Custom' indicates custom policy.\n" } }, "type": "object", "required": [ "policyName", "policyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getUserSecurityConfig:getUserSecurityConfig": { "properties": { "safeAuthClose": { "type": "number", "description": "Whether operation protection is enabled. 0 means enabled, 1 means disabled.\n" }, "safeAuthExemptDuration": { "type": "number", "description": "Operation protection exemption time. After verification is completed, no further verification is required within the exemption period. Supports values from 5 to 30; the default value is 10. Unit: minutes.\n" }, "safeAuthType": { "type": "string", "description": "Operation protection type. 'phone' indicates phone verification, 'email' indicates email verification, 'vmfa' indicates MFA device verification. Multiple operation protection types can be set, separated by commas.\n" } }, "type": "object", "required": [ "safeAuthClose", "safeAuthExemptDuration", "safeAuthType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:iam/getUserTag:getUserTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:index/ProviderAssumeRole:ProviderAssumeRole": { "properties": { "assumeRoleTrn": { "type": "string", "description": "he TRN of the role to assume.\n" }, "durationSeconds": { "type": "integer", "description": "The duration of the session when making the AssumeRole call. Its value ranges from 900 to 43200(seconds), and default is 3600 seconds.\n" }, "policy": { "type": "string", "description": "A more restrictive policy when making the AssumeRole call\n" } }, "type": "object", "required": [ "assumeRoleTrn" ], "language": { "nodejs": { "requiredOutputs": [] } } }, "volcenginecc:index/ProviderEndpoints:ProviderEndpoints": { "properties": { "cloudcontrolapi": { "type": "string", "description": "Use this to override the default Cloud Control API service endpoint URL\n" }, "sts": { "type": "string", "description": "Use this to override the default STS service endpoint URL\n" } }, "type": "object" }, "volcenginecc:kafka/AllowListAssociatedInstance:AllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "ID of the instance bound to the allowlist\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId" ] } } }, "volcenginecc:kafka/InstanceChargeInfo:InstanceChargeInfo": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.\n" }, "chargeExpireTime": { "type": "string", "description": "Expiration time for the subscription instance.\n" }, "chargeStartTime": { "type": "string", "description": "Instance billing start time.\n" }, "chargeStatus": { "type": "string", "description": "Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired\n" }, "chargeType": { "type": "string", "description": "Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after the instance is stopped due to overdue payment.\n" }, "overdueTime": { "type": "string", "description": "Instance suspension time due to overdue payment.\n" }, "period": { "type": "integer", "description": "Purchase duration for subscription-based instances.\n" }, "periodUnit": { "type": "string", "description": "The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "chargeExpireTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ] } } }, "volcenginecc:kafka/InstanceConnectionInfo:InstanceConnectionInfo": { "properties": { "endpointType": { "type": "string", "description": "Instance endpoint type. PLAINTEXT: default endpoint. SASL*PLAINTEXT: SASL endpoint (private network). SASL*SSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.\n" }, "internalEndpoint": { "type": "string", "description": "Instance private network access domain name.\n" }, "networkType": { "type": "string", "description": "Network type for the access point. Unified as PrivateNetwork.\n" }, "publicEndpoint": { "type": "string", "description": "Public access domain name for the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "endpointType", "internalEndpoint", "networkType", "publicEndpoint" ] } } }, "volcenginecc:kafka/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:kafka/TopicAccessPolicy:TopicAccessPolicy": { "properties": { "accessPolicy": { "type": "string", "description": "SASL user access permissions for the current Topic. PubSub: publish and subscribe permissions. Pub: publish permission. Sub: subscribe permission.\n" }, "userName": { "type": "string", "description": "SASL username.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessPolicy", "userName" ] } } }, "volcenginecc:kafka/TopicTag:TopicTag": { "properties": { "key": { "type": "string", "description": "Label key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:kafka/getAllowListAssociatedInstance:getAllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "ID of the instance bound to the allowlist\n" }, "instanceName": { "type": "string", "description": "Name of the instance bound to the allowlist\n" } }, "type": "object", "required": [ "instanceId", "instanceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:kafka/getInstanceChargeInfo:getInstanceChargeInfo": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.\n" }, "chargeExpireTime": { "type": "string", "description": "Expiration time for the subscription instance.\n" }, "chargeStartTime": { "type": "string", "description": "Instance billing start time.\n" }, "chargeStatus": { "type": "string", "description": "Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired\n" }, "chargeType": { "type": "string", "description": "Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after the instance is stopped due to overdue payment.\n" }, "overdueTime": { "type": "string", "description": "Instance suspension time due to overdue payment.\n" }, "period": { "type": "integer", "description": "Purchase duration for subscription-based instances.\n" }, "periodUnit": { "type": "string", "description": "The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).\n" } }, "type": "object", "required": [ "autoRenew", "chargeExpireTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:kafka/getInstanceConnectionInfo:getInstanceConnectionInfo": { "properties": { "endpointType": { "type": "string", "description": "Instance endpoint type. PLAINTEXT: default endpoint. SASL*PLAINTEXT: SASL endpoint (private network). SASL*SSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.\n" }, "internalEndpoint": { "type": "string", "description": "Instance private network access domain name.\n" }, "networkType": { "type": "string", "description": "Network type for the access point. Unified as PrivateNetwork.\n" }, "publicEndpoint": { "type": "string", "description": "Public access domain name for the instance.\n" } }, "type": "object", "required": [ "endpointType", "internalEndpoint", "networkType", "publicEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:kafka/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:kafka/getTopicAccessPolicy:getTopicAccessPolicy": { "properties": { "accessPolicy": { "type": "string", "description": "SASL user access permissions for the current Topic. PubSub: publish and subscribe permissions. Pub: publish permission. Sub: subscribe permission.\n" }, "userName": { "type": "string", "description": "SASL username.\n" } }, "type": "object", "required": [ "accessPolicy", "userName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:kafka/getTopicTag:getTopicTag": { "properties": { "key": { "type": "string", "description": "Label key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:kms/KeyMultiRegionConfiguration:KeyMultiRegionConfiguration": { "properties": { "multiRegionKeyType": { "type": "string", "description": "Multi-region key type.\n" }, "primaryKey": { "$ref": "#/types/volcenginecc:kms/KeyMultiRegionConfigurationPrimaryKey:KeyMultiRegionConfigurationPrimaryKey", "description": "Primary multi-region key transaction identifier and region ID.\n" }, "replicaKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kms/KeyMultiRegionConfigurationReplicaKey:KeyMultiRegionConfigurationReplicaKey" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "multiRegionKeyType", "primaryKey", "replicaKeys" ] } } }, "volcenginecc:kms/KeyMultiRegionConfigurationPrimaryKey:KeyMultiRegionConfigurationPrimaryKey": { "properties": { "region": { "type": "string", "description": "Multi-region key region ID.\n" }, "trn": { "type": "string", "description": "Multi-region key TRN.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "region", "trn" ] } } }, "volcenginecc:kms/KeyMultiRegionConfigurationReplicaKey:KeyMultiRegionConfigurationReplicaKey": { "properties": { "region": { "type": "string", "description": "Multi-region key region ID.\n" }, "trn": { "type": "string", "description": "Multi-region key conversion.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "region", "trn" ] } } }, "volcenginecc:kms/KeyTag:KeyTag": { "properties": { "key": { "type": "string", "description": "KMS key label key.\n" }, "value": { "type": "string", "description": "KMS key label value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:kms/getKeyMultiRegionConfiguration:getKeyMultiRegionConfiguration": { "properties": { "multiRegionKeyType": { "type": "string", "description": "Multi-region key type.\n" }, "primaryKey": { "$ref": "#/types/volcenginecc:kms/getKeyMultiRegionConfigurationPrimaryKey:getKeyMultiRegionConfigurationPrimaryKey", "description": "Primary multi-region key transaction identifier and region ID.\n" }, "replicaKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kms/getKeyMultiRegionConfigurationReplicaKey:getKeyMultiRegionConfigurationReplicaKey" }, "description": "Replica multi-region key transaction record number and region ID.\n" } }, "type": "object", "required": [ "multiRegionKeyType", "primaryKey", "replicaKeys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:kms/getKeyMultiRegionConfigurationPrimaryKey:getKeyMultiRegionConfigurationPrimaryKey": { "properties": { "region": { "type": "string", "description": "Multi-region key region ID.\n" }, "trn": { "type": "string", "description": "Multi-region key TRN.\n" } }, "type": "object", "required": [ "region", "trn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:kms/getKeyMultiRegionConfigurationReplicaKey:getKeyMultiRegionConfigurationReplicaKey": { "properties": { "region": { "type": "string", "description": "Multi-region key region ID.\n" }, "trn": { "type": "string", "description": "Multi-region key conversion.\n" } }, "type": "object", "required": [ "region", "trn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:kms/getKeyTag:getKeyTag": { "properties": { "key": { "type": "string", "description": "KMS key label key.\n" }, "value": { "type": "string", "description": "KMS key label value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:mongodb/AllowListAssociatedInstance:AllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID bound to the current allowlist.\n" }, "instanceName": { "type": "string", "description": "Instance name bound to the current allowlist.\n" }, "projectName": { "type": "string", "description": "Project name of the instance.\n" }, "vpc": { "type": "string", "description": "Private network ID of the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId", "instanceName", "projectName", "vpc" ] } } }, "volcenginecc:mongodb/InstanceConfigServer:InstanceConfigServer": { "properties": { "configServerNodeId": { "type": "string", "description": "ConfigServer node ID\n" }, "nodeRole": { "type": "string", "description": "Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.\n" }, "nodeStatus": { "type": "string", "description": "Node status.\n" }, "totalMemoryGb": { "type": "number", "description": "Total memory. Unit: GiB.\n" }, "totalvCpu": { "type": "number", "description": "Total cores.\n" }, "usedMemoryGb": { "type": "number", "description": "Used memory. Unit: GiB.\n" }, "usedvCpu": { "type": "number", "description": "Used cores.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the current node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configServerNodeId", "nodeRole", "nodeStatus", "totalMemoryGb", "totalvCpu", "usedMemoryGb", "usedvCpu", "zoneId" ] } } }, "volcenginecc:mongodb/InstanceMongo:InstanceMongo": { "properties": { "mongosNodeId": { "type": "string", "description": "Mongos node ID\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeStatus": { "type": "string", "description": "Node status.\n" }, "totalMemoryGb": { "type": "number", "description": "Total memory. Unit: GiB.\n" }, "totalvCpu": { "type": "number", "description": "Total cores.\n" }, "usedMemoryGb": { "type": "number", "description": "Used memory. Unit: GiB.\n" }, "usedvCpu": { "type": "number", "description": "Used cores.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the current node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "mongosNodeId", "nodeSpec", "nodeStatus", "totalMemoryGb", "totalvCpu", "usedMemoryGb", "usedvCpu", "zoneId" ] } } }, "volcenginecc:mongodb/InstanceNode:InstanceNode": { "properties": { "nodeDelayTime": { "type": "integer", "description": "Node latency. Unit: seconds.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodeRole": { "type": "string", "description": "Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeStatus": { "type": "string", "description": "Node status.\n" }, "totalMemoryGb": { "type": "number", "description": "Total memory. Unit: GiB.\n" }, "totalStorageGb": { "type": "number", "description": "Total storage space for this node. Unit: GiB.\n" }, "totalvCpu": { "type": "number", "description": "Total cores.\n" }, "usedMemoryGb": { "type": "number", "description": "Used memory. Unit: GiB.\n" }, "usedStorageGb": { "type": "number", "description": "Storage space used by this node. Unit: GiB.\n" }, "usedvCpu": { "type": "number", "description": "Used cores.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the current node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodeDelayTime", "nodeId", "nodeRole", "nodeSpec", "nodeStatus", "totalMemoryGb", "totalStorageGb", "totalvCpu", "usedMemoryGb", "usedStorageGb", "usedvCpu", "zoneId" ] } } }, "volcenginecc:mongodb/InstanceNodeAvailabilityZone:InstanceNodeAvailabilityZone": { "properties": { "nodeNumber": { "type": "integer", "description": "Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.\n" }, "zoneId": { "type": "string", "description": "Availability zone of the read-only node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodeNumber", "zoneId" ] } } }, "volcenginecc:mongodb/InstanceShard:InstanceShard": { "properties": { "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceShardNode:InstanceShardNode" } }, "shardId": { "type": "string", "description": "Shard node ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodes", "shardId" ] } } }, "volcenginecc:mongodb/InstanceShardNode:InstanceShardNode": { "properties": { "nodeDelayTime": { "type": "integer", "description": "Node latency. Unit: seconds.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodeRole": { "type": "string", "description": "Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeStatus": { "type": "string", "description": "Node status.\n" }, "totalMemoryGb": { "type": "number", "description": "Total memory. Unit: GiB.\n" }, "totalStorageGb": { "type": "number", "description": "Total storage space for this node. Unit: GiB.\n" }, "totalvCpu": { "type": "number", "description": "Total cores.\n" }, "usedMemoryGb": { "type": "number", "description": "Used memory. Unit: GiB.\n" }, "usedStorageGb": { "type": "number", "description": "Storage space used by this node. Unit: GiB.\n" }, "usedvCpu": { "type": "number", "description": "Used cores.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the current node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodeDelayTime", "nodeId", "nodeRole", "nodeSpec", "nodeStatus", "totalMemoryGb", "totalStorageGb", "totalvCpu", "usedMemoryGb", "usedStorageGb", "usedvCpu", "zoneId" ] } } }, "volcenginecc:mongodb/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:mongodb/getAllowListAssociatedInstance:getAllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID bound to the current allowlist.\n" }, "instanceName": { "type": "string", "description": "Instance name bound to the current allowlist.\n" }, "projectName": { "type": "string", "description": "Project name of the instance.\n" }, "vpc": { "type": "string", "description": "Private network ID of the instance.\n" } }, "type": "object", "required": [ "instanceId", "instanceName", "projectName", "vpc" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:mongodb/getInstanceConfigServer:getInstanceConfigServer": { "properties": { "configServerNodeId": { "type": "string", "description": "ConfigServer node ID\n" }, "nodeRole": { "type": "string", "description": "Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.\n" }, "nodeStatus": { "type": "string", "description": "Node status.\n" }, "totalMemoryGb": { "type": "number", "description": "Total memory. Unit: GiB.\n" }, "totalvCpu": { "type": "number", "description": "Total cores.\n" }, "usedMemoryGb": { "type": "number", "description": "Used memory. Unit: GiB.\n" }, "usedvCpu": { "type": "number", "description": "Used cores.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the current node.\n" } }, "type": "object", "required": [ "configServerNodeId", "nodeRole", "nodeStatus", "totalMemoryGb", "totalvCpu", "usedMemoryGb", "usedvCpu", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:mongodb/getInstanceMongo:getInstanceMongo": { "properties": { "mongosNodeId": { "type": "string", "description": "Mongos node ID\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeStatus": { "type": "string", "description": "Node status.\n" }, "totalMemoryGb": { "type": "number", "description": "Total memory. Unit: GiB.\n" }, "totalvCpu": { "type": "number", "description": "Total cores.\n" }, "usedMemoryGb": { "type": "number", "description": "Used memory. Unit: GiB.\n" }, "usedvCpu": { "type": "number", "description": "Used cores.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the current node.\n" } }, "type": "object", "required": [ "mongosNodeId", "nodeSpec", "nodeStatus", "totalMemoryGb", "totalvCpu", "usedMemoryGb", "usedvCpu", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:mongodb/getInstanceNode:getInstanceNode": { "properties": { "nodeDelayTime": { "type": "integer", "description": "Node latency. Unit: seconds.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodeRole": { "type": "string", "description": "Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeStatus": { "type": "string", "description": "Node status.\n" }, "totalMemoryGb": { "type": "number", "description": "Total memory. Unit: GiB.\n" }, "totalStorageGb": { "type": "number", "description": "Total storage space for this node. Unit: GiB.\n" }, "totalvCpu": { "type": "number", "description": "Total cores.\n" }, "usedMemoryGb": { "type": "number", "description": "Used memory. Unit: GiB.\n" }, "usedStorageGb": { "type": "number", "description": "Storage space used by this node. Unit: GiB.\n" }, "usedvCpu": { "type": "number", "description": "Used cores.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the current node.\n" } }, "type": "object", "required": [ "nodeDelayTime", "nodeId", "nodeRole", "nodeSpec", "nodeStatus", "totalMemoryGb", "totalStorageGb", "totalvCpu", "usedMemoryGb", "usedStorageGb", "usedvCpu", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:mongodb/getInstanceNodeAvailabilityZone:getInstanceNodeAvailabilityZone": { "properties": { "nodeNumber": { "type": "integer", "description": "Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.\n" }, "zoneId": { "type": "string", "description": "Availability zone of the read-only node.\n" } }, "type": "object", "required": [ "nodeNumber", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:mongodb/getInstanceShard:getInstanceShard": { "properties": { "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/getInstanceShardNode:getInstanceShardNode" }, "description": "List of node information in each Shard.\n" }, "shardId": { "type": "string", "description": "Shard node ID.\n" } }, "type": "object", "required": [ "nodes", "shardId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:mongodb/getInstanceShardNode:getInstanceShardNode": { "properties": { "nodeDelayTime": { "type": "integer", "description": "Node latency. Unit: seconds.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodeRole": { "type": "string", "description": "Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeStatus": { "type": "string", "description": "Node status.\n" }, "totalMemoryGb": { "type": "number", "description": "Total memory. Unit: GiB.\n" }, "totalStorageGb": { "type": "number", "description": "Total storage space for this node. Unit: GiB.\n" }, "totalvCpu": { "type": "number", "description": "Total cores.\n" }, "usedMemoryGb": { "type": "number", "description": "Used memory. Unit: GiB.\n" }, "usedStorageGb": { "type": "number", "description": "Storage space used by this node. Unit: GiB.\n" }, "usedvCpu": { "type": "number", "description": "Used cores.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the current node.\n" } }, "type": "object", "required": [ "nodeDelayTime", "nodeId", "nodeRole", "nodeSpec", "nodeStatus", "totalMemoryGb", "totalStorageGb", "totalvCpu", "usedMemoryGb", "usedStorageGb", "usedvCpu", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:mongodb/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:natgateway/NgwEipAddress:NgwEipAddress": { "properties": { "allocationId": { "type": "string", "description": "Public IP ID\n" }, "eipAddress": { "type": "string", "description": "Public IP address\n" }, "usingStatus": { "type": "string", "description": "Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allocationId", "eipAddress", "usingStatus" ] } } }, "volcenginecc:natgateway/NgwNatIpAddress:NgwNatIpAddress": { "properties": { "natIpAddress": { "type": "string", "description": "Transit IP address\n" }, "natIpId": { "type": "string", "description": "Transit IP ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "natIpAddress", "natIpId" ] } } }, "volcenginecc:natgateway/NgwTag:NgwTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:natgateway/getNgwEipAddress:getNgwEipAddress": { "properties": { "allocationId": { "type": "string", "description": "Public IP ID\n" }, "eipAddress": { "type": "string", "description": "Public IP address\n" }, "usingStatus": { "type": "string", "description": "Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.\n" } }, "type": "object", "required": [ "allocationId", "eipAddress", "usingStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:natgateway/getNgwNatIpAddress:getNgwNatIpAddress": { "properties": { "natIpAddress": { "type": "string", "description": "Transit IP address\n" }, "natIpId": { "type": "string", "description": "Transit IP ID\n" } }, "type": "object", "required": [ "natIpAddress", "natIpId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:natgateway/getNgwTag:getNgwTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:organization/AccountSecureContactInfo:AccountSecureContactInfo": { "properties": { "email": { "type": "string", "description": "Security email\n" }, "emailVerified": { "type": "integer", "description": "Security email verification status: 1. Not verified, 2. Verified\n" }, "newEmail": { "type": "string", "description": "New email being changed\n" }, "newPhone": { "type": "string", "description": "New mobile number being changed\n" }, "phone": { "type": "string", "description": "Security mobile number\n" }, "phoneVerified": { "type": "integer", "description": "Security mobile number verification status: 1. Not verified, 2. Verified\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "email", "emailVerified", "newEmail", "newPhone", "phone", "phoneVerified" ] } } }, "volcenginecc:organization/AccountTag:AccountTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:organization/OrganizationOrganization:OrganizationOrganization": { "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "Description\n" }, "name": { "type": "string", "description": "Organization Name\n" }, "owner": { "type": "string", "description": "Administrator ID\n" }, "status": { "type": "integer", "description": "Status\n" }, "type": { "type": "integer", "description": "Organization type, enterprise organization is always 1\n" }, "updatedTime": { "type": "string", "description": "Last Updated\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createdTime", "description", "name", "owner", "status", "type", "updatedTime" ] } } }, "volcenginecc:organization/OrganizationOwner:OrganizationOwner": { "properties": { "accountId": { "type": "integer", "description": "Account ID\n" }, "accountName": { "type": "string", "description": "Account Name\n" }, "mainName": { "type": "string", "description": "Entity Name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountId", "accountName", "mainName" ] } } }, "volcenginecc:organization/ServiceControlPolicyTarget:ServiceControlPolicyTarget": { "properties": { "targetId": { "type": "string", "description": "Target ID.\n" }, "targetType": { "type": "string", "description": "Target type: 1. OU 2. Account.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "targetId", "targetType" ] } } }, "volcenginecc:organization/getAccountSecureContactInfo:getAccountSecureContactInfo": { "properties": { "email": { "type": "string", "description": "Security email\n" }, "emailVerified": { "type": "integer", "description": "Security email verification status: 1. Not verified, 2. Verified\n" }, "newEmail": { "type": "string", "description": "New email being changed\n" }, "newPhone": { "type": "string", "description": "New mobile number being changed\n" }, "phone": { "type": "string", "description": "Security mobile number\n" }, "phoneVerified": { "type": "integer", "description": "Security mobile number verification status: 1. Not verified, 2. Verified\n" } }, "type": "object", "required": [ "email", "emailVerified", "newEmail", "newPhone", "phone", "phoneVerified" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:organization/getAccountTag:getAccountTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:organization/getOrganizationOrganization:getOrganizationOrganization": { "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "Description\n" }, "name": { "type": "string", "description": "Organization Name\n" }, "owner": { "type": "string", "description": "Administrator ID\n" }, "status": { "type": "integer", "description": "Status\n" }, "type": { "type": "integer", "description": "Organization type, enterprise organization is always 1\n" }, "updatedTime": { "type": "string", "description": "Last Updated\n" } }, "type": "object", "required": [ "createdTime", "description", "name", "owner", "status", "type", "updatedTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:organization/getOrganizationOwner:getOrganizationOwner": { "properties": { "accountId": { "type": "integer", "description": "Account ID\n" }, "accountName": { "type": "string", "description": "Account Name\n" }, "mainName": { "type": "string", "description": "Entity Name\n" } }, "type": "object", "required": [ "accountId", "accountName", "mainName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:organization/getServiceControlPolicyTarget:getServiceControlPolicyTarget": { "properties": { "attachedTime": { "type": "string", "description": "Binding time.\n" }, "targetId": { "type": "string", "description": "Target ID.\n" }, "targetName": { "type": "string", "description": "Target name.\n" }, "targetType": { "type": "string", "description": "Target type: 1. OU 2. Account.\n" } }, "type": "object", "required": [ "attachedTime", "targetId", "targetName", "targetType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatelink/EndpointServicePrivateDnsNameConfiguration:EndpointServicePrivateDnsNameConfiguration": { "properties": { "name": { "type": "string", "description": "Domain verification name.\n" }, "status": { "type": "string", "description": "Domain verification status. PendingVerification: Pending verification. Verifying: In progress. Verified: Verified. Failed: Verification failed.\n" }, "type": { "type": "string", "description": "Domain verification type. TXT: TXT record.\n" }, "value": { "type": "string", "description": "Domain verification value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "status", "type", "value" ] } } }, "volcenginecc:privatelink/EndpointServiceResource:EndpointServiceResource": { "properties": { "resourceId": { "type": "string", "description": "Service resource ID to be added to the endpoint service.\n" }, "zoneIds": { "type": "array", "items": { "type": "string" }, "description": "Availability zone where the load balancer provides service.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "resourceId", "zoneIds" ] } } }, "volcenginecc:privatelink/EndpointServiceTag:EndpointServiceTag": { "properties": { "key": { "type": "string", "description": "Tag keys for endpoint service tags.\n" }, "value": { "type": "string", "description": "Tag value of the endpoint service tag.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:privatelink/VpcEndpointConnectionResourcesAllocate:VpcEndpointConnectionResourcesAllocate": { "properties": { "resourceId": { "type": "string", "description": "Specify the service resource for the endpoint connection\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the service resource to be specified\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "resourceId", "zoneId" ] } } }, "volcenginecc:privatelink/VpcEndpointConnectionZone:VpcEndpointConnectionZone": { "properties": { "networkInterfaceId": { "type": "string", "description": "Endpoint network interface ID. If a seamless service resource replacement is in progress, this indicates the endpoint network interface ID connected to the replaced service resource\n" }, "networkInterfaceIp": { "type": "string", "description": "The private IPv4 address of the terminal node NIC. If a smooth service resource replacement is in progress, this refers to the IPv4 address of the terminal node NIC connected to the service resource being replaced.\n" }, "networkInterfaceIpv6": { "type": "string", "description": "Private IPv6 address of the endpoint network interface. If a seamless service resource replacement is in progress, this indicates the IPv6 address of the endpoint network interface connected to the replaced service resource. If the endpoint only supports IPv4, this parameter is not returned\n" }, "resourceId": { "type": "string", "description": "Service resource ID\n" }, "serviceStatus": { "type": "string", "description": "Status of the service resource\n" }, "subnetId": { "type": "string", "description": "ID of the subnet to which the endpoint network interface belongs\n" }, "zoneDomain": { "type": "string", "description": "The domain name of the terminal node availability zone.\n" }, "zoneId": { "type": "string", "description": "Endpoint zone ID\n" }, "zoneStatus": { "type": "string", "description": "Status of the endpoint zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "networkInterfaceId", "networkInterfaceIp", "networkInterfaceIpv6", "resourceId", "serviceStatus", "subnetId", "zoneDomain", "zoneId", "zoneStatus" ] } } }, "volcenginecc:privatelink/VpcEndpointTag:VpcEndpointTag": { "properties": { "key": { "type": "string", "description": "Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.\n" }, "value": { "type": "string", "description": "Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:privatelink/VpcEndpointZone:VpcEndpointZone": { "properties": { "privateIpAddress": { "type": "string", "description": "The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use \u0026 to separate multiple private IPv4 addresses.\n" }, "privateIpv6Address": { "type": "string", "description": "The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use \u0026 to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with \u0026.\n" }, "zoneId": { "type": "string", "description": "ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with \u0026.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "privateIpAddress", "privateIpv6Address", "subnetId", "zoneId" ] } } }, "volcenginecc:privatelink/getEndpointServicePrivateDnsNameConfiguration:getEndpointServicePrivateDnsNameConfiguration": { "properties": { "name": { "type": "string", "description": "Domain verification name.\n" }, "status": { "type": "string", "description": "Domain verification status. PendingVerification: Pending verification. Verifying: In progress. Verified: Verified. Failed: Verification failed.\n" }, "type": { "type": "string", "description": "Domain verification type. TXT: TXT record.\n" }, "value": { "type": "string", "description": "Domain verification value.\n" } }, "type": "object", "required": [ "name", "status", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatelink/getEndpointServiceResource:getEndpointServiceResource": { "properties": { "resourceId": { "type": "string", "description": "Service resource ID to be added to the endpoint service.\n" }, "resourceType": { "type": "string", "description": "Type of service resource.\n" }, "zoneIds": { "type": "array", "items": { "type": "string" }, "description": "Availability zone where the load balancer provides service.\n" } }, "type": "object", "required": [ "resourceId", "resourceType", "zoneIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatelink/getEndpointServiceTag:getEndpointServiceTag": { "properties": { "key": { "type": "string", "description": "Tag keys for endpoint service tags.\n" }, "value": { "type": "string", "description": "Tag value of the endpoint service tag.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatelink/getVpcEndpointConnectionResourcesAllocate:getVpcEndpointConnectionResourcesAllocate": { "properties": { "resourceId": { "type": "string", "description": "Specify the service resource for the endpoint connection\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the service resource to be specified\n" } }, "type": "object", "required": [ "resourceId", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatelink/getVpcEndpointConnectionZone:getVpcEndpointConnectionZone": { "properties": { "networkInterfaceId": { "type": "string", "description": "Endpoint network interface ID. If a seamless service resource replacement is in progress, this indicates the endpoint network interface ID connected to the replaced service resource\n" }, "networkInterfaceIp": { "type": "string", "description": "The private IPv4 address of the terminal node NIC. If a smooth service resource replacement is in progress, this refers to the IPv4 address of the terminal node NIC connected to the service resource being replaced.\n" }, "networkInterfaceIpv6": { "type": "string", "description": "Private IPv6 address of the endpoint network interface. If a seamless service resource replacement is in progress, this indicates the IPv6 address of the endpoint network interface connected to the replaced service resource. If the endpoint only supports IPv4, this parameter is not returned\n" }, "resourceId": { "type": "string", "description": "Service resource ID\n" }, "serviceStatus": { "type": "string", "description": "Status of the service resource\n" }, "subnetId": { "type": "string", "description": "ID of the subnet to which the endpoint network interface belongs\n" }, "zoneDomain": { "type": "string", "description": "The domain name of the terminal node availability zone.\n" }, "zoneId": { "type": "string", "description": "Endpoint zone ID\n" }, "zoneStatus": { "type": "string", "description": "Status of the endpoint zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed\n" } }, "type": "object", "required": [ "networkInterfaceId", "networkInterfaceIp", "networkInterfaceIpv6", "resourceId", "serviceStatus", "subnetId", "zoneDomain", "zoneId", "zoneStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatelink/getVpcEndpointTag:getVpcEndpointTag": { "properties": { "key": { "type": "string", "description": "Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.\n" }, "value": { "type": "string", "description": "Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatelink/getVpcEndpointZone:getVpcEndpointZone": { "properties": { "ipv6ServiceStatus": { "type": "string", "description": "Service status of the endpoint node's IPv6 address. Active: normal. Inactive: abnormal.\n" }, "networkInterfaceId": { "type": "string", "description": "ID of the endpoint NIC used to connect to new service resources. If not in the process of seamless service resource replacement, this parameter returns empty.\n" }, "privateIpAddress": { "type": "string", "description": "The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use \u0026 to separate multiple private IPv4 addresses.\n" }, "privateIpv6Address": { "type": "string", "description": "The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use \u0026 to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.\n" }, "serviceStatus": { "type": "string", "description": "Service status of the endpoint IPv4 address. Active: Normal. Inactive: Abnormal.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with \u0026.\n" }, "zoneDomain": { "type": "string", "description": "Domain name of the endpoint availability zone.\n" }, "zoneId": { "type": "string", "description": "ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with \u0026.\n" }, "zoneStatus": { "type": "string", "description": "Status of the endpoint node's availability zone. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed.\n" } }, "type": "object", "required": [ "ipv6ServiceStatus", "networkInterfaceId", "privateIpAddress", "privateIpv6Address", "serviceStatus", "subnetId", "zoneDomain", "zoneId", "zoneStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatezone/ResolverEndpointIpConfig:ResolverEndpointIpConfig": { "properties": { "azId": { "type": "string", "description": "Availability zone for the endpoint IP address. To ensure high availability, it is recommended to add at least 2 availability zones\n" }, "ip": { "type": "string", "description": "IPv4 address of the endpoint. If you do not set this parameter, the system automatically assigns an IP address. You can add up to 6 IP addresses\n" }, "ipv6": { "type": "string", "description": "IPv6 address of the endpoint. If you do not set this parameter, the system automatically assigns an IP address. You can add up to 6 IP addresses\n" }, "subnetId": { "type": "string", "description": "Subnet ID for the endpoint IP address\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "azId", "ip", "ipv6", "subnetId" ] } } }, "volcenginecc:privatezone/ResolverEndpointTag:ResolverEndpointTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:privatezone/ResolverRuleForwardIP:ResolverRuleForwardIP": { "properties": { "ip": { "type": "string", "description": "IP address of the external DNS server for the VPC\n" }, "port": { "type": "integer", "description": "Port of the external DNS server for the VPC\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ip", "port" ] } } }, "volcenginecc:privatezone/ResolverRuleTag:ResolverRuleTag": { "properties": { "key": { "type": "string", "description": "Tag key for the user tag\n" }, "value": { "type": "string", "description": "Tag value for the user tag\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:privatezone/ResolverRuleVpC:ResolverRuleVpC": { "properties": { "region": { "type": "string", "description": "Region of the VPC\n" }, "vpcId": { "type": "string", "description": "VPC ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "region", "vpcId" ] } } }, "volcenginecc:privatezone/getResolverEndpointIpConfig:getResolverEndpointIpConfig": { "properties": { "azId": { "type": "string", "description": "Availability zone for the endpoint IP address. To ensure high availability, it is recommended to add at least 2 availability zones\n" }, "ip": { "type": "string", "description": "IPv4 address of the endpoint. If you do not set this parameter, the system automatically assigns an IP address. You can add up to 6 IP addresses\n" }, "ipv6": { "type": "string", "description": "IPv6 address of the endpoint. If you do not set this parameter, the system automatically assigns an IP address. You can add up to 6 IP addresses\n" }, "subnetId": { "type": "string", "description": "Subnet ID for the endpoint IP address\n" } }, "type": "object", "required": [ "azId", "ip", "ipv6", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatezone/getResolverEndpointTag:getResolverEndpointTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatezone/getResolverRuleForwardIP:getResolverRuleForwardIP": { "properties": { "ip": { "type": "string", "description": "IP address of the external DNS server for the VPC\n" }, "port": { "type": "integer", "description": "Port of the external DNS server for the VPC\n" } }, "type": "object", "required": [ "ip", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatezone/getResolverRuleTag:getResolverRuleTag": { "properties": { "key": { "type": "string", "description": "Tag key for the user tag\n" }, "value": { "type": "string", "description": "Tag value for the user tag\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:privatezone/getResolverRuleVpC:getResolverRuleVpC": { "properties": { "accountId": { "type": "string", "description": "Account ID that created the VPC\n" }, "region": { "type": "string", "description": "Region of the VPC\n" }, "regionName": { "type": "string", "description": "Name of the VPC region\n" }, "vpcId": { "type": "string", "description": "VPC ID\n" } }, "type": "object", "required": [ "accountId", "region", "regionName", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rabbitmq/AllowListAssociatedInstance:AllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId" ] } } }, "volcenginecc:rabbitmq/InstanceChargeDetail:InstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether to automatically renew the subscription instance after expiration.\n" }, "chargeEndTime": { "type": "string", "description": "Instance billing end time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeExpireTime": { "type": "string", "description": "Expiration time of the subscription instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStartTime": { "type": "string", "description": "Instance billing start time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Supported types include: PostPaid: pay-as-you-go, PrePaid: subscription.\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after the instance is suspended due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "overdueTime": { "type": "string", "description": "Instance suspension time due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "period": { "type": "integer", "description": "Subscription instance purchase duration. When PeriodUnit is set to Month, the value range is 1–9. When PeriodUnit is set to Year, the value range is 1–3.\n" }, "periodUnit": { "type": "string", "description": "Unit for purchase duration. Values: MONTHLY: monthly purchase, YEARLY: annual purchase.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "chargeEndTime", "chargeExpireTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ] } } }, "volcenginecc:rabbitmq/InstanceEndpoint:InstanceEndpoint": { "properties": { "endpointType": { "type": "string", "description": "Type of instance endpoint. RabbitMQ instances provide the following endpoint types: WEB: Web UI endpoint, AMQP0*9*1: AMQP endpoint, MQTT: MQTT endpoint, WEB_MQTT: WEB and MQTT endpoints, STOMP: STOMP endpoint.\n" }, "internalEndpoint": { "type": "string", "description": "Private network access domain name of the instance.\n" }, "internalIpEndpoint": { "type": "string", "description": "Public service zone IP endpoint.\n" }, "networkType": { "type": "string", "description": "Network type of the endpoint. PrivateNetwork indicates a private network (VPC).\n" }, "publicEndpoint": { "type": "string", "description": "Instance public access domain name. Displayed only after public access is enabled.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "endpointType", "internalEndpoint", "internalIpEndpoint", "networkType", "publicEndpoint" ] } } }, "volcenginecc:rabbitmq/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:rabbitmq/PublicAddressChargeDetail:PublicAddressChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether subscription instances are automatically renewed after expiration.\n" }, "chargeEndTime": { "type": "string", "description": "Instance billing end time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeExpireTime": { "type": "string", "description": "Expiration time for subscription instances. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStartTime": { "type": "string", "description": "Instance billing start time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Supported types: PostPaid: pay-as-you-go, PrePaid: subscription.\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after instance is stopped due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "overdueTime": { "type": "string", "description": "Instance overdue shutdown time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "chargeEndTime", "chargeExpireTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime" ] } } }, "volcenginecc:rabbitmq/PublicAddressEndpoint:PublicAddressEndpoint": { "properties": { "endpointType": { "type": "string", "description": "Access point type of the instance. RabbitMQ instance provides the following access point types: WEB: Web UI access point, AMQP0*9*1: AMQP access point, MQTT: MQTT access point, WEB_MQTT: WEB and MQTT access point, STOMP: STOMP access point.\n" }, "internalEndpoint": { "type": "string", "description": "Instance private network access domain name.\n" }, "internalIpEndpoint": { "type": "string", "description": "Public service zone IP access point.\n" }, "networkType": { "type": "string", "description": "Network type of the access point. PrivateNetwork indicates private VPC network.\n" }, "publicEndpoint": { "type": "string", "description": "Instance public access domain name. Displayed only after public access is enabled.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "endpointType", "internalEndpoint", "internalIpEndpoint", "networkType", "publicEndpoint" ] } } }, "volcenginecc:rabbitmq/PublicAddressTag:PublicAddressTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:rabbitmq/getAllowListAssociatedInstance:getAllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance Name\n" }, "vpc": { "type": "string", "description": "VPC ID of the instance\n" } }, "type": "object", "required": [ "instanceId", "instanceName", "vpc" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rabbitmq/getInstanceChargeDetail:getInstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether to automatically renew the subscription instance after expiration.\n" }, "chargeEndTime": { "type": "string", "description": "Instance billing end time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeExpireTime": { "type": "string", "description": "Expiration time of the subscription instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStartTime": { "type": "string", "description": "Instance billing start time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Supported types include: PostPaid: pay-as-you-go, PrePaid: subscription.\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after the instance is suspended due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "overdueTime": { "type": "string", "description": "Instance suspension time due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "period": { "type": "integer", "description": "Subscription instance purchase duration. When PeriodUnit is set to Month, the value range is 1–9. When PeriodUnit is set to Year, the value range is 1–3.\n" }, "periodUnit": { "type": "string", "description": "Unit for purchase duration. Values: MONTHLY: monthly purchase, YEARLY: annual purchase.\n" } }, "type": "object", "required": [ "autoRenew", "chargeEndTime", "chargeExpireTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rabbitmq/getInstanceEndpoint:getInstanceEndpoint": { "properties": { "endpointType": { "type": "string", "description": "Type of instance endpoint. RabbitMQ instances provide the following endpoint types: WEB: Web UI endpoint, AMQP0*9*1: AMQP endpoint, MQTT: MQTT endpoint, WEB_MQTT: WEB and MQTT endpoints, STOMP: STOMP endpoint.\n" }, "internalEndpoint": { "type": "string", "description": "Private network access domain name of the instance.\n" }, "internalIpEndpoint": { "type": "string", "description": "Public service zone IP endpoint.\n" }, "networkType": { "type": "string", "description": "Network type of the endpoint. PrivateNetwork indicates a private network (VPC).\n" }, "publicEndpoint": { "type": "string", "description": "Instance public access domain name. Displayed only after public access is enabled.\n" } }, "type": "object", "required": [ "endpointType", "internalEndpoint", "internalIpEndpoint", "networkType", "publicEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rabbitmq/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rabbitmq/getPublicAddressChargeDetail:getPublicAddressChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether subscription instances are automatically renewed after expiration.\n" }, "chargeEndTime": { "type": "string", "description": "Instance billing end time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeExpireTime": { "type": "string", "description": "Expiration time for subscription instances. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStartTime": { "type": "string", "description": "Instance billing start time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Includes: Normal: normal, Overdue: pay-as-you-go overdue, Expired: subscription expired.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Supported types: PostPaid: pay-as-you-go, PrePaid: subscription.\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after instance is stopped due to overdue payment. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "overdueTime": { "type": "string", "description": "Instance overdue shutdown time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" } }, "type": "object", "required": [ "autoRenew", "chargeEndTime", "chargeExpireTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rabbitmq/getPublicAddressEndpoint:getPublicAddressEndpoint": { "properties": { "endpointType": { "type": "string", "description": "Access point type of the instance. RabbitMQ instance provides the following access point types: WEB: Web UI access point, AMQP0*9*1: AMQP access point, MQTT: MQTT access point, WEB_MQTT: WEB and MQTT access point, STOMP: STOMP access point.\n" }, "internalEndpoint": { "type": "string", "description": "Instance private network access domain name.\n" }, "internalIpEndpoint": { "type": "string", "description": "Public service zone IP access point.\n" }, "networkType": { "type": "string", "description": "Network type of the access point. PrivateNetwork indicates private VPC network.\n" }, "publicEndpoint": { "type": "string", "description": "Instance public access domain name. Displayed only after public access is enabled.\n" } }, "type": "object", "required": [ "endpointType", "internalEndpoint", "internalIpEndpoint", "networkType", "publicEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rabbitmq/getPublicAddressTag:getPublicAddressTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmssql/AllowListAssociatedInstance:AllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance name\n" }, "instanceStatus": { "type": "string", "description": "Instance status\n" }, "isLatest": { "type": "boolean", "description": "Sync latest allowlist IP\n" }, "projectName": { "type": "string", "description": "Project name of the instance\n" }, "vpc": { "type": "string", "description": "VPC ID of the instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId", "instanceName", "instanceStatus", "isLatest", "projectName", "vpc" ] } } }, "volcenginecc:rdsmssql/InstanceChargeInfo:InstanceChargeInfo": { "properties": { "autoRenew": { "type": "boolean", "description": "Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.\n" }, "chargeEndTime": { "type": "string", "description": "Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "chargeStartTime": { "type": "string", "description": "Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "chargeStatus": { "type": "string", "description": "Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.\n" }, "chargeType": { "type": "string", "description": "Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "overdueTime": { "type": "string", "description": "Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "period": { "type": "integer", "description": "Purchase duration for prepaid scenarios. Default: 1 month.\n" }, "periodUnit": { "type": "string", "description": "Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "chargeEndTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ] } } }, "volcenginecc:rdsmssql/InstanceConnectionInfo:InstanceConnectionInfo": { "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceConnectionInfoAddress:InstanceConnectionInfoAddress" } }, "description": { "type": "string", "description": "Description.\n" }, "endpointId": { "type": "string", "description": "Terminal ID.\n" }, "endpointName": { "type": "string", "description": "Terminal name.\n" }, "endpointType": { "type": "string", "description": "Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "addresses", "description", "endpointId", "endpointName", "endpointType" ] } } }, "volcenginecc:rdsmssql/InstanceConnectionInfoAddress:InstanceConnectionInfoAddress": { "properties": { "dnsVisibility": { "type": "boolean", "description": "Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.\n" }, "domain": { "type": "string", "description": "Domain name.\n" }, "eipId": { "type": "string", "description": "EIP ID, valid only for public addresses.\n" }, "ipAddress": { "type": "string", "description": "IP address.\n" }, "networkType": { "type": "string", "description": "Network address type. Possible values: Private: private network type. Public: public network type.\n" }, "port": { "type": "string", "description": "Port.\n" }, "subnetId": { "type": "string", "description": "Subnet ID, valid only for private network addresses.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsVisibility", "domain", "eipId", "ipAddress", "networkType", "port", "subnetId" ] } } }, "volcenginecc:rdsmssql/InstanceNodeDetailInfo:InstanceNodeDetailInfo": { "properties": { "createTime": { "type": "string", "description": "Node creation time.\n" }, "hostName": { "type": "string", "description": "Node hostname.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "memory": { "type": "integer", "description": "Memory size, in GiB.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodeIp": { "type": "string", "description": "Node IP.\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeStatus": { "type": "string", "description": "Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.\n" }, "nodeType": { "type": "string", "description": "Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.\n" }, "regionId": { "type": "string", "description": "Region ID.\n" }, "updateTime": { "type": "string", "description": "Update time.\n" }, "vcpu": { "type": "integer", "description": "vCPU count.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createTime", "hostName", "instanceId", "memory", "nodeId", "nodeIp", "nodeSpec", "nodeStatus", "nodeType", "regionId", "updateTime", "vcpu", "zoneId" ] } } }, "volcenginecc:rdsmssql/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:rdsmssql/getAllowListAssociatedInstance:getAllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance name\n" }, "instanceStatus": { "type": "string", "description": "Instance status\n" }, "isLatest": { "type": "boolean", "description": "Sync latest allowlist IP\n" }, "projectName": { "type": "string", "description": "Project name of the instance\n" }, "vpc": { "type": "string", "description": "VPC ID of the instance\n" } }, "type": "object", "required": [ "instanceId", "instanceName", "instanceStatus", "isLatest", "projectName", "vpc" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmssql/getInstanceChargeInfo:getInstanceChargeInfo": { "properties": { "autoRenew": { "type": "boolean", "description": "Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.\n" }, "chargeEndTime": { "type": "string", "description": "Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "chargeStartTime": { "type": "string", "description": "Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "chargeStatus": { "type": "string", "description": "Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.\n" }, "chargeType": { "type": "string", "description": "Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "overdueTime": { "type": "string", "description": "Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "period": { "type": "integer", "description": "Purchase duration for prepaid scenarios. Default: 1 month.\n" }, "periodUnit": { "type": "string", "description": "Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.\n" } }, "type": "object", "required": [ "autoRenew", "chargeEndTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmssql/getInstanceConnectionInfo:getInstanceConnectionInfo": { "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/getInstanceConnectionInfoAddress:getInstanceConnectionInfoAddress" }, "description": "Address list.\n" }, "description": { "type": "string", "description": "Description.\n" }, "endpointId": { "type": "string", "description": "Terminal ID.\n" }, "endpointName": { "type": "string", "description": "Terminal name.\n" }, "endpointType": { "type": "string", "description": "Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.\n" } }, "type": "object", "required": [ "addresses", "description", "endpointId", "endpointName", "endpointType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmssql/getInstanceConnectionInfoAddress:getInstanceConnectionInfoAddress": { "properties": { "dnsVisibility": { "type": "boolean", "description": "Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.\n" }, "domain": { "type": "string", "description": "Domain name.\n" }, "eipId": { "type": "string", "description": "EIP ID, valid only for public addresses.\n" }, "ipAddress": { "type": "string", "description": "IP address.\n" }, "networkType": { "type": "string", "description": "Network address type. Possible values: Private: private network type. Public: public network type.\n" }, "port": { "type": "string", "description": "Port.\n" }, "subnetId": { "type": "string", "description": "Subnet ID, valid only for private network addresses.\n" } }, "type": "object", "required": [ "dnsVisibility", "domain", "eipId", "ipAddress", "networkType", "port", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmssql/getInstanceNodeDetailInfo:getInstanceNodeDetailInfo": { "properties": { "createTime": { "type": "string", "description": "Node creation time.\n" }, "hostName": { "type": "string", "description": "Node hostname.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "memory": { "type": "integer", "description": "Memory size, in GiB.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodeIp": { "type": "string", "description": "Node IP.\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeStatus": { "type": "string", "description": "Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.\n" }, "nodeType": { "type": "string", "description": "Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.\n" }, "regionId": { "type": "string", "description": "Region ID.\n" }, "updateTime": { "type": "string", "description": "Update time.\n" }, "vcpu": { "type": "integer", "description": "vCPU count.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "type": "object", "required": [ "createTime", "hostName", "instanceId", "memory", "nodeId", "nodeIp", "nodeSpec", "nodeStatus", "nodeType", "regionId", "updateTime", "vcpu", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmssql/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/AllowListAssociatedInstance:AllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID bound to the current allowlist.\n" }, "instanceName": { "type": "string", "description": "Instance name bound to the current allowlist.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "isLatest": { "type": "boolean", "description": "Has the latest allowlist been synchronized? Values: true: Yes. false: No. Note: When modifying the allowlist, if the instance is not running, changes to the allowlist will not be immediately synchronized to the instance.\n" }, "vpc": { "type": "string", "description": "Private network ID of the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId", "instanceName", "instanceStatus", "isLatest", "vpc" ] } } }, "volcenginecc:rdsmysql/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo": { "properties": { "bindMode": { "type": "string", "description": "Mode for associating security groups. Values: IngressDirectionIp: Inbound IP. AssociateEcsIp: Associate ECS IP. Note: In the CreateAllowList API, the BindMode and SecurityGroupId fields of SecurityGroupBindInfoObject are required.\n" }, "ipLists": { "type": "array", "items": { "type": "string" }, "description": "Security group IP address list.\n" }, "securityGroupId": { "type": "string", "description": "Security group ID.\n" }, "securityGroupName": { "type": "string", "description": "Security group name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bindMode", "ipLists", "securityGroupId", "securityGroupName" ] } } }, "volcenginecc:rdsmysql/BackupBackupMeta:BackupBackupMeta": { "properties": { "database": { "type": "string", "description": "Database name\n" }, "tables": { "type": "array", "items": { "type": "string" }, "description": "Table name list\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "database", "tables" ] } } }, "volcenginecc:rdsmysql/BackupDbTableInfo:BackupDbTableInfo": { "properties": { "database": { "type": "string", "description": "Database name\n" }, "tables": { "type": "array", "items": { "type": "string" }, "description": "Table name list\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "database", "tables" ] } } }, "volcenginecc:rdsmysql/DatabaseDatabasePrivilege:DatabaseDatabasePrivilege": { "properties": { "accountName": { "type": "string", "description": "Database account name.\n" }, "accountPrivilege": { "type": "string", "description": "Granted account privilege type. Values: ReadWrite (read and write privileges), ReadOnly (read-only privileges), DDLOnly (DDL privileges only), DMLOnly (DML privileges only), Custom (custom privileges).\n" }, "host": { "type": "string", "description": "The specified database account can access the database from the IP address. Default value: %. If Host is set to %, the account can access the database from any IP address. If Host is set to 192.10.10.%, the account can access the database from IP addresses between 192.10.10.0 and 192.10.10.255. The specified Host must be added to the instance's allowlist.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountName", "accountPrivilege", "host" ] } } }, "volcenginecc:rdsmysql/DbAccountAccountPrivilege:DbAccountAccountPrivilege": { "properties": { "accountPrivilege": { "type": "string", "description": "Type of database permission. Value options: ReadWrite: read and write permission. ReadOnly: read-only permission. DDLOnly: DDL permission only. DMLOnly: DML permission only. Custom: custom permission. Global: global permission. None: clear account permission. Note: When used as a request parameter, pay attention to the following: Only Global and None are allowed as values when used as request parameters. Permission type is single-select; passing multiple values will result in an error. Only the GrantDBAccountPrivilege API supports None as a value for AccountPrivilege. When AccountPrivilege is set to None and DBName is an empty string, all global permissions for the account are cleared. If DBName is set to a specific database, all permissions for the account in that database are cleared.\n" }, "accountPrivilegeDetails": { "type": "array", "items": { "type": "string" }, "description": "Account privilege information. When AccountPrivilege is set to Custom, the valid values for this field are: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, EVENT, TRIGGER, CREATE ROUTINE, ALTER ROUTINE. When AccountPrivilege is set to Global, the valid values for this field are: PROCESS, REPLICATION SLAVE, REPLICATION CLIENT, SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, REFERENCES, INDEX, ALTER, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, SHOW DATABASES, CREATE TEMPORARY TABLES. Note: When used as a request parameter, this field is required if AccountPrivilege is set to Custom. In the CreateDBAccount API, REPLICATION SLAVE, PROCESS, and REPLICATION CLIENT global privileges are automatically granted to the account. Multiple values can be specified, separated by commas (,). The write mode is overwrite.\n" }, "dbName": { "type": "string", "description": "The name of the database for which account authorization needs to be modified or for which the account already has privileges. Note: When used as a request parameter in the CreateDBAccount and GrantDBAccountPrivilege APIs, ensure that the database corresponding to DBName already exists. For global privilege modifications, set DBName to an empty string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountPrivilege", "accountPrivilegeDetails", "dbName" ] } } }, "volcenginecc:rdsmysql/DbAccountTableColumnPrivilege:DbAccountTableColumnPrivilege": { "properties": { "columnPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DbAccountTableColumnPrivilegeColumnPrivilege:DbAccountTableColumnPrivilegeColumnPrivilege" } }, "dbName": { "type": "string", "description": "Name of the database to which the table belongs for setting permissions for the account.\n" }, "tablePrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DbAccountTableColumnPrivilegeTablePrivilege:DbAccountTableColumnPrivilegeTablePrivilege" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "columnPrivileges", "dbName", "tablePrivileges" ] } } }, "volcenginecc:rdsmysql/DbAccountTableColumnPrivilegeColumnPrivilege:DbAccountTableColumnPrivilegeColumnPrivilege": { "properties": { "accountPrivilegeDetails": { "type": "array", "items": { "type": "string" }, "description": "Permission information for setting column permissions for the account. Values (multiple selections allowed): INSERT, REFERENCES, SELECT, UPDATE. Note: Use commas (,) to separate multiple permissions.\n" }, "columnName": { "type": "string", "description": "Name of the column for setting column permissions for the account.\n" }, "tableName": { "type": "string", "description": "Name of the database to which the table belongs for setting column permissions for the account.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountPrivilegeDetails", "columnName", "tableName" ] } } }, "volcenginecc:rdsmysql/DbAccountTableColumnPrivilegeTablePrivilege:DbAccountTableColumnPrivilegeTablePrivilege": { "properties": { "accountPrivilegeDetails": { "type": "array", "items": { "type": "string" }, "description": "Account table permissions. Value options (multiple selections allowed): ALTER, CREATE, DELETE, DROP, INDEX, INSERT, SELECT, SHOW, VIEW, TRIGGER, UPDATE, CREATE VIEW, REFERENCES. Note: Use commas (,) to separate multiple permissions.\n" }, "tableName": { "type": "string", "description": "Name of the table for setting permissions for the account.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountPrivilegeDetails", "tableName" ] } } }, "volcenginecc:rdsmysql/EndpointAddress:EndpointAddress": { "properties": { "dnsVisibility": { "type": "boolean", "description": "false: Volcano Engine private network resolution (default). true: Volcano Engine private network and public network resolution.\n" }, "domainPrefix": { "type": "string", "description": "Connection address prefix. The prefix must meet the following rules: start with a lowercase letter and end with a lowercase letter or digit; contain at least two of the following: lowercase letters, digits, or hyphens (-); be at least 8 characters long; and the total connection address length (prefix + suffix) must not exceed 63 characters.\n" }, "port": { "type": "string", "description": "Port.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsVisibility", "domainPrefix", "port" ] } } }, "volcenginecc:rdsmysql/EndpointCustomRouteStrategy:EndpointCustomRouteStrategy": { "properties": { "keywordRouteStrategies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/EndpointCustomRouteStrategyKeywordRouteStrategy:EndpointCustomRouteStrategyKeywordRouteStrategy" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "keywordRouteStrategies" ] } } }, "volcenginecc:rdsmysql/EndpointCustomRouteStrategyKeywordRouteStrategy:EndpointCustomRouteStrategyKeywordRouteStrategy": { "properties": { "nodeType": { "type": "string", "description": "SQL forwarding rule target. Options: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. Note: For dual-node instances, you can select the primary node or read-only node. For multi-node instances, you can select the primary node or secondary node.\n" }, "sqlKeyword": { "type": "string", "description": "Forwarding rule keywords. SQL keyword rules: Each rule can contain up to 20 keywords, with a maximum length of 64 characters. Allowed characters: English letters, digits, underscore (_), @, #, :=, and Chinese characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodeType", "sqlKeyword" ] } } }, "volcenginecc:rdsmysql/EndpointReadOnlyNodeWeight:EndpointReadOnlyNodeWeight": { "properties": { "nodeId": { "type": "string", "description": "NodeId is required for read-only nodes; not required for primary nodes.\n" }, "nodeType": { "type": "string", "description": "Node type. Primary: primary node. ReadOnly: read-only node.\n" }, "weight": { "type": "integer", "description": "Node read weight increases in increments of 100, up to a maximum of 10,000. Note: Not all weights can be set to 0.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodeId", "nodeType", "weight" ] } } }, "volcenginecc:rdsmysql/InstanceAddressObject:InstanceAddressObject": { "properties": { "dnsVisibility": { "type": "boolean", "description": "false: private network resolution (default). true: private and public network resolution.\n" }, "domain": { "type": "string", "description": "Connection domain name\n" }, "eipId": { "type": "string", "description": "EIP ID, valid only for Public addresses.\n" }, "internetProtocol": { "type": "string", "description": "IP protocol version. Value: IPv4.\n" }, "ipAddress": { "type": "string", "description": "IP address.\n" }, "networkType": { "type": "string", "description": "Network address type. Values: Private: private address. Public: public address\n" }, "port": { "type": "string", "description": "Port\n" }, "subnetId": { "type": "string", "description": "Subnet ID, valid only for Private addresses\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsVisibility", "domain", "eipId", "internetProtocol", "ipAddress", "networkType", "port", "subnetId" ] } } }, "volcenginecc:rdsmysql/InstanceAutoStorageScalingConfig:InstanceAutoStorageScalingConfig": { "properties": { "enableStorageAutoScale": { "type": "boolean", "description": "Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.\n" }, "storageThreshold": { "type": "integer", "description": "Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %\n" }, "storageUpperBound": { "type": "integer", "description": "Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableStorageAutoScale", "storageThreshold", "storageUpperBound" ] } } }, "volcenginecc:rdsmysql/InstanceChargeDetail:InstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew\n" }, "chargeEndTime": { "type": "string", "description": "Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.\n" }, "chargeStartTime": { "type": "string", "description": "Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.\n" }, "chargeType": { "type": "string", "description": "Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go\n" }, "number": { "type": "integer", "description": "Number of instances to purchase. Value range: 1–50. Default: 1\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ\n" }, "overdueTime": { "type": "string", "description": "Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.\n" }, "period": { "type": "integer", "description": "Purchase duration in prepaid scenarios.\n" }, "periodUnit": { "type": "string", "description": "Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.\n" }, "tempModifyEndTime": { "type": "string", "description": "Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.\n" }, "tempModifyStartTime": { "type": "string", "description": "Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ\n" } }, "type": "object", "required": [ "chargeType" ], "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "chargeEndTime", "chargeStartTime", "chargeStatus", "chargeType", "number", "overdueReclaimTime", "overdueTime", "period", "periodUnit", "tempModifyEndTime", "tempModifyStartTime" ] } } }, "volcenginecc:rdsmysql/InstanceDisasterRecoveryInstance:InstanceDisasterRecoveryInstance": { "properties": { "dtsTaskId": { "type": "string", "description": "ID of synchronization tasks between primary and disaster recovery instances.\n" }, "dtsTaskName": { "type": "string", "description": "Name of the synchronization task between the primary instance and the disaster recovery instance\n" }, "dtsTaskStatus": { "type": "string", "description": "Status of synchronization tasks between the primary instance and the disaster recovery instance\n" }, "instanceId": { "type": "string", "description": "Disaster recovery instance ID.\n" }, "instanceName": { "type": "string", "description": "Name of disaster recovery instance.\n" }, "secondsBehindMaster": { "type": "integer", "description": "Latency between the disaster recovery instance and the primary instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dtsTaskId", "dtsTaskName", "dtsTaskStatus", "instanceId", "instanceName", "secondsBehindMaster" ] } } }, "volcenginecc:rdsmysql/InstanceEndpoint:InstanceEndpoint": { "properties": { "autoAddNewNodes": { "type": "string", "description": "When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)\n" }, "connectionInfoTags": { "type": "array", "items": { "type": "string" }, "description": "Connection endpoint tag.\n" }, "connectionMode": { "type": "string", "description": "Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint\n" }, "connectionPoolType": { "type": "string", "description": "Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.\n" }, "description": { "type": "string", "description": "Description of the connection endpoint\n" }, "enableConnectionPersistent": { "type": "boolean", "description": "Enable connection keep-alive. Options: true: yes. false: no\n" }, "enableReadOnly": { "type": "string", "description": "Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.\n" }, "enableReadWriteSplitting": { "type": "string", "description": "Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.\n" }, "endpointId": { "type": "string", "description": "Instance connection endpoint ID.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Endpoint type. Value: Custom, custom endpoint.\n" }, "idleConnectionReclaim": { "type": "boolean", "description": "Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.\n" }, "implicitTransSplit": { "type": "boolean", "description": "Whether to enable transaction separation. Values: true: Yes. false: No.\n" }, "masterNodeRouting": { "type": "boolean", "description": "Whether to enable primary node routing. Values: true: Yes. false: No.\n" }, "masterProtectorTimeout": { "type": "integer", "description": "Overload protection timeout. Value range: integer between 60 and 7200, in seconds.\n" }, "multiStatementsMode": { "type": "string", "description": "Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode\n" }, "overloadProtection": { "type": "boolean", "description": "Overload protection enabled. Values: true: yes. false: no\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.\n" }, "readOnlyNodeMaxDelayTime": { "type": "integer", "description": "Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceEndpointReadOnlyNodeWeight:InstanceEndpointReadOnlyNodeWeight" } }, "readWriteMode": { "type": "string", "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoAddNewNodes", "connectionInfoTags", "connectionMode", "connectionPoolType", "description", "enableConnectionPersistent", "enableReadOnly", "enableReadWriteSplitting", "endpointId", "endpointName", "endpointType", "idleConnectionReclaim", "implicitTransSplit", "masterNodeRouting", "masterProtectorTimeout", "multiStatementsMode", "overloadProtection", "readOnlyNodeDistributionType", "readOnlyNodeMaxDelayTime", "readOnlyNodeWeights", "readWriteMode" ] } } }, "volcenginecc:rdsmysql/InstanceEndpointReadOnlyNodeWeight:InstanceEndpointReadOnlyNodeWeight": { "properties": { "nodeId": { "type": "string", "description": "Read-only nodes require NodeId. Primary nodes do not require it\n" }, "nodeType": { "type": "string", "description": "Node type. Primary: primary node. ReadOnly: read-only node\n" }, "weight": { "type": "integer", "description": "Node read weight, increments of 100, maximum value is 10000.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodeId", "nodeType", "weight" ] } } }, "volcenginecc:rdsmysql/InstanceMaintenanceWindow:InstanceMaintenanceWindow": { "properties": { "dayKind": { "type": "string", "description": "Maintenance cycle granularity. Value: Week.\n" }, "dayOfWeeks": { "type": "array", "items": { "type": "string" }, "description": "Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dayKind", "dayOfWeeks", "maintenanceTime" ] } } }, "volcenginecc:rdsmysql/InstanceNode:InstanceNode": { "properties": { "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeType": { "type": "string", "description": "Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID\n" } }, "type": "object", "required": [ "nodeSpec", "nodeType", "zoneId" ] }, "volcenginecc:rdsmysql/InstanceProxyDetail:InstanceProxyDetail": { "properties": { "dbProxyStatus": { "type": "string", "description": "Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling\n" }, "proxyResourceInfo": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceProxyDetailProxyResourceInfo:InstanceProxyDetailProxyResourceInfo", "description": "Resource information for the instance's database proxy service\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dbProxyStatus", "proxyResourceInfo" ] } } }, "volcenginecc:rdsmysql/InstanceProxyDetailProxyResourceInfo:InstanceProxyDetailProxyResourceInfo": { "properties": { "currentProxyCpuNum": { "type": "integer", "description": "Current number of cores for the instance database proxy service\n" }, "maxProxyCpuNum": { "type": "integer", "description": "Maximum number of cores configurable for database proxy service.\n" }, "minProxyCpuNum": { "type": "integer", "description": "Minimum number of CPU cores configurable for the database proxy service\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "currentProxyCpuNum", "maxProxyCpuNum", "minProxyCpuNum" ] } } }, "volcenginecc:rdsmysql/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:rdsmysql/getAllowListAssociatedInstance:getAllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID bound to the current allowlist.\n" }, "instanceName": { "type": "string", "description": "Instance name bound to the current allowlist.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "isLatest": { "type": "boolean", "description": "Has the latest allowlist been synchronized? Values: true: Yes. false: No. Note: When modifying the allowlist, if the instance is not running, changes to the allowlist will not be immediately synchronized to the instance.\n" }, "vpc": { "type": "string", "description": "Private network ID of the instance.\n" } }, "type": "object", "required": [ "instanceId", "instanceName", "instanceStatus", "isLatest", "vpc" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getAllowListSecurityGroupBindInfo:getAllowListSecurityGroupBindInfo": { "properties": { "bindMode": { "type": "string", "description": "Mode for associating security groups. Values: IngressDirectionIp: Inbound IP. AssociateEcsIp: Associate ECS IP. Note: In the CreateAllowList API, the BindMode and SecurityGroupId fields of SecurityGroupBindInfoObject are required.\n" }, "ipLists": { "type": "array", "items": { "type": "string" }, "description": "Security group IP address list.\n" }, "securityGroupId": { "type": "string", "description": "Security group ID.\n" }, "securityGroupName": { "type": "string", "description": "Security group name.\n" } }, "type": "object", "required": [ "bindMode", "ipLists", "securityGroupId", "securityGroupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getBackupBackupMeta:getBackupBackupMeta": { "properties": { "database": { "type": "string", "description": "Database name\n" }, "tables": { "type": "array", "items": { "type": "string" }, "description": "Table name list\n" } }, "type": "object", "required": [ "database", "tables" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getBackupDbTableInfo:getBackupDbTableInfo": { "properties": { "database": { "type": "string", "description": "Database name\n" }, "tables": { "type": "array", "items": { "type": "string" }, "description": "Table name list\n" } }, "type": "object", "required": [ "database", "tables" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getDatabaseDatabasePrivilege:getDatabaseDatabasePrivilege": { "properties": { "accountName": { "type": "string", "description": "Database account name.\n" }, "accountPrivilege": { "type": "string", "description": "Granted account privilege type. Values: ReadWrite (read and write privileges), ReadOnly (read-only privileges), DDLOnly (DDL privileges only), DMLOnly (DML privileges only), Custom (custom privileges).\n" }, "accountPrivilegeDetail": { "type": "string", "description": "Database privilege string. When used as a request parameter, this field is required if AccountPrivilege is set to Custom. Values: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER. When returned, the detailed privileges for AccountPrivilege are displayed regardless of whether AccountPrivilege is set to Custom.\n" }, "host": { "type": "string", "description": "The specified database account can access the database from the IP address. Default value: %. If Host is set to %, the account can access the database from any IP address. If Host is set to 192.10.10.%, the account can access the database from IP addresses between 192.10.10.0 and 192.10.10.255. The specified Host must be added to the instance's allowlist.\n" } }, "type": "object", "required": [ "accountName", "accountPrivilege", "accountPrivilegeDetail", "host" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getDbAccountAccountPrivilege:getDbAccountAccountPrivilege": { "properties": { "accountPrivilege": { "type": "string", "description": "Type of database permission. Value options: ReadWrite: read and write permission. ReadOnly: read-only permission. DDLOnly: DDL permission only. DMLOnly: DML permission only. Custom: custom permission. Global: global permission. None: clear account permission. Note: When used as a request parameter, pay attention to the following: Only Global and None are allowed as values when used as request parameters. Permission type is single-select; passing multiple values will result in an error. Only the GrantDBAccountPrivilege API supports None as a value for AccountPrivilege. When AccountPrivilege is set to None and DBName is an empty string, all global permissions for the account are cleared. If DBName is set to a specific database, all permissions for the account in that database are cleared.\n" }, "accountPrivilegeDetails": { "type": "array", "items": { "type": "string" }, "description": "Account privilege information. When AccountPrivilege is set to Custom, the valid values for this field are: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, EVENT, TRIGGER, CREATE ROUTINE, ALTER ROUTINE. When AccountPrivilege is set to Global, the valid values for this field are: PROCESS, REPLICATION SLAVE, REPLICATION CLIENT, SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, REFERENCES, INDEX, ALTER, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, SHOW DATABASES, CREATE TEMPORARY TABLES. Note: When used as a request parameter, this field is required if AccountPrivilege is set to Custom. In the CreateDBAccount API, REPLICATION SLAVE, PROCESS, and REPLICATION CLIENT global privileges are automatically granted to the account. Multiple values can be specified, separated by commas (,). The write mode is overwrite.\n" }, "dbName": { "type": "string", "description": "The name of the database for which account authorization needs to be modified or for which the account already has privileges. Note: When used as a request parameter in the CreateDBAccount and GrantDBAccountPrivilege APIs, ensure that the database corresponding to DBName already exists. For global privilege modifications, set DBName to an empty string.\n" } }, "type": "object", "required": [ "accountPrivilege", "accountPrivilegeDetails", "dbName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getDbAccountTableColumnPrivilege:getDbAccountTableColumnPrivilege": { "properties": { "columnPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getDbAccountTableColumnPrivilegeColumnPrivilege:getDbAccountTableColumnPrivilegeColumnPrivilege" }, "description": "Account column permission information.\n" }, "dbName": { "type": "string", "description": "Name of the database to which the table belongs for setting permissions for the account.\n" }, "tablePrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getDbAccountTableColumnPrivilegeTablePrivilege:getDbAccountTableColumnPrivilegeTablePrivilege" }, "description": "Account table permission information.\n" } }, "type": "object", "required": [ "columnPrivileges", "dbName", "tablePrivileges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getDbAccountTableColumnPrivilegeColumnPrivilege:getDbAccountTableColumnPrivilegeColumnPrivilege": { "properties": { "accountPrivilegeDetails": { "type": "array", "items": { "type": "string" }, "description": "Permission information for setting column permissions for the account. Values (multiple selections allowed): INSERT, REFERENCES, SELECT, UPDATE. Note: Use commas (,) to separate multiple permissions.\n" }, "columnName": { "type": "string", "description": "Name of the column for setting column permissions for the account.\n" }, "tableName": { "type": "string", "description": "Name of the database to which the table belongs for setting column permissions for the account.\n" } }, "type": "object", "required": [ "accountPrivilegeDetails", "columnName", "tableName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getDbAccountTableColumnPrivilegeTablePrivilege:getDbAccountTableColumnPrivilegeTablePrivilege": { "properties": { "accountPrivilegeDetails": { "type": "array", "items": { "type": "string" }, "description": "Account table permissions. Value options (multiple selections allowed): ALTER, CREATE, DELETE, DROP, INDEX, INSERT, SELECT, SHOW, VIEW, TRIGGER, UPDATE, CREATE VIEW, REFERENCES. Note: Use commas (,) to separate multiple permissions.\n" }, "tableName": { "type": "string", "description": "Name of the table for setting permissions for the account.\n" } }, "type": "object", "required": [ "accountPrivilegeDetails", "tableName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getEndpointAddress:getEndpointAddress": { "properties": { "dnsVisibility": { "type": "boolean", "description": "false: Volcano Engine private network resolution (default). true: Volcano Engine private network and public network resolution.\n" }, "domain": { "type": "string", "description": "Connection domain name.\n" }, "domainPrefix": { "type": "string", "description": "Connection address prefix. The prefix must meet the following rules: start with a lowercase letter and end with a lowercase letter or digit; contain at least two of the following: lowercase letters, digits, or hyphens (-); be at least 8 characters long; and the total connection address length (prefix + suffix) must not exceed 63 characters.\n" }, "eipId": { "type": "string", "description": "EIP ID, valid only for Public addresses.\n" }, "eipLocked": { "type": "boolean", "description": "Whether the EIP used by the connection endpoint is suspended due to overdue payment. Options: true: yes. false: no.\n" }, "internetProtocol": { "type": "string", "description": "IP protocol version. Value: IPv4.\n" }, "ipAddress": { "type": "string", "description": "IP address.\n" }, "networkType": { "type": "string", "description": "Network address type. Options: Private: private network address. Public: public network address.\n" }, "port": { "type": "string", "description": "Port.\n" }, "subnetId": { "type": "string", "description": "Subnet ID, valid only for Private addresses.\n" } }, "type": "object", "required": [ "dnsVisibility", "domain", "domainPrefix", "eipId", "eipLocked", "internetProtocol", "ipAddress", "networkType", "port", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getEndpointCustomRouteStrategy:getEndpointCustomRouteStrategy": { "properties": { "keywordRouteStrategies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getEndpointCustomRouteStrategyKeywordRouteStrategy:getEndpointCustomRouteStrategyKeywordRouteStrategy" }, "description": "Custom routing policy list.\n" } }, "type": "object", "required": [ "keywordRouteStrategies" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getEndpointCustomRouteStrategyKeywordRouteStrategy:getEndpointCustomRouteStrategyKeywordRouteStrategy": { "properties": { "nodeType": { "type": "string", "description": "SQL forwarding rule target. Options: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. Note: For dual-node instances, you can select the primary node or read-only node. For multi-node instances, you can select the primary node or secondary node.\n" }, "sqlKeyword": { "type": "string", "description": "Forwarding rule keywords. SQL keyword rules: Each rule can contain up to 20 keywords, with a maximum length of 64 characters. Allowed characters: English letters, digits, underscore (_), @, #, :=, and Chinese characters.\n" } }, "type": "object", "required": [ "nodeType", "sqlKeyword" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getEndpointReadOnlyNodeWeight:getEndpointReadOnlyNodeWeight": { "properties": { "nodeId": { "type": "string", "description": "NodeId is required for read-only nodes; not required for primary nodes.\n" }, "nodeType": { "type": "string", "description": "Node type. Primary: primary node. ReadOnly: read-only node.\n" }, "weight": { "type": "integer", "description": "Node read weight increases in increments of 100, up to a maximum of 10,000. Note: Not all weights can be set to 0.\n" } }, "type": "object", "required": [ "nodeId", "nodeType", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceAddressObject:getInstanceAddressObject": { "properties": { "dnsVisibility": { "type": "boolean", "description": "false: private network resolution (default). true: private and public network resolution.\n" }, "domain": { "type": "string", "description": "Connection domain name\n" }, "eipId": { "type": "string", "description": "EIP ID, valid only for Public addresses.\n" }, "internetProtocol": { "type": "string", "description": "IP protocol version. Value: IPv4.\n" }, "ipAddress": { "type": "string", "description": "IP address.\n" }, "networkType": { "type": "string", "description": "Network address type. Values: Private: private address. Public: public address\n" }, "port": { "type": "string", "description": "Port\n" }, "subnetId": { "type": "string", "description": "Subnet ID, valid only for Private addresses\n" } }, "type": "object", "required": [ "dnsVisibility", "domain", "eipId", "internetProtocol", "ipAddress", "networkType", "port", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceAutoStorageScalingConfig:getInstanceAutoStorageScalingConfig": { "properties": { "enableStorageAutoScale": { "type": "boolean", "description": "Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.\n" }, "storageThreshold": { "type": "integer", "description": "Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %\n" }, "storageUpperBound": { "type": "integer", "description": "Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.\n" } }, "type": "object", "required": [ "enableStorageAutoScale", "storageThreshold", "storageUpperBound" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceChargeDetail:getInstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew\n" }, "chargeEndTime": { "type": "string", "description": "Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.\n" }, "chargeStartTime": { "type": "string", "description": "Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.\n" }, "chargeType": { "type": "string", "description": "Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go\n" }, "number": { "type": "integer", "description": "Number of instances to purchase. Value range: 1–50. Default: 1\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ\n" }, "overdueTime": { "type": "string", "description": "Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.\n" }, "period": { "type": "integer", "description": "Purchase duration in prepaid scenarios.\n" }, "periodUnit": { "type": "string", "description": "Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.\n" }, "tempModifyEndTime": { "type": "string", "description": "Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.\n" }, "tempModifyStartTime": { "type": "string", "description": "Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ\n" } }, "type": "object", "required": [ "autoRenew", "chargeEndTime", "chargeStartTime", "chargeStatus", "chargeType", "number", "overdueReclaimTime", "overdueTime", "period", "periodUnit", "tempModifyEndTime", "tempModifyStartTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceDisasterRecoveryInstance:getInstanceDisasterRecoveryInstance": { "properties": { "dtsTaskId": { "type": "string", "description": "ID of synchronization tasks between primary and disaster recovery instances.\n" }, "dtsTaskName": { "type": "string", "description": "Name of the synchronization task between the primary instance and the disaster recovery instance\n" }, "dtsTaskStatus": { "type": "string", "description": "Status of synchronization tasks between the primary instance and the disaster recovery instance\n" }, "instanceId": { "type": "string", "description": "Disaster recovery instance ID.\n" }, "instanceName": { "type": "string", "description": "Name of disaster recovery instance.\n" }, "secondsBehindMaster": { "type": "integer", "description": "Latency between the disaster recovery instance and the primary instance.\n" } }, "type": "object", "required": [ "dtsTaskId", "dtsTaskName", "dtsTaskStatus", "instanceId", "instanceName", "secondsBehindMaster" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceEndpoint:getInstanceEndpoint": { "properties": { "autoAddNewNodes": { "type": "string", "description": "When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)\n" }, "connectionInfoTags": { "type": "array", "items": { "type": "string" }, "description": "Connection endpoint tag.\n" }, "connectionMode": { "type": "string", "description": "Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint\n" }, "connectionPoolType": { "type": "string", "description": "Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.\n" }, "description": { "type": "string", "description": "Description of the connection endpoint\n" }, "enableConnectionPersistent": { "type": "boolean", "description": "Enable connection keep-alive. Options: true: yes. false: no\n" }, "enableReadOnly": { "type": "string", "description": "Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.\n" }, "enableReadWriteSplitting": { "type": "string", "description": "Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.\n" }, "endpointId": { "type": "string", "description": "Instance connection endpoint ID.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Endpoint type. Value: Custom, custom endpoint.\n" }, "idleConnectionReclaim": { "type": "boolean", "description": "Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.\n" }, "implicitTransSplit": { "type": "boolean", "description": "Whether to enable transaction separation. Values: true: Yes. false: No.\n" }, "masterNodeRouting": { "type": "boolean", "description": "Whether to enable primary node routing. Values: true: Yes. false: No.\n" }, "masterProtectorTimeout": { "type": "integer", "description": "Overload protection timeout. Value range: integer between 60 and 7200, in seconds.\n" }, "multiStatementsMode": { "type": "string", "description": "Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode\n" }, "overloadProtection": { "type": "boolean", "description": "Overload protection enabled. Values: true: yes. false: no\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.\n" }, "readOnlyNodeMaxDelayTime": { "type": "integer", "description": "Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceEndpointReadOnlyNodeWeight:getInstanceEndpointReadOnlyNodeWeight" }, "description": "List of nodes configured for the connection endpoint and their corresponding read-only weights.\n" }, "readWriteMode": { "type": "string", "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only\n" } }, "type": "object", "required": [ "autoAddNewNodes", "connectionInfoTags", "connectionMode", "connectionPoolType", "description", "enableConnectionPersistent", "enableReadOnly", "enableReadWriteSplitting", "endpointId", "endpointName", "endpointType", "idleConnectionReclaim", "implicitTransSplit", "masterNodeRouting", "masterProtectorTimeout", "multiStatementsMode", "overloadProtection", "readOnlyNodeDistributionType", "readOnlyNodeMaxDelayTime", "readOnlyNodeWeights", "readWriteMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceEndpointReadOnlyNodeWeight:getInstanceEndpointReadOnlyNodeWeight": { "properties": { "nodeId": { "type": "string", "description": "Read-only nodes require NodeId. Primary nodes do not require it\n" }, "nodeType": { "type": "string", "description": "Node type. Primary: primary node. ReadOnly: read-only node\n" }, "weight": { "type": "integer", "description": "Node read weight, increments of 100, maximum value is 10000.\n" } }, "type": "object", "required": [ "nodeId", "nodeType", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceMaintenanceWindow:getInstanceMaintenanceWindow": { "properties": { "dayKind": { "type": "string", "description": "Maintenance cycle granularity. Value: Week.\n" }, "dayOfWeeks": { "type": "array", "items": { "type": "string" }, "description": "Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.\n" } }, "type": "object", "required": [ "dayKind", "dayOfWeeks", "maintenanceTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceNode:getInstanceNode": { "properties": { "createTime": { "type": "string", "description": "Node creation time (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.\n" }, "delayReplicationTime": { "type": "integer", "description": "Replication delay time for read-only nodes. Value range: 0–604800, unit: seconds\n" }, "memory": { "type": "integer", "description": "Memory size, in GB.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeStatus": { "type": "string", "description": "Node status. Values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Restoring: restoring. Updating: updating. Upgrading: upgrading. Error: error\n" }, "nodeType": { "type": "string", "description": "Node type. Values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node.\n" }, "syncDelay": { "type": "integer", "description": "Latency between node and primary node, in milliseconds (ms).\n" }, "updateTime": { "type": "string", "description": "Node updates local time.\n" }, "vcpu": { "type": "integer", "description": "Number of CPU cores for the node\n" }, "zoneId": { "type": "string", "description": "Availability zone ID\n" } }, "type": "object", "required": [ "createTime", "delayReplicationTime", "memory", "nodeId", "nodeSpec", "nodeStatus", "nodeType", "syncDelay", "updateTime", "vcpu", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceProxyDetail:getInstanceProxyDetail": { "properties": { "dbProxyStatus": { "type": "string", "description": "Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling\n" }, "proxyResourceInfo": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceProxyDetailProxyResourceInfo:getInstanceProxyDetailProxyResourceInfo", "description": "Resource information for the instance's database proxy service\n" } }, "type": "object", "required": [ "dbProxyStatus", "proxyResourceInfo" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceProxyDetailProxyResourceInfo:getInstanceProxyDetailProxyResourceInfo": { "properties": { "currentProxyCpuNum": { "type": "integer", "description": "Current number of cores for the instance database proxy service\n" }, "maxProxyCpuNum": { "type": "integer", "description": "Maximum number of cores configurable for database proxy service.\n" }, "minProxyCpuNum": { "type": "integer", "description": "Minimum number of CPU cores configurable for the database proxy service\n" } }, "type": "object", "required": [ "currentProxyCpuNum", "maxProxyCpuNum", "minProxyCpuNum" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdsmysql/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/AllowListAssociatedInstance:AllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "vpc": { "type": "string", "description": "VPC ID to which the instance belongs.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId", "instanceName", "vpc" ] } } }, "volcenginecc:rdspostgresql/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo": { "properties": { "bindMode": { "type": "string", "description": "Mode for associating security groups. Values: IngressDirectionIp: inbound IP. AssociateEcsIp: associate ECS IP.\n" }, "ipLists": { "type": "array", "items": { "type": "string" }, "description": "IP address list in the security group.\n" }, "securityGroupId": { "type": "string", "description": "Security group ID.\n" }, "securityGroupName": { "type": "string", "description": "Security group name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bindMode", "ipLists", "securityGroupId", "securityGroupName" ] } } }, "volcenginecc:rdspostgresql/DbEndpointAddress:DbEndpointAddress": { "properties": { "dnsVisibility": { "type": "boolean", "description": "Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.\n" }, "domainPrefix": { "type": "string", "description": "New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.\n" }, "port": { "type": "string", "description": "Port number.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsVisibility", "domainPrefix", "port" ] } } }, "volcenginecc:rdspostgresql/DbEndpointReadOnlyNodeWeight:DbEndpointReadOnlyNodeWeight": { "properties": { "nodeId": { "type": "string", "description": "Read-only nodes require the NodeId to be provided.\n" }, "nodeType": { "type": "string", "description": "Node type. Values: Primary: primary node. ReadOnly: read-only node.\n" }, "weight": { "type": "integer", "description": "Read weight of the node, increases in increments of 100, maximum value is 40000. Note: Weights cannot all be set to 0.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodeId", "nodeType", "weight" ] } } }, "volcenginecc:rdspostgresql/InstanceChargeDetail:InstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Enable auto-renewal for prepaid scenarios\n" }, "chargeEndTime": { "type": "string", "description": "Billing expiration time for yearly/monthly instances\n" }, "chargeStartTime": { "type": "string", "description": "Instance billing start time\n" }, "chargeStatus": { "type": "string", "description": "Payment status. Value: - `Normal`: Normal - `Overdue`: Overdue and suspended - `Unpaid`: Unpaid\n" }, "chargeType": { "type": "string", "description": "Payment type. Value: - `PostPaid`: Postpaid - `PrePaid`: Prepaid\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after instance suspension due to overdue payment\n" }, "overdueTime": { "type": "string", "description": "Instance shutdown time due to overdue payment\n" }, "period": { "type": "number", "description": "Purchase duration for prepaid scenarios\n" }, "periodUnit": { "type": "string", "description": "Purchase period for prepaid scenarios. Values: - `Month`: month - `Year`: year\n" }, "tempModifyEndTime": { "type": "string", "description": "Rollback time for temporary upgrade\n" }, "tempModifyStartTime": { "type": "string", "description": "Start time of temporary scaling\n" } }, "type": "object", "required": [ "chargeType" ], "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "chargeEndTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit", "tempModifyEndTime", "tempModifyStartTime" ] } } }, "volcenginecc:rdspostgresql/InstanceEndpoint:InstanceEndpoint": { "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceEndpointAddress:InstanceEndpointAddress" } }, "autoAddNewNodes": { "type": "string", "description": "When the terminal type is read-write or read-only, you can set whether new nodes join automatically. Values: - `Enable`: join automatically - `Disable`: do not join automatically (default)\n" }, "description": { "type": "string", "description": "Address description.\n" }, "enableReadOnly": { "type": "string", "description": "Enable global read-only mode. - `Enable`: enabled - `Disable`: not enabled\n" }, "enableReadWriteSplitting": { "type": "string", "description": "Enable read-write separation. Values: - `Enable`: enabled - `Disable`: not enabled\n" }, "endpointId": { "type": "string", "description": "Instance connection terminal ID\n" }, "endpointName": { "type": "string", "description": "Instance connection terminal name\n" }, "endpointType": { "type": "string", "description": "Endpoint type: - `Cluster`: Default endpoint (created by default) - `Custom`: Custom endpoint\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read-only weight allocation mode. Options: - `Default`: Standard weight allocation (default). - `Custom`: Custom weight allocation\n" }, "readOnlyNodeMaxDelayTime": { "type": "number", "description": "Maximum latency threshold for read-only nodes. If a read-only node's latency exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30.\n**Note:** This parameter can be set for the default endpoint when read/write splitting is enabled.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceEndpointReadOnlyNodeWeight:InstanceEndpointReadOnlyNodeWeight" } }, "readWriteMode": { "type": "string", "description": "Read/write mode: - `ReadWrite`: Read/write - `ReadOnly`: Read-only\n" }, "readWriteProxyConnection": { "type": "number", "description": "After read/write splitting is enabled for the terminal, set the number of proxy connections for the terminal. - The minimum value for proxy connections is 20. - The maximum value depends on the specification of the instance's primary node. Different specifications support different maximum proxy connections. For details, see [Product Specifications]\n" }, "writeNodeHaltWriting": { "type": "boolean", "description": "Whether the endpoint sends write requests to the write node (currently, only the primary node is the write node). Value: - `true`: Yes. (Default) - `false`: No\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "addresses", "autoAddNewNodes", "description", "enableReadOnly", "enableReadWriteSplitting", "endpointId", "endpointName", "endpointType", "readOnlyNodeDistributionType", "readOnlyNodeMaxDelayTime", "readOnlyNodeWeights", "readWriteMode", "readWriteProxyConnection", "writeNodeHaltWriting" ] } } }, "volcenginecc:rdspostgresql/InstanceEndpointAddress:InstanceEndpointAddress": { "properties": { "crossRegionDomain": { "type": "string", "description": "Private network address accessible across regions\n" }, "dnsVisibility": { "type": "boolean", "description": "Enable public network resolution. Values: - false: default, private network resolution - true: private and public network resolution\n" }, "domain": { "type": "string", "description": "Connection domain name\n" }, "domainVisibilitySetting": { "type": "string", "description": "Private network address type. Values: LocalDomain: local region domain name CrossRegionDomain: cross-region accessible domain name\n" }, "eipId": { "type": "string", "description": "EIP ID, valid only for Public addresses\n" }, "ipAddress": { "type": "string", "description": "IP address\n" }, "networkType": { "type": "string", "description": "Network address type. Value: - `Private`: Private network address - `Public`: Public network address - `Inner`: Public service zone address\n" }, "port": { "type": "string", "description": "Port.\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "crossRegionDomain", "dnsVisibility", "domain", "domainVisibilitySetting", "eipId", "ipAddress", "networkType", "port", "subnetId" ] } } }, "volcenginecc:rdspostgresql/InstanceEndpointReadOnlyNodeWeight:InstanceEndpointReadOnlyNodeWeight": { "properties": { "nodeId": { "type": "string", "description": "Read-only nodes require NodeId\n" }, "nodeType": { "type": "string", "description": "Node type\n" }, "weight": { "type": "number", "description": "Node read weight, increases by 100, maximum value is 10000\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodeId", "nodeType", "weight" ] } } }, "volcenginecc:rdspostgresql/InstanceMaintenanceWindow:InstanceMaintenanceWindow": { "properties": { "dayKind": { "type": "string", "description": "Granularity of the maintenance cycle. Value: Week (week)\n" }, "dayOfWeekMaintenanceTimes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceMaintenanceWindowDayOfWeekMaintenanceTime:InstanceMaintenanceWindowDayOfWeekMaintenanceTime" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dayKind", "dayOfWeekMaintenanceTimes" ] } } }, "volcenginecc:rdspostgresql/InstanceMaintenanceWindowDayOfWeekMaintenanceTime:InstanceMaintenanceWindowDayOfWeekMaintenanceTime": { "properties": { "dayOfWeek": { "type": "string", "description": "Specify maintenance days for the instance each week. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: If not specified or left blank, all seven days are enabled by default.\n" }, "maintenanceWindowStartTime": { "type": "string", "description": "Start time of the maintenance window on the maintenance day. Format: HH:mmZ (UTC time). Currently, only start times between 16:00Z and 20:00Z are supported.\n" }, "period": { "type": "integer", "description": "Duration of the maintenance window on the maintenance day. Minimum duration is 2 hours, maximum is 6 hours.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dayOfWeek", "maintenanceWindowStartTime", "period" ] } } }, "volcenginecc:rdspostgresql/InstanceNodeInfo:InstanceNodeInfo": { "properties": { "createTime": { "type": "string", "description": "Node creation time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "memory": { "type": "number", "description": "Memory size, unit: GB\n" }, "nodeId": { "type": "string", "description": "Node ID\n" }, "nodeSpec": { "type": "string", "description": "Node specification\n" }, "nodeStatus": { "type": "string", "description": "Node status\n" }, "nodeType": { "type": "string", "description": "Node type\n" }, "regionId": { "type": "string", "description": "Region ID\n" }, "updateTime": { "type": "string", "description": "Node update time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)\n" }, "vcpu": { "type": "number", "description": "CPU size. For example: 1 means 1U\n" }, "zoneId": { "type": "string", "description": "Availability zone of the node\n" } }, "type": "object", "required": [ "nodeSpec", "nodeType", "zoneId" ], "language": { "nodejs": { "requiredOutputs": [ "createTime", "instanceId", "memory", "nodeId", "nodeSpec", "nodeStatus", "nodeType", "regionId", "updateTime", "vcpu", "zoneId" ] } } }, "volcenginecc:rdspostgresql/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:rdspostgresql/getAllowListAssociatedInstance:getAllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "vpc": { "type": "string", "description": "VPC ID to which the instance belongs.\n" } }, "type": "object", "required": [ "instanceId", "instanceName", "vpc" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getAllowListSecurityGroupBindInfo:getAllowListSecurityGroupBindInfo": { "properties": { "bindMode": { "type": "string", "description": "Mode for associating security groups. Values: IngressDirectionIp: inbound IP. AssociateEcsIp: associate ECS IP.\n" }, "ipLists": { "type": "array", "items": { "type": "string" }, "description": "IP address list in the security group.\n" }, "securityGroupId": { "type": "string", "description": "Security group ID.\n" }, "securityGroupName": { "type": "string", "description": "Security group name.\n" } }, "type": "object", "required": [ "bindMode", "ipLists", "securityGroupId", "securityGroupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getDbEndpointAddress:getDbEndpointAddress": { "properties": { "crossRegionDomain": { "type": "string", "description": "Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.\n" }, "dnsVisibility": { "type": "boolean", "description": "Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.\n" }, "domain": { "type": "string", "description": "Connection domain name\n" }, "domainPrefix": { "type": "string", "description": "New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.\n" }, "domainVisibilitySetting": { "type": "string", "description": "Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.\n" }, "eipId": { "type": "string", "description": "EIP ID, valid only for Public addresses.\n" }, "ipAddress": { "type": "string", "description": "IP address\n" }, "networkType": { "type": "string", "description": "Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.\n" }, "port": { "type": "string", "description": "Port number.\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" } }, "type": "object", "required": [ "crossRegionDomain", "dnsVisibility", "domain", "domainPrefix", "domainVisibilitySetting", "eipId", "ipAddress", "networkType", "port", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getDbEndpointReadOnlyNodeWeight:getDbEndpointReadOnlyNodeWeight": { "properties": { "nodeId": { "type": "string", "description": "Read-only nodes require the NodeId to be provided.\n" }, "nodeType": { "type": "string", "description": "Node type. Values: Primary: primary node. ReadOnly: read-only node.\n" }, "weight": { "type": "integer", "description": "Read weight of the node, increases in increments of 100, maximum value is 40000. Note: Weights cannot all be set to 0.\n" } }, "type": "object", "required": [ "nodeId", "nodeType", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getInstanceChargeDetail:getInstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Enable auto-renewal for prepaid scenarios\n" }, "chargeEndTime": { "type": "string", "description": "Billing expiration time for yearly/monthly instances\n" }, "chargeStartTime": { "type": "string", "description": "Instance billing start time\n" }, "chargeStatus": { "type": "string", "description": "Payment status. Value: - `Normal`: Normal - `Overdue`: Overdue and suspended - `Unpaid`: Unpaid\n" }, "chargeType": { "type": "string", "description": "Payment type. Value: - `PostPaid`: Postpaid - `PrePaid`: Prepaid\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after instance suspension due to overdue payment\n" }, "overdueTime": { "type": "string", "description": "Instance shutdown time due to overdue payment\n" }, "period": { "type": "number", "description": "Purchase duration for prepaid scenarios\n" }, "periodUnit": { "type": "string", "description": "Purchase period for prepaid scenarios. Values: - `Month`: month - `Year`: year\n" }, "tempModifyEndTime": { "type": "string", "description": "Rollback time for temporary upgrade\n" }, "tempModifyStartTime": { "type": "string", "description": "Start time of temporary scaling\n" } }, "type": "object", "required": [ "autoRenew", "chargeEndTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit", "tempModifyEndTime", "tempModifyStartTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getInstanceEndpoint:getInstanceEndpoint": { "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getInstanceEndpointAddress:getInstanceEndpointAddress" }, "description": "Address list.\n" }, "autoAddNewNodes": { "type": "string", "description": "When the terminal type is read-write or read-only, you can set whether new nodes join automatically. Values: - `Enable`: join automatically - `Disable`: do not join automatically (default)\n" }, "description": { "type": "string", "description": "Address description.\n" }, "enableReadOnly": { "type": "string", "description": "Enable global read-only mode. - `Enable`: enabled - `Disable`: not enabled\n" }, "enableReadWriteSplitting": { "type": "string", "description": "Enable read-write separation. Values: - `Enable`: enabled - `Disable`: not enabled\n" }, "endpointId": { "type": "string", "description": "Instance connection terminal ID\n" }, "endpointName": { "type": "string", "description": "Instance connection terminal name\n" }, "endpointType": { "type": "string", "description": "Endpoint type: - `Cluster`: Default endpoint (created by default) - `Custom`: Custom endpoint\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read-only weight allocation mode. Options: - `Default`: Standard weight allocation (default). - `Custom`: Custom weight allocation\n" }, "readOnlyNodeMaxDelayTime": { "type": "number", "description": "Maximum latency threshold for read-only nodes. If a read-only node's latency exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30.\n**Note:** This parameter can be set for the default endpoint when read/write splitting is enabled.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getInstanceEndpointReadOnlyNodeWeight:getInstanceEndpointReadOnlyNodeWeight" }, "description": "List of nodes configured for the endpoint and their corresponding read-only weights.\n" }, "readWriteMode": { "type": "string", "description": "Read/write mode: - `ReadWrite`: Read/write - `ReadOnly`: Read-only\n" }, "readWriteProxyConnection": { "type": "number", "description": "After read/write splitting is enabled for the terminal, set the number of proxy connections for the terminal. - The minimum value for proxy connections is 20. - The maximum value depends on the specification of the instance's primary node. Different specifications support different maximum proxy connections. For details, see [Product Specifications]\n" }, "writeNodeHaltWriting": { "type": "boolean", "description": "Whether the endpoint sends write requests to the write node (currently, only the primary node is the write node). Value: - `true`: Yes. (Default) - `false`: No\n" } }, "type": "object", "required": [ "addresses", "autoAddNewNodes", "description", "enableReadOnly", "enableReadWriteSplitting", "endpointId", "endpointName", "endpointType", "readOnlyNodeDistributionType", "readOnlyNodeMaxDelayTime", "readOnlyNodeWeights", "readWriteMode", "readWriteProxyConnection", "writeNodeHaltWriting" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getInstanceEndpointAddress:getInstanceEndpointAddress": { "properties": { "crossRegionDomain": { "type": "string", "description": "Private network address accessible across regions\n" }, "dnsVisibility": { "type": "boolean", "description": "Enable public network resolution. Values: - false: default, private network resolution - true: private and public network resolution\n" }, "domain": { "type": "string", "description": "Connection domain name\n" }, "domainVisibilitySetting": { "type": "string", "description": "Private network address type. Values: LocalDomain: local region domain name CrossRegionDomain: cross-region accessible domain name\n" }, "eipId": { "type": "string", "description": "EIP ID, valid only for Public addresses\n" }, "ipAddress": { "type": "string", "description": "IP address\n" }, "networkType": { "type": "string", "description": "Network address type. Value: - `Private`: Private network address - `Public`: Public network address - `Inner`: Public service zone address\n" }, "port": { "type": "string", "description": "Port.\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" } }, "type": "object", "required": [ "crossRegionDomain", "dnsVisibility", "domain", "domainVisibilitySetting", "eipId", "ipAddress", "networkType", "port", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getInstanceEndpointReadOnlyNodeWeight:getInstanceEndpointReadOnlyNodeWeight": { "properties": { "nodeId": { "type": "string", "description": "Read-only nodes require NodeId\n" }, "nodeType": { "type": "string", "description": "Node type\n" }, "weight": { "type": "number", "description": "Node read weight, increases by 100, maximum value is 10000\n" } }, "type": "object", "required": [ "nodeId", "nodeType", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getInstanceMaintenanceWindow:getInstanceMaintenanceWindow": { "properties": { "dayKind": { "type": "string", "description": "Granularity of the maintenance cycle. Value: Week (week)\n" }, "dayOfWeekMaintenanceTimes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getInstanceMaintenanceWindowDayOfWeekMaintenanceTime:getInstanceMaintenanceWindowDayOfWeekMaintenanceTime" }, "description": "Detailed information about the instance's maintenance window.\n" } }, "type": "object", "required": [ "dayKind", "dayOfWeekMaintenanceTimes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getInstanceMaintenanceWindowDayOfWeekMaintenanceTime:getInstanceMaintenanceWindowDayOfWeekMaintenanceTime": { "properties": { "dayOfWeek": { "type": "string", "description": "Specify maintenance days for the instance each week. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. Note: If not specified or left blank, all seven days are enabled by default.\n" }, "maintenanceWindowStartTime": { "type": "string", "description": "Start time of the maintenance window on the maintenance day. Format: HH:mmZ (UTC time). Currently, only start times between 16:00Z and 20:00Z are supported.\n" }, "period": { "type": "integer", "description": "Duration of the maintenance window on the maintenance day. Minimum duration is 2 hours, maximum is 6 hours.\n" } }, "type": "object", "required": [ "dayOfWeek", "maintenanceWindowStartTime", "period" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getInstanceNodeInfo:getInstanceNodeInfo": { "properties": { "createTime": { "type": "string", "description": "Node creation time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "memory": { "type": "number", "description": "Memory size, unit: GB\n" }, "nodeId": { "type": "string", "description": "Node ID\n" }, "nodeSpec": { "type": "string", "description": "Node specification\n" }, "nodeStatus": { "type": "string", "description": "Node status\n" }, "nodeType": { "type": "string", "description": "Node type\n" }, "regionId": { "type": "string", "description": "Region ID\n" }, "updateTime": { "type": "string", "description": "Node update time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time)\n" }, "vcpu": { "type": "number", "description": "CPU size. For example: 1 means 1U\n" }, "zoneId": { "type": "string", "description": "Availability zone of the node\n" } }, "type": "object", "required": [ "createTime", "instanceId", "memory", "nodeId", "nodeSpec", "nodeStatus", "nodeType", "regionId", "updateTime", "vcpu", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rdspostgresql/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:redis/AllowListAssociatedInstance:AllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID bound to the current allowlist\n" }, "instanceName": { "type": "string", "description": "Instance names bound to the current allowlist\n" }, "projectName": { "type": "string", "description": "Project name associated with the instance\n" }, "vpc": { "type": "string", "description": "Private network ID associated with the instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId", "instanceName", "projectName", "vpc" ] } } }, "volcenginecc:redis/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo": { "properties": { "bindMode": { "type": "string", "description": "Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported\n" }, "securityGroupId": { "type": "string", "description": "Associated security group ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bindMode", "securityGroupId" ] } } }, "volcenginecc:redis/InstanceCapacity:InstanceCapacity": { "properties": { "total": { "type": "integer", "description": "Total memory capacity of the current instance. Unit: MiB.\n" }, "used": { "type": "integer", "description": "Used capacity of the current instance. Unit: MiB.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "total", "used" ] } } }, "volcenginecc:redis/InstanceConfigureNode:InstanceConfigureNode": { "properties": { "az": { "type": "string", "description": "The availability zone each node belongs to.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "az" ] } } }, "volcenginecc:redis/InstanceInstanceShard:InstanceInstanceShard": { "properties": { "nodeNumber": { "type": "integer", "description": "Number of nodes in each shard\n" }, "serverNodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceInstanceShardServerNode:InstanceInstanceShardServerNode" } }, "shardId": { "type": "string", "description": "Shard ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nodeNumber", "serverNodes", "shardId" ] } } }, "volcenginecc:redis/InstanceInstanceShardServerNode:InstanceInstanceShardServerNode": { "properties": { "currentRole": { "type": "string", "description": "Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "status": { "type": "string", "description": "Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.\n" }, "zoneId": { "type": "string", "description": "Availability zone where the node is located.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "currentRole", "nodeId", "status", "zoneId" ] } } }, "volcenginecc:redis/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:redis/InstanceVisitAddr:InstanceVisitAddr": { "properties": { "addrType": { "type": "string", "description": "Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.\n" }, "address": { "type": "string", "description": "IP address or domain name.\n" }, "eipId": { "type": "string", "description": "EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.\n" }, "port": { "type": "string", "description": "Port number.\n" }, "viPv6": { "type": "string", "description": "IPv6 address corresponding to the connection address.\n" }, "vip": { "type": "string", "description": "The IPv4 address corresponding to the connection address.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "addrType", "address", "eipId", "port", "viPv6", "vip" ] } } }, "volcenginecc:redis/getAllowListAssociatedInstance:getAllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID bound to the current allowlist\n" }, "instanceName": { "type": "string", "description": "Instance names bound to the current allowlist\n" }, "projectName": { "type": "string", "description": "Project name associated with the instance\n" }, "vpc": { "type": "string", "description": "Private network ID associated with the instance\n" } }, "type": "object", "required": [ "instanceId", "instanceName", "projectName", "vpc" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:redis/getAllowListSecurityGroupBindInfo:getAllowListSecurityGroupBindInfo": { "properties": { "bindMode": { "type": "string", "description": "Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported\n" }, "ipLists": { "type": "array", "items": { "type": "string" }, "description": "IP list of security groups associated with the allowlist\n" }, "securityGroupId": { "type": "string", "description": "Associated security group ID\n" }, "securityGroupName": { "type": "string", "description": "Name of the associated security group\n" } }, "type": "object", "required": [ "bindMode", "ipLists", "securityGroupId", "securityGroupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:redis/getInstanceCapacity:getInstanceCapacity": { "properties": { "total": { "type": "integer", "description": "Total memory capacity of the current instance. Unit: MiB.\n" }, "used": { "type": "integer", "description": "Used capacity of the current instance. Unit: MiB.\n" } }, "type": "object", "required": [ "total", "used" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:redis/getInstanceConfigureNode:getInstanceConfigureNode": { "properties": { "az": { "type": "string", "description": "The availability zone each node belongs to.\n" } }, "type": "object", "required": [ "az" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:redis/getInstanceInstanceShard:getInstanceInstanceShard": { "properties": { "nodeNumber": { "type": "integer", "description": "Number of nodes in each shard\n" }, "serverNodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/getInstanceInstanceShardServerNode:getInstanceInstanceShardServerNode" }, "description": "Detailed list of all Server nodes in the shard.\n" }, "shardId": { "type": "string", "description": "Shard ID.\n" } }, "type": "object", "required": [ "nodeNumber", "serverNodes", "shardId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:redis/getInstanceInstanceShardServerNode:getInstanceInstanceShardServerNode": { "properties": { "currentRole": { "type": "string", "description": "Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "status": { "type": "string", "description": "Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.\n" }, "zoneId": { "type": "string", "description": "Availability zone where the node is located.\n" } }, "type": "object", "required": [ "currentRole", "nodeId", "status", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:redis/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:redis/getInstanceVisitAddr:getInstanceVisitAddr": { "properties": { "addrType": { "type": "string", "description": "Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.\n" }, "address": { "type": "string", "description": "IP address or domain name.\n" }, "eipId": { "type": "string", "description": "EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.\n" }, "port": { "type": "string", "description": "Port number.\n" }, "viPv6": { "type": "string", "description": "IPv6 address corresponding to the connection address.\n" }, "vip": { "type": "string", "description": "The IPv4 address corresponding to the connection address.\n" } }, "type": "object", "required": [ "addrType", "address", "eipId", "port", "viPv6", "vip" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/AllowListAssociatedInstance:AllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance Name\n" }, "vpc": { "type": "string", "description": "VPC ID of the instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId", "instanceName", "vpc" ] } } }, "volcenginecc:rocketmq/GroupConsumedClient:GroupConsumedClient": { "properties": { "clientAddress": { "type": "string", "description": "Address and port of this consumer instance.\n" }, "clientId": { "type": "string", "description": "ID of this consumer instance.\n" }, "diff": { "type": "integer", "description": "Message backlog.\n" }, "language": { "type": "string", "description": "Development language of the consumer application.\n" }, "version": { "type": "string", "description": "Consumer version.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "clientAddress", "clientId", "diff", "language", "version" ] } } }, "volcenginecc:rocketmq/GroupConsumedTopic:GroupConsumedTopic": { "properties": { "queueNum": { "type": "integer", "description": "Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.\n" }, "subString": { "type": "string", "description": "Subscription rules.\n" }, "topicName": { "type": "string", "description": "Name of the Topic subscribed by the client.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "queueNum", "subString", "topicName" ] } } }, "volcenginecc:rocketmq/InstanceChargeDetail:InstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.\n" }, "chargeExpireTime": { "type": "string", "description": "Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.\n" }, "chargeStartTime": { "type": "string", "description": "Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired\n" }, "chargeType": { "type": "string", "description": "Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "overdueTime": { "type": "string", "description": "Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "period": { "type": "integer", "description": "Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.\n" }, "periodUnit": { "type": "string", "description": "Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "chargeExpireTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ] } } }, "volcenginecc:rocketmq/InstanceConnectionInfo:InstanceConnectionInfo": { "properties": { "endpointAddressIp": { "type": "string", "description": "Instance endpoint IP address.\n" }, "endpointType": { "type": "string", "description": "Instance access point type.\n" }, "internalEndpoint": { "type": "string", "description": "Private network endpoint address for the instance.\n" }, "networkType": { "type": "string", "description": "Instance access point type.\n" }, "publicEndpoint": { "type": "string", "description": "Public access point address of the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "endpointAddressIp", "endpointType", "internalEndpoint", "networkType", "publicEndpoint" ] } } }, "volcenginecc:rocketmq/InstanceProductInfo:InstanceProductInfo": { "properties": { "sendReceiveRatio": { "type": "integer", "description": "Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "sendReceiveRatio" ] } } }, "volcenginecc:rocketmq/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:rocketmq/TopicAccessPolicy:TopicAccessPolicy": { "properties": { "accessKey": { "type": "string", "description": "AccessKey of the RocketMQ key.\n" }, "authority": { "type": "string", "description": "User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessKey", "authority" ] } } }, "volcenginecc:rocketmq/TopicGroupsInfo:TopicGroupsInfo": { "properties": { "groupId": { "type": "string", "description": "Group ID of the consumer group.\n" }, "messageModel": { "type": "string", "description": "Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.\n" }, "subString": { "type": "string", "description": "Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "groupId", "messageModel", "subString" ] } } }, "volcenginecc:rocketmq/TopicQueuesInfo:TopicQueuesInfo": { "properties": { "endOffset": { "type": "integer", "description": "The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.\n" }, "lastUpdateTimestamp": { "type": "integer", "description": "The time of the most recent message written to this queue.\n" }, "messageCount": { "type": "integer", "description": "The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.\n" }, "queueId": { "type": "string", "description": "Queue ID.\n" }, "startOffset": { "type": "integer", "description": "The earliest message offset in the current queue.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "endOffset", "lastUpdateTimestamp", "messageCount", "queueId", "startOffset" ] } } }, "volcenginecc:rocketmq/TopicReadAccessPolicy:TopicReadAccessPolicy": { "properties": { "accessKey": { "type": "string", "description": "AccessKey of the RocketMQ key.\n" }, "authority": { "type": "string", "description": "User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessKey", "authority" ] } } }, "volcenginecc:rocketmq/getAllowListAssociatedInstance:getAllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance Name\n" }, "vpc": { "type": "string", "description": "VPC ID of the instance\n" } }, "type": "object", "required": [ "instanceId", "instanceName", "vpc" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getGroupConsumedClient:getGroupConsumedClient": { "properties": { "clientAddress": { "type": "string", "description": "Address and port of this consumer instance.\n" }, "clientId": { "type": "string", "description": "ID of this consumer instance.\n" }, "diff": { "type": "integer", "description": "Message backlog.\n" }, "language": { "type": "string", "description": "Development language of the consumer application.\n" }, "version": { "type": "string", "description": "Consumer version.\n" } }, "type": "object", "required": [ "clientAddress", "clientId", "diff", "language", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getGroupConsumedTopic:getGroupConsumedTopic": { "properties": { "queueNum": { "type": "integer", "description": "Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.\n" }, "subString": { "type": "string", "description": "Subscription rules.\n" }, "topicName": { "type": "string", "description": "Name of the Topic subscribed by the client.\n" } }, "type": "object", "required": [ "queueNum", "subString", "topicName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getInstanceChargeDetail:getInstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.\n" }, "chargeExpireTime": { "type": "string", "description": "Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.\n" }, "chargeStartTime": { "type": "string", "description": "Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired\n" }, "chargeType": { "type": "string", "description": "Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "overdueTime": { "type": "string", "description": "Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "period": { "type": "integer", "description": "Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.\n" }, "periodUnit": { "type": "string", "description": "Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription\n" } }, "type": "object", "required": [ "autoRenew", "chargeExpireTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getInstanceConnectionInfo:getInstanceConnectionInfo": { "properties": { "endpointAddressIp": { "type": "string", "description": "Instance endpoint IP address.\n" }, "endpointType": { "type": "string", "description": "Instance access point type.\n" }, "internalEndpoint": { "type": "string", "description": "Private network endpoint address for the instance.\n" }, "networkType": { "type": "string", "description": "Instance access point type.\n" }, "publicEndpoint": { "type": "string", "description": "Public access point address of the instance.\n" } }, "type": "object", "required": [ "endpointAddressIp", "endpointType", "internalEndpoint", "networkType", "publicEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getInstanceProductInfo:getInstanceProductInfo": { "properties": { "sendReceiveRatio": { "type": "integer", "description": "Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.\n" } }, "type": "object", "required": [ "sendReceiveRatio" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getTopicAccessPolicy:getTopicAccessPolicy": { "properties": { "accessKey": { "type": "string", "description": "AccessKey of the RocketMQ key.\n" }, "authority": { "type": "string", "description": "User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.\n" } }, "type": "object", "required": [ "accessKey", "authority" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getTopicGroupsInfo:getTopicGroupsInfo": { "properties": { "groupId": { "type": "string", "description": "Group ID of the consumer group.\n" }, "messageModel": { "type": "string", "description": "Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.\n" }, "subString": { "type": "string", "description": "Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.\n" } }, "type": "object", "required": [ "groupId", "messageModel", "subString" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getTopicQueuesInfo:getTopicQueuesInfo": { "properties": { "endOffset": { "type": "integer", "description": "The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.\n" }, "lastUpdateTimestamp": { "type": "integer", "description": "The time of the most recent message written to this queue.\n" }, "messageCount": { "type": "integer", "description": "The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.\n" }, "queueId": { "type": "string", "description": "Queue ID.\n" }, "startOffset": { "type": "integer", "description": "The earliest message offset in the current queue.\n" } }, "type": "object", "required": [ "endOffset", "lastUpdateTimestamp", "messageCount", "queueId", "startOffset" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:rocketmq/getTopicReadAccessPolicy:getTopicReadAccessPolicy": { "properties": { "accessKey": { "type": "string", "description": "AccessKey of the RocketMQ key.\n" }, "authority": { "type": "string", "description": "User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.\n" } }, "type": "object", "required": [ "accessKey", "authority" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:storageebs/SnapshotGroupSnapshot:SnapshotGroupSnapshot": { "properties": { "creationTime": { "type": "string", "description": "Snapshot creation time\n" }, "description": { "type": "string", "description": "Snapshot description\n" }, "imageId": { "type": "string", "description": "Image ID\n" }, "instantAccess": { "type": "boolean", "description": "Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled\n" }, "progress": { "type": "integer", "description": "Dump progress\n" }, "projectName": { "type": "string", "description": "Project of the snapshot\n" }, "retentionDays": { "type": "integer", "description": "Retention days for automatic snapshots\n" }, "shared": { "type": "boolean", "description": "Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others\n" }, "snapshotGroupId": { "type": "string", "description": "Snapshot consistency group ID\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID\n" }, "snapshotName": { "type": "string", "description": "Snapshot name\n" }, "snapshotType": { "type": "string", "description": "Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot\n" }, "status": { "type": "string", "description": "Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/SnapshotGroupSnapshotTag:SnapshotGroupSnapshotTag" } }, "volumeId": { "type": "string", "description": "Cloud disk ID\n" }, "volumeKind": { "type": "string", "description": "Cloud disk category. Values are as follows: - system: System disk - data: Data disk\n" }, "volumeName": { "type": "string", "description": "Cloud disk name\n" }, "volumeSize": { "type": "integer", "description": "Cloud disk size (GiB)\n" }, "volumeStatus": { "type": "string", "description": "Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. Values are as follows: - ESSD*PL0: Ultra-fast SSD cloud disk, PL0 specification - ESSD*FlexPL: Ultra-fast SSD cloud disk, FlexPL specification - TSSD_TL0: Throughput SSD cloud disk\n" }, "zoneId": { "type": "string", "description": "Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "creationTime", "description", "imageId", "instantAccess", "progress", "projectName", "retentionDays", "shared", "snapshotGroupId", "snapshotId", "snapshotName", "snapshotType", "status", "tags", "volumeId", "volumeKind", "volumeName", "volumeSize", "volumeStatus", "volumeType", "zoneId" ] } } }, "volcenginecc:storageebs/SnapshotGroupSnapshotTag:SnapshotGroupSnapshotTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:storageebs/SnapshotGroupTag:SnapshotGroupTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:storageebs/SnapshotTag:SnapshotTag": { "properties": { "key": { "type": "string", "description": "User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.\n" }, "value": { "type": "string", "description": "User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:storageebs/VolumeBaselinePerformance:VolumeBaselinePerformance": { "properties": { "iops": { "type": "number", "description": "Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.\n" }, "throughput": { "type": "number", "description": "The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "iops", "throughput" ] } } }, "volcenginecc:storageebs/VolumeExtraPerformance:VolumeExtraPerformance": { "properties": { "extraPerformanceTypeId": { "type": "string", "description": "Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.\n" }, "iops": { "type": "number", "description": "Extra IOPS of the disk.\n" }, "throughput": { "type": "number", "description": "Extra throughput of the disk.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "extraPerformanceTypeId", "iops", "throughput" ] } } }, "volcenginecc:storageebs/VolumeTag:VolumeTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:storageebs/VolumeTotalPerformance:VolumeTotalPerformance": { "properties": { "iops": { "type": "number", "description": "Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.\n" }, "throughput": { "type": "number", "description": "The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "iops", "throughput" ] } } }, "volcenginecc:storageebs/getSnapshotGroupSnapshot:getSnapshotGroupSnapshot": { "properties": { "creationTime": { "type": "string", "description": "Snapshot creation time\n" }, "description": { "type": "string", "description": "Snapshot description\n" }, "imageId": { "type": "string", "description": "Image ID\n" }, "instantAccess": { "type": "boolean", "description": "Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled\n" }, "progress": { "type": "integer", "description": "Dump progress\n" }, "projectName": { "type": "string", "description": "Project of the snapshot\n" }, "retentionDays": { "type": "integer", "description": "Retention days for automatic snapshots\n" }, "shared": { "type": "boolean", "description": "Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others\n" }, "snapshotGroupId": { "type": "string", "description": "Snapshot consistency group ID\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID\n" }, "snapshotName": { "type": "string", "description": "Snapshot name\n" }, "snapshotType": { "type": "string", "description": "Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot\n" }, "status": { "type": "string", "description": "Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/getSnapshotGroupSnapshotTag:getSnapshotGroupSnapshotTag" }, "description": "Tag information\n" }, "volumeId": { "type": "string", "description": "Cloud disk ID\n" }, "volumeKind": { "type": "string", "description": "Cloud disk category. Values are as follows: - system: System disk - data: Data disk\n" }, "volumeName": { "type": "string", "description": "Cloud disk name\n" }, "volumeSize": { "type": "integer", "description": "Cloud disk size (GiB)\n" }, "volumeStatus": { "type": "string", "description": "Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. Values are as follows: - ESSD*PL0: Ultra-fast SSD cloud disk, PL0 specification - ESSD*FlexPL: Ultra-fast SSD cloud disk, FlexPL specification - TSSD_TL0: Throughput SSD cloud disk\n" }, "zoneId": { "type": "string", "description": "Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot\n" } }, "type": "object", "required": [ "creationTime", "description", "imageId", "instantAccess", "progress", "projectName", "retentionDays", "shared", "snapshotGroupId", "snapshotId", "snapshotName", "snapshotType", "status", "tags", "volumeId", "volumeKind", "volumeName", "volumeSize", "volumeStatus", "volumeType", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:storageebs/getSnapshotGroupSnapshotTag:getSnapshotGroupSnapshotTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:storageebs/getSnapshotGroupTag:getSnapshotGroupTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:storageebs/getSnapshotTag:getSnapshotTag": { "properties": { "key": { "type": "string", "description": "User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.\n" }, "value": { "type": "string", "description": "User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:storageebs/getVolumeBaselinePerformance:getVolumeBaselinePerformance": { "properties": { "iops": { "type": "number", "description": "Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.\n" }, "throughput": { "type": "number", "description": "The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.\n" } }, "type": "object", "required": [ "iops", "throughput" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:storageebs/getVolumeExtraPerformance:getVolumeExtraPerformance": { "properties": { "extraPerformanceTypeId": { "type": "string", "description": "Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.\n" }, "iops": { "type": "number", "description": "Extra IOPS of the disk.\n" }, "throughput": { "type": "number", "description": "Extra throughput of the disk.\n" } }, "type": "object", "required": [ "extraPerformanceTypeId", "iops", "throughput" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:storageebs/getVolumeTag:getVolumeTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:storageebs/getVolumeTotalPerformance:getVolumeTotalPerformance": { "properties": { "iops": { "type": "number", "description": "Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.\n" }, "throughput": { "type": "number", "description": "The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.\n" } }, "type": "object", "required": [ "iops", "throughput" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/AlarmNotifyGroupNoticeRule:AlarmNotifyGroupNoticeRule": { "properties": { "hasEndNode": { "type": "boolean", "description": "Whether there is an end node afterwards.\n" }, "hasNext": { "type": "boolean", "description": "Condition for whether to proceed to the next level.\n" }, "receiverInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/AlarmNotifyGroupNoticeRuleReceiverInfo:AlarmNotifyGroupNoticeRuleReceiverInfo" } }, "ruleNode": { "type": "string", "description": "Rule node. JSON format.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "hasEndNode", "hasNext", "receiverInfos", "ruleNode" ] } } }, "volcenginecc:tls/AlarmNotifyGroupNoticeRuleReceiverInfo:AlarmNotifyGroupNoticeRuleReceiverInfo": { "properties": { "alarmContentTemplateId": { "type": "string", "description": "Alarm content template ID.\n" }, "alarmWebhookAtGroups": { "type": "array", "items": { "type": "string" }, "description": "User group name to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "alarmWebhookAtUsers": { "type": "array", "items": { "type": "string" }, "description": "Username to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "alarmWebhookIntegrationId": { "type": "string", "description": "Alarm webhook integration configuration ID.\n" }, "alarmWebhookIntegrationName": { "type": "string", "description": "Name of the alarm Webhook integration configuration.\n" }, "alarmWebhookIsAtAll": { "type": "boolean", "description": "Whether to notify everyone when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "endTime": { "type": "string", "description": "End time for receiving alarm notifications. Uses 24-hour format: HH:mm:ss, with a valid range of 00:00:00–23:59:59. StartTime cannot be greater than EndTime.\n" }, "generalWebhookBody": { "type": "string", "description": "Custom WebHook request body. It is recommended to set the request body according to the callback interface requirements of the corresponding service.\n" }, "generalWebhookHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/AlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader:AlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader" } }, "generalWebhookMethod": { "type": "string", "description": "Custom callback method for the interface. Only POST or PUT is supported.\n" }, "generalWebhookUrl": { "type": "string", "description": "Custom callback URL for the interface.\n" }, "receiverChannels": { "type": "array", "items": { "type": "string" }, "description": "Notification channels. Supports one or more channels. Options: Email, Sms, Phone, GeneralWebhook, Lark, DingTalk, WeChat.\n" }, "receiverNames": { "type": "array", "items": { "type": "string" }, "description": "IAM user or user group name.\n" }, "receiverType": { "type": "string", "description": "Recipient type. Options: User: IAM user; UserGroup: IAM user group.\n" }, "startTime": { "type": "string", "description": "Alarm notification start time. Uses 24-hour format (HH:mm:ss), valid range is 00:00:00–23:59:59. StartTime cannot be later than EndTime.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "alarmContentTemplateId", "alarmWebhookAtGroups", "alarmWebhookAtUsers", "alarmWebhookIntegrationId", "alarmWebhookIntegrationName", "alarmWebhookIsAtAll", "endTime", "generalWebhookBody", "generalWebhookHeaders", "generalWebhookMethod", "generalWebhookUrl", "receiverChannels", "receiverNames", "receiverType", "startTime" ] } } }, "volcenginecc:tls/AlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader:AlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader": { "properties": { "key": { "type": "string", "description": "Custom request header key.\n" }, "value": { "type": "string", "description": "Custom request header value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tls/AlarmNotifyGroupReceiver:AlarmNotifyGroupReceiver": { "properties": { "alarmContentTemplateId": { "type": "string", "description": "Alarm content template ID.\n" }, "alarmWebhookAtGroups": { "type": "array", "items": { "type": "string" }, "description": "User group name to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "alarmWebhookAtUsers": { "type": "array", "items": { "type": "string" }, "description": "Username to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "alarmWebhookIntegrationId": { "type": "string", "description": "Alarm webhook integration configuration ID.\n" }, "alarmWebhookIntegrationName": { "type": "string", "description": "Name of the alarm Webhook integration configuration.\n" }, "alarmWebhookIsAtAll": { "type": "boolean", "description": "Whether to notify everyone when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "endTime": { "type": "string", "description": "End time for receiving alarm notifications. Uses 24-hour format: HH:mm:ss, with a valid range of 00:00:00–23:59:59. StartTime cannot be greater than EndTime.\n" }, "generalWebhookBody": { "type": "string", "description": "Custom WebHook request body. It is recommended to set the request body according to the callback interface requirements of the corresponding service.\n" }, "generalWebhookHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/AlarmNotifyGroupReceiverGeneralWebhookHeader:AlarmNotifyGroupReceiverGeneralWebhookHeader" } }, "generalWebhookMethod": { "type": "string", "description": "Custom callback method for the interface. Only POST or PUT is supported.\n" }, "generalWebhookUrl": { "type": "string", "description": "Custom callback URL for the interface.\n" }, "receiverChannels": { "type": "array", "items": { "type": "string" }, "description": "Notification channels. Supports one or more channels. Options: Email, Sms, Phone, GeneralWebhook, Lark, DingTalk, WeChat.\n" }, "receiverNames": { "type": "array", "items": { "type": "string" }, "description": "IAM user or user group name.\n" }, "receiverType": { "type": "string", "description": "Recipient type. Options: User: IAM user; UserGroup: IAM user group.\n" }, "startTime": { "type": "string", "description": "Alarm notification start time. Uses 24-hour format (HH:mm:ss), valid range is 00:00:00–23:59:59. StartTime cannot be later than EndTime.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "alarmContentTemplateId", "alarmWebhookAtGroups", "alarmWebhookAtUsers", "alarmWebhookIntegrationId", "alarmWebhookIntegrationName", "alarmWebhookIsAtAll", "endTime", "generalWebhookBody", "generalWebhookHeaders", "generalWebhookMethod", "generalWebhookUrl", "receiverChannels", "receiverNames", "receiverType", "startTime" ] } } }, "volcenginecc:tls/AlarmNotifyGroupReceiverGeneralWebhookHeader:AlarmNotifyGroupReceiverGeneralWebhookHeader": { "properties": { "key": { "type": "string", "description": "Custom request header key.\n" }, "value": { "type": "string", "description": "Custom request header value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tls/ImportTaskImportSourceInfo:ImportTaskImportSourceInfo": { "properties": { "kafkaSourceInfo": { "$ref": "#/types/volcenginecc:tls/ImportTaskImportSourceInfoKafkaSourceInfo:ImportTaskImportSourceInfoKafkaSourceInfo", "description": "Kafka data source information. When sourceType is kafka, the KafkaSourceInfo field is required\n" }, "tosSourceInfo": { "$ref": "#/types/volcenginecc:tls/ImportTaskImportSourceInfoTosSourceInfo:ImportTaskImportSourceInfoTosSourceInfo", "description": "TOS data source information. When sourceType is tos, the TosSourceInfo field is required.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "kafkaSourceInfo", "tosSourceInfo" ] } } }, "volcenginecc:tls/ImportTaskImportSourceInfoKafkaSourceInfo:ImportTaskImportSourceInfoKafkaSourceInfo": { "properties": { "encode": { "type": "string", "description": "Data encoding format. Available options: UTF-8, GBK.\n" }, "group": { "type": "string", "description": "Kafka consumer group. If not specified, the system will automatically create a Kafka consumer group.\n" }, "host": { "type": "string", "description": "The service addresses for different types of Kafka clusters vary. Details are as follows: Message Queue Kafka Edition: Use the access point of the Kafka instance. For more information, see Access Point. If the Kafka instance and the Log Service Project are in the same region, you can use private network access; otherwise, use public network access. Self-hosted Kafka clusters: Use the IP address and port number or the domain name and port number of the Kafka Broker. Only public network access is supported. Separate multiple service addresses with a comma (,).\n" }, "initialOffset": { "type": "integer", "description": "Starting position for data import. Options: 0: Earliest time, start importing from the first record in the specified Kafka Topic. 1: Latest time, start importing from the most recently generated record in the specified Kafka Topic.\n" }, "instanceId": { "type": "string", "description": "If you are using Message Queue Kafka Edition, set this to the Kafka instance ID.\n" }, "isNeedAuth": { "type": "boolean", "description": "Whether to enable authentication. If you use a public service address, it is recommended to enable authentication.\n" }, "mechanism": { "type": "string", "description": "Password authentication mechanism. Available options: PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512.\n" }, "password": { "type": "string", "description": "Kafka SASL user password for authentication.\n" }, "protocol": { "type": "string", "description": "Secure transmission protocol. Options include plaintext, sasl*ssl, ssl, and sasl*plaintext\n" }, "timeSourceDefault": { "type": "integer", "description": "Specify log time. Options: 0: Use Kafka message timestamp. 1: Use current system time.\n" }, "topic": { "type": "string", "description": "Kafka Topic name. Separate multiple Kafka Topics with commas (,).\n" }, "username": { "type": "string", "description": "Kafka SASL username for authentication.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "encode", "group", "host", "initialOffset", "instanceId", "isNeedAuth", "mechanism", "password", "protocol", "timeSourceDefault", "topic", "username" ] } } }, "volcenginecc:tls/ImportTaskImportSourceInfoTosSourceInfo:ImportTaskImportSourceInfoTosSourceInfo": { "properties": { "bucket": { "type": "string", "description": "TOS bucket name\n" }, "compressType": { "type": "string", "description": "Compression mode for data in the TOS bucket. none: No compression. snappy: Compress using snappy. gzip: Compress using gzip. lz4: Compress using lz4.\n" }, "prefix": { "type": "string", "description": "Path of the file to be imported in the TOS bucket.\n" }, "region": { "type": "string", "description": "Region where the TOS bucket is located. Cross-region data import is supported\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucket", "compressType", "prefix", "region" ] } } }, "volcenginecc:tls/ImportTaskTargetInfo:ImportTaskTargetInfo": { "properties": { "extractRule": { "$ref": "#/types/volcenginecc:tls/ImportTaskTargetInfoExtractRule:ImportTaskTargetInfoExtractRule", "description": "Log extraction rule.\n" }, "logSample": { "type": "string", "description": "Log sample. When LogType is set to multiline_log, you must configure log samples. It is recommended to provide more than two log entries as examples to ensure the regular expression matches the first line of each log. Use real samples from the production environment.\n" }, "logType": { "type": "string", "description": "Specify log parsing type during import. delimiter*log: CSV type. multiline*log: multiline full text type. minimalist*log: single line full text type. json*log: JSON type.\n" }, "region": { "type": "string", "description": "Region.\n" } }, "type": "object", "required": [ "logType", "region" ], "language": { "nodejs": { "requiredOutputs": [ "extractRule", "logSample", "logType", "region" ] } } }, "volcenginecc:tls/ImportTaskTargetInfoExtractRule:ImportTaskTargetInfoExtractRule": { "properties": { "extractRule": { "$ref": "#/types/volcenginecc:tls/ImportTaskTargetInfoExtractRuleExtractRule:ImportTaskTargetInfoExtractRuleExtractRule", "description": "Basic content of log extraction rules.\n" }, "skipLineCount": { "type": "integer", "description": "Number of skipped rows. Only valid when the log type is delimiter_log and the import type is tos.\n" }, "timeExtractRegex": { "type": "string", "description": "Time extraction regular expression, used to extract the time value from the TimeKey field and parse it as the collection time\n" }, "timeZone": { "type": "string", "description": "Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "extractRule", "skipLineCount", "timeExtractRegex", "timeZone" ] } } }, "volcenginecc:tls/ImportTaskTargetInfoExtractRuleExtractRule:ImportTaskTargetInfoExtractRuleExtractRule": { "properties": { "beginRegex": { "type": "string", "description": "Regular expression for identifying the first line of each log. The matched part is treated as the start of the log. When LogType is set to multiline_log, you must configure a log sample\n" }, "delimiter": { "type": "string", "description": "Delimiter. Only valid when LogType is delimiter_log.\n" }, "enableNanosecond": { "type": "boolean", "description": "Enable nanoseconds.\n" }, "filterKeyRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/ImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex:ImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex" } }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of log field names (Key). Valid only when LogType is delimiter_log. Supports up to 100 field names. Duplicate field names are not allowed, and all field names cannot be left blank\n" }, "logRegex": { "type": "string", "description": "Log regular expression\n" }, "logTemplate": { "$ref": "#/types/volcenginecc:tls/ImportTaskTargetInfoExtractRuleExtractRuleLogTemplate:ImportTaskTargetInfoExtractRuleExtractRuleLogTemplate", "description": "Log template.\n" }, "quote": { "type": "string", "description": "Quotation mark. Content enclosed by the quotation mark will not be separated and will be parsed as a complete field. Only valid when LogType is delimiter_log.\n" }, "timeFormat": { "type": "string", "description": "Parsing format for the time field. If you use a specified time field in the log as the log timestamp, you must fill in TimeKey and TimeFormat. TimeKey and TimeFormat must be paired. For configuration details, see time format.\n" }, "timeKey": { "type": "string", "description": "Name of the log time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must appear in pairs\n" }, "timeSample": { "type": "string", "description": "Time sample. Used to verify whether the entered time parsing format is correct\n" }, "unMatchLogKey": { "type": "string", "description": "When uploading logs that failed to parse, specify the key name for the failed logs. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together.\n" }, "unMatchUpLoadSwitch": { "type": "boolean", "description": "Whether to upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be paired. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "beginRegex", "delimiter", "enableNanosecond", "filterKeyRegexes", "keys", "logRegex", "logTemplate", "quote", "timeFormat", "timeKey", "timeSample", "unMatchLogKey", "unMatchUpLoadSwitch" ] } } }, "volcenginecc:tls/ImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex:ImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "regex": { "type": "string", "description": "Regular expression.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "regex" ] } } }, "volcenginecc:tls/ImportTaskTargetInfoExtractRuleExtractRuleLogTemplate:ImportTaskTargetInfoExtractRuleExtractRuleLogTemplate": { "properties": { "format": { "type": "string", "description": "Format.\n" }, "type": { "type": "string", "description": "Type\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "format", "type" ] } } }, "volcenginecc:tls/ImportTaskTaskStatistics:ImportTaskTaskStatistics": { "properties": { "bytesTotal": { "type": "integer", "description": "Total resource bytes enumerated\n" }, "bytesTransferred": { "type": "integer", "description": "Bytes transferred.\n" }, "failed": { "type": "integer", "description": "Number of resources failed to import.\n" }, "notExist": { "type": "integer", "description": "Number of resources not found.\n" }, "skipped": { "type": "integer", "description": "Number of resources skipped during import\n" }, "taskStatus": { "type": "string", "description": "Task status. Status of the import task. Preparing: Preparing for import. Importing: Importing data. Success: Import completed successfully. Failed: Import failed. Stopped: Import paused.\n" }, "total": { "type": "integer", "description": "Total number of resources enumerated.\n" }, "transferred": { "type": "integer", "description": "Number of records transferred.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bytesTotal", "bytesTransferred", "failed", "notExist", "skipped", "taskStatus", "total", "transferred" ] } } }, "volcenginecc:tls/IndexFullText:IndexFullText": { "properties": { "caseSensitive": { "type": "boolean", "description": "Case sensitivity. true: Case sensitive. false: Not case sensitive.\n" }, "delimiter": { "type": "string", "description": "Token separators for the full-text index. Each character in the string represents a token separator. Length: 1–256 bytes. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, specify whether to segment Chinese content in logs according to Chinese grammar. The default is false. true: For Chinese characters in logs, segment the log according to common Chinese grammar rules. Custom segmentation symbols for Chinese content are not supported. For non-Chinese characters in logs, segment the log using the segmentation symbols specified in the parameter. false: Segment the log using the segmentation symbols specified in the parameter.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "caseSensitive", "delimiter", "includeChinese" ] } } }, "volcenginecc:tls/IndexKeyValue:IndexKeyValue": { "properties": { "key": { "type": "string", "description": "Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.\n" }, "value": { "$ref": "#/types/volcenginecc:tls/IndexKeyValueValue:IndexKeyValueValue", "description": "Field description information required for configuring key-value indexes.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tls/IndexKeyValueValue:IndexKeyValueValue": { "properties": { "autoIndexFlag": { "type": "boolean", "description": "Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.\n" }, "caseSensitive": { "type": "boolean", "description": "Whether to distinguish case. Default is false.\n" }, "delimiter": { "type": "string", "description": "Token separators for the field. Default is empty (\"\"). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.\n" }, "indexAll": { "type": "boolean", "description": "Create indexes for all fields with text values in the JSON field.\n" }, "indexSqlAll": { "type": "boolean", "description": "Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.\n" }, "jsonKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/IndexKeyValueValueJsonKey:IndexKeyValueValueJsonKey" } }, "sqlFlag": { "type": "boolean", "description": "Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.\n" }, "valueType": { "type": "string", "description": "Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoIndexFlag", "caseSensitive", "delimiter", "includeChinese", "indexAll", "indexSqlAll", "jsonKeys", "sqlFlag", "valueType" ] } } }, "volcenginecc:tls/IndexKeyValueValueJsonKey:IndexKeyValueValueJsonKey": { "properties": { "key": { "type": "string", "description": "Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.\n" }, "value": { "$ref": "#/types/volcenginecc:tls/IndexKeyValueValueJsonKeyValue:IndexKeyValueValueJsonKeyValue", "description": "Field description information required for configuring key-value indexes.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tls/IndexKeyValueValueJsonKeyValue:IndexKeyValueValueJsonKeyValue": { "properties": { "autoIndexFlag": { "type": "boolean", "description": "Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.\n" }, "caseSensitive": { "type": "boolean", "description": "Whether to distinguish case. Default is false.\n" }, "delimiter": { "type": "string", "description": "Token separators for the field. Default is empty (\"\"). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.\n" }, "indexAll": { "type": "boolean", "description": "Create indexes for all fields with text values in the JSON field.\n" }, "indexSqlAll": { "type": "boolean", "description": "Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.\n" }, "sqlFlag": { "type": "boolean", "description": "Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.\n" }, "valueType": { "type": "string", "description": "Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoIndexFlag", "caseSensitive", "delimiter", "includeChinese", "indexAll", "indexSqlAll", "sqlFlag", "valueType" ] } } }, "volcenginecc:tls/IndexUserInnerKeyValue:IndexUserInnerKeyValue": { "properties": { "key": { "type": "string", "description": "Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.\n" }, "value": { "$ref": "#/types/volcenginecc:tls/IndexUserInnerKeyValueValue:IndexUserInnerKeyValueValue", "description": "Field description information required for configuring key-value indexes.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tls/IndexUserInnerKeyValueValue:IndexUserInnerKeyValueValue": { "properties": { "autoIndexFlag": { "type": "boolean", "description": "Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.\n" }, "caseSensitive": { "type": "boolean", "description": "Whether to distinguish case. Default is false.\n" }, "delimiter": { "type": "string", "description": "Token separators for the field. Default is empty (\"\"). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.\n" }, "indexAll": { "type": "boolean", "description": "Create indexes for all fields with text values in the JSON field.\n" }, "indexSqlAll": { "type": "boolean", "description": "Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.\n" }, "jsonKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/IndexUserInnerKeyValueValueJsonKey:IndexUserInnerKeyValueValueJsonKey" } }, "sqlFlag": { "type": "boolean", "description": "Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.\n" }, "valueType": { "type": "string", "description": "Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoIndexFlag", "caseSensitive", "delimiter", "includeChinese", "indexAll", "indexSqlAll", "jsonKeys", "sqlFlag", "valueType" ] } } }, "volcenginecc:tls/IndexUserInnerKeyValueValueJsonKey:IndexUserInnerKeyValueValueJsonKey": { "properties": { "key": { "type": "string", "description": "Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.\n" }, "value": { "$ref": "#/types/volcenginecc:tls/IndexUserInnerKeyValueValueJsonKeyValue:IndexUserInnerKeyValueValueJsonKeyValue", "description": "Field description information required for configuring key-value indexes.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tls/IndexUserInnerKeyValueValueJsonKeyValue:IndexUserInnerKeyValueValueJsonKeyValue": { "properties": { "autoIndexFlag": { "type": "boolean", "description": "Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.\n" }, "caseSensitive": { "type": "boolean", "description": "Whether to distinguish case. Default is false.\n" }, "delimiter": { "type": "string", "description": "Token separators for the field. Default is empty (\"\"). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.\n" }, "indexAll": { "type": "boolean", "description": "Create indexes for all fields with text values in the JSON field.\n" }, "indexSqlAll": { "type": "boolean", "description": "Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.\n" }, "sqlFlag": { "type": "boolean", "description": "Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.\n" }, "valueType": { "type": "string", "description": "Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoIndexFlag", "caseSensitive", "delimiter", "includeChinese", "indexAll", "indexSqlAll", "sqlFlag", "valueType" ] } } }, "volcenginecc:tls/ProjectTag:ProjectTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tls/RuleContainerRule:RuleContainerRule": { "properties": { "containerNameRegex": { "type": "string", "description": "Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.\n" }, "envTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleEnvTag:RuleContainerRuleEnvTag" } }, "excludeContainerEnvRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleExcludeContainerEnvRegex:RuleContainerRuleExcludeContainerEnvRegex" } }, "excludeContainerLabelRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleExcludeContainerLabelRegex:RuleContainerRuleExcludeContainerLabelRegex" } }, "includeContainerEnvRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleIncludeContainerEnvRegex:RuleContainerRuleIncludeContainerEnvRegex" } }, "includeContainerLabelRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleIncludeContainerLabelRegex:RuleContainerRuleIncludeContainerLabelRegex" } }, "kubernetesRule": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleKubernetesRule:RuleContainerRuleKubernetesRule", "description": "Kubernetes container collection rules.\n" }, "stream": { "type": "string", "description": "Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "containerNameRegex", "envTags", "excludeContainerEnvRegexes", "excludeContainerLabelRegexes", "includeContainerEnvRegexes", "includeContainerLabelRegexes", "kubernetesRule", "stream" ] } } }, "volcenginecc:tls/RuleContainerRuleEnvTag:RuleContainerRuleEnvTag": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleExcludeContainerEnvRegex:RuleContainerRuleExcludeContainerEnvRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleExcludeContainerLabelRegex:RuleContainerRuleExcludeContainerLabelRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleIncludeContainerEnvRegex:RuleContainerRuleIncludeContainerEnvRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleIncludeContainerLabelRegex:RuleContainerRuleIncludeContainerLabelRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleKubernetesRule:RuleContainerRuleKubernetesRule": { "properties": { "annotationTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleKubernetesRuleAnnotationTag:RuleContainerRuleKubernetesRuleAnnotationTag" } }, "enableAllLabelTag": { "type": "boolean", "description": "Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields **tag**source__: DC and **tag**destination__: CS.\n" }, "excludePodAnnotationRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex:RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex" } }, "excludePodLabelRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleKubernetesRuleExcludePodLabelRegex:RuleContainerRuleKubernetesRuleExcludePodLabelRegex" } }, "includePodAnnotationRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex:RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex" } }, "includePodLabelRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleKubernetesRuleIncludePodLabelRegex:RuleContainerRuleKubernetesRuleIncludePodLabelRegex" } }, "labelTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleContainerRuleKubernetesRuleLabelTag:RuleContainerRuleKubernetesRuleLabelTag" } }, "namespaceNameRegex": { "type": "string", "description": "Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.\n" }, "podNameRegex": { "type": "string", "description": "Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.\n" }, "workloadNameRegex": { "type": "string", "description": "Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.\n" }, "workloadType": { "type": "string", "description": "Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "annotationTags", "enableAllLabelTag", "excludePodAnnotationRegexes", "excludePodLabelRegexes", "includePodAnnotationRegexes", "includePodLabelRegexes", "labelTags", "namespaceNameRegex", "podNameRegex", "workloadNameRegex", "workloadType" ] } } }, "volcenginecc:tls/RuleContainerRuleKubernetesRuleAnnotationTag:RuleContainerRuleKubernetesRuleAnnotationTag": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex:RuleContainerRuleKubernetesRuleExcludePodAnnotationRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleKubernetesRuleExcludePodLabelRegex:RuleContainerRuleKubernetesRuleExcludePodLabelRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex:RuleContainerRuleKubernetesRuleIncludePodAnnotationRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleKubernetesRuleIncludePodLabelRegex:RuleContainerRuleKubernetesRuleIncludePodLabelRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleContainerRuleKubernetesRuleLabelTag:RuleContainerRuleKubernetesRuleLabelTag": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleExcludePath:RuleExcludePath": { "properties": { "type": { "type": "string", "description": "Collection path type. File: File name. Path: Directory.\n" }, "value": { "type": "string", "description": "Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type", "value" ] } } }, "volcenginecc:tls/RuleExtractRule:RuleExtractRule": { "properties": { "beginRegex": { "type": "string", "description": "Regular expression that the first line of the log must match. Valid only when LogType is multiline*log or fullregex*log. Must be a valid regular expression.\n" }, "delimiter": { "type": "string", "description": "Log delimiter. Valid only when LogType is delimiter_log.\n" }, "enableNanosecond": { "type": "boolean", "description": "Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.\n" }, "filterKeyRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleExtractRuleFilterKeyRegex:RuleExtractRuleFilterKeyRegex" } }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of log field names (Key). This is only valid when LogType is delimiter*log or fullregex*log. You can configure up to 100 field names. When LogType is delimiter*log, field names must be unique and cannot all be empty. When LogType is fullregex*log, field names must be unique and cannot be empty.\n" }, "logRegex": { "type": "string", "description": "The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.\n" }, "logTemplate": { "$ref": "#/types/volcenginecc:tls/RuleExtractRuleLogTemplate:RuleExtractRuleLogTemplate", "description": "Automatically extract log fields based on the specified log template\n" }, "quote": { "type": "string", "description": "Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.\n" }, "timeExtractRegex": { "type": "string", "description": "Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time\n" }, "timeFormat": { "type": "string", "description": "Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.\n" }, "timeKey": { "type": "string", "description": "Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.\n" }, "timeSample": { "type": "string", "description": "Time sample. Used to check whether the entered time parsing format is correct.\n" }, "timeZone": { "type": "string", "description": "Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.\n" }, "unMatchLogKey": { "type": "string", "description": "Key name for unmatched logs.\n" }, "unMatchUpLoadSwitch": { "type": "boolean", "description": "Switch for uploading unmatched logs.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "beginRegex", "delimiter", "enableNanosecond", "filterKeyRegexes", "keys", "logRegex", "logTemplate", "quote", "timeExtractRegex", "timeFormat", "timeKey", "timeSample", "timeZone", "unMatchLogKey", "unMatchUpLoadSwitch" ] } } }, "volcenginecc:tls/RuleExtractRuleFilterKeyRegex:RuleExtractRuleFilterKeyRegex": { "properties": { "key": { "type": "string", "description": "Name of the filter field.\n" }, "regex": { "type": "string", "description": "The log content of the filter field must match the specified regular expression.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "regex" ] } } }, "volcenginecc:tls/RuleExtractRuleLogTemplate:RuleExtractRuleLogTemplate": { "properties": { "format": { "type": "string", "description": "Log template format.\n" }, "type": { "type": "string", "description": "Log template types. Supported types: Nginx: Nginx log template.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "format", "type" ] } } }, "volcenginecc:tls/RuleHostGroupInfo:RuleHostGroupInfo": { "properties": { "hostGroupId": { "type": "string", "description": "Machine group ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "hostGroupId" ] } } }, "volcenginecc:tls/RuleUserDefineRule:RuleUserDefineRule": { "properties": { "advanced": { "$ref": "#/types/volcenginecc:tls/RuleUserDefineRuleAdvanced:RuleUserDefineRuleAdvanced", "description": "The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.\n" }, "enableHostGroupLabel": { "type": "boolean", "description": "Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.\n" }, "enableHostname": { "type": "boolean", "description": "Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.\n" }, "enableRawLog": { "type": "boolean", "description": "Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.\n" }, "fields": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleUserDefineRuleField:RuleUserDefineRuleField" } }, "hostGroupLabelKey": { "type": "string", "description": "Field name used to store machine group label information\n" }, "hostnameKey": { "type": "string", "description": "Hostname field name. Required only when EnableHostname is true.\n" }, "ignoreOlder": { "type": "integer", "description": "Ignore log files that have not been updated for a specified period (in hours).\n" }, "multiCollectsType": { "type": "string", "description": "Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.\n" }, "parsePathRule": { "$ref": "#/types/volcenginecc:tls/RuleUserDefineRuleParsePathRule:RuleUserDefineRuleParsePathRule", "description": "Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.\n" }, "plugin": { "$ref": "#/types/volcenginecc:tls/RuleUserDefineRulePlugin:RuleUserDefineRulePlugin", "description": "LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.\n" }, "rawLogKey": { "type": "string", "description": "Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to **raw**, meaning the original log data will be encapsulated in the **raw** field and uploaded to the log service along with the parsed log data.\n" }, "shardHashKey": { "$ref": "#/types/volcenginecc:tls/RuleUserDefineRuleShardHashKey:RuleUserDefineRuleShardHashKey", "description": "Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value\n" }, "tailFiles": { "type": "boolean", "description": "LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.\n" }, "tailSizeKb": { "type": "integer", "description": "Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "advanced", "enableHostGroupLabel", "enableHostname", "enableRawLog", "fields", "hostGroupLabelKey", "hostnameKey", "ignoreOlder", "multiCollectsType", "parsePathRule", "plugin", "rawLogKey", "shardHashKey", "tailFiles", "tailSizeKb" ] } } }, "volcenginecc:tls/RuleUserDefineRuleAdvanced:RuleUserDefineRuleAdvanced": { "properties": { "closeEof": { "type": "boolean", "description": "After reading to the end of the log file, choose whether to release the file handle. Default is false.\n" }, "closeInactive": { "type": "integer", "description": "Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.\n" }, "closeRemoved": { "type": "boolean", "description": "Release the file handle after the log file is removed. Default is false.\n" }, "closeRenamed": { "type": "boolean", "description": "Release the file handle after the log file is renamed. Default is false.\n" }, "closeTimeout": { "type": "integer", "description": "Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.\n" }, "noLineTerminatorEofMaxTime": { "type": "integer", "description": "Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "closeEof", "closeInactive", "closeRemoved", "closeRenamed", "closeTimeout", "noLineTerminatorEofMaxTime" ] } } }, "volcenginecc:tls/RuleUserDefineRuleField:RuleUserDefineRuleField": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "val" ] } } }, "volcenginecc:tls/RuleUserDefineRuleParsePathRule:RuleUserDefineRuleParsePathRule": { "properties": { "keys": { "type": "array", "items": { "type": "string" }, "description": "Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.\n" }, "pathSample": { "type": "string", "description": "Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.\n" }, "regex": { "type": "string", "description": "Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "keys", "pathSample", "regex" ] } } }, "volcenginecc:tls/RuleUserDefineRulePlugin:RuleUserDefineRulePlugin": { "properties": { "processors": { "type": "string", "description": "LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "processors" ] } } }, "volcenginecc:tls/RuleUserDefineRuleShardHashKey:RuleUserDefineRuleShardHashKey": { "properties": { "hashKey": { "type": "string", "description": "HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "hashKey" ] } } }, "volcenginecc:tls/ScheduleSqlTaskRequestCycle:ScheduleSqlTaskRequestCycle": { "properties": { "cronTab": { "type": "string", "description": "Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.\n" }, "cronTimeZone": { "type": "string", "description": "If Type is set to Cron, you must also set the time zone.\n" }, "time": { "type": "integer", "description": "Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.\n" }, "type": { "type": "string", "description": "Scheduling period type. Options: Period, Fixed, Cron.\n" } }, "type": "object", "required": [ "time", "type" ], "language": { "nodejs": { "requiredOutputs": [ "cronTab", "cronTimeZone", "time", "type" ] } } }, "volcenginecc:tls/ShipperContentInfo:ShipperContentInfo": { "properties": { "csvInfo": { "$ref": "#/types/volcenginecc:tls/ShipperContentInfoCsvInfo:ShipperContentInfoCsvInfo", "description": "CSV format log content configuration.\n" }, "format": { "type": "string", "description": "Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.\n" }, "jsonInfo": { "$ref": "#/types/volcenginecc:tls/ShipperContentInfoJsonInfo:ShipperContentInfoJsonInfo", "description": "JSON/JSONL format log content configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "csvInfo", "format", "jsonInfo" ] } } }, "volcenginecc:tls/ShipperContentInfoCsvInfo:ShipperContentInfoCsvInfo": { "properties": { "delimiter": { "type": "string", "description": "Delimiter. Supports comma, tab, pipe, semicolon, space.\n" }, "escapeChar": { "type": "string", "description": "Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.\n" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.\n" }, "nonFieldContent": { "type": "string", "description": "Content for invalid field padding. Length: 0–128.\n" }, "printHeader": { "type": "boolean", "description": "Whether to print the key in the first row.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "delimiter", "escapeChar", "keys", "nonFieldContent", "printHeader" ] } } }, "volcenginecc:tls/ShipperContentInfoJsonInfo:ShipperContentInfoJsonInfo": { "properties": { "enable": { "type": "boolean", "description": "Enable flag.\n" }, "escape": { "type": "boolean", "description": "Whether to enable escaping. Must be set to true.\n" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including **content** (required), **source**, **path**, **time**, **image_name**, **container_name**, **pod_name**, **pod_uid**, namespace, **tag****client_ip**, and **tag****receive_time**.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enable", "escape", "keys" ] } } }, "volcenginecc:tls/ShipperKafkaShipperInfo:ShipperKafkaShipperInfo": { "properties": { "compress": { "type": "string", "description": "Compression format; supports snappy, gzip, lz4, none.\n" }, "endTime": { "type": "integer", "description": "Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.\n" }, "instance": { "type": "string", "description": "Kafka instance.\n" }, "kafkaTopic": { "type": "string", "description": "Kafka topic name. All log data delivered through this configuration will be sent to this topic.\n" }, "startTime": { "type": "integer", "description": "Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compress", "endTime", "instance", "kafkaTopic", "startTime" ] } } }, "volcenginecc:tls/ShipperTosShipperInfo:ShipperTosShipperInfo": { "properties": { "bucket": { "type": "string", "description": "Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.\n" }, "compress": { "type": "string", "description": "Compression format; supports snappy, gzip, lz4, none.\n" }, "interval": { "type": "integer", "description": "Delivery interval in seconds, range: 300–900.\n" }, "maxSize": { "type": "integer", "description": "Maximum raw file size per partition for delivery, in MiB. Range: 5–256.\n" }, "partitionFormat": { "type": "string", "description": "Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.\n" }, "prefix": { "type": "string", "description": "Top-level directory name for the bucket. Cannot start with / or \\, and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucket", "compress", "interval", "maxSize", "partitionFormat", "prefix" ] } } }, "volcenginecc:tls/TopicTag:TopicTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tls/getAlarmNotifyGroupNoticeRule:getAlarmNotifyGroupNoticeRule": { "properties": { "hasEndNode": { "type": "boolean", "description": "Whether there is an end node afterwards.\n" }, "hasNext": { "type": "boolean", "description": "Condition for whether to proceed to the next level.\n" }, "receiverInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getAlarmNotifyGroupNoticeRuleReceiverInfo:getAlarmNotifyGroupNoticeRuleReceiverInfo" }, "description": "Notification channel information.\n" }, "ruleNode": { "type": "string", "description": "Rule node. JSON format.\n" } }, "type": "object", "required": [ "hasEndNode", "hasNext", "receiverInfos", "ruleNode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getAlarmNotifyGroupNoticeRuleReceiverInfo:getAlarmNotifyGroupNoticeRuleReceiverInfo": { "properties": { "alarmContentTemplateId": { "type": "string", "description": "Alarm content template ID.\n" }, "alarmWebhookAtGroups": { "type": "array", "items": { "type": "string" }, "description": "User group name to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "alarmWebhookAtUsers": { "type": "array", "items": { "type": "string" }, "description": "Username to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "alarmWebhookIntegrationId": { "type": "string", "description": "Alarm webhook integration configuration ID.\n" }, "alarmWebhookIntegrationName": { "type": "string", "description": "Name of the alarm Webhook integration configuration.\n" }, "alarmWebhookIsAtAll": { "type": "boolean", "description": "Whether to notify everyone when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "endTime": { "type": "string", "description": "End time for receiving alarm notifications. Uses 24-hour format: HH:mm:ss, with a valid range of 00:00:00–23:59:59. StartTime cannot be greater than EndTime.\n" }, "generalWebhookBody": { "type": "string", "description": "Custom WebHook request body. It is recommended to set the request body according to the callback interface requirements of the corresponding service.\n" }, "generalWebhookHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getAlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader:getAlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader" }, "description": "Custom callback request headers for the interface.\n" }, "generalWebhookMethod": { "type": "string", "description": "Custom callback method for the interface. Only POST or PUT is supported.\n" }, "generalWebhookUrl": { "type": "string", "description": "Custom callback URL for the interface.\n" }, "receiverChannels": { "type": "array", "items": { "type": "string" }, "description": "Notification channels. Supports one or more channels. Options: Email, Sms, Phone, GeneralWebhook, Lark, DingTalk, WeChat.\n" }, "receiverNames": { "type": "array", "items": { "type": "string" }, "description": "IAM user or user group name.\n" }, "receiverType": { "type": "string", "description": "Recipient type. Options: User: IAM user; UserGroup: IAM user group.\n" }, "startTime": { "type": "string", "description": "Alarm notification start time. Uses 24-hour format (HH:mm:ss), valid range is 00:00:00–23:59:59. StartTime cannot be later than EndTime.\n" } }, "type": "object", "required": [ "alarmContentTemplateId", "alarmWebhookAtGroups", "alarmWebhookAtUsers", "alarmWebhookIntegrationId", "alarmWebhookIntegrationName", "alarmWebhookIsAtAll", "endTime", "generalWebhookBody", "generalWebhookHeaders", "generalWebhookMethod", "generalWebhookUrl", "receiverChannels", "receiverNames", "receiverType", "startTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getAlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader:getAlarmNotifyGroupNoticeRuleReceiverInfoGeneralWebhookHeader": { "properties": { "key": { "type": "string", "description": "Custom request header key.\n" }, "value": { "type": "string", "description": "Custom request header value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getAlarmNotifyGroupReceiver:getAlarmNotifyGroupReceiver": { "properties": { "alarmContentTemplateId": { "type": "string", "description": "Alarm content template ID.\n" }, "alarmWebhookAtGroups": { "type": "array", "items": { "type": "string" }, "description": "User group name to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "alarmWebhookAtUsers": { "type": "array", "items": { "type": "string" }, "description": "Username to notify when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "alarmWebhookIntegrationId": { "type": "string", "description": "Alarm webhook integration configuration ID.\n" }, "alarmWebhookIntegrationName": { "type": "string", "description": "Name of the alarm Webhook integration configuration.\n" }, "alarmWebhookIsAtAll": { "type": "boolean", "description": "Whether to notify everyone when sending notifications to Feishu, DingTalk, or WeCom via Webhook integration.\n" }, "endTime": { "type": "string", "description": "End time for receiving alarm notifications. Uses 24-hour format: HH:mm:ss, with a valid range of 00:00:00–23:59:59. StartTime cannot be greater than EndTime.\n" }, "generalWebhookBody": { "type": "string", "description": "Custom WebHook request body. It is recommended to set the request body according to the callback interface requirements of the corresponding service.\n" }, "generalWebhookHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getAlarmNotifyGroupReceiverGeneralWebhookHeader:getAlarmNotifyGroupReceiverGeneralWebhookHeader" }, "description": "Custom callback request headers for the interface.\n" }, "generalWebhookMethod": { "type": "string", "description": "Custom callback method for the interface. Only POST or PUT is supported.\n" }, "generalWebhookUrl": { "type": "string", "description": "Custom callback URL for the interface.\n" }, "receiverChannels": { "type": "array", "items": { "type": "string" }, "description": "Notification channels. Supports one or more channels. Options: Email, Sms, Phone, GeneralWebhook, Lark, DingTalk, WeChat.\n" }, "receiverNames": { "type": "array", "items": { "type": "string" }, "description": "IAM user or user group name.\n" }, "receiverType": { "type": "string", "description": "Recipient type. Options: User: IAM user; UserGroup: IAM user group.\n" }, "startTime": { "type": "string", "description": "Alarm notification start time. Uses 24-hour format (HH:mm:ss), valid range is 00:00:00–23:59:59. StartTime cannot be later than EndTime.\n" } }, "type": "object", "required": [ "alarmContentTemplateId", "alarmWebhookAtGroups", "alarmWebhookAtUsers", "alarmWebhookIntegrationId", "alarmWebhookIntegrationName", "alarmWebhookIsAtAll", "endTime", "generalWebhookBody", "generalWebhookHeaders", "generalWebhookMethod", "generalWebhookUrl", "receiverChannels", "receiverNames", "receiverType", "startTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getAlarmNotifyGroupReceiverGeneralWebhookHeader:getAlarmNotifyGroupReceiverGeneralWebhookHeader": { "properties": { "key": { "type": "string", "description": "Custom request header key.\n" }, "value": { "type": "string", "description": "Custom request header value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getImportTaskImportSourceInfo:getImportTaskImportSourceInfo": { "properties": { "kafkaSourceInfo": { "$ref": "#/types/volcenginecc:tls/getImportTaskImportSourceInfoKafkaSourceInfo:getImportTaskImportSourceInfoKafkaSourceInfo", "description": "Kafka data source information. When sourceType is kafka, the KafkaSourceInfo field is required\n" }, "tosSourceInfo": { "$ref": "#/types/volcenginecc:tls/getImportTaskImportSourceInfoTosSourceInfo:getImportTaskImportSourceInfoTosSourceInfo", "description": "TOS data source information. When sourceType is tos, the TosSourceInfo field is required.\n" } }, "type": "object", "required": [ "kafkaSourceInfo", "tosSourceInfo" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getImportTaskImportSourceInfoKafkaSourceInfo:getImportTaskImportSourceInfoKafkaSourceInfo": { "properties": { "encode": { "type": "string", "description": "Data encoding format. Available options: UTF-8, GBK.\n" }, "group": { "type": "string", "description": "Kafka consumer group. If not specified, the system will automatically create a Kafka consumer group.\n" }, "host": { "type": "string", "description": "The service addresses for different types of Kafka clusters vary. Details are as follows: Message Queue Kafka Edition: Use the access point of the Kafka instance. For more information, see Access Point. If the Kafka instance and the Log Service Project are in the same region, you can use private network access; otherwise, use public network access. Self-hosted Kafka clusters: Use the IP address and port number or the domain name and port number of the Kafka Broker. Only public network access is supported. Separate multiple service addresses with a comma (,).\n" }, "initialOffset": { "type": "integer", "description": "Starting position for data import. Options: 0: Earliest time, start importing from the first record in the specified Kafka Topic. 1: Latest time, start importing from the most recently generated record in the specified Kafka Topic.\n" }, "instanceId": { "type": "string", "description": "If you are using Message Queue Kafka Edition, set this to the Kafka instance ID.\n" }, "isNeedAuth": { "type": "boolean", "description": "Whether to enable authentication. If you use a public service address, it is recommended to enable authentication.\n" }, "mechanism": { "type": "string", "description": "Password authentication mechanism. Available options: PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512.\n" }, "password": { "type": "string", "description": "Kafka SASL user password for authentication.\n" }, "protocol": { "type": "string", "description": "Secure transmission protocol. Options include plaintext, sasl*ssl, ssl, and sasl*plaintext\n" }, "timeSourceDefault": { "type": "integer", "description": "Specify log time. Options: 0: Use Kafka message timestamp. 1: Use current system time.\n" }, "topic": { "type": "string", "description": "Kafka Topic name. Separate multiple Kafka Topics with commas (,).\n" }, "username": { "type": "string", "description": "Kafka SASL username for authentication.\n" } }, "type": "object", "required": [ "encode", "group", "host", "initialOffset", "instanceId", "isNeedAuth", "mechanism", "password", "protocol", "timeSourceDefault", "topic", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getImportTaskImportSourceInfoTosSourceInfo:getImportTaskImportSourceInfoTosSourceInfo": { "properties": { "bucket": { "type": "string", "description": "TOS bucket name\n" }, "compressType": { "type": "string", "description": "Compression mode for data in the TOS bucket. none: No compression. snappy: Compress using snappy. gzip: Compress using gzip. lz4: Compress using lz4.\n" }, "prefix": { "type": "string", "description": "Path of the file to be imported in the TOS bucket.\n" }, "region": { "type": "string", "description": "Region where the TOS bucket is located. Cross-region data import is supported\n" } }, "type": "object", "required": [ "bucket", "compressType", "prefix", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getImportTaskTargetInfo:getImportTaskTargetInfo": { "properties": { "extractRule": { "$ref": "#/types/volcenginecc:tls/getImportTaskTargetInfoExtractRule:getImportTaskTargetInfoExtractRule", "description": "Log extraction rule.\n" }, "logSample": { "type": "string", "description": "Log sample. When LogType is set to multiline_log, you must configure log samples. It is recommended to provide more than two log entries as examples to ensure the regular expression matches the first line of each log. Use real samples from the production environment.\n" }, "logType": { "type": "string", "description": "Specify log parsing type during import. delimiter*log: CSV type. multiline*log: multiline full text type. minimalist*log: single line full text type. json*log: JSON type.\n" }, "region": { "type": "string", "description": "Region.\n" } }, "type": "object", "required": [ "extractRule", "logSample", "logType", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getImportTaskTargetInfoExtractRule:getImportTaskTargetInfoExtractRule": { "properties": { "extractRule": { "$ref": "#/types/volcenginecc:tls/getImportTaskTargetInfoExtractRuleExtractRule:getImportTaskTargetInfoExtractRuleExtractRule", "description": "Basic content of log extraction rules.\n" }, "skipLineCount": { "type": "integer", "description": "Number of skipped rows. Only valid when the log type is delimiter_log and the import type is tos.\n" }, "timeExtractRegex": { "type": "string", "description": "Time extraction regular expression, used to extract the time value from the TimeKey field and parse it as the collection time\n" }, "timeZone": { "type": "string", "description": "Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.\n" } }, "type": "object", "required": [ "extractRule", "skipLineCount", "timeExtractRegex", "timeZone" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getImportTaskTargetInfoExtractRuleExtractRule:getImportTaskTargetInfoExtractRuleExtractRule": { "properties": { "beginRegex": { "type": "string", "description": "Regular expression for identifying the first line of each log. The matched part is treated as the start of the log. When LogType is set to multiline_log, you must configure a log sample\n" }, "delimiter": { "type": "string", "description": "Delimiter. Only valid when LogType is delimiter_log.\n" }, "enableNanosecond": { "type": "boolean", "description": "Enable nanoseconds.\n" }, "filterKeyRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex:getImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex" }, "description": "Filter key regular expression.\n" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of log field names (Key). Valid only when LogType is delimiter_log. Supports up to 100 field names. Duplicate field names are not allowed, and all field names cannot be left blank\n" }, "logRegex": { "type": "string", "description": "Log regular expression\n" }, "logTemplate": { "$ref": "#/types/volcenginecc:tls/getImportTaskTargetInfoExtractRuleExtractRuleLogTemplate:getImportTaskTargetInfoExtractRuleExtractRuleLogTemplate", "description": "Log template.\n" }, "quote": { "type": "string", "description": "Quotation mark. Content enclosed by the quotation mark will not be separated and will be parsed as a complete field. Only valid when LogType is delimiter_log.\n" }, "timeFormat": { "type": "string", "description": "Parsing format for the time field. If you use a specified time field in the log as the log timestamp, you must fill in TimeKey and TimeFormat. TimeKey and TimeFormat must be paired. For configuration details, see time format.\n" }, "timeKey": { "type": "string", "description": "Name of the log time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must appear in pairs\n" }, "timeSample": { "type": "string", "description": "Time sample. Used to verify whether the entered time parsing format is correct\n" }, "unMatchLogKey": { "type": "string", "description": "When uploading logs that failed to parse, specify the key name for the failed logs. UnMatchUpLoadSwitch=true and UnMatchLogKey must be used together.\n" }, "unMatchUpLoadSwitch": { "type": "boolean", "description": "Whether to upload logs that failed to parse. UnMatchUpLoadSwitch=true and UnMatchLogKey must be paired. true: Upload logs that failed to parse. false: Do not upload logs that failed to parse.\n" } }, "type": "object", "required": [ "beginRegex", "delimiter", "enableNanosecond", "filterKeyRegexes", "keys", "logRegex", "logTemplate", "quote", "timeFormat", "timeKey", "timeSample", "unMatchLogKey", "unMatchUpLoadSwitch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex:getImportTaskTargetInfoExtractRuleExtractRuleFilterKeyRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "regex": { "type": "string", "description": "Regular expression.\n" } }, "type": "object", "required": [ "key", "regex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getImportTaskTargetInfoExtractRuleExtractRuleLogTemplate:getImportTaskTargetInfoExtractRuleExtractRuleLogTemplate": { "properties": { "format": { "type": "string", "description": "Format.\n" }, "type": { "type": "string", "description": "Type\n" } }, "type": "object", "required": [ "format", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getImportTaskTaskStatistics:getImportTaskTaskStatistics": { "properties": { "bytesTotal": { "type": "integer", "description": "Total resource bytes enumerated\n" }, "bytesTransferred": { "type": "integer", "description": "Bytes transferred.\n" }, "failed": { "type": "integer", "description": "Number of resources failed to import.\n" }, "notExist": { "type": "integer", "description": "Number of resources not found.\n" }, "skipped": { "type": "integer", "description": "Number of resources skipped during import\n" }, "taskStatus": { "type": "string", "description": "Task status. Status of the import task. Preparing: Preparing for import. Importing: Importing data. Success: Import completed successfully. Failed: Import failed. Stopped: Import paused.\n" }, "total": { "type": "integer", "description": "Total number of resources enumerated.\n" }, "transferred": { "type": "integer", "description": "Number of records transferred.\n" } }, "type": "object", "required": [ "bytesTotal", "bytesTransferred", "failed", "notExist", "skipped", "taskStatus", "total", "transferred" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getIndexFullText:getIndexFullText": { "properties": { "caseSensitive": { "type": "boolean", "description": "Case sensitivity. true: Case sensitive. false: Not case sensitive.\n" }, "delimiter": { "type": "string", "description": "Token separators for the full-text index. Each character in the string represents a token separator. Length: 1–256 bytes. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, specify whether to segment Chinese content in logs according to Chinese grammar. The default is false. true: For Chinese characters in logs, segment the log according to common Chinese grammar rules. Custom segmentation symbols for Chinese content are not supported. For non-Chinese characters in logs, segment the log using the segmentation symbols specified in the parameter. false: Segment the log using the segmentation symbols specified in the parameter.\n" } }, "type": "object", "required": [ "caseSensitive", "delimiter", "includeChinese" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getIndexKeyValue:getIndexKeyValue": { "properties": { "key": { "type": "string", "description": "Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.\n" }, "value": { "$ref": "#/types/volcenginecc:tls/getIndexKeyValueValue:getIndexKeyValueValue", "description": "Field description information required for configuring key-value indexes.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getIndexKeyValueValue:getIndexKeyValueValue": { "properties": { "autoIndexFlag": { "type": "boolean", "description": "Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.\n" }, "caseSensitive": { "type": "boolean", "description": "Whether to distinguish case. Default is false.\n" }, "delimiter": { "type": "string", "description": "Token separators for the field. Default is empty (\"\"). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.\n" }, "indexAll": { "type": "boolean", "description": "Create indexes for all fields with text values in the JSON field.\n" }, "indexSqlAll": { "type": "boolean", "description": "Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.\n" }, "jsonKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getIndexKeyValueValueJsonKey:getIndexKeyValueValueJsonKey" }, "description": "When ValueType is json, you can configure key-value indexes for JSON subfields using the JsonKeys field, which is an array of KeyValueInfo. Each element in the JsonKeys list is a KeyValueInfo, and you can further nest text, long, and double type subfields. For subfields in JSON key-value indexes, use . to indicate the hierarchy between JSON fields. For example, the JSON field namelist contains a text-type subfield totalcount and a JSON-type info, which itself contains the field name. Each field name should be configured as totalcount and info.name, respectively. The SqlFlag setting for subfield key-value indexes defined in JsonKeys must match their parent field, meaning they must be enabled or disabled together. The default is disabled. Subfields do not support separate settings for Delimiter, CaseSensitive, or IncludeChinese. For text-type fields, CaseSensitive, Delimiter, and IncludeChinese always inherit the parent field settings. This is only set when ValueType is json.\n" }, "sqlFlag": { "type": "boolean", "description": "Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.\n" }, "valueType": { "type": "string", "description": "Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.\n" } }, "type": "object", "required": [ "autoIndexFlag", "caseSensitive", "delimiter", "includeChinese", "indexAll", "indexSqlAll", "jsonKeys", "sqlFlag", "valueType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getIndexKeyValueValueJsonKey:getIndexKeyValueValueJsonKey": { "properties": { "key": { "type": "string", "description": "Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.\n" }, "value": { "$ref": "#/types/volcenginecc:tls/getIndexKeyValueValueJsonKeyValue:getIndexKeyValueValueJsonKeyValue", "description": "Field description information required for configuring key-value indexes.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getIndexKeyValueValueJsonKeyValue:getIndexKeyValueValueJsonKeyValue": { "properties": { "autoIndexFlag": { "type": "boolean", "description": "Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.\n" }, "caseSensitive": { "type": "boolean", "description": "Whether to distinguish case. Default is false.\n" }, "delimiter": { "type": "string", "description": "Token separators for the field. Default is empty (\"\"). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.\n" }, "indexAll": { "type": "boolean", "description": "Create indexes for all fields with text values in the JSON field.\n" }, "indexSqlAll": { "type": "boolean", "description": "Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.\n" }, "sqlFlag": { "type": "boolean", "description": "Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.\n" }, "valueType": { "type": "string", "description": "Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.\n" } }, "type": "object", "required": [ "autoIndexFlag", "caseSensitive", "delimiter", "includeChinese", "indexAll", "indexSqlAll", "sqlFlag", "valueType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getIndexUserInnerKeyValue:getIndexUserInnerKeyValue": { "properties": { "key": { "type": "string", "description": "Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.\n" }, "value": { "$ref": "#/types/volcenginecc:tls/getIndexUserInnerKeyValueValue:getIndexUserInnerKeyValueValue", "description": "Field description information required for configuring key-value indexes.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getIndexUserInnerKeyValueValue:getIndexUserInnerKeyValueValue": { "properties": { "autoIndexFlag": { "type": "boolean", "description": "Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.\n" }, "caseSensitive": { "type": "boolean", "description": "Whether to distinguish case. Default is false.\n" }, "delimiter": { "type": "string", "description": "Token separators for the field. Default is empty (\"\"). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.\n" }, "indexAll": { "type": "boolean", "description": "Create indexes for all fields with text values in the JSON field.\n" }, "indexSqlAll": { "type": "boolean", "description": "Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.\n" }, "jsonKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getIndexUserInnerKeyValueValueJsonKey:getIndexUserInnerKeyValueValueJsonKey" }, "description": "When ValueType is json, you can configure key-value indexes for JSON subfields using the JsonKeys field, which is an array of KeyValueInfo. Each element in the JsonKeys list is a KeyValueInfo, and you can further nest text, long, and double type subfields. For subfields in JSON key-value indexes, use . to indicate the hierarchy between JSON fields. For example, the JSON field namelist contains a text-type subfield totalcount and a JSON-type info, which itself contains the field name. Each field name should be configured as totalcount and info.name, respectively. The SqlFlag setting for subfield key-value indexes defined in JsonKeys must match their parent field, meaning they must be enabled or disabled together. The default is disabled. Subfields do not support separate settings for Delimiter, CaseSensitive, or IncludeChinese. For text-type fields, CaseSensitive, Delimiter, and IncludeChinese always inherit the parent field settings. This is only set when ValueType is json.\n" }, "sqlFlag": { "type": "boolean", "description": "Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.\n" }, "valueType": { "type": "string", "description": "Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.\n" } }, "type": "object", "required": [ "autoIndexFlag", "caseSensitive", "delimiter", "includeChinese", "indexAll", "indexSqlAll", "jsonKeys", "sqlFlag", "valueType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getIndexUserInnerKeyValueValueJsonKey:getIndexUserInnerKeyValueValueJsonKey": { "properties": { "key": { "type": "string", "description": "Specify the field names for key-value indexing. Up to 100 fields can be added. Only letters, numbers, spaces, underscores (_), hyphens (-), and slashes (/) are supported, and field names cannot start or end with a space. Each key name must be unique within the same index. Length: 1–128 characters. For subfields in JSON-type key-value indexes, use a dot (.) to indicate the hierarchy between JSON fields. For example, if the JSON field 'namelist' contains a text-type subfield 'totalcount' and a JSON-type subfield 'info', and 'info' contains the field 'name', the field names should be configured as 'totalcount' and 'info.name' respectively.\n" }, "value": { "$ref": "#/types/volcenginecc:tls/getIndexUserInnerKeyValueValueJsonKeyValue:getIndexUserInnerKeyValueValueJsonKeyValue", "description": "Field description information required for configuring key-value indexes.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getIndexUserInnerKeyValueValueJsonKeyValue:getIndexUserInnerKeyValueValueJsonKeyValue": { "properties": { "autoIndexFlag": { "type": "boolean", "description": "Indicates whether the index was added automatically. true: The index was added automatically. false: The index was not added automatically.\n" }, "caseSensitive": { "type": "boolean", "description": "Whether to distinguish case. Default is false.\n" }, "delimiter": { "type": "string", "description": "Token separators for the field. Default is empty (\"\"). Each character in the string represents a token separator. Length: 0–256 bytes. If the length is 0, segmentation is disabled. Only one or more of the following characters are supported: letters, numbers, and !@#%^\u0026*()-_=\\\\\"', \u003c\u003e/?|;:\\\t\\r[]{}. . Supports configuring both Chinese characters and token separators simultaneously.\n" }, "includeChinese": { "type": "boolean", "description": "When searching, determines whether to segment Chinese log content according to Chinese syntax. Enabled: Chinese characters in logs are segmented based on common Chinese syntax; custom segmentation for Chinese content is not supported. Non-Chinese characters in logs are segmented using the token separators specified in the parameter. Disabled: Logs are segmented using the token separators specified in the parameter.\n" }, "indexAll": { "type": "boolean", "description": "Create indexes for all fields with text values in the JSON field.\n" }, "indexSqlAll": { "type": "boolean", "description": "Enable automatic indexing and statistics for JSON fields. true: Enable automatic indexing and statistics. false: Disable automatic indexing and statistics.\n" }, "sqlFlag": { "type": "boolean", "description": "Whether analysis is enabled for the field. Default is false. After enabling statistical analysis, you can configure token delimiters and whether to include Chinese content.\n" }, "valueType": { "type": "string", "description": "Field type. Currently supports long, double, text, and json. The long and double types do not support configuring delimiters, including Chinese, or case sensitivity. Only the json type supports further configuration of JsonKeys subfields.\n" } }, "type": "object", "required": [ "autoIndexFlag", "caseSensitive", "delimiter", "includeChinese", "indexAll", "indexSqlAll", "sqlFlag", "valueType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getProjectTag:getProjectTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRule:getRuleContainerRule": { "properties": { "containerNameRegex": { "type": "string", "description": "Container name to collect. If no container name is specified, all containers in the machine group will be collected. Supports regex matching; for example, setting the container name to ^(container-test)$ will collect all containers named container-test.\n" }, "envTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleEnvTag:getRuleContainerRuleEnvTag" }, "description": "Whether to add environment variables as log tags to the raw log data. When enabled, the log service adds container environment variable fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, set Key to source and Value to data_source. If the container has the environment variable source=DC, the log will include the field **tag**data_source_*: DC\n" }, "excludeContainerEnvRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleExcludeContainerEnvRegex:getRuleContainerRuleExcludeContainerEnvRegex" }, "description": "The container environment variable denylist specifies which containers are excluded from collection. If the denylist is not enabled, all containers are collected. When the container environment variable denylist is enabled, Key is required and Value is optional. If Value is empty, all containers whose environment variables contain the Key are excluded from collection. If Value is not empty, only containers with a matching key-value pair are excluded, meaning only containers whose environment variables contain the Key and whose value matches the Value are excluded. Value supports regular expressions. For example, if Key is set to module and Value is set to ^(tcp|udp)$, containers with environment variables module:tcp or module:udp are excluded from collection. Multiple key-value pairs are evaluated with a logical OR, so any container environment variable matching any key-value pair will be excluded from collection. When the container environment variable denylist is enabled, Keys must be unique.\n" }, "excludeContainerLabelRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleExcludeContainerLabelRegex:getRuleContainerRuleExcludeContainerLabelRegex" }, "description": "Container label denylist specifies containers to exclude from collection. If the denylist is not enabled, all containers will be collected. If the container label denylist is enabled, Key is required and Value is optional. If Value is empty, all containers with the Key in their label will be excluded. If Value is not empty, only containers matching the key-value pair will be excluded—that is, containers with the Key in their label and a Value matching the specified pattern. Value supports regex matching; for example, set Key to app and Value to ^(test1|test2)$ to exclude containers with labels app:test1 and app:test2. Multiple key-value pairs use logical OR; any container label matching any pair will be excluded from collection. When the container label denylist is enabled, Keys must not be duplicated.\n" }, "includeContainerEnvRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleIncludeContainerEnvRegex:getRuleContainerRuleIncludeContainerEnvRegex" }, "description": "The container environment variable allowlist specifies which containers to collect using container environment variables. If the allowlist is not enabled, all containers are collected. When the container environment variable allowlist is enabled, you must enter key-value pairs. Key is required; Value is optional. If Value is empty, all containers containing the Key in their environment variables are collected. If Value is not empty, only containers with the Key in their environment variables and a Value matching the specified value are collected. Value supports regular expression matching. For example, if Key is set to module and Value is set to ^(tcp|udp)$, only containers with module:tcp or module:udp in their environment variables are collected. The logical relationship between multiple key-value pairs is OR, meaning any container environment variable matching any key-value pair will be included in the collection scope. When the container environment variable allowlist is enabled, Keys must not be duplicated.\n" }, "includeContainerLabelRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleIncludeContainerLabelRegex:getRuleContainerRuleIncludeContainerLabelRegex" }, "description": "The container label allowlist specifies which containers to collect based on container labels. If the allowlist is not enabled, all containers are collected. When the container label allowlist is enabled, you must specify key-value pairs. Key is required and Value is optional. If Value is empty, all containers whose labels contain the Key are collected. If Value is not empty, only containers whose labels contain the Key and whose value matches the Value are collected. Value supports regular expressions. For example, if Key is set to app and Value is set to ^(test1|test2)$, only containers with labels app:test1 or app:test2 are collected. Multiple key-value pairs are evaluated with a logical OR, so any container label matching any key-value pair will be included in the collection scope. When the container label allowlist is enabled, Keys must be unique.\n" }, "kubernetesRule": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleKubernetesRule:getRuleContainerRuleKubernetesRule", "description": "Kubernetes container collection rules.\n" }, "stream": { "type": "string", "description": "Collection information. stdout: Collects container standard output (stdout). stderr: Collects container standard error (stderr). all: Collects both container standard output (stdout) and standard error (stderr).\n" } }, "type": "object", "required": [ "containerNameRegex", "envTags", "excludeContainerEnvRegexes", "excludeContainerLabelRegexes", "includeContainerEnvRegexes", "includeContainerLabelRegexes", "kubernetesRule", "stream" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleEnvTag:getRuleContainerRuleEnvTag": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleExcludeContainerEnvRegex:getRuleContainerRuleExcludeContainerEnvRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleExcludeContainerLabelRegex:getRuleContainerRuleExcludeContainerLabelRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleIncludeContainerEnvRegex:getRuleContainerRuleIncludeContainerEnvRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleIncludeContainerLabelRegex:getRuleContainerRuleIncludeContainerLabelRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleKubernetesRule:getRuleContainerRuleKubernetesRule": { "properties": { "annotationTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleKubernetesRuleAnnotationTag:getRuleContainerRuleKubernetesRuleAnnotationTag" }, "description": "Whether to add Kubernetes Annotations as log tags to the original log data. When enabled, the log service will add fields related to Kubernetes Pod Annotations to the logs. Setting multiple key-value pairs means adding multiple fields. For example, if you set Key to sink and Value to data_sink, and the Pod contains the annotation sink=ck, a new field **tag**data_sink_*: ck will be added to the log.\n" }, "enableAllLabelTag": { "type": "boolean", "description": "Whether to add all Kubernetes Labels as log tags to the original log data. When enabled, the log service adds fields for all Labels in the Kubernetes Pod to the logs. For example, if the Pod contains Label source=DC and destination=CS, the logs will include fields **tag**source__: DC and **tag**destination__: CS.\n" }, "excludePodAnnotationRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex:getRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex" }, "description": "Pod Annotation Denylist is used to specify containers that are not collected. If you need to set a Pod Annotation Denylist, Key is required and Value is optional. If Value is empty, all containers under Pods whose Pod Annotation contains the specified Key are excluded. If Value is not empty, only containers under Pods whose Pod Annotation contains the Key and whose value matches the specified Value are excluded. By default, Value uses string matching, meaning it only matches when Value and the Pod Annotation value are exactly the same. If the value starts with ^ and ends with $, it is treated as a regular expression. For example, if Key is set to app and Value is set to ^(test1|test2)$, it matches containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning a Pod Annotation that matches any pair will be excluded from the collection scope. When enabling the Pod Annotation Denylist, Keys must not be duplicated. For regex fuzzy matching, you must add .*. For example, ^(http.*)$ matches strings starting with http\n" }, "excludePodLabelRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleKubernetesRuleExcludePodLabelRegex:getRuleContainerRuleKubernetesRuleExcludePodLabelRegex" }, "description": "Specify containers to exclude from collection using the Pod Label denylist. If not enabled, all containers are collected. To set a Pod Label denylist, Key is required and Value is optional. If Value is empty, all containers with the specified Key in their Pod Label are excluded from collection. If Value is not empty, only containers with the specified Key and a Value matching the Value in their Pod Label are excluded. Value supports regular expressions. For example, set Key to module and Value to ^(tcp|udp)$ to exclude containers with module:tcp or module:udp in their Pod Label. Note: The logical relationship between multiple Key-Value pairs is OR. Any Pod Label matching any Key-Value pair will be excluded from collection. When enabling the Pod Label denylist, Keys must not be duplicated. For fuzzy regular expression matching, you must add .*. For example, ^(http.*)$ matches any string starting with http\n" }, "includePodAnnotationRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex:getRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex" }, "description": "Pod Annotation Allowlist is used to specify containers to be collected. If you need to set a Pod Annotation Allowlist, Key is required and Value is optional. If Value is empty, all containers under Pods that contain the Key in Pod Annotation will match. If Value is not empty, only containers under Pods that contain the Key and whose value matches Value in Pod Annotation will match. Value defaults to string matching, meaning only when Value and the Pod Annotation value are exactly the same will they match. If the value starts with ^ and ends with $, it is a regex match. For example, set Key to app and Value to ^(test1|test2)$ to match containers under Pods with Pod Annotation app:test1 or app:test2. Note: The logical relationship between multiple Key-Value pairs is OR, meaning as long as Pod Annotation matches any pair, it will be included in the collection scope. When enabling Pod Annotation Allowlist, Keys must not be duplicated. For regex fuzzy matching, you must add .*. For example, ^(http.*)$ matches strings starting with http.\n" }, "includePodLabelRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleKubernetesRuleIncludePodLabelRegex:getRuleContainerRuleKubernetesRuleIncludePodLabelRegex" }, "description": "Pod Label Allowlist is used to specify which containers to collect. If Pod Label Allowlist is not enabled, all containers will be collected. If you need to set a Pod Label Allowlist, Key is required: if Value is empty, all containers with the Key in their Pod Label will be collected. If Value is not empty, only containers with the Key in their Pod Label and a Value matching the specified pattern will be collected; regular expression matching is supported. For example, if you set Key to module and Value to ^(tcp|udp)$, only containers with module:tcp or module:udp in their Pod Label will be collected. Note: The logical relationship between multiple key-value pairs is OR, meaning any Pod Label matching any key-value pair will be included in the collection scope. When enabling Pod Label Allowlist, Keys cannot be duplicated. For fuzzy regular expression matching, you must add .*, for example, ^(http.*)$ matches strings starting with http.\n" }, "labelTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRuleKubernetesRuleLabelTag:getRuleContainerRuleKubernetesRuleLabelTag" }, "description": "Whether to add Kubernetes labels as log tags to the raw log data. When enabled, the log service adds Kubernetes Pod label fields to the logs. Setting multiple key-value pairs adds multiple fields. For example, if you set Key to source and Value to data_source, and the Pod contains the label source=DC, the log will include the field **tag**data_source_*: DC.\n" }, "namespaceNameRegex": { "type": "string", "description": "Name of the Kubernetes Namespace to collect. If no Namespace name is specified, all containers will be collected. Namespace names support regular expression matching. For example, if you set the Namespace name to ^(tcp|udp)$, it will collect all containers under the tcp and udp namespaces.\n" }, "podNameRegex": { "type": "string", "description": "Pod name is used to specify the Pod whose containers will be collected. If no Pod name is specified, all containers will be collected. Pod name supports regular expression matching. For example, setting the Pod name to ^(http.*)$ collects all containers under Pods whose names start with http.\n" }, "workloadNameRegex": { "type": "string", "description": "Specify the container to collect by workload name. If no workload name is specified, all containers are collected. Workload names support regular expressions. For example, setting the workload name to ^(http.*)$ collects all containers under workloads starting with http.\n" }, "workloadType": { "type": "string", "description": "Specify the container to collect by workload type. Only one type can be selected. If no type is specified, containers of all types will be collected. Supported workload types: Deployment: stateless workload StatefulSet: stateful workload DaemonSet: daemon process Job: task CronJob: scheduled task\n" } }, "type": "object", "required": [ "annotationTags", "enableAllLabelTag", "excludePodAnnotationRegexes", "excludePodLabelRegexes", "includePodAnnotationRegexes", "includePodLabelRegexes", "labelTags", "namespaceNameRegex", "podNameRegex", "workloadNameRegex", "workloadType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleKubernetesRuleAnnotationTag:getRuleContainerRuleKubernetesRuleAnnotationTag": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex:getRuleContainerRuleKubernetesRuleExcludePodAnnotationRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleKubernetesRuleExcludePodLabelRegex:getRuleContainerRuleKubernetesRuleExcludePodLabelRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex:getRuleContainerRuleKubernetesRuleIncludePodAnnotationRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleKubernetesRuleIncludePodLabelRegex:getRuleContainerRuleKubernetesRuleIncludePodLabelRegex": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleContainerRuleKubernetesRuleLabelTag:getRuleContainerRuleKubernetesRuleLabelTag": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleExcludePath:getRuleExcludePath": { "properties": { "type": { "type": "string", "description": "Collection path type. File: File name. Path: Directory.\n" }, "value": { "type": "string", "description": "Collection path. Must be specified as an absolute path. When Type is Path, Value indicates a directory. When Type is File, Value indicates a file name.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleExtractRule:getRuleExtractRule": { "properties": { "beginRegex": { "type": "string", "description": "Regular expression that the first line of the log must match. Valid only when LogType is multiline*log or fullregex*log. Must be a valid regular expression.\n" }, "delimiter": { "type": "string", "description": "Log delimiter. Valid only when LogType is delimiter_log.\n" }, "enableNanosecond": { "type": "boolean", "description": "Enable nanosecond precision time. When enabled, log time parsing will include and report nanosecond precision. true: Enable nanosecond precision time. false: Disable nanosecond precision time.\n" }, "filterKeyRegexes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleExtractRuleFilterKeyRegex:getRuleExtractRuleFilterKeyRegex" }, "description": "Filter rule list. When LogType is minimalist*log or multiline*log, you can configure up to 1 filter rule, and the filter field name key must be content. When LogType is delimiter*log, json*log, or fullregex*log, you can configure up to 5 filter rules, and the filter field name key cannot be duplicated or empty. The regular expression for the filter field's log content must be a valid regular expression and is limited to 256 characters.\n" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of log field names (Key). This is only valid when LogType is delimiter*log or fullregex*log. You can configure up to 100 field names. When LogType is delimiter*log, field names must be unique and cannot all be empty. When LogType is fullregex*log, field names must be unique and cannot be empty.\n" }, "logRegex": { "type": "string", "description": "The entire log must match the specified regular expression. This is only valid when the collected log type is fullregex_log. Must be a valid regular expression.\n" }, "logTemplate": { "$ref": "#/types/volcenginecc:tls/getRuleExtractRuleLogTemplate:getRuleExtractRuleLogTemplate", "description": "Automatically extract log fields based on the specified log template\n" }, "quote": { "type": "string", "description": "Quoting character. Content wrapped by a quoting character will not be split but parsed as a complete field. Only valid when LogType is delimiter_log.\n" }, "timeExtractRegex": { "type": "string", "description": "Regular expression for extracting time, used to extract the time value from the TimeKey field and parse it as the collection time\n" }, "timeFormat": { "type": "string", "description": "Parsing format for the time field. If you use a specific time field in the log as the log timestamp, you must provide both TimeKey and TimeFormat. TimeKey and TimeFormat must be used together.\n" }, "timeKey": { "type": "string", "description": "Name of the log time field. If you want to use a specific time field in the log as the log timestamp, you need to specify both TimeKey and TimeFormat. TimeKey and TimeFormat must be provided together.\n" }, "timeSample": { "type": "string", "description": "Time sample. Used to check whether the entered time parsing format is correct.\n" }, "timeZone": { "type": "string", "description": "Time zone. Supports machine time zone (default) and custom time zone. Custom time zone supports GMT and UTC. GMT format: GMT+08:00. UTC format: Asia/Shanghai.\n" }, "unMatchLogKey": { "type": "string", "description": "Key name for unmatched logs.\n" }, "unMatchUpLoadSwitch": { "type": "boolean", "description": "Switch for uploading unmatched logs.\n" } }, "type": "object", "required": [ "beginRegex", "delimiter", "enableNanosecond", "filterKeyRegexes", "keys", "logRegex", "logTemplate", "quote", "timeExtractRegex", "timeFormat", "timeKey", "timeSample", "timeZone", "unMatchLogKey", "unMatchUpLoadSwitch" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleExtractRuleFilterKeyRegex:getRuleExtractRuleFilterKeyRegex": { "properties": { "key": { "type": "string", "description": "Name of the filter field.\n" }, "regex": { "type": "string", "description": "The log content of the filter field must match the specified regular expression.\n" } }, "type": "object", "required": [ "key", "regex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleExtractRuleLogTemplate:getRuleExtractRuleLogTemplate": { "properties": { "format": { "type": "string", "description": "Log template format.\n" }, "type": { "type": "string", "description": "Log template types. Supported types: Nginx: Nginx log template.\n" } }, "type": "object", "required": [ "format", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleHostGroupInfo:getRuleHostGroupInfo": { "properties": { "abnormalHeartbeatStatusCount": { "type": "integer", "description": "Number of hosts with heartbeat exceptions.\n" }, "agentLatestVersion": { "type": "string", "description": "Latest agent version.\n" }, "autoUpdate": { "type": "boolean", "description": "Whether LogCollector installed on the machine group server has automatic upgrade enabled. true: The log service will check for upgrades during a specified time period each day. If upgrade conditions are met, LogCollector will be upgraded automatically without manual intervention. false (default): LogCollector does not upgrade automatically. To use a newer version of LogCollector, refer to the LogCollector upgrade procedure.\n" }, "createTime": { "type": "string", "description": "Machine group creation time.\n" }, "hostCount": { "type": "integer", "description": "Number of hosts.\n" }, "hostGroupId": { "type": "string", "description": "Machine group ID\n" }, "hostGroupName": { "type": "string", "description": "Name of the machine group.\n" }, "hostGroupType": { "type": "string", "description": "Machine group type. IP: Machine IP. Label: Machine label.\n" }, "hostIdentifier": { "type": "string", "description": "Machine identifier.\n" }, "iamProjectName": { "type": "string", "description": "The IAM project to which the host group belongs.\n" }, "modifyTime": { "type": "string", "description": "Time when the machine group was modified.\n" }, "normalHeartbeatStatusCount": { "type": "integer", "description": "Number of hosts with normal heartbeat.\n" }, "ruleCount": { "type": "integer", "description": "The number of bound collection configurations.\n" }, "serviceLogging": { "type": "boolean", "description": "Whether to enable the Logcollector service log feature. true: enabled. false (default): disabled.\n" }, "updateEndTime": { "type": "string", "description": "End time for LogCollector automatic upgrade.\n" }, "updateStartTime": { "type": "string", "description": "LogCollector auto-update start time. Note: Only required when AutoUpdate is set to true. It is recommended to schedule auto-updates during off-peak hours. LogCollector may restart during the update process, but logs will not be lost.\n" } }, "type": "object", "required": [ "abnormalHeartbeatStatusCount", "agentLatestVersion", "autoUpdate", "createTime", "hostCount", "hostGroupId", "hostGroupName", "hostGroupType", "hostIdentifier", "iamProjectName", "modifyTime", "normalHeartbeatStatusCount", "ruleCount", "serviceLogging", "updateEndTime", "updateStartTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleUserDefineRule:getRuleUserDefineRule": { "properties": { "advanced": { "$ref": "#/types/volcenginecc:tls/getRuleUserDefineRuleAdvanced:getRuleUserDefineRuleAdvanced", "description": "The Advanced parameter is used for extended configuration. After enabling extended configuration, you can customize advanced behaviors of LogCollector, such as when to release file handles. Note: If multiple release conditions are specified, the handle is released and log file monitoring ends as soon as any condition is met.\n" }, "enableHostGroupLabel": { "type": "boolean", "description": "Whether to upload the label information of the host group to the log service. The default is off. true: LogCollector uploads the label information of the host group to the specified field. You can specify the field name in the HostGroupLabelKey parameter. false (default): Host group label information is not uploaded.\n" }, "enableHostname": { "type": "boolean", "description": "Upload the hostname field. Default is disabled. true: Add a field to the original log to record the source hostname. Specify the hostname field name using HostnameKey. false: (default) Do not add the hostname field.\n" }, "enableRawLog": { "type": "boolean", "description": "Upload raw logs. true: Upload raw logs. false (default): Do not upload raw logs.\n" }, "fields": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/getRuleUserDefineRuleField:getRuleUserDefineRuleField" }, "description": "Add constant fields to logs. Constant fields must follow these restrictions: You can upload up to 5 constant fields. Field names (Key) must be unique and not empty. Length limit: 1–128 characters, including letters, numbers, and special characters (-*./), and cannot start with an underscore. Field values (Value) must not be empty, with a maximum length of 512 KiB.\n" }, "hostGroupLabelKey": { "type": "string", "description": "Field name used to store machine group label information\n" }, "hostnameKey": { "type": "string", "description": "Hostname field name. Required only when EnableHostname is true.\n" }, "ignoreOlder": { "type": "integer", "description": "Ignore log files that have not been updated for a specified period (in hours).\n" }, "multiCollectsType": { "type": "string", "description": "Allow multiple log file collections. Empty: Use log file ID (including file inode, device, and checksum of the first N bytes) to uniquely identify the log file. RuleID: Use collection rule ID and log file ID to uniquely identify the log file. TopicIDRuleName: Use log topic ID, collection rule name, and log file ID to uniquely identify the log file.\n" }, "parsePathRule": { "$ref": "#/types/volcenginecc:tls/getRuleUserDefineRuleParsePathRule:getRuleUserDefineRuleParsePathRule", "description": "Rule for parsing the collection path. After setting the rule, fields in the collection path are extracted using the specified regular expression and added as metadata to the log data. Note: This parameter is not supported when collecting container standard output.\n" }, "plugin": { "$ref": "#/types/volcenginecc:tls/getRuleUserDefineRulePlugin:getRuleUserDefineRulePlugin", "description": "LogCollector plugin configuration. After enabling plugin configuration, you can add one or more LogCollector processor plugins to parse logs with complex or variable structures.\n" }, "rawLogKey": { "type": "string", "description": "Name of the raw log field. Only effective when EnableRawLog is set to true. RawLogKey defaults to **raw**, meaning the original log data will be encapsulated in the **raw** field and uploaded to the log service along with the parsed log data.\n" }, "shardHashKey": { "$ref": "#/types/volcenginecc:tls/getRuleUserDefineRuleShardHashKey:getRuleUserDefineRuleShardHashKey", "description": "Rules for routing log partitions. If this parameter is not set, logs are written using the default load balancing mode, and packets are written to any available Shard. If this parameter is set, logs are collected using the HashKey routing Shard mode, and the log service writes data to the Shard containing the specified Key value\n" }, "tailFiles": { "type": "boolean", "description": "LogCollector collection policy, which specifies whether LogCollector collects incremental logs or full logs. Default is false, meaning full log collection. true: incremental collection. LogCollector only collects newly added content in the file. When new logs are written to monitored log files, LogCollector triggers log collection. For first-time collection, LogCollector automatically determines the collection position based on the incremental threshold TailSizeKb you specify. If the new file size does not exceed the incremental threshold, collection starts from the beginning of the file. If the new file size exceeds the incremental threshold, collection starts from the position at the end of the file minus the incremental threshold, collecting only incremental logs. For subsequent collections, LogCollector determines the collection position based on Checkpoint and continues collecting. false: (default) full collection. LogCollector collects logs from the beginning of each file, including historical log data.\n" }, "tailSizeKb": { "type": "integer", "description": "Backtracking threshold for incremental collection, in KiB. When LogCollector uses incremental collection, for the first collection of a log file: If the new log file size does not exceed the TailSizeKb value, collection starts from the beginning of the file. If the new log file size exceeds the TailSizeKb value, collection starts from the position that is TailSizeKb from the end of the file.\n" } }, "type": "object", "required": [ "advanced", "enableHostGroupLabel", "enableHostname", "enableRawLog", "fields", "hostGroupLabelKey", "hostnameKey", "ignoreOlder", "multiCollectsType", "parsePathRule", "plugin", "rawLogKey", "shardHashKey", "tailFiles", "tailSizeKb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleUserDefineRuleAdvanced:getRuleUserDefineRuleAdvanced": { "properties": { "closeEof": { "type": "boolean", "description": "After reading to the end of the log file, choose whether to release the file handle. Default is false.\n" }, "closeInactive": { "type": "integer", "description": "Wait time to release log file handle. If no new logs are written to the log file within the specified time, the handle for that log file is released. Unit: seconds. Range: 1–300 seconds. Default: 60 seconds.\n" }, "closeRemoved": { "type": "boolean", "description": "Release the file handle after the log file is removed. Default is false.\n" }, "closeRenamed": { "type": "boolean", "description": "Release the file handle after the log file is renamed. Default is false.\n" }, "closeTimeout": { "type": "integer", "description": "Maximum monitoring duration for LogCollector log files, in seconds. The default is 0 seconds, meaning LogCollector does not limit the monitoring duration for log files. Timing starts when LogCollector begins monitoring the log file. Once the specified duration is exceeded, LogCollector immediately releases the file handle and stops monitoring, regardless of whether the log file has been fully read.\n" }, "noLineTerminatorEofMaxTime": { "type": "integer", "description": "Maximum wait time when LogCollector does not detect a line break, in seconds. The default is 5s. Timing starts when LogCollector begins reading the log file. If no line break is detected within the specified time, LogCollector sends the logs in the buffer. If the file write interval is long, a complete log entry may be split into two parts and written separately. Adjust this parameter based on your log write interval.\n" } }, "type": "object", "required": [ "closeEof", "closeInactive", "closeRemoved", "closeRenamed", "closeTimeout", "noLineTerminatorEofMaxTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleUserDefineRuleField:getRuleUserDefineRuleField": { "properties": { "key": { "type": "string", "description": "Key.\n" }, "val": { "type": "string", "description": "Value.\n" } }, "type": "object", "required": [ "key", "val" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleUserDefineRuleParsePathRule:getRuleUserDefineRuleParsePathRule": { "properties": { "keys": { "type": "array", "items": { "type": "string" }, "description": "Field name list. The log service uses a regular expression (Regex) to parse the path sample (PathSample) into multiple fields. Keys specify the name of each field. You can configure up to 100 field names. Field names cannot be empty or duplicated.\n" }, "pathSample": { "type": "string", "description": "Sample collection path for actual scenarios. The sample collection path must be an absolute path. Wildcards *, ?, ** are not allowed in the path sample.\n" }, "regex": { "type": "string", "description": "Regular expression used to extract the path field. Must match the sample collection path, otherwise extraction will fail\n" } }, "type": "object", "required": [ "keys", "pathSample", "regex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleUserDefineRulePlugin:getRuleUserDefineRulePlugin": { "properties": { "processors": { "type": "string", "description": "LogCollector plugin. For the list of supported plugins and parameter descriptions, see LogCollector plugin overview.\n" } }, "type": "object", "required": [ "processors" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getRuleUserDefineRuleShardHashKey:getRuleUserDefineRuleShardHashKey": { "properties": { "hashKey": { "type": "string", "description": "HashKey of the log group, used to specify the shard to which the current log group will be written. The value range for this parameter is [00000000000000000000000000000000-ffffffffffffffffffffffffffffffff).\n" } }, "type": "object", "required": [ "hashKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getScheduleSqlTaskRequestCycle:getScheduleSqlTaskRequestCycle": { "properties": { "cronTab": { "type": "string", "description": "Cron expression, with a minimum granularity of minutes, using 24-hour format. For example, 0 18 * * * means execution at 18:00 every day.\n" }, "cronTimeZone": { "type": "string", "description": "If Type is set to Cron, you must also set the time zone.\n" }, "time": { "type": "integer", "description": "Scheduling period or the time point for periodic execution (minutes from 00:00). Range: 1–1440 minutes.\n" }, "type": { "type": "string", "description": "Scheduling period type. Options: Period, Fixed, Cron.\n" } }, "type": "object", "required": [ "cronTab", "cronTimeZone", "time", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getShipperContentInfo:getShipperContentInfo": { "properties": { "csvInfo": { "$ref": "#/types/volcenginecc:tls/getShipperContentInfoCsvInfo:getShipperContentInfoCsvInfo", "description": "CSV format log content configuration.\n" }, "format": { "type": "string", "description": "Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.\n" }, "jsonInfo": { "$ref": "#/types/volcenginecc:tls/getShipperContentInfoJsonInfo:getShipperContentInfoJsonInfo", "description": "JSON/JSONL format log content configuration.\n" } }, "type": "object", "required": [ "csvInfo", "format", "jsonInfo" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getShipperContentInfoCsvInfo:getShipperContentInfoCsvInfo": { "properties": { "delimiter": { "type": "string", "description": "Delimiter. Supports comma, tab, pipe, semicolon, space.\n" }, "escapeChar": { "type": "string", "description": "Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.\n" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.\n" }, "nonFieldContent": { "type": "string", "description": "Content for invalid field padding. Length: 0–128.\n" }, "printHeader": { "type": "boolean", "description": "Whether to print the key in the first row.\n" } }, "type": "object", "required": [ "delimiter", "escapeChar", "keys", "nonFieldContent", "printHeader" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getShipperContentInfoJsonInfo:getShipperContentInfoJsonInfo": { "properties": { "enable": { "type": "boolean", "description": "Enable flag.\n" }, "escape": { "type": "boolean", "description": "Whether to enable escaping. Must be set to true.\n" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including **content** (required), **source**, **path**, **time**, **image_name**, **container_name**, **pod_name**, **pod_uid**, namespace, **tag****client_ip**, and **tag****receive_time**.\n" } }, "type": "object", "required": [ "enable", "escape", "keys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getShipperKafkaShipperInfo:getShipperKafkaShipperInfo": { "properties": { "compress": { "type": "string", "description": "Compression format; supports snappy, gzip, lz4, none.\n" }, "endTime": { "type": "integer", "description": "Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.\n" }, "instance": { "type": "string", "description": "Kafka instance.\n" }, "kafkaTopic": { "type": "string", "description": "Kafka topic name. All log data delivered through this configuration will be sent to this topic.\n" }, "startTime": { "type": "integer", "description": "Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n" } }, "type": "object", "required": [ "compress", "endTime", "instance", "kafkaTopic", "startTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getShipperTosShipperInfo:getShipperTosShipperInfo": { "properties": { "bucket": { "type": "string", "description": "Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.\n" }, "compress": { "type": "string", "description": "Compression format; supports snappy, gzip, lz4, none.\n" }, "interval": { "type": "integer", "description": "Delivery interval in seconds, range: 300–900.\n" }, "maxSize": { "type": "integer", "description": "Maximum raw file size per partition for delivery, in MiB. Range: 5–256.\n" }, "partitionFormat": { "type": "string", "description": "Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.\n" }, "prefix": { "type": "string", "description": "Top-level directory name for the bucket. Cannot start with / or \\, and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.\n" } }, "type": "object", "required": [ "bucket", "compress", "interval", "maxSize", "partitionFormat", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tls/getTopicTag:getTopicTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/BucketAcl:BucketAcl": { "properties": { "bucketAclDelivered": { "type": "boolean", "description": "Enable object default bucket ACL inheritance. true: Enable object default bucket ACL inheritance. false: Disable object default bucket ACL inheritance.\n" }, "grants": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketAclGrant:BucketAclGrant" } }, "owner": { "$ref": "#/types/volcenginecc:tos/BucketAclOwner:BucketAclOwner", "description": "Object owner\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucketAclDelivered", "grants", "owner" ] } } }, "volcenginecc:tos/BucketAclGrant:BucketAclGrant": { "properties": { "acl": { "type": "string", "description": "Bucket access permissions. Includes private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write, bucket-owner-entrusted, default.\n" }, "grantFullControl": { "type": "string", "description": "Grant all permissions to the specified user\n" }, "grantRead": { "type": "string", "description": "Grant read permission to the specified user\n" }, "grantReadAcp": { "type": "string", "description": "Grant permission to specified user to view bucket ACL\n" }, "grantWrite": { "type": "string", "description": "Grant write permission to specified user\n" }, "grantWriteAcp": { "type": "string", "description": "Grant permission to the specified user to modify and delete bucket ACL\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "acl", "grantFullControl", "grantRead", "grantReadAcp", "grantWrite", "grantWriteAcp" ] } } }, "volcenginecc:tos/BucketAclGrantGrantee:BucketAclGrantGrantee": { "properties": { "canned": { "type": "string", "description": "Predefined groups. Includes AllUsers, AuthenticatedUsers\n" }, "displayName": { "type": "string", "description": "Display name\n" }, "granteeId": { "type": "string", "description": "Account ID\n" }, "type": { "type": "string", "description": "User type. Includes Group, CanonicalUser\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "canned", "displayName", "granteeId", "type" ] } } }, "volcenginecc:tos/BucketAclOwner:BucketAclOwner": { "properties": { "displayName": { "type": "string", "description": "Display name\n" }, "ownerId": { "type": "string", "description": "Account ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "ownerId" ] } } }, "volcenginecc:tos/BucketInventoryDestination:BucketInventoryDestination": { "properties": { "tosBucketDestination": { "$ref": "#/types/volcenginecc:tos/BucketInventoryDestinationTosBucketDestination:BucketInventoryDestinationTosBucketDestination", "description": "Bucket information related to the inventory files.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "tosBucketDestination" ] } } }, "volcenginecc:tos/BucketInventoryDestinationTosBucketDestination:BucketInventoryDestinationTosBucketDestination": { "properties": { "accountId": { "type": "string", "description": "Account ID of the bucket owner.\n" }, "bucket": { "type": "string", "description": "Specify the bucket to store the inventory files.\n" }, "format": { "type": "string", "description": "Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.\n" }, "prefix": { "type": "string", "description": "Prefix for the storage path of inventory files. By default, files are saved under tos*bucket*inventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.\n" }, "role": { "type": "string", "description": "Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountId", "bucket", "format", "prefix", "role" ] } } }, "volcenginecc:tos/BucketInventoryFilter:BucketInventoryFilter": { "properties": { "prefix": { "type": "string", "description": "Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "prefix" ] } } }, "volcenginecc:tos/BucketInventoryOptionalFields:BucketInventoryOptionalFields": { "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "Information about exported inventory files.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fields" ] } } }, "volcenginecc:tos/BucketInventorySchedule:BucketInventorySchedule": { "properties": { "frequency": { "type": "string", "description": "Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "frequency" ] } } }, "volcenginecc:tos/BucketLifecycleConfig:BucketLifecycleConfig": { "properties": { "abortInCompleteMultipartUpload": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfigAbortInCompleteMultipartUpload:BucketLifecycleConfigAbortInCompleteMultipartUpload", "description": "Specify expiration attributes for unmerged multipart tasks (fragments)\n" }, "expiration": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfigExpiration:BucketLifecycleConfigExpiration", "description": "Expiration attribute for deleting the latest version object in the lifecycle rule based on last modified time\n" }, "filter": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfigFilter:BucketLifecycleConfigFilter", "description": "Filter conditions for applying the rule\n" }, "lifecycleRuleId": { "type": "string", "description": "Rule ID\n" }, "noCurrentVersionExpiration": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfigNoCurrentVersionExpiration:BucketLifecycleConfigNoCurrentVersionExpiration" }, "nonCurrentVersionTransitions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfigNonCurrentVersionTransition:BucketLifecycleConfigNonCurrentVersionTransition" } }, "prefix": { "type": "string", "description": "Prefix to which the rule applies\n" }, "status": { "type": "string", "description": "Enable rule. Includes Enabled, Disabled.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfigTag:BucketLifecycleConfigTag" } }, "transitions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfigTransition:BucketLifecycleConfigTransition" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "abortInCompleteMultipartUpload", "expiration", "filter", "lifecycleRuleId", "noCurrentVersionExpiration", "nonCurrentVersionTransitions", "prefix", "status", "tags", "transitions" ] } } }, "volcenginecc:tos/BucketLifecycleConfigAbortInCompleteMultipartUpload:BucketLifecycleConfigAbortInCompleteMultipartUpload": { "properties": { "daysAfterInitiation": { "type": "integer", "description": "Specify lifecycle rule for unmerged multipart tasks (fragments), number of days to delete after task initialization\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "daysAfterInitiation" ] } } }, "volcenginecc:tos/BucketLifecycleConfigExpiration:BucketLifecycleConfigExpiration": { "properties": { "date": { "type": "string", "description": "Specific date for deleting the latest version object in the lifecycle rule based on last modified time\n" }, "days": { "type": "integer", "description": "Number of days for deleting the latest version object based on last modified time in lifecycle rules\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "date", "days" ] } } }, "volcenginecc:tos/BucketLifecycleConfigFilter:BucketLifecycleConfigFilter": { "properties": { "greaterThanIncludeEqual": { "type": "string", "description": "Equality condition status. Includes Enabled, Disabled\n" }, "lessThanIncludeEqual": { "type": "string", "description": "Equality condition status. Includes Enabled, Disabled\n" }, "objectSizeGreaterThan": { "type": "integer", "description": "Apply rule to objects larger than the specified size\n" }, "objectSizeLessThan": { "type": "integer", "description": "Apply rule to objects smaller than the specified size\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "greaterThanIncludeEqual", "lessThanIncludeEqual", "objectSizeGreaterThan", "objectSizeLessThan" ] } } }, "volcenginecc:tos/BucketLifecycleConfigNoCurrentVersionExpiration:BucketLifecycleConfigNoCurrentVersionExpiration": { "properties": { "nonCurrentDate": { "type": "string", "description": "Specific date for deleting historical version objects in the lifecycle rule based on last modified time\n" }, "nonCurrentDays": { "type": "integer", "description": "Number of days to delete historical version objects in the lifecycle rule based on last modified time\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nonCurrentDate", "nonCurrentDays" ] } } }, "volcenginecc:tos/BucketLifecycleConfigNonCurrentVersionTransition:BucketLifecycleConfigNonCurrentVersionTransition": { "properties": { "nonCurrentDate": { "type": "string", "description": "Specific date for historical version object transition in lifecycle rules based on last modified time\n" }, "nonCurrentDays": { "type": "integer", "description": "Number of days to transition historical version objects in the lifecycle rule based on last modified time\n" }, "storageClass": { "type": "string", "description": "Storage class. Includes STANDARD, IA, ARCHIVE*FR, INTELLIGENT*TIERING, COLD*ARCHIVE, ARCHIVE, DEEP*COLD_ARCHIVE\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nonCurrentDate", "nonCurrentDays", "storageClass" ] } } }, "volcenginecc:tos/BucketLifecycleConfigTag:BucketLifecycleConfigTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tos/BucketLifecycleConfigTransition:BucketLifecycleConfigTransition": { "properties": { "date": { "type": "string", "description": "Specific date for latest version object transition in lifecycle rules based on last modified time\n" }, "days": { "type": "integer", "description": "Number of days to transition the latest version object in the lifecycle rule based on last modified time\n" }, "storageClass": { "type": "string", "description": "Storage class for historical version object transition in lifecycle rules based on last modified time. Includes STANDARD, IA, ARCHIVE*FR, INTELLIGENT*TIERING, COLD*ARCHIVE, ARCHIVE, DEEP*COLD_ARCHIVE\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "date", "days", "storageClass" ] } } }, "volcenginecc:tos/BucketTag:BucketTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:tos/getBucketAcl:getBucketAcl": { "properties": { "bucketAclDelivered": { "type": "boolean", "description": "Enable object default bucket ACL inheritance. true: Enable object default bucket ACL inheritance. false: Disable object default bucket ACL inheritance.\n" }, "grants": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/getBucketAclGrant:getBucketAclGrant" }, "description": "Root node for object access control permissions\n" }, "owner": { "$ref": "#/types/volcenginecc:tos/getBucketAclOwner:getBucketAclOwner", "description": "Object owner\n" } }, "type": "object", "required": [ "bucketAclDelivered", "grants", "owner" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketAclGrant:getBucketAclGrant": { "properties": { "acl": { "type": "string", "description": "Bucket access permissions. Includes private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write, bucket-owner-entrusted, default.\n" }, "grantFullControl": { "type": "string", "description": "Grant all permissions to the specified user\n" }, "grantRead": { "type": "string", "description": "Grant read permission to the specified user\n" }, "grantReadAcp": { "type": "string", "description": "Grant permission to specified user to view bucket ACL\n" }, "grantWrite": { "type": "string", "description": "Grant write permission to specified user\n" }, "grantWriteAcp": { "type": "string", "description": "Grant permission to the specified user to modify and delete bucket ACL\n" } }, "type": "object", "required": [ "acl", "grantFullControl", "grantRead", "grantReadAcp", "grantWrite", "grantWriteAcp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketAclGrantGrantee:getBucketAclGrantGrantee": { "properties": { "canned": { "type": "string", "description": "Predefined groups. Includes AllUsers, AuthenticatedUsers\n" }, "displayName": { "type": "string", "description": "Display name\n" }, "granteeId": { "type": "string", "description": "Account ID\n" }, "type": { "type": "string", "description": "User type. Includes Group, CanonicalUser\n" } }, "type": "object", "required": [ "canned", "displayName", "granteeId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketAclOwner:getBucketAclOwner": { "properties": { "displayName": { "type": "string", "description": "Display name\n" }, "ownerId": { "type": "string", "description": "Account ID\n" } }, "type": "object", "required": [ "displayName", "ownerId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketInventoryDestination:getBucketInventoryDestination": { "properties": { "tosBucketDestination": { "$ref": "#/types/volcenginecc:tos/getBucketInventoryDestinationTosBucketDestination:getBucketInventoryDestinationTosBucketDestination", "description": "Bucket information related to the inventory files.\n" } }, "type": "object", "required": [ "tosBucketDestination" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketInventoryDestinationTosBucketDestination:getBucketInventoryDestinationTosBucketDestination": { "properties": { "accountId": { "type": "string", "description": "Account ID of the bucket owner.\n" }, "bucket": { "type": "string", "description": "Specify the bucket to store the inventory files.\n" }, "format": { "type": "string", "description": "Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.\n" }, "prefix": { "type": "string", "description": "Prefix for the storage path of inventory files. By default, files are saved under tos*bucket*inventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.\n" }, "role": { "type": "string", "description": "Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.\n" } }, "type": "object", "required": [ "accountId", "bucket", "format", "prefix", "role" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketInventoryFilter:getBucketInventoryFilter": { "properties": { "prefix": { "type": "string", "description": "Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.\n" } }, "type": "object", "required": [ "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketInventoryOptionalFields:getBucketInventoryOptionalFields": { "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "Information about exported inventory files.\n" } }, "type": "object", "required": [ "fields" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketInventorySchedule:getBucketInventorySchedule": { "properties": { "frequency": { "type": "string", "description": "Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.\n" } }, "type": "object", "required": [ "frequency" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketLifecycleConfig:getBucketLifecycleConfig": { "properties": { "abortInCompleteMultipartUpload": { "$ref": "#/types/volcenginecc:tos/getBucketLifecycleConfigAbortInCompleteMultipartUpload:getBucketLifecycleConfigAbortInCompleteMultipartUpload", "description": "Specify expiration attributes for unmerged multipart tasks (fragments)\n" }, "expiration": { "$ref": "#/types/volcenginecc:tos/getBucketLifecycleConfigExpiration:getBucketLifecycleConfigExpiration", "description": "Expiration attribute for deleting the latest version object in the lifecycle rule based on last modified time\n" }, "filter": { "$ref": "#/types/volcenginecc:tos/getBucketLifecycleConfigFilter:getBucketLifecycleConfigFilter", "description": "Filter conditions for applying the rule\n" }, "lifecycleRuleId": { "type": "string", "description": "Rule ID\n" }, "noCurrentVersionExpiration": { "$ref": "#/types/volcenginecc:tos/getBucketLifecycleConfigNoCurrentVersionExpiration:getBucketLifecycleConfigNoCurrentVersionExpiration" }, "nonCurrentVersionTransitions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/getBucketLifecycleConfigNonCurrentVersionTransition:getBucketLifecycleConfigNonCurrentVersionTransition" }, "description": "Expiration attribute for transitioning historical version objects in the lifecycle rule based on last modified time\n" }, "prefix": { "type": "string", "description": "Prefix to which the rule applies\n" }, "status": { "type": "string", "description": "Enable rule. Includes Enabled, Disabled.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/getBucketLifecycleConfigTag:getBucketLifecycleConfigTag" }, "description": "Tag\n" }, "transitions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/getBucketLifecycleConfigTransition:getBucketLifecycleConfigTransition" }, "description": "Expiration attribute for transitioning the latest version object in the lifecycle rule based on last modified time\n" } }, "type": "object", "required": [ "abortInCompleteMultipartUpload", "expiration", "filter", "lifecycleRuleId", "noCurrentVersionExpiration", "nonCurrentVersionTransitions", "prefix", "status", "tags", "transitions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketLifecycleConfigAbortInCompleteMultipartUpload:getBucketLifecycleConfigAbortInCompleteMultipartUpload": { "properties": { "daysAfterInitiation": { "type": "integer", "description": "Specify lifecycle rule for unmerged multipart tasks (fragments), number of days to delete after task initialization\n" } }, "type": "object", "required": [ "daysAfterInitiation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketLifecycleConfigExpiration:getBucketLifecycleConfigExpiration": { "properties": { "date": { "type": "string", "description": "Specific date for deleting the latest version object in the lifecycle rule based on last modified time\n" }, "days": { "type": "integer", "description": "Number of days for deleting the latest version object based on last modified time in lifecycle rules\n" } }, "type": "object", "required": [ "date", "days" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketLifecycleConfigFilter:getBucketLifecycleConfigFilter": { "properties": { "greaterThanIncludeEqual": { "type": "string", "description": "Equality condition status. Includes Enabled, Disabled\n" }, "lessThanIncludeEqual": { "type": "string", "description": "Equality condition status. Includes Enabled, Disabled\n" }, "objectSizeGreaterThan": { "type": "integer", "description": "Apply rule to objects larger than the specified size\n" }, "objectSizeLessThan": { "type": "integer", "description": "Apply rule to objects smaller than the specified size\n" } }, "type": "object", "required": [ "greaterThanIncludeEqual", "lessThanIncludeEqual", "objectSizeGreaterThan", "objectSizeLessThan" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketLifecycleConfigNoCurrentVersionExpiration:getBucketLifecycleConfigNoCurrentVersionExpiration": { "properties": { "nonCurrentDate": { "type": "string", "description": "Specific date for deleting historical version objects in the lifecycle rule based on last modified time\n" }, "nonCurrentDays": { "type": "integer", "description": "Number of days to delete historical version objects in the lifecycle rule based on last modified time\n" } }, "type": "object", "required": [ "nonCurrentDate", "nonCurrentDays" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketLifecycleConfigNonCurrentVersionTransition:getBucketLifecycleConfigNonCurrentVersionTransition": { "properties": { "nonCurrentDate": { "type": "string", "description": "Specific date for historical version object transition in lifecycle rules based on last modified time\n" }, "nonCurrentDays": { "type": "integer", "description": "Number of days to transition historical version objects in the lifecycle rule based on last modified time\n" }, "storageClass": { "type": "string", "description": "Storage class. Includes STANDARD, IA, ARCHIVE*FR, INTELLIGENT*TIERING, COLD*ARCHIVE, ARCHIVE, DEEP*COLD_ARCHIVE\n" } }, "type": "object", "required": [ "nonCurrentDate", "nonCurrentDays", "storageClass" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketLifecycleConfigTag:getBucketLifecycleConfigTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketLifecycleConfigTransition:getBucketLifecycleConfigTransition": { "properties": { "date": { "type": "string", "description": "Specific date for latest version object transition in lifecycle rules based on last modified time\n" }, "days": { "type": "integer", "description": "Number of days to transition the latest version object in the lifecycle rule based on last modified time\n" }, "storageClass": { "type": "string", "description": "Storage class for historical version object transition in lifecycle rules based on last modified time. Includes STANDARD, IA, ARCHIVE*FR, INTELLIGENT*TIERING, COLD*ARCHIVE, ARCHIVE, DEEP*COLD_ARCHIVE\n" } }, "type": "object", "required": [ "date", "days", "storageClass" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:tos/getBucketTag:getBucketTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:transitrouter/PeerAttachmentTag:PeerAttachmentTag": { "properties": { "key": { "type": "string", "description": "Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.\n" }, "value": { "type": "string", "description": "Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:transitrouter/TransitRouterAttachment:TransitRouterAttachment": { "properties": { "autoPublishRouteEnabled": { "type": "boolean", "description": "Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.\n" }, "businessStatus": { "type": "string", "description": "Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.\n" }, "creationTime": { "type": "string", "description": "Creation time of the network instance connection.\n" }, "deletedTime": { "type": "string", "description": "Deletion time of the network instance connection.\n" }, "description": { "type": "string", "description": "Description of the network instance connection.\n" }, "ipv6Enabled": { "type": "boolean", "description": "Whether IPv6 is enabled. true: yes. false: no\n" }, "overdueTime": { "type": "string", "description": "Shutdown time due to overdue payment for the network instance connection\n" }, "resourceId": { "type": "string", "description": "ID of the network instance\n" }, "resourceType": { "type": "string", "description": "Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router\n" }, "status": { "type": "string", "description": "Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/TransitRouterAttachmentTag:TransitRouterAttachmentTag" } }, "transitRouterAttachmentId": { "type": "string", "description": "Network instance connection ID.\n" }, "transitRouterAttachmentName": { "type": "string", "description": "Name of the network instance connection\n" }, "transitRouterForwardPolicyTableId": { "type": "string", "description": "ID of the forwarding policy associated with the cross-region connection\n" }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "transitRouterRouteTableId": { "type": "string", "description": "Route table ID associated with the forwarding of the network instance connection.\n" }, "transitRouterTrafficQosMarkingPolicyId": { "type": "string", "description": "ID of the flow marking policy associated with the cross-region connection\n" }, "transitRouterTrafficQosQueuePolicyId": { "type": "string", "description": "ID of the flow queue policy associated with the cross-region connection\n" }, "updateTime": { "type": "string", "description": "Last operation time of the network instance connection\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoPublishRouteEnabled", "businessStatus", "creationTime", "deletedTime", "description", "ipv6Enabled", "overdueTime", "resourceId", "resourceType", "status", "tags", "transitRouterAttachmentId", "transitRouterAttachmentName", "transitRouterForwardPolicyTableId", "transitRouterId", "transitRouterRouteTableId", "transitRouterTrafficQosMarkingPolicyId", "transitRouterTrafficQosQueuePolicyId", "updateTime" ] } } }, "volcenginecc:transitrouter/TransitRouterAttachmentTag:TransitRouterAttachmentTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:transitrouter/TransitRouterRouteTableTag:TransitRouterRouteTableTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:transitrouter/TransitRouterTag:TransitRouterTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:transitrouter/VpcAttachmentAttachPoint:VpcAttachmentAttachPoint": { "properties": { "subnetId": { "type": "string", "description": "Subnet ID of the connection point.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the connection point.\n" } }, "type": "object", "required": [ "subnetId", "zoneId" ] }, "volcenginecc:transitrouter/VpcAttachmentTag:VpcAttachmentTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tag.\n" }, "value": { "type": "string", "description": "Tag value for user tag.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:transitrouter/VpnAttachmentTag:VpnAttachmentTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:transitrouter/getPeerAttachmentTag:getPeerAttachmentTag": { "properties": { "key": { "type": "string", "description": "Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.\n" }, "value": { "type": "string", "description": "Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:transitrouter/getTransitRouterAttachment:getTransitRouterAttachment": { "properties": { "autoPublishRouteEnabled": { "type": "boolean", "description": "Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.\n" }, "businessStatus": { "type": "string", "description": "Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.\n" }, "creationTime": { "type": "string", "description": "Creation time of the network instance connection.\n" }, "deletedTime": { "type": "string", "description": "Deletion time of the network instance connection.\n" }, "description": { "type": "string", "description": "Description of the network instance connection.\n" }, "ipv6Enabled": { "type": "boolean", "description": "Whether IPv6 is enabled. true: yes. false: no\n" }, "overdueTime": { "type": "string", "description": "Shutdown time due to overdue payment for the network instance connection\n" }, "resourceId": { "type": "string", "description": "ID of the network instance\n" }, "resourceType": { "type": "string", "description": "Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router\n" }, "status": { "type": "string", "description": "Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/getTransitRouterAttachmentTag:getTransitRouterAttachmentTag" }, "description": "Tag information of the network instance connection\n" }, "transitRouterAttachmentId": { "type": "string", "description": "Network instance connection ID.\n" }, "transitRouterAttachmentName": { "type": "string", "description": "Name of the network instance connection\n" }, "transitRouterForwardPolicyTableId": { "type": "string", "description": "ID of the forwarding policy associated with the cross-region connection\n" }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "transitRouterRouteTableId": { "type": "string", "description": "Route table ID associated with the forwarding of the network instance connection.\n" }, "transitRouterTrafficQosMarkingPolicyId": { "type": "string", "description": "ID of the flow marking policy associated with the cross-region connection\n" }, "transitRouterTrafficQosQueuePolicyId": { "type": "string", "description": "ID of the flow queue policy associated with the cross-region connection\n" }, "updateTime": { "type": "string", "description": "Last operation time of the network instance connection\n" } }, "type": "object", "required": [ "autoPublishRouteEnabled", "businessStatus", "creationTime", "deletedTime", "description", "ipv6Enabled", "overdueTime", "resourceId", "resourceType", "status", "tags", "transitRouterAttachmentId", "transitRouterAttachmentName", "transitRouterForwardPolicyTableId", "transitRouterId", "transitRouterRouteTableId", "transitRouterTrafficQosMarkingPolicyId", "transitRouterTrafficQosQueuePolicyId", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:transitrouter/getTransitRouterAttachmentTag:getTransitRouterAttachmentTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:transitrouter/getTransitRouterRouteTableTag:getTransitRouterRouteTableTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:transitrouter/getTransitRouterTag:getTransitRouterTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:transitrouter/getVpcAttachmentAttachPoint:getVpcAttachmentAttachPoint": { "properties": { "networkInterfaceId": { "type": "string", "description": "Network interface card ID of the connection point.\n" }, "subnetId": { "type": "string", "description": "Subnet ID of the connection point.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the connection point.\n" } }, "type": "object", "required": [ "networkInterfaceId", "subnetId", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:transitrouter/getVpcAttachmentTag:getVpcAttachmentTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tag.\n" }, "value": { "type": "string", "description": "Tag value for user tag.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:transitrouter/getVpnAttachmentTag:getVpnAttachmentTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/AllowListAssociatedInstance:AllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "instanceId" ] } } }, "volcenginecc:vedbm/DatabaseDatabasesPrivilege:DatabaseDatabasesPrivilege": { "properties": { "accountName": { "type": "string", "description": "Account name to be authorized\n" }, "accountPrivilege": { "type": "string", "description": "Database permission type: ReadWrite/ReadOnly/DDLOnly/DMLOnly/Custom\n" }, "accountPrivilegeDetails": { "type": "array", "items": { "type": "string" }, "description": "Specific SQL operation permissions, separated by English commas; required for Custom type\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountName", "accountPrivilege", "accountPrivilegeDetails" ] } } }, "volcenginecc:vedbm/EndpointPrivateAddresses:EndpointPrivateAddresses": { "properties": { "dnsVisibility": { "type": "boolean", "description": "Resolution method, fixed as false\n" }, "domain": { "type": "string", "description": "Instance intranet access domain name\n" }, "eipId": { "type": "string", "description": "Public network ID\n" }, "ipAddress": { "type": "string", "description": "IP address\n" }, "networkType": { "type": "string", "description": "Network type\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsVisibility", "domain", "eipId", "ipAddress", "networkType", "subnetId" ] } } }, "volcenginecc:vedbm/EndpointPublicAddresses:EndpointPublicAddresses": { "properties": { "dnsVisibility": { "type": "boolean", "description": "Resolution method, fixed as false\n" }, "domain": { "type": "string", "description": "Instance intranet access domain name\n" }, "eipId": { "type": "string", "description": "Public network ID\n" }, "ipAddress": { "type": "string", "description": "IP address\n" }, "networkType": { "type": "string", "description": "Network type\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsVisibility", "domain", "eipId", "ipAddress", "networkType", "subnetId" ] } } }, "volcenginecc:vedbm/InstanceChargeDetail:InstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.\n" }, "chargeEndTime": { "type": "string", "description": "Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "chargeStartTime": { "type": "string", "description": "Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "chargeStatus": { "type": "string", "description": "Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown\n" }, "chargeType": { "type": "string", "description": "Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "overdueTime": { "type": "string", "description": "Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "period": { "type": "integer", "description": "Purchase duration for prepaid scenarios.\n" }, "periodUnit": { "type": "string", "description": "Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoRenew", "chargeEndTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ] } } }, "volcenginecc:vedbm/InstanceEndpoint:InstanceEndpoint": { "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/InstanceEndpointAddress:InstanceEndpointAddress" } }, "autoAddNewNodes": { "type": "boolean", "description": "Whether to allow automatic addition of new nodes. Values: true: yes. false: no.\n" }, "consistLevel": { "type": "string", "description": "Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.\n" }, "consistTimeout": { "type": "integer", "description": "When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us\n" }, "consistTimeoutAction": { "type": "string", "description": "Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.\n" }, "description": { "type": "string", "description": "Address description\n" }, "distributedTransaction": { "type": "boolean", "description": "Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.\n" }, "endpointId": { "type": "string", "description": "Instance connection endpoint ID.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.\n" }, "masterAcceptReadRequests": { "type": "boolean", "description": "Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node list configured for the connection endpoint.\n" }, "readWriteMode": { "type": "string", "description": "Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "addresses", "autoAddNewNodes", "consistLevel", "consistTimeout", "consistTimeoutAction", "description", "distributedTransaction", "endpointId", "endpointName", "endpointType", "masterAcceptReadRequests", "nodeIds", "readWriteMode" ] } } }, "volcenginecc:vedbm/InstanceEndpointAddress:InstanceEndpointAddress": { "properties": { "dnsVisibility": { "type": "boolean", "description": "Parsing method. The current return value can only be false.\n" }, "domain": { "type": "string", "description": "Instance private access domain name.\n" }, "eipId": { "type": "string", "description": "Public network ID.\n" }, "ipAddress": { "type": "string", "description": "IP address.\n" }, "networkType": { "type": "string", "description": "Network type: Private: private network VPC. Public: public access.\n" }, "port": { "type": "string", "description": "Instance private network access port.\n" }, "subnetId": { "type": "string", "description": "Subnet ID. The subnet must belong to the selected availability zone.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsVisibility", "domain", "eipId", "ipAddress", "networkType", "port", "subnetId" ] } } }, "volcenginecc:vedbm/InstanceMaintenanceWindow:InstanceMaintenanceWindow": { "properties": { "dayKind": { "type": "string", "description": "Maintenance cycle granularity. Default value: Week.\n" }, "dayOfMonths": { "type": "array", "items": { "type": "integer" }, "description": "Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.\n" }, "dayOfWeeks": { "type": "array", "items": { "type": "string" }, "description": "Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dayKind", "dayOfMonths", "dayOfWeeks", "maintenanceTime" ] } } }, "volcenginecc:vedbm/InstanceNode:InstanceNode": { "properties": { "failoverPriority": { "type": "integer", "description": "Node failover priority. Range: 0~15. Higher values indicate higher priority\n" }, "memory": { "type": "integer", "description": "Memory size, in GiB.\n" }, "nodeId": { "type": "string", "description": "Node ID\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeType": { "type": "string", "description": "Node type. Values: Primary: primary node. ReadOnly: read-only node.\n" }, "vCpu": { "type": "integer", "description": "CPU size. For example, a value of 1 indicates a CPU size of 1U.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "failoverPriority", "memory", "nodeId", "nodeSpec", "nodeType", "vCpu", "zoneId" ] } } }, "volcenginecc:vedbm/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "User tag key. Length range: 1~128 characters. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it\n" }, "value": { "type": "string", "description": "User tag value. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system will automatically remove it\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vedbm/getAllowListAssociatedInstance:getAllowListAssociatedInstance": { "properties": { "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "vpc": { "type": "string", "description": "Instance VPC ID.\n" } }, "type": "object", "required": [ "instanceId", "instanceName", "vpc" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/getDatabaseDatabasesPrivilege:getDatabaseDatabasesPrivilege": { "properties": { "accountName": { "type": "string", "description": "Account name to be authorized\n" }, "accountPrivilege": { "type": "string", "description": "Database permission type: ReadWrite/ReadOnly/DDLOnly/DMLOnly/Custom\n" }, "accountPrivilegeDetails": { "type": "array", "items": { "type": "string" }, "description": "Specific SQL operation permissions, separated by English commas; required for Custom type\n" } }, "type": "object", "required": [ "accountName", "accountPrivilege", "accountPrivilegeDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/getEndpointPrivateAddresses:getEndpointPrivateAddresses": { "properties": { "dnsVisibility": { "type": "boolean", "description": "Resolution method, fixed as false\n" }, "domain": { "type": "string", "description": "Instance intranet access domain name\n" }, "eipId": { "type": "string", "description": "Public network ID\n" }, "ipAddress": { "type": "string", "description": "IP address\n" }, "networkType": { "type": "string", "description": "Network type\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" } }, "type": "object", "required": [ "dnsVisibility", "domain", "eipId", "ipAddress", "networkType", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/getEndpointPublicAddresses:getEndpointPublicAddresses": { "properties": { "dnsVisibility": { "type": "boolean", "description": "Resolution method, fixed as false\n" }, "domain": { "type": "string", "description": "Instance intranet access domain name\n" }, "eipId": { "type": "string", "description": "Public network ID\n" }, "ipAddress": { "type": "string", "description": "IP address\n" }, "networkType": { "type": "string", "description": "Network type\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" } }, "type": "object", "required": [ "dnsVisibility", "domain", "eipId", "ipAddress", "networkType", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/getInstanceChargeDetail:getInstanceChargeDetail": { "properties": { "autoRenew": { "type": "boolean", "description": "Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.\n" }, "chargeEndTime": { "type": "string", "description": "Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "chargeStartTime": { "type": "string", "description": "Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "chargeStatus": { "type": "string", "description": "Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown\n" }, "chargeType": { "type": "string", "description": "Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription\n" }, "overdueReclaimTime": { "type": "string", "description": "Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "overdueTime": { "type": "string", "description": "Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).\n" }, "period": { "type": "integer", "description": "Purchase duration for prepaid scenarios.\n" }, "periodUnit": { "type": "string", "description": "Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.\n" } }, "type": "object", "required": [ "autoRenew", "chargeEndTime", "chargeStartTime", "chargeStatus", "chargeType", "overdueReclaimTime", "overdueTime", "period", "periodUnit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/getInstanceEndpoint:getInstanceEndpoint": { "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/getInstanceEndpointAddress:getInstanceEndpointAddress" }, "description": "Connection address information.\n" }, "autoAddNewNodes": { "type": "boolean", "description": "Whether to allow automatic addition of new nodes. Values: true: yes. false: no.\n" }, "consistLevel": { "type": "string", "description": "Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.\n" }, "consistTimeout": { "type": "integer", "description": "When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us\n" }, "consistTimeoutAction": { "type": "string", "description": "Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.\n" }, "description": { "type": "string", "description": "Address description\n" }, "distributedTransaction": { "type": "boolean", "description": "Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.\n" }, "endpointId": { "type": "string", "description": "Instance connection endpoint ID.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.\n" }, "masterAcceptReadRequests": { "type": "boolean", "description": "Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node list configured for the connection endpoint.\n" }, "readWriteMode": { "type": "string", "description": "Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only\n" } }, "type": "object", "required": [ "addresses", "autoAddNewNodes", "consistLevel", "consistTimeout", "consistTimeoutAction", "description", "distributedTransaction", "endpointId", "endpointName", "endpointType", "masterAcceptReadRequests", "nodeIds", "readWriteMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/getInstanceEndpointAddress:getInstanceEndpointAddress": { "properties": { "dnsVisibility": { "type": "boolean", "description": "Parsing method. The current return value can only be false.\n" }, "domain": { "type": "string", "description": "Instance private access domain name.\n" }, "eipId": { "type": "string", "description": "Public network ID.\n" }, "ipAddress": { "type": "string", "description": "IP address.\n" }, "networkType": { "type": "string", "description": "Network type: Private: private network VPC. Public: public access.\n" }, "port": { "type": "string", "description": "Instance private network access port.\n" }, "subnetId": { "type": "string", "description": "Subnet ID. The subnet must belong to the selected availability zone.\n" } }, "type": "object", "required": [ "dnsVisibility", "domain", "eipId", "ipAddress", "networkType", "port", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/getInstanceMaintenanceWindow:getInstanceMaintenanceWindow": { "properties": { "dayKind": { "type": "string", "description": "Maintenance cycle granularity. Default value: Week.\n" }, "dayOfMonths": { "type": "array", "items": { "type": "integer" }, "description": "Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.\n" }, "dayOfWeeks": { "type": "array", "items": { "type": "string" }, "description": "Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).\n" } }, "type": "object", "required": [ "dayKind", "dayOfMonths", "dayOfWeeks", "maintenanceTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/getInstanceNode:getInstanceNode": { "properties": { "failoverPriority": { "type": "integer", "description": "Node failover priority. Range: 0~15. Higher values indicate higher priority\n" }, "memory": { "type": "integer", "description": "Memory size, in GiB.\n" }, "nodeId": { "type": "string", "description": "Node ID\n" }, "nodeSpec": { "type": "string", "description": "Node specification.\n" }, "nodeType": { "type": "string", "description": "Node type. Values: Primary: primary node. ReadOnly: read-only node.\n" }, "vCpu": { "type": "integer", "description": "CPU size. For example, a value of 1 indicates a CPU size of 1U.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID\n" } }, "type": "object", "required": [ "failoverPriority", "memory", "nodeId", "nodeSpec", "nodeType", "vCpu", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vedbm/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "User tag key. Length range: 1~128 characters. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it\n" }, "value": { "type": "string", "description": "User tag value. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system will automatically remove it\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/FunctionAsyncTaskConfig:FunctionAsyncTaskConfig": { "properties": { "destinationConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionAsyncTaskConfigDestinationConfig:FunctionAsyncTaskConfigDestinationConfig", "description": "Asynchronous task callback target configuration\n" }, "enableAsyncTask": { "type": "boolean", "description": "Whether to enable asynchronous task\n" }, "maxRetry": { "type": "integer", "description": "Number of retry attempts for asynchronous task failures. Available values: 0–3\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationConfig", "enableAsyncTask", "maxRetry" ] } } }, "volcenginecc:vefaas/FunctionAsyncTaskConfigDestinationConfig:FunctionAsyncTaskConfigDestinationConfig": { "properties": { "onFailure": { "$ref": "#/types/volcenginecc:vefaas/FunctionAsyncTaskConfigDestinationConfigOnFailure:FunctionAsyncTaskConfigDestinationConfigOnFailure", "description": "Callback target configuration when the task fails\n" }, "onSuccess": { "$ref": "#/types/volcenginecc:vefaas/FunctionAsyncTaskConfigDestinationConfigOnSuccess:FunctionAsyncTaskConfigDestinationConfigOnSuccess", "description": "Callback target configuration when the task succeeds\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "onFailure", "onSuccess" ] } } }, "volcenginecc:vefaas/FunctionAsyncTaskConfigDestinationConfigOnFailure:FunctionAsyncTaskConfigDestinationConfigOnFailure": { "properties": { "destination": { "type": "string", "description": "Specific callback target. Set the value to empty (\"\") to disable this callback\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destination" ] } } }, "volcenginecc:vefaas/FunctionAsyncTaskConfigDestinationConfigOnSuccess:FunctionAsyncTaskConfigDestinationConfigOnSuccess": { "properties": { "destination": { "type": "string", "description": "Specific callback target. Set the value to empty (\"\") to disable this callback\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destination" ] } } }, "volcenginecc:vefaas/FunctionEnv:FunctionEnv": { "properties": { "key": { "type": "string", "description": "Environment variable key. 1–63 characters; can include letters, numbers, and underscores (_), but cannot start with a number. Key must be unique within the same function\n" }, "value": { "type": "string", "description": "Environment variable value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vefaas/FunctionNasStorage:FunctionNasStorage": { "properties": { "enableNas": { "type": "boolean", "description": "Enable NAS storage mount. true: enabled, store data in NAS. false: disabled.\n" }, "nasConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/FunctionNasStorageNasConfig:FunctionNasStorageNasConfig" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableNas", "nasConfigs" ] } } }, "volcenginecc:vefaas/FunctionNasStorageNasConfig:FunctionNasStorageNasConfig": { "properties": { "fileSystemId": { "type": "string", "description": "NAS file system ID.\n" }, "gid": { "type": "integer", "description": "User group in the file system. Customization is not currently supported. If this parameter is provided, its value is 1000 (consistent with the function run user gid)\n" }, "localMountPath": { "type": "string", "description": "Function local mount directory. Length: 1–128 characters, must start with “/”, supports uppercase and lowercase letters, numbers, and special characters ( - . _ ~ / : @ = + ? #).\n" }, "mountPointId": { "type": "string", "description": "NAS mount point ID\n" }, "remotePath": { "type": "string", "description": "Remote directory in the file system. Length: 1–128 characters, must start with “/”, supports uppercase and lowercase letters, numbers, and special characters ( - . _ ~ / : @ = + ? #)\n" }, "uid": { "type": "integer", "description": "The user in the file system cannot be customized for now. If this parameter is provided, the value must be 1000 (consistent with the function run user uid).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fileSystemId", "gid", "localMountPath", "mountPointId", "remotePath", "uid" ] } } }, "volcenginecc:vefaas/FunctionSourceAccessConfig:FunctionSourceAccessConfig": { "properties": { "password": { "type": "string", "description": "Image repository password\n" }, "username": { "type": "string", "description": "Image repository username\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "password", "username" ] } } }, "volcenginecc:vefaas/FunctionTag:FunctionTag": { "properties": { "key": { "type": "string", "description": "Function tag key\n" }, "value": { "type": "string", "description": "Function tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vefaas/FunctionTlsConfig:FunctionTlsConfig": { "properties": { "enableLog": { "type": "boolean", "description": "TLS log feature toggle. true: enabled, function stdout/stderr logs will be collected to the specified log project and log topic in Log Service. false: disabled, logs will not be collected\n" }, "tlsProjectId": { "type": "string", "description": "TLS log project ID\n" }, "tlsTopicId": { "type": "string", "description": "TLS log topic ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableLog", "tlsProjectId", "tlsTopicId" ] } } }, "volcenginecc:vefaas/FunctionTosMountConfig:FunctionTosMountConfig": { "properties": { "credentials": { "$ref": "#/types/volcenginecc:vefaas/FunctionTosMountConfigCredentials:FunctionTosMountConfigCredentials", "description": "AKSK with TOS domain access permission.\n" }, "enableTos": { "type": "boolean", "description": "Enable TOS storage mount.\n" }, "mountPoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/FunctionTosMountConfigMountPoint:FunctionTosMountConfigMountPoint" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "credentials", "enableTos", "mountPoints" ] } } }, "volcenginecc:vefaas/FunctionTosMountConfigCredentials:FunctionTosMountConfigCredentials": { "properties": { "accessKeyId": { "type": "string", "description": "Account AccessKey ID\n" }, "secretAccessKey": { "type": "string", "description": "Account Secret Access Key\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessKeyId", "secretAccessKey" ] } } }, "volcenginecc:vefaas/FunctionTosMountConfigMountPoint:FunctionTosMountConfigMountPoint": { "properties": { "bucketName": { "type": "string", "description": "TOS bucket name.\n" }, "bucketPath": { "type": "string", "description": "Mounted TOS Bucket path.\n" }, "endpoint": { "type": "string", "description": "TOS access domain name.\n" }, "localMountPath": { "type": "string", "description": "Function local mount directory.\n" }, "readOnly": { "type": "boolean", "description": "Function local directory access permission. After mounting a TOS bucket, whether the function's local mount directory is read-only. true: read-only; false (default): read/write\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucketName", "bucketPath", "endpoint", "localMountPath", "readOnly" ] } } }, "volcenginecc:vefaas/FunctionVpcConfig:FunctionVpcConfig": { "properties": { "enableSharedInternetAccess": { "type": "boolean", "description": "Function public network access switch. Whether to access the public network via veFaaS VPC shared NAT gateway. Values: true: enabled, access public network via default network interface. Public outbound traffic fees apply. false: disabled, function cannot access public network via default network interface.\n" }, "enableVpc": { "type": "boolean", "description": "Whether the function enables private network access\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group ID\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID\n" }, "vpcId": { "type": "string", "description": "VPC ID. If the VPC ID is an empty string, it means the current VPC configuration will be deleted\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableSharedInternetAccess", "enableVpc", "securityGroupIds", "subnetIds", "vpcId" ] } } }, "volcenginecc:vefaas/KafkaTriggerKafkaCredentials:KafkaTriggerKafkaCredentials": { "properties": { "mechanism": { "type": "string", "description": "Kafka authentication mechanism. Options: PLAIN, SCRAM-SHA-256.\n" }, "password": { "type": "string", "description": "SASL/PLAIN password set when creating the Kafka instance.\n" }, "username": { "type": "string", "description": "SASL/PLAIN username set when creating the Kafka instance.\n" } }, "type": "object", "required": [ "mechanism", "password", "username" ] }, "volcenginecc:vefaas/SandboxEnv:SandboxEnv": { "properties": { "key": { "type": "string", "description": "Environment variable key\n" }, "value": { "type": "string", "description": "Environment variable value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vefaas/SandboxInstanceImageInfo:SandboxInstanceImageInfo": { "properties": { "command": { "type": "string", "description": "Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions\n" }, "image": { "type": "string", "description": "Preheated image address used by the sandbox instance\n" }, "imageId": { "type": "string", "description": "Pre-warmed image ID used by the sandbox instance.\n" }, "port": { "type": "integer", "description": "Listening port of the sandbox instance image.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "command", "image", "imageId", "port" ] } } }, "volcenginecc:vefaas/SandboxInstanceTosMountConfig:SandboxInstanceTosMountConfig": { "properties": { "enable": { "type": "boolean", "description": "Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no\n" }, "tosMountPoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/SandboxInstanceTosMountConfigTosMountPoint:SandboxInstanceTosMountConfigTosMountPoint" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enable", "tosMountPoints" ] } } }, "volcenginecc:vefaas/SandboxInstanceTosMountConfigTosMountPoint:SandboxInstanceTosMountConfigTosMountPoint": { "properties": { "bucketPath": { "type": "string", "description": "TOS remote directory mounted by the sandbox instance\n" }, "localMountPath": { "type": "string", "description": "Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucketPath", "localMountPath" ] } } }, "volcenginecc:vefaas/SandboxMetadata:SandboxMetadata": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vefaas/getFunctionAsyncTaskConfig:getFunctionAsyncTaskConfig": { "properties": { "destinationConfig": { "$ref": "#/types/volcenginecc:vefaas/getFunctionAsyncTaskConfigDestinationConfig:getFunctionAsyncTaskConfigDestinationConfig", "description": "Asynchronous task callback target configuration\n" }, "enableAsyncTask": { "type": "boolean", "description": "Whether to enable asynchronous task\n" }, "maxRetry": { "type": "integer", "description": "Number of retry attempts for asynchronous task failures. Available values: 0–3\n" } }, "type": "object", "required": [ "destinationConfig", "enableAsyncTask", "maxRetry" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionAsyncTaskConfigDestinationConfig:getFunctionAsyncTaskConfigDestinationConfig": { "properties": { "onFailure": { "$ref": "#/types/volcenginecc:vefaas/getFunctionAsyncTaskConfigDestinationConfigOnFailure:getFunctionAsyncTaskConfigDestinationConfigOnFailure", "description": "Callback target configuration when the task fails\n" }, "onSuccess": { "$ref": "#/types/volcenginecc:vefaas/getFunctionAsyncTaskConfigDestinationConfigOnSuccess:getFunctionAsyncTaskConfigDestinationConfigOnSuccess", "description": "Callback target configuration when the task succeeds\n" } }, "type": "object", "required": [ "onFailure", "onSuccess" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionAsyncTaskConfigDestinationConfigOnFailure:getFunctionAsyncTaskConfigDestinationConfigOnFailure": { "properties": { "destination": { "type": "string", "description": "Specific callback target. Set the value to empty (\"\") to disable this callback\n" } }, "type": "object", "required": [ "destination" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionAsyncTaskConfigDestinationConfigOnSuccess:getFunctionAsyncTaskConfigDestinationConfigOnSuccess": { "properties": { "destination": { "type": "string", "description": "Specific callback target. Set the value to empty (\"\") to disable this callback\n" } }, "type": "object", "required": [ "destination" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionEnv:getFunctionEnv": { "properties": { "key": { "type": "string", "description": "Environment variable key. 1–63 characters; can include letters, numbers, and underscores (_), but cannot start with a number. Key must be unique within the same function\n" }, "value": { "type": "string", "description": "Environment variable value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionNasStorage:getFunctionNasStorage": { "properties": { "enableNas": { "type": "boolean", "description": "Enable NAS storage mount. true: enabled, store data in NAS. false: disabled.\n" }, "nasConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/getFunctionNasStorageNasConfig:getFunctionNasStorageNasConfig" }, "description": "NAS storage configuration\n" } }, "type": "object", "required": [ "enableNas", "nasConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionNasStorageNasConfig:getFunctionNasStorageNasConfig": { "properties": { "fileSystemId": { "type": "string", "description": "NAS file system ID.\n" }, "gid": { "type": "integer", "description": "User group in the file system. Customization is not currently supported. If this parameter is provided, its value is 1000 (consistent with the function run user gid)\n" }, "localMountPath": { "type": "string", "description": "Function local mount directory. Length: 1–128 characters, must start with “/”, supports uppercase and lowercase letters, numbers, and special characters ( - . _ ~ / : @ = + ? #).\n" }, "mountPointId": { "type": "string", "description": "NAS mount point ID\n" }, "remotePath": { "type": "string", "description": "Remote directory in the file system. Length: 1–128 characters, must start with “/”, supports uppercase and lowercase letters, numbers, and special characters ( - . _ ~ / : @ = + ? #)\n" }, "uid": { "type": "integer", "description": "The user in the file system cannot be customized for now. If this parameter is provided, the value must be 1000 (consistent with the function run user uid).\n" } }, "type": "object", "required": [ "fileSystemId", "gid", "localMountPath", "mountPointId", "remotePath", "uid" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionSourceAccessConfig:getFunctionSourceAccessConfig": { "properties": { "password": { "type": "string", "description": "Image repository password\n" }, "username": { "type": "string", "description": "Image repository username\n" } }, "type": "object", "required": [ "password", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionTag:getFunctionTag": { "properties": { "key": { "type": "string", "description": "Function tag key\n" }, "value": { "type": "string", "description": "Function tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionTlsConfig:getFunctionTlsConfig": { "properties": { "enableLog": { "type": "boolean", "description": "TLS log feature toggle. true: enabled, function stdout/stderr logs will be collected to the specified log project and log topic in Log Service. false: disabled, logs will not be collected\n" }, "tlsProjectId": { "type": "string", "description": "TLS log project ID\n" }, "tlsTopicId": { "type": "string", "description": "TLS log topic ID.\n" } }, "type": "object", "required": [ "enableLog", "tlsProjectId", "tlsTopicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionTosMountConfig:getFunctionTosMountConfig": { "properties": { "credentials": { "$ref": "#/types/volcenginecc:vefaas/getFunctionTosMountConfigCredentials:getFunctionTosMountConfigCredentials", "description": "AKSK with TOS domain access permission.\n" }, "enableTos": { "type": "boolean", "description": "Enable TOS storage mount.\n" }, "mountPoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/getFunctionTosMountConfigMountPoint:getFunctionTosMountConfigMountPoint" }, "description": "TOS storage configuration list\n" } }, "type": "object", "required": [ "credentials", "enableTos", "mountPoints" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionTosMountConfigCredentials:getFunctionTosMountConfigCredentials": { "properties": { "accessKeyId": { "type": "string", "description": "Account AccessKey ID\n" }, "secretAccessKey": { "type": "string", "description": "Account Secret Access Key\n" } }, "type": "object", "required": [ "accessKeyId", "secretAccessKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionTosMountConfigMountPoint:getFunctionTosMountConfigMountPoint": { "properties": { "bucketName": { "type": "string", "description": "TOS bucket name.\n" }, "bucketPath": { "type": "string", "description": "Mounted TOS Bucket path.\n" }, "endpoint": { "type": "string", "description": "TOS access domain name.\n" }, "localMountPath": { "type": "string", "description": "Function local mount directory.\n" }, "readOnly": { "type": "boolean", "description": "Function local directory access permission. After mounting a TOS bucket, whether the function's local mount directory is read-only. true: read-only; false (default): read/write\n" } }, "type": "object", "required": [ "bucketName", "bucketPath", "endpoint", "localMountPath", "readOnly" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getFunctionVpcConfig:getFunctionVpcConfig": { "properties": { "enableSharedInternetAccess": { "type": "boolean", "description": "Function public network access switch. Whether to access the public network via veFaaS VPC shared NAT gateway. Values: true: enabled, access public network via default network interface. Public outbound traffic fees apply. false: disabled, function cannot access public network via default network interface.\n" }, "enableVpc": { "type": "boolean", "description": "Whether the function enables private network access\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group ID\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID\n" }, "vpcId": { "type": "string", "description": "VPC ID. If the VPC ID is an empty string, it means the current VPC configuration will be deleted\n" } }, "type": "object", "required": [ "enableSharedInternetAccess", "enableVpc", "securityGroupIds", "subnetIds", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getKafkaTriggerKafkaCredentials:getKafkaTriggerKafkaCredentials": { "properties": { "mechanism": { "type": "string", "description": "Kafka authentication mechanism. Options: PLAIN, SCRAM-SHA-256.\n" }, "password": { "type": "string", "description": "SASL/PLAIN password set when creating the Kafka instance.\n" }, "username": { "type": "string", "description": "SASL/PLAIN username set when creating the Kafka instance.\n" } }, "type": "object", "required": [ "mechanism", "password", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getSandboxEnv:getSandboxEnv": { "properties": { "key": { "type": "string", "description": "Environment variable key\n" }, "value": { "type": "string", "description": "Environment variable value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getSandboxInstanceImageInfo:getSandboxInstanceImageInfo": { "properties": { "command": { "type": "string", "description": "Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions\n" }, "image": { "type": "string", "description": "Preheated image address used by the sandbox instance\n" }, "imageId": { "type": "string", "description": "Pre-warmed image ID used by the sandbox instance.\n" }, "port": { "type": "integer", "description": "Listening port of the sandbox instance image.\n" } }, "type": "object", "required": [ "command", "image", "imageId", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getSandboxInstanceTosMountConfig:getSandboxInstanceTosMountConfig": { "properties": { "enable": { "type": "boolean", "description": "Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no\n" }, "tosMountPoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/getSandboxInstanceTosMountConfigTosMountPoint:getSandboxInstanceTosMountConfigTosMountPoint" }, "description": "Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled\n" } }, "type": "object", "required": [ "enable", "tosMountPoints" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getSandboxInstanceTosMountConfigTosMountPoint:getSandboxInstanceTosMountConfigTosMountPoint": { "properties": { "bucketPath": { "type": "string", "description": "TOS remote directory mounted by the sandbox instance\n" }, "localMountPath": { "type": "string", "description": "Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory\n" } }, "type": "object", "required": [ "bucketPath", "localMountPath" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vefaas/getSandboxMetadata:getSandboxMetadata": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vepfs/InstanceCapacityInfo:InstanceCapacityInfo": { "properties": { "totalTiB": { "type": "integer", "description": "Total file system capacity, unit: TiB. Note: Disk balancing time varies based on cluster capacity, cluster load, and other factors. For clusters above the PiB level, expansion typically requires day-level disk balancing time. The expansion capacity becomes effective (and is billed) only after disk balancing is complete.\n" }, "usedGiB": { "type": "integer", "description": "Used capacity (GiB).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "totalTiB", "usedGiB" ] } } }, "volcenginecc:vepfs/InstanceTag:InstanceTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vepfs/MountServiceAttachFileSystem:MountServiceAttachFileSystem": { "properties": { "accountId": { "type": "string", "description": "Account ID.\n" }, "customerPath": { "type": "string", "description": "User mount path.\n" }, "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "fileSystemName": { "type": "string", "description": "File system name.\n" }, "status": { "type": "string", "description": "Binding status. Details: Attaching: Attaching. AttachError: Attachment failed. Attached: Attached. Detaching: Detaching. DetachError: Detachment failed.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accountId", "customerPath", "fileSystemId", "fileSystemName", "status" ] } } }, "volcenginecc:vepfs/MountServiceNode:MountServiceNode": { "properties": { "defaultPassword": { "type": "string", "description": "Node initial password.\n" }, "nodeId": { "type": "string", "description": "Node instance ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "defaultPassword", "nodeId" ] } } }, "volcenginecc:vepfs/getInstanceCapacityInfo:getInstanceCapacityInfo": { "properties": { "totalTiB": { "type": "integer", "description": "Total file system capacity, unit: TiB. Note: Disk balancing time varies based on cluster capacity, cluster load, and other factors. For clusters above the PiB level, expansion typically requires day-level disk balancing time. The expansion capacity becomes effective (and is billed) only after disk balancing is complete.\n" }, "usedGiB": { "type": "integer", "description": "Used capacity (GiB).\n" } }, "type": "object", "required": [ "totalTiB", "usedGiB" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vepfs/getInstanceTag:getInstanceTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "type": { "type": "string", "description": "Tag type. Descriptions are as follows: Custom: User-defined tag. System: System tag.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "required": [ "key", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vepfs/getMountServiceAttachFileSystem:getMountServiceAttachFileSystem": { "properties": { "accountId": { "type": "string", "description": "Account ID.\n" }, "customerPath": { "type": "string", "description": "User mount path.\n" }, "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "fileSystemName": { "type": "string", "description": "File system name.\n" }, "status": { "type": "string", "description": "Binding status. Details: Attaching: Attaching. AttachError: Attachment failed. Attached: Attached. Detaching: Detaching. DetachError: Detachment failed.\n" } }, "type": "object", "required": [ "accountId", "customerPath", "fileSystemId", "fileSystemName", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vepfs/getMountServiceNode:getMountServiceNode": { "properties": { "defaultPassword": { "type": "string", "description": "Node initial password.\n" }, "nodeId": { "type": "string", "description": "Node instance ID.\n" } }, "type": "object", "required": [ "defaultPassword", "nodeId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/AddonStatus:AddonStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/AddonStatusCondition:AddonStatusCondition" } }, "phase": { "type": "string", "description": "Component status. Parameter values include: Running, Failed, Creating, Deleting, Updating\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditions", "phase" ] } } }, "volcenginecc:vke/AddonStatusCondition:AddonStatusCondition": { "type": "object" }, "volcenginecc:vke/ClusterClusterConfig:ClusterClusterConfig": { "properties": { "apiServerEndpoints": { "$ref": "#/types/volcenginecc:vke/ClusterClusterConfigApiServerEndpoints:ClusterClusterConfigApiServerEndpoints", "description": "Cluster API Server access IPv4 address information\n" }, "apiServerPublicAccessConfig": { "$ref": "#/types/volcenginecc:vke/ClusterClusterConfigApiServerPublicAccessConfig:ClusterClusterConfigApiServerPublicAccessConfig", "description": "Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true\n" }, "apiServerPublicAccessEnabled": { "type": "boolean", "description": "Node public access configuration. Parameter value description: false: Disabled. true: Enabled\n" }, "ipFamily": { "type": "string", "description": "Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack\n" }, "resourcePublicAccessDefaultEnabled": { "type": "boolean", "description": "Node public access configuration. Parameter value description: false: Disabled. true: Enabled\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group used by the cluster control plane and nodes.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID for cluster control plane communication within the private network.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID where the cluster control plane and some nodes are located.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "apiServerEndpoints", "apiServerPublicAccessConfig", "apiServerPublicAccessEnabled", "ipFamily", "resourcePublicAccessDefaultEnabled", "securityGroupIds", "subnetIds", "vpcId" ] } } }, "volcenginecc:vke/ClusterClusterConfigApiServerEndpoints:ClusterClusterConfigApiServerEndpoints": { "properties": { "privateIp": { "$ref": "#/types/volcenginecc:vke/ClusterClusterConfigApiServerEndpointsPrivateIp:ClusterClusterConfigApiServerEndpointsPrivateIp", "description": "Cluster API Server private IPv4 address.\n" }, "publicIp": { "$ref": "#/types/volcenginecc:vke/ClusterClusterConfigApiServerEndpointsPublicIp:ClusterClusterConfigApiServerEndpointsPublicIp", "description": "Cluster API Server public IPv4 address\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "privateIp", "publicIp" ] } } }, "volcenginecc:vke/ClusterClusterConfigApiServerEndpointsPrivateIp:ClusterClusterConfigApiServerEndpointsPrivateIp": { "properties": { "ipv4": { "type": "string", "description": "IPv4 address of the private network IP.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv4" ] } } }, "volcenginecc:vke/ClusterClusterConfigApiServerEndpointsPublicIp:ClusterClusterConfigApiServerEndpointsPublicIp": { "properties": { "ipv4": { "type": "string", "description": "IPv4 address of the public IP.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv4" ] } } }, "volcenginecc:vke/ClusterClusterConfigApiServerPublicAccessConfig:ClusterClusterConfigApiServerPublicAccessConfig": { "properties": { "publicAccessNetworkConfig": { "$ref": "#/types/volcenginecc:vke/ClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig:ClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig", "description": "Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "publicAccessNetworkConfig" ] } } }, "volcenginecc:vke/ClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig:ClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of the public IP, unit: Mbps\n" }, "billingType": { "type": "integer", "description": "Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.\n" }, "isp": { "type": "string", "description": "Line type of the public IP. Parameter value description: BGP: BGP (multi-line)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "billingType", "isp" ] } } }, "volcenginecc:vke/ClusterIrsaConfig:ClusterIrsaConfig": { "properties": { "audience": { "type": "string", "description": "Identifier for accepting tokens\n" }, "enabled": { "type": "boolean", "description": "Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.\n" }, "issuer": { "type": "string", "description": "OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.\n" }, "jwksUrl": { "type": "string", "description": "JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.\n" }, "oidcTrn": { "type": "string", "description": "OIDC provider TRN.\n" }, "openIdConfigUrl": { "type": "string", "description": "OIDC provider configuration document in JSON format, containing information about the OIDC provider.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "audience", "enabled", "issuer", "jwksUrl", "oidcTrn", "openIdConfigUrl" ] } } }, "volcenginecc:vke/ClusterLoggingConfig:ClusterLoggingConfig": { "properties": { "logProjectId": { "type": "string", "description": "Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.\n" }, "logSetups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/ClusterLoggingConfigLogSetup:ClusterLoggingConfigLogSetup" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "logProjectId", "logSetups" ] } } }, "volcenginecc:vke/ClusterLoggingConfigLogSetup:ClusterLoggingConfigLogSetup": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable this log option. Parameter values: true: enabled; false: not enabled.\n" }, "logTtl": { "type": "integer", "description": "Retention period of logs in log service, in days. 3650 days means permanent storage.\n" }, "logType": { "type": "string", "description": "Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "logTtl", "logType" ] } } }, "volcenginecc:vke/ClusterMonitoringConfig:ClusterMonitoringConfig": { "properties": { "componentConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/ClusterMonitoringConfigComponentConfig:ClusterMonitoringConfigComponentConfig" } }, "enableMetricsExternalCollection": { "type": "boolean", "description": "Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.\n" }, "workspaceId": { "type": "string", "description": "Workspace ID to which the monitoring data belongs.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "componentConfigs", "enableMetricsExternalCollection", "workspaceId" ] } } }, "volcenginecc:vke/ClusterMonitoringConfigComponentConfig:ClusterMonitoringConfigComponentConfig": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable this monitoring component. true means enabled; false means disabled.\n" }, "name": { "type": "string", "description": "Name of the monitoring component, such as 'prometheus', 'grafana', etc.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "name" ] } } }, "volcenginecc:vke/ClusterNodeStatistics:ClusterNodeStatistics": { "properties": { "creatingCount": { "type": "integer", "description": "Total number of nodes in Phase=Creating.\n" }, "deletingCount": { "type": "integer", "description": "Total number of nodes with Phase=Deleting.\n" }, "failedCount": { "type": "integer", "description": "Total number of nodes with Phase=Failed.\n" }, "runningCount": { "type": "integer", "description": "Total number of nodes with Phase=Running.\n" }, "totalCount": { "type": "integer", "description": "Total number of nodes.\n" }, "updatingCount": { "type": "integer", "description": "Total number of nodes in Phase=Updating.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "creatingCount", "deletingCount", "failedCount", "runningCount", "totalCount", "updatingCount" ] } } }, "volcenginecc:vke/ClusterPodsConfig:ClusterPodsConfig": { "properties": { "flannelConfig": { "$ref": "#/types/volcenginecc:vke/ClusterPodsConfigFlannelConfig:ClusterPodsConfigFlannelConfig", "description": "Flannel network configuration.\n" }, "podNetworkMode": { "type": "string", "description": "Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.\n" }, "vpcCniConfig": { "$ref": "#/types/volcenginecc:vke/ClusterPodsConfigVpcCniConfig:ClusterPodsConfigVpcCniConfig", "description": "VPC-CNI network configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "flannelConfig", "podNetworkMode", "vpcCniConfig" ] } } }, "volcenginecc:vke/ClusterPodsConfigFlannelConfig:ClusterPodsConfigFlannelConfig": { "properties": { "maxPodsPerNode": { "type": "integer", "description": "Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.\n" }, "podCidrs": { "type": "array", "items": { "type": "string" }, "description": "Pod CIDR for Flannel container network.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of Pod subnet IDs for the Flannel container network model.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "maxPodsPerNode", "podCidrs", "subnetIds" ] } } }, "volcenginecc:vke/ClusterPodsConfigVpcCniConfig:ClusterPodsConfigVpcCniConfig": { "properties": { "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of Pod subnet IDs for the VPC-CNI container network model.\n" }, "trunkEniEnabled": { "type": "boolean", "description": "Whether to enable Trunk mode for the VPC-CNI container network model\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "subnetIds", "trunkEniEnabled" ] } } }, "volcenginecc:vke/ClusterServicesConfig:ClusterServicesConfig": { "properties": { "serviceCidrsv4s": { "type": "array", "items": { "type": "string" }, "description": "IPv4 private network address exposed by Kubernetes Service.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "serviceCidrsv4s" ] } } }, "volcenginecc:vke/ClusterStatus:ClusterStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/ClusterStatusCondition:ClusterStatusCondition" } }, "phase": { "type": "string", "description": "Cluster status phase.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditions", "phase" ] } } }, "volcenginecc:vke/ClusterStatusCondition:ClusterStatusCondition": { "properties": { "type": { "type": "string", "description": "Condition type\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "volcenginecc:vke/ClusterTag:ClusterTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vke/DefaultNodePoolAutoScaling:DefaultNodePoolAutoScaling": { "properties": { "desiredReplicas": { "type": "integer", "description": "Configure the desired number of nodes in the node pool.\n" }, "enabled": { "type": "boolean", "description": "Configure the switch for node pool auto scaling. Parameter values: false: disabled true: enabled\n" }, "maxReplicas": { "type": "integer", "description": "Configure the maximum number of nodes in the node pool\n" }, "minReplicas": { "type": "integer", "description": "Configure the minimum number of nodes in the node pool\n" }, "priority": { "type": "integer", "description": "Priority\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID\n" }, "subnetPolicy": { "type": "string", "description": "Multi-subnet scheduling policy for the node pool. Parameter value description: ZoneBalance: availability zone balancing policy. Priority: subnet priority policy.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "desiredReplicas", "enabled", "maxReplicas", "minReplicas", "priority", "scalingGroupId", "subnetPolicy" ] } } }, "volcenginecc:vke/DefaultNodePoolKubernetesConfig:DefaultNodePoolKubernetesConfig": { "properties": { "autoSyncDisabled": { "type": "boolean", "description": "Whether to disable the automatic synchronization of label taints to existing nodes. Parameter value description: true: disabled, automatic synchronization is turned off. false: not disabled, automatic synchronization is turned on.\n" }, "cordon": { "type": "boolean", "description": "Node blocking configuration. Parameter value description: false: not blocked. true: blocked\n" }, "kubeletConfig": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolKubernetesConfigKubeletConfig:DefaultNodePoolKubernetesConfigKubeletConfig", "description": "Kubelet component configuration\n" }, "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolKubernetesConfigLabel:DefaultNodePoolKubernetesConfigLabel" } }, "namePrefix": { "type": "string", "description": "Prefix of the metadata name for node objects in Kubernetes.\n" }, "nameSuffix": { "type": "string", "description": "Suffix of the metadata name for node objects in Kubernetes.\n" }, "nameUseHostname": { "type": "boolean", "description": "Whether the metadata name of the node object in Kubernetes uses the ECS host name. Values: true: use ECS host name as node name. false: do not use ECS host name as node name\n" }, "taints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolKubernetesConfigTaint:DefaultNodePoolKubernetesConfigTaint" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoSyncDisabled", "cordon", "kubeletConfig", "labels", "namePrefix", "nameSuffix", "nameUseHostname", "taints" ] } } }, "volcenginecc:vke/DefaultNodePoolKubernetesConfigKubeletConfig:DefaultNodePoolKubernetesConfigKubeletConfig": { "properties": { "cpuManagerPolicy": { "type": "string", "description": "Configure kubelet's CpuManagerPolicy. Includes none and static strategies\n" }, "featureGates": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolKubernetesConfigKubeletConfigFeatureGates:DefaultNodePoolKubernetesConfigKubeletConfigFeatureGates", "description": "Feature gate.\n" }, "kubeApiBurst": { "type": "integer", "description": "Maximum number of burst requests sent to the API server per second. Does not include events and node heartbeat APIs, whose rate limits are controlled by a different set of flags.\n" }, "kubeApiQps": { "type": "integer", "description": "Queries per second (QPS) for communication with apiserver. Does not include event and node heartbeat APIs; their rate limits are controlled by a different set of flags\n" }, "kubeReserveds": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolKubernetesConfigKubeletConfigKubeReserved:DefaultNodePoolKubernetesConfigKubeletConfigKubeReserved" } }, "maxPods": { "type": "integer", "description": "Configure the maximum number of Pods supported by kubelet\n" }, "registryBurst": { "type": "integer", "description": "Set the maximum number of burst image pulls. Temporarily allow the number of image pulls specified by this parameter, provided it does not exceed the RegistryPullQps setting\n" }, "registryPullQps": { "type": "integer", "description": "Can be used to limit the QPS cap for the image repository\n" }, "serializeImagePulls": { "type": "boolean", "description": "Pull images one by one\n" }, "systemReserveds": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolKubernetesConfigKubeletConfigSystemReserved:DefaultNodePoolKubernetesConfigKubeletConfigSystemReserved" } }, "topologyManagerPolicy": { "type": "string", "description": "Topology management policy. Values: none: (default) topology management policy disabled. restricted: kubelet only accepts Pods that achieve optimal NUMA (Non-Uniform Memory Access) on requested resources. best-effort: kubelet prioritizes Pods that achieve NUMA on CPU and device resources. single-numa-node: kubelet only allows Pods that achieve NUMA on CPU and device resources within the same node.\n" }, "topologyManagerScope": { "type": "string", "description": "Resource granularity for topology management strategy. Values: container: resource alignment at container level. pod: resource alignment at Pod level\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cpuManagerPolicy", "featureGates", "kubeApiBurst", "kubeApiQps", "kubeReserveds", "maxPods", "registryBurst", "registryPullQps", "serializeImagePulls", "systemReserveds", "topologyManagerPolicy", "topologyManagerScope" ] } } }, "volcenginecc:vke/DefaultNodePoolKubernetesConfigKubeletConfigFeatureGates:DefaultNodePoolKubernetesConfigKubeletConfigFeatureGates": { "properties": { "inPlacePodVerticalScaling": { "type": "boolean", "description": "Whether to enable the feature switch for local vertical Pod autoscaling\n" }, "qoSResourceManager": { "type": "boolean", "description": "Enable QoSResourceManager feature switch. Options: - true to enable - false to disable\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "inPlacePodVerticalScaling", "qoSResourceManager" ] } } }, "volcenginecc:vke/DefaultNodePoolKubernetesConfigKubeletConfigKubeReserved:DefaultNodePoolKubernetesConfigKubeletConfigKubeReserved": { "properties": { "name": { "type": "string", "description": "Resource name. Values: cpu or memory\n" }, "quantity": { "type": "string", "description": "Specify the resource quantity. - For cpu, example value: 200m - For memory, example value: 1G\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "quantity" ] } } }, "volcenginecc:vke/DefaultNodePoolKubernetesConfigKubeletConfigSystemReserved:DefaultNodePoolKubernetesConfigKubeletConfigSystemReserved": { "properties": { "name": { "type": "string", "description": "Resource name. Values: cpu or memory.\n" }, "quantity": { "type": "string", "description": "Resource quantity for the specified resource. - For cpu, example value: 200m - For memory, example value: 1G\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "quantity" ] } } }, "volcenginecc:vke/DefaultNodePoolKubernetesConfigLabel:DefaultNodePoolKubernetesConfigLabel": { "properties": { "key": { "type": "string", "description": "Label key.\n" }, "value": { "type": "string", "description": "Label value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vke/DefaultNodePoolKubernetesConfigTaint:DefaultNodePoolKubernetesConfigTaint": { "properties": { "effect": { "type": "string", "description": "Taint effect. Values: NoSchedule (default): do not schedule. NoExecute: evict pods that do not tolerate the taint. PreferNoSchedule: avoid scheduling if possible.\n" }, "key": { "type": "string", "description": "Taint key\n" }, "value": { "type": "string", "description": "Taint value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "effect", "key", "value" ] } } }, "volcenginecc:vke/DefaultNodePoolManagement:DefaultNodePoolManagement": { "properties": { "enabled": { "type": "boolean", "description": "Whether managed mode is enabled for the node pool. Values: - true: enabled - false: disabled\n" }, "remedyConfig": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolManagementRemedyConfig:DefaultNodePoolManagementRemedyConfig", "description": "Check self-healing configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "remedyConfig" ] } } }, "volcenginecc:vke/DefaultNodePoolManagementRemedyConfig:DefaultNodePoolManagementRemedyConfig": { "properties": { "enabled": { "type": "boolean", "description": "Enable self-healing check\n" }, "remedyId": { "type": "string", "description": "Self-healing rule ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "remedyId" ] } } }, "volcenginecc:vke/DefaultNodePoolNodeConfig:DefaultNodePoolNodeConfig": { "properties": { "additionalContainerStorageEnabled": { "type": "boolean", "description": "Whether the first data disk on the node has been configured, formatted, and mounted as the storage directory for container images and logs. Parameter values: false: not configured and formatted true: configured and formatted\n" }, "autoRenew": { "type": "boolean", "description": "Whether the cloud server instance is automatically renewed upon expiration. Parameter values: true: auto renewal false: no auto renewal This parameter is returned only when InstanceChargeType=PrePaid.\n" }, "autoRenewPeriod": { "type": "integer", "description": "Automatic renewal duration for cloud server instance, in months. This parameter is returned only when AutoRenew=true.\n" }, "dataVolumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfigDataVolume:DefaultNodePoolNodeConfigDataVolume" } }, "deploymentSetGroupNumber": { "type": "integer", "description": "Group number of the instance in the deployment set. 0 means not set\n" }, "deploymentSetId": { "type": "string", "description": "Deployment set ID to be added to the instance\n" }, "hostname": { "type": "string", "description": "Host name corresponding to the node\n" }, "hpcClusterIds": { "type": "array", "items": { "type": "string" }, "description": "High performance computing cluster ID. When the node pool is configured with high performance computing GPU node types, returns the high performance computing cluster ID\n" }, "imageId": { "type": "string", "description": "Image ID used by the cloud server corresponding to the node\n" }, "initializeScript": { "type": "string", "description": "Custom script executed after creating and initializing the node. Shell script in Base64 encoding\n" }, "instanceChargeType": { "type": "string", "description": "Billing type for cloud server instance. Parameter value description: PostPaid: pay-as-you-go. PrePaid: subscription (annual/monthly).\n" }, "instanceName": { "type": "string", "description": "Node (instance) name\n" }, "instanceTypeIds": { "type": "array", "items": { "type": "string" }, "description": "List of cloud server instance type IDs corresponding to the node\n" }, "instancesDistribution": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfigInstancesDistribution:DefaultNodePoolNodeConfigInstancesDistribution", "description": "Configure the mixed strategy for spot and pay-as-you-go instances. This strategy takes effect when SpotStrategy is set to SpotAsPriceGo\n" }, "namePrefix": { "type": "string", "description": "Node name prefix. An empty string or nil means the node name prefix policy is not enabled\n" }, "networkTrafficMode": { "type": "string", "description": "Network communication mode between nodes\n" }, "period": { "type": "integer", "description": "Duration for purchasing cloud server instance, in months. This parameter is returned only when InstanceChargeType=PrePaid\n" }, "preScript": { "type": "string", "description": "Script executed before deploying nodes\n" }, "projectName": { "type": "string", "description": "The project to which the ECS belongs. Each ECS can only belong to one project.\n" }, "publicAccessConfig": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfigPublicAccessConfig:DefaultNodePoolNodeConfigPublicAccessConfig", "description": "Configuration for automatic public network access for nodes\n" }, "publicAccessEnabled": { "type": "boolean", "description": "Whether the node automatically enables public network access. Values: - false: disabled - true: enabled\n" }, "security": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfigSecurity:DefaultNodePoolNodeConfigSecurity", "description": "Node security configuration.\n" }, "spotStrategy": { "type": "string", "description": "Preemptive policy for pay-as-you-go billing. When InstanceChargeType=PostPaid: NoSpot: regular pay-as-you-go instance. SpotAsPriceGo: system auto-bidding, follows current market price.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs to which the node network belongs.\n" }, "systemVolume": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfigSystemVolume:DefaultNodePoolNodeConfigSystemVolume", "description": "System disk configuration for the node\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfigTag:DefaultNodePoolNodeConfigTag" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "additionalContainerStorageEnabled", "autoRenew", "autoRenewPeriod", "dataVolumes", "deploymentSetGroupNumber", "deploymentSetId", "hostname", "hpcClusterIds", "imageId", "initializeScript", "instanceChargeType", "instanceName", "instanceTypeIds", "instancesDistribution", "namePrefix", "networkTrafficMode", "period", "preScript", "projectName", "publicAccessConfig", "publicAccessEnabled", "security", "spotStrategy", "subnetIds", "systemVolume", "tags" ] } } }, "volcenginecc:vke/DefaultNodePoolNodeConfigDataVolume:DefaultNodePoolNodeConfigDataVolume": { "properties": { "fileSystem": { "type": "string", "description": "File system. Options: - Ext4 (default) - Xfs\n" }, "mountPoint": { "type": "string", "description": "Target mount directory after disk formatting.\n" }, "placementGroupId": { "type": "string", "description": "Placement group ID\n" }, "size": { "type": "integer", "description": "Disk capacity, in GiB\n" }, "snapshotId": { "type": "string", "description": "Create a data disk using a snapshot. You can call the DescribeSnapshots API to query the snapshot ID. Note: Only ultra-fast SSD and efficient cloud disks support creating disks from snapshots. Only snapshots in 'available' status can be used to create new disks; snapshots in 'creating', 'rolling back', 'deleting', or 'error' status cannot be used to create new disks\n" }, "subgroupNumber": { "type": "integer", "description": "Placement subgroup\n" }, "type": { "type": "string", "description": "Disk type: ESSD*PL0: ultra-fast SSD cloud disk with performance level PL0. ESSD*FlexPL: ultra-fast SSD cloud disk with performance level PL1.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fileSystem", "mountPoint", "placementGroupId", "size", "snapshotId", "subgroupNumber", "type" ] } } }, "volcenginecc:vke/DefaultNodePoolNodeConfigInstancesDistribution:DefaultNodePoolNodeConfigInstancesDistribution": { "properties": { "capacityRebalance": { "type": "boolean", "description": "Capacity rebalancing. Value range: - true: enables this feature. When a preemptible instance is about to be reclaimed, a new preemptible instance is proactively created for compensation. - false (default): disables this feature. Waits until the preemptible instance is reclaimed before scaling out to make up the instance count.\n" }, "compensateWithOnDemand": { "type": "boolean", "description": "Pay-as-you-go instance fallback feature. Value range: - true: enables this feature. If all preemptible instances fail to purchase due to insufficient inventory, pay-as-you-go instances will be attempted - false (default): disables this feature. When scaling preemptible instances, only the configured preemptible instances are attempted\n" }, "onDemandBaseCapacity": { "type": "integer", "description": "Base capacity size. The base capacity is always pay-as-you-go instances. Value range: [0,500], default: 0\n" }, "onDemandPercentageAboveBaseCapacity": { "type": "integer", "description": "Proportion of pay-as-you-go instances for capacity exceeding the base capacity. Value range [0, 100]. 0 means only preemptible instances are produced for excess capacity; 100 means only pay-as-you-go instances are produced. Default is 0.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "capacityRebalance", "compensateWithOnDemand", "onDemandBaseCapacity", "onDemandPercentageAboveBaseCapacity" ] } } }, "volcenginecc:vke/DefaultNodePoolNodeConfigPublicAccessConfig:DefaultNodePoolNodeConfigPublicAccessConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth for the public IP, unit: Mbps\n" }, "billingType": { "type": "integer", "description": "Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.\n" }, "isp": { "type": "string", "description": "Public IP line type. Parameter description: BGP: BGP (multi-line)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "billingType", "isp" ] } } }, "volcenginecc:vke/DefaultNodePoolNodeConfigSecurity:DefaultNodePoolNodeConfigSecurity": { "properties": { "login": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfigSecurityLogin:DefaultNodePoolNodeConfigSecurityLogin", "description": "Node access configuration\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs for the node network\n" }, "securityStrategies": { "type": "array", "items": { "type": "string" }, "description": "Node security policy. Parameter value description: Hids: host security hardening\n" }, "securityStrategyEnabled": { "type": "boolean", "description": "Whether security hardening is enabled for the node. Parameter value description: true: enabled. false: not enabled.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "login", "securityGroupIds", "securityStrategies", "securityStrategyEnabled" ] } } }, "volcenginecc:vke/DefaultNodePoolNodeConfigSecurityLogin:DefaultNodePoolNodeConfigSecurityLogin": { "properties": { "password": { "type": "string", "description": "Root user login password in Base64 encoding. Follow the cloud server password requirements: 8–30 characters, cannot start with / or $6$, must include at least three of the following: lowercase letters a–z, uppercase letters A–Z, numbers 0–9, special characters ( ) ` ~ ! @ # $ % ^ \u0026 * _ - + = | { } [ ] : ; ' \u003c \u003e , . ? /\n" }, "sshKeyPairName": { "type": "string", "description": "SSH key pair name. Please ensure the key pair is already created or hosted in the cloud server\n" }, "type": { "type": "string", "description": "Node access login method. Parameter value description: Password: password login. SshKeyPair: SSH key pair login.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "password", "sshKeyPairName", "type" ] } } }, "volcenginecc:vke/DefaultNodePoolNodeConfigSystemVolume:DefaultNodePoolNodeConfigSystemVolume": { "properties": { "placementGroupId": { "type": "string", "description": "Placement group ID\n" }, "size": { "type": "integer", "description": "Cloud disk capacity, in GiB. Value description: default: 40 GiB. Ultra-fast SSD (ESSD*PL0, ESSD*FlexPL): 40–2048 GiB\n" }, "subgroupNumber": { "type": "integer", "description": "Placement subgroup\n" }, "type": { "type": "string", "description": "Cloud disk type: ESSD*PL0: (default) Ultra SSD with performance level PL0. ESSD*FlexPL: Ultra SSD with performance level PL1\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "placementGroupId", "size", "subgroupNumber", "type" ] } } }, "volcenginecc:vke/DefaultNodePoolNodeConfigTag:DefaultNodePoolNodeConfigTag": { "properties": { "key": { "type": "string", "description": "Label key.\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vke/DefaultNodePoolNodeStatistics:DefaultNodePoolNodeStatistics": { "properties": { "creatingCount": { "type": "integer", "description": "Total number of nodes with Phase=Creating.\n" }, "deletingCount": { "type": "integer", "description": "Total number of nodes with Phase=Deleting.\n" }, "failedCount": { "type": "integer", "description": "Total number of nodes with Phase=Failed\n" }, "runningCount": { "type": "integer", "description": "Total number of nodes with Phase=Running\n" }, "totalCount": { "type": "integer", "description": "Total number of nodes in the node pool.\n" }, "updatingCount": { "type": "integer", "description": "Total number of nodes with Phase=Updating\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "creatingCount", "deletingCount", "failedCount", "runningCount", "totalCount", "updatingCount" ] } } }, "volcenginecc:vke/DefaultNodePoolStatus:DefaultNodePoolStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolStatusCondition:DefaultNodePoolStatusCondition" } }, "phase": { "type": "string", "description": "Status of the node pool. Parameter values: Creating, Running, Updating, Deleting, Failed, Scaling.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditions", "phase" ] } } }, "volcenginecc:vke/DefaultNodePoolStatusCondition:DefaultNodePoolStatusCondition": { "properties": { "type": { "type": "string", "description": "Status conditions under the current primary state of the node pool, indicating the reasons for entering this state. There can be multiple reasons. Parameter values: ProgressingOk, ResourceCleanupFailed, Unknown, ClusterNotRunning.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "volcenginecc:vke/DefaultNodePoolTag:DefaultNodePoolTag": { "properties": { "key": { "type": "string", "description": "Label key.\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vke/NodeKubernetesConfig:NodeKubernetesConfig": { "properties": { "cordon": { "type": "boolean", "description": "Node lock configuration. Options: false (default): not locked; true: locked\n" }, "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodeKubernetesConfigLabel:NodeKubernetesConfigLabel" } }, "taints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodeKubernetesConfigTaint:NodeKubernetesConfigTaint" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cordon", "labels", "taints" ] } } }, "volcenginecc:vke/NodeKubernetesConfigLabel:NodeKubernetesConfigLabel": { "properties": { "key": { "type": "string", "description": "Label key. A valid label key consists of two parts: \\n\\n and \\n\\n, separated by a slash (/). \\n\\n is required and supports uppercase and lowercase English letters, numbers, hyphens (-), underscores (_), and periods (.), must start and end with a letter or number, and must not exceed 63 characters. \\n\\n is optional. If specified, \\n\\n must be a DNS subdomain: a series of DNS labels separated by periods (.), with a maximum length of 253 characters. The total length of \\n\\n and \\n\\n must not exceed 82 characters.\n" }, "value": { "type": "string", "description": "Tag value, up to 63 characters (can be empty). Can start and end with an English letter (upper or lower case) or a digit. Supported special characters: hyphen (-), underscore (_), period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vke/NodeKubernetesConfigTaint:NodeKubernetesConfigTaint": { "properties": { "effect": { "type": "string", "description": "Taint effect. Options: NoSchedule (default): Do not schedule. NoExecute: Evict Pods that do not tolerate the taint. PreferNoSchedule: Avoid scheduling if possible.\n" }, "key": { "type": "string", "description": "Taint key. A valid taint key has two segments: \\n\\n and \\n\\n, separated by a slash (/). \\n\\n is required and supports English letters (case-sensitive), numbers, hyphen (-), underscore (_), and period (.), must start and end with a letter or number, and be no longer than 63 characters. \\n\\n is optional. If specified, \\n\\n must be a DNS subdomain: a series of DNS labels separated by periods (.), no longer than 253 characters. The total length of \\n\\n and \\n\\n must not exceed 82 characters.\n" }, "value": { "type": "string", "description": "Taint value, up to 63 characters (can be empty). Must start and end with an English letter or number. Supports special characters: hyphen (-), underscore (_), and period (.).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "effect", "key", "value" ] } } }, "volcenginecc:vke/NodePoolAutoScaling:NodePoolAutoScaling": { "properties": { "desiredReplicas": { "type": "integer", "description": "Configure the expected number of nodes in the node pool\n" }, "enabled": { "type": "boolean", "description": "Configure the node pool auto scaling feature switch. Parameter values: false: disabled. true: enabled.\n" }, "maxReplicas": { "type": "integer", "description": "Configure the maximum number of nodes in the node pool\n" }, "minReplicas": { "type": "integer", "description": "Minimum number of nodes configured for the node pool\n" }, "priority": { "type": "integer", "description": "Priority\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID\n" }, "subnetPolicy": { "type": "string", "description": "Multi-subnet scheduling strategy for the node pool. Parameter values: ZoneBalance: availability zone balancing strategy. Priority: subnet priority strategy.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "desiredReplicas", "enabled", "maxReplicas", "minReplicas", "priority", "scalingGroupId", "subnetPolicy" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfig:NodePoolKubernetesConfig": { "properties": { "autoSyncDisabled": { "type": "boolean", "description": "Disable automatic synchronization of labels and taints to existing nodes. Parameter values: true: disable (turn off automatic sync). false: do not disable (turn on automatic sync)\n" }, "containerdConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfigContainerdConfig:NodePoolKubernetesConfigContainerdConfig", "description": "Node pool Containerd configuration\n" }, "cordon": { "type": "boolean", "description": "Node blocking configuration. Parameter values: false: not blocked; true: blocked\n" }, "kubeletConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfigKubeletConfig:NodePoolKubernetesConfigKubeletConfig", "description": "Kubelet component configuration\n" }, "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfigLabel:NodePoolKubernetesConfigLabel" } }, "namePrefix": { "type": "string", "description": "Prefix for node object metadata name in Kubernetes\n" }, "nameSuffix": { "type": "string", "description": "Suffix for node object metadata name in Kubernetes\n" }, "nameUseHostname": { "type": "boolean", "description": "Whether the node object metadata name in Kubernetes uses the ECS host name. Values: true: use ECS host name as node name; false: do not use ECS host name as node name\n" }, "taints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfigTaint:NodePoolKubernetesConfigTaint" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoSyncDisabled", "containerdConfig", "cordon", "kubeletConfig", "labels", "namePrefix", "nameSuffix", "nameUseHostname", "taints" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfigContainerdConfig:NodePoolKubernetesConfigContainerdConfig": { "properties": { "insecureRegistries": { "type": "array", "items": { "type": "string" }, "description": "Specify the container image repository address to skip certificate verification.\n" }, "registryProxyConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfigContainerdConfigRegistryProxyConfig:NodePoolKubernetesConfigContainerdConfigRegistryProxyConfig" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "insecureRegistries", "registryProxyConfigs" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfigContainerdConfigRegistryProxyConfig:NodePoolKubernetesConfigContainerdConfigRegistryProxyConfig": { "properties": { "proxyEndpoints": { "type": "array", "items": { "type": "string" }, "description": "Proxy address.\n" }, "registry": { "type": "string", "description": "Container image repository address.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "proxyEndpoints", "registry" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfigKubeletConfig:NodePoolKubernetesConfigKubeletConfig": { "properties": { "cpuManagerPolicy": { "type": "string", "description": "Configure kubelet CpuManagerPolicy. Supports none and static policies\n" }, "evictionHards": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfigKubeletConfigEvictionHard:NodePoolKubernetesConfigKubeletConfigEvictionHard" } }, "featureGates": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfigKubeletConfigFeatureGates:NodePoolKubernetesConfigKubeletConfigFeatureGates", "description": "Feature gate\n" }, "kubeApiBurst": { "type": "integer", "description": "Maximum burst request rate sent to the API server per second. Excludes events and node heartbeat APIs, whose rate limits are controlled by a different set of flags\n" }, "kubeApiQps": { "type": "integer", "description": "Queries per second (QPS) for communication with apiserver. Events and node heartbeat APIs are not included; their rate limits are controlled by a different set of flags.\n" }, "kubeReserveds": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfigKubeletConfigKubeReserved:NodePoolKubernetesConfigKubeletConfigKubeReserved" } }, "maxPods": { "type": "integer", "description": "Configure the maximum number of Pods supported by kubelet\n" }, "registryBurst": { "type": "integer", "description": "Set the maximum number of burst image pulls. Temporarily allows the number of image pulls specified by this parameter, provided it does not exceed the RegistryPullQps setting\n" }, "registryPullQps": { "type": "integer", "description": "Used to limit the QPS cap for the image repository\n" }, "serializeImagePulls": { "type": "boolean", "description": "Pull images sequentially\n" }, "systemReserveds": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfigKubeletConfigSystemReserved:NodePoolKubernetesConfigKubeletConfigSystemReserved" } }, "topologyManagerPolicy": { "type": "string", "description": "Topology management policy. Values: none (default): disables topology management policy. restricted: kubelet only accepts Pods that achieve optimal NUMA (Non-Uniform Memory Access) on requested resources. best-effort: kubelet prioritizes Pods that achieve NUMA on CPU and device resources. single-numa-node: kubelet only allows Pods that achieve NUMA on CPU and device resources within the same node\n" }, "topologyManagerScope": { "type": "string", "description": "Resource granularity for topology management policy. Values: container: resource alignment at container level pod: resource alignment at Pod level\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cpuManagerPolicy", "evictionHards", "featureGates", "kubeApiBurst", "kubeApiQps", "kubeReserveds", "maxPods", "registryBurst", "registryPullQps", "serializeImagePulls", "systemReserveds", "topologyManagerPolicy", "topologyManagerScope" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfigKubeletConfigEvictionHard:NodePoolKubernetesConfigKubeletConfigEvictionHard": { "properties": { "key": { "type": "string", "description": "Hard threshold name. Options: memory.available, nodefs.available, nodefs.inodesFree, imagefs.available\n" }, "value": { "type": "string", "description": "Hard threshold value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfigKubeletConfigFeatureGates:NodePoolKubernetesConfigKubeletConfigFeatureGates": { "properties": { "inPlacePodVerticalScaling": { "type": "boolean", "description": "Enable local vertical Pod autoscaling feature toggle\n" }, "qoSResourceManager": { "type": "boolean", "description": "Whether to enable the QoSResourceManager feature switch. Values: - true enabled; - false disabled\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "inPlacePodVerticalScaling", "qoSResourceManager" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfigKubeletConfigKubeReserved:NodePoolKubernetesConfigKubeletConfigKubeReserved": { "properties": { "name": { "type": "string", "description": "Resource name. Valid values: cpu or memory.\n" }, "quantity": { "type": "string", "description": "Specify the resource quantity. - For cpu, example value: 200m - For memory, example value: 1G\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "quantity" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfigKubeletConfigSystemReserved:NodePoolKubernetesConfigKubeletConfigSystemReserved": { "properties": { "name": { "type": "string", "description": "Resource name. Valid values: cpu or memory.\n" }, "quantity": { "type": "string", "description": "Resource quantity for the specified resource. - For cpu, example value: 200m. - For memory, example value: 1G.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "quantity" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfigLabel:NodePoolKubernetesConfigLabel": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Label value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vke/NodePoolKubernetesConfigTaint:NodePoolKubernetesConfigTaint": { "properties": { "effect": { "type": "string", "description": "Taint effect. Values: NoSchedule: (default) Do not schedule. NoExecute: Evict pods that do not tolerate the taint. PreferNoSchedule: Prefer not to schedule.\n" }, "key": { "type": "string", "description": "Taint key.\n" }, "value": { "type": "string", "description": "Taint value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "effect", "key", "value" ] } } }, "volcenginecc:vke/NodePoolManagement:NodePoolManagement": { "properties": { "enabled": { "type": "boolean", "description": "Enable managed mode for node pool. Options: - true: on - false: off\n" }, "remedyConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolManagementRemedyConfig:NodePoolManagementRemedyConfig", "description": "Check self-healing configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "remedyConfig" ] } } }, "volcenginecc:vke/NodePoolManagementRemedyConfig:NodePoolManagementRemedyConfig": { "properties": { "enabled": { "type": "boolean", "description": "Enable self-healing check\n" }, "remedyId": { "type": "string", "description": "Self-healing rule ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "remedyId" ] } } }, "volcenginecc:vke/NodePoolNodeConfig:NodePoolNodeConfig": { "properties": { "additionalContainerStorageEnabled": { "type": "boolean", "description": "Whether the first data disk of the node is configured, formatted, and mounted as the storage directory for container images and logs. Parameter values: false: not configured and formatted; true: configured and formatted\n" }, "autoRenew": { "type": "boolean", "description": "Whether the cloud server instance will be automatically renewed upon expiration. Parameter description: true: auto renewal false: no auto renewal This parameter is returned only when InstanceChargeType=PrePaid.\n" }, "autoRenewPeriod": { "type": "integer", "description": "Automatic renewal duration for cloud server instances, in months. This parameter is returned only when AutoRenew=true\n" }, "dataVolumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfigDataVolume:NodePoolNodeConfigDataVolume" } }, "deploymentSetGroupNumber": { "type": "integer", "description": "Group number of the instance in the deployment set; 0 means not set\n" }, "deploymentSetId": { "type": "string", "description": "Deployment Set ID to be added to the instance\n" }, "hostname": { "type": "string", "description": "The host name corresponding to the node.\n" }, "hpcClusterIds": { "type": "array", "items": { "type": "string" }, "description": "High performance computing cluster ID. When the node pool is configured with high performance computing GPU node types, returns the high performance computing cluster ID\n" }, "imageId": { "type": "string", "description": "Image ID used by the cloud server corresponding to the node\n" }, "initializeScript": { "type": "string", "description": "Custom script executed after node creation and initialization. Shell script in Base64 encoding\n" }, "instanceChargeType": { "type": "string", "description": "Cloud server instance billing type. Parameter values: PostPaid: pay-as-you-go. PrePaid: subscription (annual/monthly).\n" }, "instanceName": { "type": "string", "description": "Node (instance) name\n" }, "instanceTypeIds": { "type": "array", "items": { "type": "string" }, "description": "List of cloud server instance type IDs corresponding to the nodes\n" }, "instancesDistribution": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfigInstancesDistribution:NodePoolNodeConfigInstancesDistribution", "description": "Set the mixed strategy for spot and pay-as-you-go instances. This strategy takes effect when SpotStrategy is SpotAsPriceGo.\n" }, "namePrefix": { "type": "string", "description": "Node name prefix. An empty string or nil means the node name prefix policy is not enabled.\n" }, "networkTrafficMode": { "type": "string", "description": "Network communication mode between nodes\n" }, "period": { "type": "integer", "description": "Purchase duration for cloud server instances, in months. This parameter is returned only when InstanceChargeType=PrePaid\n" }, "preScript": { "type": "string", "description": "Script to execute before deploying the node\n" }, "projectName": { "type": "string", "description": "Project to which the ECS belongs. Each ECS can only belong to one project.\n" }, "publicAccessConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfigPublicAccessConfig:NodePoolNodeConfigPublicAccessConfig", "description": "Configuration for automatic public network access for nodes\n" }, "publicAccessEnabled": { "type": "boolean", "description": "Enable public network access for nodes automatically. Options: - false: off - true: on\n" }, "security": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfigSecurity:NodePoolNodeConfigSecurity", "description": "Node security configuration\n" }, "spotStrategy": { "type": "string", "description": "Spot pricing strategy for pay-as-you-go billing. When InstanceChargeType=PostPaid: NoSpot: Standard pay-as-you-go instance. SpotAsPriceGo: System automatically bids, following the current market price.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs for the node network.\n" }, "systemVolume": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfigSystemVolume:NodePoolNodeConfigSystemVolume", "description": "System disk configuration for the node\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfigTag:NodePoolNodeConfigTag" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "additionalContainerStorageEnabled", "autoRenew", "autoRenewPeriod", "dataVolumes", "deploymentSetGroupNumber", "deploymentSetId", "hostname", "hpcClusterIds", "imageId", "initializeScript", "instanceChargeType", "instanceName", "instanceTypeIds", "instancesDistribution", "namePrefix", "networkTrafficMode", "period", "preScript", "projectName", "publicAccessConfig", "publicAccessEnabled", "security", "spotStrategy", "subnetIds", "systemVolume", "tags" ] } } }, "volcenginecc:vke/NodePoolNodeConfigDataVolume:NodePoolNodeConfigDataVolume": { "properties": { "fileSystem": { "type": "string", "description": "File system. Options: - Ext4 (default) - Xfs\n" }, "mountPoint": { "type": "string", "description": "Target mount directory after disk formatting.\n" }, "placementGroupId": { "type": "string", "description": "Placement group ID\n" }, "size": { "type": "integer", "description": "Disk capacity, in GiB.\n" }, "snapshotId": { "type": "string", "description": "Create a data disk from a snapshot. You can call the DescribeSnapshots API to query the snapshot ID. Note: Only Ultra SSD and High-performance Cloud Disk support creating disks from snapshots. Only snapshots in the 'available' status can be used to create new disks. Snapshots in 'creating', 'rolling back', 'deleting', or 'error' status cannot be used to create new disks.\n" }, "subgroupNumber": { "type": "integer", "description": "Placement subgroup\n" }, "type": { "type": "string", "description": "Disk type: ESSD*PL0: ultra-fast SSD disk with performance level PL0. ESSD*FlexPL: ultra-fast SSD disk with performance level PL1\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fileSystem", "mountPoint", "placementGroupId", "size", "snapshotId", "subgroupNumber", "type" ] } } }, "volcenginecc:vke/NodePoolNodeConfigInstancesDistribution:NodePoolNodeConfigInstancesDistribution": { "properties": { "capacityRebalance": { "type": "boolean", "description": "Capacity rebalancing. Value range: - true: enables this feature. When a preemptible instance is about to be reclaimed, proactively creates a new preemptible instance for compensation. - false (default): disables this feature. Waits until the preemptible instance is reclaimed before scaling out to make up the instance count\n" }, "compensateWithOnDemand": { "type": "boolean", "description": "On-demand instance fallback feature. Value range: - true: enable this feature; when all preemptible instances fail to purchase due to insufficient inventory or other reasons, attempt to purchase on-demand instances - false (default): disable this feature; only attempt to purchase configured preemptible instances when scaling up\n" }, "onDemandBaseCapacity": { "type": "integer", "description": "Size of the base capacity. The base capacity is always pay-as-you-go instances. Value range: [0,500], default is 0.\n" }, "onDemandPercentageAboveBaseCapacity": { "type": "integer", "description": "Proportion of pay-as-you-go instances in the part exceeding the base capacity. Value range: [0, 100]. 0 means only preemptible instances are produced for the part exceeding the base capacity; 100 means only pay-as-you-go instances are produced. Default value is 0.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "capacityRebalance", "compensateWithOnDemand", "onDemandBaseCapacity", "onDemandPercentageAboveBaseCapacity" ] } } }, "volcenginecc:vke/NodePoolNodeConfigPublicAccessConfig:NodePoolNodeConfigPublicAccessConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth for public IP, unit: Mbps\n" }, "billingType": { "type": "integer", "description": "Billing type for public IP: 2: pay-as-you-go by bandwidth cap. 3: pay-as-you-go by actual traffic.\n" }, "isp": { "type": "string", "description": "Public IP line type. Parameter description: BGP: BGP (multi-line)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bandwidth", "billingType", "isp" ] } } }, "volcenginecc:vke/NodePoolNodeConfigSecurity:NodePoolNodeConfigSecurity": { "properties": { "login": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfigSecurityLogin:NodePoolNodeConfigSecurityLogin", "description": "Node access configuration.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs for the node network\n" }, "securityStrategies": { "type": "array", "items": { "type": "string" }, "description": "Node security policy. Parameter description: Hids: Host security hardening.\n" }, "securityStrategyEnabled": { "type": "boolean", "description": "Whether the node has enabled security hardening configuration. Parameter values: true: enabled; false: not enabled\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "login", "securityGroupIds", "securityStrategies", "securityStrategyEnabled" ] } } }, "volcenginecc:vke/NodePoolNodeConfigSecurityLogin:NodePoolNodeConfigSecurityLogin": { "properties": { "password": { "type": "string", "description": "Root user login password in Base64 encoding. Follow the cloud server's requirements for instance passwords: 8–30 characters in length, must not start with / or $6$, supports the following character types and must include at least three types: lowercase letters a–z, uppercase letters A–Z, numbers 0–9, special characters ( ) ` ~ ! @ # $ % ^ \u0026 * _ - + = | { } [ ] : ; ' \u003c \u003e , . ? /\n" }, "sshKeyPairName": { "type": "string", "description": "SSH key pair name. Ensure the key pair is already created or hosted in the cloud server\n" }, "type": { "type": "string", "description": "Node access login method. Parameter values: Password: password login; SshKeyPair: SSH key pair login\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "password", "sshKeyPairName", "type" ] } } }, "volcenginecc:vke/NodePoolNodeConfigSystemVolume:NodePoolNodeConfigSystemVolume": { "properties": { "placementGroupId": { "type": "string", "description": "Placement group ID\n" }, "size": { "type": "integer", "description": "Disk capacity, in GiB. Value description: Default: 40 GiB. Ultra-fast SSD (ESSD*PL0, ESSD*FlexPL): 40–2048 GiB\n" }, "subgroupNumber": { "type": "integer", "description": "Placement subgroup\n" }, "type": { "type": "string", "description": "Cloud disk types: ESSD*PL0: (default) Ultra-fast SSD cloud disk with performance level PL0. ESSD*FlexPL: Ultra-fast SSD cloud disk with performance level PL1.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "placementGroupId", "size", "subgroupNumber", "type" ] } } }, "volcenginecc:vke/NodePoolNodeConfigTag:NodePoolNodeConfigTag": { "properties": { "key": { "type": "string", "description": "Label key\n" }, "value": { "type": "string", "description": "Label value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vke/NodePoolNodeStatistics:NodePoolNodeStatistics": { "properties": { "creatingCount": { "type": "integer", "description": "Total number of nodes in Phase=Creating.\n" }, "deletingCount": { "type": "integer", "description": "Total number of nodes with Phase=Deleting\n" }, "failedCount": { "type": "integer", "description": "Total number of nodes with Phase=Failed\n" }, "runningCount": { "type": "integer", "description": "Total number of nodes with Phase=Running\n" }, "totalCount": { "type": "integer", "description": "Total number of nodes in the node pool\n" }, "updatingCount": { "type": "integer", "description": "Total number of nodes with Phase=Updating\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "creatingCount", "deletingCount", "failedCount", "runningCount", "totalCount", "updatingCount" ] } } }, "volcenginecc:vke/NodePoolStatus:NodePoolStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolStatusCondition:NodePoolStatusCondition" } }, "phase": { "type": "string", "description": "Status of the node pool. Parameter values: Creating, Running, Updating, Deleting, Failed, Scaling\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditions", "phase" ] } } }, "volcenginecc:vke/NodePoolStatusCondition:NodePoolStatusCondition": { "properties": { "type": { "type": "string", "description": "Status conditions for the node pool in the current main state, i.e., the reasons for entering this main state. There can be multiple reasons. Parameter values: ProgressingOk, ResourceCleanupFailed, Unknown, ClusterNotRunning.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "volcenginecc:vke/NodePoolTag:NodePoolTag": { "properties": { "key": { "type": "string", "description": "Label key\n" }, "value": { "type": "string", "description": "Label value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vke/NodeStatus:NodeStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodeStatusCondition:NodeStatusCondition" } }, "phase": { "type": "string", "description": "Node status. Parameter values: Creating, Running, Deleting, Failed, Updating.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditions", "phase" ] } } }, "volcenginecc:vke/NodeStatusCondition:NodeStatusCondition": { "properties": { "type": { "type": "string", "description": "Status condition under the node's current primary state, indicating the reason for entering this primary state. There can be multiple reasons. Parameter values: Progressing, Ok, Unschedulable, InitilizeFailed, NotReady, Balance, ResourceCleanupFailed, Unknown.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type" ] } } }, "volcenginecc:vke/getAddonStatus:getAddonStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getAddonStatusCondition:getAddonStatusCondition" }, "description": "Status conditions under the component's current primary state.\n" }, "phase": { "type": "string", "description": "Component status. Parameter values include: Running, Failed, Creating, Deleting, Updating\n" } }, "type": "object", "required": [ "conditions", "phase" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getAddonStatusCondition:getAddonStatusCondition": { "properties": { "type": { "type": "string", "description": "Status conditions under the component's current primary state, indicating the reasons for entering this state. Multiple reasons are possible. Parameter values include: Progressing, ClusterVersionUpgrading, Unknown, Degraded, NameConflict, ClusterNotRunning, CrashLoopBackOff, SchedulingFailed, ResourceCleanupFailed\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterClusterConfig:getClusterClusterConfig": { "properties": { "apiServerEndpoints": { "$ref": "#/types/volcenginecc:vke/getClusterClusterConfigApiServerEndpoints:getClusterClusterConfigApiServerEndpoints", "description": "Cluster API Server access IPv4 address information\n" }, "apiServerPublicAccessConfig": { "$ref": "#/types/volcenginecc:vke/getClusterClusterConfigApiServerPublicAccessConfig:getClusterClusterConfigApiServerPublicAccessConfig", "description": "Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true\n" }, "apiServerPublicAccessEnabled": { "type": "boolean", "description": "Node public access configuration. Parameter value description: false: Disabled. true: Enabled\n" }, "ipFamily": { "type": "string", "description": "Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack\n" }, "resourcePublicAccessDefaultEnabled": { "type": "boolean", "description": "Node public access configuration. Parameter value description: false: Disabled. true: Enabled\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group used by the cluster control plane and nodes.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID for cluster control plane communication within the private network.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID where the cluster control plane and some nodes are located.\n" } }, "type": "object", "required": [ "apiServerEndpoints", "apiServerPublicAccessConfig", "apiServerPublicAccessEnabled", "ipFamily", "resourcePublicAccessDefaultEnabled", "securityGroupIds", "subnetIds", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterClusterConfigApiServerEndpoints:getClusterClusterConfigApiServerEndpoints": { "properties": { "privateIp": { "$ref": "#/types/volcenginecc:vke/getClusterClusterConfigApiServerEndpointsPrivateIp:getClusterClusterConfigApiServerEndpointsPrivateIp", "description": "Cluster API Server private IPv4 address.\n" }, "publicIp": { "$ref": "#/types/volcenginecc:vke/getClusterClusterConfigApiServerEndpointsPublicIp:getClusterClusterConfigApiServerEndpointsPublicIp", "description": "Cluster API Server public IPv4 address\n" } }, "type": "object", "required": [ "privateIp", "publicIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterClusterConfigApiServerEndpointsPrivateIp:getClusterClusterConfigApiServerEndpointsPrivateIp": { "properties": { "ipv4": { "type": "string", "description": "IPv4 address of the private network IP.\n" } }, "type": "object", "required": [ "ipv4" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterClusterConfigApiServerEndpointsPublicIp:getClusterClusterConfigApiServerEndpointsPublicIp": { "properties": { "ipv4": { "type": "string", "description": "IPv4 address of the public IP.\n" } }, "type": "object", "required": [ "ipv4" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterClusterConfigApiServerPublicAccessConfig:getClusterClusterConfigApiServerPublicAccessConfig": { "properties": { "publicAccessNetworkConfig": { "$ref": "#/types/volcenginecc:vke/getClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig:getClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig", "description": "Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true\n" } }, "type": "object", "required": [ "publicAccessNetworkConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig:getClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of the public IP, unit: Mbps\n" }, "billingType": { "type": "integer", "description": "Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.\n" }, "isp": { "type": "string", "description": "Line type of the public IP. Parameter value description: BGP: BGP (multi-line)\n" } }, "type": "object", "required": [ "bandwidth", "billingType", "isp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterIrsaConfig:getClusterIrsaConfig": { "properties": { "audience": { "type": "string", "description": "Identifier for accepting tokens\n" }, "enabled": { "type": "boolean", "description": "Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.\n" }, "issuer": { "type": "string", "description": "OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.\n" }, "jwksUrl": { "type": "string", "description": "JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.\n" }, "oidcTrn": { "type": "string", "description": "OIDC provider TRN.\n" }, "openIdConfigUrl": { "type": "string", "description": "OIDC provider configuration document in JSON format, containing information about the OIDC provider.\n" } }, "type": "object", "required": [ "audience", "enabled", "issuer", "jwksUrl", "oidcTrn", "openIdConfigUrl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterLoggingConfig:getClusterLoggingConfig": { "properties": { "logProjectId": { "type": "string", "description": "Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.\n" }, "logSetups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getClusterLoggingConfigLogSetup:getClusterLoggingConfigLogSetup" }, "description": "Cluster log option information.\n" } }, "type": "object", "required": [ "logProjectId", "logSetups" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterLoggingConfigLogSetup:getClusterLoggingConfigLogSetup": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable this log option. Parameter values: true: enabled; false: not enabled.\n" }, "logTopicId": { "type": "string", "description": "TLS log topic ID for the collection target. If empty, the corresponding log topic has not been created.\n" }, "logTtl": { "type": "integer", "description": "Retention period of logs in log service, in days. 3650 days means permanent storage.\n" }, "logType": { "type": "string", "description": "Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.\n" } }, "type": "object", "required": [ "enabled", "logTopicId", "logTtl", "logType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterMonitoringConfig:getClusterMonitoringConfig": { "properties": { "componentConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getClusterMonitoringConfigComponentConfig:getClusterMonitoringConfigComponentConfig" }, "description": "List of monitoring component configurations.\n" }, "enableMetricsExternalCollection": { "type": "boolean", "description": "Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.\n" }, "workspaceId": { "type": "string", "description": "Workspace ID to which the monitoring data belongs.\n" } }, "type": "object", "required": [ "componentConfigs", "enableMetricsExternalCollection", "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterMonitoringConfigComponentConfig:getClusterMonitoringConfigComponentConfig": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable this monitoring component. true means enabled; false means disabled.\n" }, "name": { "type": "string", "description": "Name of the monitoring component, such as 'prometheus', 'grafana', etc.\n" } }, "type": "object", "required": [ "enabled", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterNodeStatistics:getClusterNodeStatistics": { "properties": { "creatingCount": { "type": "integer", "description": "Total number of nodes in Phase=Creating.\n" }, "deletingCount": { "type": "integer", "description": "Total number of nodes with Phase=Deleting.\n" }, "failedCount": { "type": "integer", "description": "Total number of nodes with Phase=Failed.\n" }, "runningCount": { "type": "integer", "description": "Total number of nodes with Phase=Running.\n" }, "totalCount": { "type": "integer", "description": "Total number of nodes.\n" }, "updatingCount": { "type": "integer", "description": "Total number of nodes in Phase=Updating.\n" } }, "type": "object", "required": [ "creatingCount", "deletingCount", "failedCount", "runningCount", "totalCount", "updatingCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterPodsConfig:getClusterPodsConfig": { "properties": { "flannelConfig": { "$ref": "#/types/volcenginecc:vke/getClusterPodsConfigFlannelConfig:getClusterPodsConfigFlannelConfig", "description": "Flannel network configuration.\n" }, "podNetworkMode": { "type": "string", "description": "Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.\n" }, "vpcCniConfig": { "$ref": "#/types/volcenginecc:vke/getClusterPodsConfigVpcCniConfig:getClusterPodsConfigVpcCniConfig", "description": "VPC-CNI network configuration.\n" } }, "type": "object", "required": [ "flannelConfig", "podNetworkMode", "vpcCniConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterPodsConfigFlannelConfig:getClusterPodsConfigFlannelConfig": { "properties": { "maxPodsPerNode": { "type": "integer", "description": "Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.\n" }, "podCidrs": { "type": "array", "items": { "type": "string" }, "description": "Pod CIDR for Flannel container network.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of Pod subnet IDs for the Flannel container network model.\n" } }, "type": "object", "required": [ "maxPodsPerNode", "podCidrs", "subnetIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterPodsConfigVpcCniConfig:getClusterPodsConfigVpcCniConfig": { "properties": { "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of Pod subnet IDs for the VPC-CNI container network model.\n" }, "trunkEniEnabled": { "type": "boolean", "description": "Whether to enable Trunk mode for the VPC-CNI container network model\n" } }, "type": "object", "required": [ "subnetIds", "trunkEniEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterServicesConfig:getClusterServicesConfig": { "properties": { "serviceCidrsv4s": { "type": "array", "items": { "type": "string" }, "description": "IPv4 private network address exposed by Kubernetes Service.\n" } }, "type": "object", "required": [ "serviceCidrsv4s" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterStatus:getClusterStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getClusterStatusCondition:getClusterStatusCondition" }, "description": "Status condition list\n" }, "phase": { "type": "string", "description": "Cluster status phase.\n" } }, "type": "object", "required": [ "conditions", "phase" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterStatusCondition:getClusterStatusCondition": { "properties": { "type": { "type": "string", "description": "Condition type\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getClusterTag:getClusterTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolAutoScaling:getDefaultNodePoolAutoScaling": { "properties": { "desiredReplicas": { "type": "integer", "description": "Configure the desired number of nodes in the node pool.\n" }, "enabled": { "type": "boolean", "description": "Configure the switch for node pool auto scaling. Parameter values: false: disabled true: enabled\n" }, "maxReplicas": { "type": "integer", "description": "Configure the maximum number of nodes in the node pool\n" }, "minReplicas": { "type": "integer", "description": "Configure the minimum number of nodes in the node pool\n" }, "priority": { "type": "integer", "description": "Priority\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID\n" }, "subnetPolicy": { "type": "string", "description": "Multi-subnet scheduling policy for the node pool. Parameter value description: ZoneBalance: availability zone balancing policy. Priority: subnet priority policy.\n" } }, "type": "object", "required": [ "desiredReplicas", "enabled", "maxReplicas", "minReplicas", "priority", "scalingGroupId", "subnetPolicy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolKubernetesConfig:getDefaultNodePoolKubernetesConfig": { "properties": { "autoSyncDisabled": { "type": "boolean", "description": "Whether to disable the automatic synchronization of label taints to existing nodes. Parameter value description: true: disabled, automatic synchronization is turned off. false: not disabled, automatic synchronization is turned on.\n" }, "cordon": { "type": "boolean", "description": "Node blocking configuration. Parameter value description: false: not blocked. true: blocked\n" }, "kubeletConfig": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolKubernetesConfigKubeletConfig:getDefaultNodePoolKubernetesConfigKubeletConfig", "description": "Kubelet component configuration\n" }, "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolKubernetesConfigLabel:getDefaultNodePoolKubernetesConfigLabel" }, "description": "Kubernetes label information for node pool/node\n" }, "namePrefix": { "type": "string", "description": "Prefix of the metadata name for node objects in Kubernetes.\n" }, "nameSuffix": { "type": "string", "description": "Suffix of the metadata name for node objects in Kubernetes.\n" }, "nameUseHostname": { "type": "boolean", "description": "Whether the metadata name of the node object in Kubernetes uses the ECS host name. Values: true: use ECS host name as node name. false: do not use ECS host name as node name\n" }, "taints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolKubernetesConfigTaint:getDefaultNodePoolKubernetesConfigTaint" }, "description": "Kubernetes taint information for the node pool/node\n" } }, "type": "object", "required": [ "autoSyncDisabled", "cordon", "kubeletConfig", "labels", "namePrefix", "nameSuffix", "nameUseHostname", "taints" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolKubernetesConfigKubeletConfig:getDefaultNodePoolKubernetesConfigKubeletConfig": { "properties": { "cpuManagerPolicy": { "type": "string", "description": "Configure kubelet's CpuManagerPolicy. Includes none and static strategies\n" }, "featureGates": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolKubernetesConfigKubeletConfigFeatureGates:getDefaultNodePoolKubernetesConfigKubeletConfigFeatureGates", "description": "Feature gate.\n" }, "kubeApiBurst": { "type": "integer", "description": "Maximum number of burst requests sent to the API server per second. Does not include events and node heartbeat APIs, whose rate limits are controlled by a different set of flags.\n" }, "kubeApiQps": { "type": "integer", "description": "Queries per second (QPS) for communication with apiserver. Does not include event and node heartbeat APIs; their rate limits are controlled by a different set of flags\n" }, "kubeReserveds": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolKubernetesConfigKubeletConfigKubeReserved:getDefaultNodePoolKubernetesConfigKubeletConfigKubeReserved" }, "description": "Resources reserved for Kubernetes system components on the node. By default, half of the default value in the node reserved resource policy is reserved\n" }, "maxPods": { "type": "integer", "description": "Configure the maximum number of Pods supported by kubelet\n" }, "registryBurst": { "type": "integer", "description": "Set the maximum number of burst image pulls. Temporarily allow the number of image pulls specified by this parameter, provided it does not exceed the RegistryPullQps setting\n" }, "registryPullQps": { "type": "integer", "description": "Can be used to limit the QPS cap for the image repository\n" }, "serializeImagePulls": { "type": "boolean", "description": "Pull images one by one\n" }, "systemReserveds": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolKubernetesConfigKubeletConfigSystemReserved:getDefaultNodePoolKubernetesConfigKubeletConfigSystemReserved" }, "description": "Resources reserved for the operating system on the node. By default, resources are reserved at half the default value specified in the node reserved resource policy.\n" }, "topologyManagerPolicy": { "type": "string", "description": "Topology management policy. Values: none: (default) topology management policy disabled. restricted: kubelet only accepts Pods that achieve optimal NUMA (Non-Uniform Memory Access) on requested resources. best-effort: kubelet prioritizes Pods that achieve NUMA on CPU and device resources. single-numa-node: kubelet only allows Pods that achieve NUMA on CPU and device resources within the same node.\n" }, "topologyManagerScope": { "type": "string", "description": "Resource granularity for topology management strategy. Values: container: resource alignment at container level. pod: resource alignment at Pod level\n" } }, "type": "object", "required": [ "cpuManagerPolicy", "featureGates", "kubeApiBurst", "kubeApiQps", "kubeReserveds", "maxPods", "registryBurst", "registryPullQps", "serializeImagePulls", "systemReserveds", "topologyManagerPolicy", "topologyManagerScope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolKubernetesConfigKubeletConfigFeatureGates:getDefaultNodePoolKubernetesConfigKubeletConfigFeatureGates": { "properties": { "inPlacePodVerticalScaling": { "type": "boolean", "description": "Whether to enable the feature switch for local vertical Pod autoscaling\n" }, "qoSResourceManager": { "type": "boolean", "description": "Enable QoSResourceManager feature switch. Options: - true to enable - false to disable\n" } }, "type": "object", "required": [ "inPlacePodVerticalScaling", "qoSResourceManager" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolKubernetesConfigKubeletConfigKubeReserved:getDefaultNodePoolKubernetesConfigKubeletConfigKubeReserved": { "properties": { "name": { "type": "string", "description": "Resource name. Values: cpu or memory\n" }, "quantity": { "type": "string", "description": "Specify the resource quantity. - For cpu, example value: 200m - For memory, example value: 1G\n" } }, "type": "object", "required": [ "name", "quantity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolKubernetesConfigKubeletConfigSystemReserved:getDefaultNodePoolKubernetesConfigKubeletConfigSystemReserved": { "properties": { "name": { "type": "string", "description": "Resource name. Values: cpu or memory.\n" }, "quantity": { "type": "string", "description": "Resource quantity for the specified resource. - For cpu, example value: 200m - For memory, example value: 1G\n" } }, "type": "object", "required": [ "name", "quantity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolKubernetesConfigLabel:getDefaultNodePoolKubernetesConfigLabel": { "properties": { "key": { "type": "string", "description": "Label key.\n" }, "value": { "type": "string", "description": "Label value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolKubernetesConfigTaint:getDefaultNodePoolKubernetesConfigTaint": { "properties": { "effect": { "type": "string", "description": "Taint effect. Values: NoSchedule (default): do not schedule. NoExecute: evict pods that do not tolerate the taint. PreferNoSchedule: avoid scheduling if possible.\n" }, "key": { "type": "string", "description": "Taint key\n" }, "value": { "type": "string", "description": "Taint value\n" } }, "type": "object", "required": [ "effect", "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolManagement:getDefaultNodePoolManagement": { "properties": { "enabled": { "type": "boolean", "description": "Whether managed mode is enabled for the node pool. Values: - true: enabled - false: disabled\n" }, "remedyConfig": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolManagementRemedyConfig:getDefaultNodePoolManagementRemedyConfig", "description": "Check self-healing configuration.\n" } }, "type": "object", "required": [ "enabled", "remedyConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolManagementRemedyConfig:getDefaultNodePoolManagementRemedyConfig": { "properties": { "enabled": { "type": "boolean", "description": "Enable self-healing check\n" }, "remedyId": { "type": "string", "description": "Self-healing rule ID\n" } }, "type": "object", "required": [ "enabled", "remedyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolNodeConfig:getDefaultNodePoolNodeConfig": { "properties": { "additionalContainerStorageEnabled": { "type": "boolean", "description": "Whether the first data disk on the node has been configured, formatted, and mounted as the storage directory for container images and logs. Parameter values: false: not configured and formatted true: configured and formatted\n" }, "autoRenew": { "type": "boolean", "description": "Whether the cloud server instance is automatically renewed upon expiration. Parameter values: true: auto renewal false: no auto renewal This parameter is returned only when InstanceChargeType=PrePaid.\n" }, "autoRenewPeriod": { "type": "integer", "description": "Automatic renewal duration for cloud server instance, in months. This parameter is returned only when AutoRenew=true.\n" }, "dataVolumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolNodeConfigDataVolume:getDefaultNodePoolNodeConfigDataVolume" }, "description": "Data disk configuration for the node\n" }, "deploymentSetGroupNumber": { "type": "integer", "description": "Group number of the instance in the deployment set. 0 means not set\n" }, "deploymentSetId": { "type": "string", "description": "Deployment set ID to be added to the instance\n" }, "hostname": { "type": "string", "description": "Host name corresponding to the node\n" }, "hpcClusterIds": { "type": "array", "items": { "type": "string" }, "description": "High performance computing cluster ID. When the node pool is configured with high performance computing GPU node types, returns the high performance computing cluster ID\n" }, "imageId": { "type": "string", "description": "Image ID used by the cloud server corresponding to the node\n" }, "initializeScript": { "type": "string", "description": "Custom script executed after creating and initializing the node. Shell script in Base64 encoding\n" }, "instanceChargeType": { "type": "string", "description": "Billing type for cloud server instance. Parameter value description: PostPaid: pay-as-you-go. PrePaid: subscription (annual/monthly).\n" }, "instanceName": { "type": "string", "description": "Node (instance) name\n" }, "instanceTypeIds": { "type": "array", "items": { "type": "string" }, "description": "List of cloud server instance type IDs corresponding to the node\n" }, "instancesDistribution": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolNodeConfigInstancesDistribution:getDefaultNodePoolNodeConfigInstancesDistribution", "description": "Configure the mixed strategy for spot and pay-as-you-go instances. This strategy takes effect when SpotStrategy is set to SpotAsPriceGo\n" }, "namePrefix": { "type": "string", "description": "Node name prefix. An empty string or nil means the node name prefix policy is not enabled\n" }, "networkTrafficMode": { "type": "string", "description": "Network communication mode between nodes\n" }, "period": { "type": "integer", "description": "Duration for purchasing cloud server instance, in months. This parameter is returned only when InstanceChargeType=PrePaid\n" }, "preScript": { "type": "string", "description": "Script executed before deploying nodes\n" }, "projectName": { "type": "string", "description": "The project to which the ECS belongs. Each ECS can only belong to one project.\n" }, "publicAccessConfig": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolNodeConfigPublicAccessConfig:getDefaultNodePoolNodeConfigPublicAccessConfig", "description": "Configuration for automatic public network access for nodes\n" }, "publicAccessEnabled": { "type": "boolean", "description": "Whether the node automatically enables public network access. Values: - false: disabled - true: enabled\n" }, "security": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolNodeConfigSecurity:getDefaultNodePoolNodeConfigSecurity", "description": "Node security configuration.\n" }, "spotStrategy": { "type": "string", "description": "Preemptive policy for pay-as-you-go billing. When InstanceChargeType=PostPaid: NoSpot: regular pay-as-you-go instance. SpotAsPriceGo: system auto-bidding, follows current market price.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs to which the node network belongs.\n" }, "systemVolume": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolNodeConfigSystemVolume:getDefaultNodePoolNodeConfigSystemVolume", "description": "System disk configuration for the node\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolNodeConfigTag:getDefaultNodePoolNodeConfigTag" }, "description": "Label information configured for the node pool\n" } }, "type": "object", "required": [ "additionalContainerStorageEnabled", "autoRenew", "autoRenewPeriod", "dataVolumes", "deploymentSetGroupNumber", "deploymentSetId", "hostname", "hpcClusterIds", "imageId", "initializeScript", "instanceChargeType", "instanceName", "instanceTypeIds", "instancesDistribution", "namePrefix", "networkTrafficMode", "period", "preScript", "projectName", "publicAccessConfig", "publicAccessEnabled", "security", "spotStrategy", "subnetIds", "systemVolume", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolNodeConfigDataVolume:getDefaultNodePoolNodeConfigDataVolume": { "properties": { "fileSystem": { "type": "string", "description": "File system. Options: - Ext4 (default) - Xfs\n" }, "mountPoint": { "type": "string", "description": "Target mount directory after disk formatting.\n" }, "placementGroupId": { "type": "string", "description": "Placement group ID\n" }, "size": { "type": "integer", "description": "Disk capacity, in GiB\n" }, "snapshotId": { "type": "string", "description": "Create a data disk using a snapshot. You can call the DescribeSnapshots API to query the snapshot ID. Note: Only ultra-fast SSD and efficient cloud disks support creating disks from snapshots. Only snapshots in 'available' status can be used to create new disks; snapshots in 'creating', 'rolling back', 'deleting', or 'error' status cannot be used to create new disks\n" }, "subgroupNumber": { "type": "integer", "description": "Placement subgroup\n" }, "type": { "type": "string", "description": "Disk type: ESSD*PL0: ultra-fast SSD cloud disk with performance level PL0. ESSD*FlexPL: ultra-fast SSD cloud disk with performance level PL1.\n" } }, "type": "object", "required": [ "fileSystem", "mountPoint", "placementGroupId", "size", "snapshotId", "subgroupNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolNodeConfigInstancesDistribution:getDefaultNodePoolNodeConfigInstancesDistribution": { "properties": { "capacityRebalance": { "type": "boolean", "description": "Capacity rebalancing. Value range: - true: enables this feature. When a preemptible instance is about to be reclaimed, a new preemptible instance is proactively created for compensation. - false (default): disables this feature. Waits until the preemptible instance is reclaimed before scaling out to make up the instance count.\n" }, "compensateWithOnDemand": { "type": "boolean", "description": "Pay-as-you-go instance fallback feature. Value range: - true: enables this feature. If all preemptible instances fail to purchase due to insufficient inventory, pay-as-you-go instances will be attempted - false (default): disables this feature. When scaling preemptible instances, only the configured preemptible instances are attempted\n" }, "onDemandBaseCapacity": { "type": "integer", "description": "Base capacity size. The base capacity is always pay-as-you-go instances. Value range: [0,500], default: 0\n" }, "onDemandPercentageAboveBaseCapacity": { "type": "integer", "description": "Proportion of pay-as-you-go instances for capacity exceeding the base capacity. Value range [0, 100]. 0 means only preemptible instances are produced for excess capacity; 100 means only pay-as-you-go instances are produced. Default is 0.\n" } }, "type": "object", "required": [ "capacityRebalance", "compensateWithOnDemand", "onDemandBaseCapacity", "onDemandPercentageAboveBaseCapacity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolNodeConfigPublicAccessConfig:getDefaultNodePoolNodeConfigPublicAccessConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth for the public IP, unit: Mbps\n" }, "billingType": { "type": "integer", "description": "Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.\n" }, "isp": { "type": "string", "description": "Public IP line type. Parameter description: BGP: BGP (multi-line)\n" } }, "type": "object", "required": [ "bandwidth", "billingType", "isp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolNodeConfigSecurity:getDefaultNodePoolNodeConfigSecurity": { "properties": { "login": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolNodeConfigSecurityLogin:getDefaultNodePoolNodeConfigSecurityLogin", "description": "Node access configuration\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs for the node network\n" }, "securityStrategies": { "type": "array", "items": { "type": "string" }, "description": "Node security policy. Parameter value description: Hids: host security hardening\n" }, "securityStrategyEnabled": { "type": "boolean", "description": "Whether security hardening is enabled for the node. Parameter value description: true: enabled. false: not enabled.\n" } }, "type": "object", "required": [ "login", "securityGroupIds", "securityStrategies", "securityStrategyEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolNodeConfigSecurityLogin:getDefaultNodePoolNodeConfigSecurityLogin": { "properties": { "password": { "type": "string", "description": "Root user login password in Base64 encoding. Follow the cloud server password requirements: 8–30 characters, cannot start with / or $6$, must include at least three of the following: lowercase letters a–z, uppercase letters A–Z, numbers 0–9, special characters ( ) ` ~ ! @ # $ % ^ \u0026 * _ - + = | { } [ ] : ; ' \u003c \u003e , . ? /\n" }, "sshKeyPairName": { "type": "string", "description": "SSH key pair name. Please ensure the key pair is already created or hosted in the cloud server\n" }, "type": { "type": "string", "description": "Node access login method. Parameter value description: Password: password login. SshKeyPair: SSH key pair login.\n" } }, "type": "object", "required": [ "password", "sshKeyPairName", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolNodeConfigSystemVolume:getDefaultNodePoolNodeConfigSystemVolume": { "properties": { "placementGroupId": { "type": "string", "description": "Placement group ID\n" }, "size": { "type": "integer", "description": "Cloud disk capacity, in GiB. Value description: default: 40 GiB. Ultra-fast SSD (ESSD*PL0, ESSD*FlexPL): 40–2048 GiB\n" }, "subgroupNumber": { "type": "integer", "description": "Placement subgroup\n" }, "type": { "type": "string", "description": "Cloud disk type: ESSD*PL0: (default) Ultra SSD with performance level PL0. ESSD*FlexPL: Ultra SSD with performance level PL1\n" } }, "type": "object", "required": [ "placementGroupId", "size", "subgroupNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolNodeConfigTag:getDefaultNodePoolNodeConfigTag": { "properties": { "key": { "type": "string", "description": "Label key.\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolNodeStatistics:getDefaultNodePoolNodeStatistics": { "properties": { "creatingCount": { "type": "integer", "description": "Total number of nodes with Phase=Creating.\n" }, "deletingCount": { "type": "integer", "description": "Total number of nodes with Phase=Deleting.\n" }, "failedCount": { "type": "integer", "description": "Total number of nodes with Phase=Failed\n" }, "runningCount": { "type": "integer", "description": "Total number of nodes with Phase=Running\n" }, "totalCount": { "type": "integer", "description": "Total number of nodes in the node pool.\n" }, "updatingCount": { "type": "integer", "description": "Total number of nodes with Phase=Updating\n" } }, "type": "object", "required": [ "creatingCount", "deletingCount", "failedCount", "runningCount", "totalCount", "updatingCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolStatus:getDefaultNodePoolStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolStatusCondition:getDefaultNodePoolStatusCondition" }, "description": "Status conditions of the node pool in its current primary state, indicating the reason for entering this state\n" }, "phase": { "type": "string", "description": "Status of the node pool. Parameter values: Creating, Running, Updating, Deleting, Failed, Scaling.\n" } }, "type": "object", "required": [ "conditions", "phase" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolStatusCondition:getDefaultNodePoolStatusCondition": { "properties": { "type": { "type": "string", "description": "Status conditions under the current primary state of the node pool, indicating the reasons for entering this state. There can be multiple reasons. Parameter values: ProgressingOk, ResourceCleanupFailed, Unknown, ClusterNotRunning.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getDefaultNodePoolTag:getDefaultNodePoolTag": { "properties": { "key": { "type": "string", "description": "Label key.\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodeKubernetesConfig:getNodeKubernetesConfig": { "properties": { "cordon": { "type": "boolean", "description": "Node lock configuration. Options: false (default): not locked; true: locked\n" }, "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodeKubernetesConfigLabel:getNodeKubernetesConfigLabel" }, "description": "Kubernetes label information for node pools/nodes. Up to 20 labels can be specified.\n" }, "taints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodeKubernetesConfigTaint:getNodeKubernetesConfigTaint" }, "description": "Kubernetes taint information for node pools/nodes. Up to 20 taints can be specified.\n" } }, "type": "object", "required": [ "cordon", "labels", "taints" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodeKubernetesConfigLabel:getNodeKubernetesConfigLabel": { "properties": { "key": { "type": "string", "description": "Label key. A valid label key consists of two parts: \\n\\n and \\n\\n, separated by a slash (/). \\n\\n is required and supports uppercase and lowercase English letters, numbers, hyphens (-), underscores (_), and periods (.), must start and end with a letter or number, and must not exceed 63 characters. \\n\\n is optional. If specified, \\n\\n must be a DNS subdomain: a series of DNS labels separated by periods (.), with a maximum length of 253 characters. The total length of \\n\\n and \\n\\n must not exceed 82 characters.\n" }, "value": { "type": "string", "description": "Tag value, up to 63 characters (can be empty). Can start and end with an English letter (upper or lower case) or a digit. Supported special characters: hyphen (-), underscore (_), period (.).\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodeKubernetesConfigTaint:getNodeKubernetesConfigTaint": { "properties": { "effect": { "type": "string", "description": "Taint effect. Options: NoSchedule (default): Do not schedule. NoExecute: Evict Pods that do not tolerate the taint. PreferNoSchedule: Avoid scheduling if possible.\n" }, "key": { "type": "string", "description": "Taint key. A valid taint key has two segments: \\n\\n and \\n\\n, separated by a slash (/). \\n\\n is required and supports English letters (case-sensitive), numbers, hyphen (-), underscore (_), and period (.), must start and end with a letter or number, and be no longer than 63 characters. \\n\\n is optional. If specified, \\n\\n must be a DNS subdomain: a series of DNS labels separated by periods (.), no longer than 253 characters. The total length of \\n\\n and \\n\\n must not exceed 82 characters.\n" }, "value": { "type": "string", "description": "Taint value, up to 63 characters (can be empty). Must start and end with an English letter or number. Supports special characters: hyphen (-), underscore (_), and period (.).\n" } }, "type": "object", "required": [ "effect", "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolAutoScaling:getNodePoolAutoScaling": { "properties": { "desiredReplicas": { "type": "integer", "description": "Configure the expected number of nodes in the node pool\n" }, "enabled": { "type": "boolean", "description": "Configure the node pool auto scaling feature switch. Parameter values: false: disabled. true: enabled.\n" }, "maxReplicas": { "type": "integer", "description": "Configure the maximum number of nodes in the node pool\n" }, "minReplicas": { "type": "integer", "description": "Minimum number of nodes configured for the node pool\n" }, "priority": { "type": "integer", "description": "Priority\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID\n" }, "subnetPolicy": { "type": "string", "description": "Multi-subnet scheduling strategy for the node pool. Parameter values: ZoneBalance: availability zone balancing strategy. Priority: subnet priority strategy.\n" } }, "type": "object", "required": [ "desiredReplicas", "enabled", "maxReplicas", "minReplicas", "priority", "scalingGroupId", "subnetPolicy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfig:getNodePoolKubernetesConfig": { "properties": { "autoSyncDisabled": { "type": "boolean", "description": "Disable automatic synchronization of labels and taints to existing nodes. Parameter values: true: disable (turn off automatic sync). false: do not disable (turn on automatic sync)\n" }, "containerdConfig": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfigContainerdConfig:getNodePoolKubernetesConfigContainerdConfig", "description": "Node pool Containerd configuration\n" }, "cordon": { "type": "boolean", "description": "Node blocking configuration. Parameter values: false: not blocked; true: blocked\n" }, "kubeletConfig": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfig:getNodePoolKubernetesConfigKubeletConfig", "description": "Kubelet component configuration\n" }, "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfigLabel:getNodePoolKubernetesConfigLabel" }, "description": "Kubernetes label information for node pools/nodes\n" }, "namePrefix": { "type": "string", "description": "Prefix for node object metadata name in Kubernetes\n" }, "nameSuffix": { "type": "string", "description": "Suffix for node object metadata name in Kubernetes\n" }, "nameUseHostname": { "type": "boolean", "description": "Whether the node object metadata name in Kubernetes uses the ECS host name. Values: true: use ECS host name as node name; false: do not use ECS host name as node name\n" }, "taints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfigTaint:getNodePoolKubernetesConfigTaint" }, "description": "Kubernetes taint information for node pools/nodes\n" } }, "type": "object", "required": [ "autoSyncDisabled", "containerdConfig", "cordon", "kubeletConfig", "labels", "namePrefix", "nameSuffix", "nameUseHostname", "taints" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfigContainerdConfig:getNodePoolKubernetesConfigContainerdConfig": { "properties": { "insecureRegistries": { "type": "array", "items": { "type": "string" }, "description": "Specify the container image repository address to skip certificate verification.\n" }, "registryProxyConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfigContainerdConfigRegistryProxyConfig:getNodePoolKubernetesConfigContainerdConfigRegistryProxyConfig" }, "description": "Container image repository proxy configuration\n" } }, "type": "object", "required": [ "insecureRegistries", "registryProxyConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfigContainerdConfigRegistryProxyConfig:getNodePoolKubernetesConfigContainerdConfigRegistryProxyConfig": { "properties": { "proxyEndpoints": { "type": "array", "items": { "type": "string" }, "description": "Proxy address.\n" }, "registry": { "type": "string", "description": "Container image repository address.\n" } }, "type": "object", "required": [ "proxyEndpoints", "registry" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfig:getNodePoolKubernetesConfigKubeletConfig": { "properties": { "cpuManagerPolicy": { "type": "string", "description": "Configure kubelet CpuManagerPolicy. Supports none and static policies\n" }, "evictionHards": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfigEvictionHard:getNodePoolKubernetesConfigKubeletConfigEvictionHard" }, "description": "Set of hard thresholds for triggering Pod eviction\n" }, "featureGates": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfigFeatureGates:getNodePoolKubernetesConfigKubeletConfigFeatureGates", "description": "Feature gate\n" }, "kubeApiBurst": { "type": "integer", "description": "Maximum burst request rate sent to the API server per second. Excludes events and node heartbeat APIs, whose rate limits are controlled by a different set of flags\n" }, "kubeApiQps": { "type": "integer", "description": "Queries per second (QPS) for communication with apiserver. Events and node heartbeat APIs are not included; their rate limits are controlled by a different set of flags.\n" }, "kubeReserveds": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfigKubeReserved:getNodePoolKubernetesConfigKubeletConfigKubeReserved" }, "description": "Resources reserved for Kubernetes system components on the node. By default, half of the default value in the node reserved resource policy is reserved.\n" }, "maxPods": { "type": "integer", "description": "Configure the maximum number of Pods supported by kubelet\n" }, "registryBurst": { "type": "integer", "description": "Set the maximum number of burst image pulls. Temporarily allows the number of image pulls specified by this parameter, provided it does not exceed the RegistryPullQps setting\n" }, "registryPullQps": { "type": "integer", "description": "Used to limit the QPS cap for the image repository\n" }, "serializeImagePulls": { "type": "boolean", "description": "Pull images sequentially\n" }, "systemReserveds": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfigSystemReserved:getNodePoolKubernetesConfigKubeletConfigSystemReserved" }, "description": "Resources reserved for the operating system on the node. By default, half of the default value in the node reserved resource policy is used for resource reservation.\n" }, "topologyManagerPolicy": { "type": "string", "description": "Topology management policy. Values: none (default): disables topology management policy. restricted: kubelet only accepts Pods that achieve optimal NUMA (Non-Uniform Memory Access) on requested resources. best-effort: kubelet prioritizes Pods that achieve NUMA on CPU and device resources. single-numa-node: kubelet only allows Pods that achieve NUMA on CPU and device resources within the same node\n" }, "topologyManagerScope": { "type": "string", "description": "Resource granularity for topology management policy. Values: container: resource alignment at container level pod: resource alignment at Pod level\n" } }, "type": "object", "required": [ "cpuManagerPolicy", "evictionHards", "featureGates", "kubeApiBurst", "kubeApiQps", "kubeReserveds", "maxPods", "registryBurst", "registryPullQps", "serializeImagePulls", "systemReserveds", "topologyManagerPolicy", "topologyManagerScope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfigEvictionHard:getNodePoolKubernetesConfigKubeletConfigEvictionHard": { "properties": { "key": { "type": "string", "description": "Hard threshold name. Options: memory.available, nodefs.available, nodefs.inodesFree, imagefs.available\n" }, "value": { "type": "string", "description": "Hard threshold value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfigFeatureGates:getNodePoolKubernetesConfigKubeletConfigFeatureGates": { "properties": { "inPlacePodVerticalScaling": { "type": "boolean", "description": "Enable local vertical Pod autoscaling feature toggle\n" }, "qoSResourceManager": { "type": "boolean", "description": "Whether to enable the QoSResourceManager feature switch. Values: - true enabled; - false disabled\n" } }, "type": "object", "required": [ "inPlacePodVerticalScaling", "qoSResourceManager" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfigKubeReserved:getNodePoolKubernetesConfigKubeletConfigKubeReserved": { "properties": { "name": { "type": "string", "description": "Resource name. Valid values: cpu or memory.\n" }, "quantity": { "type": "string", "description": "Specify the resource quantity. - For cpu, example value: 200m - For memory, example value: 1G\n" } }, "type": "object", "required": [ "name", "quantity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfigKubeletConfigSystemReserved:getNodePoolKubernetesConfigKubeletConfigSystemReserved": { "properties": { "name": { "type": "string", "description": "Resource name. Valid values: cpu or memory.\n" }, "quantity": { "type": "string", "description": "Resource quantity for the specified resource. - For cpu, example value: 200m. - For memory, example value: 1G.\n" } }, "type": "object", "required": [ "name", "quantity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfigLabel:getNodePoolKubernetesConfigLabel": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Label value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolKubernetesConfigTaint:getNodePoolKubernetesConfigTaint": { "properties": { "effect": { "type": "string", "description": "Taint effect. Values: NoSchedule: (default) Do not schedule. NoExecute: Evict pods that do not tolerate the taint. PreferNoSchedule: Prefer not to schedule.\n" }, "key": { "type": "string", "description": "Taint key.\n" }, "value": { "type": "string", "description": "Taint value\n" } }, "type": "object", "required": [ "effect", "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolManagement:getNodePoolManagement": { "properties": { "enabled": { "type": "boolean", "description": "Enable managed mode for node pool. Options: - true: on - false: off\n" }, "remedyConfig": { "$ref": "#/types/volcenginecc:vke/getNodePoolManagementRemedyConfig:getNodePoolManagementRemedyConfig", "description": "Check self-healing configuration.\n" } }, "type": "object", "required": [ "enabled", "remedyConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolManagementRemedyConfig:getNodePoolManagementRemedyConfig": { "properties": { "enabled": { "type": "boolean", "description": "Enable self-healing check\n" }, "remedyId": { "type": "string", "description": "Self-healing rule ID\n" } }, "type": "object", "required": [ "enabled", "remedyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolNodeConfig:getNodePoolNodeConfig": { "properties": { "additionalContainerStorageEnabled": { "type": "boolean", "description": "Whether the first data disk of the node is configured, formatted, and mounted as the storage directory for container images and logs. Parameter values: false: not configured and formatted; true: configured and formatted\n" }, "autoRenew": { "type": "boolean", "description": "Whether the cloud server instance will be automatically renewed upon expiration. Parameter description: true: auto renewal false: no auto renewal This parameter is returned only when InstanceChargeType=PrePaid.\n" }, "autoRenewPeriod": { "type": "integer", "description": "Automatic renewal duration for cloud server instances, in months. This parameter is returned only when AutoRenew=true\n" }, "dataVolumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolNodeConfigDataVolume:getNodePoolNodeConfigDataVolume" }, "description": "Node data disk configuration.\n" }, "deploymentSetGroupNumber": { "type": "integer", "description": "Group number of the instance in the deployment set; 0 means not set\n" }, "deploymentSetId": { "type": "string", "description": "Deployment Set ID to be added to the instance\n" }, "hostname": { "type": "string", "description": "The host name corresponding to the node.\n" }, "hpcClusterIds": { "type": "array", "items": { "type": "string" }, "description": "High performance computing cluster ID. When the node pool is configured with high performance computing GPU node types, returns the high performance computing cluster ID\n" }, "imageId": { "type": "string", "description": "Image ID used by the cloud server corresponding to the node\n" }, "initializeScript": { "type": "string", "description": "Custom script executed after node creation and initialization. Shell script in Base64 encoding\n" }, "instanceChargeType": { "type": "string", "description": "Cloud server instance billing type. Parameter values: PostPaid: pay-as-you-go. PrePaid: subscription (annual/monthly).\n" }, "instanceName": { "type": "string", "description": "Node (instance) name\n" }, "instanceTypeIds": { "type": "array", "items": { "type": "string" }, "description": "List of cloud server instance type IDs corresponding to the nodes\n" }, "instancesDistribution": { "$ref": "#/types/volcenginecc:vke/getNodePoolNodeConfigInstancesDistribution:getNodePoolNodeConfigInstancesDistribution", "description": "Set the mixed strategy for spot and pay-as-you-go instances. This strategy takes effect when SpotStrategy is SpotAsPriceGo.\n" }, "namePrefix": { "type": "string", "description": "Node name prefix. An empty string or nil means the node name prefix policy is not enabled.\n" }, "networkTrafficMode": { "type": "string", "description": "Network communication mode between nodes\n" }, "period": { "type": "integer", "description": "Purchase duration for cloud server instances, in months. This parameter is returned only when InstanceChargeType=PrePaid\n" }, "preScript": { "type": "string", "description": "Script to execute before deploying the node\n" }, "projectName": { "type": "string", "description": "Project to which the ECS belongs. Each ECS can only belong to one project.\n" }, "publicAccessConfig": { "$ref": "#/types/volcenginecc:vke/getNodePoolNodeConfigPublicAccessConfig:getNodePoolNodeConfigPublicAccessConfig", "description": "Configuration for automatic public network access for nodes\n" }, "publicAccessEnabled": { "type": "boolean", "description": "Enable public network access for nodes automatically. Options: - false: off - true: on\n" }, "security": { "$ref": "#/types/volcenginecc:vke/getNodePoolNodeConfigSecurity:getNodePoolNodeConfigSecurity", "description": "Node security configuration\n" }, "spotStrategy": { "type": "string", "description": "Spot pricing strategy for pay-as-you-go billing. When InstanceChargeType=PostPaid: NoSpot: Standard pay-as-you-go instance. SpotAsPriceGo: System automatically bids, following the current market price.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs for the node network.\n" }, "systemVolume": { "$ref": "#/types/volcenginecc:vke/getNodePoolNodeConfigSystemVolume:getNodePoolNodeConfigSystemVolume", "description": "System disk configuration for the node\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolNodeConfigTag:getNodePoolNodeConfigTag" }, "description": "Label information configured for the node pool\n" } }, "type": "object", "required": [ "additionalContainerStorageEnabled", "autoRenew", "autoRenewPeriod", "dataVolumes", "deploymentSetGroupNumber", "deploymentSetId", "hostname", "hpcClusterIds", "imageId", "initializeScript", "instanceChargeType", "instanceName", "instanceTypeIds", "instancesDistribution", "namePrefix", "networkTrafficMode", "period", "preScript", "projectName", "publicAccessConfig", "publicAccessEnabled", "security", "spotStrategy", "subnetIds", "systemVolume", "tags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolNodeConfigDataVolume:getNodePoolNodeConfigDataVolume": { "properties": { "fileSystem": { "type": "string", "description": "File system. Options: - Ext4 (default) - Xfs\n" }, "mountPoint": { "type": "string", "description": "Target mount directory after disk formatting.\n" }, "placementGroupId": { "type": "string", "description": "Placement group ID\n" }, "size": { "type": "integer", "description": "Disk capacity, in GiB.\n" }, "snapshotId": { "type": "string", "description": "Create a data disk from a snapshot. You can call the DescribeSnapshots API to query the snapshot ID. Note: Only Ultra SSD and High-performance Cloud Disk support creating disks from snapshots. Only snapshots in the 'available' status can be used to create new disks. Snapshots in 'creating', 'rolling back', 'deleting', or 'error' status cannot be used to create new disks.\n" }, "subgroupNumber": { "type": "integer", "description": "Placement subgroup\n" }, "type": { "type": "string", "description": "Disk type: ESSD*PL0: ultra-fast SSD disk with performance level PL0. ESSD*FlexPL: ultra-fast SSD disk with performance level PL1\n" } }, "type": "object", "required": [ "fileSystem", "mountPoint", "placementGroupId", "size", "snapshotId", "subgroupNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolNodeConfigInstancesDistribution:getNodePoolNodeConfigInstancesDistribution": { "properties": { "capacityRebalance": { "type": "boolean", "description": "Capacity rebalancing. Value range: - true: enables this feature. When a preemptible instance is about to be reclaimed, proactively creates a new preemptible instance for compensation. - false (default): disables this feature. Waits until the preemptible instance is reclaimed before scaling out to make up the instance count\n" }, "compensateWithOnDemand": { "type": "boolean", "description": "On-demand instance fallback feature. Value range: - true: enable this feature; when all preemptible instances fail to purchase due to insufficient inventory or other reasons, attempt to purchase on-demand instances - false (default): disable this feature; only attempt to purchase configured preemptible instances when scaling up\n" }, "onDemandBaseCapacity": { "type": "integer", "description": "Size of the base capacity. The base capacity is always pay-as-you-go instances. Value range: [0,500], default is 0.\n" }, "onDemandPercentageAboveBaseCapacity": { "type": "integer", "description": "Proportion of pay-as-you-go instances in the part exceeding the base capacity. Value range: [0, 100]. 0 means only preemptible instances are produced for the part exceeding the base capacity; 100 means only pay-as-you-go instances are produced. Default value is 0.\n" } }, "type": "object", "required": [ "capacityRebalance", "compensateWithOnDemand", "onDemandBaseCapacity", "onDemandPercentageAboveBaseCapacity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolNodeConfigPublicAccessConfig:getNodePoolNodeConfigPublicAccessConfig": { "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth for public IP, unit: Mbps\n" }, "billingType": { "type": "integer", "description": "Billing type for public IP: 2: pay-as-you-go by bandwidth cap. 3: pay-as-you-go by actual traffic.\n" }, "isp": { "type": "string", "description": "Public IP line type. Parameter description: BGP: BGP (multi-line)\n" } }, "type": "object", "required": [ "bandwidth", "billingType", "isp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolNodeConfigSecurity:getNodePoolNodeConfigSecurity": { "properties": { "login": { "$ref": "#/types/volcenginecc:vke/getNodePoolNodeConfigSecurityLogin:getNodePoolNodeConfigSecurityLogin", "description": "Node access configuration.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs for the node network\n" }, "securityStrategies": { "type": "array", "items": { "type": "string" }, "description": "Node security policy. Parameter description: Hids: Host security hardening.\n" }, "securityStrategyEnabled": { "type": "boolean", "description": "Whether the node has enabled security hardening configuration. Parameter values: true: enabled; false: not enabled\n" } }, "type": "object", "required": [ "login", "securityGroupIds", "securityStrategies", "securityStrategyEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolNodeConfigSecurityLogin:getNodePoolNodeConfigSecurityLogin": { "properties": { "password": { "type": "string", "description": "Root user login password in Base64 encoding. Follow the cloud server's requirements for instance passwords: 8–30 characters in length, must not start with / or $6$, supports the following character types and must include at least three types: lowercase letters a–z, uppercase letters A–Z, numbers 0–9, special characters ( ) ` ~ ! @ # $ % ^ \u0026 * _ - + = | { } [ ] : ; ' \u003c \u003e , . ? /\n" }, "sshKeyPairName": { "type": "string", "description": "SSH key pair name. Ensure the key pair is already created or hosted in the cloud server\n" }, "type": { "type": "string", "description": "Node access login method. Parameter values: Password: password login; SshKeyPair: SSH key pair login\n" } }, "type": "object", "required": [ "password", "sshKeyPairName", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolNodeConfigSystemVolume:getNodePoolNodeConfigSystemVolume": { "properties": { "placementGroupId": { "type": "string", "description": "Placement group ID\n" }, "size": { "type": "integer", "description": "Disk capacity, in GiB. Value description: Default: 40 GiB. Ultra-fast SSD (ESSD*PL0, ESSD*FlexPL): 40–2048 GiB\n" }, "subgroupNumber": { "type": "integer", "description": "Placement subgroup\n" }, "type": { "type": "string", "description": "Cloud disk types: ESSD*PL0: (default) Ultra-fast SSD cloud disk with performance level PL0. ESSD*FlexPL: Ultra-fast SSD cloud disk with performance level PL1.\n" } }, "type": "object", "required": [ "placementGroupId", "size", "subgroupNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolNodeConfigTag:getNodePoolNodeConfigTag": { "properties": { "key": { "type": "string", "description": "Label key\n" }, "value": { "type": "string", "description": "Label value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolNodeStatistics:getNodePoolNodeStatistics": { "properties": { "creatingCount": { "type": "integer", "description": "Total number of nodes in Phase=Creating.\n" }, "deletingCount": { "type": "integer", "description": "Total number of nodes with Phase=Deleting\n" }, "failedCount": { "type": "integer", "description": "Total number of nodes with Phase=Failed\n" }, "runningCount": { "type": "integer", "description": "Total number of nodes with Phase=Running\n" }, "totalCount": { "type": "integer", "description": "Total number of nodes in the node pool\n" }, "updatingCount": { "type": "integer", "description": "Total number of nodes with Phase=Updating\n" } }, "type": "object", "required": [ "creatingCount", "deletingCount", "failedCount", "runningCount", "totalCount", "updatingCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolStatus:getNodePoolStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolStatusCondition:getNodePoolStatusCondition" }, "description": "Status conditions for the current primary state of the node pool, i.e., the reason for entering this primary state\n" }, "phase": { "type": "string", "description": "Status of the node pool. Parameter values: Creating, Running, Updating, Deleting, Failed, Scaling\n" } }, "type": "object", "required": [ "conditions", "phase" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolStatusCondition:getNodePoolStatusCondition": { "properties": { "type": { "type": "string", "description": "Status conditions for the node pool in the current main state, i.e., the reasons for entering this main state. There can be multiple reasons. Parameter values: ProgressingOk, ResourceCleanupFailed, Unknown, ClusterNotRunning.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodePoolTag:getNodePoolTag": { "properties": { "key": { "type": "string", "description": "Label key\n" }, "value": { "type": "string", "description": "Label value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodeStatus:getNodeStatus": { "properties": { "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/getNodeStatusCondition:getNodeStatusCondition" }, "description": "Status condition under the node's current primary state, indicating the reason for entering this primary state.\n" }, "phase": { "type": "string", "description": "Node status. Parameter values: Creating, Running, Deleting, Failed, Updating.\n" } }, "type": "object", "required": [ "conditions", "phase" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vke/getNodeStatusCondition:getNodeStatusCondition": { "properties": { "type": { "type": "string", "description": "Status condition under the node's current primary state, indicating the reason for entering this primary state. There can be multiple reasons. Parameter values: Progressing, Ok, Unschedulable, InitilizeFailed, NotReady, Balance, ResourceCleanupFailed, Unknown.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/AlertingRuleAnnotation:AlertingRuleAnnotation": { "properties": { "name": { "type": "string", "description": "Tag or annotation key\n" }, "value": { "type": "string", "description": "Tag or annotation value. If set to empty, the key will be deleted\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "value" ] } } }, "volcenginecc:vmp/AlertingRuleLabel:AlertingRuleLabel": { "properties": { "name": { "type": "string", "description": "Tag or annotation key\n" }, "value": { "type": "string", "description": "Tag or annotation value. If set to empty, the key will be deleted\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "value" ] } } }, "volcenginecc:vmp/AlertingRuleLevel:AlertingRuleLevel": { "properties": { "comparator": { "type": "string", "description": "Alert rule comparison condition. Options: \u003e, \u003e=, \u003c, \u003c=, ==, !=\n" }, "for": { "type": "string", "description": "Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m\n" }, "level": { "type": "string", "description": "Alert rule severity. Currently supports P0, P1, or P2\n" }, "threshold": { "type": "number", "description": "Alert rule threshold\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "comparator", "for", "level", "threshold" ] } } }, "volcenginecc:vmp/AlertingRuleQuery:AlertingRuleQuery": { "properties": { "promQl": { "type": "string", "description": "Query statement\n" }, "workspaceId": { "type": "string", "description": "Workspace ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "promQl", "workspaceId" ] } } }, "volcenginecc:vmp/AlertingRuleTag:AlertingRuleTag": { "properties": { "key": { "type": "string", "description": "Tag or annotation key\n" }, "value": { "type": "string", "description": "Tag or annotation value. If set to empty, the key will be deleted\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vmp/WorkspaceInstanceType:WorkspaceInstanceType": { "properties": { "activeSeries": { "type": "integer", "description": "Maximum active time series count\n" }, "availabilityZoneReplicas": { "type": "integer", "description": "Number of availability zones (az)\n" }, "calculatePriceParams": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/WorkspaceInstanceTypeCalculatePriceParam:WorkspaceInstanceTypeCalculatePriceParam" } }, "downsamplingPeriods": { "type": "array", "items": { "type": "string" }, "description": "Downsampling policy\n" }, "ingestSamplesPerSecond": { "type": "integer", "description": "Maximum samples written per second\n" }, "queryConcurrency": { "type": "integer", "description": "Maximum query concurrency\n" }, "queryPerSecond": { "type": "integer", "description": "Maximum query QPS\n" }, "replicasPerZone": { "type": "integer", "description": "Number of data replicas per availability zone (az)\n" }, "retentionPeriod": { "type": "string", "description": "Maximum data retention period\n" }, "scanSamplesPerSecond": { "type": "integer", "description": "Maximum samples scanned per second\n" }, "scanSeriesPerSecond": { "type": "integer", "description": "Maximum time series scanned per second\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "activeSeries", "availabilityZoneReplicas", "calculatePriceParams", "downsamplingPeriods", "ingestSamplesPerSecond", "queryConcurrency", "queryPerSecond", "replicasPerZone", "retentionPeriod", "scanSamplesPerSecond", "scanSeriesPerSecond" ] } } }, "volcenginecc:vmp/WorkspaceInstanceTypeCalculatePriceParam:WorkspaceInstanceTypeCalculatePriceParam": { "properties": { "calChargeItemLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/WorkspaceInstanceTypeCalculatePriceParamCalChargeItemList:WorkspaceInstanceTypeCalculatePriceParamCalChargeItemList" } }, "configurationCode": { "type": "string", "description": "Configuration item code.\n" }, "period": { "type": "string", "description": "Billing cycle.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "calChargeItemLists", "configurationCode", "period" ] } } }, "volcenginecc:vmp/WorkspaceInstanceTypeCalculatePriceParamCalChargeItemList:WorkspaceInstanceTypeCalculatePriceParamCalChargeItemList": { "properties": { "attrValue": { "type": "string", "description": "Billing item attribute value.\n" }, "chargeItemCode": { "type": "string", "description": "Billing item code.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attrValue", "chargeItemCode" ] } } }, "volcenginecc:vmp/WorkspaceQuota:WorkspaceQuota": { "properties": { "activeSeries": { "type": "integer", "description": "Maximum active time series count. Integer, default range is 1–50000000\n" }, "ingestSamplesPerSecond": { "type": "integer", "description": "Metric ingestion rate, i.e., maximum samples written per second. Integer, default range is 1–5000000\n" }, "publicQueryBandwidth": { "type": "integer", "description": "Workspace public Query bandwidth (Mbps).\n" }, "publicWriteBandwidth": { "type": "integer", "description": "Workspace public RemoteWrite bandwidth (Mbps).\n" }, "queryPerSecond": { "type": "integer", "description": "Maximum query QPS. Integer, default range is 1–500\n" }, "scanSamplesPerSecond": { "type": "integer", "description": "Maximum samples scanned per second. Integer, default range is 1–1000000000\n" }, "scanSeriesPerSecond": { "type": "integer", "description": "Maximum time series scanned per second. Integer, default range is 1–200000\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "activeSeries", "ingestSamplesPerSecond", "publicQueryBandwidth", "publicWriteBandwidth", "queryPerSecond", "scanSamplesPerSecond", "scanSeriesPerSecond" ] } } }, "volcenginecc:vmp/WorkspaceTag:WorkspaceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vmp/WorkspaceUsage:WorkspaceUsage": { "properties": { "activeSeries": { "type": "integer", "description": "Active time series count\n" }, "ingestedSamplesPerSecond": { "type": "number", "description": "Samples written per second\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "activeSeries", "ingestedSamplesPerSecond" ] } } }, "volcenginecc:vmp/getAlertingRuleAnnotation:getAlertingRuleAnnotation": { "properties": { "name": { "type": "string", "description": "Tag or annotation key\n" }, "value": { "type": "string", "description": "Tag or annotation value. If set to empty, the key will be deleted\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getAlertingRuleLabel:getAlertingRuleLabel": { "properties": { "name": { "type": "string", "description": "Tag or annotation key\n" }, "value": { "type": "string", "description": "Tag or annotation value. If set to empty, the key will be deleted\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getAlertingRuleLevel:getAlertingRuleLevel": { "properties": { "comparator": { "type": "string", "description": "Alert rule comparison condition. Options: \u003e, \u003e=, \u003c, \u003c=, ==, !=\n" }, "for": { "type": "string", "description": "Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m\n" }, "level": { "type": "string", "description": "Alert rule severity. Currently supports P0, P1, or P2\n" }, "threshold": { "type": "number", "description": "Alert rule threshold\n" } }, "type": "object", "required": [ "comparator", "for", "level", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getAlertingRuleQuery:getAlertingRuleQuery": { "properties": { "promQl": { "type": "string", "description": "Query statement\n" }, "workspaceId": { "type": "string", "description": "Workspace ID\n" } }, "type": "object", "required": [ "promQl", "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getAlertingRuleTag:getAlertingRuleTag": { "properties": { "key": { "type": "string", "description": "Tag or annotation key\n" }, "value": { "type": "string", "description": "Tag or annotation value. If set to empty, the key will be deleted\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getWorkspaceInstanceType:getWorkspaceInstanceType": { "properties": { "activeSeries": { "type": "integer", "description": "Maximum active time series count\n" }, "availabilityZoneReplicas": { "type": "integer", "description": "Number of availability zones (az)\n" }, "calculatePriceParams": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/getWorkspaceInstanceTypeCalculatePriceParam:getWorkspaceInstanceTypeCalculatePriceParam" }, "description": "Billing parameter list.\n" }, "downsamplingPeriods": { "type": "array", "items": { "type": "string" }, "description": "Downsampling policy\n" }, "ingestSamplesPerSecond": { "type": "integer", "description": "Maximum samples written per second\n" }, "queryConcurrency": { "type": "integer", "description": "Maximum query concurrency\n" }, "queryPerSecond": { "type": "integer", "description": "Maximum query QPS\n" }, "replicasPerZone": { "type": "integer", "description": "Number of data replicas per availability zone (az)\n" }, "retentionPeriod": { "type": "string", "description": "Maximum data retention period\n" }, "scanSamplesPerSecond": { "type": "integer", "description": "Maximum samples scanned per second\n" }, "scanSeriesPerSecond": { "type": "integer", "description": "Maximum time series scanned per second\n" } }, "type": "object", "required": [ "activeSeries", "availabilityZoneReplicas", "calculatePriceParams", "downsamplingPeriods", "ingestSamplesPerSecond", "queryConcurrency", "queryPerSecond", "replicasPerZone", "retentionPeriod", "scanSamplesPerSecond", "scanSeriesPerSecond" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getWorkspaceInstanceTypeCalculatePriceParam:getWorkspaceInstanceTypeCalculatePriceParam": { "properties": { "calChargeItemLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/getWorkspaceInstanceTypeCalculatePriceParamCalChargeItemList:getWorkspaceInstanceTypeCalculatePriceParamCalChargeItemList" }, "description": "Billing item list.\n" }, "configurationCode": { "type": "string", "description": "Configuration item code.\n" }, "period": { "type": "string", "description": "Billing cycle.\n" } }, "type": "object", "required": [ "calChargeItemLists", "configurationCode", "period" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getWorkspaceInstanceTypeCalculatePriceParamCalChargeItemList:getWorkspaceInstanceTypeCalculatePriceParamCalChargeItemList": { "properties": { "attrValue": { "type": "string", "description": "Billing item attribute value.\n" }, "chargeItemCode": { "type": "string", "description": "Billing item code.\n" } }, "type": "object", "required": [ "attrValue", "chargeItemCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getWorkspaceQuota:getWorkspaceQuota": { "properties": { "activeSeries": { "type": "integer", "description": "Maximum active time series count. Integer, default range is 1–50000000\n" }, "ingestSamplesPerSecond": { "type": "integer", "description": "Metric ingestion rate, i.e., maximum samples written per second. Integer, default range is 1–5000000\n" }, "publicQueryBandwidth": { "type": "integer", "description": "Workspace public Query bandwidth (Mbps).\n" }, "publicWriteBandwidth": { "type": "integer", "description": "Workspace public RemoteWrite bandwidth (Mbps).\n" }, "queryPerSecond": { "type": "integer", "description": "Maximum query QPS. Integer, default range is 1–500\n" }, "scanSamplesPerSecond": { "type": "integer", "description": "Maximum samples scanned per second. Integer, default range is 1–1000000000\n" }, "scanSeriesPerSecond": { "type": "integer", "description": "Maximum time series scanned per second. Integer, default range is 1–200000\n" } }, "type": "object", "required": [ "activeSeries", "ingestSamplesPerSecond", "publicQueryBandwidth", "publicWriteBandwidth", "queryPerSecond", "scanSamplesPerSecond", "scanSeriesPerSecond" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getWorkspaceTag:getWorkspaceTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vmp/getWorkspaceUsage:getWorkspaceUsage": { "properties": { "activeSeries": { "type": "integer", "description": "Active time series count\n" }, "ingestedSamplesPerSecond": { "type": "number", "description": "Samples written per second\n" } }, "type": "object", "required": [ "activeSeries", "ingestedSamplesPerSecond" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/BandwidthPackageEipAddress:BandwidthPackageEipAddress": { "properties": { "allocationId": { "type": "string", "description": "Allocation ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allocationId" ] } } }, "volcenginecc:vpc/BandwidthPackageTag:BandwidthPackageTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/EipTag:EipTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/EniPrimaryIpAddress:EniPrimaryIpAddress": { "properties": { "associatedElasticIp": { "$ref": "#/types/volcenginecc:vpc/EniPrimaryIpAddressAssociatedElasticIp:EniPrimaryIpAddressAssociatedElasticIp", "description": "Information about the public IP associated with the primary private IPv4 address of the network interface.\n" }, "primary": { "type": "boolean", "description": "Indicates whether this is the primary private IPv4 address.\n" }, "privateIpAddress": { "type": "string", "description": "Private IP address of the network interface.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "associatedElasticIp", "primary", "privateIpAddress" ] } } }, "volcenginecc:vpc/EniPrimaryIpAddressAssociatedElasticIp:EniPrimaryIpAddressAssociatedElasticIp": { "properties": { "allocationId": { "type": "string", "description": "Public IP ID\n" }, "eipAddress": { "type": "string", "description": "Public IP address\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether the public IP is released when the cloud server instance is deleted. Only pay-as-you-go public IPs bound to the primary NIC's primary private IP are valid. When enabled, if the cloud server instance is automatically reclaimed by the system (24 hours after unsubscription, upon expiration, or due to overdue payment) or deleted via the DeleteInstances API, the public IP is released along with the instance. true: yes, false: no\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allocationId", "eipAddress", "releaseWithInstance" ] } } }, "volcenginecc:vpc/EniPrivateIpSet:EniPrivateIpSet": { "properties": { "associatedElasticIp": { "$ref": "#/types/volcenginecc:vpc/EniPrivateIpSetAssociatedElasticIp:EniPrivateIpSetAssociatedElasticIp", "description": "Information about the public IP associated with the primary private IPv4 address of the network interface.\n" }, "privateIpAddress": { "type": "string", "description": "Private IP address of the network interface.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "associatedElasticIp", "privateIpAddress" ] } } }, "volcenginecc:vpc/EniPrivateIpSetAssociatedElasticIp:EniPrivateIpSetAssociatedElasticIp": { "properties": { "allocationId": { "type": "string", "description": "Public IP ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allocationId" ] } } }, "volcenginecc:vpc/EniTag:EniTag": { "properties": { "key": { "type": "string", "description": "Tag key for the user tag.\n" }, "value": { "type": "string", "description": "Tag value for the user tag.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/FlowLogTag:FlowLogTag": { "properties": { "key": { "type": "string", "description": "User label tag key. Length must be 1–128 characters. Supports input of characters from any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ symbols (@). If the tag key starts or ends with a space, the system automatically removes it.\n" }, "value": { "type": "string", "description": "User tag value. Supports input in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system will automatically remove it.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/HaVipTag:HaVipTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Length range: 1–128 characters. Supports input of characters in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system automatically removes it\n" }, "value": { "type": "string", "description": "Tag value for user tags. Supports input of characters in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system automatically removes it\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/Ipv6AddressBandwidthTag:Ipv6AddressBandwidthTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/Ipv6GatewayTag:Ipv6GatewayTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/NetworkAclDefaultEgressAclEntry:NetworkAclDefaultEgressAclEntry": { "properties": { "cidrIp": { "type": "string", "description": "For inbound rules, specifies the source address range. For outbound rules, specifies the destination address range. Supports CIDR and IPv4 address ranges. Default value: none.\n" }, "description": { "type": "string", "description": "Rule description.\n" }, "networkAclEntryId": { "type": "string", "description": "Rule ID.\n" }, "networkAclEntryName": { "type": "string", "description": "Rule name.\n" }, "policy": { "type": "string", "description": "Authorization policy. accept: Allow access. drop: Deny access. No denial message is returned; the requester only experiences a timeout or similar connection failure.\n" }, "port": { "type": "string", "description": "Destination port range for the rule. If the direction rule protocol is all, icmp, or gre, the port range is -1/-1, meaning no port restriction. If the protocol is tcp or udp, the port range is 1–65535, formatted as 1/200, 80/80, indicating ports 1 to 200, or port 80.\n" }, "priority": { "type": "integer", "description": "Priority of direction rules. Lower numbers indicate higher priority. Default value if not specified: 1.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol. icmpv6: ICMPV6 protocol. gre: GRE protocol. all: Supports all protocols.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidrIp", "description", "networkAclEntryId", "networkAclEntryName", "policy", "port", "priority", "protocol" ] } } }, "volcenginecc:vpc/NetworkAclDefaultIngressAclEntry:NetworkAclDefaultIngressAclEntry": { "properties": { "cidrIp": { "type": "string", "description": "For inbound rules, specifies the source address range. For outbound rules, specifies the destination address range. Supports CIDR and IPv4 address ranges. Default value: none.\n" }, "description": { "type": "string", "description": "Rule description.\n" }, "networkAclEntryId": { "type": "string", "description": "Rule ID.\n" }, "networkAclEntryName": { "type": "string", "description": "Rule name.\n" }, "policy": { "type": "string", "description": "Authorization policy. accept: Allow access. drop: Deny access. No denial message is returned; the requester only experiences a timeout or similar connection failure.\n" }, "port": { "type": "string", "description": "Destination port range for the rule. If the direction rule protocol is all, icmp, or gre, the port range is -1/-1, meaning no port restriction. If the protocol is tcp or udp, the port range is 1–65535, formatted as 1/200, 80/80, indicating ports 1 to 200, or port 80.\n" }, "priority": { "type": "integer", "description": "Priority of direction rules. Lower numbers indicate higher priority. Default value if not specified: 1.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol. icmpv6: ICMPV6 protocol. gre: GRE protocol. all: Supports all protocols.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidrIp", "description", "networkAclEntryId", "networkAclEntryName", "policy", "port", "priority", "protocol" ] } } }, "volcenginecc:vpc/NetworkAclEgressAclEntry:NetworkAclEgressAclEntry": { "properties": { "cidrIp": { "type": "string", "description": "For inbound rules, specifies the source address range. For outbound rules, specifies the destination address range. Supports CIDR and IPv4 address ranges. Default value: none.\n" }, "description": { "type": "string", "description": "Rule description.\n" }, "networkAclEntryName": { "type": "string", "description": "Rule name.\n" }, "policy": { "type": "string", "description": "Authorization policy. accept: Allow access. drop: Deny access. No denial message is returned; the requester only experiences a timeout or similar connection failure.\n" }, "port": { "type": "string", "description": "Destination port range for the rule. If the direction rule protocol is all, icmp, or gre, the port range is -1/-1, meaning no port restriction. If the protocol is tcp or udp, the port range is 1–65535, formatted as 1/200, 80/80, indicating ports 1 to 200, or port 80.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol. icmpv6: ICMPV6 protocol. gre: GRE protocol. all: Supports all protocols.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidrIp", "description", "networkAclEntryName", "policy", "port", "protocol" ] } } }, "volcenginecc:vpc/NetworkAclIngressAclEntry:NetworkAclIngressAclEntry": { "properties": { "cidrIp": { "type": "string", "description": "For inbound rules, specifies the source address range. For outbound rules, specifies the destination address range. Supports CIDR and IPv4 address ranges. Default value: none.\n" }, "description": { "type": "string", "description": "Rule description.\n" }, "networkAclEntryName": { "type": "string", "description": "Rule name.\n" }, "policy": { "type": "string", "description": "Authorization policy. accept: Allow access. drop: Deny access. No denial message is returned; the requester only experiences a timeout or similar connection failure.\n" }, "port": { "type": "string", "description": "Destination port range for the rule. If the direction rule protocol is all, icmp, or gre, the port range is -1/-1, meaning no port restriction. If the protocol is tcp or udp, the port range is 1–65535, formatted as 1/200, 80/80, indicating ports 1 to 200, or port 80.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol. icmpv6: ICMPV6 protocol. gre: GRE protocol. all: Supports all protocols.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidrIp", "description", "networkAclEntryName", "policy", "port", "protocol" ] } } }, "volcenginecc:vpc/NetworkAclResource:NetworkAclResource": { "properties": { "resourceId": { "type": "string", "description": "Associated resource ID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "resourceId" ] } } }, "volcenginecc:vpc/NetworkAclTag:NetworkAclTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/PrefixListAssociationsRouteTable:PrefixListAssociationsRouteTable": { "properties": { "resourceId": { "type": "string", "description": "ID of the associated resource.\n" }, "resourceType": { "type": "string", "description": "Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "resourceId", "resourceType" ] } } }, "volcenginecc:vpc/PrefixListAssociationsSecurityGroup:PrefixListAssociationsSecurityGroup": { "properties": { "resourceId": { "type": "string", "description": "ID of the associated resource.\n" }, "resourceType": { "type": "string", "description": "Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "resourceId", "resourceType" ] } } }, "volcenginecc:vpc/PrefixListPrefixListEntry:PrefixListPrefixListEntry": { "properties": { "cidr": { "type": "string", "description": "CIDR of the prefix list entry.\n" }, "description": { "type": "string", "description": "Description of the prefix list entry. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidr", "description" ] } } }, "volcenginecc:vpc/PrefixListTag:PrefixListTag": { "properties": { "key": { "type": "string", "description": "Tag key of the user tag.\n" }, "value": { "type": "string", "description": "Tag value of the user tag.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/RouteTableCustomRouteEntry:RouteTableCustomRouteEntry": { "properties": { "description": { "type": "string", "description": "Route Entry Description\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR of the route entry\n" }, "destinationPrefixListId": { "type": "string", "description": "Prefix List ID\n" }, "nextHopId": { "type": "string", "description": "Next Hop Resource ID\n" }, "nextHopName": { "type": "string", "description": "Name of the next hop resource for the route entry\n" }, "nextHopType": { "type": "string", "description": "Next hop type for custom route entry. 1. Instance: ECS instance 2. HaVip: High availability virtual IP 3. NetworkInterface: Secondary network interface 4. NatGW: NAT gateway 5. VpnGW: VPN gateway 6. TransitRouter: Transit router 7. IPv6GW: IPv6 gateway 8. CloudConnector: Cloud connector 9. GWLBEndpoint: Gateway load balancer endpoint\n" }, "routeEntryName": { "type": "string", "description": "Route Entry Name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "destinationCidrBlock", "destinationPrefixListId", "nextHopId", "nextHopName", "nextHopType", "routeEntryName" ] } } }, "volcenginecc:vpc/RouteTableSystemRouteEntry:RouteTableSystemRouteEntry": { "properties": { "description": { "type": "string", "description": "Route Entry Description\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR of the route entry\n" }, "destinationPrefixListId": { "type": "string", "description": "Prefix List ID\n" }, "nextHopId": { "type": "string", "description": "Next Hop Resource ID\n" }, "nextHopName": { "type": "string", "description": "Name of the next hop resource for the route entry\n" }, "nextHopType": { "type": "string", "description": "Next hop type for custom route entry. 1. Instance: ECS instance 2. HaVip: High availability virtual IP 3. NetworkInterface: Secondary network interface 4. NatGW: NAT gateway 5. VpnGW: VPN gateway 6. TransitRouter: Transit router 7. IPv6GW: IPv6 gateway 8. CloudConnector: Cloud connector 9. GWLBEndpoint: Gateway load balancer endpoint\n" }, "prefixListCidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "Prefix List CIDR\n" }, "routeEntryId": { "type": "string", "description": "Route Entry ID\n" }, "routeEntryName": { "type": "string", "description": "Route Entry Name\n" }, "routeTableId": { "type": "string", "description": "Route Table ID\n" }, "status": { "type": "string", "description": "Route entry status. 1. Pending: Pending creation 2. Available: Available\n" }, "type": { "type": "string", "description": "Route entry type. 1. Custom: Custom route entry 2. System: System default route entry\n" }, "vpcId": { "type": "string", "description": "ID of the private network to which the route entry belongs\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "destinationCidrBlock", "destinationPrefixListId", "nextHopId", "nextHopName", "nextHopType", "prefixListCidrBlocks", "routeEntryId", "routeEntryName", "routeTableId", "status", "type", "vpcId" ] } } }, "volcenginecc:vpc/RouteTableTag:RouteTableTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/SecurityGroupEgressPermission:SecurityGroupEgressPermission": { "properties": { "cidrIp": { "type": "string", "description": "IPv4 CIDR or IPv6 CIDR of the source address\n" }, "description": { "type": "string", "description": "Description for the security group rule. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1–255 characters. If not specified, the original configuration is retained\n" }, "direction": { "type": "string", "description": "Security group rule direction. ingress: inbound direction. egress: outbound direction\n" }, "policy": { "type": "string", "description": "Access policy. For resources specified by CidrIp, SourceGroupId, or PrefixListId, refers to the NICs in the security group. Values: accept (allow), drop (deny)\n" }, "portEnd": { "type": "integer", "description": "Port range end value. 1. When Protocol is set to tcp or udp, the valid range is 1–65535. 2. When Protocol is set to icmp, icmpv6, or all, only -1 is supported, indicating no port restriction\n" }, "portStart": { "type": "integer", "description": "Port range start value. 1. When Protocol is tcp or udp, range is 1–65535. 2. When Protocol is icmp, icmpv6, or all, only -1 is supported, meaning no port restriction\n" }, "prefixListId": { "type": "string", "description": "Prefix list ID\n" }, "priority": { "type": "integer", "description": "Security group rule priority. Lower numbers indicate higher priority. Value range: 1–100. Default: 1 if not specified\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp, udp, icmp, icmpv6, all\n" }, "sourceGroupId": { "type": "string", "description": "Source address security group ID. All NIC addresses in this security group are used as source addresses\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidrIp", "description", "direction", "policy", "portEnd", "portStart", "prefixListId", "priority", "protocol", "sourceGroupId" ] } } }, "volcenginecc:vpc/SecurityGroupIngressPermission:SecurityGroupIngressPermission": { "properties": { "cidrIp": { "type": "string", "description": "IPv4 CIDR or IPv6 CIDR of the source address\n" }, "description": { "type": "string", "description": "Description for the security group rule. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1–255 characters. If not specified, the original configuration is retained\n" }, "direction": { "type": "string", "description": "Security group rule direction. ingress: inbound direction. egress: outbound direction\n" }, "policy": { "type": "string", "description": "Access policy. For resources specified by CidrIp, SourceGroupId, or PrefixListId, refers to the NICs in the security group. Values: accept (allow), drop (deny)\n" }, "portEnd": { "type": "integer", "description": "Port range end value. 1. When Protocol is set to tcp or udp, the valid range is 1–65535. 2. When Protocol is set to icmp, icmpv6, or all, only -1 is supported, indicating no port restriction\n" }, "portStart": { "type": "integer", "description": "Port range start value. 1. When Protocol is tcp or udp, range is 1–65535. 2. When Protocol is icmp, icmpv6, or all, only -1 is supported, meaning no port restriction\n" }, "prefixListId": { "type": "string", "description": "Prefix list ID\n" }, "priority": { "type": "integer", "description": "Security group rule priority. Lower numbers indicate higher priority. Value range: 1–100. Default: 1 if not specified\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp, udp, icmp, icmpv6, all\n" }, "sourceGroupId": { "type": "string", "description": "Source address security group ID. All NIC addresses in this security group are used as source addresses\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidrIp", "description", "direction", "policy", "portEnd", "portStart", "prefixListId", "priority", "protocol", "sourceGroupId" ] } } }, "volcenginecc:vpc/SecurityGroupTag:SecurityGroupTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/SubnetRouteTable:SubnetRouteTable": { "properties": { "routeTableId": { "type": "string", "description": "ID of the route table associated with the subnet\n" }, "routeTableType": { "type": "string", "description": "Type of route table associated with the subnet. 1. System: System route table. 2. Custom: Custom route table\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "routeTableId", "routeTableType" ] } } }, "volcenginecc:vpc/SubnetTag:SubnetTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/TrafficMirrorFilterEgressFilterRule:TrafficMirrorFilterEgressFilterRule": { "properties": { "description": { "type": "string", "description": "Filter rule instance description\n" }, "destinationCidrBlock": { "type": "string", "description": "Filter rule destination address\n" }, "destinationPortRange": { "type": "string", "description": "Filter rule destination port range\n" }, "policy": { "type": "string", "description": "Filter rule action. accept: Enable traffic mirroring. reject: Do not enable traffic mirroring\n" }, "priority": { "type": "integer", "description": "Filter rule priority\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "protocol": { "type": "string", "description": "Filter rule protocol type\n" }, "sourceCidrBlock": { "type": "string", "description": "Filter rule source address\n" }, "sourcePortRange": { "type": "string", "description": "Filter rule source port range\n" }, "status": { "type": "string", "description": "Filter rule status\n" }, "trafficDirection": { "type": "string", "description": "Filter rule direction. egress: Outbound. ingress: Inbound\n" }, "trafficMirrorFilterId": { "type": "string", "description": "Filter condition instance ID\n" }, "trafficMirrorFilterRuleId": { "type": "string", "description": "Filter rule instance ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "destinationCidrBlock", "destinationPortRange", "policy", "priority", "projectName", "protocol", "sourceCidrBlock", "sourcePortRange", "status", "trafficDirection", "trafficMirrorFilterId", "trafficMirrorFilterRuleId" ] } } }, "volcenginecc:vpc/TrafficMirrorFilterIngressFilterRule:TrafficMirrorFilterIngressFilterRule": { "properties": { "description": { "type": "string", "description": "Filter rule instance description\n" }, "destinationCidrBlock": { "type": "string", "description": "Filter rule destination address\n" }, "destinationPortRange": { "type": "string", "description": "Filter rule destination port range\n" }, "policy": { "type": "string", "description": "Filter rule action. accept: Enable traffic mirroring. reject: Do not enable traffic mirroring\n" }, "priority": { "type": "integer", "description": "Filter rule priority\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "protocol": { "type": "string", "description": "Filter rule protocol type\n" }, "sourceCidrBlock": { "type": "string", "description": "Filter rule source address\n" }, "sourcePortRange": { "type": "string", "description": "Filter rule source port range\n" }, "status": { "type": "string", "description": "Filter rule status\n" }, "trafficDirection": { "type": "string", "description": "Filter rule direction. egress: Outbound. ingress: Inbound\n" }, "trafficMirrorFilterId": { "type": "string", "description": "Filter condition instance ID\n" }, "trafficMirrorFilterRuleId": { "type": "string", "description": "Filter rule instance ID\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "destinationCidrBlock", "destinationPortRange", "policy", "priority", "projectName", "protocol", "sourceCidrBlock", "sourcePortRange", "status", "trafficDirection", "trafficMirrorFilterId", "trafficMirrorFilterRuleId" ] } } }, "volcenginecc:vpc/TrafficMirrorFilterTag:TrafficMirrorFilterTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/TrafficMirrorSessionTag:TrafficMirrorSessionTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/TrafficMirrorTargetTag:TrafficMirrorTargetTag": { "properties": { "key": { "type": "string", "description": "Tag key. Length must be between 1 and 128 characters. Supports input of characters from any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it.\n" }, "value": { "type": "string", "description": "Tag value. Length must be between 0 and 256 characters. If not specified, the default is empty. Supports input of characters from any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system will automatically remove it.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/VpcAssociateCen:VpcAssociateCen": { "properties": { "cenId": { "type": "string", "description": "ID of the CEN.\n" }, "cenOwnerId": { "type": "string", "description": "User ID of the CEN.\n" }, "cenStatus": { "type": "string", "description": "Status of the VPC in the CEN. Loading: loading, Loaded: loaded\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cenId", "cenOwnerId", "cenStatus" ] } } }, "volcenginecc:vpc/VpcTag:VpcTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpc/getBandwidthPackageEipAddress:getBandwidthPackageEipAddress": { "properties": { "allocationId": { "type": "string", "description": "Allocation ID\n" }, "eipAddress": { "type": "string", "description": "Elastic IP address\n" } }, "type": "object", "required": [ "allocationId", "eipAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getBandwidthPackageTag:getBandwidthPackageTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getEipTag:getEipTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getEniPrimaryIpAddress:getEniPrimaryIpAddress": { "properties": { "associatedElasticIp": { "$ref": "#/types/volcenginecc:vpc/getEniPrimaryIpAddressAssociatedElasticIp:getEniPrimaryIpAddressAssociatedElasticIp", "description": "Information about the public IP associated with the primary private IPv4 address of the network interface.\n" }, "primary": { "type": "boolean", "description": "Indicates whether this is the primary private IPv4 address.\n" }, "privateIpAddress": { "type": "string", "description": "Private IP address of the network interface.\n" } }, "type": "object", "required": [ "associatedElasticIp", "primary", "privateIpAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getEniPrimaryIpAddressAssociatedElasticIp:getEniPrimaryIpAddressAssociatedElasticIp": { "properties": { "allocationId": { "type": "string", "description": "Public IP ID\n" }, "eipAddress": { "type": "string", "description": "Public IP address\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether the public IP is released when the cloud server instance is deleted. Only pay-as-you-go public IPs bound to the primary NIC's primary private IP are valid. When enabled, if the cloud server instance is automatically reclaimed by the system (24 hours after unsubscription, upon expiration, or due to overdue payment) or deleted via the DeleteInstances API, the public IP is released along with the instance. true: yes, false: no\n" } }, "type": "object", "required": [ "allocationId", "eipAddress", "releaseWithInstance" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getEniPrivateIpSet:getEniPrivateIpSet": { "properties": { "associatedElasticIp": { "$ref": "#/types/volcenginecc:vpc/getEniPrivateIpSetAssociatedElasticIp:getEniPrivateIpSetAssociatedElasticIp", "description": "Information about the public IP associated with the primary private IPv4 address of the network interface.\n" }, "primary": { "type": "boolean", "description": "Indicates whether this is the primary private IPv4 address.\n" }, "privateIpAddress": { "type": "string", "description": "Private IP address of the network interface.\n" } }, "type": "object", "required": [ "associatedElasticIp", "primary", "privateIpAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getEniPrivateIpSetAssociatedElasticIp:getEniPrivateIpSetAssociatedElasticIp": { "properties": { "allocationId": { "type": "string", "description": "Public IP ID\n" }, "eipAddress": { "type": "string", "description": "Public IP address\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether the public IP is released when the cloud server instance is deleted. Only pay-as-you-go public IPs bound to the primary NIC's primary private IP are valid. When enabled, if the cloud server instance is automatically reclaimed by the system (24 hours after unsubscription, upon expiration, or due to overdue payment) or deleted via the DeleteInstances API, the public IP is released along with the instance. true: yes, false: no\n" } }, "type": "object", "required": [ "allocationId", "eipAddress", "releaseWithInstance" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getEniTag:getEniTag": { "properties": { "key": { "type": "string", "description": "Tag key for the user tag.\n" }, "value": { "type": "string", "description": "Tag value for the user tag.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getFlowLogTag:getFlowLogTag": { "properties": { "key": { "type": "string", "description": "User label tag key. Length must be 1–128 characters. Supports input of characters from any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ symbols (@). If the tag key starts or ends with a space, the system automatically removes it.\n" }, "value": { "type": "string", "description": "User tag value. Supports input in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system will automatically remove it.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getHaVipTag:getHaVipTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tags. Length range: 1–128 characters. Supports input of characters in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system automatically removes it\n" }, "value": { "type": "string", "description": "Tag value for user tags. Supports input of characters in any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system automatically removes it\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getIpv6AddressBandwidthTag:getIpv6AddressBandwidthTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getIpv6GatewayTag:getIpv6GatewayTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getNetworkAclDefaultEgressAclEntry:getNetworkAclDefaultEgressAclEntry": { "properties": { "cidrIp": { "type": "string", "description": "For inbound rules, specifies the source address range. For outbound rules, specifies the destination address range. Supports CIDR and IPv4 address ranges. Default value: none.\n" }, "description": { "type": "string", "description": "Rule description.\n" }, "networkAclEntryId": { "type": "string", "description": "Rule ID.\n" }, "networkAclEntryName": { "type": "string", "description": "Rule name.\n" }, "policy": { "type": "string", "description": "Authorization policy. accept: Allow access. drop: Deny access. No denial message is returned; the requester only experiences a timeout or similar connection failure.\n" }, "port": { "type": "string", "description": "Destination port range for the rule. If the direction rule protocol is all, icmp, or gre, the port range is -1/-1, meaning no port restriction. If the protocol is tcp or udp, the port range is 1–65535, formatted as 1/200, 80/80, indicating ports 1 to 200, or port 80.\n" }, "priority": { "type": "integer", "description": "Priority of direction rules. Lower numbers indicate higher priority. Default value if not specified: 1.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol. icmpv6: ICMPV6 protocol. gre: GRE protocol. all: Supports all protocols.\n" } }, "type": "object", "required": [ "cidrIp", "description", "networkAclEntryId", "networkAclEntryName", "policy", "port", "priority", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getNetworkAclDefaultIngressAclEntry:getNetworkAclDefaultIngressAclEntry": { "properties": { "cidrIp": { "type": "string", "description": "For inbound rules, specifies the source address range. For outbound rules, specifies the destination address range. Supports CIDR and IPv4 address ranges. Default value: none.\n" }, "description": { "type": "string", "description": "Rule description.\n" }, "networkAclEntryId": { "type": "string", "description": "Rule ID.\n" }, "networkAclEntryName": { "type": "string", "description": "Rule name.\n" }, "policy": { "type": "string", "description": "Authorization policy. accept: Allow access. drop: Deny access. No denial message is returned; the requester only experiences a timeout or similar connection failure.\n" }, "port": { "type": "string", "description": "Destination port range for the rule. If the direction rule protocol is all, icmp, or gre, the port range is -1/-1, meaning no port restriction. If the protocol is tcp or udp, the port range is 1–65535, formatted as 1/200, 80/80, indicating ports 1 to 200, or port 80.\n" }, "priority": { "type": "integer", "description": "Priority of direction rules. Lower numbers indicate higher priority. Default value if not specified: 1.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol. icmpv6: ICMPV6 protocol. gre: GRE protocol. all: Supports all protocols.\n" } }, "type": "object", "required": [ "cidrIp", "description", "networkAclEntryId", "networkAclEntryName", "policy", "port", "priority", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getNetworkAclEgressAclEntry:getNetworkAclEgressAclEntry": { "properties": { "cidrIp": { "type": "string", "description": "For inbound rules, specifies the source address range. For outbound rules, specifies the destination address range. Supports CIDR and IPv4 address ranges. Default value: none.\n" }, "description": { "type": "string", "description": "Rule description.\n" }, "networkAclEntryId": { "type": "string", "description": "Rule ID.\n" }, "networkAclEntryName": { "type": "string", "description": "Rule name.\n" }, "policy": { "type": "string", "description": "Authorization policy. accept: Allow access. drop: Deny access. No denial message is returned; the requester only experiences a timeout or similar connection failure.\n" }, "port": { "type": "string", "description": "Destination port range for the rule. If the direction rule protocol is all, icmp, or gre, the port range is -1/-1, meaning no port restriction. If the protocol is tcp or udp, the port range is 1–65535, formatted as 1/200, 80/80, indicating ports 1 to 200, or port 80.\n" }, "priority": { "type": "integer", "description": "Priority of direction rules. Lower numbers indicate higher priority. Default value if not specified: 1.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol. icmpv6: ICMPV6 protocol. gre: GRE protocol. all: Supports all protocols.\n" } }, "type": "object", "required": [ "cidrIp", "description", "networkAclEntryId", "networkAclEntryName", "policy", "port", "priority", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getNetworkAclIngressAclEntry:getNetworkAclIngressAclEntry": { "properties": { "cidrIp": { "type": "string", "description": "For inbound rules, specifies the source address range. For outbound rules, specifies the destination address range. Supports CIDR and IPv4 address ranges. Default value: none.\n" }, "description": { "type": "string", "description": "Rule description.\n" }, "networkAclEntryId": { "type": "string", "description": "Rule ID.\n" }, "networkAclEntryName": { "type": "string", "description": "Rule name.\n" }, "policy": { "type": "string", "description": "Authorization policy. accept: Allow access. drop: Deny access. No denial message is returned; the requester only experiences a timeout or similar connection failure.\n" }, "port": { "type": "string", "description": "Destination port range for the rule. If the direction rule protocol is all, icmp, or gre, the port range is -1/-1, meaning no port restriction. If the protocol is tcp or udp, the port range is 1–65535, formatted as 1/200, 80/80, indicating ports 1 to 200, or port 80.\n" }, "priority": { "type": "integer", "description": "Priority of direction rules. Lower numbers indicate higher priority. Default value if not specified: 1.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol. icmpv6: ICMPV6 protocol. gre: GRE protocol. all: Supports all protocols.\n" } }, "type": "object", "required": [ "cidrIp", "description", "networkAclEntryId", "networkAclEntryName", "policy", "port", "priority", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getNetworkAclResource:getNetworkAclResource": { "properties": { "resourceId": { "type": "string", "description": "Associated resource ID.\n" }, "status": { "type": "string", "description": "Status of resources associated with the network ACL. BINDED: Bound. BINDING: Binding. UNBINDING: Unbinding.\n" } }, "type": "object", "required": [ "resourceId", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getNetworkAclTag:getNetworkAclTag": { "properties": { "key": { "type": "string", "description": "User tag key.\n" }, "value": { "type": "string", "description": "User tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getPrefixListAssociationsRouteTable:getPrefixListAssociationsRouteTable": { "properties": { "resourceId": { "type": "string", "description": "ID of the associated resource.\n" }, "resourceType": { "type": "string", "description": "Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.\n" } }, "type": "object", "required": [ "resourceId", "resourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getPrefixListAssociationsSecurityGroup:getPrefixListAssociationsSecurityGroup": { "properties": { "resourceId": { "type": "string", "description": "ID of the associated resource.\n" }, "resourceType": { "type": "string", "description": "Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.\n" } }, "type": "object", "required": [ "resourceId", "resourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getPrefixListPrefixListEntry:getPrefixListPrefixListEntry": { "properties": { "cidr": { "type": "string", "description": "CIDR of the prefix list entry.\n" }, "description": { "type": "string", "description": "Description of the prefix list entry. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" } }, "type": "object", "required": [ "cidr", "description" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getPrefixListTag:getPrefixListTag": { "properties": { "key": { "type": "string", "description": "Tag key of the user tag.\n" }, "value": { "type": "string", "description": "Tag value of the user tag.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getRouteTableCustomRouteEntry:getRouteTableCustomRouteEntry": { "properties": { "description": { "type": "string", "description": "Route Entry Description\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR of the route entry\n" }, "destinationPrefixListId": { "type": "string", "description": "Prefix List ID\n" }, "nextHopId": { "type": "string", "description": "Next Hop Resource ID\n" }, "nextHopName": { "type": "string", "description": "Name of the next hop resource for the route entry\n" }, "nextHopType": { "type": "string", "description": "Next hop type for custom route entry. 1. Instance: ECS instance 2. HaVip: High availability virtual IP 3. NetworkInterface: Secondary network interface 4. NatGW: NAT gateway 5. VpnGW: VPN gateway 6. TransitRouter: Transit router 7. IPv6GW: IPv6 gateway 8. CloudConnector: Cloud connector 9. GWLBEndpoint: Gateway load balancer endpoint\n" }, "prefixListCidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "Prefix List CIDR\n" }, "routeEntryId": { "type": "string", "description": "Route Entry ID\n" }, "routeEntryName": { "type": "string", "description": "Route Entry Name\n" }, "routeTableId": { "type": "string", "description": "Route Table ID\n" }, "status": { "type": "string", "description": "Route entry status. 1. Pending: Pending creation 2. Available: Available\n" }, "type": { "type": "string", "description": "Route entry type. 1. Custom: Custom route entry 2. System: System default route entry\n" }, "vpcId": { "type": "string", "description": "ID of the private network to which the route entry belongs\n" } }, "type": "object", "required": [ "description", "destinationCidrBlock", "destinationPrefixListId", "nextHopId", "nextHopName", "nextHopType", "prefixListCidrBlocks", "routeEntryId", "routeEntryName", "routeTableId", "status", "type", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getRouteTableSystemRouteEntry:getRouteTableSystemRouteEntry": { "properties": { "description": { "type": "string", "description": "Route Entry Description\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR of the route entry\n" }, "destinationPrefixListId": { "type": "string", "description": "Prefix List ID\n" }, "nextHopId": { "type": "string", "description": "Next Hop Resource ID\n" }, "nextHopName": { "type": "string", "description": "Name of the next hop resource for the route entry\n" }, "nextHopType": { "type": "string", "description": "Next hop type for custom route entry. 1. Instance: ECS instance 2. HaVip: High availability virtual IP 3. NetworkInterface: Secondary network interface 4. NatGW: NAT gateway 5. VpnGW: VPN gateway 6. TransitRouter: Transit router 7. IPv6GW: IPv6 gateway 8. CloudConnector: Cloud connector 9. GWLBEndpoint: Gateway load balancer endpoint\n" }, "prefixListCidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "Prefix List CIDR\n" }, "routeEntryId": { "type": "string", "description": "Route Entry ID\n" }, "routeEntryName": { "type": "string", "description": "Route Entry Name\n" }, "routeTableId": { "type": "string", "description": "Route Table ID\n" }, "status": { "type": "string", "description": "Route entry status. 1. Pending: Pending creation 2. Available: Available\n" }, "type": { "type": "string", "description": "Route entry type. 1. Custom: Custom route entry 2. System: System default route entry\n" }, "vpcId": { "type": "string", "description": "ID of the private network to which the route entry belongs\n" } }, "type": "object", "required": [ "description", "destinationCidrBlock", "destinationPrefixListId", "nextHopId", "nextHopName", "nextHopType", "prefixListCidrBlocks", "routeEntryId", "routeEntryName", "routeTableId", "status", "type", "vpcId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getRouteTableTag:getRouteTableTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getSecurityGroupEgressPermission:getSecurityGroupEgressPermission": { "properties": { "cidrIp": { "type": "string", "description": "IPv4 CIDR or IPv6 CIDR of the source address\n" }, "creationTime": { "type": "string", "description": "Security group rule creation time\n" }, "description": { "type": "string", "description": "Description for the security group rule. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1–255 characters. If not specified, the original configuration is retained\n" }, "direction": { "type": "string", "description": "Security group rule direction. ingress: inbound direction. egress: outbound direction\n" }, "policy": { "type": "string", "description": "Access policy. For resources specified by CidrIp, SourceGroupId, or PrefixListId, refers to the NICs in the security group. Values: accept (allow), drop (deny)\n" }, "portEnd": { "type": "integer", "description": "Port range end value. 1. When Protocol is set to tcp or udp, the valid range is 1–65535. 2. When Protocol is set to icmp, icmpv6, or all, only -1 is supported, indicating no port restriction\n" }, "portStart": { "type": "integer", "description": "Port range start value. 1. When Protocol is tcp or udp, range is 1–65535. 2. When Protocol is icmp, icmpv6, or all, only -1 is supported, meaning no port restriction\n" }, "prefixListCidrs": { "type": "array", "items": { "type": "string" }, "description": "Prefix list CIDR\n" }, "prefixListId": { "type": "string", "description": "Prefix list ID\n" }, "priority": { "type": "integer", "description": "Security group rule priority. Lower numbers indicate higher priority. Value range: 1–100. Default: 1 if not specified\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp, udp, icmp, icmpv6, all\n" }, "sourceGroupId": { "type": "string", "description": "Source address security group ID. All NIC addresses in this security group are used as source addresses\n" }, "updateTime": { "type": "string", "description": "Security group rule update time\n" } }, "type": "object", "required": [ "cidrIp", "creationTime", "description", "direction", "policy", "portEnd", "portStart", "prefixListCidrs", "prefixListId", "priority", "protocol", "sourceGroupId", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getSecurityGroupIngressPermission:getSecurityGroupIngressPermission": { "properties": { "cidrIp": { "type": "string", "description": "IPv4 CIDR or IPv6 CIDR of the source address\n" }, "creationTime": { "type": "string", "description": "Security group rule creation time\n" }, "description": { "type": "string", "description": "Description for the security group rule. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1–255 characters. If not specified, the original configuration is retained\n" }, "direction": { "type": "string", "description": "Security group rule direction. ingress: inbound direction. egress: outbound direction\n" }, "policy": { "type": "string", "description": "Access policy. For resources specified by CidrIp, SourceGroupId, or PrefixListId, refers to the NICs in the security group. Values: accept (allow), drop (deny)\n" }, "portEnd": { "type": "integer", "description": "Port range end value. 1. When Protocol is set to tcp or udp, the valid range is 1–65535. 2. When Protocol is set to icmp, icmpv6, or all, only -1 is supported, indicating no port restriction\n" }, "portStart": { "type": "integer", "description": "Port range start value. 1. When Protocol is tcp or udp, range is 1–65535. 2. When Protocol is icmp, icmpv6, or all, only -1 is supported, meaning no port restriction\n" }, "prefixListCidrs": { "type": "array", "items": { "type": "string" }, "description": "Prefix list CIDR\n" }, "prefixListId": { "type": "string", "description": "Prefix list ID\n" }, "priority": { "type": "integer", "description": "Security group rule priority. Lower numbers indicate higher priority. Value range: 1–100. Default: 1 if not specified\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp, udp, icmp, icmpv6, all\n" }, "sourceGroupId": { "type": "string", "description": "Source address security group ID. All NIC addresses in this security group are used as source addresses\n" }, "updateTime": { "type": "string", "description": "Security group rule update time\n" } }, "type": "object", "required": [ "cidrIp", "creationTime", "description", "direction", "policy", "portEnd", "portStart", "prefixListCidrs", "prefixListId", "priority", "protocol", "sourceGroupId", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getSecurityGroupTag:getSecurityGroupTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getSubnetRouteTable:getSubnetRouteTable": { "properties": { "routeTableId": { "type": "string", "description": "ID of the route table associated with the subnet\n" }, "routeTableType": { "type": "string", "description": "Type of route table associated with the subnet. 1. System: System route table. 2. Custom: Custom route table\n" } }, "type": "object", "required": [ "routeTableId", "routeTableType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getSubnetTag:getSubnetTag": { "properties": { "key": { "type": "string", "description": "User tag key\n" }, "value": { "type": "string", "description": "User tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getTrafficMirrorFilterEgressFilterRule:getTrafficMirrorFilterEgressFilterRule": { "properties": { "description": { "type": "string", "description": "Filter rule instance description\n" }, "destinationCidrBlock": { "type": "string", "description": "Filter rule destination address\n" }, "destinationPortRange": { "type": "string", "description": "Filter rule destination port range\n" }, "policy": { "type": "string", "description": "Filter rule action. accept: Enable traffic mirroring. reject: Do not enable traffic mirroring\n" }, "priority": { "type": "integer", "description": "Filter rule priority\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "protocol": { "type": "string", "description": "Filter rule protocol type\n" }, "sourceCidrBlock": { "type": "string", "description": "Filter rule source address\n" }, "sourcePortRange": { "type": "string", "description": "Filter rule source port range\n" }, "status": { "type": "string", "description": "Filter rule status\n" }, "trafficDirection": { "type": "string", "description": "Filter rule direction. egress: Outbound. ingress: Inbound\n" }, "trafficMirrorFilterId": { "type": "string", "description": "Filter condition instance ID\n" }, "trafficMirrorFilterRuleId": { "type": "string", "description": "Filter rule instance ID\n" } }, "type": "object", "required": [ "description", "destinationCidrBlock", "destinationPortRange", "policy", "priority", "projectName", "protocol", "sourceCidrBlock", "sourcePortRange", "status", "trafficDirection", "trafficMirrorFilterId", "trafficMirrorFilterRuleId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getTrafficMirrorFilterIngressFilterRule:getTrafficMirrorFilterIngressFilterRule": { "properties": { "description": { "type": "string", "description": "Filter rule instance description\n" }, "destinationCidrBlock": { "type": "string", "description": "Filter rule destination address\n" }, "destinationPortRange": { "type": "string", "description": "Filter rule destination port range\n" }, "policy": { "type": "string", "description": "Filter rule action. accept: Enable traffic mirroring. reject: Do not enable traffic mirroring\n" }, "priority": { "type": "integer", "description": "Filter rule priority\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "protocol": { "type": "string", "description": "Filter rule protocol type\n" }, "sourceCidrBlock": { "type": "string", "description": "Filter rule source address\n" }, "sourcePortRange": { "type": "string", "description": "Filter rule source port range\n" }, "status": { "type": "string", "description": "Filter rule status\n" }, "trafficDirection": { "type": "string", "description": "Filter rule direction. egress: Outbound. ingress: Inbound\n" }, "trafficMirrorFilterId": { "type": "string", "description": "Filter condition instance ID\n" }, "trafficMirrorFilterRuleId": { "type": "string", "description": "Filter rule instance ID\n" } }, "type": "object", "required": [ "description", "destinationCidrBlock", "destinationPortRange", "policy", "priority", "projectName", "protocol", "sourceCidrBlock", "sourcePortRange", "status", "trafficDirection", "trafficMirrorFilterId", "trafficMirrorFilterRuleId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getTrafficMirrorFilterTag:getTrafficMirrorFilterTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getTrafficMirrorSessionTag:getTrafficMirrorSessionTag": { "properties": { "key": { "type": "string", "description": "Tag key\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getTrafficMirrorTargetTag:getTrafficMirrorTargetTag": { "properties": { "key": { "type": "string", "description": "Tag key. Length must be between 1 and 128 characters. Supports input of characters from any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it.\n" }, "value": { "type": "string", "description": "Tag value. Length must be between 0 and 256 characters. If not specified, the default is empty. Supports input of characters from any language, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @ (@). Case sensitive. If the tag value starts or ends with a space, the system will automatically remove it.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getVpcAssociateCen:getVpcAssociateCen": { "properties": { "cenId": { "type": "string", "description": "ID of the CEN.\n" }, "cenOwnerId": { "type": "string", "description": "User ID of the CEN.\n" }, "cenStatus": { "type": "string", "description": "Status of the VPC in the CEN. Loading: loading, Loaded: loaded\n" } }, "type": "object", "required": [ "cenId", "cenOwnerId", "cenStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpc/getVpcTag:getVpcTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/CustomerGatewayTag:CustomerGatewayTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tag\n" }, "value": { "type": "string", "description": "Tag value for user tag\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpn/SslVpnClientCertTag:SslVpnClientCertTag": { "properties": { "key": { "type": "string", "description": "Tag key (Key) for SSL client certificate tags. Parameter - N: indicates the sequence number of the tag key, range: 1–20. Multiple tag keys are separated by \u0026. Naming rules: Cannot start with any combination of 'sys:' in any case. Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1–128 characters. Note: Duplicate tag keys are not allowed for the same resource.\n" }, "value": { "type": "string", "description": "Tag value (Value) for SSL client certificate tags. Parameter - N: indicates the sequence number of the tag value, range: 1–20. Multiple tag values are separated by \u0026. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty, length must be between 0–256 characters. Case-sensitive, cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpn/VpnConnectionBgpInfo:VpnConnectionBgpInfo": { "properties": { "enableBgp": { "type": "boolean", "description": "Enable dynamic route propagation. false (default): No, use static routing mode. true: Yes, use BGP routing mode.\n" }, "localAsn": { "type": "integer", "description": "The ASN of the VPN gateway.\n" }, "localBgpIp": { "type": "string", "description": "The local tunnel IP, which is the BGP address configured on the VPN gateway and defaults to the first host address of BgpConfig.TunnelCidr. This address must be an IP address within the IPsec tunnel subnet. If BgpConfig.EnableBgp is set to true, this parameter must be provided.\n" }, "peerAsn": { "type": "integer", "description": "ASN of the customer gateway.\n" }, "peerBgpIp": { "type": "string", "description": "BGP peer IP, that is, the BGP address on the customer gateway side.\n" }, "sessionStatus": { "type": "string", "description": "Status of the BGP connection. Up: BGP connection is normal. Down: BGP connection is not working.\n" }, "tunnelCidr": { "type": "string", "description": "CIDR address range for the local and peer IPs of the BGP session.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableBgp", "localAsn", "localBgpIp", "peerAsn", "peerBgpIp", "sessionStatus", "tunnelCidr" ] } } }, "volcenginecc:vpn/VpnConnectionHealthChecker:VpnConnectionHealthChecker": { "properties": { "checkInterval": { "type": "integer", "description": "Interval for performing health checks\n" }, "checkResult": { "type": "string", "description": "Health check result. Up: Normal. Down: Abnormal.\n" }, "checkerId": { "type": "string", "description": "ID of the IPsec connection health check\n" }, "downTime": { "type": "integer", "description": "Health check unhealthy threshold. If the health check result is 'abnormal' for the specified number of consecutive times, the IPsec connection is considered unhealthy.\n" }, "localIp": { "type": "string", "description": "Health check source IP.\n" }, "remoteIp": { "type": "string", "description": "Health check target IP.\n" }, "timeout": { "type": "integer", "description": "Health check response timeout. If the IPsec connection does not respond correctly within the specified response time, it is considered 'abnormal' for health check.\n" }, "upTime": { "type": "integer", "description": "Health check threshold. If the specified number of consecutive health checks are all 'healthy', the IPsec connection is considered 'healthy' by health check.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "checkInterval", "checkResult", "checkerId", "downTime", "localIp", "remoteIp", "timeout", "upTime" ] } } }, "volcenginecc:vpn/VpnConnectionIkeConfig:VpnConnectionIkeConfig": { "properties": { "authAlg": { "type": "string", "description": "Authentication algorithm for phase one.\n" }, "dhGroup": { "type": "string", "description": "DH (Diffie-Hellman) key exchange algorithm used in phase 1 negotiation. Valid values: group1, group2 (default), group5, group14\n" }, "encAlg": { "type": "string", "description": "Encryption algorithm for phase 1 negotiation.\n" }, "lifetime": { "type": "integer", "description": "Lifetime of the SA for phase 1 negotiation. After the lifetime is exceeded, negotiation restarts. Value range: 900~86400, unit: seconds. Default: 86400.\n" }, "localId": { "type": "string", "description": "Identifier of the VPN gateway, used for phase 1 negotiation. Supports IP format and FQDN (Fully Qualified Domain Name) format. If not specified, defaults to the current VPN gateway's egress IP address. If you manually set it to FQDN format, it is recommended to set the negotiation mode to 'aggressive'. Maximum length is 100 characters. Only uppercase and lowercase letters, special characters ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ; and digits are allowed.\n" }, "mode": { "type": "string", "description": "Negotiation mode for phase 1. This parameter is required only when IkeConfig.Version is ikev1. Valid values: main (default), aggressive\n" }, "psk": { "type": "string", "description": "Pre-shared key used for identity authentication between the VPN gateway and the user gateway in phase 1. Must not exceed 100 characters and can only contain uppercase and lowercase letters, special symbols ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ;, and numbers.\n" }, "remoteId": { "type": "string", "description": "Identifier of the customer gateway, used for phase one negotiation. Supports IP format and FQDN (Fully Qualified Domain Name) format. If not specified, defaults to the public IP address of the currently selected customer gateway. If you manually set it to FQDN format, it is recommended to set the negotiation mode to 'aggressive'. Maximum length is 100 characters. Only uppercase and lowercase letters, special characters ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ;, and digits are allowed.\n" }, "version": { "type": "string", "description": "Version of the IKE key exchange protocol. Valid values: ikev1, ikev2 (default).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authAlg", "dhGroup", "encAlg", "lifetime", "localId", "mode", "psk", "remoteId", "version" ] } } }, "volcenginecc:vpn/VpnConnectionIpsecConfig:VpnConnectionIpsecConfig": { "properties": { "authAlg": { "type": "string", "description": "Authentication algorithm for phase 2 negotiation\n" }, "dhGroup": { "type": "string", "description": "DH (Diffie-Hellman) key exchange algorithm used in phase 2\n" }, "encAlg": { "type": "string", "description": "Encryption algorithm for phase 2 negotiation\n" }, "lifetime": { "type": "integer", "description": "Lifetime of the SA for phase 2 negotiation. Negotiation will be re-initiated after the lifetime expires.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authAlg", "dhGroup", "encAlg", "lifetime" ] } } }, "volcenginecc:vpn/VpnConnectionTag:VpnConnectionTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpn/VpnConnectionTunnelOption:VpnConnectionTunnelOption": { "properties": { "connectStatus": { "type": "string", "description": "IPsec tunnel status. ike*sa*negotiation*failed: Phase one negotiation failed; nike*sa*negotiation*completed: Phase one negotiation succeeded; nipsec*sa*negotiation*failed: Phase two negotiation failed; nipsec*sa*negotiation*completed: Phase two negotiation succeeded.\n" }, "customerGatewayId": { "type": "string", "description": "ID of the customer gateway associated with the IPsec connection.\n" }, "dpdAction": { "type": "string", "description": "Status of the DPD feature.\n" }, "ikeConfig": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionTunnelOptionIkeConfig:VpnConnectionTunnelOptionIkeConfig", "description": "IKE configuration information for the IPsec connection.\n" }, "ipsecConfig": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionTunnelOptionIpsecConfig:VpnConnectionTunnelOptionIpsecConfig", "description": "Information about the IPsec configuration in the IPsec connection.\n" }, "natTraversal": { "type": "boolean", "description": "Whether to enable NAT traversal\n" }, "role": { "type": "string", "description": "The role of the tunnel.\n" }, "tunnelBgpInfo": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionTunnelOptionTunnelBgpInfo:VpnConnectionTunnelOptionTunnelBgpInfo", "description": "BGP session information.\n" }, "tunnelId": { "type": "string", "description": "Tunnel ID of the IPsec connection.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "connectStatus", "customerGatewayId", "dpdAction", "ikeConfig", "ipsecConfig", "natTraversal", "role", "tunnelBgpInfo", "tunnelId" ] } } }, "volcenginecc:vpn/VpnConnectionTunnelOptionIkeConfig:VpnConnectionTunnelOptionIkeConfig": { "properties": { "authAlg": { "type": "string", "description": "Authentication algorithm for phase one.\n" }, "dhGroup": { "type": "string", "description": "DH (Diffie-Hellman) key exchange algorithm used in phase 1 negotiation. Valid values: group1, group2 (default), group5, group14\n" }, "encAlg": { "type": "string", "description": "Encryption algorithm for phase 1 negotiation.\n" }, "lifetime": { "type": "integer", "description": "Lifetime of the SA for phase 1 negotiation. After the lifetime is exceeded, negotiation restarts. Value range: 900~86400, unit: seconds. Default: 86400.\n" }, "localId": { "type": "string", "description": "Identifier of the VPN gateway, used for phase 1 negotiation. Supports IP format and FQDN (Fully Qualified Domain Name) format. If not specified, defaults to the current VPN gateway's egress IP address. If you manually set it to FQDN format, it is recommended to set the negotiation mode to 'aggressive'. Maximum length is 100 characters. Only uppercase and lowercase letters, special characters ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ; and digits are allowed.\n" }, "mode": { "type": "string", "description": "Negotiation mode for phase 1. This parameter is required only when IkeConfig.Version is ikev1. Valid values: main (default), aggressive\n" }, "psk": { "type": "string", "description": "Pre-shared key used for identity authentication between the VPN gateway and the user gateway in phase 1. Must not exceed 100 characters and can only contain uppercase and lowercase letters, special symbols ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ;, and numbers.\n" }, "remoteId": { "type": "string", "description": "Identifier of the customer gateway, used for phase one negotiation. Supports IP format and FQDN (Fully Qualified Domain Name) format. If not specified, defaults to the public IP address of the currently selected customer gateway. If you manually set it to FQDN format, it is recommended to set the negotiation mode to 'aggressive'. Maximum length is 100 characters. Only uppercase and lowercase letters, special characters ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ;, and digits are allowed.\n" }, "version": { "type": "string", "description": "Version of the IKE key exchange protocol. Valid values: ikev1, ikev2 (default).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authAlg", "dhGroup", "encAlg", "lifetime", "localId", "mode", "psk", "remoteId", "version" ] } } }, "volcenginecc:vpn/VpnConnectionTunnelOptionIpsecConfig:VpnConnectionTunnelOptionIpsecConfig": { "properties": { "authAlg": { "type": "string", "description": "Authentication algorithm for phase 2 negotiation\n" }, "dhGroup": { "type": "string", "description": "DH (Diffie-Hellman) key exchange algorithm used in phase 2\n" }, "encAlg": { "type": "string", "description": "Encryption algorithm for phase 2 negotiation\n" }, "lifetime": { "type": "integer", "description": "Lifetime of the SA for phase 2 negotiation. Negotiation will be re-initiated after the lifetime expires.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authAlg", "dhGroup", "encAlg", "lifetime" ] } } }, "volcenginecc:vpn/VpnConnectionTunnelOptionTunnelBgpInfo:VpnConnectionTunnelOptionTunnelBgpInfo": { "properties": { "enableBgp": { "type": "boolean", "description": "Enable dynamic route propagation. false (default): No, use static routing mode. true: Yes, use BGP routing mode.\n" }, "localAsn": { "type": "integer", "description": "The ASN of the VPN gateway.\n" }, "localBgpIp": { "type": "string", "description": "BGP address. Defaults to the first host address of TunnelOptions.N.BGPConfig.TunnelCidr. This address must be an IP address within the IPsec tunnel CIDR block. If EnableTunnelsBgp is set to true, this parameter must be specified.\n" }, "peerAsn": { "type": "integer", "description": "ASN of the customer gateway.\n" }, "peerBgpIp": { "type": "string", "description": "BGP peer IP, that is, the BGP address on the customer gateway side.\n" }, "sessionStatus": { "type": "string", "description": "Status of the BGP connection. Up: BGP connection is normal. Down: BGP connection is not working.\n" }, "tunnelCidr": { "type": "string", "description": "The CIDR address range for the local and peer IPs of the BGP session. This range must be within the 169.254.0.0/16 subnet with a subnet mask length of 30. If EnableTunnelsBgp is set to true, this parameter must be provided.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enableBgp", "localAsn", "localBgpIp", "peerAsn", "peerBgpIp", "sessionStatus", "tunnelCidr" ] } } }, "volcenginecc:vpn/VpnGatewayTag:VpnGatewayTag": { "properties": { "key": { "type": "string", "description": "VPN gateway tag key (Key). Parameter - N: Indicates the sequence number of the tag key, value range: 1–20. Multiple tag keys are separated by \u0026. Naming rules: Cannot start with any combination of volc: or sys: (case-insensitive). Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length limit: 1–128 characters. Note: Tag keys for the same resource must not be duplicated.\n" }, "value": { "type": "string", "description": "VPN gateway tag value (Value). Parameter - N: Indicates the sequence number of the tag value, value range: 1–20. Multiple tag values are separated by \u0026. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length limit: 0–256 characters. Case-sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "volcenginecc:vpn/getCustomerGatewayTag:getCustomerGatewayTag": { "properties": { "key": { "type": "string", "description": "Tag key for user tag\n" }, "value": { "type": "string", "description": "Tag value for user tag\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getSslVpnClientCertTag:getSslVpnClientCertTag": { "properties": { "key": { "type": "string", "description": "Tag key (Key) for SSL client certificate tags. Parameter - N: indicates the sequence number of the tag key, range: 1–20. Multiple tag keys are separated by \u0026. Naming rules: Cannot start with any combination of 'sys:' in any case. Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1–128 characters. Note: Duplicate tag keys are not allowed for the same resource.\n" }, "value": { "type": "string", "description": "Tag value (Value) for SSL client certificate tags. Parameter - N: indicates the sequence number of the tag value, range: 1–20. Multiple tag values are separated by \u0026. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty, length must be between 0–256 characters. Case-sensitive, cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnConnectionBgpInfo:getVpnConnectionBgpInfo": { "properties": { "enableBgp": { "type": "boolean", "description": "Enable dynamic route propagation. false (default): No, use static routing mode. true: Yes, use BGP routing mode.\n" }, "localAsn": { "type": "integer", "description": "The ASN of the VPN gateway.\n" }, "localBgpIp": { "type": "string", "description": "The local tunnel IP, which is the BGP address configured on the VPN gateway and defaults to the first host address of BgpConfig.TunnelCidr. This address must be an IP address within the IPsec tunnel subnet. If BgpConfig.EnableBgp is set to true, this parameter must be provided.\n" }, "peerAsn": { "type": "integer", "description": "ASN of the customer gateway.\n" }, "peerBgpIp": { "type": "string", "description": "BGP peer IP, that is, the BGP address on the customer gateway side.\n" }, "sessionStatus": { "type": "string", "description": "Status of the BGP connection. Up: BGP connection is normal. Down: BGP connection is not working.\n" }, "tunnelCidr": { "type": "string", "description": "CIDR address range for the local and peer IPs of the BGP session.\n" } }, "type": "object", "required": [ "enableBgp", "localAsn", "localBgpIp", "peerAsn", "peerBgpIp", "sessionStatus", "tunnelCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnConnectionHealthChecker:getVpnConnectionHealthChecker": { "properties": { "checkInterval": { "type": "integer", "description": "Interval for performing health checks\n" }, "checkResult": { "type": "string", "description": "Health check result. Up: Normal. Down: Abnormal.\n" }, "checkerId": { "type": "string", "description": "ID of the IPsec connection health check\n" }, "downTime": { "type": "integer", "description": "Health check unhealthy threshold. If the health check result is 'abnormal' for the specified number of consecutive times, the IPsec connection is considered unhealthy.\n" }, "localIp": { "type": "string", "description": "Health check source IP.\n" }, "remoteIp": { "type": "string", "description": "Health check target IP.\n" }, "timeout": { "type": "integer", "description": "Health check response timeout. If the IPsec connection does not respond correctly within the specified response time, it is considered 'abnormal' for health check.\n" }, "upTime": { "type": "integer", "description": "Health check threshold. If the specified number of consecutive health checks are all 'healthy', the IPsec connection is considered 'healthy' by health check.\n" } }, "type": "object", "required": [ "checkInterval", "checkResult", "checkerId", "downTime", "localIp", "remoteIp", "timeout", "upTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnConnectionIkeConfig:getVpnConnectionIkeConfig": { "properties": { "authAlg": { "type": "string", "description": "Authentication algorithm for phase one.\n" }, "dhGroup": { "type": "string", "description": "DH (Diffie-Hellman) key exchange algorithm used in phase 1 negotiation. Valid values: group1, group2 (default), group5, group14\n" }, "encAlg": { "type": "string", "description": "Encryption algorithm for phase 1 negotiation.\n" }, "lifetime": { "type": "integer", "description": "Lifetime of the SA for phase 1 negotiation. After the lifetime is exceeded, negotiation restarts. Value range: 900~86400, unit: seconds. Default: 86400.\n" }, "localId": { "type": "string", "description": "Identifier of the VPN gateway, used for phase 1 negotiation. Supports IP format and FQDN (Fully Qualified Domain Name) format. If not specified, defaults to the current VPN gateway's egress IP address. If you manually set it to FQDN format, it is recommended to set the negotiation mode to 'aggressive'. Maximum length is 100 characters. Only uppercase and lowercase letters, special characters ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ; and digits are allowed.\n" }, "mode": { "type": "string", "description": "Negotiation mode for phase 1. This parameter is required only when IkeConfig.Version is ikev1. Valid values: main (default), aggressive\n" }, "psk": { "type": "string", "description": "Pre-shared key used for identity authentication between the VPN gateway and the user gateway in phase 1. Must not exceed 100 characters and can only contain uppercase and lowercase letters, special symbols ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ;, and numbers.\n" }, "remoteId": { "type": "string", "description": "Identifier of the customer gateway, used for phase one negotiation. Supports IP format and FQDN (Fully Qualified Domain Name) format. If not specified, defaults to the public IP address of the currently selected customer gateway. If you manually set it to FQDN format, it is recommended to set the negotiation mode to 'aggressive'. Maximum length is 100 characters. Only uppercase and lowercase letters, special characters ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ;, and digits are allowed.\n" }, "version": { "type": "string", "description": "Version of the IKE key exchange protocol. Valid values: ikev1, ikev2 (default).\n" } }, "type": "object", "required": [ "authAlg", "dhGroup", "encAlg", "lifetime", "localId", "mode", "psk", "remoteId", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnConnectionIpsecConfig:getVpnConnectionIpsecConfig": { "properties": { "authAlg": { "type": "string", "description": "Authentication algorithm for phase 2 negotiation\n" }, "dhGroup": { "type": "string", "description": "DH (Diffie-Hellman) key exchange algorithm used in phase 2\n" }, "encAlg": { "type": "string", "description": "Encryption algorithm for phase 2 negotiation\n" }, "lifetime": { "type": "integer", "description": "Lifetime of the SA for phase 2 negotiation. Negotiation will be re-initiated after the lifetime expires.\n" } }, "type": "object", "required": [ "authAlg", "dhGroup", "encAlg", "lifetime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnConnectionTag:getVpnConnectionTag": { "properties": { "key": { "type": "string", "description": "Tag key.\n" }, "value": { "type": "string", "description": "Tag value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnConnectionTunnelOption:getVpnConnectionTunnelOption": { "properties": { "connectStatus": { "type": "string", "description": "IPsec tunnel status. ike*sa*negotiation*failed: Phase one negotiation failed; nike*sa*negotiation*completed: Phase one negotiation succeeded; nipsec*sa*negotiation*failed: Phase two negotiation failed; nipsec*sa*negotiation*completed: Phase two negotiation succeeded.\n" }, "customerGatewayId": { "type": "string", "description": "ID of the customer gateway associated with the IPsec connection.\n" }, "dpdAction": { "type": "string", "description": "Status of the DPD feature.\n" }, "ikeConfig": { "$ref": "#/types/volcenginecc:vpn/getVpnConnectionTunnelOptionIkeConfig:getVpnConnectionTunnelOptionIkeConfig", "description": "IKE configuration information for the IPsec connection.\n" }, "ipsecConfig": { "$ref": "#/types/volcenginecc:vpn/getVpnConnectionTunnelOptionIpsecConfig:getVpnConnectionTunnelOptionIpsecConfig", "description": "Information about the IPsec configuration in the IPsec connection.\n" }, "natTraversal": { "type": "boolean", "description": "Whether to enable NAT traversal\n" }, "role": { "type": "string", "description": "The role of the tunnel.\n" }, "tunnelBgpInfo": { "$ref": "#/types/volcenginecc:vpn/getVpnConnectionTunnelOptionTunnelBgpInfo:getVpnConnectionTunnelOptionTunnelBgpInfo", "description": "BGP session information.\n" }, "tunnelId": { "type": "string", "description": "Tunnel ID of the IPsec connection.\n" } }, "type": "object", "required": [ "connectStatus", "customerGatewayId", "dpdAction", "ikeConfig", "ipsecConfig", "natTraversal", "role", "tunnelBgpInfo", "tunnelId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnConnectionTunnelOptionIkeConfig:getVpnConnectionTunnelOptionIkeConfig": { "properties": { "authAlg": { "type": "string", "description": "Authentication algorithm for phase one.\n" }, "dhGroup": { "type": "string", "description": "DH (Diffie-Hellman) key exchange algorithm used in phase 1 negotiation. Valid values: group1, group2 (default), group5, group14\n" }, "encAlg": { "type": "string", "description": "Encryption algorithm for phase 1 negotiation.\n" }, "lifetime": { "type": "integer", "description": "Lifetime of the SA for phase 1 negotiation. After the lifetime is exceeded, negotiation restarts. Value range: 900~86400, unit: seconds. Default: 86400.\n" }, "localId": { "type": "string", "description": "Identifier of the VPN gateway, used for phase 1 negotiation. Supports IP format and FQDN (Fully Qualified Domain Name) format. If not specified, defaults to the current VPN gateway's egress IP address. If you manually set it to FQDN format, it is recommended to set the negotiation mode to 'aggressive'. Maximum length is 100 characters. Only uppercase and lowercase letters, special characters ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ; and digits are allowed.\n" }, "mode": { "type": "string", "description": "Negotiation mode for phase 1. This parameter is required only when IkeConfig.Version is ikev1. Valid values: main (default), aggressive\n" }, "psk": { "type": "string", "description": "Pre-shared key used for identity authentication between the VPN gateway and the user gateway in phase 1. Must not exceed 100 characters and can only contain uppercase and lowercase letters, special symbols ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ;, and numbers.\n" }, "remoteId": { "type": "string", "description": "Identifier of the customer gateway, used for phase one negotiation. Supports IP format and FQDN (Fully Qualified Domain Name) format. If not specified, defaults to the public IP address of the currently selected customer gateway. If you manually set it to FQDN format, it is recommended to set the negotiation mode to 'aggressive'. Maximum length is 100 characters. Only uppercase and lowercase letters, special characters ~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \\ , . / : ;, and digits are allowed.\n" }, "version": { "type": "string", "description": "Version of the IKE key exchange protocol. Valid values: ikev1, ikev2 (default).\n" } }, "type": "object", "required": [ "authAlg", "dhGroup", "encAlg", "lifetime", "localId", "mode", "psk", "remoteId", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnConnectionTunnelOptionIpsecConfig:getVpnConnectionTunnelOptionIpsecConfig": { "properties": { "authAlg": { "type": "string", "description": "Authentication algorithm for phase 2 negotiation\n" }, "dhGroup": { "type": "string", "description": "DH (Diffie-Hellman) key exchange algorithm used in phase 2\n" }, "encAlg": { "type": "string", "description": "Encryption algorithm for phase 2 negotiation\n" }, "lifetime": { "type": "integer", "description": "Lifetime of the SA for phase 2 negotiation. Negotiation will be re-initiated after the lifetime expires.\n" } }, "type": "object", "required": [ "authAlg", "dhGroup", "encAlg", "lifetime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnConnectionTunnelOptionTunnelBgpInfo:getVpnConnectionTunnelOptionTunnelBgpInfo": { "properties": { "enableBgp": { "type": "boolean", "description": "Enable dynamic route propagation. false (default): No, use static routing mode. true: Yes, use BGP routing mode.\n" }, "localAsn": { "type": "integer", "description": "The ASN of the VPN gateway.\n" }, "localBgpIp": { "type": "string", "description": "BGP address. Defaults to the first host address of TunnelOptions.N.BGPConfig.TunnelCidr. This address must be an IP address within the IPsec tunnel CIDR block. If EnableTunnelsBgp is set to true, this parameter must be specified.\n" }, "peerAsn": { "type": "integer", "description": "ASN of the customer gateway.\n" }, "peerBgpIp": { "type": "string", "description": "BGP peer IP, that is, the BGP address on the customer gateway side.\n" }, "sessionStatus": { "type": "string", "description": "Status of the BGP connection. Up: BGP connection is normal. Down: BGP connection is not working.\n" }, "tunnelCidr": { "type": "string", "description": "The CIDR address range for the local and peer IPs of the BGP session. This range must be within the 169.254.0.0/16 subnet with a subnet mask length of 30. If EnableTunnelsBgp is set to true, this parameter must be provided.\n" } }, "type": "object", "required": [ "enableBgp", "localAsn", "localBgpIp", "peerAsn", "peerBgpIp", "sessionStatus", "tunnelCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:vpn/getVpnGatewayTag:getVpnGatewayTag": { "properties": { "key": { "type": "string", "description": "VPN gateway tag key (Key). Parameter - N: Indicates the sequence number of the tag key, value range: 1–20. Multiple tag keys are separated by \u0026. Naming rules: Cannot start with any combination of volc: or sys: (case-insensitive). Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length limit: 1–128 characters. Note: Tag keys for the same resource must not be duplicated.\n" }, "value": { "type": "string", "description": "VPN gateway tag value (Value). Parameter - N: Indicates the sequence number of the tag value, value range: 1–20. Multiple tag values are separated by \u0026. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length limit: 0–256 characters. Case-sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:waf/DomainBackendGroup:DomainBackendGroup": { "properties": { "accessPorts": { "type": "array", "items": { "type": "integer" }, "description": "Access port number.\n" }, "backends": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/DomainBackendGroupBackend:DomainBackendGroupBackend" } }, "name": { "type": "string", "description": "Origin group name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessPorts", "backends", "name" ] } } }, "volcenginecc:waf/DomainBackendGroupBackend:DomainBackendGroupBackend": { "properties": { "ip": { "type": "string", "description": "Origin IP address\n" }, "port": { "type": "integer", "description": "Origin port\n" }, "protocol": { "type": "string", "description": "Origin protocol.\n" }, "weight": { "type": "integer", "description": "Origin weight\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ip", "port", "protocol", "weight" ] } } }, "volcenginecc:waf/DomainCloudAccessConfig:DomainCloudAccessConfig": { "properties": { "accessProtocol": { "type": "string", "description": "Access protocol type\n" }, "defenceMode": { "type": "integer", "description": "Protection mode\n" }, "instanceId": { "type": "string", "description": "Load balancing instance ID.\n" }, "instanceName": { "type": "string", "description": "Load balancer instance name.\n" }, "listenerId": { "type": "string", "description": "Load balancing listener ID.\n" }, "lostAssociationFromAlb": { "type": "integer", "description": "Disassociated from ALB\n" }, "port": { "type": "string", "description": "Listener forwarding rule port number\n" }, "protocol": { "type": "string", "description": "Protocol type for listener forwarding rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessProtocol", "defenceMode", "instanceId", "instanceName", "listenerId", "lostAssociationFromAlb", "port", "protocol" ] } } }, "volcenginecc:waf/DomainProtocolPorts:DomainProtocolPorts": { "properties": { "http": { "type": "array", "items": { "type": "integer" }, "description": "HTTP protocol port number\n" }, "https": { "type": "array", "items": { "type": "integer" }, "description": "HTTPS protocol port number\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "http", "https" ] } } }, "volcenginecc:waf/DomainTcpListenerConfig:DomainTcpListenerConfig": { "properties": { "accessProtocol": { "type": "string", "description": "Access protocol type\n" }, "defenceMode": { "type": "integer", "description": "Protection mode\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "lostAssociationFromAlb": { "type": "integer", "description": "Disassociated from ALB\n" }, "port": { "type": "string", "description": "Listener port number\n" }, "protocol": { "type": "string", "description": "Listener protocol type.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessProtocol", "defenceMode", "instanceId", "instanceName", "listenerId", "lostAssociationFromAlb", "port", "protocol" ] } } }, "volcenginecc:waf/DomainTlsFieldsConfig:DomainTlsFieldsConfig": { "properties": { "headersConfig": { "$ref": "#/types/volcenginecc:waf/DomainTlsFieldsConfigHeadersConfig:DomainTlsFieldsConfigHeadersConfig" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "headersConfig" ] } } }, "volcenginecc:waf/DomainTlsFieldsConfigHeadersConfig:DomainTlsFieldsConfigHeadersConfig": { "properties": { "enable": { "type": "integer", "description": "Record all header fields\n" }, "excludedKeyLists": { "type": "array", "items": { "type": "string" }, "description": "Exception header fields. Exclude the specified fields from the JSON to help save log storage space.\n" }, "statisticalKeyLists": { "type": "array", "items": { "type": "string" }, "description": "Statistics header fields. Use the specified fields for log analysis and alerts.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enable", "excludedKeyLists", "statisticalKeyLists" ] } } }, "volcenginecc:waf/getDomainBackendGroup:getDomainBackendGroup": { "properties": { "accessPorts": { "type": "array", "items": { "type": "integer" }, "description": "Access port number.\n" }, "backends": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/getDomainBackendGroupBackend:getDomainBackendGroupBackend" }, "description": "Origin group details.\n" }, "name": { "type": "string", "description": "Origin group name.\n" } }, "type": "object", "required": [ "accessPorts", "backends", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:waf/getDomainBackendGroupBackend:getDomainBackendGroupBackend": { "properties": { "ip": { "type": "string", "description": "Origin IP address\n" }, "port": { "type": "integer", "description": "Origin port\n" }, "protocol": { "type": "string", "description": "Origin protocol.\n" }, "weight": { "type": "integer", "description": "Origin weight\n" } }, "type": "object", "required": [ "ip", "port", "protocol", "weight" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:waf/getDomainCloudAccessConfig:getDomainCloudAccessConfig": { "properties": { "accessProtocol": { "type": "string", "description": "Access protocol type\n" }, "defenceMode": { "type": "integer", "description": "Protection mode\n" }, "instanceId": { "type": "string", "description": "Load balancing instance ID.\n" }, "instanceName": { "type": "string", "description": "Load balancer instance name.\n" }, "listenerId": { "type": "string", "description": "Load balancing listener ID.\n" }, "lostAssociationFromAlb": { "type": "integer", "description": "Disassociated from ALB\n" }, "port": { "type": "string", "description": "Listener forwarding rule port number\n" }, "protocol": { "type": "string", "description": "Protocol type for listener forwarding rules.\n" } }, "type": "object", "required": [ "accessProtocol", "defenceMode", "instanceId", "instanceName", "listenerId", "lostAssociationFromAlb", "port", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:waf/getDomainProtocolPorts:getDomainProtocolPorts": { "properties": { "http": { "type": "array", "items": { "type": "integer" }, "description": "HTTP protocol port number\n" }, "https": { "type": "array", "items": { "type": "integer" }, "description": "HTTPS protocol port number\n" } }, "type": "object", "required": [ "http", "https" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:waf/getDomainTcpListenerConfig:getDomainTcpListenerConfig": { "properties": { "accessProtocol": { "type": "string", "description": "Access protocol type\n" }, "defenceMode": { "type": "integer", "description": "Protection mode\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "lostAssociationFromAlb": { "type": "integer", "description": "Disassociated from ALB\n" }, "port": { "type": "string", "description": "Listener port number\n" }, "protocol": { "type": "string", "description": "Listener protocol type.\n" } }, "type": "object", "required": [ "accessProtocol", "defenceMode", "instanceId", "instanceName", "listenerId", "lostAssociationFromAlb", "port", "protocol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:waf/getDomainTlsFieldsConfig:getDomainTlsFieldsConfig": { "properties": { "headersConfig": { "$ref": "#/types/volcenginecc:waf/getDomainTlsFieldsConfigHeadersConfig:getDomainTlsFieldsConfigHeadersConfig" } }, "type": "object", "required": [ "headersConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "volcenginecc:waf/getDomainTlsFieldsConfigHeadersConfig:getDomainTlsFieldsConfigHeadersConfig": { "properties": { "enable": { "type": "integer", "description": "Record all header fields\n" }, "excludedKeyLists": { "type": "array", "items": { "type": "string" }, "description": "Exception header fields. Exclude the specified fields from the JSON to help save log storage space.\n" }, "statisticalKeyLists": { "type": "array", "items": { "type": "string" }, "description": "Statistics header fields. Use the specified fields for log analysis and alerts.\n" } }, "type": "object", "required": [ "enable", "excludedKeyLists", "statisticalKeyLists" ], "language": { "nodejs": { "requiredInputs": [] } } } }, "provider": { "description": "The provider type for the volcenginecc package. By default, resources use package-wide configuration\nsettings, however an explicit `Provider` instance may be created and passed during resource\nconstruction to achieve fine-grained programmatic control over provider settings. See the\n[documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.\n", "properties": { "accessKey": { "type": "string", "description": "The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the `VOLCENGINE_ACCESS_KEY`\nenvironment variable\n" }, "assumeRole": { "$ref": "#/types/volcenginecc:index/ProviderAssumeRole:ProviderAssumeRole", "description": "An `assume_role` block (documented below). Only one `assume_role` block may be in the configuration.\n" }, "customerHeaders": { "type": "string", "description": "CUSTOMER HEADERS for Volcengine Provider. The customer_headers field uses commas (,) to separate multiple headers, and\ncolons (:) to separate each header key from its corresponding value.\n" }, "disableSsl": { "type": "boolean", "description": "Disable SSL for Volcengine Provider\n" }, "endpoints": { "$ref": "#/types/volcenginecc:index/ProviderEndpoints:ProviderEndpoints", "description": "An `endpoints` block (documented below). Only one `endpoints` block may be in the configuration.\n" }, "filePath": { "type": "string", "description": "The file path for Volcengine Provider configuration. It can be sourced from the `VOLCENGINE_FILE_PATH` environment\nvariable\n" }, "profile": { "type": "string", "description": "The profile for Volcengine Provider. It can be sourced from the `VOLCENGINE_PROFILE` environment variable\n" }, "proxyUrl": { "type": "string", "description": "PROXY URL for Volcengine Provider\n" }, "region": { "type": "string", "description": "The Region for Volcengine Provider. It must be provided, but it can also be sourced from the `VOLCENGINE_REGION`\nenvironment variable\n" }, "secretKey": { "type": "string", "description": "he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the `VOLCENGINE_SECRET_KEY`\nenvironment variable\n" } }, "inputProperties": { "accessKey": { "type": "string", "description": "The Access Key for Volcengine Provider. It must be provided, but it can also be sourced from the `VOLCENGINE_ACCESS_KEY`\nenvironment variable\n", "defaultInfo": { "environment": [ "VOLCENGINE_ACCESS_KEY" ] } }, "assumeRole": { "$ref": "#/types/volcenginecc:index/ProviderAssumeRole:ProviderAssumeRole", "description": "An `assume_role` block (documented below). Only one `assume_role` block may be in the configuration.\n" }, "customerHeaders": { "type": "string", "description": "CUSTOMER HEADERS for Volcengine Provider. The customer_headers field uses commas (,) to separate multiple headers, and\ncolons (:) to separate each header key from its corresponding value.\n", "defaultInfo": { "environment": [ "VOLCENGINE_CUSTOMER_HEADERS" ] } }, "disableSsl": { "type": "boolean", "description": "Disable SSL for Volcengine Provider\n", "defaultInfo": { "environment": [ "VOLCENGINE_DISABLE_SSL" ] } }, "endpoints": { "$ref": "#/types/volcenginecc:index/ProviderEndpoints:ProviderEndpoints", "description": "An `endpoints` block (documented below). Only one `endpoints` block may be in the configuration.\n" }, "filePath": { "type": "string", "description": "The file path for Volcengine Provider configuration. It can be sourced from the `VOLCENGINE_FILE_PATH` environment\nvariable\n", "defaultInfo": { "environment": [ "VOLCENGINE_FILE_PATH" ] } }, "profile": { "type": "string", "description": "The profile for Volcengine Provider. It can be sourced from the `VOLCENGINE_PROFILE` environment variable\n", "defaultInfo": { "environment": [ "VOLCENGINE_PROFILE" ] } }, "proxyUrl": { "type": "string", "description": "PROXY URL for Volcengine Provider\n", "defaultInfo": { "environment": [ "VOLCENGINE_PROXY_URL" ] } }, "region": { "type": "string", "description": "The Region for Volcengine Provider. It must be provided, but it can also be sourced from the `VOLCENGINE_REGION`\nenvironment variable\n", "defaultInfo": { "environment": [ "VOLCENGINE_REGION" ] } }, "secretKey": { "type": "string", "description": "he Secret Key for Volcengine Provider. It must be provided, but it can also be sourced from the `VOLCENGINE_SECRET_KEY`\nenvironment variable\n", "defaultInfo": { "environment": [ "VOLCENGINE_SECRET_KEY" ] } } }, "methods": { "terraformConfig": "pulumi:providers:volcenginecc/terraformConfig" } }, "resources": { "volcenginecc:alb/acl:Acl": { "description": "ALB provides access control at the listener level. If you want to allow only certain IPs or deny only certain IPs from accessing the ALB instance via the listener port, you can set an access control policy for the listener. You can configure access control when creating the listener or modify/reconfigure it after the listener is created.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst albAclDemo = new volcenginecc.alb.Acl(\"AlbAclDemo\", {\n aclName: \"AlbAclDemo\",\n projectName: \"default\",\n aclEntries: [{\n description: \"AlbAclDemo description\",\n entry: \"1.1.1.1/32\",\n }],\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nalb_acl_demo = volcenginecc.alb.Acl(\"AlbAclDemo\",\n acl_name=\"AlbAclDemo\",\n project_name=\"default\",\n acl_entries=[{\n \"description\": \"AlbAclDemo description\",\n \"entry\": \"1.1.1.1/32\",\n }],\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var albAclDemo = new Volcenginecc.Alb.Acl(\"AlbAclDemo\", new()\n {\n AclName = \"AlbAclDemo\",\n ProjectName = \"default\",\n AclEntries = new[]\n {\n new Volcenginecc.Alb.Inputs.AclAclEntryArgs\n {\n Description = \"AlbAclDemo description\",\n Entry = \"1.1.1.1/32\",\n },\n },\n Tags = new[]\n {\n new Volcenginecc.Alb.Inputs.AclTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/alb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := alb.NewAcl(ctx, \"AlbAclDemo\", \u0026alb.AclArgs{\n\t\t\tAclName: pulumi.String(\"AlbAclDemo\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tAclEntries: alb.AclAclEntryArray{\n\t\t\t\t\u0026alb.AclAclEntryArgs{\n\t\t\t\t\tDescription: pulumi.String(\"AlbAclDemo description\"),\n\t\t\t\t\tEntry: pulumi.String(\"1.1.1.1/32\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTags: alb.AclTagArray{\n\t\t\t\t\u0026alb.AclTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.alb.Acl;\nimport com.volcengine.volcenginecc.alb.AclArgs;\nimport com.pulumi.volcenginecc.alb.inputs.AclAclEntryArgs;\nimport com.pulumi.volcenginecc.alb.inputs.AclTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var albAclDemo = new Acl(\"albAclDemo\", AclArgs.builder()\n .aclName(\"AlbAclDemo\")\n .projectName(\"default\")\n .aclEntries(AclAclEntryArgs.builder()\n .description(\"AlbAclDemo description\")\n .entry(\"1.1.1.1/32\")\n .build())\n .tags(AclTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n albAclDemo:\n type: volcenginecc:alb:Acl\n name: AlbAclDemo\n properties:\n aclName: AlbAclDemo\n projectName: default\n aclEntries:\n - description: AlbAclDemo description\n entry: 1.1.1.1/32\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:alb/acl:Acl example \"acl_id\"\n```\n\n", "properties": { "aclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/AclAclEntry:AclAclEntry" } }, "aclEntryCount": { "type": "integer", "description": "Number of IP entries in the access control policy group.\n" }, "aclId": { "type": "string", "description": "Access control policy group ID.\n" }, "aclName": { "type": "string", "description": "Name of the access control policy group. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If not specified, defaults to the access control policy group ID.\n" }, "createdTime": { "type": "string", "description": "Creation time of the access control policy group.\n" }, "description": { "type": "string", "description": "Description of the access control policy group. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/AclListener:AclListener" } }, "projectName": { "type": "string", "description": "Name of the project to which the access control policy group belongs.\n" }, "status": { "type": "string", "description": "Status of the access control policy group. Creating: being created. Active: available. Configuring: being configured. Deleting: being deleted.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/AclTag:AclTag" } }, "updatedTime": { "type": "string", "description": "Most recent operation time for the access control policy group.\n" } }, "required": [ "aclEntries", "aclEntryCount", "aclId", "aclName", "createdTime", "description", "listeners", "projectName", "status", "tags", "updatedTime" ], "inputProperties": { "aclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/AclAclEntry:AclAclEntry" } }, "aclName": { "type": "string", "description": "Name of the access control policy group. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If not specified, defaults to the access control policy group ID.\n" }, "description": { "type": "string", "description": "Description of the access control policy group. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the access control policy group belongs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/AclTag:AclTag" } } }, "stateInputs": { "description": "Input properties used for looking up and filtering Acl resources.\n", "properties": { "aclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/AclAclEntry:AclAclEntry" } }, "aclEntryCount": { "type": "integer", "description": "Number of IP entries in the access control policy group.\n" }, "aclId": { "type": "string", "description": "Access control policy group ID.\n" }, "aclName": { "type": "string", "description": "Name of the access control policy group. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If not specified, defaults to the access control policy group ID.\n" }, "createdTime": { "type": "string", "description": "Creation time of the access control policy group.\n" }, "description": { "type": "string", "description": "Description of the access control policy group. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/AclListener:AclListener" } }, "projectName": { "type": "string", "description": "Name of the project to which the access control policy group belongs.\n" }, "status": { "type": "string", "description": "Status of the access control policy group. Creating: being created. Active: available. Configuring: being configured. Deleting: being deleted.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/AclTag:AclTag" } }, "updatedTime": { "type": "string", "description": "Most recent operation time for the access control policy group.\n" } }, "type": "object" } }, "volcenginecc:alb/certificate:Certificate": { "description": "ALB supports uploading server certificates and CA certificates to the console and manages uploaded certificates separately\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst aLBCertificateDemo = new volcenginecc.alb.Certificate(\"ALBCertificateDemo\", {\n certificateName: \"ALBCertificateDemo\",\n certificateType: \"CA\",\n publicKey: \"-----BEGIN CERTIFICATE-----xxxx-----END CERTIFICATE-----\",\n description: \"ALBCertificateDemo description\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\na_lb_certificate_demo = volcenginecc.alb.Certificate(\"ALBCertificateDemo\",\n certificate_name=\"ALBCertificateDemo\",\n certificate_type=\"CA\",\n public_key=\"-----BEGIN CERTIFICATE-----xxxx-----END CERTIFICATE-----\",\n description=\"ALBCertificateDemo description\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var aLBCertificateDemo = new Volcenginecc.Alb.Certificate(\"ALBCertificateDemo\", new()\n {\n CertificateName = \"ALBCertificateDemo\",\n CertificateType = \"CA\",\n PublicKey = \"-----BEGIN CERTIFICATE-----xxxx-----END CERTIFICATE-----\",\n Description = \"ALBCertificateDemo description\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Alb.Inputs.CertificateTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/alb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := alb.NewCertificate(ctx, \"ALBCertificateDemo\", \u0026alb.CertificateArgs{\n\t\t\tCertificateName: pulumi.String(\"ALBCertificateDemo\"),\n\t\t\tCertificateType: pulumi.String(\"CA\"),\n\t\t\tPublicKey: pulumi.String(\"-----BEGIN CERTIFICATE-----xxxx-----END CERTIFICATE-----\"),\n\t\t\tDescription: pulumi.String(\"ALBCertificateDemo description\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: alb.CertificateTagArray{\n\t\t\t\t\u0026alb.CertificateTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.alb.Certificate;\nimport com.volcengine.volcenginecc.alb.CertificateArgs;\nimport com.pulumi.volcenginecc.alb.inputs.CertificateTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var aLBCertificateDemo = new Certificate(\"aLBCertificateDemo\", CertificateArgs.builder()\n .certificateName(\"ALBCertificateDemo\")\n .certificateType(\"CA\")\n .publicKey(\"-----BEGIN CERTIFICATE-----xxxx-----END CERTIFICATE-----\")\n .description(\"ALBCertificateDemo description\")\n .projectName(\"default\")\n .tags(CertificateTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n aLBCertificateDemo:\n type: volcenginecc:alb:Certificate\n name: ALBCertificateDemo\n properties:\n certificateName: ALBCertificateDemo\n certificateType: CA\n publicKey: '-----BEGIN CERTIFICATE-----xxxx-----END CERTIFICATE-----'\n description: ALBCertificateDemo description\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:alb/certificate:Certificate example \"certificate_id|certificate_type\"\n```\n\n", "properties": { "certificateId": { "type": "string", "description": "Certificate ID\n" }, "certificateName": { "type": "string", "description": "Certificate name. Length must be between 1 and 128 characters, start with a letter or Chinese character, and may include numbers, periods (.), underscores (_), and hyphens (-)\n" }, "certificateType": { "type": "string", "description": "Certificate type. Options: CA: CA certificate; Server: server certificate\n" }, "createdTime": { "type": "string", "description": "Certificate creation time\n" }, "description": { "type": "string", "description": "Certificate description\n" }, "domainName": { "type": "string", "description": "Certificate domain name\n" }, "expiredAt": { "type": "string", "description": "Certificate expiration time\n" }, "listeners": { "type": "array", "items": { "type": "string" }, "description": "List of listeners associated with the certificate\n" }, "privateKey": { "type": "string", "description": "Server certificate private key. Required when certificate type is Server\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "publicKey": { "type": "string", "description": "Server certificate public key\n" }, "san": { "type": "string", "description": "Certificate subject alternative name list. Use English ',' to separate multiple domain names. Includes (commonName, DnsName, IP)\n" }, "status": { "type": "string", "description": "Certificate status. Options: Creating: creating; Active: active; Deleting: deleting\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/CertificateTag:CertificateTag" } } }, "required": [ "certificateId", "certificateName", "certificateType", "createdTime", "description", "domainName", "expiredAt", "listeners", "privateKey", "projectName", "publicKey", "san", "status", "tags" ], "inputProperties": { "certificateName": { "type": "string", "description": "Certificate name. Length must be between 1 and 128 characters, start with a letter or Chinese character, and may include numbers, periods (.), underscores (_), and hyphens (-)\n" }, "certificateType": { "type": "string", "description": "Certificate type. Options: CA: CA certificate; Server: server certificate\n" }, "description": { "type": "string", "description": "Certificate description\n" }, "privateKey": { "type": "string", "description": "Server certificate private key. Required when certificate type is Server\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "publicKey": { "type": "string", "description": "Server certificate public key\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/CertificateTag:CertificateTag" } } }, "requiredInputs": [ "certificateType", "publicKey" ], "stateInputs": { "description": "Input properties used for looking up and filtering Certificate resources.\n", "properties": { "certificateId": { "type": "string", "description": "Certificate ID\n" }, "certificateName": { "type": "string", "description": "Certificate name. Length must be between 1 and 128 characters, start with a letter or Chinese character, and may include numbers, periods (.), underscores (_), and hyphens (-)\n" }, "certificateType": { "type": "string", "description": "Certificate type. Options: CA: CA certificate; Server: server certificate\n" }, "createdTime": { "type": "string", "description": "Certificate creation time\n" }, "description": { "type": "string", "description": "Certificate description\n" }, "domainName": { "type": "string", "description": "Certificate domain name\n" }, "expiredAt": { "type": "string", "description": "Certificate expiration time\n" }, "listeners": { "type": "array", "items": { "type": "string" }, "description": "List of listeners associated with the certificate\n" }, "privateKey": { "type": "string", "description": "Server certificate private key. Required when certificate type is Server\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "publicKey": { "type": "string", "description": "Server certificate public key\n" }, "san": { "type": "string", "description": "Certificate subject alternative name list. Use English ',' to separate multiple domain names. Includes (commonName, DnsName, IP)\n" }, "status": { "type": "string", "description": "Certificate status. Options: Creating: creating; Active: active; Deleting: deleting\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/CertificateTag:CertificateTag" } } }, "type": "object" } }, "volcenginecc:alb/customizedCfg:CustomizedCfg": { "description": "ALB provides personalized configuration functionality at the listener level. You can create and manage standard NGINX configuration policies in the console, associate configuration policies with listeners in one click on the listener details page, and complete personalized configurations to meet business requirements without submitting a ticket.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst aLBCustomizedCfgDemo = new volcenginecc.alb.CustomizedCfg(\"ALBCustomizedCfgDemo\", {\n customizedCfgName: \"ccapi-test\",\n description: \"testdesc\",\n customizedCfgContent: `ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256;\\x0d\nssl_protocols TLSv1.2 TLSv1.1 TLSv1;\\x0d\nclient_max_body_size 60M;\\x0d\nkeepalive_timeout 77s;\\x0d\nproxy_connect_timeout 4s;\\x0d\nproxy_request_buffering off;\\x0d\nproxy_ignore_client_abort off;\\x0d\nproxy_read_timeout 60s;\\x0d\nproxy_send_timeout 60s;\\x0d\nclient_header_timeout 60s;\\x0d\nclient_body_timeout 60s;\\x0d\nsend_timeout 60s;\\x0d\nssl_verify_depth 3;\\x0d\n`,\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\na_lb_customized_cfg_demo = volcenginecc.alb.CustomizedCfg(\"ALBCustomizedCfgDemo\",\n customized_cfg_name=\"ccapi-test\",\n description=\"testdesc\",\n customized_cfg_content=\"\"\"ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256;\\x0d\nssl_protocols TLSv1.2 TLSv1.1 TLSv1;\\x0d\nclient_max_body_size 60M;\\x0d\nkeepalive_timeout 77s;\\x0d\nproxy_connect_timeout 4s;\\x0d\nproxy_request_buffering off;\\x0d\nproxy_ignore_client_abort off;\\x0d\nproxy_read_timeout 60s;\\x0d\nproxy_send_timeout 60s;\\x0d\nclient_header_timeout 60s;\\x0d\nclient_body_timeout 60s;\\x0d\nsend_timeout 60s;\\x0d\nssl_verify_depth 3;\\x0d\n\"\"\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var aLBCustomizedCfgDemo = new Volcenginecc.Alb.CustomizedCfg(\"ALBCustomizedCfgDemo\", new()\n {\n CustomizedCfgName = \"ccapi-test\",\n Description = \"testdesc\",\n CustomizedCfgContent = @\"ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256;\r\nssl_protocols TLSv1.2 TLSv1.1 TLSv1;\r\nclient_max_body_size 60M;\r\nkeepalive_timeout 77s;\r\nproxy_connect_timeout 4s;\r\nproxy_request_buffering off;\r\nproxy_ignore_client_abort off;\r\nproxy_read_timeout 60s;\r\nproxy_send_timeout 60s;\r\nclient_header_timeout 60s;\r\nclient_body_timeout 60s;\r\nsend_timeout 60s;\r\nssl_verify_depth 3;\r\n\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Alb.Inputs.CustomizedCfgTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/alb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := alb.NewCustomizedCfg(ctx, \"ALBCustomizedCfgDemo\", \u0026alb.CustomizedCfgArgs{\n\t\t\tCustomizedCfgName: pulumi.String(\"ccapi-test\"),\n\t\t\tDescription: pulumi.String(\"testdesc\"),\n\t\t\tCustomizedCfgContent: pulumi.String(`ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256;\nssl_protocols TLSv1.2 TLSv1.1 TLSv1;\nclient_max_body_size 60M;\nkeepalive_timeout 77s;\nproxy_connect_timeout 4s;\nproxy_request_buffering off;\nproxy_ignore_client_abort off;\nproxy_read_timeout 60s;\nproxy_send_timeout 60s;\nclient_header_timeout 60s;\nclient_body_timeout 60s;\nsend_timeout 60s;\nssl_verify_depth 3;\n`),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: alb.CustomizedCfgTagArray{\n\t\t\t\t\u0026alb.CustomizedCfgTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.alb.CustomizedCfg;\nimport com.volcengine.volcenginecc.alb.CustomizedCfgArgs;\nimport com.pulumi.volcenginecc.alb.inputs.CustomizedCfgTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var aLBCustomizedCfgDemo = new CustomizedCfg(\"aLBCustomizedCfgDemo\", CustomizedCfgArgs.builder()\n .customizedCfgName(\"ccapi-test\")\n .description(\"testdesc\")\n .customizedCfgContent(\"\"\"\nssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256;\r\nssl_protocols TLSv1.2 TLSv1.1 TLSv1;\r\nclient_max_body_size 60M;\r\nkeepalive_timeout 77s;\r\nproxy_connect_timeout 4s;\r\nproxy_request_buffering off;\r\nproxy_ignore_client_abort off;\r\nproxy_read_timeout 60s;\r\nproxy_send_timeout 60s;\r\nclient_header_timeout 60s;\r\nclient_body_timeout 60s;\r\nsend_timeout 60s;\r\nssl_verify_depth 3;\r\n \"\"\")\n .projectName(\"default\")\n .tags(CustomizedCfgTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n aLBCustomizedCfgDemo:\n type: volcenginecc:alb:CustomizedCfg\n name: ALBCustomizedCfgDemo\n properties:\n customizedCfgName: ccapi-test\n description: testdesc\n customizedCfgContent: \"ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256;\\r\\nssl_protocols TLSv1.2 TLSv1.1 TLSv1;\\r\\nclient_max_body_size 60M;\\r\\nkeepalive_timeout 77s;\\r\\nproxy_connect_timeout 4s;\\r\\nproxy_request_buffering off;\\r\\nproxy_ignore_client_abort off;\\r\\nproxy_read_timeout 60s;\\r\\nproxy_send_timeout 60s;\\r\\nclient_header_timeout 60s;\\r\\nclient_body_timeout 60s;\\r\\nsend_timeout 60s;\\r\\nssl_verify_depth 3;\\r\\n\"\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:alb/customizedCfg:CustomizedCfg example \"customized_cfg_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the personalized configuration.\n" }, "customizedCfgContent": { "type": "string", "description": "Content of the personalized configuration item. Specific rules: Length must not exceed 4096 characters. Spaces and semicolons must be escaped. Different configuration items are separated by ';\n'. Configuration items cannot be duplicated. Currently supported configuration items include ssl*protocols, ssl*ciphers, client*max*body*size, keepalive*timeout, proxy*request*buffering, proxy*connect*timeout, add*header, client*header*timeout, proxy*read*timeout, proxy*send*timeout, client*body*timeout, send*timeout, and ssl*verify*depth. For details, see the official documentation.\n" }, "customizedCfgId": { "type": "string", "description": "Personalized configuration ID.\n" }, "customizedCfgName": { "type": "string", "description": "Name of the personalized configuration. Specific rules: Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n" }, "description": { "type": "string", "description": "Description of the personalized configuration. Specific rules: Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/CustomizedCfgListener:CustomizedCfgListener" } }, "projectName": { "type": "string", "description": "Project name to which the personalized configuration belongs.\n" }, "status": { "type": "string", "description": "Status of the personalized configuration. Includes Active, Configuring, Creating, or Deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/CustomizedCfgTag:CustomizedCfgTag" } }, "updatedTime": { "type": "string", "description": "Last operation time of the personalized configuration.\n" } }, "required": [ "createdTime", "customizedCfgContent", "customizedCfgId", "customizedCfgName", "description", "listeners", "projectName", "status", "tags", "updatedTime" ], "inputProperties": { "customizedCfgContent": { "type": "string", "description": "Content of the personalized configuration item. Specific rules: Length must not exceed 4096 characters. Spaces and semicolons must be escaped. Different configuration items are separated by ';\n'. Configuration items cannot be duplicated. Currently supported configuration items include ssl*protocols, ssl*ciphers, client*max*body*size, keepalive*timeout, proxy*request*buffering, proxy*connect*timeout, add*header, client*header*timeout, proxy*read*timeout, proxy*send*timeout, client*body*timeout, send*timeout, and ssl*verify*depth. For details, see the official documentation.\n" }, "customizedCfgName": { "type": "string", "description": "Name of the personalized configuration. Specific rules: Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n" }, "description": { "type": "string", "description": "Description of the personalized configuration. Specific rules: Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n" }, "projectName": { "type": "string", "description": "Project name to which the personalized configuration belongs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/CustomizedCfgTag:CustomizedCfgTag" } } }, "requiredInputs": [ "customizedCfgContent", "customizedCfgName" ], "stateInputs": { "description": "Input properties used for looking up and filtering CustomizedCfg resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the personalized configuration.\n" }, "customizedCfgContent": { "type": "string", "description": "Content of the personalized configuration item. Specific rules: Length must not exceed 4096 characters. Spaces and semicolons must be escaped. Different configuration items are separated by ';\n'. Configuration items cannot be duplicated. Currently supported configuration items include ssl*protocols, ssl*ciphers, client*max*body*size, keepalive*timeout, proxy*request*buffering, proxy*connect*timeout, add*header, client*header*timeout, proxy*read*timeout, proxy*send*timeout, client*body*timeout, send*timeout, and ssl*verify*depth. For details, see the official documentation.\n" }, "customizedCfgId": { "type": "string", "description": "Personalized configuration ID.\n" }, "customizedCfgName": { "type": "string", "description": "Name of the personalized configuration. Specific rules: Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n" }, "description": { "type": "string", "description": "Description of the personalized configuration. Specific rules: Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/CustomizedCfgListener:CustomizedCfgListener" } }, "projectName": { "type": "string", "description": "Project name to which the personalized configuration belongs.\n" }, "status": { "type": "string", "description": "Status of the personalized configuration. Includes Active, Configuring, Creating, or Deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/CustomizedCfgTag:CustomizedCfgTag" } }, "updatedTime": { "type": "string", "description": "Last operation time of the personalized configuration.\n" } }, "type": "object" } }, "volcenginecc:alb/healthCheckTemplate:HealthCheckTemplate": { "description": "Health checks are essential for ensuring application availability. ALB regularly performs health checks on backend servers to verify whether they can accept new requests. If a backend server fails to respond properly to ALB's health check requests, client traffic will not be routed to that server. ALB forwards traffic to other servers with a healthy status, ensuring service continuity and reliability. ALB health checks are performed based on server groups. Once health checks are enabled for a server group, ALB periodically checks the status of backend servers within the group.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst aLBHealthCheckTemplateDemo = new volcenginecc.alb.HealthCheckTemplate(\"ALBHealthCheckTemplateDemo\", {\n description: \"asdfgh\",\n healthCheckDomain: \"test.com\",\n healthCheckHttpCode: \"http_2xx,http_3xx\",\n healthCheckHttpVersion: \"HTTP1.0\",\n healthCheckInterval: 2,\n healthCheckMethod: \"HEAD\",\n healthCheckPort: 0,\n healthCheckProtocol: \"HTTP\",\n healthCheckTemplateName: \"test-test-1001\",\n healthCheckTimeout: 2,\n healthCheckUri: \"/\",\n healthyThreshold: 3,\n unhealthyThreshold: 3,\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\na_lb_health_check_template_demo = volcenginecc.alb.HealthCheckTemplate(\"ALBHealthCheckTemplateDemo\",\n description=\"asdfgh\",\n health_check_domain=\"test.com\",\n health_check_http_code=\"http_2xx,http_3xx\",\n health_check_http_version=\"HTTP1.0\",\n health_check_interval=2,\n health_check_method=\"HEAD\",\n health_check_port=0,\n health_check_protocol=\"HTTP\",\n health_check_template_name=\"test-test-1001\",\n health_check_timeout=2,\n health_check_uri=\"/\",\n healthy_threshold=3,\n unhealthy_threshold=3,\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var aLBHealthCheckTemplateDemo = new Volcenginecc.Alb.HealthCheckTemplate(\"ALBHealthCheckTemplateDemo\", new()\n {\n Description = \"asdfgh\",\n HealthCheckDomain = \"test.com\",\n HealthCheckHttpCode = \"http_2xx,http_3xx\",\n HealthCheckHttpVersion = \"HTTP1.0\",\n HealthCheckInterval = 2,\n HealthCheckMethod = \"HEAD\",\n HealthCheckPort = 0,\n HealthCheckProtocol = \"HTTP\",\n HealthCheckTemplateName = \"test-test-1001\",\n HealthCheckTimeout = 2,\n HealthCheckUri = \"/\",\n HealthyThreshold = 3,\n UnhealthyThreshold = 3,\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Alb.Inputs.HealthCheckTemplateTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/alb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := alb.NewHealthCheckTemplate(ctx, \"ALBHealthCheckTemplateDemo\", \u0026alb.HealthCheckTemplateArgs{\n\t\t\tDescription: pulumi.String(\"asdfgh\"),\n\t\t\tHealthCheckDomain: pulumi.String(\"test.com\"),\n\t\t\tHealthCheckHttpCode: pulumi.String(\"http_2xx,http_3xx\"),\n\t\t\tHealthCheckHttpVersion: pulumi.String(\"HTTP1.0\"),\n\t\t\tHealthCheckInterval: pulumi.Int(2),\n\t\t\tHealthCheckMethod: pulumi.String(\"HEAD\"),\n\t\t\tHealthCheckPort: pulumi.Int(0),\n\t\t\tHealthCheckProtocol: pulumi.String(\"HTTP\"),\n\t\t\tHealthCheckTemplateName: pulumi.String(\"test-test-1001\"),\n\t\t\tHealthCheckTimeout: pulumi.Int(2),\n\t\t\tHealthCheckUri: pulumi.String(\"/\"),\n\t\t\tHealthyThreshold: pulumi.Int(3),\n\t\t\tUnhealthyThreshold: pulumi.Int(3),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: alb.HealthCheckTemplateTagArray{\n\t\t\t\t\u0026alb.HealthCheckTemplateTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.alb.HealthCheckTemplate;\nimport com.volcengine.volcenginecc.alb.HealthCheckTemplateArgs;\nimport com.pulumi.volcenginecc.alb.inputs.HealthCheckTemplateTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var aLBHealthCheckTemplateDemo = new HealthCheckTemplate(\"aLBHealthCheckTemplateDemo\", HealthCheckTemplateArgs.builder()\n .description(\"asdfgh\")\n .healthCheckDomain(\"test.com\")\n .healthCheckHttpCode(\"http_2xx,http_3xx\")\n .healthCheckHttpVersion(\"HTTP1.0\")\n .healthCheckInterval(2)\n .healthCheckMethod(\"HEAD\")\n .healthCheckPort(0)\n .healthCheckProtocol(\"HTTP\")\n .healthCheckTemplateName(\"test-test-1001\")\n .healthCheckTimeout(2)\n .healthCheckUri(\"/\")\n .healthyThreshold(3)\n .unhealthyThreshold(3)\n .projectName(\"default\")\n .tags(HealthCheckTemplateTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n aLBHealthCheckTemplateDemo:\n type: volcenginecc:alb:HealthCheckTemplate\n name: ALBHealthCheckTemplateDemo\n properties:\n description: asdfgh\n healthCheckDomain: test.com\n healthCheckHttpCode: http_2xx,http_3xx\n healthCheckHttpVersion: HTTP1.0\n healthCheckInterval: 2\n healthCheckMethod: HEAD\n healthCheckPort: 0\n healthCheckProtocol: HTTP\n healthCheckTemplateName: test-test-1001\n healthCheckTimeout: 2\n healthCheckUri: /\n healthyThreshold: 3\n unhealthyThreshold: 3\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:alb/healthCheckTemplate:HealthCheckTemplate example \"health_check_template_id\"\n```\n\n", "properties": { "createTime": { "type": "string", "description": "Creation time of the health check template.\n" }, "description": { "type": "string", "description": "Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.\n" }, "healthCheckDomain": { "type": "string", "description": "Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.\n" }, "healthCheckHttpCode": { "type": "string", "description": "HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http*2xx (default), http*3xx (default), http*4xx, http*5xx.\n" }, "healthCheckHttpVersion": { "type": "string", "description": "HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.\n" }, "healthCheckInterval": { "type": "integer", "description": "Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.\n" }, "healthCheckMethod": { "type": "string", "description": "Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)\n" }, "healthCheckPort": { "type": "integer", "description": "Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.\n" }, "healthCheckProtocol": { "type": "string", "description": "Protocol for the health check. HTTP or TCP.\n" }, "healthCheckTemplateId": { "type": "string", "description": "Health check template ID.\n" }, "healthCheckTemplateName": { "type": "string", "description": "Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n" }, "healthCheckTimeout": { "type": "integer", "description": "Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.\n" }, "healthCheckUri": { "type": "string", "description": "Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '\u0026', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.\n" }, "healthyThreshold": { "type": "integer", "description": "Health threshold for the health check. Default is 3. Range: 2–10 times.\n" }, "projectName": { "type": "string", "description": "Project name to which the health check template belongs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/HealthCheckTemplateTag:HealthCheckTemplateTag" } }, "unhealthyThreshold": { "type": "integer", "description": "Unhealthy threshold for health checks. Default is 3; range is 2–10 times.\n" }, "updateTime": { "type": "string", "description": "Last operation time of the health check template.\n" } }, "required": [ "createTime", "description", "healthCheckDomain", "healthCheckHttpCode", "healthCheckHttpVersion", "healthCheckInterval", "healthCheckMethod", "healthCheckPort", "healthCheckProtocol", "healthCheckTemplateId", "healthCheckTemplateName", "healthCheckTimeout", "healthCheckUri", "healthyThreshold", "projectName", "tags", "unhealthyThreshold", "updateTime" ], "inputProperties": { "description": { "type": "string", "description": "Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.\n" }, "healthCheckDomain": { "type": "string", "description": "Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.\n" }, "healthCheckHttpCode": { "type": "string", "description": "HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http*2xx (default), http*3xx (default), http*4xx, http*5xx.\n" }, "healthCheckHttpVersion": { "type": "string", "description": "HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.\n" }, "healthCheckInterval": { "type": "integer", "description": "Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.\n" }, "healthCheckMethod": { "type": "string", "description": "Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)\n" }, "healthCheckPort": { "type": "integer", "description": "Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.\n" }, "healthCheckProtocol": { "type": "string", "description": "Protocol for the health check. HTTP or TCP.\n" }, "healthCheckTemplateName": { "type": "string", "description": "Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n" }, "healthCheckTimeout": { "type": "integer", "description": "Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.\n" }, "healthCheckUri": { "type": "string", "description": "Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '\u0026', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.\n" }, "healthyThreshold": { "type": "integer", "description": "Health threshold for the health check. Default is 3. Range: 2–10 times.\n" }, "projectName": { "type": "string", "description": "Project name to which the health check template belongs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/HealthCheckTemplateTag:HealthCheckTemplateTag" } }, "unhealthyThreshold": { "type": "integer", "description": "Unhealthy threshold for health checks. Default is 3; range is 2–10 times.\n" } }, "requiredInputs": [ "healthCheckTemplateName" ], "stateInputs": { "description": "Input properties used for looking up and filtering HealthCheckTemplate resources.\n", "properties": { "createTime": { "type": "string", "description": "Creation time of the health check template.\n" }, "description": { "type": "string", "description": "Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.\n" }, "healthCheckDomain": { "type": "string", "description": "Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.\n" }, "healthCheckHttpCode": { "type": "string", "description": "HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http*2xx (default), http*3xx (default), http*4xx, http*5xx.\n" }, "healthCheckHttpVersion": { "type": "string", "description": "HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.\n" }, "healthCheckInterval": { "type": "integer", "description": "Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.\n" }, "healthCheckMethod": { "type": "string", "description": "Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)\n" }, "healthCheckPort": { "type": "integer", "description": "Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.\n" }, "healthCheckProtocol": { "type": "string", "description": "Protocol for the health check. HTTP or TCP.\n" }, "healthCheckTemplateId": { "type": "string", "description": "Health check template ID.\n" }, "healthCheckTemplateName": { "type": "string", "description": "Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n" }, "healthCheckTimeout": { "type": "integer", "description": "Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.\n" }, "healthCheckUri": { "type": "string", "description": "Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '\u0026', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.\n" }, "healthyThreshold": { "type": "integer", "description": "Health threshold for the health check. Default is 3. Range: 2–10 times.\n" }, "projectName": { "type": "string", "description": "Project name to which the health check template belongs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/HealthCheckTemplateTag:HealthCheckTemplateTag" } }, "unhealthyThreshold": { "type": "integer", "description": "Unhealthy threshold for health checks. Default is 3; range is 2–10 times.\n" }, "updateTime": { "type": "string", "description": "Last operation time of the health check template.\n" } }, "type": "object" } }, "volcenginecc:alb/listener:Listener": { "description": "Each ALB instance requires at least one listener to function properly. The listener receives client requests and distributes them to backend servers based on your configured forwarding rules and load balancing algorithm. You can create multiple listeners under a single ALB instance and configure different listening protocols for each listener to handle client requests using different protocols.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n aLBListenerDemo:\n type: volcenginecc:alb:Listener\n name: ALBListenerDemo\n properties:\n loadBalancerId: alb-bdazuxj87hts8dv40noxxxxx\n listenerName: ALBListenerDemo\n protocol: HTTPS\n port: 80\n enabled: on\n serverGroupId: rsp-1pff7rhpf5e68845wfah2xxxx\n aclStatus: on\n aclType: black\n aclIds:\n - acl-xp8avgtjnmrk54ov5fyoxxxx\n customizedCfgId: ccfg-xoblsk63beo054ov5el5xxxx\n description: ALBListenerDemo description\n tags:\n - key: env\n value: test\n certificateSource: cert_center\n certCenterCertificateId: cert-a126f867a19141618ff316a52a50xxxx\n caCertificateSource: pca_root\n pcaRootCaCertificateId: pca_root_xxxxxx\n enableHttp2: on\n enableQuic: off\n domainExtensions:\n - cert_center_certificate_id: cert-7718b7e7afa94e4db38ec9092cxxxxxx\n certificate_source: cert_center\n domain: \"\"\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:alb/listener:Listener example \"listener_id\"\n```\n\n", "properties": { "accessLogRecordCustomizedHeadersEnabled": { "type": "string", "description": "Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.\n" }, "aclIds": { "type": "array", "items": { "type": "string" }, "description": "Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.\n" }, "aclStatus": { "type": "string", "description": "Whether access control is enabled. Values: on: enabled. off: not enabled (default).\n" }, "aclType": { "type": "string", "description": "Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.\n" }, "caCertificateId": { "type": "string", "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When the certificate source is alb, you must specify the CACertificateId parameter.\n" }, "caCertificateSource": { "type": "string", "description": "Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pca*root: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pca*sub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.\n" }, "certCenterCertificateId": { "type": "string", "description": "Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.\n" }, "certificateId": { "type": "string", "description": "Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.\n" }, "certificateSource": { "type": "string", "description": "Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; cert*center: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pca*leaf: private leaf certificate purchased or uploaded via Volcano Engine Certificate Center.\n" }, "createdTime": { "type": "string", "description": "Listener creation time.\n" }, "customizedCfgId": { "type": "string", "description": "Personalized configuration ID. If not bound, the value is an empty string.\n" }, "description": { "type": "string", "description": "Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.\n" }, "domainExtensions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ListenerDomainExtension:ListenerDomainExtension" } }, "enableHttp2": { "type": "string", "description": "HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).\n" }, "enableQuic": { "type": "string", "description": "QUIC feature switch. This parameter is only valid for HTTPS listeners. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.\n" }, "enabled": { "type": "string", "description": "Listener on/off status. Values: on: enabled (default); off: disabled.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "listenerName": { "type": "string", "description": "Listener name. If not specified, it is named in the \"protocol-port\" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.\n" }, "loadBalancerId": { "type": "string", "description": "Load balancer instance ID associated with the listener.\n" }, "pcaLeafCertificateId": { "type": "string", "description": "Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.\n" }, "pcaRootCaCertificateId": { "type": "string", "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.\n" }, "pcaSubCaCertificateId": { "type": "string", "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.\n" }, "port": { "type": "integer", "description": "Listener port. Value range: 1 - 65535.\n" }, "projectName": { "type": "string", "description": "Project name to which the listener belongs.\n" }, "protocol": { "type": "string", "description": "Listener protocol. Supports HTTP and HTTPS protocols.\n" }, "serverGroupId": { "type": "string", "description": "Default server group for the listener.\n" }, "serverGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ListenerServerGroup:ListenerServerGroup" } }, "status": { "type": "string", "description": "Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ListenerTag:ListenerTag" } }, "updatedTime": { "type": "string", "description": "The most recent operation time of the listener.\n" } }, "required": [ "accessLogRecordCustomizedHeadersEnabled", "aclIds", "aclStatus", "aclType", "caCertificateId", "caCertificateSource", "certCenterCertificateId", "certificateId", "certificateSource", "createdTime", "customizedCfgId", "description", "domainExtensions", "enableHttp2", "enableQuic", "enabled", "listenerId", "listenerName", "loadBalancerId", "pcaLeafCertificateId", "pcaRootCaCertificateId", "pcaSubCaCertificateId", "port", "projectName", "protocol", "serverGroupId", "serverGroups", "status", "tags", "updatedTime" ], "inputProperties": { "accessLogRecordCustomizedHeadersEnabled": { "type": "string", "description": "Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.\n" }, "aclIds": { "type": "array", "items": { "type": "string" }, "description": "Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.\n" }, "aclStatus": { "type": "string", "description": "Whether access control is enabled. Values: on: enabled. off: not enabled (default).\n" }, "aclType": { "type": "string", "description": "Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.\n" }, "caCertificateId": { "type": "string", "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When the certificate source is alb, you must specify the CACertificateId parameter.\n" }, "caCertificateSource": { "type": "string", "description": "Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pca*root: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pca*sub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.\n" }, "certCenterCertificateId": { "type": "string", "description": "Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.\n" }, "certificateId": { "type": "string", "description": "Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.\n" }, "certificateSource": { "type": "string", "description": "Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; cert*center: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pca*leaf: private leaf certificate purchased or uploaded via Volcano Engine Certificate Center.\n" }, "customizedCfgId": { "type": "string", "description": "Personalized configuration ID. If not bound, the value is an empty string.\n" }, "description": { "type": "string", "description": "Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.\n" }, "domainExtensions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ListenerDomainExtension:ListenerDomainExtension" } }, "enableHttp2": { "type": "string", "description": "HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).\n" }, "enableQuic": { "type": "string", "description": "QUIC feature switch. This parameter is only valid for HTTPS listeners. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.\n" }, "enabled": { "type": "string", "description": "Listener on/off status. Values: on: enabled (default); off: disabled.\n" }, "listenerName": { "type": "string", "description": "Listener name. If not specified, it is named in the \"protocol-port\" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.\n" }, "loadBalancerId": { "type": "string", "description": "Load balancer instance ID associated with the listener.\n" }, "pcaLeafCertificateId": { "type": "string", "description": "Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.\n" }, "pcaRootCaCertificateId": { "type": "string", "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.\n" }, "pcaSubCaCertificateId": { "type": "string", "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.\n" }, "port": { "type": "integer", "description": "Listener port. Value range: 1 - 65535.\n" }, "protocol": { "type": "string", "description": "Listener protocol. Supports HTTP and HTTPS protocols.\n" }, "serverGroupId": { "type": "string", "description": "Default server group for the listener.\n" }, "serverGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ListenerServerGroup:ListenerServerGroup" } }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ListenerTag:ListenerTag" } } }, "requiredInputs": [ "loadBalancerId", "port", "protocol", "serverGroupId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Listener resources.\n", "properties": { "accessLogRecordCustomizedHeadersEnabled": { "type": "string", "description": "Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.\n" }, "aclIds": { "type": "array", "items": { "type": "string" }, "description": "Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.\n" }, "aclStatus": { "type": "string", "description": "Whether access control is enabled. Values: on: enabled. off: not enabled (default).\n" }, "aclType": { "type": "string", "description": "Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.\n" }, "caCertificateId": { "type": "string", "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When the certificate source is alb, you must specify the CACertificateId parameter.\n" }, "caCertificateSource": { "type": "string", "description": "Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pca*root: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pca*sub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.\n" }, "certCenterCertificateId": { "type": "string", "description": "Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.\n" }, "certificateId": { "type": "string", "description": "Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.\n" }, "certificateSource": { "type": "string", "description": "Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; cert*center: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pca*leaf: private leaf certificate purchased or uploaded via Volcano Engine Certificate Center.\n" }, "createdTime": { "type": "string", "description": "Listener creation time.\n" }, "customizedCfgId": { "type": "string", "description": "Personalized configuration ID. If not bound, the value is an empty string.\n" }, "description": { "type": "string", "description": "Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.\n" }, "domainExtensions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ListenerDomainExtension:ListenerDomainExtension" } }, "enableHttp2": { "type": "string", "description": "HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).\n" }, "enableQuic": { "type": "string", "description": "QUIC feature switch. This parameter is only valid for HTTPS listeners. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.\n" }, "enabled": { "type": "string", "description": "Listener on/off status. Values: on: enabled (default); off: disabled.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "listenerName": { "type": "string", "description": "Listener name. If not specified, it is named in the \"protocol-port\" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.\n" }, "loadBalancerId": { "type": "string", "description": "Load balancer instance ID associated with the listener.\n" }, "pcaLeafCertificateId": { "type": "string", "description": "Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.\n" }, "pcaRootCaCertificateId": { "type": "string", "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.\n" }, "pcaSubCaCertificateId": { "type": "string", "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.\n" }, "port": { "type": "integer", "description": "Listener port. Value range: 1 - 65535.\n" }, "projectName": { "type": "string", "description": "Project name to which the listener belongs.\n" }, "protocol": { "type": "string", "description": "Listener protocol. Supports HTTP and HTTPS protocols.\n" }, "serverGroupId": { "type": "string", "description": "Default server group for the listener.\n" }, "serverGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ListenerServerGroup:ListenerServerGroup" } }, "status": { "type": "string", "description": "Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ListenerTag:ListenerTag" } }, "updatedTime": { "type": "string", "description": "The most recent operation time of the listener.\n" } }, "type": "object" } }, "volcenginecc:alb/loadBalancer:LoadBalancer": { "description": "Application Load Balancer (ALB) is a service that distributes traffic for Layer 7 network protocols.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n aLBLoadBalancerDemo:\n type: volcenginecc:alb:LoadBalancer\n name: ALBLoadBalancerDemo\n properties:\n type: public\n addressIpVersion: DualStack\n loadBalancerName: ccapi-alb-4\n description: Create by ccaip\n vpcId: vpc-rrco37ovjq4gv0x5xxxxx\n loadBalancerBillingType: 1\n deleteProtection: off\n bandwidthPackageId: bwp-1a1i9jjnawidc8nvexxxxx\n ipv6BandwidthPackageId: bwp-1a1i9jjnawidc8nvxxxxx\n eipBillingConfig:\n isp: BGP\n billing_type: 3\n bandwidth: 1\n security_protection_types: AntiDDoS_Enhanced\n security_protection_instance_id: 743\n zoneMappings:\n - subnet_id: subnet-rrwqhg3qzxfkv0xxxxxx\n zone_id: cn-beijing-a\n - subnet_id: subnet-btnzu3hrc0005h0xxxxx\n zone_id: cn-beijing-b\n ipv6EipBillingConfig:\n isp: BGP\n billing_type: 3\n bandwidth: 1\n projectName: default\n modificationProtectionStatus: NonProtection\n loadBalancerEdition: Standard\n wafProtectionEnabled: off\n tags:\n - key: test\n value: env\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:alb/loadBalancer:LoadBalancer example \"load_balancer_id\"\n```\n\n", "properties": { "addressIpVersion": { "type": "string", "description": "IP type of the ALB instance. IPv4: IPv4 type; DualStack: IPv4 \u0026 IPv6 dual stack type.\n" }, "bandwidthPackageId": { "type": "string", "description": "ID of the bound shared bandwidth package, enabling bandwidth sharing.\n" }, "businessStatus": { "type": "string", "description": "Service status of the ALB instance. Normal: normal; FinancialLocked: locked due to overdue payment.\n" }, "createTime": { "type": "string", "description": "Creation time of the ALB instance.\n" }, "deleteProtection": { "type": "string", "description": "Delete protection switch. on: enabled; off: disabled.\n" }, "deletedTime": { "type": "string", "description": "Expected reclamation time of the ALB instance. This parameter is only returned when the instance is in the FinancialLocked state.\n" }, "description": { "type": "string", "description": "Description of the ALB instance.\n" }, "dnsName": { "type": "string", "description": "DNS domain name.\n" }, "eipBillingConfig": { "$ref": "#/types/volcenginecc:alb/LoadBalancerEipBillingConfig:LoadBalancerEipBillingConfig", "description": "Billing configuration for public IP, only applicable to public instances.\n" }, "globalAccelerator": { "$ref": "#/types/volcenginecc:alb/LoadBalancerGlobalAccelerator:LoadBalancerGlobalAccelerator", "description": "Global accelerator configuration, used to improve cross-region access speed.\n" }, "ipv6BandwidthPackageId": { "type": "string", "description": "When creating a public ALB instance, specify the shared bandwidth package ID to which the IPv6 public bandwidth will be added.\n" }, "ipv6EipBillingConfig": { "$ref": "#/types/volcenginecc:alb/LoadBalancerIpv6EipBillingConfig:LoadBalancerIpv6EipBillingConfig", "description": "Billing configuration for IPv6 public IP, only applicable to public instances.\n" }, "loadBalancerBillingType": { "type": "integer", "description": "ALB instance billing type. Currently, only pay-as-you-go is supported (value is 1).\n" }, "loadBalancerEdition": { "type": "string", "description": "Version of the application load balancer. Basic: Basic version; Standard: Standard version.\n" }, "loadBalancerId": { "type": "string", "description": "ALB instance ID.\n" }, "loadBalancerName": { "type": "string", "description": "Name of the ALB instance.\n" }, "lockReason": { "type": "string", "description": "Reason for ALB instance freeze, such as Financial (arrears) or Security (security reasons). Returned only when the instance is locked.\n" }, "modificationProtectionReason": { "type": "string", "description": "Reason for modification protection. This parameter is valid and legitimate only when ModificationProtectionStatus is ConsoleProtection.\n" }, "modificationProtectionStatus": { "type": "string", "description": "Modification protection status. NonProtection: Not protected; ConsoleProtection: Console modification protection, instance configuration cannot be modified through the console.\n" }, "overdueTime": { "type": "string", "description": "Freeze time of the ALB instance. This parameter is only returned when the instance is in the FinancialLocked state.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the instance belongs.\n" }, "proxyProtocolEnabled": { "type": "string", "description": "ALB supports the Proxy Protocol and records the client's real IP.\n" }, "status": { "type": "string", "description": "ALB instance status: Active (running), Provisioning (creating), Configuring (configuring), Deleting (deleting), CreateFailed (creation failed), Inactive (stopped).\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/LoadBalancerTag:LoadBalancerTag" } }, "type": { "type": "string", "description": "Type of ALB instance. Values are public or private. public: Creates a public load balancer instance. The system assigns a public IP address and a private IP address, which can forward both public and private network requests. private: Creates a private load balancer instance. The system assigns a private IP address, used only for forwarding private network requests.\n" }, "updateTime": { "type": "string", "description": "Last update time of the ALB instance.\n" }, "vpcId": { "type": "string", "description": "ID of the Virtual Private Cloud (VPC) to which the load balancer instance belongs.\n" }, "wafInstanceId": { "type": "string", "description": "ID of the WAF security protection instance bound to the ALB instance.\n" }, "wafProtectedDomain": { "type": "string", "description": "Domain name protected by WAF, used for precise rule matching.\n" }, "wafProtectionEnabled": { "type": "string", "description": "WAF security protection switch. on: enabled; off: disabled.\n" }, "zoneMappings": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/LoadBalancerZoneMapping:LoadBalancerZoneMapping" } } }, "required": [ "addressIpVersion", "bandwidthPackageId", "businessStatus", "createTime", "deleteProtection", "deletedTime", "description", "dnsName", "eipBillingConfig", "globalAccelerator", "ipv6BandwidthPackageId", "ipv6EipBillingConfig", "loadBalancerBillingType", "loadBalancerEdition", "loadBalancerId", "loadBalancerName", "lockReason", "modificationProtectionReason", "modificationProtectionStatus", "overdueTime", "projectName", "proxyProtocolEnabled", "status", "tags", "type", "updateTime", "vpcId", "wafInstanceId", "wafProtectedDomain", "wafProtectionEnabled", "zoneMappings" ], "inputProperties": { "addressIpVersion": { "type": "string", "description": "IP type of the ALB instance. IPv4: IPv4 type; DualStack: IPv4 \u0026 IPv6 dual stack type.\n" }, "bandwidthPackageId": { "type": "string", "description": "ID of the bound shared bandwidth package, enabling bandwidth sharing.\n" }, "deleteProtection": { "type": "string", "description": "Delete protection switch. on: enabled; off: disabled.\n" }, "description": { "type": "string", "description": "Description of the ALB instance.\n" }, "eipBillingConfig": { "$ref": "#/types/volcenginecc:alb/LoadBalancerEipBillingConfig:LoadBalancerEipBillingConfig", "description": "Billing configuration for public IP, only applicable to public instances.\n" }, "globalAccelerator": { "$ref": "#/types/volcenginecc:alb/LoadBalancerGlobalAccelerator:LoadBalancerGlobalAccelerator", "description": "Global accelerator configuration, used to improve cross-region access speed.\n" }, "ipv6BandwidthPackageId": { "type": "string", "description": "When creating a public ALB instance, specify the shared bandwidth package ID to which the IPv6 public bandwidth will be added.\n" }, "ipv6EipBillingConfig": { "$ref": "#/types/volcenginecc:alb/LoadBalancerIpv6EipBillingConfig:LoadBalancerIpv6EipBillingConfig", "description": "Billing configuration for IPv6 public IP, only applicable to public instances.\n" }, "loadBalancerBillingType": { "type": "integer", "description": "ALB instance billing type. Currently, only pay-as-you-go is supported (value is 1).\n" }, "loadBalancerEdition": { "type": "string", "description": "Version of the application load balancer. Basic: Basic version; Standard: Standard version.\n" }, "loadBalancerName": { "type": "string", "description": "Name of the ALB instance.\n" }, "modificationProtectionReason": { "type": "string", "description": "Reason for modification protection. This parameter is valid and legitimate only when ModificationProtectionStatus is ConsoleProtection.\n" }, "modificationProtectionStatus": { "type": "string", "description": "Modification protection status. NonProtection: Not protected; ConsoleProtection: Console modification protection, instance configuration cannot be modified through the console.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the instance belongs.\n" }, "proxyProtocolEnabled": { "type": "string", "description": "ALB supports the Proxy Protocol and records the client's real IP.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/LoadBalancerTag:LoadBalancerTag" } }, "type": { "type": "string", "description": "Type of ALB instance. Values are public or private. public: Creates a public load balancer instance. The system assigns a public IP address and a private IP address, which can forward both public and private network requests. private: Creates a private load balancer instance. The system assigns a private IP address, used only for forwarding private network requests.\n" }, "vpcId": { "type": "string", "description": "ID of the Virtual Private Cloud (VPC) to which the load balancer instance belongs.\n" }, "wafInstanceId": { "type": "string", "description": "ID of the WAF security protection instance bound to the ALB instance.\n" }, "wafProtectedDomain": { "type": "string", "description": "Domain name protected by WAF, used for precise rule matching.\n" }, "wafProtectionEnabled": { "type": "string", "description": "WAF security protection switch. on: enabled; off: disabled.\n" }, "zoneMappings": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/LoadBalancerZoneMapping:LoadBalancerZoneMapping" } } }, "requiredInputs": [ "type", "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering LoadBalancer resources.\n", "properties": { "addressIpVersion": { "type": "string", "description": "IP type of the ALB instance. IPv4: IPv4 type; DualStack: IPv4 \u0026 IPv6 dual stack type.\n" }, "bandwidthPackageId": { "type": "string", "description": "ID of the bound shared bandwidth package, enabling bandwidth sharing.\n" }, "businessStatus": { "type": "string", "description": "Service status of the ALB instance. Normal: normal; FinancialLocked: locked due to overdue payment.\n" }, "createTime": { "type": "string", "description": "Creation time of the ALB instance.\n" }, "deleteProtection": { "type": "string", "description": "Delete protection switch. on: enabled; off: disabled.\n" }, "deletedTime": { "type": "string", "description": "Expected reclamation time of the ALB instance. This parameter is only returned when the instance is in the FinancialLocked state.\n" }, "description": { "type": "string", "description": "Description of the ALB instance.\n" }, "dnsName": { "type": "string", "description": "DNS domain name.\n" }, "eipBillingConfig": { "$ref": "#/types/volcenginecc:alb/LoadBalancerEipBillingConfig:LoadBalancerEipBillingConfig", "description": "Billing configuration for public IP, only applicable to public instances.\n" }, "globalAccelerator": { "$ref": "#/types/volcenginecc:alb/LoadBalancerGlobalAccelerator:LoadBalancerGlobalAccelerator", "description": "Global accelerator configuration, used to improve cross-region access speed.\n" }, "ipv6BandwidthPackageId": { "type": "string", "description": "When creating a public ALB instance, specify the shared bandwidth package ID to which the IPv6 public bandwidth will be added.\n" }, "ipv6EipBillingConfig": { "$ref": "#/types/volcenginecc:alb/LoadBalancerIpv6EipBillingConfig:LoadBalancerIpv6EipBillingConfig", "description": "Billing configuration for IPv6 public IP, only applicable to public instances.\n" }, "loadBalancerBillingType": { "type": "integer", "description": "ALB instance billing type. Currently, only pay-as-you-go is supported (value is 1).\n" }, "loadBalancerEdition": { "type": "string", "description": "Version of the application load balancer. Basic: Basic version; Standard: Standard version.\n" }, "loadBalancerId": { "type": "string", "description": "ALB instance ID.\n" }, "loadBalancerName": { "type": "string", "description": "Name of the ALB instance.\n" }, "lockReason": { "type": "string", "description": "Reason for ALB instance freeze, such as Financial (arrears) or Security (security reasons). Returned only when the instance is locked.\n" }, "modificationProtectionReason": { "type": "string", "description": "Reason for modification protection. This parameter is valid and legitimate only when ModificationProtectionStatus is ConsoleProtection.\n" }, "modificationProtectionStatus": { "type": "string", "description": "Modification protection status. NonProtection: Not protected; ConsoleProtection: Console modification protection, instance configuration cannot be modified through the console.\n" }, "overdueTime": { "type": "string", "description": "Freeze time of the ALB instance. This parameter is only returned when the instance is in the FinancialLocked state.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the instance belongs.\n" }, "proxyProtocolEnabled": { "type": "string", "description": "ALB supports the Proxy Protocol and records the client's real IP.\n" }, "status": { "type": "string", "description": "ALB instance status: Active (running), Provisioning (creating), Configuring (configuring), Deleting (deleting), CreateFailed (creation failed), Inactive (stopped).\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/LoadBalancerTag:LoadBalancerTag" } }, "type": { "type": "string", "description": "Type of ALB instance. Values are public or private. public: Creates a public load balancer instance. The system assigns a public IP address and a private IP address, which can forward both public and private network requests. private: Creates a private load balancer instance. The system assigns a private IP address, used only for forwarding private network requests.\n" }, "updateTime": { "type": "string", "description": "Last update time of the ALB instance.\n" }, "vpcId": { "type": "string", "description": "ID of the Virtual Private Cloud (VPC) to which the load balancer instance belongs.\n" }, "wafInstanceId": { "type": "string", "description": "ID of the WAF security protection instance bound to the ALB instance.\n" }, "wafProtectedDomain": { "type": "string", "description": "Domain name protected by WAF, used for precise rule matching.\n" }, "wafProtectionEnabled": { "type": "string", "description": "WAF security protection switch. on: enabled; off: disabled.\n" }, "zoneMappings": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/LoadBalancerZoneMapping:LoadBalancerZoneMapping" } } }, "type": "object" } }, "volcenginecc:alb/rule:Rule": { "description": "ALB distributes incoming traffic based on the forwarding rules you set. You can configure multiple forwarding rules for a single listener. Basic edition ALB instances support forwarding rules based on domain and path. Standard edition ALB instances support forwarding rules based on domain, path, and HTTP headers, and support composite forwarding conditions.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n albRuleDemo:\n type: volcenginecc:alb:Rule\n name: AlbRuleDemo\n properties:\n description: test-rewrite\n domain: www.xxxx.test.com\n listenerId: lsn-bdwhrmgvcyyo8dv4xxxxxx\n rewriteConfig:\n rewrite_path: /test\n rewriteEnabled: on\n ruleAction: \"\"\n trafficLimitEnabled: off\n trafficLimitQps: 0\n url: /\n forwardGroupConfig:\n server_group_tuples:\n - serverGroupId: rsp-1pf4pgyq8zitc845wfxxxxxx\n weight: 100\n - serverGroupId: rsp-1pf4pgyq8zitc845wfxxxxxx\n weight: 100\n sticky_session_enabled: on\n sticky_session_timeout: 2000\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:alb/rule:Rule example \"listener_id|rule_id\"\n```\n\n", "properties": { "description": { "type": "string", "description": "Forwarding rule description.\n" }, "domain": { "type": "string", "description": "Domain name of the forwarding rule.\n" }, "forwardGroupConfig": { "$ref": "#/types/volcenginecc:alb/RuleForwardGroupConfig:RuleForwardGroupConfig", "description": "Forwarding rule server group configuration.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "priority": { "type": "integer", "description": "Standard edition forwarding rule priority.\n" }, "redirectConfig": { "$ref": "#/types/volcenginecc:alb/RuleRedirectConfig:RuleRedirectConfig", "description": "Redirect-related configuration information.\n" }, "rewriteConfig": { "$ref": "#/types/volcenginecc:alb/RuleRewriteConfig:RuleRewriteConfig", "description": "Redirect-related configuration information.\n" }, "rewriteEnabled": { "type": "string", "description": "Forwarding rule rewrite configuration switch. on: enabled. off: disabled.\n" }, "ruleAction": { "type": "string", "description": "Forwarding rule action. Empty: default forward to server group. Redirect: redirect.\n" }, "ruleActions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/RuleRuleAction:RuleRuleAction" } }, "ruleConditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/RuleRuleCondition:RuleRuleCondition" } }, "ruleId": { "type": "string", "description": "Forwarding rule ID.\n" }, "serverGroupId": { "type": "string", "description": "Backend server group ID associated with the forwarding rule.\n" }, "trafficLimitEnabled": { "type": "string", "description": "Forwarding rule QPS throttling switch. on: enabled. off: disabled.\n" }, "trafficLimitQps": { "type": "integer", "description": "Requests per second. Range: 100–100000.\n" }, "url": { "type": "string", "description": "Forwarding rule URL.\n" } }, "required": [ "description", "domain", "forwardGroupConfig", "listenerId", "priority", "redirectConfig", "rewriteConfig", "rewriteEnabled", "ruleAction", "ruleActions", "ruleConditions", "ruleId", "serverGroupId", "trafficLimitEnabled", "trafficLimitQps", "url" ], "inputProperties": { "description": { "type": "string", "description": "Forwarding rule description.\n" }, "domain": { "type": "string", "description": "Domain name of the forwarding rule.\n" }, "forwardGroupConfig": { "$ref": "#/types/volcenginecc:alb/RuleForwardGroupConfig:RuleForwardGroupConfig", "description": "Forwarding rule server group configuration.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "priority": { "type": "integer", "description": "Standard edition forwarding rule priority.\n" }, "redirectConfig": { "$ref": "#/types/volcenginecc:alb/RuleRedirectConfig:RuleRedirectConfig", "description": "Redirect-related configuration information.\n" }, "rewriteConfig": { "$ref": "#/types/volcenginecc:alb/RuleRewriteConfig:RuleRewriteConfig", "description": "Redirect-related configuration information.\n" }, "rewriteEnabled": { "type": "string", "description": "Forwarding rule rewrite configuration switch. on: enabled. off: disabled.\n" }, "ruleAction": { "type": "string", "description": "Forwarding rule action. Empty: default forward to server group. Redirect: redirect.\n" }, "ruleActions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/RuleRuleAction:RuleRuleAction" } }, "ruleConditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/RuleRuleCondition:RuleRuleCondition" } }, "serverGroupId": { "type": "string", "description": "Backend server group ID associated with the forwarding rule.\n" }, "trafficLimitEnabled": { "type": "string", "description": "Forwarding rule QPS throttling switch. on: enabled. off: disabled.\n" }, "trafficLimitQps": { "type": "integer", "description": "Requests per second. Range: 100–100000.\n" }, "url": { "type": "string", "description": "Forwarding rule URL.\n" } }, "requiredInputs": [ "listenerId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Rule resources.\n", "properties": { "description": { "type": "string", "description": "Forwarding rule description.\n" }, "domain": { "type": "string", "description": "Domain name of the forwarding rule.\n" }, "forwardGroupConfig": { "$ref": "#/types/volcenginecc:alb/RuleForwardGroupConfig:RuleForwardGroupConfig", "description": "Forwarding rule server group configuration.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "priority": { "type": "integer", "description": "Standard edition forwarding rule priority.\n" }, "redirectConfig": { "$ref": "#/types/volcenginecc:alb/RuleRedirectConfig:RuleRedirectConfig", "description": "Redirect-related configuration information.\n" }, "rewriteConfig": { "$ref": "#/types/volcenginecc:alb/RuleRewriteConfig:RuleRewriteConfig", "description": "Redirect-related configuration information.\n" }, "rewriteEnabled": { "type": "string", "description": "Forwarding rule rewrite configuration switch. on: enabled. off: disabled.\n" }, "ruleAction": { "type": "string", "description": "Forwarding rule action. Empty: default forward to server group. Redirect: redirect.\n" }, "ruleActions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/RuleRuleAction:RuleRuleAction" } }, "ruleConditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/RuleRuleCondition:RuleRuleCondition" } }, "ruleId": { "type": "string", "description": "Forwarding rule ID.\n" }, "serverGroupId": { "type": "string", "description": "Backend server group ID associated with the forwarding rule.\n" }, "trafficLimitEnabled": { "type": "string", "description": "Forwarding rule QPS throttling switch. on: enabled. off: disabled.\n" }, "trafficLimitQps": { "type": "integer", "description": "Requests per second. Range: 100–100000.\n" }, "url": { "type": "string", "description": "Forwarding rule URL.\n" } }, "type": "object" } }, "volcenginecc:alb/serverGroup:ServerGroup": { "description": "A server group is a logical collection of backend servers. The ALB instance determines which server group to forward client requests to based on your forwarding rules. Then, the ALB instance distributes requests to backend servers within the server group according to your load balancing policy. Backend servers receive and process the requests.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n albServergroupDemo:\n type: volcenginecc:alb:ServerGroup\n name: AlbServergroupDemo\n properties:\n vpcId: vpc-13f8***\n serverGroupName: test-servergroup\n serverGroupType: instance\n protocol: HTTP\n scheduler: wrr\n crossZoneEnabled: on\n healthCheck:\n enabled: on\n port: 80\n interval: 2\n timeout: 5\n healthy_threshold: 3\n unhealthy_threshold: 3\n method: GET\n http_version: HTTP1.1\n uri: /health\n http_code: http_2xx\n stickySessionConfig:\n sticky_session_enabled: on\n sticky_session_type: insert\n cookie_timeout: 1000\n servers:\n - instance_id: i-ye3***\n type: ecs\n ip: 192.168.1.**\n port: 80\n weight: 10\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:alb/serverGroup:ServerGroup example \"server_group_id\"\n```\n\n", "properties": { "createTime": { "type": "string", "description": "Creation time of the backend server group.\n" }, "crossZoneEnabled": { "type": "string", "description": "Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.\n" }, "description": { "type": "string", "description": "Description of the backend server group.\n" }, "healthCheck": { "$ref": "#/types/volcenginecc:alb/ServerGroupHealthCheck:ServerGroupHealthCheck", "description": "Health check configuration information for the server group.\n" }, "ipAddressType": { "type": "string", "description": "IP address type of the server group. Currently, only IPv4 is supported.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ServerGroupListener:ServerGroupListener" } }, "projectName": { "type": "string", "description": "Name of the project to which the backend server group belongs.\n" }, "protocol": { "type": "string", "description": "Backend protocol: HTTP, HTTPS.\n" }, "scheduler": { "type": "string", "description": "Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.\n" }, "serverCount": { "type": "integer", "description": "Number of backend servers in the server group.\n" }, "serverGroupId": { "type": "string", "description": "Backend server group ID.\n" }, "serverGroupName": { "type": "string", "description": "Backend server group name.\n" }, "serverGroupType": { "type": "string", "description": "Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ServerGroupServer:ServerGroupServer" } }, "status": { "type": "string", "description": "Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.\n" }, "stickySessionConfig": { "$ref": "#/types/volcenginecc:alb/ServerGroupStickySessionConfig:ServerGroupStickySessionConfig", "description": "Session persistence parameter information.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ServerGroupTag:ServerGroupTag" } }, "updateTime": { "type": "string", "description": "Last operation time of the backend server group.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC to which the backend server group belongs.\n" } }, "required": [ "createTime", "crossZoneEnabled", "description", "healthCheck", "ipAddressType", "listeners", "projectName", "protocol", "scheduler", "serverCount", "serverGroupId", "serverGroupName", "serverGroupType", "servers", "status", "stickySessionConfig", "tags", "updateTime", "vpcId" ], "inputProperties": { "crossZoneEnabled": { "type": "string", "description": "Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.\n" }, "description": { "type": "string", "description": "Description of the backend server group.\n" }, "healthCheck": { "$ref": "#/types/volcenginecc:alb/ServerGroupHealthCheck:ServerGroupHealthCheck", "description": "Health check configuration information for the server group.\n" }, "ipAddressType": { "type": "string", "description": "IP address type of the server group. Currently, only IPv4 is supported.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the backend server group belongs.\n" }, "protocol": { "type": "string", "description": "Backend protocol: HTTP, HTTPS.\n" }, "scheduler": { "type": "string", "description": "Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.\n" }, "serverGroupName": { "type": "string", "description": "Backend server group name.\n" }, "serverGroupType": { "type": "string", "description": "Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ServerGroupServer:ServerGroupServer" } }, "status": { "type": "string", "description": "Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.\n" }, "stickySessionConfig": { "$ref": "#/types/volcenginecc:alb/ServerGroupStickySessionConfig:ServerGroupStickySessionConfig", "description": "Session persistence parameter information.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ServerGroupTag:ServerGroupTag" } }, "vpcId": { "type": "string", "description": "ID of the VPC to which the backend server group belongs.\n" } }, "requiredInputs": [ "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering ServerGroup resources.\n", "properties": { "createTime": { "type": "string", "description": "Creation time of the backend server group.\n" }, "crossZoneEnabled": { "type": "string", "description": "Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.\n" }, "description": { "type": "string", "description": "Description of the backend server group.\n" }, "healthCheck": { "$ref": "#/types/volcenginecc:alb/ServerGroupHealthCheck:ServerGroupHealthCheck", "description": "Health check configuration information for the server group.\n" }, "ipAddressType": { "type": "string", "description": "IP address type of the server group. Currently, only IPv4 is supported.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ServerGroupListener:ServerGroupListener" } }, "projectName": { "type": "string", "description": "Name of the project to which the backend server group belongs.\n" }, "protocol": { "type": "string", "description": "Backend protocol: HTTP, HTTPS.\n" }, "scheduler": { "type": "string", "description": "Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.\n" }, "serverCount": { "type": "integer", "description": "Number of backend servers in the server group.\n" }, "serverGroupId": { "type": "string", "description": "Backend server group ID.\n" }, "serverGroupName": { "type": "string", "description": "Backend server group name.\n" }, "serverGroupType": { "type": "string", "description": "Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ServerGroupServer:ServerGroupServer" } }, "status": { "type": "string", "description": "Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.\n" }, "stickySessionConfig": { "$ref": "#/types/volcenginecc:alb/ServerGroupStickySessionConfig:ServerGroupStickySessionConfig", "description": "Session persistence parameter information.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:alb/ServerGroupTag:ServerGroupTag" } }, "updateTime": { "type": "string", "description": "Last operation time of the backend server group.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC to which the backend server group belongs.\n" } }, "type": "object" } }, "volcenginecc:apig/customDomain:CustomDomain": { "description": "The service serves as the entry point for external access. You can bind your custom domain to the service using the domain binding feature\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst apigCustomDomainDemo = new volcenginecc.apig.CustomDomain(\"ApigCustomDomainDemo\", {\n serviceId: \"sd50d3h5xxxm0t5xxxxx\",\n domain: \"www.****.com\",\n protocols: [\n \"HTTP\",\n \"HTTPS\",\n ],\n certificateId: \"cert-775906d873xxx5bc9d1d372b5dxxxxx\",\n comments: \"ApigCustomDomainDemo custom domain\",\n sslRedirect: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\napig_custom_domain_demo = volcenginecc.apig.CustomDomain(\"ApigCustomDomainDemo\",\n service_id=\"sd50d3h5xxxm0t5xxxxx\",\n domain=\"www.****.com\",\n protocols=[\n \"HTTP\",\n \"HTTPS\",\n ],\n certificate_id=\"cert-775906d873xxx5bc9d1d372b5dxxxxx\",\n comments=\"ApigCustomDomainDemo custom domain\",\n ssl_redirect=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var apigCustomDomainDemo = new Volcenginecc.Apig.CustomDomain(\"ApigCustomDomainDemo\", new()\n {\n ServiceId = \"sd50d3h5xxxm0t5xxxxx\",\n Domain = \"www.****.com\",\n Protocols = new[]\n {\n \"HTTP\",\n \"HTTPS\",\n },\n CertificateId = \"cert-775906d873xxx5bc9d1d372b5dxxxxx\",\n Comments = \"ApigCustomDomainDemo custom domain\",\n SslRedirect = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/apig\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := apig.NewCustomDomain(ctx, \"ApigCustomDomainDemo\", \u0026apig.CustomDomainArgs{\n\t\t\tServiceId: pulumi.String(\"sd50d3h5xxxm0t5xxxxx\"),\n\t\t\tDomain: pulumi.String(\"www.****.com\"),\n\t\t\tProtocols: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"HTTP\"),\n\t\t\t\tpulumi.String(\"HTTPS\"),\n\t\t\t},\n\t\t\tCertificateId: pulumi.String(\"cert-775906d873xxx5bc9d1d372b5dxxxxx\"),\n\t\t\tComments: pulumi.String(\"ApigCustomDomainDemo custom domain\"),\n\t\t\tSslRedirect: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.apig.CustomDomain;\nimport com.volcengine.volcenginecc.apig.CustomDomainArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var apigCustomDomainDemo = new CustomDomain(\"apigCustomDomainDemo\", CustomDomainArgs.builder()\n .serviceId(\"sd50d3h5xxxm0t5xxxxx\")\n .domain(\"www.****.com\")\n .protocols( \n \"HTTP\",\n \"HTTPS\")\n .certificateId(\"cert-775906d873xxx5bc9d1d372b5dxxxxx\")\n .comments(\"ApigCustomDomainDemo custom domain\")\n .sslRedirect(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n apigCustomDomainDemo:\n type: volcenginecc:apig:CustomDomain\n name: ApigCustomDomainDemo\n properties:\n serviceId: sd50d3h5xxxm0t5xxxxx\n domain: www.****.com\n protocols:\n - HTTP\n - HTTPS\n certificateId: cert-775906d873xxx5bc9d1d372b5dxxxxx\n comments: ApigCustomDomainDemo custom domain\n sslRedirect: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:apig/customDomain:CustomDomain example \"custom_domain_id\"\n```\n\n", "properties": { "certificateId": { "type": "string", "description": "Custom Domain Certificate ID\n" }, "comments": { "type": "string", "description": "Remarks\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "customDomainId": { "type": "string", "description": "Custom Domain ID\n" }, "domain": { "type": "string", "description": "Custom Domain\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "Protocol. Values: HTTP, HTTPS\n" }, "serviceId": { "type": "string", "description": "Service ID\n" }, "sslRedirect": { "type": "boolean", "description": "Redirect to HTTPS\n" }, "status": { "type": "string", "description": "Status. Values: Creating: configuring; CreationFailed: configuration failed; Deleting: deleting; DeletionFailed: deletion failed; Verified: active\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "required": [ "certificateId", "comments", "createdTime", "customDomainId", "domain", "protocols", "serviceId", "sslRedirect", "status", "updatedTime" ], "inputProperties": { "certificateId": { "type": "string", "description": "Custom Domain Certificate ID\n" }, "comments": { "type": "string", "description": "Remarks\n" }, "domain": { "type": "string", "description": "Custom Domain\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "Protocol. Values: HTTP, HTTPS\n" }, "serviceId": { "type": "string", "description": "Service ID\n" }, "sslRedirect": { "type": "boolean", "description": "Redirect to HTTPS\n" } }, "requiredInputs": [ "domain", "protocols", "serviceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering CustomDomain resources.\n", "properties": { "certificateId": { "type": "string", "description": "Custom Domain Certificate ID\n" }, "comments": { "type": "string", "description": "Remarks\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "customDomainId": { "type": "string", "description": "Custom Domain ID\n" }, "domain": { "type": "string", "description": "Custom Domain\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "Protocol. Values: HTTP, HTTPS\n" }, "serviceId": { "type": "string", "description": "Service ID\n" }, "sslRedirect": { "type": "boolean", "description": "Redirect to HTTPS\n" }, "status": { "type": "string", "description": "Status. Values: Creating: configuring; CreationFailed: configuration failed; Deleting: deleting; DeletionFailed: deletion failed; Verified: active\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "type": "object" } }, "volcenginecc:apig/gateway:Gateway": { "description": "API Gateway (Gateway) is the core component of the API management service. It receives, processes, and forwards API requests, and provides security authentication, traffic control, and other features\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n aPIGGatewayDemo:\n type: volcenginecc:apig:Gateway\n name: APIGGatewayDemo\n properties:\n name: APIGGatewayDemo\n type: standard\n comments: APIGGatewayDemo comments\n vpcId: vpc-13f8k4dwdsydc3n6nu5rxxxxx\n subnetIds:\n - subnet-***\n - subnet-***\n resourceSpec:\n instance_spec_code: 1c2g\n replicas: 2\n clb_spec_code: small_1\n public_network_bandwidth: 1\n public_network_billing_type: bandwidth\n network_type:\n enablePublicNetwork: true\n enablePrivateNetwork: true\n monitorSpec:\n enable: true\n workspace_id: '***'\n logSpec:\n enable: true\n project_id: '***'\n topic_id: '***'\n traceSpec:\n enable: true\n trace_type: tls\n tls_trace_spec:\n projectId: '***'\n iamUserAk: '***'\n iamUserSk: '***'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:apig/gateway:Gateway example \"gateway_id\"\n```\n\n", "properties": { "backendSpec": { "$ref": "#/types/volcenginecc:apig/GatewayBackendSpec:GatewayBackendSpec", "description": "Backend service configuration information\n" }, "comments": { "type": "string", "description": "Gateway remarks. Length limit: 0–253 characters.\n" }, "createdTime": { "type": "string", "description": "Gateway creation time\n" }, "customLog": { "$ref": "#/types/volcenginecc:apig/GatewayCustomLog:GatewayCustomLog", "description": "Custom log configuration\n" }, "events": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayEvent:GatewayEvent" } }, "gatewayId": { "type": "string", "description": "Gateway instance ID\n" }, "logSpec": { "$ref": "#/types/volcenginecc:apig/GatewayLogSpec:GatewayLogSpec", "description": "Log configuration\n" }, "message": { "type": "string", "description": "Error message for gateway creation failure, deletion failure, or abnormal status\n" }, "monitorSpec": { "$ref": "#/types/volcenginecc:apig/GatewayMonitorSpec:GatewayMonitorSpec", "description": "Monitoring configuration information\n" }, "name": { "type": "string", "description": "Gateway name\n" }, "networkSpec": { "$ref": "#/types/volcenginecc:apig/GatewayNetworkSpec:GatewayNetworkSpec", "description": "Network configuration information\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "resourceSpec": { "$ref": "#/types/volcenginecc:apig/GatewayResourceSpec:GatewayResourceSpec", "description": "Resource specification configuration information\n" }, "status": { "type": "string", "description": "Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID list. Length limit: 1–2\n" }, "traceSpec": { "$ref": "#/types/volcenginecc:apig/GatewayTraceSpec:GatewayTraceSpec", "description": "Link tracing configuration information.\n" }, "type": { "type": "string", "description": "Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)\n" }, "version": { "type": "string", "description": "Gateway version.\n" }, "vpcId": { "type": "string", "description": "VPC ID。\n" } }, "required": [ "backendSpec", "comments", "createdTime", "customLog", "events", "gatewayId", "logSpec", "message", "monitorSpec", "name", "networkSpec", "projectName", "resourceSpec", "status", "subnetIds", "traceSpec", "type", "version", "vpcId" ], "inputProperties": { "comments": { "type": "string", "description": "Gateway remarks. Length limit: 0–253 characters.\n" }, "customLog": { "$ref": "#/types/volcenginecc:apig/GatewayCustomLog:GatewayCustomLog", "description": "Custom log configuration\n" }, "logSpec": { "$ref": "#/types/volcenginecc:apig/GatewayLogSpec:GatewayLogSpec", "description": "Log configuration\n" }, "monitorSpec": { "$ref": "#/types/volcenginecc:apig/GatewayMonitorSpec:GatewayMonitorSpec", "description": "Monitoring configuration information\n" }, "name": { "type": "string", "description": "Gateway name\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "resourceSpec": { "$ref": "#/types/volcenginecc:apig/GatewayResourceSpec:GatewayResourceSpec", "description": "Resource specification configuration information\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID list. Length limit: 1–2\n" }, "traceSpec": { "$ref": "#/types/volcenginecc:apig/GatewayTraceSpec:GatewayTraceSpec", "description": "Link tracing configuration information.\n" }, "type": { "type": "string", "description": "Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)\n" }, "vpcId": { "type": "string", "description": "VPC ID。\n" } }, "requiredInputs": [ "name" ], "stateInputs": { "description": "Input properties used for looking up and filtering Gateway resources.\n", "properties": { "backendSpec": { "$ref": "#/types/volcenginecc:apig/GatewayBackendSpec:GatewayBackendSpec", "description": "Backend service configuration information\n" }, "comments": { "type": "string", "description": "Gateway remarks. Length limit: 0–253 characters.\n" }, "createdTime": { "type": "string", "description": "Gateway creation time\n" }, "customLog": { "$ref": "#/types/volcenginecc:apig/GatewayCustomLog:GatewayCustomLog", "description": "Custom log configuration\n" }, "events": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayEvent:GatewayEvent" } }, "gatewayId": { "type": "string", "description": "Gateway instance ID\n" }, "logSpec": { "$ref": "#/types/volcenginecc:apig/GatewayLogSpec:GatewayLogSpec", "description": "Log configuration\n" }, "message": { "type": "string", "description": "Error message for gateway creation failure, deletion failure, or abnormal status\n" }, "monitorSpec": { "$ref": "#/types/volcenginecc:apig/GatewayMonitorSpec:GatewayMonitorSpec", "description": "Monitoring configuration information\n" }, "name": { "type": "string", "description": "Gateway name\n" }, "networkSpec": { "$ref": "#/types/volcenginecc:apig/GatewayNetworkSpec:GatewayNetworkSpec", "description": "Network configuration information\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "resourceSpec": { "$ref": "#/types/volcenginecc:apig/GatewayResourceSpec:GatewayResourceSpec", "description": "Resource specification configuration information\n" }, "status": { "type": "string", "description": "Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID list. Length limit: 1–2\n" }, "traceSpec": { "$ref": "#/types/volcenginecc:apig/GatewayTraceSpec:GatewayTraceSpec", "description": "Link tracing configuration information.\n" }, "type": { "type": "string", "description": "Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)\n" }, "version": { "type": "string", "description": "Gateway version.\n" }, "vpcId": { "type": "string", "description": "VPC ID。\n" } }, "type": "object" } }, "volcenginecc:apig/gatewayService:GatewayService": { "description": "A service is a set of routes exposed as entry points to distinguish traffic sources and protocols, enabling business, environment, and logical tenant isolation. Services can bind independent access domains, allowing access by domain.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n apigGatewayServiceDemo:\n type: volcenginecc:apig:GatewayService\n name: ApigGatewayServiceDemo\n properties:\n serviceName: ccapi-terraform-1\n gatewayId: gd6l9lbilgrmdxxxxxx\n protocols:\n - HTTP\n - HTTPS\n authSpec:\n enable: true\n comments: test\n serviceType: AIProvider\n serviceNetworkSpec:\n enable_public_network: true\n enable_private_network: false\n private_network_ip: []\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:apig/gatewayService:GatewayService example \"service_id\"\n```\n\n", "properties": { "authSpec": { "$ref": "#/types/volcenginecc:apig/GatewayServiceAuthSpec:GatewayServiceAuthSpec", "description": "Authentication configuration.\n" }, "comments": { "type": "string", "description": "Remarks. Length must be 0–253 characters.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "customDomains": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayServiceCustomDomain:GatewayServiceCustomDomain" } }, "domainSpec": { "$ref": "#/types/volcenginecc:apig/GatewayServiceDomainSpec:GatewayServiceDomainSpec", "description": "Domain details.\n" }, "domainType": { "type": "string", "description": "Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.\n" }, "domains": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayServiceDomain:GatewayServiceDomain" } }, "gatewayId": { "type": "string", "description": "Gateway ID.\n" }, "gatewayName": { "type": "string", "description": "Gateway name.\n" }, "message": { "type": "string", "description": "Error message for service creation failure, deletion failure, or abnormal status.\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.\n" }, "serviceId": { "type": "string", "description": "Service ID.\n" }, "serviceName": { "type": "string", "description": "Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).\n" }, "serviceNetworkSpec": { "$ref": "#/types/volcenginecc:apig/GatewayServiceServiceNetworkSpec:GatewayServiceServiceNetworkSpec", "description": "Default domain network configuration..\n" }, "serviceType": { "type": "string", "description": "Service type. Options: AIProvider: AI model proxy.\n" }, "status": { "type": "string", "description": "Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.\n" } }, "required": [ "authSpec", "comments", "createdTime", "customDomains", "domainSpec", "domainType", "domains", "gatewayId", "gatewayName", "message", "protocols", "serviceId", "serviceName", "serviceNetworkSpec", "serviceType", "status" ], "inputProperties": { "authSpec": { "$ref": "#/types/volcenginecc:apig/GatewayServiceAuthSpec:GatewayServiceAuthSpec", "description": "Authentication configuration.\n" }, "comments": { "type": "string", "description": "Remarks. Length must be 0–253 characters.\n" }, "customDomains": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayServiceCustomDomain:GatewayServiceCustomDomain" } }, "domainType": { "type": "string", "description": "Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.\n" }, "gatewayId": { "type": "string", "description": "Gateway ID.\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.\n" }, "serviceName": { "type": "string", "description": "Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).\n" }, "serviceNetworkSpec": { "$ref": "#/types/volcenginecc:apig/GatewayServiceServiceNetworkSpec:GatewayServiceServiceNetworkSpec", "description": "Default domain network configuration..\n" }, "serviceType": { "type": "string", "description": "Service type. Options: AIProvider: AI model proxy.\n" } }, "requiredInputs": [ "authSpec", "gatewayId", "protocols", "serviceName" ], "stateInputs": { "description": "Input properties used for looking up and filtering GatewayService resources.\n", "properties": { "authSpec": { "$ref": "#/types/volcenginecc:apig/GatewayServiceAuthSpec:GatewayServiceAuthSpec", "description": "Authentication configuration.\n" }, "comments": { "type": "string", "description": "Remarks. Length must be 0–253 characters.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "customDomains": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayServiceCustomDomain:GatewayServiceCustomDomain" } }, "domainSpec": { "$ref": "#/types/volcenginecc:apig/GatewayServiceDomainSpec:GatewayServiceDomainSpec", "description": "Domain details.\n" }, "domainType": { "type": "string", "description": "Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.\n" }, "domains": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/GatewayServiceDomain:GatewayServiceDomain" } }, "gatewayId": { "type": "string", "description": "Gateway ID.\n" }, "gatewayName": { "type": "string", "description": "Gateway name.\n" }, "message": { "type": "string", "description": "Error message for service creation failure, deletion failure, or abnormal status.\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.\n" }, "serviceId": { "type": "string", "description": "Service ID.\n" }, "serviceName": { "type": "string", "description": "Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).\n" }, "serviceNetworkSpec": { "$ref": "#/types/volcenginecc:apig/GatewayServiceServiceNetworkSpec:GatewayServiceServiceNetworkSpec", "description": "Default domain network configuration..\n" }, "serviceType": { "type": "string", "description": "Service type. Options: AIProvider: AI model proxy.\n" }, "status": { "type": "string", "description": "Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.\n" } }, "type": "object" } }, "volcenginecc:apig/upstream:Upstream": { "description": "Upstream is an abstraction of the backend for API gateway instances. You can group backend applications with the same functionality into an upstream, which decouples routing from backend applications and provides flexible support for scenarios such as canary releases and multi-version management. This article introduces the concept and purpose of upstream\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n aPIGUpstreamAIProviderDemo:\n type: volcenginecc:apig:Upstream\n name: APIGUpstreamAIProviderDemo\n properties:\n circuitBreakingSettings:\n base_ejection_time: 30\n consecutive_errors: 5\n enable: true\n interval: 10\n max_ejection_percent: 20\n min_health_percent: 60\n comments: this is a test\n connectionPoolSettings:\n enable: true\n http_1_max_pending_requests: 1000\n idle_timeout: 1000\n max_connections: 1000\n gatewayId: gd6hagxxxxxkh7is70\n loadBalancerSettings:\n lb_policy: SimpleLB\n simple_lb: LEAST_CONN\n warmup_duration: 5\n name: test-7\n protocol: HTTP\n tlsSettings:\n sni: \"\"\n tls_mode: DISABLE\n sourceType: Domain\n upstreamSpec:\n domain:\n domainList:\n - domain: www.test7.com\n port: 5566\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:apig/upstream:Upstream example \"upstream_id\"\n```\n\n", "properties": { "backendTargets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/UpstreamBackendTarget:UpstreamBackendTarget" } }, "circuitBreakingSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamCircuitBreakingSettings:UpstreamCircuitBreakingSettings", "description": "Service circuit breaking configuration\n" }, "comments": { "type": "string", "description": "Remarks\n" }, "connectionPoolSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamConnectionPoolSettings:UpstreamConnectionPoolSettings", "description": "Connection Pool Configuration\n" }, "createdTime": { "type": "string", "description": "Upstream creation time\n" }, "gatewayId": { "type": "string", "description": "Gateway Instance ID\n" }, "loadBalancerSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamLoadBalancerSettings:UpstreamLoadBalancerSettings", "description": "Load Balancing Configuration\n" }, "name": { "type": "string", "description": "Upstream name\n" }, "protocol": { "type": "string", "description": "Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC\n" }, "sourceType": { "type": "string", "description": "Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy\n" }, "tlsSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamTlsSettings:UpstreamTlsSettings", "description": "TLS Configuration\n" }, "updatedTime": { "type": "string", "description": "Upstream update time\n" }, "upstreamId": { "type": "string", "description": "Upstream ID。\n" }, "upstreamSpec": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpec:UpstreamUpstreamSpec", "description": "Upstream Configuration\n" }, "versionDetails": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/UpstreamVersionDetail:UpstreamVersionDetail" } } }, "required": [ "backendTargets", "circuitBreakingSettings", "comments", "connectionPoolSettings", "createdTime", "gatewayId", "loadBalancerSettings", "name", "protocol", "sourceType", "tlsSettings", "updatedTime", "upstreamId", "upstreamSpec", "versionDetails" ], "inputProperties": { "circuitBreakingSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamCircuitBreakingSettings:UpstreamCircuitBreakingSettings", "description": "Service circuit breaking configuration\n" }, "comments": { "type": "string", "description": "Remarks\n" }, "connectionPoolSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamConnectionPoolSettings:UpstreamConnectionPoolSettings", "description": "Connection Pool Configuration\n" }, "gatewayId": { "type": "string", "description": "Gateway Instance ID\n" }, "loadBalancerSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamLoadBalancerSettings:UpstreamLoadBalancerSettings", "description": "Load Balancing Configuration\n" }, "name": { "type": "string", "description": "Upstream name\n" }, "protocol": { "type": "string", "description": "Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC\n" }, "sourceType": { "type": "string", "description": "Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy\n" }, "tlsSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamTlsSettings:UpstreamTlsSettings", "description": "TLS Configuration\n" }, "upstreamSpec": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpec:UpstreamUpstreamSpec", "description": "Upstream Configuration\n" } }, "requiredInputs": [ "gatewayId", "name", "sourceType", "upstreamSpec" ], "stateInputs": { "description": "Input properties used for looking up and filtering Upstream resources.\n", "properties": { "backendTargets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/UpstreamBackendTarget:UpstreamBackendTarget" } }, "circuitBreakingSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamCircuitBreakingSettings:UpstreamCircuitBreakingSettings", "description": "Service circuit breaking configuration\n" }, "comments": { "type": "string", "description": "Remarks\n" }, "connectionPoolSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamConnectionPoolSettings:UpstreamConnectionPoolSettings", "description": "Connection Pool Configuration\n" }, "createdTime": { "type": "string", "description": "Upstream creation time\n" }, "gatewayId": { "type": "string", "description": "Gateway Instance ID\n" }, "loadBalancerSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamLoadBalancerSettings:UpstreamLoadBalancerSettings", "description": "Load Balancing Configuration\n" }, "name": { "type": "string", "description": "Upstream name\n" }, "protocol": { "type": "string", "description": "Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC\n" }, "sourceType": { "type": "string", "description": "Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy\n" }, "tlsSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamTlsSettings:UpstreamTlsSettings", "description": "TLS Configuration\n" }, "updatedTime": { "type": "string", "description": "Upstream update time\n" }, "upstreamId": { "type": "string", "description": "Upstream ID。\n" }, "upstreamSpec": { "$ref": "#/types/volcenginecc:apig/UpstreamUpstreamSpec:UpstreamUpstreamSpec", "description": "Upstream Configuration\n" }, "versionDetails": { "type": "array", "items": { "$ref": "#/types/volcenginecc:apig/UpstreamVersionDetail:UpstreamVersionDetail" } } }, "type": "object" } }, "volcenginecc:apig/upstreamSource:UpstreamSource": { "description": "The API Gateway supports cluster registration based on container services (VKE) and container service clusters. Import clusters into the API Gateway instance to use them as Upstream sources, allowing the gateway to retrieve the Service list from the cluster\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n upstreamSourceNacosDemo:\n type: volcenginecc:apig:UpstreamSource\n name: UpstreamSourceNacosDemo\n properties:\n gatewayId: gd3s9vbk7npja181xxxxx\n comments: upstreamSourceNacosDemo\n sourceType: Nacos\n sourceSpec:\n nacos_source:\n nacosId: nd3thmnjdl46p917xxxxx\n authConfig:\n basic:\n username: nacos\n password: '******'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:apig/upstreamSource:UpstreamSource example \"upstream_source_id\"\n```\n\n", "properties": { "comments": { "type": "string", "description": "Remarks, length limit: 0–253 characters\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "gatewayId": { "type": "string", "description": "Gateway instance ID\n" }, "ingressSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceIngressSettings:UpstreamSourceIngressSettings", "description": "Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type\n" }, "sourceSpec": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceSourceSpec:UpstreamSourceSourceSpec", "description": "Upstream source configuration\n" }, "sourceType": { "type": "string", "description": "Upstream source type. Options: K8S: Container cluster. Nacos: Registry\n" }, "status": { "type": "string", "description": "Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed\n" }, "statusMessage": { "type": "string", "description": "Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster\n" }, "updatedTime": { "type": "string", "description": "Update time\n" }, "upstreamSourceId": { "type": "string", "description": "Upstream source ID\n" }, "watchNamespaces": { "type": "array", "items": { "type": "string" }, "description": "Specify namespace\n" } }, "required": [ "comments", "createdTime", "gatewayId", "ingressSettings", "sourceSpec", "sourceType", "status", "statusMessage", "updatedTime", "upstreamSourceId", "watchNamespaces" ], "inputProperties": { "comments": { "type": "string", "description": "Remarks, length limit: 0–253 characters\n" }, "gatewayId": { "type": "string", "description": "Gateway instance ID\n" }, "ingressSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceIngressSettings:UpstreamSourceIngressSettings", "description": "Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type\n" }, "sourceSpec": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceSourceSpec:UpstreamSourceSourceSpec", "description": "Upstream source configuration\n" }, "sourceType": { "type": "string", "description": "Upstream source type. Options: K8S: Container cluster. Nacos: Registry\n" }, "watchNamespaces": { "type": "array", "items": { "type": "string" }, "description": "Specify namespace\n" } }, "requiredInputs": [ "gatewayId", "sourceSpec", "sourceType" ], "stateInputs": { "description": "Input properties used for looking up and filtering UpstreamSource resources.\n", "properties": { "comments": { "type": "string", "description": "Remarks, length limit: 0–253 characters\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "gatewayId": { "type": "string", "description": "Gateway instance ID\n" }, "ingressSettings": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceIngressSettings:UpstreamSourceIngressSettings", "description": "Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type\n" }, "sourceSpec": { "$ref": "#/types/volcenginecc:apig/UpstreamSourceSourceSpec:UpstreamSourceSourceSpec", "description": "Upstream source configuration\n" }, "sourceType": { "type": "string", "description": "Upstream source type. Options: K8S: Container cluster. Nacos: Registry\n" }, "status": { "type": "string", "description": "Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed\n" }, "statusMessage": { "type": "string", "description": "Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster\n" }, "updatedTime": { "type": "string", "description": "Update time\n" }, "upstreamSourceId": { "type": "string", "description": "Upstream source ID\n" }, "watchNamespaces": { "type": "array", "items": { "type": "string" }, "description": "Specify namespace\n" } }, "type": "object" } }, "volcenginecc:ark/endpoint:Endpoint": { "description": "When using large language models for inference services, the inference endpoint is the key entry point for model invocation. Developers can initiate API/SDK inference requests to the large model simply by specifying the ID, enabling quick access and flexible invocation. The system provides a unified API invocation method, call monitoring, rate limiting strategies, and security mechanisms to ensure stability and security during inference\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n endpointDemo:\n type: volcenginecc:ark:Endpoint\n name: EndpointDemo\n properties:\n name: EndpointDemo\n description: endpoint description\n modelReference:\n foundation_model:\n name: doubao-1-5-thinking-***\n modelVersion: '250428'\n tags:\n - key: env\n value: test\n projectName: default\n rateLimit:\n tpm: 5\n rpm: 10\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ark/endpoint:Endpoint example \"endpoint_id\"\n```\n\n", "properties": { "batchOnly": { "type": "boolean", "description": "Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed\n" }, "certificate": { "$ref": "#/types/volcenginecc:ark/EndpointCertificate:EndpointCertificate", "description": "Certificate information\n" }, "createTime": { "type": "string", "description": "Endpoint creation time, RFC3339 format\n" }, "description": { "type": "string", "description": "Endpoint description\n" }, "endpointId": { "type": "string", "description": "Inference access point ID.\n" }, "endpointModelType": { "type": "string", "description": "Access point model type. Options: FoundationModel for base model; CustomModel for custom model.\n" }, "modelReference": { "$ref": "#/types/volcenginecc:ark/EndpointModelReference:EndpointModelReference", "description": "Endpoint access model\n" }, "modelUnitId": { "type": "string", "description": "Model unit. If empty, indicates postpaid; otherwise, prepaid.\n" }, "moderation": { "$ref": "#/types/volcenginecc:ark/EndpointModeration:EndpointModeration", "description": "Content guardrail scheme\n" }, "name": { "type": "string", "description": "Endpoint name\n" }, "projectName": { "type": "string", "description": "Project name the resource belongs to; default value is \"default\"\n" }, "rateLimit": { "$ref": "#/types/volcenginecc:ark/EndpointRateLimit:EndpointRateLimit", "description": "Endpoint rate limiting\n" }, "rollingId": { "type": "string", "description": "Endpoint switch ID\n" }, "scaleTierId": { "type": "string", "description": "If a TPM protection package exists, this is the TPM protection package ID.\n" }, "status": { "type": "string", "description": "Endpoint status\n" }, "statusReason": { "type": "string", "description": "Additional status information\n" }, "supportRolling": { "type": "boolean", "description": "Whether endpoint supports switching model versions\n" }, "supportScaleTier": { "type": "boolean", "description": "Whether TPM protection package is supported\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ark/EndpointTag:EndpointTag" } }, "updateTime": { "type": "string", "description": "Endpoint update time, RFC3339 format\n" } }, "required": [ "batchOnly", "certificate", "createTime", "description", "endpointId", "endpointModelType", "modelReference", "modelUnitId", "moderation", "name", "projectName", "rateLimit", "rollingId", "scaleTierId", "status", "statusReason", "supportRolling", "supportScaleTier", "tags", "updateTime" ], "inputProperties": { "description": { "type": "string", "description": "Endpoint description\n" }, "modelReference": { "$ref": "#/types/volcenginecc:ark/EndpointModelReference:EndpointModelReference", "description": "Endpoint access model\n" }, "modelUnitId": { "type": "string", "description": "Model unit. If empty, indicates postpaid; otherwise, prepaid.\n" }, "moderation": { "$ref": "#/types/volcenginecc:ark/EndpointModeration:EndpointModeration", "description": "Content guardrail scheme\n" }, "name": { "type": "string", "description": "Endpoint name\n" }, "projectName": { "type": "string", "description": "Project name the resource belongs to; default value is \"default\"\n" }, "rateLimit": { "$ref": "#/types/volcenginecc:ark/EndpointRateLimit:EndpointRateLimit", "description": "Endpoint rate limiting\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ark/EndpointTag:EndpointTag" } } }, "requiredInputs": [ "modelReference", "name" ], "stateInputs": { "description": "Input properties used for looking up and filtering Endpoint resources.\n", "properties": { "batchOnly": { "type": "boolean", "description": "Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed\n" }, "certificate": { "$ref": "#/types/volcenginecc:ark/EndpointCertificate:EndpointCertificate", "description": "Certificate information\n" }, "createTime": { "type": "string", "description": "Endpoint creation time, RFC3339 format\n" }, "description": { "type": "string", "description": "Endpoint description\n" }, "endpointId": { "type": "string", "description": "Inference access point ID.\n" }, "endpointModelType": { "type": "string", "description": "Access point model type. Options: FoundationModel for base model; CustomModel for custom model.\n" }, "modelReference": { "$ref": "#/types/volcenginecc:ark/EndpointModelReference:EndpointModelReference", "description": "Endpoint access model\n" }, "modelUnitId": { "type": "string", "description": "Model unit. If empty, indicates postpaid; otherwise, prepaid.\n" }, "moderation": { "$ref": "#/types/volcenginecc:ark/EndpointModeration:EndpointModeration", "description": "Content guardrail scheme\n" }, "name": { "type": "string", "description": "Endpoint name\n" }, "projectName": { "type": "string", "description": "Project name the resource belongs to; default value is \"default\"\n" }, "rateLimit": { "$ref": "#/types/volcenginecc:ark/EndpointRateLimit:EndpointRateLimit", "description": "Endpoint rate limiting\n" }, "rollingId": { "type": "string", "description": "Endpoint switch ID\n" }, "scaleTierId": { "type": "string", "description": "If a TPM protection package exists, this is the TPM protection package ID.\n" }, "status": { "type": "string", "description": "Endpoint status\n" }, "statusReason": { "type": "string", "description": "Additional status information\n" }, "supportRolling": { "type": "boolean", "description": "Whether endpoint supports switching model versions\n" }, "supportScaleTier": { "type": "boolean", "description": "Whether TPM protection package is supported\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ark/EndpointTag:EndpointTag" } }, "updateTime": { "type": "string", "description": "Endpoint update time, RFC3339 format\n" } }, "type": "object" } }, "volcenginecc:autoscaling/scalingConfiguration:ScalingConfiguration": { "description": "Defines the instance configuration in the scaling group, including compute, memory, network, storage, and security. When the scaling group expands, new instances are created based on this configuration source.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n autoScalingDemo:\n type: volcenginecc:autoscaling:ScalingConfiguration\n name: AutoScalingDemo\n properties:\n instanceName: AutoScalingDemo\n scalingConfigurationName: AutoScalingDemo\n hostName: AutoScalingDemo\n scalingGroupId: scg-ye43d97gsvkxgganxxxx\n securityGroupIds:\n - sg-rrco3fkzzy0wv0x589wxxxx\n eip:\n bandwidth: 1\n billing_type: PostPaidByBandwidth\n isp: BGP\n bandwidth_package_id: bwp-btgl56gbli4g5h0b2v7ixxxx\n release_with_instance: true\n ipv6AddressCount: 1\n spotStrategy: SpotWithPriceLimit\n instanceTypeOverrides:\n - instance_type: ecs.g4il.large\n price_limit: 0.5\n imageId: image-aagd56zrvqjtdripxxxx\n securityEnhancementStrategy: Active\n volumes:\n - delete_with_instance: true\n size: 40\n volume_type: ESSD_PL0\n - delete_with_instance: true\n size: 500\n volume_type: ESSD_FlexPL\n extra_performance_iops: 3\n extra_performance_type_id: Balance\n - delete_with_instance: true\n size: 510\n volume_type: ESSD_FlexPL\n extra_performance_iops: 2\n extra_performance_type_id: IOPS\n - delete_with_instance: true\n size: 520\n volume_type: ESSD_FlexPL\n extra_performance_throughput_mb: 2\n extra_performance_type_id: Throughput\n projectName: default\n keyPairName: test\n password: test\n instanceDescription: Web server configuration\n zoneId: cn-test\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:autoscaling/scalingConfiguration:ScalingConfiguration example \"scaling_configuration_id\"\n```\n\n", "properties": { "createdAt": { "type": "string", "description": "Resource creation time (UTC)\n" }, "eip": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationEip:ScalingConfigurationEip", "description": "Public IP.\n" }, "hostName": { "type": "string", "description": "Instance hostname. Value: Linux instances allow periods to separate segments; each segment can contain letters, digits, or hyphens '-'. Cannot start or end with a period '.' or hyphen '-', and periods or hyphens cannot be used consecutively. Linux hostnames must be 2–63 characters long. Windows instances allow letters, digits, or hyphens '-', but cannot be entirely numeric. Cannot start or end with a hyphen '-', and hyphens cannot be used consecutively. Windows hostnames must be 2–15 characters long. If not specified, the hostname is automatically generated as follows: Structure: iv - + initial hostname, for example iv-3tigy72q3u3vj0******. Created instances retain the original hostname generation logic and do not change upon instance restart. Initial hostname generation logic: Linux: extracts all characters after instance ID 'i-'. Windows: extracts the last 12 characters after instance ID 'i-'\n" }, "hpcClusterId": { "type": "string", "description": "ID of the high-performance computing cluster to which the instance belongs. Only valid when InstanceTypes.N is specified as 'High-Performance Computing GPU'.\n" }, "imageId": { "type": "string", "description": "Image ID. The image resource used when the scaling group automatically creates an instance\n" }, "instanceChargeType": { "type": "string", "description": "Instance billing type. Values: PrePaid (subscription) / PostPaid (pay-as-you-go)\n" }, "instanceDescription": { "type": "string", "description": "Instance description. Value: Cannot start with a digit or hyphen. Only Chinese characters, letters, digits, underscores, and hyphens are allowed. Length must be between 0 and 255 characters. If not specified, defaults to an empty string\n" }, "instanceName": { "type": "string", "description": "Instance name. Rules: Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscore \"_\", hyphen \"-\", and period \".\". Length: 1–128 characters.\n" }, "instanceTypeOverrides": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationInstanceTypeOverride:ScalingConfigurationInstanceTypeOverride" } }, "instanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of compute specifications for the instance\n" }, "ipv6AddressCount": { "type": "integer", "description": "Assign an IPv6 address to the instance NIC. Values: 0: Do not assign an IPv6 address. 1: Assign an IPv6 address; the system automatically allocates an IPv6 subnet for you.\n" }, "keyPairName": { "type": "string", "description": "Name of the key pair. If both KeyPairName and Password are set, only KeyPairName takes effect\n" }, "lifecycleState": { "type": "string", "description": "Lifecycle status. Values: Active (active) / InActive (inactive)\n" }, "password": { "type": "string", "description": "When logging in to the instance using the 'Password' method, set the root login password: The password must be 8–30 characters long and consist of uppercase letters, lowercase letters, numbers, and special characters. At least three types must be included. Allowed special characters: `~!#$%^\u0026*()_-+= |. The password cannot start with '/' or '$6$'\n" }, "projectName": { "type": "string", "description": "The project to which the instance created by the scaling configuration belongs. Default is empty. Each resource can belong to only one project.\nOnly letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed.\nMaximum length: 64 characters\n" }, "scalingConfigurationId": { "type": "string", "description": "Scaling configuration ID\n" }, "scalingConfigurationName": { "type": "string", "description": "Name of the scaling configuration. The name must be unique within the same scaling group in the same region. Rules: Must start with a Chinese character or letter. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length: 1–128 characters. Special characters are not supported.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID to which the scaling configuration belongs\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Enable security hardening. Options: Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group ID associated with the instance's primary network interface\n" }, "spotStrategy": { "type": "string", "description": "Instance preemption policy. Values: NoSpot (default): creates a standard pay-as-you-go instance. SpotAsPriceGo: system automatically bids, creating a preemptible instance that follows the current market price. SpotWithPriceLimit: creates a preemptible instance with a specified bid limit\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationTag:ScalingConfigurationTag" } }, "updatedAt": { "type": "string", "description": "Resource update time (UTC)\n" }, "userData": { "type": "string", "description": "Instance custom data. Custom data must be Base64 encoded, and the size before encoding must not exceed 16 KB. If not specified, defaults to empty\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationVolume:ScalingConfigurationVolume" } }, "zoneId": { "type": "string", "description": "Availability zone ID for the scaling configuration\n" } }, "required": [ "createdAt", "eip", "hostName", "hpcClusterId", "imageId", "instanceChargeType", "instanceDescription", "instanceName", "instanceTypeOverrides", "instanceTypes", "ipv6AddressCount", "keyPairName", "lifecycleState", "password", "projectName", "scalingConfigurationId", "scalingConfigurationName", "scalingGroupId", "securityEnhancementStrategy", "securityGroupIds", "spotStrategy", "tags", "updatedAt", "userData", "volumes", "zoneId" ], "inputProperties": { "eip": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationEip:ScalingConfigurationEip", "description": "Public IP.\n" }, "hostName": { "type": "string", "description": "Instance hostname. Value: Linux instances allow periods to separate segments; each segment can contain letters, digits, or hyphens '-'. Cannot start or end with a period '.' or hyphen '-', and periods or hyphens cannot be used consecutively. Linux hostnames must be 2–63 characters long. Windows instances allow letters, digits, or hyphens '-', but cannot be entirely numeric. Cannot start or end with a hyphen '-', and hyphens cannot be used consecutively. Windows hostnames must be 2–15 characters long. If not specified, the hostname is automatically generated as follows: Structure: iv - + initial hostname, for example iv-3tigy72q3u3vj0******. Created instances retain the original hostname generation logic and do not change upon instance restart. Initial hostname generation logic: Linux: extracts all characters after instance ID 'i-'. Windows: extracts the last 12 characters after instance ID 'i-'\n" }, "hpcClusterId": { "type": "string", "description": "ID of the high-performance computing cluster to which the instance belongs. Only valid when InstanceTypes.N is specified as 'High-Performance Computing GPU'.\n" }, "imageId": { "type": "string", "description": "Image ID. The image resource used when the scaling group automatically creates an instance\n" }, "instanceDescription": { "type": "string", "description": "Instance description. Value: Cannot start with a digit or hyphen. Only Chinese characters, letters, digits, underscores, and hyphens are allowed. Length must be between 0 and 255 characters. If not specified, defaults to an empty string\n" }, "instanceName": { "type": "string", "description": "Instance name. Rules: Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscore \"_\", hyphen \"-\", and period \".\". Length: 1–128 characters.\n" }, "instanceTypeOverrides": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationInstanceTypeOverride:ScalingConfigurationInstanceTypeOverride" } }, "ipv6AddressCount": { "type": "integer", "description": "Assign an IPv6 address to the instance NIC. Values: 0: Do not assign an IPv6 address. 1: Assign an IPv6 address; the system automatically allocates an IPv6 subnet for you.\n" }, "keyPairName": { "type": "string", "description": "Name of the key pair. If both KeyPairName and Password are set, only KeyPairName takes effect\n" }, "lifecycleState": { "type": "string", "description": "Lifecycle status. Values: Active (active) / InActive (inactive)\n" }, "password": { "type": "string", "description": "When logging in to the instance using the 'Password' method, set the root login password: The password must be 8–30 characters long and consist of uppercase letters, lowercase letters, numbers, and special characters. At least three types must be included. Allowed special characters: `~!#$%^\u0026*()_-+= |. The password cannot start with '/' or '$6$'\n" }, "projectName": { "type": "string", "description": "The project to which the instance created by the scaling configuration belongs. Default is empty. Each resource can belong to only one project.\nOnly letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed.\nMaximum length: 64 characters\n" }, "scalingConfigurationName": { "type": "string", "description": "Name of the scaling configuration. The name must be unique within the same scaling group in the same region. Rules: Must start with a Chinese character or letter. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length: 1–128 characters. Special characters are not supported.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID to which the scaling configuration belongs\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Enable security hardening. Options: Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group ID associated with the instance's primary network interface\n" }, "spotStrategy": { "type": "string", "description": "Instance preemption policy. Values: NoSpot (default): creates a standard pay-as-you-go instance. SpotAsPriceGo: system automatically bids, creating a preemptible instance that follows the current market price. SpotWithPriceLimit: creates a preemptible instance with a specified bid limit\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationTag:ScalingConfigurationTag" } }, "userData": { "type": "string", "description": "Instance custom data. Custom data must be Base64 encoded, and the size before encoding must not exceed 16 KB. If not specified, defaults to empty\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationVolume:ScalingConfigurationVolume" } }, "zoneId": { "type": "string", "description": "Availability zone ID for the scaling configuration\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering ScalingConfiguration resources.\n", "properties": { "createdAt": { "type": "string", "description": "Resource creation time (UTC)\n" }, "eip": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationEip:ScalingConfigurationEip", "description": "Public IP.\n" }, "hostName": { "type": "string", "description": "Instance hostname. Value: Linux instances allow periods to separate segments; each segment can contain letters, digits, or hyphens '-'. Cannot start or end with a period '.' or hyphen '-', and periods or hyphens cannot be used consecutively. Linux hostnames must be 2–63 characters long. Windows instances allow letters, digits, or hyphens '-', but cannot be entirely numeric. Cannot start or end with a hyphen '-', and hyphens cannot be used consecutively. Windows hostnames must be 2–15 characters long. If not specified, the hostname is automatically generated as follows: Structure: iv - + initial hostname, for example iv-3tigy72q3u3vj0******. Created instances retain the original hostname generation logic and do not change upon instance restart. Initial hostname generation logic: Linux: extracts all characters after instance ID 'i-'. Windows: extracts the last 12 characters after instance ID 'i-'\n" }, "hpcClusterId": { "type": "string", "description": "ID of the high-performance computing cluster to which the instance belongs. Only valid when InstanceTypes.N is specified as 'High-Performance Computing GPU'.\n" }, "imageId": { "type": "string", "description": "Image ID. The image resource used when the scaling group automatically creates an instance\n" }, "instanceChargeType": { "type": "string", "description": "Instance billing type. Values: PrePaid (subscription) / PostPaid (pay-as-you-go)\n" }, "instanceDescription": { "type": "string", "description": "Instance description. Value: Cannot start with a digit or hyphen. Only Chinese characters, letters, digits, underscores, and hyphens are allowed. Length must be between 0 and 255 characters. If not specified, defaults to an empty string\n" }, "instanceName": { "type": "string", "description": "Instance name. Rules: Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscore \"_\", hyphen \"-\", and period \".\". Length: 1–128 characters.\n" }, "instanceTypeOverrides": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationInstanceTypeOverride:ScalingConfigurationInstanceTypeOverride" } }, "instanceTypes": { "type": "array", "items": { "type": "string" }, "description": "List of compute specifications for the instance\n" }, "ipv6AddressCount": { "type": "integer", "description": "Assign an IPv6 address to the instance NIC. Values: 0: Do not assign an IPv6 address. 1: Assign an IPv6 address; the system automatically allocates an IPv6 subnet for you.\n" }, "keyPairName": { "type": "string", "description": "Name of the key pair. If both KeyPairName and Password are set, only KeyPairName takes effect\n" }, "lifecycleState": { "type": "string", "description": "Lifecycle status. Values: Active (active) / InActive (inactive)\n" }, "password": { "type": "string", "description": "When logging in to the instance using the 'Password' method, set the root login password: The password must be 8–30 characters long and consist of uppercase letters, lowercase letters, numbers, and special characters. At least three types must be included. Allowed special characters: `~!#$%^\u0026*()_-+= |. The password cannot start with '/' or '$6$'\n" }, "projectName": { "type": "string", "description": "The project to which the instance created by the scaling configuration belongs. Default is empty. Each resource can belong to only one project.\nOnly letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed.\nMaximum length: 64 characters\n" }, "scalingConfigurationId": { "type": "string", "description": "Scaling configuration ID\n" }, "scalingConfigurationName": { "type": "string", "description": "Name of the scaling configuration. The name must be unique within the same scaling group in the same region. Rules: Must start with a Chinese character or letter. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length: 1–128 characters. Special characters are not supported.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID to which the scaling configuration belongs\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Enable security hardening. Options: Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Security group ID associated with the instance's primary network interface\n" }, "spotStrategy": { "type": "string", "description": "Instance preemption policy. Values: NoSpot (default): creates a standard pay-as-you-go instance. SpotAsPriceGo: system automatically bids, creating a preemptible instance that follows the current market price. SpotWithPriceLimit: creates a preemptible instance with a specified bid limit\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationTag:ScalingConfigurationTag" } }, "updatedAt": { "type": "string", "description": "Resource update time (UTC)\n" }, "userData": { "type": "string", "description": "Instance custom data. Custom data must be Base64 encoded, and the size before encoding must not exceed 16 KB. If not specified, defaults to empty\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingConfigurationVolume:ScalingConfigurationVolume" } }, "zoneId": { "type": "string", "description": "Availability zone ID for the scaling configuration\n" } }, "type": "object" } }, "volcenginecc:autoscaling/scalingGroup:ScalingGroup": { "description": "Scaling groups are used to manage a set of cloud resource instances. You can use scaling groups to define the number/capacity of instances in the resource pool, cooldown time, load balancing, and other information.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n autoScalingScalingGroupDemo:\n type: volcenginecc:autoscaling:ScalingGroup\n name: AutoScalingScalingGroupDemo\n properties:\n healthCheckType: ECS\n scalingMode: release\n instancesDistribution:\n compensate_with_on_demand: true\n on_demand_base_capacity: 0\n on_demand_percentage_above_base_capacity: 50\n spot_instance_remedy: true\n tags:\n - key: env\n value: test\n launchTemplateOverrides:\n - instance_type: ecs.g4il.large\n price_limit: 0\n launchTemplateId: lt-ye9dsl3ucffig992xxxxfncd\n projectName: default\n serverGroupAttributes:\n - port: 8080\n server_group_id: rsp-13g2ktevofhfk3n6nxxxu4mqjq0o\n type: CLB\n weight: 50\n - port: 8080\n server_group_id: rsp-bde4j3yuu8008dv4xxxx0nkn203g\n type: ALB\n weight: 50\n launchTemplateVersion: Default\n subnetIds:\n - subnet-3nrd6qaq3log0931ecxxxh3re2r\n defaultCooldown: 300\n desireInstanceNumber: -1\n instanceTerminatePolicy: OldestScalingConfigurationWithOldestInstance\n maxInstanceNumber: 6\n minInstanceNumber: 1\n multiAzPolicy: PRIORITY\n scalingGroupName: AutoScalingScalingGroupDemo\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:autoscaling/scalingGroup:ScalingGroup example \"scaling_group_id\"\n```\n\n", "properties": { "activeScalingConfigurationId": { "type": "string", "description": "ID of the scaling configuration bound to the scaling group\n" }, "createdTime": { "type": "string", "description": "Scaling group creation time\n" }, "dbInstanceIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the RDS database instance.\n" }, "defaultCooldown": { "type": "integer", "description": "Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.\n" }, "desireInstanceNumber": { "type": "integer", "description": "Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.\n" }, "healthCheckType": { "type": "string", "description": "Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.\n" }, "instanceRemovePolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupInstanceRemovePolicy:ScalingGroupInstanceRemovePolicy" } }, "instanceTerminatePolicy": { "type": "string", "description": "Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.\n" }, "instances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupInstance:ScalingGroupInstance" } }, "instancesDistribution": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupInstancesDistribution:ScalingGroupInstancesDistribution", "description": "Instance distribution policy.\n" }, "isEnableScalingGroup": { "type": "boolean", "description": "Whether to enable the scaling group. true: enabled. false: stopped\n" }, "launchTemplateId": { "type": "string", "description": "Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.\n" }, "launchTemplateOverrides": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupLaunchTemplateOverride:ScalingGroupLaunchTemplateOverride" } }, "launchTemplateVersion": { "type": "string", "description": "Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.\n" }, "lifecycleState": { "type": "string", "description": "Status of the scaling group. Active: enabled. InActive: not activated. Deleting: deleting. Locked: locked. CoolingDown: cooling down. Unknown: unknown status.\n" }, "loadBalancerHealthCheckGracePeriod": { "type": "integer", "description": "Grace period for CLB health checks on scaling group instances\n" }, "maxInstanceNumber": { "type": "integer", "description": "Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.\n" }, "minInstanceNumber": { "type": "integer", "description": "Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.\n" }, "multiAzPolicy": { "type": "string", "description": "Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.\n" }, "projectName": { "type": "string", "description": "Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID.\n" }, "scalingGroupName": { "type": "string", "description": "Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.\n" }, "scalingMode": { "type": "string", "description": "Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.\n" }, "serverGroupAttributes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupServerGroupAttribute:ScalingGroupServerGroupAttribute" } }, "stoppedInstanceCount": { "type": "integer", "description": "Number of instances in the scaling group that are in the disabled state.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs for the primary network interface of instances in the scaling group\n" }, "suspendedProcesses": { "type": "array", "items": { "type": "string" }, "description": "Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupTag:ScalingGroupTag" } }, "totalInstanceCount": { "type": "integer", "description": "Number of instances currently in the scaling group\n" }, "updatedTime": { "type": "string", "description": "Scaling group update time.\n" }, "vpcId": { "type": "string", "description": "VPC ID to which the scaling group belongs\n" } }, "required": [ "activeScalingConfigurationId", "createdTime", "dbInstanceIds", "defaultCooldown", "desireInstanceNumber", "healthCheckType", "instanceRemovePolicies", "instanceTerminatePolicy", "instances", "instancesDistribution", "isEnableScalingGroup", "launchTemplateId", "launchTemplateOverrides", "launchTemplateVersion", "lifecycleState", "loadBalancerHealthCheckGracePeriod", "maxInstanceNumber", "minInstanceNumber", "multiAzPolicy", "projectName", "scalingGroupId", "scalingGroupName", "scalingMode", "serverGroupAttributes", "stoppedInstanceCount", "subnetIds", "suspendedProcesses", "tags", "totalInstanceCount", "updatedTime", "vpcId" ], "inputProperties": { "activeScalingConfigurationId": { "type": "string", "description": "ID of the scaling configuration bound to the scaling group\n" }, "defaultCooldown": { "type": "integer", "description": "Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.\n" }, "desireInstanceNumber": { "type": "integer", "description": "Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.\n" }, "healthCheckType": { "type": "string", "description": "Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.\n" }, "instanceRemovePolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupInstanceRemovePolicy:ScalingGroupInstanceRemovePolicy" } }, "instanceTerminatePolicy": { "type": "string", "description": "Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.\n" }, "instances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupInstance:ScalingGroupInstance" } }, "instancesDistribution": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupInstancesDistribution:ScalingGroupInstancesDistribution", "description": "Instance distribution policy.\n" }, "isEnableScalingGroup": { "type": "boolean", "description": "Whether to enable the scaling group. true: enabled. false: stopped\n" }, "launchTemplateId": { "type": "string", "description": "Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.\n" }, "launchTemplateOverrides": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupLaunchTemplateOverride:ScalingGroupLaunchTemplateOverride" } }, "launchTemplateVersion": { "type": "string", "description": "Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.\n" }, "maxInstanceNumber": { "type": "integer", "description": "Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.\n" }, "minInstanceNumber": { "type": "integer", "description": "Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.\n" }, "multiAzPolicy": { "type": "string", "description": "Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.\n" }, "projectName": { "type": "string", "description": "Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.\n" }, "scalingGroupName": { "type": "string", "description": "Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.\n" }, "scalingMode": { "type": "string", "description": "Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.\n" }, "serverGroupAttributes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupServerGroupAttribute:ScalingGroupServerGroupAttribute" } }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs for the primary network interface of instances in the scaling group\n" }, "suspendedProcesses": { "type": "array", "items": { "type": "string" }, "description": "Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupTag:ScalingGroupTag" } } }, "requiredInputs": [ "maxInstanceNumber", "minInstanceNumber", "scalingGroupName", "subnetIds" ], "stateInputs": { "description": "Input properties used for looking up and filtering ScalingGroup resources.\n", "properties": { "activeScalingConfigurationId": { "type": "string", "description": "ID of the scaling configuration bound to the scaling group\n" }, "createdTime": { "type": "string", "description": "Scaling group creation time\n" }, "dbInstanceIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the RDS database instance.\n" }, "defaultCooldown": { "type": "integer", "description": "Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.\n" }, "desireInstanceNumber": { "type": "integer", "description": "Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.\n" }, "healthCheckType": { "type": "string", "description": "Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.\n" }, "instanceRemovePolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupInstanceRemovePolicy:ScalingGroupInstanceRemovePolicy" } }, "instanceTerminatePolicy": { "type": "string", "description": "Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.\n" }, "instances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupInstance:ScalingGroupInstance" } }, "instancesDistribution": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupInstancesDistribution:ScalingGroupInstancesDistribution", "description": "Instance distribution policy.\n" }, "isEnableScalingGroup": { "type": "boolean", "description": "Whether to enable the scaling group. true: enabled. false: stopped\n" }, "launchTemplateId": { "type": "string", "description": "Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.\n" }, "launchTemplateOverrides": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupLaunchTemplateOverride:ScalingGroupLaunchTemplateOverride" } }, "launchTemplateVersion": { "type": "string", "description": "Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.\n" }, "lifecycleState": { "type": "string", "description": "Status of the scaling group. Active: enabled. InActive: not activated. Deleting: deleting. Locked: locked. CoolingDown: cooling down. Unknown: unknown status.\n" }, "loadBalancerHealthCheckGracePeriod": { "type": "integer", "description": "Grace period for CLB health checks on scaling group instances\n" }, "maxInstanceNumber": { "type": "integer", "description": "Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.\n" }, "minInstanceNumber": { "type": "integer", "description": "Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.\n" }, "multiAzPolicy": { "type": "string", "description": "Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.\n" }, "projectName": { "type": "string", "description": "Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID.\n" }, "scalingGroupName": { "type": "string", "description": "Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.\n" }, "scalingMode": { "type": "string", "description": "Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.\n" }, "serverGroupAttributes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupServerGroupAttribute:ScalingGroupServerGroupAttribute" } }, "stoppedInstanceCount": { "type": "integer", "description": "Number of instances in the scaling group that are in the disabled state.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnet IDs for the primary network interface of instances in the scaling group\n" }, "suspendedProcesses": { "type": "array", "items": { "type": "string" }, "description": "Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:autoscaling/ScalingGroupTag:ScalingGroupTag" } }, "totalInstanceCount": { "type": "integer", "description": "Number of instances currently in the scaling group\n" }, "updatedTime": { "type": "string", "description": "Scaling group update time.\n" }, "vpcId": { "type": "string", "description": "VPC ID to which the scaling group belongs\n" } }, "type": "object" } }, "volcenginecc:autoscaling/scalingLifecycleHook:ScalingLifecycleHook": { "description": "After the scaling group triggers scaling rules, health checks, and instance count checks, the lifecycle hook can suspend instances that are in the 'joining', 'removing', or 'disabling' state, putting them into the joining/removing suspended state. The instances are now in a waiting state, and you can perform custom operations during this period until the lifecycle hook times out or you manually end the suspension.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n scalingLifecycleHookDemo:\n type: volcenginecc:autoscaling:ScalingLifecycleHook\n name: ScalingLifecycleHookDemo\n properties:\n scalingGroupId: scg-yexxxxxxv6yn56hnvlm\n lifecycleHookName: ccapi-dx-1\n lifecycleHookType: SCALE_IN\n lifecycleHookTimeout: 1800\n lifecycleHookPolicy: CONTINUE\n lifecycleCommand:\n command_id: cmd-ybv3xxxxxxx51qxnx\n parameters: '{\"KEY_PAIR_ID\":\"1024\",\"KEY_PAIR_TIMEOUT\":\"360\"}'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:autoscaling/scalingLifecycleHook:ScalingLifecycleHook example \"scaling_group_id|lifecycle_hook_id\"\n```\n\n", "properties": { "lifecycleCommand": { "$ref": "#/types/volcenginecc:autoscaling/ScalingLifecycleHookLifecycleCommand:ScalingLifecycleHookLifecycleCommand", "description": "Cloud Assistant command information.\n" }, "lifecycleHookId": { "type": "string", "description": "Lifecycle hook ID.\n" }, "lifecycleHookName": { "type": "string", "description": "Lifecycle hook name, cannot be modified after creation. Values: Cannot start with a digit, hyphen, or underscore. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.\n" }, "lifecycleHookPolicy": { "type": "string", "description": "Policy executed after the instance suspension ends. Values: CONTINUE: Continue execution. REJECT: Abort subsequent actions. ROLLBACK: For elastic scale-in activities, the release of ECS instances is rejected and rollback is performed; for elastic scale-out activities, the effect is the same as REJECT.\n" }, "lifecycleHookTimeout": { "type": "integer", "description": "Duration for which the ECS instance remains suspended. After timeout, the suspended state ends automatically and scaling actions continue according to the execution policy. Please evaluate the processing time for custom operations and set an appropriate timeout. Values: 30 to 21600 (6 hours), unit: s, must be an integer.\n" }, "lifecycleHookType": { "type": "string", "description": "Type of scaling activity. When a specified type of scaling activity occurs, the lifecycle hook is triggered and the ECS instance is suspended. Values: SCALE*IN: Elastic scale-in activity. SCALE*OUT: Elastic scale-out activity.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID.\n" } }, "required": [ "lifecycleCommand", "lifecycleHookId", "lifecycleHookName", "lifecycleHookPolicy", "lifecycleHookTimeout", "lifecycleHookType", "scalingGroupId" ], "inputProperties": { "lifecycleCommand": { "$ref": "#/types/volcenginecc:autoscaling/ScalingLifecycleHookLifecycleCommand:ScalingLifecycleHookLifecycleCommand", "description": "Cloud Assistant command information.\n" }, "lifecycleHookName": { "type": "string", "description": "Lifecycle hook name, cannot be modified after creation. Values: Cannot start with a digit, hyphen, or underscore. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.\n" }, "lifecycleHookPolicy": { "type": "string", "description": "Policy executed after the instance suspension ends. Values: CONTINUE: Continue execution. REJECT: Abort subsequent actions. ROLLBACK: For elastic scale-in activities, the release of ECS instances is rejected and rollback is performed; for elastic scale-out activities, the effect is the same as REJECT.\n" }, "lifecycleHookTimeout": { "type": "integer", "description": "Duration for which the ECS instance remains suspended. After timeout, the suspended state ends automatically and scaling actions continue according to the execution policy. Please evaluate the processing time for custom operations and set an appropriate timeout. Values: 30 to 21600 (6 hours), unit: s, must be an integer.\n" }, "lifecycleHookType": { "type": "string", "description": "Type of scaling activity. When a specified type of scaling activity occurs, the lifecycle hook is triggered and the ECS instance is suspended. Values: SCALE*IN: Elastic scale-in activity. SCALE*OUT: Elastic scale-out activity.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID.\n" } }, "requiredInputs": [ "lifecycleHookName", "lifecycleHookPolicy", "lifecycleHookTimeout", "lifecycleHookType", "scalingGroupId" ], "stateInputs": { "description": "Input properties used for looking up and filtering ScalingLifecycleHook resources.\n", "properties": { "lifecycleCommand": { "$ref": "#/types/volcenginecc:autoscaling/ScalingLifecycleHookLifecycleCommand:ScalingLifecycleHookLifecycleCommand", "description": "Cloud Assistant command information.\n" }, "lifecycleHookId": { "type": "string", "description": "Lifecycle hook ID.\n" }, "lifecycleHookName": { "type": "string", "description": "Lifecycle hook name, cannot be modified after creation. Values: Cannot start with a digit, hyphen, or underscore. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.\n" }, "lifecycleHookPolicy": { "type": "string", "description": "Policy executed after the instance suspension ends. Values: CONTINUE: Continue execution. REJECT: Abort subsequent actions. ROLLBACK: For elastic scale-in activities, the release of ECS instances is rejected and rollback is performed; for elastic scale-out activities, the effect is the same as REJECT.\n" }, "lifecycleHookTimeout": { "type": "integer", "description": "Duration for which the ECS instance remains suspended. After timeout, the suspended state ends automatically and scaling actions continue according to the execution policy. Please evaluate the processing time for custom operations and set an appropriate timeout. Values: 30 to 21600 (6 hours), unit: s, must be an integer.\n" }, "lifecycleHookType": { "type": "string", "description": "Type of scaling activity. When a specified type of scaling activity occurs, the lifecycle hook is triggered and the ECS instance is suspended. Values: SCALE*IN: Elastic scale-in activity. SCALE*OUT: Elastic scale-out activity.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID.\n" } }, "type": "object" } }, "volcenginecc:autoscaling/scalingPolicy:ScalingPolicy": { "description": "Scaling rules define the conditions and methods for triggering scaling actions, including rule type, trigger time, scaling action, cooldown time. You can enable multiple scaling rules within the same scaling group. Scaling actions are executed when any rule type is met. If multiple rule types are met at the same time, manual scaling actions take priority.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n autoScalingScalingPolicyDemo:\n type: volcenginecc:autoscaling:ScalingPolicy\n name: AutoScalingScalingPolicyDemo\n properties:\n scalingGroupId: scg-ye9vu9ztco9ht5lxxxxx\n scalingPolicyName: AutoScalingScalingPolicyDemo\n scalingPolicyType: Scheduled\n adjustmentType: PercentChangeInCapacity\n adjustmentValue: 1\n cooldown: 86400\n scheduledPolicy:\n launch_time: 2025-12-21T11:58Z\n recurrence_end_time: \"\"\n recurrence_type: \"\"\n recurrence_value: \"\"\n isEnabledPolicy: false\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:autoscaling/scalingPolicy:ScalingPolicy example \"scaling_group_id|scaling_policy_id\"\n```\n\n", "properties": { "adjustmentType": { "type": "string", "description": "Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.\n" }, "adjustmentValue": { "type": "integer", "description": "Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.\n" }, "alarmPolicy": { "$ref": "#/types/volcenginecc:autoscaling/ScalingPolicyAlarmPolicy:ScalingPolicyAlarmPolicy", "description": "Detailed information about the alarm task.\n" }, "cooldown": { "type": "integer", "description": "Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.\n" }, "isEnabledPolicy": { "type": "boolean", "description": "Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID.\n" }, "scalingPolicyId": { "type": "string", "description": "Scaling rule ID.\n" }, "scalingPolicyName": { "type": "string", "description": "Name of the scaling rule.\n" }, "scalingPolicyType": { "type": "string", "description": "Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.\n" }, "scheduledPolicy": { "$ref": "#/types/volcenginecc:autoscaling/ScalingPolicyScheduledPolicy:ScalingPolicyScheduledPolicy", "description": "Detailed information for scheduled/recurring tasks.\n" }, "status": { "type": "string", "description": "Status of the scaling rule. Options: Active: enabled. Inactive: disabled. The scaling group must be in Active status.\n" } }, "required": [ "adjustmentType", "adjustmentValue", "alarmPolicy", "cooldown", "isEnabledPolicy", "scalingGroupId", "scalingPolicyId", "scalingPolicyName", "scalingPolicyType", "scheduledPolicy", "status" ], "inputProperties": { "adjustmentType": { "type": "string", "description": "Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.\n" }, "adjustmentValue": { "type": "integer", "description": "Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.\n" }, "alarmPolicy": { "$ref": "#/types/volcenginecc:autoscaling/ScalingPolicyAlarmPolicy:ScalingPolicyAlarmPolicy", "description": "Detailed information about the alarm task.\n" }, "cooldown": { "type": "integer", "description": "Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.\n" }, "isEnabledPolicy": { "type": "boolean", "description": "Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID.\n" }, "scalingPolicyName": { "type": "string", "description": "Name of the scaling rule.\n" }, "scalingPolicyType": { "type": "string", "description": "Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.\n" }, "scheduledPolicy": { "$ref": "#/types/volcenginecc:autoscaling/ScalingPolicyScheduledPolicy:ScalingPolicyScheduledPolicy", "description": "Detailed information for scheduled/recurring tasks.\n" } }, "requiredInputs": [ "scalingGroupId", "scalingPolicyName", "scalingPolicyType" ], "stateInputs": { "description": "Input properties used for looking up and filtering ScalingPolicy resources.\n", "properties": { "adjustmentType": { "type": "string", "description": "Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.\n" }, "adjustmentValue": { "type": "integer", "description": "Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.\n" }, "alarmPolicy": { "$ref": "#/types/volcenginecc:autoscaling/ScalingPolicyAlarmPolicy:ScalingPolicyAlarmPolicy", "description": "Detailed information about the alarm task.\n" }, "cooldown": { "type": "integer", "description": "Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.\n" }, "isEnabledPolicy": { "type": "boolean", "description": "Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.\n" }, "scalingGroupId": { "type": "string", "description": "Scaling group ID.\n" }, "scalingPolicyId": { "type": "string", "description": "Scaling rule ID.\n" }, "scalingPolicyName": { "type": "string", "description": "Name of the scaling rule.\n" }, "scalingPolicyType": { "type": "string", "description": "Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.\n" }, "scheduledPolicy": { "$ref": "#/types/volcenginecc:autoscaling/ScalingPolicyScheduledPolicy:ScalingPolicyScheduledPolicy", "description": "Detailed information for scheduled/recurring tasks.\n" }, "status": { "type": "string", "description": "Status of the scaling rule. Options: Active: enabled. Inactive: disabled. The scaling group must be in Active status.\n" } }, "type": "object" } }, "volcenginecc:bmq/group:Group": { "description": "A group of consumers with the same Group ID. When multiple consumers in the same Group consume a Topic, each message is delivered to only one consumer, enabling load balancing. Using Groups ensures that messages in a Topic are consumed in parallel.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n bMQGroupDemo:\n type: volcenginecc:bmq:Group\n name: BMQGroupDemo\n properties:\n description: this is test group\n groupName: cBMQGroupDemo\n instanceId: bmq-4ld4vpjzd32tq1gxxxxx\n resetInfo:\n topic_id: 5f81fcab96cb46c7955659fdxxxxx\n reset_by: OFFSET\n offset_type: LATEST\n reset_value: 4\n partition_id: 1\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:bmq/group:Group example \"group_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Consumer Group creation time\n" }, "description": { "type": "string", "description": "Consumer Group description\n" }, "groupId": { "type": "string", "description": "Consumer Group ID\n" }, "groupName": { "type": "string", "description": "Set a custom Consumer Group name. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.\n" }, "instanceId": { "type": "string", "description": "BMQ instance ID\n" }, "ownerId": { "type": "string", "description": "User ID of the Consumer Group owner\n" }, "ownerName": { "type": "string", "description": "Name of the Consumer Group owner\n" }, "resetInfo": { "$ref": "#/types/volcenginecc:bmq/GroupResetInfo:GroupResetInfo", "description": "Reset consumption offset information\n" }, "status": { "type": "string", "description": "Consumer Group status\n" }, "topicInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/GroupTopicInfo:GroupTopicInfo" } } }, "required": [ "createdTime", "description", "groupId", "groupName", "instanceId", "ownerId", "ownerName", "resetInfo", "status", "topicInfos" ], "inputProperties": { "description": { "type": "string", "description": "Consumer Group description\n" }, "groupName": { "type": "string", "description": "Set a custom Consumer Group name. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.\n" }, "instanceId": { "type": "string", "description": "BMQ instance ID\n" }, "resetInfo": { "$ref": "#/types/volcenginecc:bmq/GroupResetInfo:GroupResetInfo", "description": "Reset consumption offset information\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Group resources.\n", "properties": { "createdTime": { "type": "string", "description": "Consumer Group creation time\n" }, "description": { "type": "string", "description": "Consumer Group description\n" }, "groupId": { "type": "string", "description": "Consumer Group ID\n" }, "groupName": { "type": "string", "description": "Set a custom Consumer Group name. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.\n" }, "instanceId": { "type": "string", "description": "BMQ instance ID\n" }, "ownerId": { "type": "string", "description": "User ID of the Consumer Group owner\n" }, "ownerName": { "type": "string", "description": "Name of the Consumer Group owner\n" }, "resetInfo": { "$ref": "#/types/volcenginecc:bmq/GroupResetInfo:GroupResetInfo", "description": "Reset consumption offset information\n" }, "status": { "type": "string", "description": "Consumer Group status\n" }, "topicInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/GroupTopicInfo:GroupTopicInfo" } } }, "type": "object" } }, "volcenginecc:bmq/instance:Instance": { "description": "The cloud-native messaging engine is 100% compatible with the Apache Kafka protocol. It offers a fully managed, high-throughput, low-latency, highly available, highly scalable, and highly stable distributed messaging engine service based on cloud-native architecture. Supports flexible and dynamic scaling, integrated stream and batch processing, and provides enterprise-grade real-time stream data processing capabilities for large-scale data. Helps you build the 'central nervous system' for data processing, widely used in scenarios such as log collection, data aggregation, and offline data analysis.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst bMQInstanceDemo = new volcenginecc.bmq.Instance(\"BMQInstanceDemo\", {\n name: \"BMQInstanceDemo\",\n billingType: \"POST\",\n projectName: \"default\",\n specification: \"bmq.standard\",\n vpcId: \"vpc-miltj87lh2ww5smt1bxxxxx\",\n messageRetention: 1,\n endpoints: {\n \"public\": {\n eipId: \"eip-3nriu2y2ufwu8931exxxxx\",\n },\n overlay: {\n vpcIds: [\"vpc-miltj87lh2ww5smt1bxxxxx\"],\n },\n },\n securityGroupIdLists: [\"sg-3nqnz9en1ucxs931eaxxxxx\"],\n subnetIdLists: [\"subnet-w02wsq25fitc865ykaxxxxx\"],\n zoneIdLists: [\"cn-beijing-a\"],\n tags: [{\n key: \"env\",\n type: \"CUSTOM\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nb_mq_instance_demo = volcenginecc.bmq.Instance(\"BMQInstanceDemo\",\n name=\"BMQInstanceDemo\",\n billing_type=\"POST\",\n project_name=\"default\",\n specification=\"bmq.standard\",\n vpc_id=\"vpc-miltj87lh2ww5smt1bxxxxx\",\n message_retention=1,\n endpoints={\n \"public\": {\n \"eip_id\": \"eip-3nriu2y2ufwu8931exxxxx\",\n },\n \"overlay\": {\n \"vpc_ids\": [\"vpc-miltj87lh2ww5smt1bxxxxx\"],\n },\n },\n security_group_id_lists=[\"sg-3nqnz9en1ucxs931eaxxxxx\"],\n subnet_id_lists=[\"subnet-w02wsq25fitc865ykaxxxxx\"],\n zone_id_lists=[\"cn-beijing-a\"],\n tags=[{\n \"key\": \"env\",\n \"type\": \"CUSTOM\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var bMQInstanceDemo = new Volcenginecc.Bmq.Instance(\"BMQInstanceDemo\", new()\n {\n Name = \"BMQInstanceDemo\",\n BillingType = \"POST\",\n ProjectName = \"default\",\n Specification = \"bmq.standard\",\n VpcId = \"vpc-miltj87lh2ww5smt1bxxxxx\",\n MessageRetention = 1,\n Endpoints = new Volcenginecc.Bmq.Inputs.InstanceEndpointsArgs\n {\n Public = new Volcenginecc.Bmq.Inputs.InstanceEndpointsPublicArgs\n {\n EipId = \"eip-3nriu2y2ufwu8931exxxxx\",\n },\n Overlay = new Volcenginecc.Bmq.Inputs.InstanceEndpointsOverlayArgs\n {\n VpcIds = new[]\n {\n \"vpc-miltj87lh2ww5smt1bxxxxx\",\n },\n },\n },\n SecurityGroupIdLists = new[]\n {\n \"sg-3nqnz9en1ucxs931eaxxxxx\",\n },\n SubnetIdLists = new[]\n {\n \"subnet-w02wsq25fitc865ykaxxxxx\",\n },\n ZoneIdLists = new[]\n {\n \"cn-beijing-a\",\n },\n Tags = new[]\n {\n new Volcenginecc.Bmq.Inputs.InstanceTagArgs\n {\n Key = \"env\",\n Type = \"CUSTOM\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/bmq\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := bmq.NewInstance(ctx, \"BMQInstanceDemo\", \u0026bmq.InstanceArgs{\n\t\t\tName: pulumi.String(\"BMQInstanceDemo\"),\n\t\t\tBillingType: pulumi.String(\"POST\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tSpecification: pulumi.String(\"bmq.standard\"),\n\t\t\tVpcId: pulumi.String(\"vpc-miltj87lh2ww5smt1bxxxxx\"),\n\t\t\tMessageRetention: pulumi.Int(1),\n\t\t\tEndpoints: \u0026bmq.InstanceEndpointsArgs{\n\t\t\t\tPublic: \u0026bmq.InstanceEndpointsPublicArgs{\n\t\t\t\t\tEipId: pulumi.String(\"eip-3nriu2y2ufwu8931exxxxx\"),\n\t\t\t\t},\n\t\t\t\tOverlay: \u0026bmq.InstanceEndpointsOverlayArgs{\n\t\t\t\t\tVpcIds: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"vpc-miltj87lh2ww5smt1bxxxxx\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tSecurityGroupIdLists: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"sg-3nqnz9en1ucxs931eaxxxxx\"),\n\t\t\t},\n\t\t\tSubnetIdLists: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"subnet-w02wsq25fitc865ykaxxxxx\"),\n\t\t\t},\n\t\t\tZoneIdLists: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"cn-beijing-a\"),\n\t\t\t},\n\t\t\tTags: bmq.InstanceTagArray{\n\t\t\t\t\u0026bmq.InstanceTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tType: pulumi.String(\"CUSTOM\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.bmq.Instance;\nimport com.volcengine.volcenginecc.bmq.InstanceArgs;\nimport com.pulumi.volcenginecc.bmq.inputs.InstanceEndpointsArgs;\nimport com.pulumi.volcenginecc.bmq.inputs.InstanceEndpointsPublicArgs;\nimport com.pulumi.volcenginecc.bmq.inputs.InstanceEndpointsOverlayArgs;\nimport com.pulumi.volcenginecc.bmq.inputs.InstanceTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var bMQInstanceDemo = new Instance(\"bMQInstanceDemo\", InstanceArgs.builder()\n .name(\"BMQInstanceDemo\")\n .billingType(\"POST\")\n .projectName(\"default\")\n .specification(\"bmq.standard\")\n .vpcId(\"vpc-miltj87lh2ww5smt1bxxxxx\")\n .messageRetention(1)\n .endpoints(InstanceEndpointsArgs.builder()\n .public_(InstanceEndpointsPublicArgs.builder()\n .eipId(\"eip-3nriu2y2ufwu8931exxxxx\")\n .build())\n .overlay(InstanceEndpointsOverlayArgs.builder()\n .vpcIds(\"vpc-miltj87lh2ww5smt1bxxxxx\")\n .build())\n .build())\n .securityGroupIdLists(\"sg-3nqnz9en1ucxs931eaxxxxx\")\n .subnetIdLists(\"subnet-w02wsq25fitc865ykaxxxxx\")\n .zoneIdLists(\"cn-beijing-a\")\n .tags(InstanceTagArgs.builder()\n .key(\"env\")\n .type(\"CUSTOM\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n bMQInstanceDemo:\n type: volcenginecc:bmq:Instance\n name: BMQInstanceDemo\n properties:\n name: BMQInstanceDemo\n billingType: POST\n projectName: default\n specification: bmq.standard\n vpcId: vpc-miltj87lh2ww5smt1bxxxxx\n messageRetention: 1\n endpoints:\n public:\n eipId: eip-3nriu2y2ufwu8931exxxxx\n overlay:\n vpcIds:\n - vpc-miltj87lh2ww5smt1bxxxxx\n securityGroupIdLists:\n - sg-3nqnz9en1ucxs931eaxxxxx\n subnetIdLists:\n - subnet-w02wsq25fitc865ykaxxxxx\n zoneIdLists:\n - cn-beijing-a\n tags:\n - key: env\n type: CUSTOM\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:bmq/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "autoRenew": { "type": "string", "description": "Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.\n" }, "billingPeriod": { "type": "string", "description": "Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription\n" }, "billingType": { "type": "string", "description": "Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription\n" }, "createdTime": { "type": "string", "description": "Instance creation time\n" }, "description": { "type": "string", "description": "Instance description\n" }, "eipId": { "type": "string", "description": "Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region\n" }, "endpoints": { "$ref": "#/types/volcenginecc:bmq/InstanceEndpoints:InstanceEndpoints", "description": "Response data for all instance endpoints\n" }, "expirationTime": { "type": "string", "description": "Instance expiration time\n" }, "groupLimit": { "type": "integer", "description": "Maximum number of consumer groups per instance\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "messageRetention": { "type": "integer", "description": "Message retention period for all Topics under the instance, in hours\n" }, "name": { "type": "string", "description": "Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters\n" }, "partitionLimit": { "type": "integer", "description": "Maximum number of partitions per instance\n" }, "projectName": { "type": "string", "description": "Project name associated with the instance\n" }, "resourceTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/InstanceResourceTag:InstanceResourceTag" } }, "resources": { "$ref": "#/types/volcenginecc:bmq/InstanceResources:InstanceResources", "description": "Instance resource statistics response data\n" }, "securityGroupIdLists": { "type": "array", "items": { "type": "string" }, "description": "Security group list used by the instance\n" }, "specification": { "type": "string", "description": "Instance specification\n" }, "status": { "type": "string", "description": "Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATION*FAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFY*FAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITY*EXPAXION*FAILED: Capacity expansion failed, EXPANDING*CAPACITY: Expanding capacity, CANCEL*EXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid\n" }, "subnetIdLists": { "type": "array", "items": { "type": "string" }, "description": "Subnet list used by the instance\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/InstanceTag:InstanceTag" } }, "times": { "type": "integer", "description": "Purchase duration for yearly/monthly subscription instances, in months\n" }, "topicLimit": { "type": "integer", "description": "Maximum number of Topics per instance\n" }, "vpcId": { "type": "string", "description": "VPC ID where the instance is located\n" }, "zoneIdLists": { "type": "array", "items": { "type": "string" }, "description": "List of availability zones for the instance\n" } }, "required": [ "autoRenew", "billingPeriod", "billingType", "createdTime", "description", "eipId", "endpoints", "expirationTime", "groupLimit", "instanceId", "messageRetention", "name", "partitionLimit", "projectName", "resourceTags", "resources", "securityGroupIdLists", "specification", "status", "subnetIdLists", "tags", "times", "topicLimit", "vpcId", "zoneIdLists" ], "inputProperties": { "autoRenew": { "type": "string", "description": "Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.\n" }, "billingPeriod": { "type": "string", "description": "Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription\n" }, "billingType": { "type": "string", "description": "Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription\n" }, "description": { "type": "string", "description": "Instance description\n" }, "eipId": { "type": "string", "description": "Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region\n" }, "endpoints": { "$ref": "#/types/volcenginecc:bmq/InstanceEndpoints:InstanceEndpoints", "description": "Response data for all instance endpoints\n" }, "messageRetention": { "type": "integer", "description": "Message retention period for all Topics under the instance, in hours\n" }, "name": { "type": "string", "description": "Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters\n" }, "projectName": { "type": "string", "description": "Project name associated with the instance\n" }, "securityGroupIdLists": { "type": "array", "items": { "type": "string" }, "description": "Security group list used by the instance\n" }, "specification": { "type": "string", "description": "Instance specification\n" }, "subnetIdLists": { "type": "array", "items": { "type": "string" }, "description": "Subnet list used by the instance\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/InstanceTag:InstanceTag" } }, "times": { "type": "integer", "description": "Purchase duration for yearly/monthly subscription instances, in months\n" }, "vpcId": { "type": "string", "description": "VPC ID where the instance is located\n" }, "zoneIdLists": { "type": "array", "items": { "type": "string" }, "description": "List of availability zones for the instance\n" } }, "requiredInputs": [ "billingType", "name", "projectName", "securityGroupIdLists", "specification", "subnetIdLists", "vpcId", "zoneIdLists" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "autoRenew": { "type": "string", "description": "Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.\n" }, "billingPeriod": { "type": "string", "description": "Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription\n" }, "billingType": { "type": "string", "description": "Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription\n" }, "createdTime": { "type": "string", "description": "Instance creation time\n" }, "description": { "type": "string", "description": "Instance description\n" }, "eipId": { "type": "string", "description": "Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region\n" }, "endpoints": { "$ref": "#/types/volcenginecc:bmq/InstanceEndpoints:InstanceEndpoints", "description": "Response data for all instance endpoints\n" }, "expirationTime": { "type": "string", "description": "Instance expiration time\n" }, "groupLimit": { "type": "integer", "description": "Maximum number of consumer groups per instance\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "messageRetention": { "type": "integer", "description": "Message retention period for all Topics under the instance, in hours\n" }, "name": { "type": "string", "description": "Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters\n" }, "partitionLimit": { "type": "integer", "description": "Maximum number of partitions per instance\n" }, "projectName": { "type": "string", "description": "Project name associated with the instance\n" }, "resourceTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/InstanceResourceTag:InstanceResourceTag" } }, "resources": { "$ref": "#/types/volcenginecc:bmq/InstanceResources:InstanceResources", "description": "Instance resource statistics response data\n" }, "securityGroupIdLists": { "type": "array", "items": { "type": "string" }, "description": "Security group list used by the instance\n" }, "specification": { "type": "string", "description": "Instance specification\n" }, "status": { "type": "string", "description": "Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATION*FAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFY*FAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITY*EXPAXION*FAILED: Capacity expansion failed, EXPANDING*CAPACITY: Expanding capacity, CANCEL*EXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid\n" }, "subnetIdLists": { "type": "array", "items": { "type": "string" }, "description": "Subnet list used by the instance\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:bmq/InstanceTag:InstanceTag" } }, "times": { "type": "integer", "description": "Purchase duration for yearly/monthly subscription instances, in months\n" }, "topicLimit": { "type": "integer", "description": "Maximum number of Topics per instance\n" }, "vpcId": { "type": "string", "description": "VPC ID where the instance is located\n" }, "zoneIdLists": { "type": "array", "items": { "type": "string" }, "description": "List of availability zones for the instance\n" } }, "type": "object" } }, "volcenginecc:cbr/backupPlan:BackupPlan": { "description": "To enable automatic backup for backup sources, you can create a backup plan, associate backup sources and backup policies within the plan, specify backup storage space, and set backup data retention rules. After creating the backup plan, the system will automatically back up the specified sources in a unified manner according to the associated backup policy configuration\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cBRBackupPlanDemo:\n type: volcenginecc:cbr:BackupPlan\n name: CBRBackupPlanDemo\n properties:\n name: CBRBackupPlanDemo\n policyId: policy-krn3z1wf9ubujxxxxx\n resourceLists:\n - resource_type: ECS\n resource_id: res-krn4bq3sctbwvxxxxx\n meta_information:\n vepfsMeta: \"\"\n ecsMeta: '{\"AutoBackupAllAttachedVolumes\":true,\"VolumeList\":[{\"VolumeId\":\"vol-3wt6m9uygg4kgxxxxx\",\"VolumeName\":\"emr-d6af13acb6966xxxxx-volume-1-2\",\"VolumeType\":\"ESSD_FlexPL\"},{\"VolumeId\":\"vol-3wt6m9vh3a3qxxxxx\",\"VolumeName\":\"emr-d6af13acb6966xxxxx-volume-2-2\",\"VolumeType\":\"ESSD_FlexPL\"}]}'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cbr/backupPlan:BackupPlan example \"plan_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account ID that created this plan\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "name": { "type": "string", "description": "Backup Plan Name\n" }, "planId": { "type": "string", "description": "Backup Plan ID\n" }, "policy": { "$ref": "#/types/volcenginecc:cbr/BackupPlanPolicy:BackupPlanPolicy", "description": "Backup Policy\n" }, "policyId": { "type": "string", "description": "Backup Policy ID\n" }, "resourceLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cbr/BackupPlanResourceList:BackupPlanResourceList" } }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "required": [ "accountId", "createdTime", "name", "planId", "policy", "policyId", "resourceLists", "updatedTime" ], "inputProperties": { "name": { "type": "string", "description": "Backup Plan Name\n" }, "policyId": { "type": "string", "description": "Backup Policy ID\n" }, "resourceLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cbr/BackupPlanResourceList:BackupPlanResourceList" } } }, "requiredInputs": [ "name", "resourceLists" ], "stateInputs": { "description": "Input properties used for looking up and filtering BackupPlan resources.\n", "properties": { "accountId": { "type": "string", "description": "Account ID that created this plan\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "name": { "type": "string", "description": "Backup Plan Name\n" }, "planId": { "type": "string", "description": "Backup Plan ID\n" }, "policy": { "$ref": "#/types/volcenginecc:cbr/BackupPlanPolicy:BackupPlanPolicy", "description": "Backup Policy\n" }, "policyId": { "type": "string", "description": "Backup Policy ID\n" }, "resourceLists": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cbr/BackupPlanResourceList:BackupPlanResourceList" } }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "type": "object" } }, "volcenginecc:cbr/backupPolicy:BackupPolicy": { "description": "The backup policy defines information such as backup cycle and backup type. Subsequently, backup plans associate the backup policy with backup storage space to achieve automatic backup\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@pulumi/volcenginecc\";\n\nconst cBRBackupPolicyDemo = new volcenginecc.index.CbrBackuppolicy(\"CBRBackupPolicyDemo\", {\n backupType: \"INCREMENTAL\",\n crontab: \"0 2,1,0 * * 1,2\",\n enablePolicy: false,\n name: \"CBRBackupPolicyDemo\",\n retentionDay: 67,\n retentionNumMax: -1,\n retentionNumMin: 2,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_br_backup_policy_demo = volcenginecc.index.CbrBackuppolicy(\"CBRBackupPolicyDemo\",\n backup_type=INCREMENTAL,\n crontab=0 2,1,0 * * 1,2,\n enable_policy=False,\n name=CBRBackupPolicyDemo,\n retention_day=67,\n retention_num_max=-1,\n retention_num_min=2)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cBRBackupPolicyDemo = new Volcenginecc.Index.CbrBackuppolicy(\"CBRBackupPolicyDemo\", new()\n {\n BackupType = \"INCREMENTAL\",\n Crontab = \"0 2,1,0 * * 1,2\",\n EnablePolicy = false,\n Name = \"CBRBackupPolicyDemo\",\n RetentionDay = 67,\n RetentionNumMax = -1,\n RetentionNumMin = 2,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := volcenginecc.NewCbrBackuppolicy(ctx, \"CBRBackupPolicyDemo\", \u0026volcenginecc.CbrBackuppolicyArgs{\n\t\t\tBackupType: \"INCREMENTAL\",\n\t\t\tCrontab: \"0 2,1,0 * * 1,2\",\n\t\t\tEnablePolicy: false,\n\t\t\tName: \"CBRBackupPolicyDemo\",\n\t\t\tRetentionDay: 67,\n\t\t\tRetentionNumMax: -1,\n\t\t\tRetentionNumMin: 2,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.volcenginecc.cbrBackuppolicy;\nimport com.pulumi.volcenginecc.cbrBackuppolicyArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cBRBackupPolicyDemo = new CbrBackuppolicy(\"cBRBackupPolicyDemo\", CbrBackuppolicyArgs.builder()\n .backupType(\"INCREMENTAL\")\n .crontab(\"0 2,1,0 * * 1,2\")\n .enablePolicy(false)\n .name(\"CBRBackupPolicyDemo\")\n .retentionDay(67)\n .retentionNumMax(-1)\n .retentionNumMin(2)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cBRBackupPolicyDemo:\n type: volcenginecc:cbrBackuppolicy\n name: CBRBackupPolicyDemo\n properties:\n backupType: INCREMENTAL\n crontab: 0 2,1,0 * * 1,2\n enablePolicy: false\n name: CBRBackupPolicyDemo\n retentionDay: 67\n retentionNumMax: -1\n retentionNumMin: 2\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cbr/backupPolicy:BackupPolicy example \"policy_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account ID that created this policy\n" }, "backupType": { "type": "string", "description": "Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "crontab": { "type": "string", "description": "Backup cycle, using a crontab expression\n" }, "enablePolicy": { "type": "boolean", "description": "Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled\n" }, "name": { "type": "string", "description": "Policy Name\n" }, "planNumber": { "type": "integer", "description": "Number of backup plans associated with this policy\n" }, "policyId": { "type": "string", "description": "Backup Policy ID\n" }, "retentionDay": { "type": "integer", "description": "Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]\n" }, "retentionNumMax": { "type": "integer", "description": "Maximum number of restore points retained\n" }, "retentionNumMin": { "type": "integer", "description": "Minimum restore point retention limit\n" }, "updatedTime": { "type": "string", "description": "Update time\n" } }, "required": [ "accountId", "backupType", "createdTime", "crontab", "enablePolicy", "name", "planNumber", "policyId", "retentionDay", "retentionNumMax", "retentionNumMin", "updatedTime" ], "inputProperties": { "backupType": { "type": "string", "description": "Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup\n" }, "crontab": { "type": "string", "description": "Backup cycle, using a crontab expression\n" }, "enablePolicy": { "type": "boolean", "description": "Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled\n" }, "name": { "type": "string", "description": "Policy Name\n" }, "retentionDay": { "type": "integer", "description": "Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]\n" }, "retentionNumMax": { "type": "integer", "description": "Maximum number of restore points retained\n" }, "retentionNumMin": { "type": "integer", "description": "Minimum restore point retention limit\n" } }, "requiredInputs": [ "backupType", "crontab", "enablePolicy", "name", "retentionDay", "retentionNumMax", "retentionNumMin" ], "stateInputs": { "description": "Input properties used for looking up and filtering BackupPolicy resources.\n", "properties": { "accountId": { "type": "string", "description": "Account ID that created this policy\n" }, "backupType": { "type": "string", "description": "Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "crontab": { "type": "string", "description": "Backup cycle, using a crontab expression\n" }, "enablePolicy": { "type": "boolean", "description": "Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled\n" }, "name": { "type": "string", "description": "Policy Name\n" }, "planNumber": { "type": "integer", "description": "Number of backup plans associated with this policy\n" }, "policyId": { "type": "string", "description": "Backup Policy ID\n" }, "retentionDay": { "type": "integer", "description": "Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]\n" }, "retentionNumMax": { "type": "integer", "description": "Maximum number of restore points retained\n" }, "retentionNumMin": { "type": "integer", "description": "Minimum restore point retention limit\n" }, "updatedTime": { "type": "string", "description": "Update time\n" } }, "type": "object" } }, "volcenginecc:cbr/backupResource:BackupResource": { "description": "Refers to the backup object, which is the starting point for cloud backup operations. It can be a computing resource, service instance, or a group of collaborative services and resources from the backup source product, such as ECS full instance, cloud disk, or object storage bucket.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cBRBackupResourceDemo = new volcenginecc.cbr.BackupResource(\"CBRBackupResourceDemo\", {\n instanceId: \"i-yebwmo5pfkcva4xxxxx\",\n instanceName: \"CBRBackupResourceDemo\",\n resourceType: \"ECS\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_br_backup_resource_demo = volcenginecc.cbr.BackupResource(\"CBRBackupResourceDemo\",\n instance_id=\"i-yebwmo5pfkcva4xxxxx\",\n instance_name=\"CBRBackupResourceDemo\",\n resource_type=\"ECS\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cBRBackupResourceDemo = new Volcenginecc.Cbr.BackupResource(\"CBRBackupResourceDemo\", new()\n {\n InstanceId = \"i-yebwmo5pfkcva4xxxxx\",\n InstanceName = \"CBRBackupResourceDemo\",\n ResourceType = \"ECS\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cbr\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cbr.NewBackupResource(ctx, \"CBRBackupResourceDemo\", \u0026cbr.BackupResourceArgs{\n\t\t\tInstanceId: pulumi.String(\"i-yebwmo5pfkcva4xxxxx\"),\n\t\t\tInstanceName: pulumi.String(\"CBRBackupResourceDemo\"),\n\t\t\tResourceType: pulumi.String(\"ECS\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cbr.BackupResource;\nimport com.volcengine.volcenginecc.cbr.BackupResourceArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cBRBackupResourceDemo = new BackupResource(\"cBRBackupResourceDemo\", BackupResourceArgs.builder()\n .instanceId(\"i-yebwmo5pfkcva4xxxxx\")\n .instanceName(\"CBRBackupResourceDemo\")\n .resourceType(\"ECS\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cBRBackupResourceDemo:\n type: volcenginecc:cbr:BackupResource\n name: CBRBackupResourceDemo\n properties:\n instanceId: i-yebwmo5pfkcva4xxxxx\n instanceName: CBRBackupResourceDemo\n resourceType: ECS\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cbr/backupResource:BackupResource example \"resource_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account ID that created this backup source\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance Name\n" }, "metaInformation": { "$ref": "#/types/volcenginecc:cbr/BackupResourceMetaInformation:BackupResourceMetaInformation", "description": "Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.\n" }, "plans": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cbr/BackupResourcePlan:BackupResourcePlan" } }, "recoveryPointNumber": { "type": "integer", "description": "Number of Restore Points\n" }, "resourceId": { "type": "string", "description": "Backup Source ID\n" }, "resourceType": { "type": "string", "description": "Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.\n" }, "status": { "type": "string", "description": "Backup source status. Possible values: AVAILABLE, REMOVING, BEING*BACKED*UP, RECOVERING, CREATING, ERROR, UNAVAILABLE.\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" }, "usedCapacityInBytes": { "type": "integer", "description": "Bytes Already Backed Up\n" } }, "required": [ "accountId", "createdTime", "instanceId", "instanceName", "metaInformation", "plans", "recoveryPointNumber", "resourceId", "resourceType", "status", "updatedTime", "usedCapacityInBytes" ], "inputProperties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance Name\n" }, "resourceType": { "type": "string", "description": "Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.\n" } }, "requiredInputs": [ "instanceId", "instanceName", "resourceType" ], "stateInputs": { "description": "Input properties used for looking up and filtering BackupResource resources.\n", "properties": { "accountId": { "type": "string", "description": "Account ID that created this backup source\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance Name\n" }, "metaInformation": { "$ref": "#/types/volcenginecc:cbr/BackupResourceMetaInformation:BackupResourceMetaInformation", "description": "Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.\n" }, "plans": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cbr/BackupResourcePlan:BackupResourcePlan" } }, "recoveryPointNumber": { "type": "integer", "description": "Number of Restore Points\n" }, "resourceId": { "type": "string", "description": "Backup Source ID\n" }, "resourceType": { "type": "string", "description": "Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.\n" }, "status": { "type": "string", "description": "Backup source status. Possible values: AVAILABLE, REMOVING, BEING*BACKED*UP, RECOVERING, CREATING, ERROR, UNAVAILABLE.\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" }, "usedCapacityInBytes": { "type": "integer", "description": "Bytes Already Backed Up\n" } }, "type": "object" } }, "volcenginecc:cbr/vault:Vault": { "description": "Used to store your backup data\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cBRVaultDemo = new volcenginecc.cbr.Vault(\"CBRVaultDemo\", {\n vaultName: \"CBRVaultDemo\",\n projectName: \"default\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_br_vault_demo = volcenginecc.cbr.Vault(\"CBRVaultDemo\",\n vault_name=\"CBRVaultDemo\",\n project_name=\"default\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cBRVaultDemo = new Volcenginecc.Cbr.Vault(\"CBRVaultDemo\", new()\n {\n VaultName = \"CBRVaultDemo\",\n ProjectName = \"default\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cbr\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cbr.NewVault(ctx, \"CBRVaultDemo\", \u0026cbr.VaultArgs{\n\t\t\tVaultName: pulumi.String(\"CBRVaultDemo\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cbr.Vault;\nimport com.volcengine.volcenginecc.cbr.VaultArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cBRVaultDemo = new Vault(\"cBRVaultDemo\", VaultArgs.builder()\n .vaultName(\"CBRVaultDemo\")\n .projectName(\"default\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cBRVaultDemo:\n type: volcenginecc:cbr:Vault\n name: CBRVaultDemo\n properties:\n vaultName: CBRVaultDemo\n projectName: default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cbr/vault:Vault example \"vault_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "endpoint": { "type": "string", "description": "Access Domain Name\n" }, "projectName": { "type": "string", "description": "Project Name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cbr/VaultTag:VaultTag" } }, "vaultId": { "type": "string", "description": "Backup Repository ID\n" }, "vaultName": { "type": "string", "description": "Backup Repository Name\n" } }, "required": [ "createdTime", "endpoint", "projectName", "tags", "vaultId", "vaultName" ], "inputProperties": { "projectName": { "type": "string", "description": "Project Name\n" }, "vaultName": { "type": "string", "description": "Backup Repository Name\n" } }, "requiredInputs": [ "vaultName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Vault resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "endpoint": { "type": "string", "description": "Access Domain Name\n" }, "projectName": { "type": "string", "description": "Project Name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cbr/VaultTag:VaultTag" } }, "vaultId": { "type": "string", "description": "Backup Repository ID\n" }, "vaultName": { "type": "string", "description": "Backup Repository Name\n" } }, "type": "object" } }, "volcenginecc:cdn/domain:Domain": { "description": "An accelerated domain name is the domain you want to speed up content delivery for. After you add the domain to the content delivery network, it becomes an accelerated domain name in the CDN. The CDN assigns a CNAME to this domain. Once you create a DNS record to resolve your domain to this CNAME, requests sent by users to your domain are routed to your accelerated domain name, enabling faster content delivery.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cDNDomainDemo:\n type: volcenginecc:cdn:Domain\n name: CDNDomainDemo\n properties:\n areaAccessRule:\n rule_type: \"\"\n switch: false\n caches:\n - cache_action:\n action: cache\n defaultPolicy: force_cache\n ttl: 2\n condition:\n conditionRule:\n - name: \"\"\n object: path\n operator: match\n type: url\n value: /index.shtml;/index.html;/index.php;/index.aspx;/index.htm;/;/C\n connective: OR\n - cache_action:\n action: cache\n defaultPolicy: default\n ttl: 0\n condition:\n conditionRule:\n - name: \"\"\n object: filetype\n operator: match\n type: url\n value: php;jsp;asp;aspx\n connective: OR\n - cache_action:\n action: cache\n defaultPolicy: default\n ttl: 2.592e+06\n condition:\n conditionRule:\n - name: \"\"\n object: directory\n operator: match\n type: url\n value: /\n connective: OR\n cacheKeys:\n - cache_key_action:\n cacheKeyComponents:\n - action: exclude\n ignoreCase: false\n object: queryString\n subobject: '*'\n condition:\n conditionRule:\n - name: \"\"\n object: path\n operator: match\n type: url\n value: /A\n connective: OR\n - cache_key_action:\n cacheKeyComponents:\n - action: includePart\n ignoreCase: true\n object: queryString\n subobject: A\n condition:\n conditionRule:\n - name: \"\"\n object: filetype\n operator: match\n type: url\n value: jpg;jpeg;png;gif;webp;bmp;ico;tiff;htm;shtml;html;css;js;xml;json;bin;zip;rar;ipa;apk;sis;xap;msi;exe;cab;7z;txt;wmv;mp3;wma;ogg;flv;mp4;avi;mpg;mpeg;f4v;hlv;rmvb;rm;3pg;img;m3u8;ts;swf;A\n connective: OR\n - cache_key_action:\n cacheKeyComponents:\n - action: include\n ignoreCase: false\n object: queryString\n subobject: '*'\n condition:\n conditionRule:\n - name: \"\"\n object: directory\n operator: match\n type: url\n value: /\n connective: OR\n compression:\n compression_rules:\n - compressionAction:\n compressionFormat: all\n compressionTarget: '*'\n compressionType:\n - gzip\n - br\n maxFileSizeKb: 2048\n minFileSizeKb: 0\n condition:\n conditionRule:\n - name: \"\"\n object: path\n operator: match\n type: url\n value: /F\n connective: OR\n - compressionAction:\n compressionFormat: all\n compressionTarget: '*'\n compressionType:\n - gzip\n - br\n maxFileSizeKb: 2048\n minFileSizeKb: 0\n condition:\n conditionRule:\n - name: \"\"\n object: directory\n operator: match\n type: url\n value: /E/\n connective: OR\n - compressionAction:\n compressionFormat: all\n compressionTarget: '*'\n compressionType:\n - gzip\n - br\n maxFileSizeKb: 2048\n minFileSizeKb: 0\n condition:\n conditionRule:\n - name: \"\"\n object: filetype\n operator: match\n type: url\n value: D\n connective: OR\n - compressionAction:\n compressionFormat: default\n compressionTarget: '*'\n compressionType:\n - gzip\n maxFileSizeKb: 2048\n minFileSizeKb: 0\n switch: true\n conditionalOrigin:\n origin_rules:\n - actions:\n originLines:\n - address: 192.168.0.4\n httpPort: '80'\n httpsPort: '443'\n instanceType: ip\n originHost: 192.168.0.5\n - address: 192.168.0.5\n httpPort: '80'\n httpsPort: '443'\n instanceType: ip\n originHost: 192.168.0.6\n condition:\n conditionGroups:\n - condition:\n object: path\n operator: equal\n value:\n - /a\n - condition:\n object: directory\n operator: equal\n value:\n - /b/\n - condition:\n object: filetype\n operator: equal\n value:\n - c\n - condition:\n object: client_ip\n operator: equal\n value:\n - 192.168.0.3\n - condition:\n object: client_ip_operator\n operator: belong\n value:\n - CT\n - CM\n - CU\n - CMTIETONG\n - CBN\n - CERNET\n - DRPENG\n connective: and\n isGroup: true\n switch: true\n customErrorPage:\n switch: false\n customizeAccessRule:\n switch: false\n domain: ccapi-test-web.com\n downloadSpeedLimit:\n switch: false\n followRedirect: true\n https:\n disable_http: false\n forced_redirect:\n enableForcedRedirect: false\n statusCode: '301'\n http2: false\n hsts:\n switch: false\n ttl: 0\n ocsp: false\n switch: false\n httpForcedRedirect:\n enable_forced_redirect: false\n status_code: '301'\n iPv6:\n switch: false\n methodDeniedRule:\n methods: \"\"\n switch: false\n multiRange:\n switch: false\n offlineCache:\n object: \"\"\n status_code: \"\"\n switch: false\n origins:\n - origin_action:\n originLines:\n - address: 192.168.0.1\n httpPort: '80'\n httpsPort: '443'\n instanceType: ip\n originHost: a.com\n originType: primary\n privateBucketAccess: false\n weight: '1'\n - address: b.com\n httpPort: '80'\n httpsPort: '443'\n instanceType: domain\n originHost: c.com\n originType: primary\n privateBucketAccess: false\n weight: '1'\n - address: ccapi-test-red.tos-cn-beijing.volces.com\n httpPort: \"\"\n httpsPort: \"\"\n instanceType: tos\n originHost: ccapi-test-red.tos-cn-beijing.volces.com\n originType: primary\n privateBucketAccess: true\n privateBucketAuth:\n authType: tos\n switch: true\n weight: '1'\n - address: 192.168.0.2\n httpPort: '80'\n httpsPort: '443'\n instanceType: ip\n originHost: d.com\n originType: backup\n privateBucketAccess: false\n weight: '1'\n originArgs:\n - condition:\n conditionRule:\n - name: \"\"\n object: directory\n operator: match\n type: url\n value: /\n connective: OR\n origin_arg_action:\n originArgComponents:\n - action: include\n object: queryString\n subobject: '*'\n originCertCheck:\n switch: false\n originHost: \"\"\n originIPv6: followclient\n originProtocol: followclient\n originRange: true\n originRetry:\n status_code: \"\"\n switch: false\n originRewrite:\n switch: false\n originSni:\n sni_domain: \"\"\n switch: false\n pageOptimization:\n optimization_type:\n - html\n - js\n - css\n switch: true\n project: default\n redirectionRewrite:\n switch: false\n remoteAuth:\n switch: false\n requestBlockRule:\n switch: false\n rewriteHls:\n sign_name: \"\"\n switch: false\n serviceRegion: outside_chinese_mainland\n serviceType: web\n tags:\n - key: env\n value: test\n timeout:\n switch: false\n urlNormalize:\n switch: false\n videoDrag:\n switch: false\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cdn/domain:Domain example \"domain\"\n```\n\n", "properties": { "areaAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainAreaAccessRule:DomainAreaAccessRule", "description": "Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.\n" }, "backupOrigins": { "type": "array", "items": { "type": "string" }, "description": "Indicates the backup origin server list configured for this domain. If no backup origin server is configured for this domain, the parameter value is null.\n" }, "browserCaches": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainBrowserCach:DomainBrowserCach" } }, "cacheHost": { "$ref": "#/types/volcenginecc:cdn/DomainCacheHost:DomainCacheHost", "description": "Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.\n" }, "cacheKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCacheKey:DomainCacheKey" } }, "cacheShared": { "type": "string", "description": "Indicates the role of this domain in the 'shared cache' configuration. The parameter has the following values: target*host: indicates the 'target domain'. cache*shared_on: indicates the 'configured domain'. If this domain is not included in any 'shared cache' configuration, the parameter value is an empty string ('').\n" }, "cacheSharedTargetHost": { "type": "string", "description": "If CacheShared is cache*shared*on, this parameter indicates the 'Target Domain' in the 'Shared Cache' configuration for this domain name. If CacheShared is target_host, this parameter is empty (\"\").\n" }, "caches": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCach:DomainCach" } }, "cname": { "type": "string", "description": "Indicates the CNAME assigned by the content delivery network to the acceleration domain name.\n" }, "compression": { "$ref": "#/types/volcenginecc:cdn/DomainCompression:DomainCompression", "description": "Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.\n" }, "conditionalOrigin": { "$ref": "#/types/volcenginecc:cdn/DomainConditionalOrigin:DomainConditionalOrigin", "description": "Specifies the configuration module for the 'Conditional Origin' feature.\n" }, "createdTime": { "type": "integer", "description": "Indicates the creation time of this accelerated domain name, in Unix timestamp format.\n" }, "customErrorPage": { "$ref": "#/types/volcenginecc:cdn/DomainCustomErrorPage:DomainCustomErrorPage", "description": "Indicates the configuration module for the \"Custom Error Page\" feature. This feature is disabled by default.\n" }, "customizeAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainCustomizeAccessRule:DomainCustomizeAccessRule", "description": "Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.\n" }, "domain": { "type": "string", "description": "Indicates the acceleration domain name.\n", "language": { "csharp": { "name": "DomainValue" } } }, "domainLock": { "$ref": "#/types/volcenginecc:cdn/DomainDomainLock:DomainDomainLock", "description": "Indicates the lock status of this domain name.\n" }, "downloadSpeedLimit": { "$ref": "#/types/volcenginecc:cdn/DomainDownloadSpeedLimit:DomainDownloadSpeedLimit", "description": "Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.\n" }, "followRedirect": { "type": "boolean", "description": "Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.\n" }, "httpForcedRedirect": { "$ref": "#/types/volcenginecc:cdn/DomainHttpForcedRedirect:DomainHttpForcedRedirect", "description": "Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.\n" }, "https": { "$ref": "#/types/volcenginecc:cdn/DomainHttps:DomainHttps", "description": "Indicates the HTTPS configuration module. This feature is disabled by default.\n" }, "iPv6": { "$ref": "#/types/volcenginecc:cdn/DomainIPv6:DomainIPv6", "description": "Indicates the configuration module for the IPv6 feature.\n" }, "ipAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainIpAccessRule:DomainIpAccessRule", "description": "Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.\n" }, "isConflictDomain": { "type": "boolean", "description": "Indicates whether the domain is a conflicting domain. In CDN, each domain is unique. If you need to add a domain that already exists under another primary account, you must submit a ticket. If you successfully add the domain under your primary account, it becomes a conflicting domain. This parameter has the following values: true: the domain is a conflicting domain. false: the domain is not a conflicting domain.\n" }, "lockStatus": { "type": "string", "description": "Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.\n" }, "methodDeniedRule": { "$ref": "#/types/volcenginecc:cdn/DomainMethodDeniedRule:DomainMethodDeniedRule", "description": "Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.\n" }, "multiRange": { "$ref": "#/types/volcenginecc:cdn/DomainMultiRange:DomainMultiRange", "description": "Indicates the configuration module for the multi-range feature. This feature is disabled by default\n" }, "negativeCaches": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainNegativeCach:DomainNegativeCach" } }, "offlineCache": { "$ref": "#/types/volcenginecc:cdn/DomainOfflineCache:DomainOfflineCache", "description": "Indicates the configuration module for the 'offline cache' feature.\n" }, "originAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainOriginAccessRule:DomainOriginAccessRule", "description": "Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.\n" }, "originArgs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOriginArg:DomainOriginArg" } }, "originCertCheck": { "$ref": "#/types/volcenginecc:cdn/DomainOriginCertCheck:DomainOriginCertCheck", "description": "Origin certificate validation\n" }, "originHost": { "type": "string", "description": "If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.\n" }, "originIPv6": { "type": "string", "description": "Indicates the configuration for \"IPv6 origin fetch.\" This parameter has the following values: ipv6*first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4*first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.\n" }, "originProtocol": { "type": "string", "description": "Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.\n" }, "originRange": { "type": "boolean", "description": "Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.\n" }, "originRetry": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRetry:DomainOriginRetry", "description": "Indicates the configuration module for the \"origin fetch retry settings\" feature.\n" }, "originRewrite": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRewrite:DomainOriginRewrite", "description": "Indicates the configuration module for the 'Origin URL Rewrite' feature.\n" }, "originSni": { "$ref": "#/types/volcenginecc:cdn/DomainOriginSni:DomainOriginSni", "description": "Indicates the configuration module for the 'origin SNI' feature.\n" }, "origins": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOrigin:DomainOrigin" } }, "pageOptimization": { "$ref": "#/types/volcenginecc:cdn/DomainPageOptimization:DomainPageOptimization", "description": "Specifies the configuration module for the 'page optimization' feature.\n" }, "primaryOrigins": { "type": "array", "items": { "type": "string" }, "description": "Indicates the list of primary origin servers configured for this domain name.\n" }, "project": { "type": "string", "description": "Indicates the project to which the acceleration domain belongs\n" }, "quic": { "$ref": "#/types/volcenginecc:cdn/DomainQuic:DomainQuic", "description": "Indicates the configuration module for the QUIC feature. This feature is disabled by default.\n" }, "redirectionRewrite": { "$ref": "#/types/volcenginecc:cdn/DomainRedirectionRewrite:DomainRedirectionRewrite", "description": "Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.\n" }, "refererAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainRefererAccessRule:DomainRefererAccessRule", "description": "Indicates the configuration module for the \"Referer Allowlist and Denylist\" feature. This feature is disabled by default.\n" }, "remoteAuth": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuth:DomainRemoteAuth", "description": "Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.\n" }, "requestBlockRule": { "$ref": "#/types/volcenginecc:cdn/DomainRequestBlockRule:DomainRequestBlockRule", "description": "Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default\n" }, "requestHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRequestHeader:DomainRequestHeader" } }, "responseHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainResponseHeader:DomainResponseHeader" } }, "rewriteHls": { "$ref": "#/types/volcenginecc:cdn/DomainRewriteHls:DomainRewriteHls", "description": "Indicates the configuration module for the \"Standard HLS Encryption Rewrite\" feature. This feature is disabled by default.\n" }, "serviceRegion": { "type": "string", "description": "Indicates the acceleration region for this accelerated domain name. The parameter values are: chinese*mainland: Chinese Mainland. global: Global. outside*chinese_mainland: Global (excluding Chinese Mainland).\n" }, "serviceType": { "type": "string", "description": "Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.\n" }, "signedUrlAuth": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuth:DomainSignedUrlAuth", "description": "Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default\n" }, "status": { "type": "string", "description": "Indicates the status of the acceleration domain name. The parameter values are as follows: online: indicates normal operation. configuring: indicates configuration in progress. offline: indicates offline status.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainTag:DomainTag" } }, "timeout": { "$ref": "#/types/volcenginecc:cdn/DomainTimeout:DomainTimeout", "description": "Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.\n" }, "uaAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainUaAccessRule:DomainUaAccessRule", "description": "Indicates the configuration module for the \"UA allowlist and blocklist\" feature. This feature is disabled by default.\n" }, "updatedTime": { "type": "integer", "description": "Indicates the most recent update time for this domain configuration, in Unix timestamp format.\n" }, "urlNormalize": { "$ref": "#/types/volcenginecc:cdn/DomainUrlNormalize:DomainUrlNormalize", "description": "Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.\n" }, "videoDrag": { "$ref": "#/types/volcenginecc:cdn/DomainVideoDrag:DomainVideoDrag", "description": "Indicates the configuration module for the \"Video Drag\" feature. This feature is disabled by default.\n" } }, "required": [ "areaAccessRule", "backupOrigins", "browserCaches", "caches", "cacheHost", "cacheKeys", "cacheShared", "cacheSharedTargetHost", "cname", "compression", "conditionalOrigin", "createdTime", "customErrorPage", "customizeAccessRule", "domain", "domainLock", "downloadSpeedLimit", "followRedirect", "httpForcedRedirect", "https", "iPv6", "ipAccessRule", "isConflictDomain", "lockStatus", "methodDeniedRule", "multiRange", "negativeCaches", "offlineCache", "origins", "originAccessRule", "originArgs", "originCertCheck", "originHost", "originIPv6", "originProtocol", "originRange", "originRetry", "originRewrite", "originSni", "pageOptimization", "primaryOrigins", "project", "quic", "redirectionRewrite", "refererAccessRule", "remoteAuth", "requestBlockRule", "requestHeaders", "responseHeaders", "rewriteHls", "serviceRegion", "serviceType", "signedUrlAuth", "status", "tags", "timeout", "uaAccessRule", "updatedTime", "urlNormalize", "videoDrag" ], "inputProperties": { "areaAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainAreaAccessRule:DomainAreaAccessRule", "description": "Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.\n" }, "browserCaches": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainBrowserCach:DomainBrowserCach" } }, "cacheHost": { "$ref": "#/types/volcenginecc:cdn/DomainCacheHost:DomainCacheHost", "description": "Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.\n" }, "cacheKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCacheKey:DomainCacheKey" } }, "caches": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCach:DomainCach" } }, "compression": { "$ref": "#/types/volcenginecc:cdn/DomainCompression:DomainCompression", "description": "Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.\n" }, "conditionalOrigin": { "$ref": "#/types/volcenginecc:cdn/DomainConditionalOrigin:DomainConditionalOrigin", "description": "Specifies the configuration module for the 'Conditional Origin' feature.\n" }, "customErrorPage": { "$ref": "#/types/volcenginecc:cdn/DomainCustomErrorPage:DomainCustomErrorPage", "description": "Indicates the configuration module for the \"Custom Error Page\" feature. This feature is disabled by default.\n" }, "customizeAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainCustomizeAccessRule:DomainCustomizeAccessRule", "description": "Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.\n" }, "domain": { "type": "string", "description": "Indicates the acceleration domain name.\n", "language": { "csharp": { "name": "DomainValue" } } }, "downloadSpeedLimit": { "$ref": "#/types/volcenginecc:cdn/DomainDownloadSpeedLimit:DomainDownloadSpeedLimit", "description": "Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.\n" }, "followRedirect": { "type": "boolean", "description": "Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.\n" }, "httpForcedRedirect": { "$ref": "#/types/volcenginecc:cdn/DomainHttpForcedRedirect:DomainHttpForcedRedirect", "description": "Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.\n" }, "https": { "$ref": "#/types/volcenginecc:cdn/DomainHttps:DomainHttps", "description": "Indicates the HTTPS configuration module. This feature is disabled by default.\n" }, "iPv6": { "$ref": "#/types/volcenginecc:cdn/DomainIPv6:DomainIPv6", "description": "Indicates the configuration module for the IPv6 feature.\n" }, "ipAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainIpAccessRule:DomainIpAccessRule", "description": "Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.\n" }, "methodDeniedRule": { "$ref": "#/types/volcenginecc:cdn/DomainMethodDeniedRule:DomainMethodDeniedRule", "description": "Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.\n" }, "multiRange": { "$ref": "#/types/volcenginecc:cdn/DomainMultiRange:DomainMultiRange", "description": "Indicates the configuration module for the multi-range feature. This feature is disabled by default\n" }, "negativeCaches": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainNegativeCach:DomainNegativeCach" } }, "offlineCache": { "$ref": "#/types/volcenginecc:cdn/DomainOfflineCache:DomainOfflineCache", "description": "Indicates the configuration module for the 'offline cache' feature.\n" }, "originAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainOriginAccessRule:DomainOriginAccessRule", "description": "Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.\n" }, "originArgs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOriginArg:DomainOriginArg" } }, "originCertCheck": { "$ref": "#/types/volcenginecc:cdn/DomainOriginCertCheck:DomainOriginCertCheck", "description": "Origin certificate validation\n" }, "originHost": { "type": "string", "description": "If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.\n" }, "originIPv6": { "type": "string", "description": "Indicates the configuration for \"IPv6 origin fetch.\" This parameter has the following values: ipv6*first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4*first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.\n" }, "originProtocol": { "type": "string", "description": "Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.\n" }, "originRange": { "type": "boolean", "description": "Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.\n" }, "originRetry": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRetry:DomainOriginRetry", "description": "Indicates the configuration module for the \"origin fetch retry settings\" feature.\n" }, "originRewrite": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRewrite:DomainOriginRewrite", "description": "Indicates the configuration module for the 'Origin URL Rewrite' feature.\n" }, "originSni": { "$ref": "#/types/volcenginecc:cdn/DomainOriginSni:DomainOriginSni", "description": "Indicates the configuration module for the 'origin SNI' feature.\n" }, "origins": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOrigin:DomainOrigin" } }, "pageOptimization": { "$ref": "#/types/volcenginecc:cdn/DomainPageOptimization:DomainPageOptimization", "description": "Specifies the configuration module for the 'page optimization' feature.\n" }, "project": { "type": "string", "description": "Indicates the project to which the acceleration domain belongs\n" }, "quic": { "$ref": "#/types/volcenginecc:cdn/DomainQuic:DomainQuic", "description": "Indicates the configuration module for the QUIC feature. This feature is disabled by default.\n" }, "redirectionRewrite": { "$ref": "#/types/volcenginecc:cdn/DomainRedirectionRewrite:DomainRedirectionRewrite", "description": "Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.\n" }, "refererAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainRefererAccessRule:DomainRefererAccessRule", "description": "Indicates the configuration module for the \"Referer Allowlist and Denylist\" feature. This feature is disabled by default.\n" }, "remoteAuth": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuth:DomainRemoteAuth", "description": "Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.\n" }, "requestBlockRule": { "$ref": "#/types/volcenginecc:cdn/DomainRequestBlockRule:DomainRequestBlockRule", "description": "Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default\n" }, "requestHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRequestHeader:DomainRequestHeader" } }, "responseHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainResponseHeader:DomainResponseHeader" } }, "rewriteHls": { "$ref": "#/types/volcenginecc:cdn/DomainRewriteHls:DomainRewriteHls", "description": "Indicates the configuration module for the \"Standard HLS Encryption Rewrite\" feature. This feature is disabled by default.\n" }, "serviceRegion": { "type": "string", "description": "Indicates the acceleration region for this accelerated domain name. The parameter values are: chinese*mainland: Chinese Mainland. global: Global. outside*chinese_mainland: Global (excluding Chinese Mainland).\n" }, "serviceType": { "type": "string", "description": "Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.\n" }, "signedUrlAuth": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuth:DomainSignedUrlAuth", "description": "Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainTag:DomainTag" } }, "timeout": { "$ref": "#/types/volcenginecc:cdn/DomainTimeout:DomainTimeout", "description": "Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.\n" }, "uaAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainUaAccessRule:DomainUaAccessRule", "description": "Indicates the configuration module for the \"UA allowlist and blocklist\" feature. This feature is disabled by default.\n" }, "urlNormalize": { "$ref": "#/types/volcenginecc:cdn/DomainUrlNormalize:DomainUrlNormalize", "description": "Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.\n" }, "videoDrag": { "$ref": "#/types/volcenginecc:cdn/DomainVideoDrag:DomainVideoDrag", "description": "Indicates the configuration module for the \"Video Drag\" feature. This feature is disabled by default.\n" } }, "requiredInputs": [ "domain", "origins", "serviceType" ], "stateInputs": { "description": "Input properties used for looking up and filtering Domain resources.\n", "properties": { "areaAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainAreaAccessRule:DomainAreaAccessRule", "description": "Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.\n" }, "backupOrigins": { "type": "array", "items": { "type": "string" }, "description": "Indicates the backup origin server list configured for this domain. If no backup origin server is configured for this domain, the parameter value is null.\n" }, "browserCaches": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainBrowserCach:DomainBrowserCach" } }, "cacheHost": { "$ref": "#/types/volcenginecc:cdn/DomainCacheHost:DomainCacheHost", "description": "Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.\n" }, "cacheKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCacheKey:DomainCacheKey" } }, "cacheShared": { "type": "string", "description": "Indicates the role of this domain in the 'shared cache' configuration. The parameter has the following values: target*host: indicates the 'target domain'. cache*shared_on: indicates the 'configured domain'. If this domain is not included in any 'shared cache' configuration, the parameter value is an empty string ('').\n" }, "cacheSharedTargetHost": { "type": "string", "description": "If CacheShared is cache*shared*on, this parameter indicates the 'Target Domain' in the 'Shared Cache' configuration for this domain name. If CacheShared is target_host, this parameter is empty (\"\").\n" }, "caches": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainCach:DomainCach" } }, "cname": { "type": "string", "description": "Indicates the CNAME assigned by the content delivery network to the acceleration domain name.\n" }, "compression": { "$ref": "#/types/volcenginecc:cdn/DomainCompression:DomainCompression", "description": "Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.\n" }, "conditionalOrigin": { "$ref": "#/types/volcenginecc:cdn/DomainConditionalOrigin:DomainConditionalOrigin", "description": "Specifies the configuration module for the 'Conditional Origin' feature.\n" }, "createdTime": { "type": "integer", "description": "Indicates the creation time of this accelerated domain name, in Unix timestamp format.\n" }, "customErrorPage": { "$ref": "#/types/volcenginecc:cdn/DomainCustomErrorPage:DomainCustomErrorPage", "description": "Indicates the configuration module for the \"Custom Error Page\" feature. This feature is disabled by default.\n" }, "customizeAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainCustomizeAccessRule:DomainCustomizeAccessRule", "description": "Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.\n" }, "domain": { "type": "string", "description": "Indicates the acceleration domain name.\n", "language": { "csharp": { "name": "DomainValue" } } }, "domainLock": { "$ref": "#/types/volcenginecc:cdn/DomainDomainLock:DomainDomainLock", "description": "Indicates the lock status of this domain name.\n" }, "downloadSpeedLimit": { "$ref": "#/types/volcenginecc:cdn/DomainDownloadSpeedLimit:DomainDownloadSpeedLimit", "description": "Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.\n" }, "followRedirect": { "type": "boolean", "description": "Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.\n" }, "httpForcedRedirect": { "$ref": "#/types/volcenginecc:cdn/DomainHttpForcedRedirect:DomainHttpForcedRedirect", "description": "Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.\n" }, "https": { "$ref": "#/types/volcenginecc:cdn/DomainHttps:DomainHttps", "description": "Indicates the HTTPS configuration module. This feature is disabled by default.\n" }, "iPv6": { "$ref": "#/types/volcenginecc:cdn/DomainIPv6:DomainIPv6", "description": "Indicates the configuration module for the IPv6 feature.\n" }, "ipAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainIpAccessRule:DomainIpAccessRule", "description": "Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.\n" }, "isConflictDomain": { "type": "boolean", "description": "Indicates whether the domain is a conflicting domain. In CDN, each domain is unique. If you need to add a domain that already exists under another primary account, you must submit a ticket. If you successfully add the domain under your primary account, it becomes a conflicting domain. This parameter has the following values: true: the domain is a conflicting domain. false: the domain is not a conflicting domain.\n" }, "lockStatus": { "type": "string", "description": "Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.\n" }, "methodDeniedRule": { "$ref": "#/types/volcenginecc:cdn/DomainMethodDeniedRule:DomainMethodDeniedRule", "description": "Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.\n" }, "multiRange": { "$ref": "#/types/volcenginecc:cdn/DomainMultiRange:DomainMultiRange", "description": "Indicates the configuration module for the multi-range feature. This feature is disabled by default\n" }, "negativeCaches": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainNegativeCach:DomainNegativeCach" } }, "offlineCache": { "$ref": "#/types/volcenginecc:cdn/DomainOfflineCache:DomainOfflineCache", "description": "Indicates the configuration module for the 'offline cache' feature.\n" }, "originAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainOriginAccessRule:DomainOriginAccessRule", "description": "Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.\n" }, "originArgs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOriginArg:DomainOriginArg" } }, "originCertCheck": { "$ref": "#/types/volcenginecc:cdn/DomainOriginCertCheck:DomainOriginCertCheck", "description": "Origin certificate validation\n" }, "originHost": { "type": "string", "description": "If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.\n" }, "originIPv6": { "type": "string", "description": "Indicates the configuration for \"IPv6 origin fetch.\" This parameter has the following values: ipv6*first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4*first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.\n" }, "originProtocol": { "type": "string", "description": "Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.\n" }, "originRange": { "type": "boolean", "description": "Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.\n" }, "originRetry": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRetry:DomainOriginRetry", "description": "Indicates the configuration module for the \"origin fetch retry settings\" feature.\n" }, "originRewrite": { "$ref": "#/types/volcenginecc:cdn/DomainOriginRewrite:DomainOriginRewrite", "description": "Indicates the configuration module for the 'Origin URL Rewrite' feature.\n" }, "originSni": { "$ref": "#/types/volcenginecc:cdn/DomainOriginSni:DomainOriginSni", "description": "Indicates the configuration module for the 'origin SNI' feature.\n" }, "origins": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainOrigin:DomainOrigin" } }, "pageOptimization": { "$ref": "#/types/volcenginecc:cdn/DomainPageOptimization:DomainPageOptimization", "description": "Specifies the configuration module for the 'page optimization' feature.\n" }, "primaryOrigins": { "type": "array", "items": { "type": "string" }, "description": "Indicates the list of primary origin servers configured for this domain name.\n" }, "project": { "type": "string", "description": "Indicates the project to which the acceleration domain belongs\n" }, "quic": { "$ref": "#/types/volcenginecc:cdn/DomainQuic:DomainQuic", "description": "Indicates the configuration module for the QUIC feature. This feature is disabled by default.\n" }, "redirectionRewrite": { "$ref": "#/types/volcenginecc:cdn/DomainRedirectionRewrite:DomainRedirectionRewrite", "description": "Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.\n" }, "refererAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainRefererAccessRule:DomainRefererAccessRule", "description": "Indicates the configuration module for the \"Referer Allowlist and Denylist\" feature. This feature is disabled by default.\n" }, "remoteAuth": { "$ref": "#/types/volcenginecc:cdn/DomainRemoteAuth:DomainRemoteAuth", "description": "Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.\n" }, "requestBlockRule": { "$ref": "#/types/volcenginecc:cdn/DomainRequestBlockRule:DomainRequestBlockRule", "description": "Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default\n" }, "requestHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainRequestHeader:DomainRequestHeader" } }, "responseHeaders": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainResponseHeader:DomainResponseHeader" } }, "rewriteHls": { "$ref": "#/types/volcenginecc:cdn/DomainRewriteHls:DomainRewriteHls", "description": "Indicates the configuration module for the \"Standard HLS Encryption Rewrite\" feature. This feature is disabled by default.\n" }, "serviceRegion": { "type": "string", "description": "Indicates the acceleration region for this accelerated domain name. The parameter values are: chinese*mainland: Chinese Mainland. global: Global. outside*chinese_mainland: Global (excluding Chinese Mainland).\n" }, "serviceType": { "type": "string", "description": "Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.\n" }, "signedUrlAuth": { "$ref": "#/types/volcenginecc:cdn/DomainSignedUrlAuth:DomainSignedUrlAuth", "description": "Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default\n" }, "status": { "type": "string", "description": "Indicates the status of the acceleration domain name. The parameter values are as follows: online: indicates normal operation. configuring: indicates configuration in progress. offline: indicates offline status.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cdn/DomainTag:DomainTag" } }, "timeout": { "$ref": "#/types/volcenginecc:cdn/DomainTimeout:DomainTimeout", "description": "Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.\n" }, "uaAccessRule": { "$ref": "#/types/volcenginecc:cdn/DomainUaAccessRule:DomainUaAccessRule", "description": "Indicates the configuration module for the \"UA allowlist and blocklist\" feature. This feature is disabled by default.\n" }, "updatedTime": { "type": "integer", "description": "Indicates the most recent update time for this domain configuration, in Unix timestamp format.\n" }, "urlNormalize": { "$ref": "#/types/volcenginecc:cdn/DomainUrlNormalize:DomainUrlNormalize", "description": "Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.\n" }, "videoDrag": { "$ref": "#/types/volcenginecc:cdn/DomainVideoDrag:DomainVideoDrag", "description": "Indicates the configuration module for the \"Video Drag\" feature. This feature is disabled by default.\n" } }, "type": "object" } }, "volcenginecc:cdn/shareConfig:ShareConfig": { "description": "Global configuration extends domain configuration capabilities with the following advantages: increases the capacity of denylist and allowlist. For example, an IP denylist can contain up to 30,000 entries. Improves domain configuration efficiency. A single global configuration can be associated with multiple domains. Provides a common list type that can be used in additional domain configurations. Modifications to a global configuration are immediately applied to all associated domains.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cDNShareConfigDemo:\n type: volcenginecc:cdn:ShareConfig\n name: CDNShareConfigDemo\n properties:\n configName: CDNShareConfigDemo\n configType: allow_referer_access_rule\n project: default\n allowRefererAccessRule:\n allow_empty: true\n common_type:\n ignoreCase: true\n rules:\n - 139.x.x.1\n - 139.x.x.2\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cdn/shareConfig:ShareConfig example \"config_name\"\n```\n\n", "properties": { "allowIpAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigAllowIpAccessRule:ShareConfigAllowIpAccessRule", "description": "Specifies the configuration for an IP allowlist, where ConfigType is allow*ip*access*rule.\n" }, "allowRefererAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigAllowRefererAccessRule:ShareConfigAllowRefererAccessRule", "description": "Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allow*referer*access*rule.\n" }, "commonMatchList": { "$ref": "#/types/volcenginecc:cdn/ShareConfigCommonMatchList:ShareConfigCommonMatchList", "description": "Specifies the configuration for a common list, where ConfigType is common*match*list.\n" }, "configName": { "type": "string", "description": "Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.\n" }, "configType": { "type": "string", "description": "This parameter specifies the type of global configuration. Available values are: deny*ip*access*rule: indicates an IP denylist. allow*ip*access*rule: indicates an IP allowlist. deny*referer*access*rule: indicates a Referer denylist. allow*referer*access*rule: indicates a Referer allowlist. common*match*list: indicates a common list.\n" }, "denyIpAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigDenyIpAccessRule:ShareConfigDenyIpAccessRule", "description": "Specifies the configuration for an IP denylist, where ConfigType is deny*ip*access*rule.\n" }, "denyRefererAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigDenyRefererAccessRule:ShareConfigDenyRefererAccessRule", "description": "Indicates a configuration for a Referer denylist. The corresponding ConfigType is deny*referer*access*rule.\n" }, "domainCount": { "type": "integer", "description": "Indicates the number of accelerated domains associated with this global configuration.\n" }, "project": { "type": "string", "description": "Specifies the project name to which the global configuration belongs.\n" }, "ruleContent": { "type": "string", "description": "Specifies the HTML code for the custom error page.\n" }, "updatedTime": { "type": "integer", "description": "Indicates the last modification time of this global configuration, in Unix timestamp.\n" } }, "required": [ "allowIpAccessRule", "allowRefererAccessRule", "commonMatchList", "configName", "configType", "denyIpAccessRule", "denyRefererAccessRule", "domainCount", "project", "ruleContent", "updatedTime" ], "inputProperties": { "allowIpAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigAllowIpAccessRule:ShareConfigAllowIpAccessRule", "description": "Specifies the configuration for an IP allowlist, where ConfigType is allow*ip*access*rule.\n" }, "allowRefererAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigAllowRefererAccessRule:ShareConfigAllowRefererAccessRule", "description": "Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allow*referer*access*rule.\n" }, "commonMatchList": { "$ref": "#/types/volcenginecc:cdn/ShareConfigCommonMatchList:ShareConfigCommonMatchList", "description": "Specifies the configuration for a common list, where ConfigType is common*match*list.\n" }, "configName": { "type": "string", "description": "Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.\n" }, "configType": { "type": "string", "description": "This parameter specifies the type of global configuration. Available values are: deny*ip*access*rule: indicates an IP denylist. allow*ip*access*rule: indicates an IP allowlist. deny*referer*access*rule: indicates a Referer denylist. allow*referer*access*rule: indicates a Referer allowlist. common*match*list: indicates a common list.\n" }, "denyIpAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigDenyIpAccessRule:ShareConfigDenyIpAccessRule", "description": "Specifies the configuration for an IP denylist, where ConfigType is deny*ip*access*rule.\n" }, "denyRefererAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigDenyRefererAccessRule:ShareConfigDenyRefererAccessRule", "description": "Indicates a configuration for a Referer denylist. The corresponding ConfigType is deny*referer*access*rule.\n" }, "project": { "type": "string", "description": "Specifies the project name to which the global configuration belongs.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering ShareConfig resources.\n", "properties": { "allowIpAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigAllowIpAccessRule:ShareConfigAllowIpAccessRule", "description": "Specifies the configuration for an IP allowlist, where ConfigType is allow*ip*access*rule.\n" }, "allowRefererAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigAllowRefererAccessRule:ShareConfigAllowRefererAccessRule", "description": "Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allow*referer*access*rule.\n" }, "commonMatchList": { "$ref": "#/types/volcenginecc:cdn/ShareConfigCommonMatchList:ShareConfigCommonMatchList", "description": "Specifies the configuration for a common list, where ConfigType is common*match*list.\n" }, "configName": { "type": "string", "description": "Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.\n" }, "configType": { "type": "string", "description": "This parameter specifies the type of global configuration. Available values are: deny*ip*access*rule: indicates an IP denylist. allow*ip*access*rule: indicates an IP allowlist. deny*referer*access*rule: indicates a Referer denylist. allow*referer*access*rule: indicates a Referer allowlist. common*match*list: indicates a common list.\n" }, "denyIpAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigDenyIpAccessRule:ShareConfigDenyIpAccessRule", "description": "Specifies the configuration for an IP denylist, where ConfigType is deny*ip*access*rule.\n" }, "denyRefererAccessRule": { "$ref": "#/types/volcenginecc:cdn/ShareConfigDenyRefererAccessRule:ShareConfigDenyRefererAccessRule", "description": "Indicates a configuration for a Referer denylist. The corresponding ConfigType is deny*referer*access*rule.\n" }, "domainCount": { "type": "integer", "description": "Indicates the number of accelerated domains associated with this global configuration.\n" }, "project": { "type": "string", "description": "Specifies the project name to which the global configuration belongs.\n" }, "ruleContent": { "type": "string", "description": "Specifies the HTML code for the custom error page.\n" }, "updatedTime": { "type": "integer", "description": "Indicates the last modification time of this global configuration, in Unix timestamp.\n" } }, "type": "object" } }, "volcenginecc:cen/bandwidthPackage:BandwidthPackage": { "description": "Provides cross-region communication bandwidth for Cloud Enterprise Network instances. You can allocate bandwidth to different inter-region connections. By creating a bandwidth package and assigning inter-region bandwidth, you enable connectivity between network instances in different regions.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cENBandwidthPackageDemo = new volcenginecc.cen.BandwidthPackage(\"CENBandwidthPackageDemo\", {\n bandwidth: 3,\n billingType: 4,\n cenBandwidthPackageName: \"ccapi-test\",\n cenIds: [\"cen-2v73nw1h8a03k6x7exxxxx\"],\n description: \"this is a cen test\",\n localGeographicRegionSetId: \"China\",\n peerGeographicRegionSetId: \"China\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_en_bandwidth_package_demo = volcenginecc.cen.BandwidthPackage(\"CENBandwidthPackageDemo\",\n bandwidth=3,\n billing_type=4,\n cen_bandwidth_package_name=\"ccapi-test\",\n cen_ids=[\"cen-2v73nw1h8a03k6x7exxxxx\"],\n description=\"this is a cen test\",\n local_geographic_region_set_id=\"China\",\n peer_geographic_region_set_id=\"China\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cENBandwidthPackageDemo = new Volcenginecc.Cen.BandwidthPackage(\"CENBandwidthPackageDemo\", new()\n {\n Bandwidth = 3,\n BillingType = 4,\n CenBandwidthPackageName = \"ccapi-test\",\n CenIds = new[]\n {\n \"cen-2v73nw1h8a03k6x7exxxxx\",\n },\n Description = \"this is a cen test\",\n LocalGeographicRegionSetId = \"China\",\n PeerGeographicRegionSetId = \"China\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Cen.Inputs.BandwidthPackageTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cen\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cen.NewBandwidthPackage(ctx, \"CENBandwidthPackageDemo\", \u0026cen.BandwidthPackageArgs{\n\t\t\tBandwidth: pulumi.Int(3),\n\t\t\tBillingType: pulumi.Int(4),\n\t\t\tCenBandwidthPackageName: pulumi.String(\"ccapi-test\"),\n\t\t\tCenIds: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"cen-2v73nw1h8a03k6x7exxxxx\"),\n\t\t\t},\n\t\t\tDescription: pulumi.String(\"this is a cen test\"),\n\t\t\tLocalGeographicRegionSetId: pulumi.String(\"China\"),\n\t\t\tPeerGeographicRegionSetId: pulumi.String(\"China\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: cen.BandwidthPackageTagArray{\n\t\t\t\t\u0026cen.BandwidthPackageTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cen.BandwidthPackage;\nimport com.volcengine.volcenginecc.cen.BandwidthPackageArgs;\nimport com.pulumi.volcenginecc.cen.inputs.BandwidthPackageTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cENBandwidthPackageDemo = new BandwidthPackage(\"cENBandwidthPackageDemo\", BandwidthPackageArgs.builder()\n .bandwidth(3)\n .billingType(4)\n .cenBandwidthPackageName(\"ccapi-test\")\n .cenIds(\"cen-2v73nw1h8a03k6x7exxxxx\")\n .description(\"this is a cen test\")\n .localGeographicRegionSetId(\"China\")\n .peerGeographicRegionSetId(\"China\")\n .projectName(\"default\")\n .tags(BandwidthPackageTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cENBandwidthPackageDemo:\n type: volcenginecc:cen:BandwidthPackage\n name: CENBandwidthPackageDemo\n properties:\n bandwidth: 3\n billingType: 4\n cenBandwidthPackageName: ccapi-test\n cenIds:\n - cen-2v73nw1h8a03k6x7exxxxx\n description: this is a cen test\n localGeographicRegionSetId: China\n peerGeographicRegionSetId: China\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cen/bandwidthPackage:BandwidthPackage example \"cen_bandwidth_package_id\"\n```\n\n", "properties": { "bandwidth": { "type": "integer", "description": "Bandwidth peak of the bandwidth package. Value range: 2–10000 Mbps. Default: 2 Mbps.\n" }, "billingStatus": { "type": "integer", "description": "Billing status of the bandwidth package instance. 0: Creating 1: Running 3: Unsubscribed 4: Expired and stopped 5: Expired and recycled 8: Unsubscribed and stopped\n" }, "billingType": { "type": "integer", "description": "Billing method of the bandwidth package. Valid values: 1 (default): yearly/monthly subscription. 4: pay-as-you-go—95th percentile billing.\n" }, "businessStatus": { "type": "string", "description": "Frozen status of the bandwidth package. Normal: normal. FinancialLocked: frozen.\n" }, "cenBandwidthPackageId": { "type": "string", "description": "Bandwidth package ID.\n" }, "cenBandwidthPackageName": { "type": "string", "description": "Name of the bandwidth package. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the bandwidth package ID.\n" }, "cenIds": { "type": "array", "items": { "type": "string" }, "description": "List of associated CEN instance IDs.\n" }, "creationTime": { "type": "string", "description": "Creation time of the bandwidth package.\n" }, "deletedTime": { "type": "string", "description": "Deletion time of the bandwidth package.\n" }, "description": { "type": "string", "description": "Description of the bandwidth package. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "expiredTime": { "type": "string", "description": "Expiration time of the bandwidth package.\n" }, "lineOperator": { "type": "string", "description": "Carrier for cross-border bandwidth package lines. If LocalGeographicRegionSetId and PeerGeographicRegionSetId are the same, this parameter is not supported. If LocalGeographicRegionSetId and PeerGeographicRegionSetId are different, available values are: ChinaUnicom (default): China Unicom.\n" }, "localGeographicRegionSetId": { "type": "string", "description": "Local geographic region ID for Cloud Enterprise Network communication. Available values: China: Chinese mainland. Asia: Asia-Pacific.\n" }, "peerGeographicRegionSetId": { "type": "string", "description": "Peer geographic region ID for Cloud Enterprise Network interconnection. Valid values: China: Chinese mainland. Asia: Asia-Pacific.\n" }, "period": { "type": "integer", "description": "Purchase duration of the bandwidth package. Default is 1. Valid values: If PeriodUnit is Month, range is 1–9, 12, 24, and 36. If PeriodUnit is Year, range is 1–3.\n" }, "periodUnit": { "type": "string", "description": "Billing cycle of the bandwidth package. Valid values: Month (default): month. Year: year.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the bandwidth package belongs. If not specified, defaults to 'default'.\n" }, "reclaimTime": { "type": "string", "description": "Recycle time after the bandwidth package instance expires.\n" }, "remainRenewTimes": { "type": "integer", "description": "Number of automatic renewals. Values include -1 and 1–100. Default is -1, which means unlimited automatic renewals.\n" }, "remainingBandwidth": { "type": "integer", "description": "Remaining bandwidth, measured in Mbps.\n" }, "renewPeriod": { "type": "integer", "description": "Duration of each automatic renewal, in months. Valid values: 1–3, 6, and 12. Default is 1.\n" }, "renewType": { "type": "string", "description": "Renewal type of the bandwidth package instance. Manual: Manual renewal. Auto: Automatic renewal. NoRenew: No renewal.\n" }, "status": { "type": "string", "description": "Status of the bandwidth package. Creating: Being created. Deleting: Being deleted. Pending: In progress. Available: Unbound. InUse: Bound.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/BandwidthPackageTag:BandwidthPackageTag" } }, "updateTime": { "type": "string", "description": "Update time of the bandwidth package.\n" } }, "required": [ "bandwidth", "billingStatus", "billingType", "businessStatus", "cenBandwidthPackageId", "cenBandwidthPackageName", "cenIds", "creationTime", "deletedTime", "description", "expiredTime", "lineOperator", "localGeographicRegionSetId", "peerGeographicRegionSetId", "period", "periodUnit", "projectName", "reclaimTime", "remainRenewTimes", "remainingBandwidth", "renewPeriod", "renewType", "status", "tags", "updateTime" ], "inputProperties": { "bandwidth": { "type": "integer", "description": "Bandwidth peak of the bandwidth package. Value range: 2–10000 Mbps. Default: 2 Mbps.\n" }, "billingType": { "type": "integer", "description": "Billing method of the bandwidth package. Valid values: 1 (default): yearly/monthly subscription. 4: pay-as-you-go—95th percentile billing.\n" }, "cenBandwidthPackageName": { "type": "string", "description": "Name of the bandwidth package. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the bandwidth package ID.\n" }, "cenIds": { "type": "array", "items": { "type": "string" }, "description": "List of associated CEN instance IDs.\n" }, "description": { "type": "string", "description": "Description of the bandwidth package. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "lineOperator": { "type": "string", "description": "Carrier for cross-border bandwidth package lines. If LocalGeographicRegionSetId and PeerGeographicRegionSetId are the same, this parameter is not supported. If LocalGeographicRegionSetId and PeerGeographicRegionSetId are different, available values are: ChinaUnicom (default): China Unicom.\n" }, "localGeographicRegionSetId": { "type": "string", "description": "Local geographic region ID for Cloud Enterprise Network communication. Available values: China: Chinese mainland. Asia: Asia-Pacific.\n" }, "peerGeographicRegionSetId": { "type": "string", "description": "Peer geographic region ID for Cloud Enterprise Network interconnection. Valid values: China: Chinese mainland. Asia: Asia-Pacific.\n" }, "period": { "type": "integer", "description": "Purchase duration of the bandwidth package. Default is 1. Valid values: If PeriodUnit is Month, range is 1–9, 12, 24, and 36. If PeriodUnit is Year, range is 1–3.\n" }, "periodUnit": { "type": "string", "description": "Billing cycle of the bandwidth package. Valid values: Month (default): month. Year: year.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the bandwidth package belongs. If not specified, defaults to 'default'.\n" }, "remainRenewTimes": { "type": "integer", "description": "Number of automatic renewals. Values include -1 and 1–100. Default is -1, which means unlimited automatic renewals.\n" }, "renewPeriod": { "type": "integer", "description": "Duration of each automatic renewal, in months. Valid values: 1–3, 6, and 12. Default is 1.\n" }, "renewType": { "type": "string", "description": "Renewal type of the bandwidth package instance. Manual: Manual renewal. Auto: Automatic renewal. NoRenew: No renewal.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/BandwidthPackageTag:BandwidthPackageTag" } } }, "requiredInputs": [ "localGeographicRegionSetId", "peerGeographicRegionSetId" ], "stateInputs": { "description": "Input properties used for looking up and filtering BandwidthPackage resources.\n", "properties": { "bandwidth": { "type": "integer", "description": "Bandwidth peak of the bandwidth package. Value range: 2–10000 Mbps. Default: 2 Mbps.\n" }, "billingStatus": { "type": "integer", "description": "Billing status of the bandwidth package instance. 0: Creating 1: Running 3: Unsubscribed 4: Expired and stopped 5: Expired and recycled 8: Unsubscribed and stopped\n" }, "billingType": { "type": "integer", "description": "Billing method of the bandwidth package. Valid values: 1 (default): yearly/monthly subscription. 4: pay-as-you-go—95th percentile billing.\n" }, "businessStatus": { "type": "string", "description": "Frozen status of the bandwidth package. Normal: normal. FinancialLocked: frozen.\n" }, "cenBandwidthPackageId": { "type": "string", "description": "Bandwidth package ID.\n" }, "cenBandwidthPackageName": { "type": "string", "description": "Name of the bandwidth package. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the bandwidth package ID.\n" }, "cenIds": { "type": "array", "items": { "type": "string" }, "description": "List of associated CEN instance IDs.\n" }, "creationTime": { "type": "string", "description": "Creation time of the bandwidth package.\n" }, "deletedTime": { "type": "string", "description": "Deletion time of the bandwidth package.\n" }, "description": { "type": "string", "description": "Description of the bandwidth package. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "expiredTime": { "type": "string", "description": "Expiration time of the bandwidth package.\n" }, "lineOperator": { "type": "string", "description": "Carrier for cross-border bandwidth package lines. If LocalGeographicRegionSetId and PeerGeographicRegionSetId are the same, this parameter is not supported. If LocalGeographicRegionSetId and PeerGeographicRegionSetId are different, available values are: ChinaUnicom (default): China Unicom.\n" }, "localGeographicRegionSetId": { "type": "string", "description": "Local geographic region ID for Cloud Enterprise Network communication. Available values: China: Chinese mainland. Asia: Asia-Pacific.\n" }, "peerGeographicRegionSetId": { "type": "string", "description": "Peer geographic region ID for Cloud Enterprise Network interconnection. Valid values: China: Chinese mainland. Asia: Asia-Pacific.\n" }, "period": { "type": "integer", "description": "Purchase duration of the bandwidth package. Default is 1. Valid values: If PeriodUnit is Month, range is 1–9, 12, 24, and 36. If PeriodUnit is Year, range is 1–3.\n" }, "periodUnit": { "type": "string", "description": "Billing cycle of the bandwidth package. Valid values: Month (default): month. Year: year.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the bandwidth package belongs. If not specified, defaults to 'default'.\n" }, "reclaimTime": { "type": "string", "description": "Recycle time after the bandwidth package instance expires.\n" }, "remainRenewTimes": { "type": "integer", "description": "Number of automatic renewals. Values include -1 and 1–100. Default is -1, which means unlimited automatic renewals.\n" }, "remainingBandwidth": { "type": "integer", "description": "Remaining bandwidth, measured in Mbps.\n" }, "renewPeriod": { "type": "integer", "description": "Duration of each automatic renewal, in months. Valid values: 1–3, 6, and 12. Default is 1.\n" }, "renewType": { "type": "string", "description": "Renewal type of the bandwidth package instance. Manual: Manual renewal. Auto: Automatic renewal. NoRenew: No renewal.\n" }, "status": { "type": "string", "description": "Status of the bandwidth package. Creating: Being created. Deleting: Being deleted. Pending: In progress. Available: Unbound. InUse: Bound.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/BandwidthPackageTag:BandwidthPackageTag" } }, "updateTime": { "type": "string", "description": "Update time of the bandwidth package.\n" } }, "type": "object" } }, "volcenginecc:cen/cen:Cen": { "description": "Cloud Enterprise Network (CEN) provides fast, high-quality, and stable networking capabilities to quickly build private networks (VPC) across regions and between on-premises data centers (IDC), helping you create a global cloud network with enterprise-scale and communication capabilities\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cENCENDemo:\n type: volcenginecc:cen:Cen\n name: CENCENDemo\n properties:\n cenName: CENCENDemo\n description: CENCENDemo descripiton\n projectName: iac\n tags:\n - key: dev\n value: test\n instances:\n - instance_id: vpc-3psq16gaiw4qo6csxyv***\n instance_owner_id: 21074****\n instance_region_id: cn-beijing\n instance_type: VPC\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cen/cen:Cen example \"cen_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account ID to which the CEN instance belongs\n" }, "cenBandwidthPackageIds": { "type": "array", "items": { "type": "string" }, "description": "Bandwidth package ID\n" }, "cenId": { "type": "string", "description": "CEN instance ID\n" }, "cenName": { "type": "string", "description": "Name of the CEN instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If not specified, defaults to the CEN instance ID\n" }, "creationTime": { "type": "string", "description": "Time when the CEN instance was created\n" }, "description": { "type": "string", "description": "Description for the CEN instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to empty\n" }, "instances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/CenInstance:CenInstance" } }, "projectName": { "type": "string", "description": "Name of the project to which the CEN instance belongs. If not specified, defaults to 'default'\n" }, "status": { "type": "string", "description": "Status of the CEN instance. Creating: Creating Deleting: Deleting Pending: Configuring Available: Available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/CenTag:CenTag" } }, "updateTime": { "type": "string", "description": "Time when the CEN instance was updated\n" } }, "required": [ "accountId", "cenBandwidthPackageIds", "cenId", "cenName", "creationTime", "description", "instances", "projectName", "status", "tags", "updateTime" ], "inputProperties": { "cenName": { "type": "string", "description": "Name of the CEN instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If not specified, defaults to the CEN instance ID\n" }, "description": { "type": "string", "description": "Description for the CEN instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to empty\n" }, "instances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/CenInstance:CenInstance" } }, "projectName": { "type": "string", "description": "Name of the project to which the CEN instance belongs. If not specified, defaults to 'default'\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/CenTag:CenTag" } } }, "stateInputs": { "description": "Input properties used for looking up and filtering Cen resources.\n", "properties": { "accountId": { "type": "string", "description": "Account ID to which the CEN instance belongs\n" }, "cenBandwidthPackageIds": { "type": "array", "items": { "type": "string" }, "description": "Bandwidth package ID\n" }, "cenId": { "type": "string", "description": "CEN instance ID\n" }, "cenName": { "type": "string", "description": "Name of the CEN instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If not specified, defaults to the CEN instance ID\n" }, "creationTime": { "type": "string", "description": "Time when the CEN instance was created\n" }, "description": { "type": "string", "description": "Description for the CEN instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to empty\n" }, "instances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/CenInstance:CenInstance" } }, "projectName": { "type": "string", "description": "Name of the project to which the CEN instance belongs. If not specified, defaults to 'default'\n" }, "status": { "type": "string", "description": "Status of the CEN instance. Creating: Creating Deleting: Deleting Pending: Configuring Available: Available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/CenTag:CenTag" } }, "updateTime": { "type": "string", "description": "Time when the CEN instance was updated\n" } }, "type": "object" } }, "volcenginecc:cen/grantInstance:GrantInstance": { "description": "Authorize this account's network instance for use by the specified account's Cloud Enterprise Network instance\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cenGranInstanceDemo = new volcenginecc.cen.GrantInstance(\"CenGranInstanceDemo\", {\n cenId: \"cen-2v72wo******\",\n cenOwnerId: \"210102***\",\n instanceId: \"vpc-bu3j9gfdv01s****\",\n instanceRegionId: \"cn-beijing\",\n instanceType: \"VPC\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ncen_gran_instance_demo = volcenginecc.cen.GrantInstance(\"CenGranInstanceDemo\",\n cen_id=\"cen-2v72wo******\",\n cen_owner_id=\"210102***\",\n instance_id=\"vpc-bu3j9gfdv01s****\",\n instance_region_id=\"cn-beijing\",\n instance_type=\"VPC\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cenGranInstanceDemo = new Volcenginecc.Cen.GrantInstance(\"CenGranInstanceDemo\", new()\n {\n CenId = \"cen-2v72wo******\",\n CenOwnerId = \"210102***\",\n InstanceId = \"vpc-bu3j9gfdv01s****\",\n InstanceRegionId = \"cn-beijing\",\n InstanceType = \"VPC\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cen\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cen.NewGrantInstance(ctx, \"CenGranInstanceDemo\", \u0026cen.GrantInstanceArgs{\n\t\t\tCenId: pulumi.String(\"cen-2v72wo******\"),\n\t\t\tCenOwnerId: pulumi.String(\"210102***\"),\n\t\t\tInstanceId: pulumi.String(\"vpc-bu3j9gfdv01s****\"),\n\t\t\tInstanceRegionId: pulumi.String(\"cn-beijing\"),\n\t\t\tInstanceType: pulumi.String(\"VPC\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cen.GrantInstance;\nimport com.volcengine.volcenginecc.cen.GrantInstanceArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cenGranInstanceDemo = new GrantInstance(\"cenGranInstanceDemo\", GrantInstanceArgs.builder()\n .cenId(\"cen-2v72wo******\")\n .cenOwnerId(\"210102***\")\n .instanceId(\"vpc-bu3j9gfdv01s****\")\n .instanceRegionId(\"cn-beijing\")\n .instanceType(\"VPC\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cenGranInstanceDemo:\n type: volcenginecc:cen:GrantInstance\n name: CenGranInstanceDemo\n properties:\n cenId: cen-2v72wo******\n cenOwnerId: 210102***\n instanceId: vpc-bu3j9gfdv01s****\n instanceRegionId: cn-beijing\n instanceType: VPC\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cen/grantInstance:GrantInstance example \"instance_id|cen_id\"\n```\n\n", "properties": { "cenId": { "type": "string", "description": "Cloud Enterprise Network instance ID of the other party's account\n" }, "cenOwnerId": { "type": "string", "description": "Other party's account\n" }, "creationTime": { "type": "string", "description": "Network instance authorization time\n" }, "instanceId": { "type": "string", "description": "ID of the network instance to be authorized\n" }, "instanceRegionId": { "type": "string", "description": "Region where the network instance is located\n" }, "instanceType": { "type": "string", "description": "Network instance type. Options: VPC: Virtual Private Cloud. DCGW: Direct Connect Gateway\n" } }, "required": [ "cenId", "cenOwnerId", "creationTime", "instanceId", "instanceRegionId", "instanceType" ], "inputProperties": { "cenId": { "type": "string", "description": "Cloud Enterprise Network instance ID of the other party's account\n" }, "cenOwnerId": { "type": "string", "description": "Other party's account\n" }, "instanceId": { "type": "string", "description": "ID of the network instance to be authorized\n" }, "instanceRegionId": { "type": "string", "description": "Region where the network instance is located\n" }, "instanceType": { "type": "string", "description": "Network instance type. Options: VPC: Virtual Private Cloud. DCGW: Direct Connect Gateway\n" } }, "requiredInputs": [ "cenId", "cenOwnerId", "instanceId", "instanceRegionId", "instanceType" ], "stateInputs": { "description": "Input properties used for looking up and filtering GrantInstance resources.\n", "properties": { "cenId": { "type": "string", "description": "Cloud Enterprise Network instance ID of the other party's account\n" }, "cenOwnerId": { "type": "string", "description": "Other party's account\n" }, "creationTime": { "type": "string", "description": "Network instance authorization time\n" }, "instanceId": { "type": "string", "description": "ID of the network instance to be authorized\n" }, "instanceRegionId": { "type": "string", "description": "Region where the network instance is located\n" }, "instanceType": { "type": "string", "description": "Network instance type. Options: VPC: Virtual Private Cloud. DCGW: Direct Connect Gateway\n" } }, "type": "object" } }, "volcenginecc:cen/interRegionBandwidth:InterRegionBandwidth": { "description": "CEN inter-region bandwidth, used to allocate cross-region connectivity bandwidth for Cloud Enterprise Network instances.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cENInterRegionBandwidthDemo = new volcenginecc.cen.InterRegionBandwidth(\"CENInterRegionBandwidthDemo\", {\n localRegionId: \"cn-beijing\",\n peerRegionId: \"cn-shanghai\",\n bandwidth: 1,\n cenId: \"cen-2v73nw1h8a03k6x7exxxxx\",\n cenBandwidthPackageId: \"cbp-mikp555wa4u85smt1xxxxxx\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_en_inter_region_bandwidth_demo = volcenginecc.cen.InterRegionBandwidth(\"CENInterRegionBandwidthDemo\",\n local_region_id=\"cn-beijing\",\n peer_region_id=\"cn-shanghai\",\n bandwidth=1,\n cen_id=\"cen-2v73nw1h8a03k6x7exxxxx\",\n cen_bandwidth_package_id=\"cbp-mikp555wa4u85smt1xxxxxx\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cENInterRegionBandwidthDemo = new Volcenginecc.Cen.InterRegionBandwidth(\"CENInterRegionBandwidthDemo\", new()\n {\n LocalRegionId = \"cn-beijing\",\n PeerRegionId = \"cn-shanghai\",\n Bandwidth = 1,\n CenId = \"cen-2v73nw1h8a03k6x7exxxxx\",\n CenBandwidthPackageId = \"cbp-mikp555wa4u85smt1xxxxxx\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cen\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cen.NewInterRegionBandwidth(ctx, \"CENInterRegionBandwidthDemo\", \u0026cen.InterRegionBandwidthArgs{\n\t\t\tLocalRegionId: pulumi.String(\"cn-beijing\"),\n\t\t\tPeerRegionId: pulumi.String(\"cn-shanghai\"),\n\t\t\tBandwidth: pulumi.Int(1),\n\t\t\tCenId: pulumi.String(\"cen-2v73nw1h8a03k6x7exxxxx\"),\n\t\t\tCenBandwidthPackageId: pulumi.String(\"cbp-mikp555wa4u85smt1xxxxxx\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cen.InterRegionBandwidth;\nimport com.volcengine.volcenginecc.cen.InterRegionBandwidthArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cENInterRegionBandwidthDemo = new InterRegionBandwidth(\"cENInterRegionBandwidthDemo\", InterRegionBandwidthArgs.builder()\n .localRegionId(\"cn-beijing\")\n .peerRegionId(\"cn-shanghai\")\n .bandwidth(1)\n .cenId(\"cen-2v73nw1h8a03k6x7exxxxx\")\n .cenBandwidthPackageId(\"cbp-mikp555wa4u85smt1xxxxxx\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cENInterRegionBandwidthDemo:\n type: volcenginecc:cen:InterRegionBandwidth\n name: CENInterRegionBandwidthDemo\n properties:\n localRegionId: cn-beijing\n peerRegionId: cn-shanghai\n bandwidth: 1\n cenId: cen-2v73nw1h8a03k6x7exxxxx\n cenBandwidthPackageId: cbp-mikp555wa4u85smt1xxxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cen/interRegionBandwidth:InterRegionBandwidth example \"inter_region_bandwidth_id\"\n```\n\n", "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of CEN inter-region bandwidth, measured in Mbps. The value cannot exceed the bandwidth that can be allocated by the associated bandwidth package.\n" }, "cenBandwidthPackageId": { "type": "string", "description": "Instance ID of the bandwidth package.\n" }, "cenId": { "type": "string", "description": "ID of the Cloud Enterprise Network instance.\n" }, "creationTime": { "type": "string", "description": "Time when the CEN inter-region bandwidth was created.\n" }, "interRegionBandwidthId": { "type": "string", "description": "ID of the CEN inter-region bandwidth.\n" }, "localRegionId": { "type": "string", "description": "ID of the local region for CEN inter-region bandwidth.\n" }, "peerRegionId": { "type": "string", "description": "ID of the remote region for CEN inter-region bandwidth.\n" }, "status": { "type": "string", "description": "Status of CEN inter-region bandwidth. Creating: Being created. Deleting: Being deleted. Pending: Configuring. Available: Available.\n" }, "updateTime": { "type": "string", "description": "Time when the CEN inter-region bandwidth was updated.\n" } }, "required": [ "bandwidth", "cenBandwidthPackageId", "cenId", "creationTime", "interRegionBandwidthId", "localRegionId", "peerRegionId", "status", "updateTime" ], "inputProperties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of CEN inter-region bandwidth, measured in Mbps. The value cannot exceed the bandwidth that can be allocated by the associated bandwidth package.\n" }, "cenBandwidthPackageId": { "type": "string", "description": "Instance ID of the bandwidth package.\n" }, "cenId": { "type": "string", "description": "ID of the Cloud Enterprise Network instance.\n" }, "localRegionId": { "type": "string", "description": "ID of the local region for CEN inter-region bandwidth.\n" }, "peerRegionId": { "type": "string", "description": "ID of the remote region for CEN inter-region bandwidth.\n" } }, "requiredInputs": [ "bandwidth", "cenId", "localRegionId", "peerRegionId" ], "stateInputs": { "description": "Input properties used for looking up and filtering InterRegionBandwidth resources.\n", "properties": { "bandwidth": { "type": "integer", "description": "Peak bandwidth of CEN inter-region bandwidth, measured in Mbps. The value cannot exceed the bandwidth that can be allocated by the associated bandwidth package.\n" }, "cenBandwidthPackageId": { "type": "string", "description": "Instance ID of the bandwidth package.\n" }, "cenId": { "type": "string", "description": "ID of the Cloud Enterprise Network instance.\n" }, "creationTime": { "type": "string", "description": "Time when the CEN inter-region bandwidth was created.\n" }, "interRegionBandwidthId": { "type": "string", "description": "ID of the CEN inter-region bandwidth.\n" }, "localRegionId": { "type": "string", "description": "ID of the local region for CEN inter-region bandwidth.\n" }, "peerRegionId": { "type": "string", "description": "ID of the remote region for CEN inter-region bandwidth.\n" }, "status": { "type": "string", "description": "Status of CEN inter-region bandwidth. Creating: Being created. Deleting: Being deleted. Pending: Configuring. Available: Available.\n" }, "updateTime": { "type": "string", "description": "Time when the CEN inter-region bandwidth was updated.\n" } }, "type": "object" } }, "volcenginecc:cen/routeEntry:RouteEntry": { "description": "Cloud enterprise network route entry, used to publish the route entry of a network instance to the cloud enterprise network\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cENRouteEntryDemo = new volcenginecc.cen.RouteEntry(\"CENRouteEntryDemo\", {\n instanceType: \"VPC\",\n instanceRegionId: \"cn-beijing\",\n instanceId: \"vpc-iirjlwem73eo74o8ctxxxxx\",\n destinationCidrBlock: \"192.x.0.0/24\",\n cenId: \"cen-2v73nw1h8a03k6x7e8xxxxx\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_en_route_entry_demo = volcenginecc.cen.RouteEntry(\"CENRouteEntryDemo\",\n instance_type=\"VPC\",\n instance_region_id=\"cn-beijing\",\n instance_id=\"vpc-iirjlwem73eo74o8ctxxxxx\",\n destination_cidr_block=\"192.x.0.0/24\",\n cen_id=\"cen-2v73nw1h8a03k6x7e8xxxxx\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cENRouteEntryDemo = new Volcenginecc.Cen.RouteEntry(\"CENRouteEntryDemo\", new()\n {\n InstanceType = \"VPC\",\n InstanceRegionId = \"cn-beijing\",\n InstanceId = \"vpc-iirjlwem73eo74o8ctxxxxx\",\n DestinationCidrBlock = \"192.x.0.0/24\",\n CenId = \"cen-2v73nw1h8a03k6x7e8xxxxx\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cen\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cen.NewRouteEntry(ctx, \"CENRouteEntryDemo\", \u0026cen.RouteEntryArgs{\n\t\t\tInstanceType: pulumi.String(\"VPC\"),\n\t\t\tInstanceRegionId: pulumi.String(\"cn-beijing\"),\n\t\t\tInstanceId: pulumi.String(\"vpc-iirjlwem73eo74o8ctxxxxx\"),\n\t\t\tDestinationCidrBlock: pulumi.String(\"192.x.0.0/24\"),\n\t\t\tCenId: pulumi.String(\"cen-2v73nw1h8a03k6x7e8xxxxx\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cen.RouteEntry;\nimport com.volcengine.volcenginecc.cen.RouteEntryArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cENRouteEntryDemo = new RouteEntry(\"cENRouteEntryDemo\", RouteEntryArgs.builder()\n .instanceType(\"VPC\")\n .instanceRegionId(\"cn-beijing\")\n .instanceId(\"vpc-iirjlwem73eo74o8ctxxxxx\")\n .destinationCidrBlock(\"192.x.0.0/24\")\n .cenId(\"cen-2v73nw1h8a03k6x7e8xxxxx\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cENRouteEntryDemo:\n type: volcenginecc:cen:RouteEntry\n name: CENRouteEntryDemo\n properties:\n instanceType: VPC\n instanceRegionId: cn-beijing\n instanceId: vpc-iirjlwem73eo74o8ctxxxxx\n destinationCidrBlock: 192.x.0.0/24\n cenId: cen-2v73nw1h8a03k6x7e8xxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cen/routeEntry:RouteEntry example \"cen_id|destination_cidr_block|instance_id\"\n```\n\n", "properties": { "asPaths": { "type": "array", "items": { "type": "string" }, "description": "AS path\n" }, "cenId": { "type": "string", "description": "Cloud enterprise network instance ID\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR of the route entry\n" }, "instanceId": { "type": "string", "description": "Network instance ID\n" }, "instanceRegionId": { "type": "string", "description": "Region ID of the network instance\n" }, "instanceType": { "type": "string", "description": "Network instance type\n" }, "publishStatus": { "type": "string", "description": "Publish status of the route entry\n" }, "status": { "type": "string", "description": "Effective status of the route entry\n" }, "type": { "type": "string", "description": "Route entry type\n" } }, "required": [ "asPaths", "cenId", "destinationCidrBlock", "instanceId", "instanceRegionId", "instanceType", "publishStatus", "status", "type" ], "inputProperties": { "cenId": { "type": "string", "description": "Cloud enterprise network instance ID\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR of the route entry\n" }, "instanceId": { "type": "string", "description": "Network instance ID\n" }, "instanceRegionId": { "type": "string", "description": "Region ID of the network instance\n" }, "instanceType": { "type": "string", "description": "Network instance type\n" } }, "requiredInputs": [ "cenId", "destinationCidrBlock", "instanceId", "instanceRegionId", "instanceType" ], "stateInputs": { "description": "Input properties used for looking up and filtering RouteEntry resources.\n", "properties": { "asPaths": { "type": "array", "items": { "type": "string" }, "description": "AS path\n" }, "cenId": { "type": "string", "description": "Cloud enterprise network instance ID\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR of the route entry\n" }, "instanceId": { "type": "string", "description": "Network instance ID\n" }, "instanceRegionId": { "type": "string", "description": "Region ID of the network instance\n" }, "instanceType": { "type": "string", "description": "Network instance type\n" }, "publishStatus": { "type": "string", "description": "Publish status of the route entry\n" }, "status": { "type": "string", "description": "Effective status of the route entry\n" }, "type": { "type": "string", "description": "Route entry type\n" } }, "type": "object" } }, "volcenginecc:cen/serviceRouteEntry:ServiceRouteEntry": { "description": "Cloud service access.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cENServiceRouteEntryDemo:\n type: volcenginecc:cen:ServiceRouteEntry\n name: CENServiceRouteEntryDemo\n properties:\n cenId: cen-2v73nw1h8a03k6x7exxxxxx\n destinationCidrBlock: 100.x.0.0/11\n serviceVpcId: vpc-iirjlwem73eo74o8cxxxxx\n description: ccapi-test\n publishMode: Custom\n publishToInstances:\n - instance_region_id: cn-hongkong\n instance_type: VPC\n instance_id: vpc-2uzvkdpoof7cw17q7y2xxxxx\n - instance_region_id: cn-shanghai\n instance_type: VPC\n instance_id: vpc-33glll2z1gem86k70bxxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cen/serviceRouteEntry:ServiceRouteEntry example \"cen_id|destination_cidr_block\"\n```\n\n", "properties": { "cenId": { "type": "string", "description": "Cloud Enterprise Network instance ID.\n" }, "creationTime": { "type": "string", "description": "Resource creation time.\n" }, "description": { "type": "string", "description": "Custom remarks for the route.\n" }, "destinationCidrBlock": { "type": "string", "description": "Address range where the cloud service is deployed.\n" }, "publishMode": { "type": "string", "description": "Route publishing scope mode.\n" }, "publishToInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/ServiceRouteEntryPublishToInstance:ServiceRouteEntryPublishToInstance" } }, "serviceRegionId": { "type": "string", "description": "Region where the cloud service is located.\n" }, "serviceVpcId": { "type": "string", "description": "Private network ID bound to the backend cloud service.\n" }, "status": { "type": "string", "description": "Cloud service access route status.\n" } }, "required": [ "cenId", "creationTime", "description", "destinationCidrBlock", "publishMode", "publishToInstances", "serviceRegionId", "serviceVpcId", "status" ], "inputProperties": { "cenId": { "type": "string", "description": "Cloud Enterprise Network instance ID.\n" }, "creationTime": { "type": "string", "description": "Resource creation time.\n" }, "description": { "type": "string", "description": "Custom remarks for the route.\n" }, "destinationCidrBlock": { "type": "string", "description": "Address range where the cloud service is deployed.\n" }, "publishMode": { "type": "string", "description": "Route publishing scope mode.\n" }, "publishToInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/ServiceRouteEntryPublishToInstance:ServiceRouteEntryPublishToInstance" } }, "serviceVpcId": { "type": "string", "description": "Private network ID bound to the backend cloud service.\n" } }, "requiredInputs": [ "cenId", "destinationCidrBlock", "serviceVpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering ServiceRouteEntry resources.\n", "properties": { "cenId": { "type": "string", "description": "Cloud Enterprise Network instance ID.\n" }, "creationTime": { "type": "string", "description": "Resource creation time.\n" }, "description": { "type": "string", "description": "Custom remarks for the route.\n" }, "destinationCidrBlock": { "type": "string", "description": "Address range where the cloud service is deployed.\n" }, "publishMode": { "type": "string", "description": "Route publishing scope mode.\n" }, "publishToInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cen/ServiceRouteEntryPublishToInstance:ServiceRouteEntryPublishToInstance" } }, "serviceRegionId": { "type": "string", "description": "Region where the cloud service is located.\n" }, "serviceVpcId": { "type": "string", "description": "Private network ID bound to the backend cloud service.\n" }, "status": { "type": "string", "description": "Cloud service access route status.\n" } }, "type": "object" } }, "volcenginecc:clb/acl:Acl": { "description": "CLB provides listener-level access control. If you want to allow only certain IPs or deny only certain IPs from accessing the CLB instance through the listener port, you can set an access control policy for the listener.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst aclDemo = new volcenginecc.clb.Acl(\"AclDemo\", {\n aclName: \"AclDemo\",\n description: \"AclDemo Example\",\n projectName: \"default\",\n aclEntries: [\n {\n description: \"AclDemo description\",\n entry: \"1.1.2.2/32\",\n },\n {\n description: \"AclDemo description\",\n entry: \"2.2.2.2/32\",\n },\n ],\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nacl_demo = volcenginecc.clb.Acl(\"AclDemo\",\n acl_name=\"AclDemo\",\n description=\"AclDemo Example\",\n project_name=\"default\",\n acl_entries=[\n {\n \"description\": \"AclDemo description\",\n \"entry\": \"1.1.2.2/32\",\n },\n {\n \"description\": \"AclDemo description\",\n \"entry\": \"2.2.2.2/32\",\n },\n ],\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var aclDemo = new Volcenginecc.Clb.Acl(\"AclDemo\", new()\n {\n AclName = \"AclDemo\",\n Description = \"AclDemo Example\",\n ProjectName = \"default\",\n AclEntries = new[]\n {\n new Volcenginecc.Clb.Inputs.AclAclEntryArgs\n {\n Description = \"AclDemo description\",\n Entry = \"1.1.2.2/32\",\n },\n new Volcenginecc.Clb.Inputs.AclAclEntryArgs\n {\n Description = \"AclDemo description\",\n Entry = \"2.2.2.2/32\",\n },\n },\n Tags = new[]\n {\n new Volcenginecc.Clb.Inputs.AclTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/clb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := clb.NewAcl(ctx, \"AclDemo\", \u0026clb.AclArgs{\n\t\t\tAclName: pulumi.String(\"AclDemo\"),\n\t\t\tDescription: pulumi.String(\"AclDemo Example\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tAclEntries: clb.AclAclEntryArray{\n\t\t\t\t\u0026clb.AclAclEntryArgs{\n\t\t\t\t\tDescription: pulumi.String(\"AclDemo description\"),\n\t\t\t\t\tEntry: pulumi.String(\"1.1.2.2/32\"),\n\t\t\t\t},\n\t\t\t\t\u0026clb.AclAclEntryArgs{\n\t\t\t\t\tDescription: pulumi.String(\"AclDemo description\"),\n\t\t\t\t\tEntry: pulumi.String(\"2.2.2.2/32\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTags: clb.AclTagArray{\n\t\t\t\t\u0026clb.AclTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.clb.Acl;\nimport com.volcengine.volcenginecc.clb.AclArgs;\nimport com.pulumi.volcenginecc.clb.inputs.AclAclEntryArgs;\nimport com.pulumi.volcenginecc.clb.inputs.AclTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var aclDemo = new Acl(\"aclDemo\", AclArgs.builder()\n .aclName(\"AclDemo\")\n .description(\"AclDemo Example\")\n .projectName(\"default\")\n .aclEntries( \n AclAclEntryArgs.builder()\n .description(\"AclDemo description\")\n .entry(\"1.1.2.2/32\")\n .build(),\n AclAclEntryArgs.builder()\n .description(\"AclDemo description\")\n .entry(\"2.2.2.2/32\")\n .build())\n .tags(AclTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n aclDemo:\n type: volcenginecc:clb:Acl\n name: AclDemo\n properties:\n aclName: AclDemo\n description: AclDemo Example\n projectName: default\n aclEntries:\n - description: AclDemo description\n entry: 1.1.2.2/32\n - description: AclDemo description\n entry: 2.2.2.2/32\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/acl:Acl example \"acl_id\"\n```\n\n", "properties": { "aclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/AclAclEntry:AclAclEntry" } }, "aclEntryCount": { "type": "integer", "description": "Number of IP entries contained in the access control policy group.\n" }, "aclId": { "type": "string", "description": "Access control policy group ID\n" }, "aclName": { "type": "string", "description": "Name of the access control policy group. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the access control policy group ID.\n" }, "createTime": { "type": "string", "description": "Creation time of the access control policy group\n" }, "description": { "type": "string", "description": "Description of the access control policy group. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/AclListener:AclListener" } }, "projectName": { "type": "string", "description": "Name of the project to which the access control policy group belongs. If not specified, defaults to 'default'.\n" }, "serviceManaged": { "type": "boolean", "description": "Is this a managed resource. true: yes. false: no.\n" }, "status": { "type": "string", "description": "Status of the access control policy group. Creating: creating. Active: available. Configuring: configuring. Deleting: deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/AclTag:AclTag" } }, "updateTime": { "type": "string", "description": "Last operation time of the access control policy group\n" } }, "required": [ "aclEntries", "aclEntryCount", "aclId", "aclName", "createTime", "description", "listeners", "projectName", "serviceManaged", "status", "tags", "updateTime" ], "inputProperties": { "aclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/AclAclEntry:AclAclEntry" } }, "aclName": { "type": "string", "description": "Name of the access control policy group. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the access control policy group ID.\n" }, "description": { "type": "string", "description": "Description of the access control policy group. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the access control policy group belongs. If not specified, defaults to 'default'.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/AclTag:AclTag" } } }, "stateInputs": { "description": "Input properties used for looking up and filtering Acl resources.\n", "properties": { "aclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/AclAclEntry:AclAclEntry" } }, "aclEntryCount": { "type": "integer", "description": "Number of IP entries contained in the access control policy group.\n" }, "aclId": { "type": "string", "description": "Access control policy group ID\n" }, "aclName": { "type": "string", "description": "Name of the access control policy group. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the access control policy group ID.\n" }, "createTime": { "type": "string", "description": "Creation time of the access control policy group\n" }, "description": { "type": "string", "description": "Description of the access control policy group. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/AclListener:AclListener" } }, "projectName": { "type": "string", "description": "Name of the project to which the access control policy group belongs. If not specified, defaults to 'default'.\n" }, "serviceManaged": { "type": "boolean", "description": "Is this a managed resource. true: yes. false: no.\n" }, "status": { "type": "string", "description": "Status of the access control policy group. Creating: creating. Active: available. Configuring: configuring. Deleting: deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/AclTag:AclTag" } }, "updateTime": { "type": "string", "description": "Last operation time of the access control policy group\n" } }, "type": "object" } }, "volcenginecc:clb/certificate:Certificate": { "description": "Provides unified certificate management service for HTTPS protocol. Certificates do not need to be uploaded to backend servers. Supports decryption processing on CLB instances, reducing CPU overhead on backend servers.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst certificatDemo = new volcenginecc.clb.Certificate(\"CertificatDemo\", {\n certificateName: \"CertificatDemo\",\n privateKey: \"-----BEGIN RSA PRIVATE KEY-----***----END RSA PRIVATE KEY-----\",\n publicKey: `-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----`,\n description: \"CertificateDemo Example\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ncertificat_demo = volcenginecc.clb.Certificate(\"CertificatDemo\",\n certificate_name=\"CertificatDemo\",\n private_key=\"-----BEGIN RSA PRIVATE KEY-----***----END RSA PRIVATE KEY-----\",\n public_key=\"\"\"-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\"\"\",\n description=\"CertificateDemo Example\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var certificatDemo = new Volcenginecc.Clb.Certificate(\"CertificatDemo\", new()\n {\n CertificateName = \"CertificatDemo\",\n PrivateKey = \"-----BEGIN RSA PRIVATE KEY-----***----END RSA PRIVATE KEY-----\",\n PublicKey = @\"-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\",\n Description = \"CertificateDemo Example\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Clb.Inputs.CertificateTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/clb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := clb.NewCertificate(ctx, \"CertificatDemo\", \u0026clb.CertificateArgs{\n\t\t\tCertificateName: pulumi.String(\"CertificatDemo\"),\n\t\t\tPrivateKey: pulumi.String(\"-----BEGIN RSA PRIVATE KEY-----***----END RSA PRIVATE KEY-----\"),\n\t\t\tPublicKey: pulumi.String(\"-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\"),\n\t\t\tDescription: pulumi.String(\"CertificateDemo Example\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: clb.CertificateTagArray{\n\t\t\t\t\u0026clb.CertificateTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.clb.Certificate;\nimport com.volcengine.volcenginecc.clb.CertificateArgs;\nimport com.pulumi.volcenginecc.clb.inputs.CertificateTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var certificatDemo = new Certificate(\"certificatDemo\", CertificateArgs.builder()\n .certificateName(\"CertificatDemo\")\n .privateKey(\"-----BEGIN RSA PRIVATE KEY-----***----END RSA PRIVATE KEY-----\")\n .publicKey(\"\"\"\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----***-----END CERTIFICATE----- \"\"\")\n .description(\"CertificateDemo Example\")\n .projectName(\"default\")\n .tags(CertificateTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n certificatDemo:\n type: volcenginecc:clb:Certificate\n name: CertificatDemo\n properties:\n certificateName: CertificatDemo\n privateKey: '-----BEGIN RSA PRIVATE KEY-----***----END RSA PRIVATE KEY-----'\n publicKey: |-\n -----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n -----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n -----BEGIN CERTIFICATE-----***-----END CERTIFICATE-----\n description: CertificateDemo Example\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/certificate:Certificate example \"certificate_id\"\n```\n\n", "properties": { "certificateId": { "type": "string", "description": "Certificate ID.\n" }, "certificateName": { "type": "string", "description": "Certificate name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters.\n" }, "createdTime": { "type": "string", "description": "Certificate creation time.\n" }, "description": { "type": "string", "description": "Certificate description. Default value is an empty string. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.\n" }, "domainName": { "type": "string", "description": "Certificate primary domain name.\n" }, "expiredAt": { "type": "string", "description": "Certificate expiration time.\n" }, "listeners": { "type": "array", "items": { "type": "string" }, "description": "ID of the listener associated with the certificate.\n" }, "privateKey": { "type": "string", "description": "Certificate private key.\n" }, "projectName": { "type": "string", "description": "Name of the project the certificate belongs to. If not specified, defaults to 'default'.\n" }, "publicKey": { "type": "string", "description": "Certificate public key.\n" }, "serviceManaged": { "type": "boolean", "description": "Managed resource status. true: managed resource. false: unmanaged resource.\n" }, "subjectAlternativeNames": { "type": "array", "items": { "type": "string" }, "description": "List of alternate domain names for the certificate.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/CertificateTag:CertificateTag" } } }, "required": [ "certificateId", "certificateName", "createdTime", "description", "domainName", "expiredAt", "listeners", "privateKey", "projectName", "publicKey", "serviceManaged", "subjectAlternativeNames", "tags" ], "inputProperties": { "certificateName": { "type": "string", "description": "Certificate name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters.\n" }, "description": { "type": "string", "description": "Certificate description. Default value is an empty string. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.\n" }, "privateKey": { "type": "string", "description": "Certificate private key.\n" }, "projectName": { "type": "string", "description": "Name of the project the certificate belongs to. If not specified, defaults to 'default'.\n" }, "publicKey": { "type": "string", "description": "Certificate public key.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/CertificateTag:CertificateTag" } } }, "requiredInputs": [ "privateKey", "publicKey" ], "stateInputs": { "description": "Input properties used for looking up and filtering Certificate resources.\n", "properties": { "certificateId": { "type": "string", "description": "Certificate ID.\n" }, "certificateName": { "type": "string", "description": "Certificate name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters.\n" }, "createdTime": { "type": "string", "description": "Certificate creation time.\n" }, "description": { "type": "string", "description": "Certificate description. Default value is an empty string. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.\n" }, "domainName": { "type": "string", "description": "Certificate primary domain name.\n" }, "expiredAt": { "type": "string", "description": "Certificate expiration time.\n" }, "listeners": { "type": "array", "items": { "type": "string" }, "description": "ID of the listener associated with the certificate.\n" }, "privateKey": { "type": "string", "description": "Certificate private key.\n" }, "projectName": { "type": "string", "description": "Name of the project the certificate belongs to. If not specified, defaults to 'default'.\n" }, "publicKey": { "type": "string", "description": "Certificate public key.\n" }, "serviceManaged": { "type": "boolean", "description": "Managed resource status. true: managed resource. false: unmanaged resource.\n" }, "subjectAlternativeNames": { "type": "array", "items": { "type": "string" }, "description": "List of alternate domain names for the certificate.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/CertificateTag:CertificateTag" } } }, "type": "object" } }, "volcenginecc:clb/clb:Clb": { "description": "Load balancer instance\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cLBDemo:\n type: volcenginecc:clb:Clb\n name: CLBDemo\n properties:\n loadBalancerName: CLBDemo\n loadBalancerSpec: small_1\n addressIpVersion: ipv4\n bypassSecurityGroupEnabled: off\n description: CLBDemo description\n loadBalancerBillingType: 2\n masterZoneId: cn-beijing-a\n slaveZoneId: cn-beijing-b\n modificationProtectionReason: xx\n modificationProtectionStatus: xx\n period: 1\n periodUnit: Month\n projectName: default\n regionId: cn-beijing\n subnetId: subnet-rrwqhg3qzxfkv0x57g3xxxx\n type: public\n vpcId: vpc-rrco37ovjq4gv0x58zfxxxx\n eip:\n isp: BGP\n bandwidth: 1\n eip_billing_type: 3\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/clb:Clb example \"load_balancer_id\"\n```\n\n", "properties": { "accessLog": { "$ref": "#/types/volcenginecc:clb/ClbAccessLog:ClbAccessLog", "description": "Access log information in the load balancer instance\n" }, "accountId": { "type": "string", "description": "Account ID to which the load balancer instance belongs\n" }, "addressIpVersion": { "type": "string", "description": "IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private\n" }, "allowedPorts": { "type": "array", "items": { "type": "string" }, "description": "Allowed port ranges\n" }, "autoRenewal": { "type": "boolean", "description": "Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No\n" }, "businessStatus": { "type": "string", "description": "Whether the load balancer instance is locked\n" }, "bypassSecurityGroupEnabled": { "type": "string", "description": "Whether to enable bypass security group feature\n" }, "createTime": { "type": "string", "description": "Creation time of the load balancer instance\n" }, "deletedTime": { "type": "string", "description": "Expected recycling time of the load balancer instance\n" }, "description": { "type": "string", "description": "Description of the load balancer instance\n" }, "eip": { "$ref": "#/types/volcenginecc:clb/ClbEip:ClbEip", "description": "Public IP information of the load balancer instance\n" }, "eipAddress": { "type": "string", "description": "Public IP address\n" }, "eipId": { "type": "string", "description": "Public IP ID\n" }, "enabled": { "type": "boolean", "description": "Enable status of the load balancer instance\n" }, "eni": { "$ref": "#/types/volcenginecc:clb/ClbEni:ClbEni", "description": "Private IPv4 address information of the load balancer instance\n" }, "eniAddressNum": { "type": "number", "description": "Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required\n" }, "eniIpv6Address": { "type": "string", "description": "Private IPv6 address of the load balancer instance\n" }, "enis": { "$ref": "#/types/volcenginecc:clb/ClbEnis:ClbEnis", "description": "List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation\n" }, "exclusiveClusterId": { "type": "string", "description": "Dedicated cluster ID\n" }, "expiredTime": { "type": "string", "description": "Expiration time of the load balancer instance\n" }, "ipv6AddressBandwidth": { "$ref": "#/types/volcenginecc:clb/ClbIpv6AddressBandwidth:ClbIpv6AddressBandwidth", "description": "IPv6 public bandwidth information for the load balancing instance\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ClbListener:ClbListener" } }, "loadBalancerBillingType": { "type": "number", "description": "CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)\n" }, "loadBalancerId": { "type": "string", "description": "Load balancer instance ID\n" }, "loadBalancerName": { "type": "string", "description": "Name of the load balancer instance\n" }, "loadBalancerSpec": { "type": "string", "description": "CLB instance specification. Different specifications provide different forwarding capabilities. small*1: Small I. small*2: Small II. medium*1: Medium I. medium*2: Medium II. large*1: Large I. large*2: Large II\n" }, "lockReason": { "type": "string", "description": "Reason why the load balancer instance is frozen\n" }, "masterZoneId": { "type": "string", "description": "Main availability zone ID of the load balancer instance\n" }, "modificationProtectionReason": { "type": "string", "description": "Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters\n" }, "modificationProtectionStatus": { "type": "string", "description": "Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled\n" }, "newArch": { "type": "boolean", "description": "Whether it is a new architecture\n" }, "orderId": { "type": "string", "description": "Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation\n" }, "overdueTime": { "type": "string", "description": "Freeze time of the load balancer instance\n" }, "period": { "type": "number", "description": "Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3\n" }, "periodUnit": { "type": "string", "description": "Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year\n" }, "projectName": { "type": "string", "description": "Name of the project associated with the CLB instance\n" }, "serverGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ClbServerGroup:ClbServerGroup" } }, "serviceManaged": { "type": "boolean", "description": "Whether the CLB instance is a managed resource\n" }, "slaveZoneId": { "type": "string", "description": "Secondary availability zone ID of the load balancer instance\n" }, "status": { "type": "string", "description": "Load balancer instance status: Inactive: stopped. Active: running. Creating: creating. Provisioning: creating. Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.\n" }, "subnetId": { "type": "string", "description": "Subnet ID within the VPC of the load balancer instance\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ClbTag:ClbTag" } }, "timestampRemoveEnabled": { "type": "string", "description": "Enable TCP timestamp removal\n" }, "type": { "type": "string", "description": "CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests\n" }, "updateTime": { "type": "string", "description": "Most recent operation time of the load balancer instance\n" }, "vpcId": { "type": "string", "description": "VPC ID of the load balancer instance\n" }, "zoneType": { "type": "string", "description": "Availability zone type of the load balancer instance\n" } }, "required": [ "accessLog", "accountId", "addressIpVersion", "allowedPorts", "autoRenewal", "businessStatus", "bypassSecurityGroupEnabled", "createTime", "deletedTime", "description", "eip", "eipAddress", "eipId", "enabled", "eni", "eniAddressNum", "eniIpv6Address", "enis", "exclusiveClusterId", "expiredTime", "ipv6AddressBandwidth", "listeners", "loadBalancerBillingType", "loadBalancerId", "loadBalancerName", "loadBalancerSpec", "lockReason", "masterZoneId", "modificationProtectionReason", "modificationProtectionStatus", "newArch", "orderId", "overdueTime", "period", "periodUnit", "projectName", "serverGroups", "serviceManaged", "slaveZoneId", "status", "subnetId", "tags", "timestampRemoveEnabled", "type", "updateTime", "vpcId", "zoneType" ], "inputProperties": { "accessLog": { "$ref": "#/types/volcenginecc:clb/ClbAccessLog:ClbAccessLog", "description": "Access log information in the load balancer instance\n" }, "addressIpVersion": { "type": "string", "description": "IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private\n" }, "allowedPorts": { "type": "array", "items": { "type": "string" }, "description": "Allowed port ranges\n" }, "autoRenewal": { "type": "boolean", "description": "Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No\n" }, "bypassSecurityGroupEnabled": { "type": "string", "description": "Whether to enable bypass security group feature\n" }, "description": { "type": "string", "description": "Description of the load balancer instance\n" }, "eip": { "$ref": "#/types/volcenginecc:clb/ClbEip:ClbEip", "description": "Public IP information of the load balancer instance\n" }, "eipAddress": { "type": "string", "description": "Public IP address\n" }, "eipId": { "type": "string", "description": "Public IP ID\n" }, "eniAddressNum": { "type": "number", "description": "Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required\n" }, "enis": { "$ref": "#/types/volcenginecc:clb/ClbEnis:ClbEnis", "description": "List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation\n" }, "exclusiveClusterId": { "type": "string", "description": "Dedicated cluster ID\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ClbListener:ClbListener" } }, "loadBalancerBillingType": { "type": "number", "description": "CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)\n" }, "loadBalancerName": { "type": "string", "description": "Name of the load balancer instance\n" }, "loadBalancerSpec": { "type": "string", "description": "CLB instance specification. Different specifications provide different forwarding capabilities. small*1: Small I. small*2: Small II. medium*1: Medium I. medium*2: Medium II. large*1: Large I. large*2: Large II\n" }, "masterZoneId": { "type": "string", "description": "Main availability zone ID of the load balancer instance\n" }, "modificationProtectionReason": { "type": "string", "description": "Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters\n" }, "modificationProtectionStatus": { "type": "string", "description": "Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled\n" }, "newArch": { "type": "boolean", "description": "Whether it is a new architecture\n" }, "orderId": { "type": "string", "description": "Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation\n" }, "period": { "type": "number", "description": "Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3\n" }, "periodUnit": { "type": "string", "description": "Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year\n" }, "projectName": { "type": "string", "description": "Name of the project associated with the CLB instance\n" }, "serverGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ClbServerGroup:ClbServerGroup" } }, "slaveZoneId": { "type": "string", "description": "Secondary availability zone ID of the load balancer instance\n" }, "subnetId": { "type": "string", "description": "Subnet ID within the VPC of the load balancer instance\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ClbTag:ClbTag" } }, "type": { "type": "string", "description": "CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests\n" }, "vpcId": { "type": "string", "description": "VPC ID of the load balancer instance\n" }, "zoneType": { "type": "string", "description": "Availability zone type of the load balancer instance\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Clb resources.\n", "properties": { "accessLog": { "$ref": "#/types/volcenginecc:clb/ClbAccessLog:ClbAccessLog", "description": "Access log information in the load balancer instance\n" }, "accountId": { "type": "string", "description": "Account ID to which the load balancer instance belongs\n" }, "addressIpVersion": { "type": "string", "description": "IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private\n" }, "allowedPorts": { "type": "array", "items": { "type": "string" }, "description": "Allowed port ranges\n" }, "autoRenewal": { "type": "boolean", "description": "Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No\n" }, "businessStatus": { "type": "string", "description": "Whether the load balancer instance is locked\n" }, "bypassSecurityGroupEnabled": { "type": "string", "description": "Whether to enable bypass security group feature\n" }, "createTime": { "type": "string", "description": "Creation time of the load balancer instance\n" }, "deletedTime": { "type": "string", "description": "Expected recycling time of the load balancer instance\n" }, "description": { "type": "string", "description": "Description of the load balancer instance\n" }, "eip": { "$ref": "#/types/volcenginecc:clb/ClbEip:ClbEip", "description": "Public IP information of the load balancer instance\n" }, "eipAddress": { "type": "string", "description": "Public IP address\n" }, "eipId": { "type": "string", "description": "Public IP ID\n" }, "enabled": { "type": "boolean", "description": "Enable status of the load balancer instance\n" }, "eni": { "$ref": "#/types/volcenginecc:clb/ClbEni:ClbEni", "description": "Private IPv4 address information of the load balancer instance\n" }, "eniAddressNum": { "type": "number", "description": "Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required\n" }, "eniIpv6Address": { "type": "string", "description": "Private IPv6 address of the load balancer instance\n" }, "enis": { "$ref": "#/types/volcenginecc:clb/ClbEnis:ClbEnis", "description": "List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation\n" }, "exclusiveClusterId": { "type": "string", "description": "Dedicated cluster ID\n" }, "expiredTime": { "type": "string", "description": "Expiration time of the load balancer instance\n" }, "ipv6AddressBandwidth": { "$ref": "#/types/volcenginecc:clb/ClbIpv6AddressBandwidth:ClbIpv6AddressBandwidth", "description": "IPv6 public bandwidth information for the load balancing instance\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ClbListener:ClbListener" } }, "loadBalancerBillingType": { "type": "number", "description": "CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)\n" }, "loadBalancerId": { "type": "string", "description": "Load balancer instance ID\n" }, "loadBalancerName": { "type": "string", "description": "Name of the load balancer instance\n" }, "loadBalancerSpec": { "type": "string", "description": "CLB instance specification. Different specifications provide different forwarding capabilities. small*1: Small I. small*2: Small II. medium*1: Medium I. medium*2: Medium II. large*1: Large I. large*2: Large II\n" }, "lockReason": { "type": "string", "description": "Reason why the load balancer instance is frozen\n" }, "masterZoneId": { "type": "string", "description": "Main availability zone ID of the load balancer instance\n" }, "modificationProtectionReason": { "type": "string", "description": "Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters\n" }, "modificationProtectionStatus": { "type": "string", "description": "Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled\n" }, "newArch": { "type": "boolean", "description": "Whether it is a new architecture\n" }, "orderId": { "type": "string", "description": "Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation\n" }, "overdueTime": { "type": "string", "description": "Freeze time of the load balancer instance\n" }, "period": { "type": "number", "description": "Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3\n" }, "periodUnit": { "type": "string", "description": "Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year\n" }, "projectName": { "type": "string", "description": "Name of the project associated with the CLB instance\n" }, "serverGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ClbServerGroup:ClbServerGroup" } }, "serviceManaged": { "type": "boolean", "description": "Whether the CLB instance is a managed resource\n" }, "slaveZoneId": { "type": "string", "description": "Secondary availability zone ID of the load balancer instance\n" }, "status": { "type": "string", "description": "Load balancer instance status: Inactive: stopped. Active: running. Creating: creating. Provisioning: creating. Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.\n" }, "subnetId": { "type": "string", "description": "Subnet ID within the VPC of the load balancer instance\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ClbTag:ClbTag" } }, "timestampRemoveEnabled": { "type": "string", "description": "Enable TCP timestamp removal\n" }, "type": { "type": "string", "description": "CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests\n" }, "updateTime": { "type": "string", "description": "Most recent operation time of the load balancer instance\n" }, "vpcId": { "type": "string", "description": "VPC ID of the load balancer instance\n" }, "zoneType": { "type": "string", "description": "Availability zone type of the load balancer instance\n" } }, "type": "object" } }, "volcenginecc:clb/listener:Listener": { "description": "The listener monitors user access requests received by the CLB instance based on the specified protocol and port. CLB forwards access requests to healthy backend servers in the associated backend server group according to the scheduling algorithm configured for the listener.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n clbListenerDemo:\n type: volcenginecc:clb:Listener\n name: ClbListenerDemo\n properties:\n aclIds:\n - acl-mjd01crvppts5smt1bsxxxxx\n aclStatus: on\n aclType: black\n connectionDrainEnabled: on\n connectionDrainTimeout: 900\n description: ClbListenerDemo description\n enabled: on\n establishedTimeout: 300\n serverGroupId: rsp-rs11ie8u6neov0x58bxxxxx\n healthCheck:\n enabled: on\n healthy_threshold: 3\n interval: 5\n timeout: 2\n unhealthy_threshold: 3\n port: 0\n udp_request: test\n udp_expect: test\n listenerName: ClbListenerDemo\n loadBalancerId: clb-rs1187938g00v0x58nxxxxx\n persistenceTimeout: 1000\n persistenceType: source_ip\n protocol: UDP\n port: 5001\n scheduler: wrr\n bandwidth: 1\n proxyProtocolType: standard\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/listener:Listener example \"listener_id\"\n```\n\n", "properties": { "aclIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the access control policy group bound to the listener. Returned only when the AclStatus parameter is set to on.\n" }, "aclStatus": { "type": "string", "description": "Enable access control. Values: on: enabled. off (default): disabled.\n" }, "aclType": { "type": "string", "description": "Access control mode. white: Allowlist. black: Denylist. This parameter is valid only when the AclStatus parameter is on.\n" }, "bandwidth": { "type": "integer", "description": "Bandwidth limit for the listener, which means this listener exclusively uses the bandwidth of the CLB instance. Unit: Mbps. -1 (default): This listener does not exclusively use CLB bandwidth and shares the non-exclusive bandwidth of the CLB instance with other listeners. Value range: 1 to the non-exclusive bandwidth of the CLB instance.\n" }, "caCertificateId": { "type": "string", "description": "CA certificate for mutual authentication.\n" }, "caEnabled": { "type": "string", "description": "Enable mutual authentication. on: enabled. off (default): disabled.\n" }, "certCenterCertificateId": { "type": "string", "description": "Certificate ID from Certificate Center.\n" }, "certificateId": { "type": "string", "description": "Certificate ID from the CLB certificate management module.\n" }, "certificateSource": { "type": "string", "description": "Certificate source. clb (default): certificate uploaded to CLB. cert_center: certificate uploaded to Certificate Center. user: certificate uploaded by user.\n" }, "clientBodyTimeout": { "type": "integer", "description": "Timeout for reading the client request body. This timeout applies only between two consecutive read operations, not the entire request transmission. Range: 30–120 seconds, default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "clientHeaderTimeout": { "type": "integer", "description": "Timeout for reading the client request header. Value range: 30–120 seconds. Default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "connectionDrainEnabled": { "type": "string", "description": "Whether the listener enables graceful connection termination. on: enabled. off: not enabled. When Protocol returns HTTP or HTTPS, this parameter always returns off.\n" }, "connectionDrainTimeout": { "type": "integer", "description": "Timeout for graceful connection termination, in seconds. If ConnectionDrainEnabled returns off, this parameter returns 0.\n" }, "cookie": { "type": "string", "description": "Name of the session persistence cookie configured on the backend server. This parameter is valid and required only when PersistenceType is set to server. Only letters, numbers, underscores (_), and hyphens (-) are allowed. Length must be between 1 and 200 characters.\n" }, "cps": { "type": "integer", "description": "Maximum number of new connections per second. -1 (default): No limit, which means the maximum number of new connections allowed by the CLB instance. Value range: 1 to the maximum number of new connections allowed by the CLB instance.\n" }, "createdTime": { "type": "string", "description": "Creation time of the listener.\n" }, "description": { "type": "string", "description": "Listener description. Must start with a letter, digit, or Chinese character. Can include letters, digits, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 0–255 characters. If not specified, the default is an empty string.\n" }, "domainExtensions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ListenerDomainExtension:ListenerDomainExtension" } }, "enabled": { "type": "string", "description": "Enable listener. on (default): enabled. off: disabled.\n" }, "endPort": { "type": "integer", "description": "End port for all-port listening. Range: 1–65535. When Port is '0', this parameter is required and must be greater than startPort.\n" }, "establishedTimeout": { "type": "integer", "description": "Listener connection timeout. This parameter is valid only when Protocol is set to TCP or UDP. Values: TCP protocol: 10–900 seconds, default is 900 seconds. UDP protocol: 1–300 seconds, default is 90 seconds.\n" }, "healthCheck": { "$ref": "#/types/volcenginecc:clb/ListenerHealthCheck:ListenerHealthCheck", "description": "Health check information.\n" }, "http2Enabled": { "type": "string", "description": "Whether the listener enables frontend HTTP 2.0 protocol. This parameter is valid only when Protocol is set to HTTPS. Values: on: enabled. off (default): disabled.\n" }, "keepaliveTimeout": { "type": "integer", "description": "Keep-alive timeout between the client and CLB. Range: 0–900 seconds, default is 75 seconds. 0 disables keep-alive. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "listenerName": { "type": "string", "description": "Listener name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If left blank, 'Protocol-Port' will be used as the default listener name.\n" }, "loadBalancerId": { "type": "string", "description": "ID of the CLB instance.\n" }, "maxConnections": { "type": "integer", "description": "Maximum concurrent connections limit. -1 (default): unlimited (up to the maximum concurrent connections supported by the CLB instance). Value range: 1 to the maximum concurrent connections limit of the CLB instance.\n" }, "persistenceTimeout": { "type": "integer", "description": "Session persistence timeout, in seconds. The value range depends on the PersistenceType parameter. When PersistenceType is set to source_ip, the range is 1–3600. When PersistenceType is set to insert, the range is 1–86400.\n" }, "persistenceType": { "type": "string", "description": "Session persistence type. Values: off (default): session persistence disabled. source_ip: source IP address, valid only when Protocol is TCP or UDP. insert: insert Cookie, valid only when Protocol is HTTP or HTTPS and Scheduler is wrr. server: rewrite Cookie, valid only when Protocol is HTTP or HTTPS and Scheduler is wrr.\n" }, "port": { "type": "integer", "description": "Port used by the listener to receive requests. Value range: 0–65535. When the Protocol parameter is 'TCP' or 'UDP', 0 is supported, which enables listening on all ports.\n" }, "protocol": { "type": "string", "description": "Listener protocol. Includes: TCP, UDP, HTTP, HTTPS.\n" }, "proxyConnectTimeout": { "type": "integer", "description": "Connection establishment timeout between CLB and backend server. Recommended to be greater than the health check timeout. Range: 4–120 seconds, default is 4. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "proxyProtocolType": { "type": "string", "description": "Enable Proxy-Protocol. This parameter is valid only when Protocol is TCP or UDP. Values: off (default): disabled. standard: enabled.\n" }, "proxyReadTimeout": { "type": "integer", "description": "Timeout for CLB to read responses from backend servers. This timeout applies only between two consecutive read operations, not for the entire response transmission. Value range: 30–3600 seconds. Default: 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "proxySendTimeout": { "type": "integer", "description": "Timeout for CLB to transmit requests to backend servers. This timeout applies only between two consecutive write operations, not the entire request transmission process. Value range: 30–3600 seconds. Default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "ruleIds": { "type": "array", "items": { "type": "string" }, "description": "List of rule IDs bound to the listener.\n" }, "scheduler": { "type": "string", "description": "Scheduling algorithm used by the listener. wrr (default): Weighted round robin. wlc: Weighted least connections. sh: Source address hash.\n" }, "securityPolicyId": { "type": "string", "description": "TLS security policy for HTTPS listeners. This parameter is valid only when Protocol is set to HTTPS. Values: default*policy (default): supports SSL v3, TLS v1.0, TLS v1.1, TLS v1.2. tls*cipher*policy*1*0: supports TLS v1.0, TLS v1.1, TLS v1.2. tls*cipher*policy*1*1: supports TLS v1.1, TLS v1.2. tls*cipher*policy*1*2: supports TLS v1.2. tls*cipher*policy*1*2*strict: supports TLS v1.2.\n" }, "sendTimeout": { "type": "integer", "description": "Timeout for CLB to send responses to the client. This timeout applies only between two consecutive write operations, not the entire response transmission. Range: 1–3600 seconds, default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "serverGroupId": { "type": "string", "description": "ID of the backend server group associated with the listener.\n" }, "startPort": { "type": "integer", "description": "Start port for all-port listening. Range: 1–65535. When Port is '0', this parameter is required.\n" }, "status": { "type": "string", "description": "Listener status. Creating: being created. Active: running. Deleting: being deleted. Disabled: disabled.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ListenerTag:ListenerTag" } }, "updatedTime": { "type": "string", "description": "Last operation time of the listener.\n" }, "wafProtectionEnabled": { "type": "string", "description": "Send traffic passing through the Layer 7 listener to the Web Application Firewall for inspection and filtering. on: yes. off: no.\n" } }, "required": [ "aclIds", "aclStatus", "aclType", "bandwidth", "caCertificateId", "caEnabled", "certCenterCertificateId", "certificateId", "certificateSource", "clientBodyTimeout", "clientHeaderTimeout", "connectionDrainEnabled", "connectionDrainTimeout", "cookie", "cps", "createdTime", "description", "domainExtensions", "enabled", "endPort", "establishedTimeout", "healthCheck", "http2Enabled", "keepaliveTimeout", "listenerId", "listenerName", "loadBalancerId", "maxConnections", "persistenceTimeout", "persistenceType", "port", "protocol", "proxyConnectTimeout", "proxyProtocolType", "proxyReadTimeout", "proxySendTimeout", "ruleIds", "scheduler", "securityPolicyId", "sendTimeout", "serverGroupId", "startPort", "status", "tags", "updatedTime", "wafProtectionEnabled" ], "inputProperties": { "aclIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the access control policy group bound to the listener. Returned only when the AclStatus parameter is set to on.\n" }, "aclStatus": { "type": "string", "description": "Enable access control. Values: on: enabled. off (default): disabled.\n" }, "aclType": { "type": "string", "description": "Access control mode. white: Allowlist. black: Denylist. This parameter is valid only when the AclStatus parameter is on.\n" }, "bandwidth": { "type": "integer", "description": "Bandwidth limit for the listener, which means this listener exclusively uses the bandwidth of the CLB instance. Unit: Mbps. -1 (default): This listener does not exclusively use CLB bandwidth and shares the non-exclusive bandwidth of the CLB instance with other listeners. Value range: 1 to the non-exclusive bandwidth of the CLB instance.\n" }, "caCertificateId": { "type": "string", "description": "CA certificate for mutual authentication.\n" }, "caEnabled": { "type": "string", "description": "Enable mutual authentication. on: enabled. off (default): disabled.\n" }, "certCenterCertificateId": { "type": "string", "description": "Certificate ID from Certificate Center.\n" }, "certificateId": { "type": "string", "description": "Certificate ID from the CLB certificate management module.\n" }, "certificateSource": { "type": "string", "description": "Certificate source. clb (default): certificate uploaded to CLB. cert_center: certificate uploaded to Certificate Center. user: certificate uploaded by user.\n" }, "clientBodyTimeout": { "type": "integer", "description": "Timeout for reading the client request body. This timeout applies only between two consecutive read operations, not the entire request transmission. Range: 30–120 seconds, default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "clientHeaderTimeout": { "type": "integer", "description": "Timeout for reading the client request header. Value range: 30–120 seconds. Default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "connectionDrainEnabled": { "type": "string", "description": "Whether the listener enables graceful connection termination. on: enabled. off: not enabled. When Protocol returns HTTP or HTTPS, this parameter always returns off.\n" }, "connectionDrainTimeout": { "type": "integer", "description": "Timeout for graceful connection termination, in seconds. If ConnectionDrainEnabled returns off, this parameter returns 0.\n" }, "cookie": { "type": "string", "description": "Name of the session persistence cookie configured on the backend server. This parameter is valid and required only when PersistenceType is set to server. Only letters, numbers, underscores (_), and hyphens (-) are allowed. Length must be between 1 and 200 characters.\n" }, "cps": { "type": "integer", "description": "Maximum number of new connections per second. -1 (default): No limit, which means the maximum number of new connections allowed by the CLB instance. Value range: 1 to the maximum number of new connections allowed by the CLB instance.\n" }, "description": { "type": "string", "description": "Listener description. Must start with a letter, digit, or Chinese character. Can include letters, digits, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 0–255 characters. If not specified, the default is an empty string.\n" }, "domainExtensions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ListenerDomainExtension:ListenerDomainExtension" } }, "enabled": { "type": "string", "description": "Enable listener. on (default): enabled. off: disabled.\n" }, "endPort": { "type": "integer", "description": "End port for all-port listening. Range: 1–65535. When Port is '0', this parameter is required and must be greater than startPort.\n" }, "establishedTimeout": { "type": "integer", "description": "Listener connection timeout. This parameter is valid only when Protocol is set to TCP or UDP. Values: TCP protocol: 10–900 seconds, default is 900 seconds. UDP protocol: 1–300 seconds, default is 90 seconds.\n" }, "healthCheck": { "$ref": "#/types/volcenginecc:clb/ListenerHealthCheck:ListenerHealthCheck", "description": "Health check information.\n" }, "http2Enabled": { "type": "string", "description": "Whether the listener enables frontend HTTP 2.0 protocol. This parameter is valid only when Protocol is set to HTTPS. Values: on: enabled. off (default): disabled.\n" }, "keepaliveTimeout": { "type": "integer", "description": "Keep-alive timeout between the client and CLB. Range: 0–900 seconds, default is 75 seconds. 0 disables keep-alive. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "listenerName": { "type": "string", "description": "Listener name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If left blank, 'Protocol-Port' will be used as the default listener name.\n" }, "loadBalancerId": { "type": "string", "description": "ID of the CLB instance.\n" }, "maxConnections": { "type": "integer", "description": "Maximum concurrent connections limit. -1 (default): unlimited (up to the maximum concurrent connections supported by the CLB instance). Value range: 1 to the maximum concurrent connections limit of the CLB instance.\n" }, "persistenceTimeout": { "type": "integer", "description": "Session persistence timeout, in seconds. The value range depends on the PersistenceType parameter. When PersistenceType is set to source_ip, the range is 1–3600. When PersistenceType is set to insert, the range is 1–86400.\n" }, "persistenceType": { "type": "string", "description": "Session persistence type. Values: off (default): session persistence disabled. source_ip: source IP address, valid only when Protocol is TCP or UDP. insert: insert Cookie, valid only when Protocol is HTTP or HTTPS and Scheduler is wrr. server: rewrite Cookie, valid only when Protocol is HTTP or HTTPS and Scheduler is wrr.\n" }, "port": { "type": "integer", "description": "Port used by the listener to receive requests. Value range: 0–65535. When the Protocol parameter is 'TCP' or 'UDP', 0 is supported, which enables listening on all ports.\n" }, "protocol": { "type": "string", "description": "Listener protocol. Includes: TCP, UDP, HTTP, HTTPS.\n" }, "proxyConnectTimeout": { "type": "integer", "description": "Connection establishment timeout between CLB and backend server. Recommended to be greater than the health check timeout. Range: 4–120 seconds, default is 4. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "proxyProtocolType": { "type": "string", "description": "Enable Proxy-Protocol. This parameter is valid only when Protocol is TCP or UDP. Values: off (default): disabled. standard: enabled.\n" }, "proxyReadTimeout": { "type": "integer", "description": "Timeout for CLB to read responses from backend servers. This timeout applies only between two consecutive read operations, not for the entire response transmission. Value range: 30–3600 seconds. Default: 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "proxySendTimeout": { "type": "integer", "description": "Timeout for CLB to transmit requests to backend servers. This timeout applies only between two consecutive write operations, not the entire request transmission process. Value range: 30–3600 seconds. Default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "scheduler": { "type": "string", "description": "Scheduling algorithm used by the listener. wrr (default): Weighted round robin. wlc: Weighted least connections. sh: Source address hash.\n" }, "securityPolicyId": { "type": "string", "description": "TLS security policy for HTTPS listeners. This parameter is valid only when Protocol is set to HTTPS. Values: default*policy (default): supports SSL v3, TLS v1.0, TLS v1.1, TLS v1.2. tls*cipher*policy*1*0: supports TLS v1.0, TLS v1.1, TLS v1.2. tls*cipher*policy*1*1: supports TLS v1.1, TLS v1.2. tls*cipher*policy*1*2: supports TLS v1.2. tls*cipher*policy*1*2*strict: supports TLS v1.2.\n" }, "sendTimeout": { "type": "integer", "description": "Timeout for CLB to send responses to the client. This timeout applies only between two consecutive write operations, not the entire response transmission. Range: 1–3600 seconds, default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "serverGroupId": { "type": "string", "description": "ID of the backend server group associated with the listener.\n" }, "startPort": { "type": "integer", "description": "Start port for all-port listening. Range: 1–65535. When Port is '0', this parameter is required.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ListenerTag:ListenerTag" } } }, "requiredInputs": [ "loadBalancerId", "port", "protocol", "serverGroupId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Listener resources.\n", "properties": { "aclIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the access control policy group bound to the listener. Returned only when the AclStatus parameter is set to on.\n" }, "aclStatus": { "type": "string", "description": "Enable access control. Values: on: enabled. off (default): disabled.\n" }, "aclType": { "type": "string", "description": "Access control mode. white: Allowlist. black: Denylist. This parameter is valid only when the AclStatus parameter is on.\n" }, "bandwidth": { "type": "integer", "description": "Bandwidth limit for the listener, which means this listener exclusively uses the bandwidth of the CLB instance. Unit: Mbps. -1 (default): This listener does not exclusively use CLB bandwidth and shares the non-exclusive bandwidth of the CLB instance with other listeners. Value range: 1 to the non-exclusive bandwidth of the CLB instance.\n" }, "caCertificateId": { "type": "string", "description": "CA certificate for mutual authentication.\n" }, "caEnabled": { "type": "string", "description": "Enable mutual authentication. on: enabled. off (default): disabled.\n" }, "certCenterCertificateId": { "type": "string", "description": "Certificate ID from Certificate Center.\n" }, "certificateId": { "type": "string", "description": "Certificate ID from the CLB certificate management module.\n" }, "certificateSource": { "type": "string", "description": "Certificate source. clb (default): certificate uploaded to CLB. cert_center: certificate uploaded to Certificate Center. user: certificate uploaded by user.\n" }, "clientBodyTimeout": { "type": "integer", "description": "Timeout for reading the client request body. This timeout applies only between two consecutive read operations, not the entire request transmission. Range: 30–120 seconds, default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "clientHeaderTimeout": { "type": "integer", "description": "Timeout for reading the client request header. Value range: 30–120 seconds. Default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "connectionDrainEnabled": { "type": "string", "description": "Whether the listener enables graceful connection termination. on: enabled. off: not enabled. When Protocol returns HTTP or HTTPS, this parameter always returns off.\n" }, "connectionDrainTimeout": { "type": "integer", "description": "Timeout for graceful connection termination, in seconds. If ConnectionDrainEnabled returns off, this parameter returns 0.\n" }, "cookie": { "type": "string", "description": "Name of the session persistence cookie configured on the backend server. This parameter is valid and required only when PersistenceType is set to server. Only letters, numbers, underscores (_), and hyphens (-) are allowed. Length must be between 1 and 200 characters.\n" }, "cps": { "type": "integer", "description": "Maximum number of new connections per second. -1 (default): No limit, which means the maximum number of new connections allowed by the CLB instance. Value range: 1 to the maximum number of new connections allowed by the CLB instance.\n" }, "createdTime": { "type": "string", "description": "Creation time of the listener.\n" }, "description": { "type": "string", "description": "Listener description. Must start with a letter, digit, or Chinese character. Can include letters, digits, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 0–255 characters. If not specified, the default is an empty string.\n" }, "domainExtensions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ListenerDomainExtension:ListenerDomainExtension" } }, "enabled": { "type": "string", "description": "Enable listener. on (default): enabled. off: disabled.\n" }, "endPort": { "type": "integer", "description": "End port for all-port listening. Range: 1–65535. When Port is '0', this parameter is required and must be greater than startPort.\n" }, "establishedTimeout": { "type": "integer", "description": "Listener connection timeout. This parameter is valid only when Protocol is set to TCP or UDP. Values: TCP protocol: 10–900 seconds, default is 900 seconds. UDP protocol: 1–300 seconds, default is 90 seconds.\n" }, "healthCheck": { "$ref": "#/types/volcenginecc:clb/ListenerHealthCheck:ListenerHealthCheck", "description": "Health check information.\n" }, "http2Enabled": { "type": "string", "description": "Whether the listener enables frontend HTTP 2.0 protocol. This parameter is valid only when Protocol is set to HTTPS. Values: on: enabled. off (default): disabled.\n" }, "keepaliveTimeout": { "type": "integer", "description": "Keep-alive timeout between the client and CLB. Range: 0–900 seconds, default is 75 seconds. 0 disables keep-alive. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "listenerName": { "type": "string", "description": "Listener name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If left blank, 'Protocol-Port' will be used as the default listener name.\n" }, "loadBalancerId": { "type": "string", "description": "ID of the CLB instance.\n" }, "maxConnections": { "type": "integer", "description": "Maximum concurrent connections limit. -1 (default): unlimited (up to the maximum concurrent connections supported by the CLB instance). Value range: 1 to the maximum concurrent connections limit of the CLB instance.\n" }, "persistenceTimeout": { "type": "integer", "description": "Session persistence timeout, in seconds. The value range depends on the PersistenceType parameter. When PersistenceType is set to source_ip, the range is 1–3600. When PersistenceType is set to insert, the range is 1–86400.\n" }, "persistenceType": { "type": "string", "description": "Session persistence type. Values: off (default): session persistence disabled. source_ip: source IP address, valid only when Protocol is TCP or UDP. insert: insert Cookie, valid only when Protocol is HTTP or HTTPS and Scheduler is wrr. server: rewrite Cookie, valid only when Protocol is HTTP or HTTPS and Scheduler is wrr.\n" }, "port": { "type": "integer", "description": "Port used by the listener to receive requests. Value range: 0–65535. When the Protocol parameter is 'TCP' or 'UDP', 0 is supported, which enables listening on all ports.\n" }, "protocol": { "type": "string", "description": "Listener protocol. Includes: TCP, UDP, HTTP, HTTPS.\n" }, "proxyConnectTimeout": { "type": "integer", "description": "Connection establishment timeout between CLB and backend server. Recommended to be greater than the health check timeout. Range: 4–120 seconds, default is 4. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "proxyProtocolType": { "type": "string", "description": "Enable Proxy-Protocol. This parameter is valid only when Protocol is TCP or UDP. Values: off (default): disabled. standard: enabled.\n" }, "proxyReadTimeout": { "type": "integer", "description": "Timeout for CLB to read responses from backend servers. This timeout applies only between two consecutive read operations, not for the entire response transmission. Value range: 30–3600 seconds. Default: 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "proxySendTimeout": { "type": "integer", "description": "Timeout for CLB to transmit requests to backend servers. This timeout applies only between two consecutive write operations, not the entire request transmission process. Value range: 30–3600 seconds. Default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "ruleIds": { "type": "array", "items": { "type": "string" }, "description": "List of rule IDs bound to the listener.\n" }, "scheduler": { "type": "string", "description": "Scheduling algorithm used by the listener. wrr (default): Weighted round robin. wlc: Weighted least connections. sh: Source address hash.\n" }, "securityPolicyId": { "type": "string", "description": "TLS security policy for HTTPS listeners. This parameter is valid only when Protocol is set to HTTPS. Values: default*policy (default): supports SSL v3, TLS v1.0, TLS v1.1, TLS v1.2. tls*cipher*policy*1*0: supports TLS v1.0, TLS v1.1, TLS v1.2. tls*cipher*policy*1*1: supports TLS v1.1, TLS v1.2. tls*cipher*policy*1*2: supports TLS v1.2. tls*cipher*policy*1*2*strict: supports TLS v1.2.\n" }, "sendTimeout": { "type": "integer", "description": "Timeout for CLB to send responses to the client. This timeout applies only between two consecutive write operations, not the entire response transmission. Range: 1–3600 seconds, default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n" }, "serverGroupId": { "type": "string", "description": "ID of the backend server group associated with the listener.\n" }, "startPort": { "type": "integer", "description": "Start port for all-port listening. Range: 1–65535. When Port is '0', this parameter is required.\n" }, "status": { "type": "string", "description": "Listener status. Creating: being created. Active: running. Deleting: being deleted. Disabled: disabled.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ListenerTag:ListenerTag" } }, "updatedTime": { "type": "string", "description": "Last operation time of the listener.\n" }, "wafProtectionEnabled": { "type": "string", "description": "Send traffic passing through the Layer 7 listener to the Web Application Firewall for inspection and filtering. on: yes. off: no.\n" } }, "type": "object" } }, "volcenginecc:clb/nlb:Nlb": { "description": "The NLB instance receives user access requests and forwards them to backend servers based on the configuration of listeners and server groups.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n nLBDemo:\n type: volcenginecc:clb:Nlb\n name: NLBDemo\n properties:\n ipv4NetworkType: intranet\n securityGroupIds:\n - sg-13fg4nslwnwu83n6nu5a7xxxx\n vpcId: vpc-13ffun9olqz9c3n6nu43bxxxx\n loadBalancerName: NLBDemo\n description: NLBDemom\n projectName: default\n ipAddressVersion: ipv4\n crossZoneEnabled: false\n zoneMappings:\n - subnet_id: subnet-mjoyynjt59ts5smt1bncxxxx\n zone_id: cn-beijing-a\n ipv_4_address: 192.168.xx.2\n modificationProtectionStatus: ConsoleProtection\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/nlb:Nlb example \"load_balancer_id\"\n```\n\n", "properties": { "accessLog": { "$ref": "#/types/volcenginecc:clb/NlbAccessLog:NlbAccessLog", "description": "Access log information of the NLB instance.\n" }, "accountId": { "type": "string", "description": "Account ID to which the NLB instance belongs.\n" }, "billingStatus": { "type": "string", "description": "Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.\n" }, "billingType": { "type": "integer", "description": "Billing type of the NLB instance. 3: pay-as-you-go\n" }, "createdTime": { "type": "string", "description": "Creation time of the NLB instance.\n" }, "crossZoneEnabled": { "type": "boolean", "description": "Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.\n" }, "description": { "type": "string", "description": "Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.\n" }, "dnsName": { "type": "string", "description": "DNS address of the NLB instance.\n" }, "expectedOverdueTime": { "type": "string", "description": "Time when the NLB instance is suspended due to overdue payment.\n" }, "ipAddressVersion": { "type": "string", "description": "IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.\n" }, "ipv4BandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID for IPv4 type.\n" }, "ipv4NetworkType": { "type": "string", "description": "IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.\n" }, "ipv6BandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID for IPv6 type.\n" }, "ipv6NetworkType": { "type": "string", "description": "IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.\n" }, "loadBalancerId": { "type": "string", "description": "NLB instance ID.\n" }, "loadBalancerName": { "type": "string", "description": "Name of the NLB instance.\n" }, "managedSecurityGroupId": { "type": "string", "description": "Managed security group ID automatically associated with the NLB instance by the system.\n" }, "modificationProtectionStatus": { "type": "string", "description": "Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.\n" }, "overdueTime": { "type": "string", "description": "Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the NLB instance belongs.\n" }, "reclaimedTime": { "type": "string", "description": "Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs associated with the NLB instance.\n" }, "status": { "type": "string", "description": "Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbTag:NlbTag" } }, "updatedTime": { "type": "string", "description": "Update time of the NLB instance.\n" }, "vpcId": { "type": "string", "description": "VPC ID to which the NLB instance belongs.\n" }, "zoneMappings": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbZoneMapping:NlbZoneMapping" } } }, "required": [ "accessLog", "accountId", "billingStatus", "billingType", "createdTime", "crossZoneEnabled", "description", "dnsName", "expectedOverdueTime", "ipAddressVersion", "ipv4BandwidthPackageId", "ipv4NetworkType", "ipv6BandwidthPackageId", "ipv6NetworkType", "loadBalancerId", "loadBalancerName", "managedSecurityGroupId", "modificationProtectionStatus", "overdueTime", "projectName", "reclaimedTime", "securityGroupIds", "status", "tags", "updatedTime", "vpcId", "zoneMappings" ], "inputProperties": { "accountId": { "type": "string", "description": "Account ID to which the NLB instance belongs.\n" }, "crossZoneEnabled": { "type": "boolean", "description": "Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.\n" }, "description": { "type": "string", "description": "Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.\n" }, "ipAddressVersion": { "type": "string", "description": "IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.\n" }, "ipv4BandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID for IPv4 type.\n" }, "ipv4NetworkType": { "type": "string", "description": "IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.\n" }, "ipv6BandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID for IPv6 type.\n" }, "ipv6NetworkType": { "type": "string", "description": "IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.\n" }, "loadBalancerName": { "type": "string", "description": "Name of the NLB instance.\n" }, "modificationProtectionStatus": { "type": "string", "description": "Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the NLB instance belongs.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs associated with the NLB instance.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbTag:NlbTag" } }, "vpcId": { "type": "string", "description": "VPC ID to which the NLB instance belongs.\n" }, "zoneMappings": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbZoneMapping:NlbZoneMapping" } } }, "requiredInputs": [ "ipv4NetworkType", "securityGroupIds", "vpcId", "zoneMappings" ], "stateInputs": { "description": "Input properties used for looking up and filtering Nlb resources.\n", "properties": { "accessLog": { "$ref": "#/types/volcenginecc:clb/NlbAccessLog:NlbAccessLog", "description": "Access log information of the NLB instance.\n" }, "accountId": { "type": "string", "description": "Account ID to which the NLB instance belongs.\n" }, "billingStatus": { "type": "string", "description": "Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.\n" }, "billingType": { "type": "integer", "description": "Billing type of the NLB instance. 3: pay-as-you-go\n" }, "createdTime": { "type": "string", "description": "Creation time of the NLB instance.\n" }, "crossZoneEnabled": { "type": "boolean", "description": "Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.\n" }, "description": { "type": "string", "description": "Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.\n" }, "dnsName": { "type": "string", "description": "DNS address of the NLB instance.\n" }, "expectedOverdueTime": { "type": "string", "description": "Time when the NLB instance is suspended due to overdue payment.\n" }, "ipAddressVersion": { "type": "string", "description": "IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.\n" }, "ipv4BandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID for IPv4 type.\n" }, "ipv4NetworkType": { "type": "string", "description": "IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.\n" }, "ipv6BandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID for IPv6 type.\n" }, "ipv6NetworkType": { "type": "string", "description": "IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.\n" }, "loadBalancerId": { "type": "string", "description": "NLB instance ID.\n" }, "loadBalancerName": { "type": "string", "description": "Name of the NLB instance.\n" }, "managedSecurityGroupId": { "type": "string", "description": "Managed security group ID automatically associated with the NLB instance by the system.\n" }, "modificationProtectionStatus": { "type": "string", "description": "Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.\n" }, "overdueTime": { "type": "string", "description": "Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the NLB instance belongs.\n" }, "reclaimedTime": { "type": "string", "description": "Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs associated with the NLB instance.\n" }, "status": { "type": "string", "description": "Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbTag:NlbTag" } }, "updatedTime": { "type": "string", "description": "Update time of the NLB instance.\n" }, "vpcId": { "type": "string", "description": "VPC ID to which the NLB instance belongs.\n" }, "zoneMappings": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbZoneMapping:NlbZoneMapping" } } }, "type": "object" } }, "volcenginecc:clb/nlbListener:NlbListener": { "description": "The listener monitors user access requests received by the NLB instance based on the specified protocol and port. NLB forwards requests to healthy backend servers in the associated server group according to the scheduling algorithm configured for that group.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cLBNLBListenerDemo = new volcenginecc.clb.NlbListener(\"CLBNLBListenerDemo\", {\n loadBalancerId: \"nlb-11zz9w3jqptz449iegfwvxxxx\",\n protocol: \"TCP\",\n port: 0,\n serverGroupId: \"rsp-11zz9wdewa3uo49ieggq8xxxx\",\n connectionTimeout: 60,\n description: \"CLBNLBListenerDemo description\",\n enabled: true,\n listenerName: \"CLBNLBListenerDemo\",\n tags: [{\n key: \"env\",\n value: \"Test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_lbnlb_listener_demo = volcenginecc.clb.NlbListener(\"CLBNLBListenerDemo\",\n load_balancer_id=\"nlb-11zz9w3jqptz449iegfwvxxxx\",\n protocol=\"TCP\",\n port=0,\n server_group_id=\"rsp-11zz9wdewa3uo49ieggq8xxxx\",\n connection_timeout=60,\n description=\"CLBNLBListenerDemo description\",\n enabled=True,\n listener_name=\"CLBNLBListenerDemo\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"Test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cLBNLBListenerDemo = new Volcenginecc.Clb.NlbListener(\"CLBNLBListenerDemo\", new()\n {\n LoadBalancerId = \"nlb-11zz9w3jqptz449iegfwvxxxx\",\n Protocol = \"TCP\",\n Port = 0,\n ServerGroupId = \"rsp-11zz9wdewa3uo49ieggq8xxxx\",\n ConnectionTimeout = 60,\n Description = \"CLBNLBListenerDemo description\",\n Enabled = true,\n ListenerName = \"CLBNLBListenerDemo\",\n Tags = new[]\n {\n new Volcenginecc.Clb.Inputs.NlbListenerTagArgs\n {\n Key = \"env\",\n Value = \"Test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/clb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := clb.NewNlbListener(ctx, \"CLBNLBListenerDemo\", \u0026clb.NlbListenerArgs{\n\t\t\tLoadBalancerId: pulumi.String(\"nlb-11zz9w3jqptz449iegfwvxxxx\"),\n\t\t\tProtocol: pulumi.String(\"TCP\"),\n\t\t\tPort: pulumi.Int(0),\n\t\t\tServerGroupId: pulumi.String(\"rsp-11zz9wdewa3uo49ieggq8xxxx\"),\n\t\t\tConnectionTimeout: pulumi.Int(60),\n\t\t\tDescription: pulumi.String(\"CLBNLBListenerDemo description\"),\n\t\t\tEnabled: pulumi.Bool(true),\n\t\t\tListenerName: pulumi.String(\"CLBNLBListenerDemo\"),\n\t\t\tTags: clb.NlbListenerTagArray{\n\t\t\t\t\u0026clb.NlbListenerTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"Test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.clb.NlbListener;\nimport com.volcengine.volcenginecc.clb.NlbListenerArgs;\nimport com.pulumi.volcenginecc.clb.inputs.NlbListenerTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cLBNLBListenerDemo = new NlbListener(\"cLBNLBListenerDemo\", NlbListenerArgs.builder()\n .loadBalancerId(\"nlb-11zz9w3jqptz449iegfwvxxxx\")\n .protocol(\"TCP\")\n .port(0)\n .serverGroupId(\"rsp-11zz9wdewa3uo49ieggq8xxxx\")\n .connectionTimeout(60)\n .description(\"CLBNLBListenerDemo description\")\n .enabled(true)\n .listenerName(\"CLBNLBListenerDemo\")\n .tags(NlbListenerTagArgs.builder()\n .key(\"env\")\n .value(\"Test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cLBNLBListenerDemo:\n type: volcenginecc:clb:NlbListener\n name: CLBNLBListenerDemo\n properties:\n loadBalancerId: nlb-11zz9w3jqptz449iegfwvxxxx\n protocol: TCP\n port: 0\n serverGroupId: rsp-11zz9wdewa3uo49ieggq8xxxx\n connectionTimeout: 60\n description: CLBNLBListenerDemo description\n enabled: true\n listenerName: CLBNLBListenerDemo\n tags:\n - key: env\n value: Test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/nlbListener:NlbListener example \"listener_id\"\n```\n\n", "properties": { "certificateId": { "type": "string", "description": "TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.\n" }, "connectionTimeout": { "type": "integer", "description": "Listener connection timeout (seconds)\n" }, "createdTime": { "type": "string", "description": "Listener creation time\n" }, "description": { "type": "string", "description": "Listener description\n" }, "enabled": { "type": "boolean", "description": "Listener enabled: true (enabled); false (disabled)\n" }, "endPort": { "type": "integer", "description": "End port for all-port listening. Valid only when Port is 0.\n" }, "healths": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbListenerHealth:NlbListenerHealth" } }, "listenerId": { "type": "string", "description": "Listener unique identifier\n" }, "listenerName": { "type": "string", "description": "Listener name\n" }, "loadBalancerId": { "type": "string", "description": "Load balancer instance ID\n" }, "port": { "type": "integer", "description": "Port on which the listener receives requests. 0 indicates all-port listening is enabled.\n" }, "protocol": { "type": "string", "description": "Listener protocol type: TCP, UDP, TLS\n" }, "securityPolicyId": { "type": "string", "description": "TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tls*cipher*policy*1*0 .tls*cipher*policy*1*1 .tls*cipher*policy*1*2 .tls*cipher*policy*1*2*strict .tls*cipher*policy*1*2*strict*with*1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.\n" }, "serverGroupId": { "type": "string", "description": "Server group ID associated with the listener\n" }, "startPort": { "type": "integer", "description": "Start port for all-port listening. Valid only when Port is 0.\n" }, "status": { "type": "string", "description": "Listener status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbListenerTag:NlbListenerTag" } }, "updatedTime": { "type": "string", "description": "Listener's most recent operation time\n" } }, "required": [ "certificateId", "connectionTimeout", "createdTime", "description", "enabled", "endPort", "healths", "listenerId", "listenerName", "loadBalancerId", "port", "protocol", "securityPolicyId", "serverGroupId", "startPort", "status", "tags", "updatedTime" ], "inputProperties": { "certificateId": { "type": "string", "description": "TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.\n" }, "connectionTimeout": { "type": "integer", "description": "Listener connection timeout (seconds)\n" }, "description": { "type": "string", "description": "Listener description\n" }, "enabled": { "type": "boolean", "description": "Listener enabled: true (enabled); false (disabled)\n" }, "endPort": { "type": "integer", "description": "End port for all-port listening. Valid only when Port is 0.\n" }, "healths": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbListenerHealth:NlbListenerHealth" } }, "listenerName": { "type": "string", "description": "Listener name\n" }, "loadBalancerId": { "type": "string", "description": "Load balancer instance ID\n" }, "port": { "type": "integer", "description": "Port on which the listener receives requests. 0 indicates all-port listening is enabled.\n" }, "protocol": { "type": "string", "description": "Listener protocol type: TCP, UDP, TLS\n" }, "securityPolicyId": { "type": "string", "description": "TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tls*cipher*policy*1*0 .tls*cipher*policy*1*1 .tls*cipher*policy*1*2 .tls*cipher*policy*1*2*strict .tls*cipher*policy*1*2*strict*with*1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.\n" }, "serverGroupId": { "type": "string", "description": "Server group ID associated with the listener\n" }, "startPort": { "type": "integer", "description": "Start port for all-port listening. Valid only when Port is 0.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbListenerTag:NlbListenerTag" } } }, "requiredInputs": [ "loadBalancerId", "port", "protocol", "serverGroupId" ], "stateInputs": { "description": "Input properties used for looking up and filtering NlbListener resources.\n", "properties": { "certificateId": { "type": "string", "description": "TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.\n" }, "connectionTimeout": { "type": "integer", "description": "Listener connection timeout (seconds)\n" }, "createdTime": { "type": "string", "description": "Listener creation time\n" }, "description": { "type": "string", "description": "Listener description\n" }, "enabled": { "type": "boolean", "description": "Listener enabled: true (enabled); false (disabled)\n" }, "endPort": { "type": "integer", "description": "End port for all-port listening. Valid only when Port is 0.\n" }, "healths": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbListenerHealth:NlbListenerHealth" } }, "listenerId": { "type": "string", "description": "Listener unique identifier\n" }, "listenerName": { "type": "string", "description": "Listener name\n" }, "loadBalancerId": { "type": "string", "description": "Load balancer instance ID\n" }, "port": { "type": "integer", "description": "Port on which the listener receives requests. 0 indicates all-port listening is enabled.\n" }, "protocol": { "type": "string", "description": "Listener protocol type: TCP, UDP, TLS\n" }, "securityPolicyId": { "type": "string", "description": "TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tls*cipher*policy*1*0 .tls*cipher*policy*1*1 .tls*cipher*policy*1*2 .tls*cipher*policy*1*2*strict .tls*cipher*policy*1*2*strict*with*1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.\n" }, "serverGroupId": { "type": "string", "description": "Server group ID associated with the listener\n" }, "startPort": { "type": "integer", "description": "Start port for all-port listening. Valid only when Port is 0.\n" }, "status": { "type": "string", "description": "Listener status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbListenerTag:NlbListenerTag" } }, "updatedTime": { "type": "string", "description": "Listener's most recent operation time\n" } }, "type": "object" } }, "volcenginecc:clb/nlbSecurityPolicy:NlbSecurityPolicy": { "description": "Some security policies are preset for common scenarios. If the system preset policies do not meet your needs, you can also customize security policies\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cLBNLBSecurityPolicyDemo = new volcenginecc.clb.NlbSecurityPolicy(\"CLBNLBSecurityPolicyDemo\", {\n ciphers: [\n \"TLS_AES_128_CCM_SHA256\",\n \"TLS_AES_128_GCM_SHA256\",\n ],\n projectName: \"default\",\n securityPolicyName: \"ccapi-test-1\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n tlsVersions: [\"TLSv1.3\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_lbnlb_security_policy_demo = volcenginecc.clb.NlbSecurityPolicy(\"CLBNLBSecurityPolicyDemo\",\n ciphers=[\n \"TLS_AES_128_CCM_SHA256\",\n \"TLS_AES_128_GCM_SHA256\",\n ],\n project_name=\"default\",\n security_policy_name=\"ccapi-test-1\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }],\n tls_versions=[\"TLSv1.3\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cLBNLBSecurityPolicyDemo = new Volcenginecc.Clb.NlbSecurityPolicy(\"CLBNLBSecurityPolicyDemo\", new()\n {\n Ciphers = new[]\n {\n \"TLS_AES_128_CCM_SHA256\",\n \"TLS_AES_128_GCM_SHA256\",\n },\n ProjectName = \"default\",\n SecurityPolicyName = \"ccapi-test-1\",\n Tags = new[]\n {\n new Volcenginecc.Clb.Inputs.NlbSecurityPolicyTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n TlsVersions = new[]\n {\n \"TLSv1.3\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/clb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := clb.NewNlbSecurityPolicy(ctx, \"CLBNLBSecurityPolicyDemo\", \u0026clb.NlbSecurityPolicyArgs{\n\t\t\tCiphers: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"TLS_AES_128_CCM_SHA256\"),\n\t\t\t\tpulumi.String(\"TLS_AES_128_GCM_SHA256\"),\n\t\t\t},\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tSecurityPolicyName: pulumi.String(\"ccapi-test-1\"),\n\t\t\tTags: clb.NlbSecurityPolicyTagArray{\n\t\t\t\t\u0026clb.NlbSecurityPolicyTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTlsVersions: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"TLSv1.3\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.clb.NlbSecurityPolicy;\nimport com.volcengine.volcenginecc.clb.NlbSecurityPolicyArgs;\nimport com.pulumi.volcenginecc.clb.inputs.NlbSecurityPolicyTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cLBNLBSecurityPolicyDemo = new NlbSecurityPolicy(\"cLBNLBSecurityPolicyDemo\", NlbSecurityPolicyArgs.builder()\n .ciphers( \n \"TLS_AES_128_CCM_SHA256\",\n \"TLS_AES_128_GCM_SHA256\")\n .projectName(\"default\")\n .securityPolicyName(\"ccapi-test-1\")\n .tags(NlbSecurityPolicyTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .tlsVersions(\"TLSv1.3\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cLBNLBSecurityPolicyDemo:\n type: volcenginecc:clb:NlbSecurityPolicy\n name: CLBNLBSecurityPolicyDemo\n properties:\n ciphers:\n - TLS_AES_128_CCM_SHA256\n - TLS_AES_128_GCM_SHA256\n projectName: default\n securityPolicyName: ccapi-test-1\n tags:\n - key: env\n value: test\n tlsVersions:\n - TLSv1.3\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/nlbSecurityPolicy:NlbSecurityPolicy example \"security_policy_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account ID associated with the TLS security policy\n" }, "ciphers": { "type": "array", "items": { "type": "string" }, "description": "Cipher suites for the TLS custom security policy. Supported cipher suites for different TLS protocol versions are as follows: TLSv1.0 \u0026 TLSv1.1: ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, DES-CBC3-SHA. TLSv1.2: ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256. TLSv1.3: TLS*CHACHA20*POLY1305*SHA256, TLS*AES*256*GCM*SHA384, TLS*AES*128*GCM*SHA256, TLS*AES*128*CCM*8*SHA256, TLS*AES*128*CCM*SHA256, TLS*SM4*GCM*SM3, TLS*SM4*CCM*SM3. When specifying this parameter, you must provide all supported cipher suites. Adding or removing cipher suites individually is not supported via this interface. If only Ciphers.N is provided and TlsVersions.N is not, validation is based on the TLS protocol versions supported by the current listener and the cipher suites specified in the request. If both TlsVersions.N and Ciphers.N are provided, validation is based on the TLS protocol versions and cipher suites specified in the request. TLS*SM4*GCM*SM3 and TLS*SM4*CCM*SM3 are currently in pilot testing. To request access, please contact your account manager\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "projectName": { "type": "string", "description": "Name of the project to which the TLS custom security policy belongs. If not specified, defaults to default\n" }, "relatedListenerIds": { "type": "array", "items": { "type": "string" }, "description": "Listener associated with the TLS security policy\n" }, "securityPolicyId": { "type": "string", "description": "Security policy ID\n" }, "securityPolicyName": { "type": "string", "description": "Security policy name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If this parameter is not specified, defaults to the policy ID\n" }, "status": { "type": "string", "description": "TLS custom security policy status. Creating: Being created. Configuring: Being configured. Active: Active. Deleting: Being deleted.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbSecurityPolicyTag:NlbSecurityPolicyTag" } }, "tlsVersions": { "type": "array", "items": { "type": "string" }, "description": "Update the TLS protocol versions for the TLS custom security policy. Valid values: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. When specifying this parameter, you must provide all supported TLS versions. Adding or removing TLS protocol versions individually is not supported via this interface. If only TlsVersions.N is provided and Ciphers.N is not, validation is based on the TLS protocol versions in the request and the cipher suites supported by the current listener. If both TlsVersions.N and Ciphers.N are provided, validation is based on the TLS protocol versions and cipher suites specified in the request\n" }, "updatedTime": { "type": "string", "description": "Update time\n" } }, "required": [ "accountId", "ciphers", "createdTime", "projectName", "relatedListenerIds", "securityPolicyId", "securityPolicyName", "status", "tags", "tlsVersions", "updatedTime" ], "inputProperties": { "ciphers": { "type": "array", "items": { "type": "string" }, "description": "Cipher suites for the TLS custom security policy. Supported cipher suites for different TLS protocol versions are as follows: TLSv1.0 \u0026 TLSv1.1: ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, DES-CBC3-SHA. TLSv1.2: ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256. TLSv1.3: TLS*CHACHA20*POLY1305*SHA256, TLS*AES*256*GCM*SHA384, TLS*AES*128*GCM*SHA256, TLS*AES*128*CCM*8*SHA256, TLS*AES*128*CCM*SHA256, TLS*SM4*GCM*SM3, TLS*SM4*CCM*SM3. When specifying this parameter, you must provide all supported cipher suites. Adding or removing cipher suites individually is not supported via this interface. If only Ciphers.N is provided and TlsVersions.N is not, validation is based on the TLS protocol versions supported by the current listener and the cipher suites specified in the request. If both TlsVersions.N and Ciphers.N are provided, validation is based on the TLS protocol versions and cipher suites specified in the request. TLS*SM4*GCM*SM3 and TLS*SM4*CCM*SM3 are currently in pilot testing. To request access, please contact your account manager\n" }, "projectName": { "type": "string", "description": "Name of the project to which the TLS custom security policy belongs. If not specified, defaults to default\n" }, "securityPolicyName": { "type": "string", "description": "Security policy name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If this parameter is not specified, defaults to the policy ID\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbSecurityPolicyTag:NlbSecurityPolicyTag" } }, "tlsVersions": { "type": "array", "items": { "type": "string" }, "description": "Update the TLS protocol versions for the TLS custom security policy. Valid values: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. When specifying this parameter, you must provide all supported TLS versions. Adding or removing TLS protocol versions individually is not supported via this interface. If only TlsVersions.N is provided and Ciphers.N is not, validation is based on the TLS protocol versions in the request and the cipher suites supported by the current listener. If both TlsVersions.N and Ciphers.N are provided, validation is based on the TLS protocol versions and cipher suites specified in the request\n" } }, "requiredInputs": [ "ciphers", "tlsVersions" ], "stateInputs": { "description": "Input properties used for looking up and filtering NlbSecurityPolicy resources.\n", "properties": { "accountId": { "type": "string", "description": "Account ID associated with the TLS security policy\n" }, "ciphers": { "type": "array", "items": { "type": "string" }, "description": "Cipher suites for the TLS custom security policy. Supported cipher suites for different TLS protocol versions are as follows: TLSv1.0 \u0026 TLSv1.1: ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, DES-CBC3-SHA. TLSv1.2: ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256. TLSv1.3: TLS*CHACHA20*POLY1305*SHA256, TLS*AES*256*GCM*SHA384, TLS*AES*128*GCM*SHA256, TLS*AES*128*CCM*8*SHA256, TLS*AES*128*CCM*SHA256, TLS*SM4*GCM*SM3, TLS*SM4*CCM*SM3. When specifying this parameter, you must provide all supported cipher suites. Adding or removing cipher suites individually is not supported via this interface. If only Ciphers.N is provided and TlsVersions.N is not, validation is based on the TLS protocol versions supported by the current listener and the cipher suites specified in the request. If both TlsVersions.N and Ciphers.N are provided, validation is based on the TLS protocol versions and cipher suites specified in the request. TLS*SM4*GCM*SM3 and TLS*SM4*CCM*SM3 are currently in pilot testing. To request access, please contact your account manager\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "projectName": { "type": "string", "description": "Name of the project to which the TLS custom security policy belongs. If not specified, defaults to default\n" }, "relatedListenerIds": { "type": "array", "items": { "type": "string" }, "description": "Listener associated with the TLS security policy\n" }, "securityPolicyId": { "type": "string", "description": "Security policy ID\n" }, "securityPolicyName": { "type": "string", "description": "Security policy name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If this parameter is not specified, defaults to the policy ID\n" }, "status": { "type": "string", "description": "TLS custom security policy status. Creating: Being created. Configuring: Being configured. Active: Active. Deleting: Being deleted.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbSecurityPolicyTag:NlbSecurityPolicyTag" } }, "tlsVersions": { "type": "array", "items": { "type": "string" }, "description": "Update the TLS protocol versions for the TLS custom security policy. Valid values: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. When specifying this parameter, you must provide all supported TLS versions. Adding or removing TLS protocol versions individually is not supported via this interface. If only TlsVersions.N is provided and Ciphers.N is not, validation is based on the TLS protocol versions in the request and the cipher suites supported by the current listener. If both TlsVersions.N and Ciphers.N are provided, validation is based on the TLS protocol versions and cipher suites specified in the request\n" }, "updatedTime": { "type": "string", "description": "Update time\n" } }, "type": "object" } }, "volcenginecc:clb/nlbServerGroup:NlbServerGroup": { "description": "A server group is a set of backend servers.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n nLBServerGroupDemo:\n type: volcenginecc:clb:NlbServerGroup\n name: NLBServerGroupDemo\n properties:\n bypassSecurityGroupEnabled: false\n healthCheck:\n enabled: false\n vpcId: vpc-13f8k4dwdsydc3n6nu5rxxxxx\n projectName: default\n serverGroupName: NLBServerGroupDemo.Aa1xxxxx\n type: instance\n protocol: UDP\n description: test.IPV4.UDP.WLC_=\n scheduler: wlc\n ipAddressVersion: ipv4\n anyPortEnabled: false\n connectionDrainEnabled: false\n preserveClientIpEnabled: false\n sessionPersistenceEnabled: false\n proxyProtocolType: off\n servers:\n - instance_id: i-ye2fvd0qo0bw80ctxxxxx\n type: ecs\n ip: 192.168.xx.76\n port: 10\n weight: 50\n - instance_id: eni-mirt64nt1xq85smt1a3xxxxx\n type: eni\n ip: 192.168.xx.77\n port: 20\n weight: 50\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/nlbServerGroup:NlbServerGroup example \"server_group_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account ID\n" }, "anyPortEnabled": { "type": "boolean", "description": "Enable all-port forwarding\n" }, "bypassSecurityGroupEnabled": { "type": "boolean", "description": "Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.\n" }, "connectionDrainEnabled": { "type": "boolean", "description": "Enable graceful connection termination.\n" }, "connectionDrainTimeout": { "type": "integer", "description": "Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.\n" }, "createdTime": { "type": "string", "description": "Backend server group creation time\n" }, "description": { "type": "string", "description": "Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.\n" }, "healthCheck": { "$ref": "#/types/volcenginecc:clb/NlbServerGroupHealthCheck:NlbServerGroupHealthCheck", "description": "Health check parameters\n" }, "ipAddressVersion": { "type": "string", "description": "IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.\n" }, "preserveClientIpEnabled": { "type": "boolean", "description": "Enable source address persistence\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "protocol": { "type": "string", "description": "Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.\n" }, "proxyProtocolType": { "type": "string", "description": "Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.\n" }, "relatedLoadBalancerIds": { "type": "array", "items": { "type": "string" }, "description": "NLB instance associated with the server group.\n" }, "scheduler": { "type": "string", "description": "Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.\n" }, "serverCount": { "type": "integer", "description": "Number of backend servers in the server group.\n" }, "serverGroupId": { "type": "string", "description": "Server group ID\n" }, "serverGroupName": { "type": "string", "description": "Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbServerGroupServer:NlbServerGroupServer" } }, "sessionPersistenceEnabled": { "type": "boolean", "description": "Enable session persistence.\n" }, "sessionPersistenceTimeout": { "type": "integer", "description": "Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds\n" }, "status": { "type": "string", "description": "Server group status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbServerGroupTag:NlbServerGroupTag" } }, "timestampRemoveEnabled": { "type": "boolean", "description": "Enable removal of TCP/HTTP/HTTPS packet timestamps\n" }, "type": { "type": "string", "description": "Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.\n" }, "updatedTime": { "type": "string", "description": "Last update time of the backend server group.\n" }, "vpcId": { "type": "string", "description": "ID of the private network to which the server group belongs\n" } }, "required": [ "accountId", "anyPortEnabled", "bypassSecurityGroupEnabled", "connectionDrainEnabled", "connectionDrainTimeout", "createdTime", "description", "healthCheck", "ipAddressVersion", "preserveClientIpEnabled", "projectName", "protocol", "proxyProtocolType", "relatedLoadBalancerIds", "scheduler", "serverCount", "serverGroupId", "serverGroupName", "servers", "sessionPersistenceEnabled", "sessionPersistenceTimeout", "status", "tags", "timestampRemoveEnabled", "type", "updatedTime", "vpcId" ], "inputProperties": { "anyPortEnabled": { "type": "boolean", "description": "Enable all-port forwarding\n" }, "bypassSecurityGroupEnabled": { "type": "boolean", "description": "Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.\n" }, "connectionDrainEnabled": { "type": "boolean", "description": "Enable graceful connection termination.\n" }, "connectionDrainTimeout": { "type": "integer", "description": "Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.\n" }, "description": { "type": "string", "description": "Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.\n" }, "healthCheck": { "$ref": "#/types/volcenginecc:clb/NlbServerGroupHealthCheck:NlbServerGroupHealthCheck", "description": "Health check parameters\n" }, "ipAddressVersion": { "type": "string", "description": "IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.\n" }, "preserveClientIpEnabled": { "type": "boolean", "description": "Enable source address persistence\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "protocol": { "type": "string", "description": "Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.\n" }, "proxyProtocolType": { "type": "string", "description": "Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.\n" }, "scheduler": { "type": "string", "description": "Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.\n" }, "serverGroupName": { "type": "string", "description": "Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbServerGroupServer:NlbServerGroupServer" } }, "sessionPersistenceEnabled": { "type": "boolean", "description": "Enable session persistence.\n" }, "sessionPersistenceTimeout": { "type": "integer", "description": "Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbServerGroupTag:NlbServerGroupTag" } }, "timestampRemoveEnabled": { "type": "boolean", "description": "Enable removal of TCP/HTTP/HTTPS packet timestamps\n" }, "type": { "type": "string", "description": "Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.\n" }, "vpcId": { "type": "string", "description": "ID of the private network to which the server group belongs\n" } }, "requiredInputs": [ "protocol", "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering NlbServerGroup resources.\n", "properties": { "accountId": { "type": "string", "description": "Account ID\n" }, "anyPortEnabled": { "type": "boolean", "description": "Enable all-port forwarding\n" }, "bypassSecurityGroupEnabled": { "type": "boolean", "description": "Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.\n" }, "connectionDrainEnabled": { "type": "boolean", "description": "Enable graceful connection termination.\n" }, "connectionDrainTimeout": { "type": "integer", "description": "Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.\n" }, "createdTime": { "type": "string", "description": "Backend server group creation time\n" }, "description": { "type": "string", "description": "Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.\n" }, "healthCheck": { "$ref": "#/types/volcenginecc:clb/NlbServerGroupHealthCheck:NlbServerGroupHealthCheck", "description": "Health check parameters\n" }, "ipAddressVersion": { "type": "string", "description": "IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.\n" }, "preserveClientIpEnabled": { "type": "boolean", "description": "Enable source address persistence\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "protocol": { "type": "string", "description": "Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.\n" }, "proxyProtocolType": { "type": "string", "description": "Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.\n" }, "relatedLoadBalancerIds": { "type": "array", "items": { "type": "string" }, "description": "NLB instance associated with the server group.\n" }, "scheduler": { "type": "string", "description": "Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.\n" }, "serverCount": { "type": "integer", "description": "Number of backend servers in the server group.\n" }, "serverGroupId": { "type": "string", "description": "Server group ID\n" }, "serverGroupName": { "type": "string", "description": "Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbServerGroupServer:NlbServerGroupServer" } }, "sessionPersistenceEnabled": { "type": "boolean", "description": "Enable session persistence.\n" }, "sessionPersistenceTimeout": { "type": "integer", "description": "Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds\n" }, "status": { "type": "string", "description": "Server group status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/NlbServerGroupTag:NlbServerGroupTag" } }, "timestampRemoveEnabled": { "type": "boolean", "description": "Enable removal of TCP/HTTP/HTTPS packet timestamps\n" }, "type": { "type": "string", "description": "Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.\n" }, "updatedTime": { "type": "string", "description": "Last update time of the backend server group.\n" }, "vpcId": { "type": "string", "description": "ID of the private network to which the server group belongs\n" } }, "type": "object" } }, "volcenginecc:clb/rule:Rule": { "description": "The forwarding rule directs requests for specified domain names and URLs to the designated backend server group.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst ruleDemo = new volcenginecc.clb.Rule(\"RuleDemo\", {\n listenerId: \"lsn-13****\",\n description: \"RuleDemo Example\",\n domain: \"www.***.com\",\n actionType: \"Forward\",\n serverGroupId: \"rsp-mj***\",\n url: \"/co3cee\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nrule_demo = volcenginecc.clb.Rule(\"RuleDemo\",\n listener_id=\"lsn-13****\",\n description=\"RuleDemo Example\",\n domain=\"www.***.com\",\n action_type=\"Forward\",\n server_group_id=\"rsp-mj***\",\n url=\"/co3cee\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var ruleDemo = new Volcenginecc.Clb.Rule(\"RuleDemo\", new()\n {\n ListenerId = \"lsn-13****\",\n Description = \"RuleDemo Example\",\n Domain = \"www.***.com\",\n ActionType = \"Forward\",\n ServerGroupId = \"rsp-mj***\",\n Url = \"/co3cee\",\n Tags = new[]\n {\n new Volcenginecc.Clb.Inputs.RuleTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/clb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := clb.NewRule(ctx, \"RuleDemo\", \u0026clb.RuleArgs{\n\t\t\tListenerId: pulumi.String(\"lsn-13****\"),\n\t\t\tDescription: pulumi.String(\"RuleDemo Example\"),\n\t\t\tDomain: pulumi.String(\"www.***.com\"),\n\t\t\tActionType: pulumi.String(\"Forward\"),\n\t\t\tServerGroupId: pulumi.String(\"rsp-mj***\"),\n\t\t\tUrl: pulumi.String(\"/co3cee\"),\n\t\t\tTags: clb.RuleTagArray{\n\t\t\t\t\u0026clb.RuleTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.clb.Rule;\nimport com.volcengine.volcenginecc.clb.RuleArgs;\nimport com.pulumi.volcenginecc.clb.inputs.RuleTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var ruleDemo = new Rule(\"ruleDemo\", RuleArgs.builder()\n .listenerId(\"lsn-13****\")\n .description(\"RuleDemo Example\")\n .domain(\"www.***.com\")\n .actionType(\"Forward\")\n .serverGroupId(\"rsp-mj***\")\n .url(\"/co3cee\")\n .tags(RuleTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n ruleDemo:\n type: volcenginecc:clb:Rule\n name: RuleDemo\n properties:\n listenerId: lsn-13****\n description: RuleDemo Example\n domain: www.***.com\n actionType: Forward\n serverGroupId: rsp-mj***\n url: /co3cee\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/rule:Rule example \"listener_id|rule_id\"\n```\n\n", "properties": { "actionType": { "type": "string", "description": "Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.\n" }, "description": { "type": "string", "description": "Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.\n" }, "domain": { "type": "string", "description": "Domain name of the forwarding rule.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "redirectConfig": { "$ref": "#/types/volcenginecc:clb/RuleRedirectConfig:RuleRedirectConfig", "description": "Redirection-related configuration information.\n" }, "ruleId": { "type": "string", "description": "Forwarding rule ID.\n" }, "serverGroupId": { "type": "string", "description": "ID of the backend server group associated with the forwarding rule.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/RuleTag:RuleTag" } }, "url": { "type": "string", "description": "URL of the forwarding rule.\n" } }, "required": [ "actionType", "description", "domain", "listenerId", "redirectConfig", "ruleId", "serverGroupId", "tags", "url" ], "inputProperties": { "actionType": { "type": "string", "description": "Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.\n" }, "description": { "type": "string", "description": "Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.\n" }, "domain": { "type": "string", "description": "Domain name of the forwarding rule.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "redirectConfig": { "$ref": "#/types/volcenginecc:clb/RuleRedirectConfig:RuleRedirectConfig", "description": "Redirection-related configuration information.\n" }, "serverGroupId": { "type": "string", "description": "ID of the backend server group associated with the forwarding rule.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/RuleTag:RuleTag" } }, "url": { "type": "string", "description": "URL of the forwarding rule.\n" } }, "requiredInputs": [ "listenerId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Rule resources.\n", "properties": { "actionType": { "type": "string", "description": "Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.\n" }, "description": { "type": "string", "description": "Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.\n" }, "domain": { "type": "string", "description": "Domain name of the forwarding rule.\n" }, "listenerId": { "type": "string", "description": "Listener ID.\n" }, "redirectConfig": { "$ref": "#/types/volcenginecc:clb/RuleRedirectConfig:RuleRedirectConfig", "description": "Redirection-related configuration information.\n" }, "ruleId": { "type": "string", "description": "Forwarding rule ID.\n" }, "serverGroupId": { "type": "string", "description": "ID of the backend server group associated with the forwarding rule.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/RuleTag:RuleTag" } }, "url": { "type": "string", "description": "URL of the forwarding rule.\n" } }, "type": "object" } }, "volcenginecc:clb/serverGroup:ServerGroup": { "description": "A backend server group is a collection of backend servers.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cLBServerGroupDemo:\n type: volcenginecc:clb:ServerGroup\n name: CLBServerGroupDemo\n properties:\n loadBalancerId: clb-mioj49on0zcw5smt1b8rxxxx\n serverGroupName: CLBServerGroupDemo\n type: instance\n description: CLBServerGroupDemo description\n addressIpVersion: ipv4\n anyPortEnabled: off\n tags:\n - key: env\n value: test\n servers:\n - instance_id: i-ye498lwge85i3z3kxxxx\n type: ecs\n weight: 50\n ip: 192.168.*.13\n any_port_enabled: off\n port: 8080\n description: test\n - instance_id: i-ye48ymyy9s5i3z4pxxxx\n type: ecs\n weight: 22\n ip: 192.168.*.52\n any_port_enabled: off\n port: 91\n description: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:clb/serverGroup:ServerGroup example \"server_group_id\"\n```\n\n", "properties": { "addressIpVersion": { "type": "string", "description": "IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.\n" }, "anyPortEnabled": { "type": "string", "description": "Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.\n" }, "createTime": { "type": "string", "description": "Creation time of the backend server group.\n" }, "description": { "type": "string", "description": "Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ServerGroupListener:ServerGroupListener" } }, "loadBalancerId": { "type": "string", "description": "CLB instance ID to which the backend server group belongs.\n" }, "serverGroupId": { "type": "string", "description": "Backend server group ID.\n" }, "serverGroupName": { "type": "string", "description": "Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ServerGroupServer:ServerGroupServer" } }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ServerGroupTag:ServerGroupTag" } }, "type": { "type": "string", "description": "Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.\n" }, "updateTime": { "type": "string", "description": "Last operation time of the backend server group.\n" } }, "required": [ "addressIpVersion", "anyPortEnabled", "createTime", "description", "listeners", "loadBalancerId", "serverGroupId", "serverGroupName", "servers", "tags", "type", "updateTime" ], "inputProperties": { "addressIpVersion": { "type": "string", "description": "IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.\n" }, "anyPortEnabled": { "type": "string", "description": "Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.\n" }, "description": { "type": "string", "description": "Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "loadBalancerId": { "type": "string", "description": "CLB instance ID to which the backend server group belongs.\n" }, "serverGroupName": { "type": "string", "description": "Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ServerGroupServer:ServerGroupServer" } }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ServerGroupTag:ServerGroupTag" } }, "type": { "type": "string", "description": "Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.\n" } }, "requiredInputs": [ "loadBalancerId" ], "stateInputs": { "description": "Input properties used for looking up and filtering ServerGroup resources.\n", "properties": { "addressIpVersion": { "type": "string", "description": "IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.\n" }, "anyPortEnabled": { "type": "string", "description": "Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.\n" }, "createTime": { "type": "string", "description": "Creation time of the backend server group.\n" }, "description": { "type": "string", "description": "Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "listeners": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ServerGroupListener:ServerGroupListener" } }, "loadBalancerId": { "type": "string", "description": "CLB instance ID to which the backend server group belongs.\n" }, "serverGroupId": { "type": "string", "description": "Backend server group ID.\n" }, "serverGroupName": { "type": "string", "description": "Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ServerGroupServer:ServerGroupServer" } }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:clb/ServerGroupTag:ServerGroupTag" } }, "type": { "type": "string", "description": "Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.\n" }, "updateTime": { "type": "string", "description": "Last operation time of the backend server group.\n" } }, "type": "object" } }, "volcenginecc:cloudidentity/group:Group": { "description": "When you need to grant SSO authorization to Cloud Identity Center users in bulk, you can first manage users in bulk through user groups\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cloudIdentityGroupDemo:\n type: volcenginecc:cloudidentity:Group\n name: CloudIdentityGroupDemo\n properties:\n description: ccapi-multi-des\n displayName: test for ccapi\n groupName: ccapi-multi\n joinType: Manual\n members:\n - user_id: '***********'\n - user_id: '*************'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cloudidentity/group:Group example \"group_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "Description\n" }, "displayName": { "type": "string", "description": "Display Name\n" }, "groupId": { "type": "string", "description": "User Group ID\n" }, "groupName": { "type": "string", "description": "User Group Name\n" }, "joinType": { "type": "string", "description": "User Group Type\n" }, "members": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudidentity/GroupMember:GroupMember" } }, "source": { "type": "string", "description": "User Group Source\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "required": [ "createdTime", "description", "displayName", "groupId", "groupName", "joinType", "members", "source", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Description\n" }, "displayName": { "type": "string", "description": "Display Name\n" }, "groupName": { "type": "string", "description": "User Group Name\n" }, "joinType": { "type": "string", "description": "User Group Type\n" }, "members": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudidentity/GroupMember:GroupMember" } } }, "requiredInputs": [ "groupName", "joinType" ], "stateInputs": { "description": "Input properties used for looking up and filtering Group resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "Description\n" }, "displayName": { "type": "string", "description": "Display Name\n" }, "groupId": { "type": "string", "description": "User Group ID\n" }, "groupName": { "type": "string", "description": "User Group Name\n" }, "joinType": { "type": "string", "description": "User Group Type\n" }, "members": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudidentity/GroupMember:GroupMember" } }, "source": { "type": "string", "description": "User Group Source\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "type": "object" } }, "volcenginecc:cloudidentity/permissionSet:PermissionSet": { "description": "After you create a Cloud Identity Center user, you need to grant the user login access permissions to each account. When access permissions to Volcano Engine cloud resources share common characteristics, such as network operations permissions or security management permissions, you can predefine permission sets in the Cloud Identity Center as templates. You can achieve centralized authorization based on these permission sets. The Cloud Identity Center will synchronize and distribute permission sets to each account, reducing enterprise permission operation and maintenance costs\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cloudIdentityPermissionSetDemo:\n type: volcenginecc:cloudidentity:PermissionSet\n name: CloudIdentityPermissionSetDemo\n properties:\n description: cc-test\n name: cctest-test\n relayState: https://console.xxxxx.com/xxxxx\n sessionDuration: 3600\n permissionPolicies:\n - permission_policy_name: AdministratorAccess\n permission_policy_type: System\n permission_policy_document: \"\"\n - permission_policy_name: IAMFullAccess\n permission_policy_type: System\n permission_policy_document: \"\"\n - permission_policy_name: InlinePolicy\n permission_policy_type: Inline\n permission_policy_document: |-\n {\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"vpc:*\"\n ],\n \"Resource\": [\n \"*\"\n ]\n }\n ]\n }\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cloudidentity/permissionSet:PermissionSet example \"permission_set_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "Permission Set Description\n" }, "name": { "type": "string", "description": "Permission Set Name\n" }, "permissionPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudidentity/PermissionSetPermissionPolicy:PermissionSetPermissionPolicy" } }, "permissionSetId": { "type": "string", "description": "Permission Set ID\n" }, "relayState": { "type": "string", "description": "Console Redirect URL\n" }, "sessionDuration": { "type": "integer", "description": "Session Expiration Time (seconds)\n" }, "statusNotifications": { "type": "array", "items": { "type": "string" }, "description": "Status Notification Configuration\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "required": [ "createdTime", "description", "name", "permissionPolicies", "permissionSetId", "relayState", "sessionDuration", "statusNotifications", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Permission Set Description\n" }, "name": { "type": "string", "description": "Permission Set Name\n" }, "permissionPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudidentity/PermissionSetPermissionPolicy:PermissionSetPermissionPolicy" } }, "relayState": { "type": "string", "description": "Console Redirect URL\n" }, "sessionDuration": { "type": "integer", "description": "Session Expiration Time (seconds)\n" } }, "requiredInputs": [ "name" ], "stateInputs": { "description": "Input properties used for looking up and filtering PermissionSet resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "Permission Set Description\n" }, "name": { "type": "string", "description": "Permission Set Name\n" }, "permissionPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudidentity/PermissionSetPermissionPolicy:PermissionSetPermissionPolicy" } }, "permissionSetId": { "type": "string", "description": "Permission Set ID\n" }, "relayState": { "type": "string", "description": "Console Redirect URL\n" }, "sessionDuration": { "type": "integer", "description": "Session Expiration Time (seconds)\n" }, "statusNotifications": { "type": "array", "items": { "type": "string" }, "description": "Status Notification Configuration\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "type": "object" } }, "volcenginecc:cloudidentity/permissionSetAssignment:PermissionSetAssignment": { "description": "After you create a Cloud Identity Center user, you need to grant the user login access to each account.\nWhen users require access to Volcano Engine cloud resources with permissions that share abstractable characteristics, such as network operations permissions or security management permissions, you can predefine permission sets in the Cloud Identity Center as templates. You can achieve centralized authorization based on these permission sets. The Cloud Identity Center will synchronize and distribute permission sets to each account, reducing enterprise permission management costs.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cloudIdentityPermissionSetAssignmentDemo = new volcenginecc.cloudidentity.PermissionSetAssignment(\"CloudIdentityPermissionSetAssignmentDemo\", {\n permissionSetId: \"897569*****\",\n principalId: \"899471*****\",\n principalType: \"User\",\n targetId: \"21036*****\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ncloud_identity_permission_set_assignment_demo = volcenginecc.cloudidentity.PermissionSetAssignment(\"CloudIdentityPermissionSetAssignmentDemo\",\n permission_set_id=\"897569*****\",\n principal_id=\"899471*****\",\n principal_type=\"User\",\n target_id=\"21036*****\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cloudIdentityPermissionSetAssignmentDemo = new Volcenginecc.Cloudidentity.PermissionSetAssignment(\"CloudIdentityPermissionSetAssignmentDemo\", new()\n {\n PermissionSetId = \"897569*****\",\n PrincipalId = \"899471*****\",\n PrincipalType = \"User\",\n TargetId = \"21036*****\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cloudidentity\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cloudidentity.NewPermissionSetAssignment(ctx, \"CloudIdentityPermissionSetAssignmentDemo\", \u0026cloudidentity.PermissionSetAssignmentArgs{\n\t\t\tPermissionSetId: pulumi.String(\"897569*****\"),\n\t\t\tPrincipalId: pulumi.String(\"899471*****\"),\n\t\t\tPrincipalType: pulumi.String(\"User\"),\n\t\t\tTargetId: pulumi.String(\"21036*****\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cloudidentity.PermissionSetAssignment;\nimport com.volcengine.volcenginecc.cloudidentity.PermissionSetAssignmentArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cloudIdentityPermissionSetAssignmentDemo = new PermissionSetAssignment(\"cloudIdentityPermissionSetAssignmentDemo\", PermissionSetAssignmentArgs.builder()\n .permissionSetId(\"897569*****\")\n .principalId(\"899471*****\")\n .principalType(\"User\")\n .targetId(\"21036*****\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cloudIdentityPermissionSetAssignmentDemo:\n type: volcenginecc:cloudidentity:PermissionSetAssignment\n name: CloudIdentityPermissionSetAssignmentDemo\n properties:\n permissionSetId: 897569*****\n principalId: 899471*****\n principalType: User\n targetId: 21036*****\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cloudidentity/permissionSetAssignment:PermissionSetAssignment example \"target_id|principal_id|permission_set_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Authorization creation time\n" }, "permissionSetId": { "type": "string", "description": "Permission set ID\n" }, "permissionSetName": { "type": "string", "description": "Permission set name\n" }, "principalId": { "type": "string", "description": "Cloud Identity Center object ID\n" }, "principalName": { "type": "string", "description": "Cloud Identity Center object name\n" }, "principalType": { "type": "string", "description": "Cloud Identity Center object type: User or Group\n" }, "targetId": { "type": "string", "description": "Authorized account ID\n" }, "targetName": { "type": "string", "description": "Authorized account name\n" } }, "required": [ "createdTime", "permissionSetId", "permissionSetName", "principalId", "principalName", "principalType", "targetId", "targetName" ], "inputProperties": { "permissionSetId": { "type": "string", "description": "Permission set ID\n" }, "principalId": { "type": "string", "description": "Cloud Identity Center object ID\n" }, "principalType": { "type": "string", "description": "Cloud Identity Center object type: User or Group\n" }, "targetId": { "type": "string", "description": "Authorized account ID\n" } }, "requiredInputs": [ "permissionSetId", "principalId", "principalType", "targetId" ], "stateInputs": { "description": "Input properties used for looking up and filtering PermissionSetAssignment resources.\n", "properties": { "createdTime": { "type": "string", "description": "Authorization creation time\n" }, "permissionSetId": { "type": "string", "description": "Permission set ID\n" }, "permissionSetName": { "type": "string", "description": "Permission set name\n" }, "principalId": { "type": "string", "description": "Cloud Identity Center object ID\n" }, "principalName": { "type": "string", "description": "Cloud Identity Center object name\n" }, "principalType": { "type": "string", "description": "Cloud Identity Center object type: User or Group\n" }, "targetId": { "type": "string", "description": "Authorized account ID\n" }, "targetName": { "type": "string", "description": "Authorized account name\n" } }, "type": "object" } }, "volcenginecc:cloudidentity/permissionSetProvisioning:PermissionSetProvisioning": { "description": "Deploy permission set to the specified account\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cloudIdentityPermissionSetProvisioningDemo = new volcenginecc.cloudidentity.PermissionSetProvisioning(\"CloudIdentityPermissionSetProvisioningDemo\", {\n permissionSetId: \"897569*****\",\n targetId: \"21036*****\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ncloud_identity_permission_set_provisioning_demo = volcenginecc.cloudidentity.PermissionSetProvisioning(\"CloudIdentityPermissionSetProvisioningDemo\",\n permission_set_id=\"897569*****\",\n target_id=\"21036*****\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cloudIdentityPermissionSetProvisioningDemo = new Volcenginecc.Cloudidentity.PermissionSetProvisioning(\"CloudIdentityPermissionSetProvisioningDemo\", new()\n {\n PermissionSetId = \"897569*****\",\n TargetId = \"21036*****\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cloudidentity\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cloudidentity.NewPermissionSetProvisioning(ctx, \"CloudIdentityPermissionSetProvisioningDemo\", \u0026cloudidentity.PermissionSetProvisioningArgs{\n\t\t\tPermissionSetId: pulumi.String(\"897569*****\"),\n\t\t\tTargetId: pulumi.String(\"21036*****\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cloudidentity.PermissionSetProvisioning;\nimport com.volcengine.volcenginecc.cloudidentity.PermissionSetProvisioningArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cloudIdentityPermissionSetProvisioningDemo = new PermissionSetProvisioning(\"cloudIdentityPermissionSetProvisioningDemo\", PermissionSetProvisioningArgs.builder()\n .permissionSetId(\"897569*****\")\n .targetId(\"21036*****\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cloudIdentityPermissionSetProvisioningDemo:\n type: volcenginecc:cloudidentity:PermissionSetProvisioning\n name: CloudIdentityPermissionSetProvisioningDemo\n properties:\n permissionSetId: 897569*****\n targetId: 21036*****\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cloudidentity/permissionSetProvisioning:PermissionSetProvisioning example \"permission_set_id|target_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time\n" }, "permissionSetId": { "type": "string", "description": "Permission set ID\n" }, "permissionSetName": { "type": "string", "description": "Permission set name\n" }, "provisioningStatus": { "type": "string", "description": "Permission set status Running: In progress, Reprovision Required: Redeployment required, Provision Failed: Deployment failed, Provisioned: Deployed\n" }, "targetId": { "type": "string", "description": "Authorized account ID\n" }, "targetName": { "type": "string", "description": "Account name\n" }, "updatedTime": { "type": "string", "description": "Update time\n" } }, "required": [ "createdTime", "permissionSetId", "permissionSetName", "provisioningStatus", "targetId", "targetName", "updatedTime" ], "inputProperties": { "permissionSetId": { "type": "string", "description": "Permission set ID\n" }, "targetId": { "type": "string", "description": "Authorized account ID\n" } }, "requiredInputs": [ "permissionSetId", "targetId" ], "stateInputs": { "description": "Input properties used for looking up and filtering PermissionSetProvisioning resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time\n" }, "permissionSetId": { "type": "string", "description": "Permission set ID\n" }, "permissionSetName": { "type": "string", "description": "Permission set name\n" }, "provisioningStatus": { "type": "string", "description": "Permission set status Running: In progress, Reprovision Required: Redeployment required, Provision Failed: Deployment failed, Provisioned: Deployed\n" }, "targetId": { "type": "string", "description": "Authorized account ID\n" }, "targetName": { "type": "string", "description": "Account name\n" }, "updatedTime": { "type": "string", "description": "Update time\n" } }, "type": "object" } }, "volcenginecc:cloudidentity/user:User": { "description": "Cloud Identity Center users are mapped one-to-one with enterprise employee identities. A Cloud Identity Center user is an identity type that can be uniquely linked to an IAM user under an account for single sign-on. Cloud Identity Center provides full lifecycle management and permission management for enterprise employee identities. We recommend that you centrally manage employee identities within this product.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cloudIdentityUserDemo = new volcenginecc.cloudidentity.User(\"CloudIdentityUserDemo\", {\n userName: \"CloudIdentityUserDemo\",\n displayName: \"CloudIdentityUserDemo\",\n description: \"CloudIdentityUserDemo description\",\n email: \"xxx@163.com\",\n phone: \"***********\",\n password: \"********\",\n passwordResetRequired: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ncloud_identity_user_demo = volcenginecc.cloudidentity.User(\"CloudIdentityUserDemo\",\n user_name=\"CloudIdentityUserDemo\",\n display_name=\"CloudIdentityUserDemo\",\n description=\"CloudIdentityUserDemo description\",\n email=\"xxx@163.com\",\n phone=\"***********\",\n password=\"********\",\n password_reset_required=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cloudIdentityUserDemo = new Volcenginecc.Cloudidentity.User(\"CloudIdentityUserDemo\", new()\n {\n UserName = \"CloudIdentityUserDemo\",\n DisplayName = \"CloudIdentityUserDemo\",\n Description = \"CloudIdentityUserDemo description\",\n Email = \"xxx@163.com\",\n Phone = \"***********\",\n Password = \"********\",\n PasswordResetRequired = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cloudidentity\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cloudidentity.NewUser(ctx, \"CloudIdentityUserDemo\", \u0026cloudidentity.UserArgs{\n\t\t\tUserName: pulumi.String(\"CloudIdentityUserDemo\"),\n\t\t\tDisplayName: pulumi.String(\"CloudIdentityUserDemo\"),\n\t\t\tDescription: pulumi.String(\"CloudIdentityUserDemo description\"),\n\t\t\tEmail: pulumi.String(\"xxx@163.com\"),\n\t\t\tPhone: pulumi.String(\"***********\"),\n\t\t\tPassword: pulumi.String(\"********\"),\n\t\t\tPasswordResetRequired: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cloudidentity.User;\nimport com.volcengine.volcenginecc.cloudidentity.UserArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cloudIdentityUserDemo = new User(\"cloudIdentityUserDemo\", UserArgs.builder()\n .userName(\"CloudIdentityUserDemo\")\n .displayName(\"CloudIdentityUserDemo\")\n .description(\"CloudIdentityUserDemo description\")\n .email(\"xxx@163.com\")\n .phone(\"***********\")\n .password(\"********\")\n .passwordResetRequired(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cloudIdentityUserDemo:\n type: volcenginecc:cloudidentity:User\n name: CloudIdentityUserDemo\n properties:\n userName: CloudIdentityUserDemo\n displayName: CloudIdentityUserDemo\n description: CloudIdentityUserDemo description\n email: xxx@163.com\n phone: '***********'\n password: '********'\n passwordResetRequired: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cloudidentity/user:User example \"user_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time.\n" }, "description": { "type": "string", "description": "User Description.\n" }, "displayName": { "type": "string", "description": "User Display Name.\n" }, "email": { "type": "string", "description": "Email.\n" }, "identityType": { "type": "string", "description": "Identity Type.\n" }, "password": { "type": "string", "description": "Password. Password must be 8–32 characters long and include at least three of the following: uppercase letters, lowercase letters, numbers, and special symbols.\n" }, "passwordResetRequired": { "type": "boolean", "description": "Is password reset required on first login?\n" }, "phone": { "type": "string", "description": "Mobile Number.\n" }, "source": { "type": "string", "description": "User Source.\n" }, "updatedTime": { "type": "string", "description": "Update Time.\n" }, "userId": { "type": "string", "description": "User ID.\n" }, "userName": { "type": "string", "description": "Username.\n" } }, "required": [ "createdTime", "description", "displayName", "email", "identityType", "password", "passwordResetRequired", "phone", "source", "updatedTime", "userId", "userName" ], "inputProperties": { "description": { "type": "string", "description": "User Description.\n" }, "displayName": { "type": "string", "description": "User Display Name.\n" }, "email": { "type": "string", "description": "Email.\n" }, "password": { "type": "string", "description": "Password. Password must be 8–32 characters long and include at least three of the following: uppercase letters, lowercase letters, numbers, and special symbols.\n" }, "passwordResetRequired": { "type": "boolean", "description": "Is password reset required on first login?\n" }, "phone": { "type": "string", "description": "Mobile Number.\n" }, "userName": { "type": "string", "description": "Username.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering User resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time.\n" }, "description": { "type": "string", "description": "User Description.\n" }, "displayName": { "type": "string", "description": "User Display Name.\n" }, "email": { "type": "string", "description": "Email.\n" }, "identityType": { "type": "string", "description": "Identity Type.\n" }, "password": { "type": "string", "description": "Password. Password must be 8–32 characters long and include at least three of the following: uppercase letters, lowercase letters, numbers, and special symbols.\n" }, "passwordResetRequired": { "type": "boolean", "description": "Is password reset required on first login?\n" }, "phone": { "type": "string", "description": "Mobile Number.\n" }, "source": { "type": "string", "description": "User Source.\n" }, "updatedTime": { "type": "string", "description": "Update Time.\n" }, "userId": { "type": "string", "description": "User ID.\n" }, "userName": { "type": "string", "description": "Username.\n" } }, "type": "object" } }, "volcenginecc:cloudidentity/userProvisioning:UserProvisioning": { "description": "After you create a Cloud Identity Center user, you need to grant the user login access to each account.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@pulumi/volcenginecc\";\n\nconst cloudIdentityUserProvisioningDemo = new volcenginecc.index.CloudidentityUserprovisioning(\"CloudIdentityUserProvisioningDemo\", {\n targetId: \"2103612***\",\n principalType: \"Group\",\n principalId: \"8990752****\",\n duplicationStrategy: \"KeepBoth\",\n deletionStrategy: \"Delete\",\n identitySourceStrategy: \"BindConflictUser\",\n description: \"ccapi-test\",\n duplicationSuffix: \"-cctest\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ncloud_identity_user_provisioning_demo = volcenginecc.index.CloudidentityUserprovisioning(\"CloudIdentityUserProvisioningDemo\",\n target_id=2103612***,\n principal_type=Group,\n principal_id=8990752****,\n duplication_strategy=KeepBoth,\n deletion_strategy=Delete,\n identity_source_strategy=BindConflictUser,\n description=ccapi-test,\n duplication_suffix=-cctest)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cloudIdentityUserProvisioningDemo = new Volcenginecc.Index.CloudidentityUserprovisioning(\"CloudIdentityUserProvisioningDemo\", new()\n {\n TargetId = \"2103612***\",\n PrincipalType = \"Group\",\n PrincipalId = \"8990752****\",\n DuplicationStrategy = \"KeepBoth\",\n DeletionStrategy = \"Delete\",\n IdentitySourceStrategy = \"BindConflictUser\",\n Description = \"ccapi-test\",\n DuplicationSuffix = \"-cctest\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := volcenginecc.NewCloudidentityUserprovisioning(ctx, \"CloudIdentityUserProvisioningDemo\", \u0026volcenginecc.CloudidentityUserprovisioningArgs{\n\t\t\tTargetId: \"2103612***\",\n\t\t\tPrincipalType: \"Group\",\n\t\t\tPrincipalId: \"8990752****\",\n\t\t\tDuplicationStrategy: \"KeepBoth\",\n\t\t\tDeletionStrategy: \"Delete\",\n\t\t\tIdentitySourceStrategy: \"BindConflictUser\",\n\t\t\tDescription: \"ccapi-test\",\n\t\t\tDuplicationSuffix: \"-cctest\",\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.volcenginecc.cloudidentityUserprovisioning;\nimport com.pulumi.volcenginecc.cloudidentityUserprovisioningArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cloudIdentityUserProvisioningDemo = new CloudidentityUserprovisioning(\"cloudIdentityUserProvisioningDemo\", CloudidentityUserprovisioningArgs.builder()\n .targetId(\"2103612***\")\n .principalType(\"Group\")\n .principalId(\"8990752****\")\n .duplicationStrategy(\"KeepBoth\")\n .deletionStrategy(\"Delete\")\n .identitySourceStrategy(\"BindConflictUser\")\n .description(\"ccapi-test\")\n .duplicationSuffix(\"-cctest\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cloudIdentityUserProvisioningDemo:\n type: volcenginecc:cloudidentityUserprovisioning\n name: CloudIdentityUserProvisioningDemo\n properties:\n targetId: 2103612***\n principalType: Group\n principalId: 8990752****\n duplicationStrategy: KeepBoth\n deletionStrategy: Delete\n identitySourceStrategy: BindConflictUser\n description: ccapi-test\n duplicationSuffix: -cctest\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cloudidentity/userProvisioning:UserProvisioning example \"user_provisioning_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "deletionStrategy": { "type": "string", "description": "Deletion Policy\n" }, "description": { "type": "string", "description": "Task Description\n" }, "duplicationStrategy": { "type": "string", "description": "Username Conflict Policy\n" }, "duplicationSuffix": { "type": "string", "description": "Suffix for IAM user name in this synchronization\n" }, "identitySourceStrategy": { "type": "string", "description": "Identity Source Conflict Policy\n" }, "principalId": { "type": "string", "description": "Identity ID\n" }, "principalName": { "type": "string", "description": "Target Name\n" }, "principalType": { "type": "string", "description": "Identity Type\n" }, "provisionStatus": { "type": "string", "description": "Authorization Task Status. Provisioned: authorization successful, Provisioning: authorizing, DeleteProvisioning: revoking authorization, DeleteProvisioned: authorization revoked successfully.\n" }, "targetId": { "type": "string", "description": "Target ID\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" }, "userProvisioningId": { "type": "string", "description": "IAM User Synchronization Task ID\n" } }, "required": [ "createdTime", "deletionStrategy", "description", "duplicationStrategy", "duplicationSuffix", "identitySourceStrategy", "principalId", "principalName", "principalType", "provisionStatus", "targetId", "updatedTime", "userProvisioningId" ], "inputProperties": { "deletionStrategy": { "type": "string", "description": "Deletion Policy\n" }, "description": { "type": "string", "description": "Task Description\n" }, "duplicationStrategy": { "type": "string", "description": "Username Conflict Policy\n" }, "duplicationSuffix": { "type": "string", "description": "Suffix for IAM user name in this synchronization\n" }, "identitySourceStrategy": { "type": "string", "description": "Identity Source Conflict Policy\n" }, "principalId": { "type": "string", "description": "Identity ID\n" }, "principalType": { "type": "string", "description": "Identity Type\n" }, "targetId": { "type": "string", "description": "Target ID\n" } }, "requiredInputs": [ "deletionStrategy", "duplicationStrategy", "identitySourceStrategy", "principalId", "principalType", "targetId" ], "stateInputs": { "description": "Input properties used for looking up and filtering UserProvisioning resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation Time\n" }, "deletionStrategy": { "type": "string", "description": "Deletion Policy\n" }, "description": { "type": "string", "description": "Task Description\n" }, "duplicationStrategy": { "type": "string", "description": "Username Conflict Policy\n" }, "duplicationSuffix": { "type": "string", "description": "Suffix for IAM user name in this synchronization\n" }, "identitySourceStrategy": { "type": "string", "description": "Identity Source Conflict Policy\n" }, "principalId": { "type": "string", "description": "Identity ID\n" }, "principalName": { "type": "string", "description": "Target Name\n" }, "principalType": { "type": "string", "description": "Identity Type\n" }, "provisionStatus": { "type": "string", "description": "Authorization Task Status. Provisioned: authorization successful, Provisioning: authorizing, DeleteProvisioning: revoking authorization, DeleteProvisioned: authorization revoked successfully.\n" }, "targetId": { "type": "string", "description": "Target ID\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" }, "userProvisioningId": { "type": "string", "description": "IAM User Synchronization Task ID\n" } }, "type": "object" } }, "volcenginecc:cloudmonitor/rule:Rule": { "description": "If you need to monitor the data status of a cloud product resource, you can create a cloud monitoring alert policy. When the monitored resource data meets the alert trigger conditions, the system will send alert notifications using your specified method, helping you quickly identify resources with abnormal data.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n cloudMonitorRuleDemo:\n type: volcenginecc:cloudmonitor:Rule\n name: CloudMonitorRuleDemo\n properties:\n ruleName: CloudMonitorRuleDemo\n description: this is a description\n ruleType: static\n namespace: VCM_AgentKitMcp\n subNamespace: MCP_Service\n originalDimensions:\n key: ResourceID\n values:\n - '*'\n level: warning\n evaluationCount: 1\n enableState: enable\n regions:\n - cn-beijing\n multipleConditions: false\n noData:\n enable: false\n evaluation_count: 4\n levelConditions:\n - level: warning\n conditions:\n - metricName: istio_requests_total\n statistics: sum\n comparisonOperator: '\u003e'\n threshold: '100000'\n metricUnit: Count\n conditions:\n - metric_name: istio_requests_total\n statistics: sum\n comparison_operator: '\u003e'\n threshold: '100000'\n metric_unit: Count\n conditionOperator: '\u0026\u0026'\n silenceTime: 5\n recoveryNotify:\n enable: true\n projectName: default\n tags:\n - key: env\n value: test\n alertMethods:\n - Email\n - Webhook\n webhookIds:\n - 2005838xxxxx67xxxxx\n contactGroupIds:\n - 20041xxxxxx06xxxxx\n effectStartAt: 00:00\n effectEndAt: 23:59\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cloudmonitor/rule:Rule example \"rule_id\"\n```\n\n", "properties": { "alertMethods": { "type": "array", "items": { "type": "string" }, "description": "Alert notification method. Email: email, Phone: phone, SMS: SMS, Webhook: webhook callback.\n" }, "alertState": { "type": "string", "description": "Alert status. alerting: In alert; normal: Normal.\n" }, "conditionOperator": { "type": "string", "description": "Multi-metric determination condition. \u0026\u0026: Alert is triggered only if all metrics meet the condition; ||: Alert is triggered if any metric meets the condition.\n" }, "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleCondition:RuleCondition" } }, "contactGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Alert notification group ID bound to the alert policy.\n" }, "createdAt": { "type": "string", "description": "Alert policy creation time, in timestamp format.\n" }, "description": { "type": "string", "description": "Alert policy description.\n" }, "dimensionConditions": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleDimensionConditions:RuleDimensionConditions", "description": "Dimension configuration.\n" }, "effectEndAt": { "type": "string", "description": "Policy expiration time, in HH:MM format.\n" }, "effectStartAt": { "type": "string", "description": "Policy start time, in HH:MM format.\n" }, "enableState": { "type": "string", "description": "Alert policy status. enable: enabled, disable: disabled\n" }, "evaluationCount": { "type": "integer", "description": "Duration required to trigger an alert, in minutes.\n" }, "level": { "type": "string", "description": "Alert level. critical: critical, warning: warning, notice: notification\n" }, "levelConditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleLevelCondition:RuleLevelCondition" } }, "multipleConditions": { "type": "boolean", "description": "Does the alert policy use multiple metrics? true: multiple metrics, false: single metric (default).\n" }, "namespace": { "type": "string", "description": "Cloud product associated with the monitoring metric. For details, see Namespace for each product in Cloud Product Monitoring Metrics.\n" }, "noData": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleNoData:RuleNoData", "description": "No data alert.\n" }, "notificationId": { "type": "string", "description": "Notification policy ID.\n" }, "notifyTemplates": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleNotifyTemplate:RuleNotifyTemplate" } }, "originalDimensions": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleOriginalDimensions:RuleOriginalDimensions", "description": "Resource ID detected by the alert policy.\n" }, "projectName": { "type": "string", "description": "Project to which the alert policy belongs.\n" }, "recoveryNotify": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleRecoveryNotify:RuleRecoveryNotify", "description": "Alert recovery notification.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "Availability zone ID of the cloud product.\n" }, "resourceType": { "type": "string", "description": "Resource type detected by the alert policy.\n" }, "ruleId": { "type": "string", "description": "Alarm policy ID.\n" }, "ruleName": { "type": "string", "description": "Alert policy name.\n" }, "ruleType": { "type": "string", "description": "Alert policy type. static: manual selection, dynamic: select by resource name, project, and tag.\n" }, "silenceTime": { "type": "integer", "description": "Alert sending interval, in minutes. Supported values: 5, 10, 15, 30, 60, 180, 360, 720, 1440.\n" }, "subNamespace": { "type": "string", "description": "Dimension of the metric referenced by this policy. For details, see SubNamespace for each product in Cloud Product Monitoring Metrics.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleTag:RuleTag" } }, "updatedAt": { "type": "string", "description": "Alarm policy update time, in timestamp format.\n" }, "webhook": { "type": "string", "description": "Alarm callback URL bound to the alarm policy.\n" }, "webhookIds": { "type": "array", "items": { "type": "string" }, "description": "Alarm callback ID list when an alarm occurs.\n" } }, "required": [ "alertMethods", "alertState", "conditionOperator", "conditions", "contactGroupIds", "createdAt", "description", "dimensionConditions", "effectEndAt", "effectStartAt", "enableState", "evaluationCount", "level", "levelConditions", "multipleConditions", "namespace", "noData", "notificationId", "notifyTemplates", "originalDimensions", "projectName", "recoveryNotify", "regions", "resourceType", "ruleId", "ruleName", "ruleType", "silenceTime", "subNamespace", "tags", "updatedAt", "webhook", "webhookIds" ], "inputProperties": { "alertMethods": { "type": "array", "items": { "type": "string" }, "description": "Alert notification method. Email: email, Phone: phone, SMS: SMS, Webhook: webhook callback.\n" }, "conditionOperator": { "type": "string", "description": "Multi-metric determination condition. \u0026\u0026: Alert is triggered only if all metrics meet the condition; ||: Alert is triggered if any metric meets the condition.\n" }, "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleCondition:RuleCondition" } }, "contactGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Alert notification group ID bound to the alert policy.\n" }, "description": { "type": "string", "description": "Alert policy description.\n" }, "dimensionConditions": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleDimensionConditions:RuleDimensionConditions", "description": "Dimension configuration.\n" }, "effectEndAt": { "type": "string", "description": "Policy expiration time, in HH:MM format.\n" }, "effectStartAt": { "type": "string", "description": "Policy start time, in HH:MM format.\n" }, "enableState": { "type": "string", "description": "Alert policy status. enable: enabled, disable: disabled\n" }, "evaluationCount": { "type": "integer", "description": "Duration required to trigger an alert, in minutes.\n" }, "level": { "type": "string", "description": "Alert level. critical: critical, warning: warning, notice: notification\n" }, "levelConditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleLevelCondition:RuleLevelCondition" } }, "multipleConditions": { "type": "boolean", "description": "Does the alert policy use multiple metrics? true: multiple metrics, false: single metric (default).\n" }, "namespace": { "type": "string", "description": "Cloud product associated with the monitoring metric. For details, see Namespace for each product in Cloud Product Monitoring Metrics.\n" }, "noData": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleNoData:RuleNoData", "description": "No data alert.\n" }, "notificationId": { "type": "string", "description": "Notification policy ID.\n" }, "notifyTemplates": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleNotifyTemplate:RuleNotifyTemplate" } }, "originalDimensions": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleOriginalDimensions:RuleOriginalDimensions", "description": "Resource ID detected by the alert policy.\n" }, "projectName": { "type": "string", "description": "Project to which the alert policy belongs.\n" }, "recoveryNotify": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleRecoveryNotify:RuleRecoveryNotify", "description": "Alert recovery notification.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "Availability zone ID of the cloud product.\n" }, "ruleName": { "type": "string", "description": "Alert policy name.\n" }, "ruleType": { "type": "string", "description": "Alert policy type. static: manual selection, dynamic: select by resource name, project, and tag.\n" }, "silenceTime": { "type": "integer", "description": "Alert sending interval, in minutes. Supported values: 5, 10, 15, 30, 60, 180, 360, 720, 1440.\n" }, "subNamespace": { "type": "string", "description": "Dimension of the metric referenced by this policy. For details, see SubNamespace for each product in Cloud Product Monitoring Metrics.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleTag:RuleTag" } }, "webhook": { "type": "string", "description": "Alarm callback URL bound to the alarm policy.\n" }, "webhookIds": { "type": "array", "items": { "type": "string" }, "description": "Alarm callback ID list when an alarm occurs.\n" } }, "requiredInputs": [ "effectEndAt", "effectStartAt", "enableState", "evaluationCount", "level", "namespace", "ruleName", "ruleType", "silenceTime", "subNamespace" ], "stateInputs": { "description": "Input properties used for looking up and filtering Rule resources.\n", "properties": { "alertMethods": { "type": "array", "items": { "type": "string" }, "description": "Alert notification method. Email: email, Phone: phone, SMS: SMS, Webhook: webhook callback.\n" }, "alertState": { "type": "string", "description": "Alert status. alerting: In alert; normal: Normal.\n" }, "conditionOperator": { "type": "string", "description": "Multi-metric determination condition. \u0026\u0026: Alert is triggered only if all metrics meet the condition; ||: Alert is triggered if any metric meets the condition.\n" }, "conditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleCondition:RuleCondition" } }, "contactGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Alert notification group ID bound to the alert policy.\n" }, "createdAt": { "type": "string", "description": "Alert policy creation time, in timestamp format.\n" }, "description": { "type": "string", "description": "Alert policy description.\n" }, "dimensionConditions": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleDimensionConditions:RuleDimensionConditions", "description": "Dimension configuration.\n" }, "effectEndAt": { "type": "string", "description": "Policy expiration time, in HH:MM format.\n" }, "effectStartAt": { "type": "string", "description": "Policy start time, in HH:MM format.\n" }, "enableState": { "type": "string", "description": "Alert policy status. enable: enabled, disable: disabled\n" }, "evaluationCount": { "type": "integer", "description": "Duration required to trigger an alert, in minutes.\n" }, "level": { "type": "string", "description": "Alert level. critical: critical, warning: warning, notice: notification\n" }, "levelConditions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleLevelCondition:RuleLevelCondition" } }, "multipleConditions": { "type": "boolean", "description": "Does the alert policy use multiple metrics? true: multiple metrics, false: single metric (default).\n" }, "namespace": { "type": "string", "description": "Cloud product associated with the monitoring metric. For details, see Namespace for each product in Cloud Product Monitoring Metrics.\n" }, "noData": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleNoData:RuleNoData", "description": "No data alert.\n" }, "notificationId": { "type": "string", "description": "Notification policy ID.\n" }, "notifyTemplates": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleNotifyTemplate:RuleNotifyTemplate" } }, "originalDimensions": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleOriginalDimensions:RuleOriginalDimensions", "description": "Resource ID detected by the alert policy.\n" }, "projectName": { "type": "string", "description": "Project to which the alert policy belongs.\n" }, "recoveryNotify": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleRecoveryNotify:RuleRecoveryNotify", "description": "Alert recovery notification.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "Availability zone ID of the cloud product.\n" }, "resourceType": { "type": "string", "description": "Resource type detected by the alert policy.\n" }, "ruleId": { "type": "string", "description": "Alarm policy ID.\n" }, "ruleName": { "type": "string", "description": "Alert policy name.\n" }, "ruleType": { "type": "string", "description": "Alert policy type. static: manual selection, dynamic: select by resource name, project, and tag.\n" }, "silenceTime": { "type": "integer", "description": "Alert sending interval, in minutes. Supported values: 5, 10, 15, 30, 60, 180, 360, 720, 1440.\n" }, "subNamespace": { "type": "string", "description": "Dimension of the metric referenced by this policy. For details, see SubNamespace for each product in Cloud Product Monitoring Metrics.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/RuleTag:RuleTag" } }, "updatedAt": { "type": "string", "description": "Alarm policy update time, in timestamp format.\n" }, "webhook": { "type": "string", "description": "Alarm callback URL bound to the alarm policy.\n" }, "webhookIds": { "type": "array", "items": { "type": "string" }, "description": "Alarm callback ID list when an alarm occurs.\n" } }, "type": "object" } }, "volcenginecc:cr/endpointAclPolicy:EndpointAclPolicy": { "description": "Adding access addresses to the allowlist for public network access can effectively enhance information security\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cREndpointAclPolicyDemo = new volcenginecc.cr.EndpointAclPolicy(\"CREndpointAclPolicyDemo\", {\n registry: \"xxxxx\",\n type: \"Public\",\n entry: \"0.0.0.0/0\",\n description: \"test acl policy\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_r_endpoint_acl_policy_demo = volcenginecc.cr.EndpointAclPolicy(\"CREndpointAclPolicyDemo\",\n registry=\"xxxxx\",\n type=\"Public\",\n entry=\"0.0.0.0/0\",\n description=\"test acl policy\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cREndpointAclPolicyDemo = new Volcenginecc.Cr.EndpointAclPolicy(\"CREndpointAclPolicyDemo\", new()\n {\n Registry = \"xxxxx\",\n Type = \"Public\",\n Entry = \"0.0.0.0/0\",\n Description = \"test acl policy\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cr\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cr.NewEndpointAclPolicy(ctx, \"CREndpointAclPolicyDemo\", \u0026cr.EndpointAclPolicyArgs{\n\t\t\tRegistry: pulumi.String(\"xxxxx\"),\n\t\t\tType: pulumi.String(\"Public\"),\n\t\t\tEntry: pulumi.String(\"0.0.0.0/0\"),\n\t\t\tDescription: pulumi.String(\"test acl policy\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cr.EndpointAclPolicy;\nimport com.volcengine.volcenginecc.cr.EndpointAclPolicyArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cREndpointAclPolicyDemo = new EndpointAclPolicy(\"cREndpointAclPolicyDemo\", EndpointAclPolicyArgs.builder()\n .registry(\"xxxxx\")\n .type(\"Public\")\n .entry(\"0.0.0.0/0\")\n .description(\"test acl policy\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cREndpointAclPolicyDemo:\n type: volcenginecc:cr:EndpointAclPolicy\n name: CREndpointAclPolicyDemo\n properties:\n registry: xxxxx\n type: Public\n entry: 0.0.0.0/0\n description: test acl policy\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cr/endpointAclPolicy:EndpointAclPolicy example \"registry|entry\"\n```\n\n", "properties": { "description": { "type": "string", "description": "Description of the allowlist IPs\n" }, "entry": { "type": "string", "description": "Allowlist IPs to be added\n" }, "registry": { "type": "string", "description": "Name of the image repository instance. On the Instance List page in the Image Repository Console, obtain the instance name\n" }, "type": { "type": "string", "description": "Network type of the allowlist; currently only Public is supported\n" } }, "required": [ "description", "entry", "registry", "type" ], "inputProperties": { "description": { "type": "string", "description": "Description of the allowlist IPs\n" }, "entry": { "type": "string", "description": "Allowlist IPs to be added\n" }, "registry": { "type": "string", "description": "Name of the image repository instance. On the Instance List page in the Image Repository Console, obtain the instance name\n" }, "type": { "type": "string", "description": "Network type of the allowlist; currently only Public is supported\n" } }, "requiredInputs": [ "registry", "type" ], "stateInputs": { "description": "Input properties used for looking up and filtering EndpointAclPolicy resources.\n", "properties": { "description": { "type": "string", "description": "Description of the allowlist IPs\n" }, "entry": { "type": "string", "description": "Allowlist IPs to be added\n" }, "registry": { "type": "string", "description": "Name of the image repository instance. On the Instance List page in the Image Repository Console, obtain the instance name\n" }, "type": { "type": "string", "description": "Network type of the allowlist; currently only Public is supported\n" } }, "type": "object" } }, "volcenginecc:cr/nameSpace:NameSpace": { "description": "A namespace is a collection of OCI artifact repositories that share related attributes. Namespace names are typically organization team names, product project names, or custom names within an enterprise.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst namespaceDemo = new volcenginecc.cr.NameSpace(\"NamespaceDemo\", {\n registry: \"test\",\n name: \"testnamespace\",\n project: \"default\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nnamespace_demo = volcenginecc.cr.NameSpace(\"NamespaceDemo\",\n registry=\"test\",\n name=\"testnamespace\",\n project=\"default\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var namespaceDemo = new Volcenginecc.Cr.NameSpace(\"NamespaceDemo\", new()\n {\n Registry = \"test\",\n Name = \"testnamespace\",\n Project = \"default\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cr\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cr.NewNameSpace(ctx, \"NamespaceDemo\", \u0026cr.NameSpaceArgs{\n\t\t\tRegistry: pulumi.String(\"test\"),\n\t\t\tName: pulumi.String(\"testnamespace\"),\n\t\t\tProject: pulumi.String(\"default\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cr.NameSpace;\nimport com.volcengine.volcenginecc.cr.NameSpaceArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var namespaceDemo = new NameSpace(\"namespaceDemo\", NameSpaceArgs.builder()\n .registry(\"test\")\n .name(\"testnamespace\")\n .project(\"default\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n namespaceDemo:\n type: volcenginecc:cr:NameSpace\n name: NamespaceDemo\n properties:\n registry: test\n name: testnamespace\n project: default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cr/nameSpace:NameSpace example \"registry|name\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Namespace creation time.\n" }, "name": { "type": "string", "description": "Namespace name. Supports lowercase English letters, numbers, periods (.), hyphens (-), and underscores (_). Punctuation cannot appear at the beginning or end, nor be used consecutively. Length must be between 2 and 90 characters. Standard edition instance: The name must be unique within the same image repository instance. Trial edition instance: The namespace name must be unique across all accounts within the same region. If the namespace name you set is already taken, try another name or purchase a standard edition instance.\n" }, "project": { "type": "string", "description": "Name of the project to which the namespace belongs. This parameter is case-sensitive and must not exceed 64 characters. If the parameter is empty, the namespace is associated with the default project.\n" }, "registry": { "type": "string", "description": "Specify the image repository instance name. Obtain it via ListRegistries or from the instance list page in the image repository console.\n" } }, "required": [ "createdTime", "name", "project", "registry" ], "inputProperties": { "name": { "type": "string", "description": "Namespace name. Supports lowercase English letters, numbers, periods (.), hyphens (-), and underscores (_). Punctuation cannot appear at the beginning or end, nor be used consecutively. Length must be between 2 and 90 characters. Standard edition instance: The name must be unique within the same image repository instance. Trial edition instance: The namespace name must be unique across all accounts within the same region. If the namespace name you set is already taken, try another name or purchase a standard edition instance.\n" }, "project": { "type": "string", "description": "Name of the project to which the namespace belongs. This parameter is case-sensitive and must not exceed 64 characters. If the parameter is empty, the namespace is associated with the default project.\n" }, "registry": { "type": "string", "description": "Specify the image repository instance name. Obtain it via ListRegistries or from the instance list page in the image repository console.\n" } }, "requiredInputs": [ "name", "registry" ], "stateInputs": { "description": "Input properties used for looking up and filtering NameSpace resources.\n", "properties": { "createdTime": { "type": "string", "description": "Namespace creation time.\n" }, "name": { "type": "string", "description": "Namespace name. Supports lowercase English letters, numbers, periods (.), hyphens (-), and underscores (_). Punctuation cannot appear at the beginning or end, nor be used consecutively. Length must be between 2 and 90 characters. Standard edition instance: The name must be unique within the same image repository instance. Trial edition instance: The namespace name must be unique across all accounts within the same region. If the namespace name you set is already taken, try another name or purchase a standard edition instance.\n" }, "project": { "type": "string", "description": "Name of the project to which the namespace belongs. This parameter is case-sensitive and must not exceed 64 characters. If the parameter is empty, the namespace is associated with the default project.\n" }, "registry": { "type": "string", "description": "Specify the image repository instance name. Obtain it via ListRegistries or from the instance list page in the image repository console.\n" } }, "type": "object" } }, "volcenginecc:cr/registry:Registry": { "description": "Container Registry (CR) provides secure, highly available hosting for container images, Helm Charts, and other OCI-compliant cloud-native artifacts, making it easy for enterprise users to manage the full lifecycle of container images and Helm Charts.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst cRRegistryDemo = new volcenginecc.cr.Registry(\"CRRegistryDemo\", {\n project: \"default\",\n name: \"test\",\n type: \"Enterprise\",\n endpoint: {\n enabled: true,\n },\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nc_r_registry_demo = volcenginecc.cr.Registry(\"CRRegistryDemo\",\n project=\"default\",\n name=\"test\",\n type=\"Enterprise\",\n endpoint={\n \"enabled\": True,\n },\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cRRegistryDemo = new Volcenginecc.Cr.Registry(\"CRRegistryDemo\", new()\n {\n Project = \"default\",\n Name = \"test\",\n Type = \"Enterprise\",\n Endpoint = new Volcenginecc.Cr.Inputs.RegistryEndpointArgs\n {\n Enabled = true,\n },\n Tags = new[]\n {\n new Volcenginecc.Cr.Inputs.RegistryTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cr\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cr.NewRegistry(ctx, \"CRRegistryDemo\", \u0026cr.RegistryArgs{\n\t\t\tProject: pulumi.String(\"default\"),\n\t\t\tName: pulumi.String(\"test\"),\n\t\t\tType: pulumi.String(\"Enterprise\"),\n\t\t\tEndpoint: \u0026cr.RegistryEndpointArgs{\n\t\t\t\tEnabled: pulumi.Bool(true),\n\t\t\t},\n\t\t\tTags: cr.RegistryTagArray{\n\t\t\t\t\u0026cr.RegistryTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cr.Registry;\nimport com.volcengine.volcenginecc.cr.RegistryArgs;\nimport com.pulumi.volcenginecc.cr.inputs.RegistryEndpointArgs;\nimport com.pulumi.volcenginecc.cr.inputs.RegistryTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cRRegistryDemo = new Registry(\"cRRegistryDemo\", RegistryArgs.builder()\n .project(\"default\")\n .name(\"test\")\n .type(\"Enterprise\")\n .endpoint(RegistryEndpointArgs.builder()\n .enabled(true)\n .build())\n .tags(RegistryTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cRRegistryDemo:\n type: volcenginecc:cr:Registry\n name: CRRegistryDemo\n properties:\n project: default\n name: test\n type: Enterprise\n endpoint:\n enabled: true\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cr/registry:Registry example \"name\"\n```\n\n", "properties": { "chargeType": { "type": "string", "description": "Container registry instance billing type. Currently, only the PostCharge pay-as-you-go mode is supported.\n" }, "createdTime": { "type": "string", "description": "Time when the container registry instance was created.\n" }, "endpoint": { "$ref": "#/types/volcenginecc:cr/RegistryEndpoint:RegistryEndpoint", "description": "Public endpoint information for the image repository instance\n" }, "expireTime": { "type": "string", "description": "Only applicable when the billing type is HybridCharge. Instance expiration time\n" }, "name": { "type": "string", "description": "Standard Edition instance name. Names must be unique within the same region. Supports lowercase English letters, numbers, and hyphens (-). Numbers cannot be the first character, and hyphens (-) cannot be the first or last character. Length must be between 3 and 30 characters.\n" }, "project": { "type": "string", "description": "Specify the project to associate with the instance. Each instance can only be associated with one project\n" }, "proxyCache": { "$ref": "#/types/volcenginecc:cr/RegistryProxyCache:RegistryProxyCache", "description": "ProxyCache configuration. Required when set to ProxyCache\n" }, "proxyCacheEnabled": { "type": "boolean", "description": "Whether to set as ProxyCache instance\n" }, "renewType": { "type": "string", "description": "Only applicable when the billing type is HybridCharge. Instance auto-renewal type\n" }, "status": { "$ref": "#/types/volcenginecc:cr/RegistryStatus:RegistryStatus", "description": "Container registry instance status, composed of Phase and Conditions. Valid Phase and Conditions combinations are as follows: {Creating, [Progressing]}: Creating, {Running, [Ok]}: Running, {Running, [Degraded]}: Running, {Stopped, [Balance]}: Suspended due to overdue payment, {Stopped, [Released]}: Pending recycle, {Stopped, [Released, Balance]}: Suspended due to overdue payment, {Starting, [Progressing]}: Starting, {Deleting, [Progressing]}: Deleting, {Failed, [Unknown]}: Error\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cr/RegistryTag:RegistryTag" } }, "type": { "type": "string", "description": "If not specified, a Standard Edition instance will be created by default. Enterprise: Standard Edition, Micro: Micro Edition\n" } }, "required": [ "chargeType", "createdTime", "endpoint", "expireTime", "name", "project", "proxyCache", "proxyCacheEnabled", "renewType", "status", "tags", "type" ], "inputProperties": { "endpoint": { "$ref": "#/types/volcenginecc:cr/RegistryEndpoint:RegistryEndpoint", "description": "Public endpoint information for the image repository instance\n" }, "name": { "type": "string", "description": "Standard Edition instance name. Names must be unique within the same region. Supports lowercase English letters, numbers, and hyphens (-). Numbers cannot be the first character, and hyphens (-) cannot be the first or last character. Length must be between 3 and 30 characters.\n" }, "project": { "type": "string", "description": "Specify the project to associate with the instance. Each instance can only be associated with one project\n" }, "status": { "$ref": "#/types/volcenginecc:cr/RegistryStatus:RegistryStatus", "description": "Container registry instance status, composed of Phase and Conditions. Valid Phase and Conditions combinations are as follows: {Creating, [Progressing]}: Creating, {Running, [Ok]}: Running, {Running, [Degraded]}: Running, {Stopped, [Balance]}: Suspended due to overdue payment, {Stopped, [Released]}: Pending recycle, {Stopped, [Released, Balance]}: Suspended due to overdue payment, {Starting, [Progressing]}: Starting, {Deleting, [Progressing]}: Deleting, {Failed, [Unknown]}: Error\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cr/RegistryTag:RegistryTag" } }, "type": { "type": "string", "description": "If not specified, a Standard Edition instance will be created by default. Enterprise: Standard Edition, Micro: Micro Edition\n" } }, "requiredInputs": [ "name" ], "stateInputs": { "description": "Input properties used for looking up and filtering Registry resources.\n", "properties": { "chargeType": { "type": "string", "description": "Container registry instance billing type. Currently, only the PostCharge pay-as-you-go mode is supported.\n" }, "createdTime": { "type": "string", "description": "Time when the container registry instance was created.\n" }, "endpoint": { "$ref": "#/types/volcenginecc:cr/RegistryEndpoint:RegistryEndpoint", "description": "Public endpoint information for the image repository instance\n" }, "expireTime": { "type": "string", "description": "Only applicable when the billing type is HybridCharge. Instance expiration time\n" }, "name": { "type": "string", "description": "Standard Edition instance name. Names must be unique within the same region. Supports lowercase English letters, numbers, and hyphens (-). Numbers cannot be the first character, and hyphens (-) cannot be the first or last character. Length must be between 3 and 30 characters.\n" }, "project": { "type": "string", "description": "Specify the project to associate with the instance. Each instance can only be associated with one project\n" }, "proxyCache": { "$ref": "#/types/volcenginecc:cr/RegistryProxyCache:RegistryProxyCache", "description": "ProxyCache configuration. Required when set to ProxyCache\n" }, "proxyCacheEnabled": { "type": "boolean", "description": "Whether to set as ProxyCache instance\n" }, "renewType": { "type": "string", "description": "Only applicable when the billing type is HybridCharge. Instance auto-renewal type\n" }, "status": { "$ref": "#/types/volcenginecc:cr/RegistryStatus:RegistryStatus", "description": "Container registry instance status, composed of Phase and Conditions. Valid Phase and Conditions combinations are as follows: {Creating, [Progressing]}: Creating, {Running, [Ok]}: Running, {Running, [Degraded]}: Running, {Stopped, [Balance]}: Suspended due to overdue payment, {Stopped, [Released]}: Pending recycle, {Stopped, [Released, Balance]}: Suspended due to overdue payment, {Starting, [Progressing]}: Starting, {Deleting, [Progressing]}: Deleting, {Failed, [Unknown]}: Error\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:cr/RegistryTag:RegistryTag" } }, "type": { "type": "string", "description": "If not specified, a Standard Edition instance will be created by default. Enterprise: Standard Edition, Micro: Micro Edition\n" } }, "type": "object" } }, "volcenginecc:cr/repository:Repository": { "description": "The OCI artifact repository is used to store container images, Helm Charts, and other OCI (Open Container Initiative) artifacts that comply with open container standards.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst repositoryDemo = new volcenginecc.cr.Repository(\"RepositoryDemo\", {\n registry: \"test\",\n namespace: \"default\",\n name: \"RepositoryDemo\",\n description: \"RepositoryDemo description\",\n accessLevel: \"Public\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nrepository_demo = volcenginecc.cr.Repository(\"RepositoryDemo\",\n registry=\"test\",\n namespace=\"default\",\n name=\"RepositoryDemo\",\n description=\"RepositoryDemo description\",\n access_level=\"Public\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var repositoryDemo = new Volcenginecc.Cr.Repository(\"RepositoryDemo\", new()\n {\n Registry = \"test\",\n Namespace = \"default\",\n Name = \"RepositoryDemo\",\n Description = \"RepositoryDemo description\",\n AccessLevel = \"Public\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/cr\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := cr.NewRepository(ctx, \"RepositoryDemo\", \u0026cr.RepositoryArgs{\n\t\t\tRegistry: pulumi.String(\"test\"),\n\t\t\tNamespace: pulumi.String(\"default\"),\n\t\t\tName: pulumi.String(\"RepositoryDemo\"),\n\t\t\tDescription: pulumi.String(\"RepositoryDemo description\"),\n\t\t\tAccessLevel: pulumi.String(\"Public\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.cr.Repository;\nimport com.volcengine.volcenginecc.cr.RepositoryArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var repositoryDemo = new Repository(\"repositoryDemo\", RepositoryArgs.builder()\n .registry(\"test\")\n .namespace(\"default\")\n .name(\"RepositoryDemo\")\n .description(\"RepositoryDemo description\")\n .accessLevel(\"Public\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n repositoryDemo:\n type: volcenginecc:cr:Repository\n name: RepositoryDemo\n properties:\n registry: test\n namespace: default\n name: RepositoryDemo\n description: RepositoryDemo description\n accessLevel: Public\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:cr/repository:Repository example \"registry|namespace|name\"\n```\n\n", "properties": { "accessLevel": { "type": "string", "description": "Access level. Values include: Private: Private OCI artifact repository, accessible only to authorized users. Public: Public OCI artifact repository, accessible to all users. You can specify one or more access levels in a single entry.\n" }, "createTime": { "type": "string", "description": "Creation time of the OCI artifact repository. RFC3339 format, UTC+0 time.\n" }, "description": { "type": "string", "description": "Image repository description, with a length of 0–300 UTF-8 characters.\n" }, "name": { "type": "string", "description": "OCI artifact repository name. The name must be unique within the same namespace. Supports lowercase English letters, numbers, and delimiters (delimiters can be a single '.' or '/', one or more '-', or one or two '_'. Delimiters cannot appear at the beginning or end of the name, nor can they appear consecutively). Length must be between 1 and 128 characters.\n" }, "namespace": { "type": "string", "description": "Target namespace name. Obtain the namespace name from the Namespace page of the target instance in the Image Repository Console.\n" }, "registry": { "type": "string", "description": "Specify the name of the image repository instance to which the namespace belongs. Obtain the instance name from the Instance List page in the Image Repository Console.\n" }, "updateTime": { "type": "string", "description": "Last updated time for the OCI artifact repository. RFC3339 format, UTC+0 time.\n" } }, "required": [ "accessLevel", "createTime", "description", "name", "namespace", "registry", "updateTime" ], "inputProperties": { "accessLevel": { "type": "string", "description": "Access level. Values include: Private: Private OCI artifact repository, accessible only to authorized users. Public: Public OCI artifact repository, accessible to all users. You can specify one or more access levels in a single entry.\n" }, "description": { "type": "string", "description": "Image repository description, with a length of 0–300 UTF-8 characters.\n" }, "name": { "type": "string", "description": "OCI artifact repository name. The name must be unique within the same namespace. Supports lowercase English letters, numbers, and delimiters (delimiters can be a single '.' or '/', one or more '-', or one or two '_'. Delimiters cannot appear at the beginning or end of the name, nor can they appear consecutively). Length must be between 1 and 128 characters.\n" }, "namespace": { "type": "string", "description": "Target namespace name. Obtain the namespace name from the Namespace page of the target instance in the Image Repository Console.\n" }, "registry": { "type": "string", "description": "Specify the name of the image repository instance to which the namespace belongs. Obtain the instance name from the Instance List page in the Image Repository Console.\n" } }, "requiredInputs": [ "name", "namespace", "registry" ], "stateInputs": { "description": "Input properties used for looking up and filtering Repository resources.\n", "properties": { "accessLevel": { "type": "string", "description": "Access level. Values include: Private: Private OCI artifact repository, accessible only to authorized users. Public: Public OCI artifact repository, accessible to all users. You can specify one or more access levels in a single entry.\n" }, "createTime": { "type": "string", "description": "Creation time of the OCI artifact repository. RFC3339 format, UTC+0 time.\n" }, "description": { "type": "string", "description": "Image repository description, with a length of 0–300 UTF-8 characters.\n" }, "name": { "type": "string", "description": "OCI artifact repository name. The name must be unique within the same namespace. Supports lowercase English letters, numbers, and delimiters (delimiters can be a single '.' or '/', one or more '-', or one or two '_'. Delimiters cannot appear at the beginning or end of the name, nor can they appear consecutively). Length must be between 1 and 128 characters.\n" }, "namespace": { "type": "string", "description": "Target namespace name. Obtain the namespace name from the Namespace page of the target instance in the Image Repository Console.\n" }, "registry": { "type": "string", "description": "Specify the name of the image repository instance to which the namespace belongs. Obtain the instance name from the Instance List page in the Image Repository Console.\n" }, "updateTime": { "type": "string", "description": "Last updated time for the OCI artifact repository. RFC3339 format, UTC+0 time.\n" } }, "type": "object" } }, "volcenginecc:directconnect/directConnectGateway:DirectConnectGateway": { "description": "The Direct Connect Gateway is the entry point for local data centers to access the cloud. It connects private networks (VPC) and physical dedicated connections, enabling mutual access between on-premises data centers (IDC) and cloud private networks (VPC).\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst directConnectDirectConnectGatewayDemo = new volcenginecc.directconnect.DirectConnectGateway(\"DirectConnectDirectConnectGatewayDemo\", {\n description: \"DirectConnectDirectConnectGatewayDemo-Description\",\n directConnectGatewayName: \"DirectConnectDirectConnectGatewayDemo\",\n enableIpv6: false,\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ndirect_connect_direct_connect_gateway_demo = volcenginecc.directconnect.DirectConnectGateway(\"DirectConnectDirectConnectGatewayDemo\",\n description=\"DirectConnectDirectConnectGatewayDemo-Description\",\n direct_connect_gateway_name=\"DirectConnectDirectConnectGatewayDemo\",\n enable_ipv6=False,\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var directConnectDirectConnectGatewayDemo = new Volcenginecc.Directconnect.DirectConnectGateway(\"DirectConnectDirectConnectGatewayDemo\", new()\n {\n Description = \"DirectConnectDirectConnectGatewayDemo-Description\",\n DirectConnectGatewayName = \"DirectConnectDirectConnectGatewayDemo\",\n EnableIpv6 = false,\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Directconnect.Inputs.DirectConnectGatewayTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/directconnect\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := directconnect.NewDirectConnectGateway(ctx, \"DirectConnectDirectConnectGatewayDemo\", \u0026directconnect.DirectConnectGatewayArgs{\n\t\t\tDescription: pulumi.String(\"DirectConnectDirectConnectGatewayDemo-Description\"),\n\t\t\tDirectConnectGatewayName: pulumi.String(\"DirectConnectDirectConnectGatewayDemo\"),\n\t\t\tEnableIpv6: pulumi.Bool(false),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: directconnect.DirectConnectGatewayTagArray{\n\t\t\t\t\u0026directconnect.DirectConnectGatewayTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.directconnect.DirectConnectGateway;\nimport com.volcengine.volcenginecc.directconnect.DirectConnectGatewayArgs;\nimport com.pulumi.volcenginecc.directconnect.inputs.DirectConnectGatewayTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var directConnectDirectConnectGatewayDemo = new DirectConnectGateway(\"directConnectDirectConnectGatewayDemo\", DirectConnectGatewayArgs.builder()\n .description(\"DirectConnectDirectConnectGatewayDemo-Description\")\n .directConnectGatewayName(\"DirectConnectDirectConnectGatewayDemo\")\n .enableIpv6(false)\n .projectName(\"default\")\n .tags(DirectConnectGatewayTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n directConnectDirectConnectGatewayDemo:\n type: volcenginecc:directconnect:DirectConnectGateway\n name: DirectConnectDirectConnectGatewayDemo\n properties:\n description: DirectConnectDirectConnectGatewayDemo-Description\n directConnectGatewayName: DirectConnectDirectConnectGatewayDemo\n enableIpv6: false\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:directconnect/directConnectGateway:DirectConnectGateway example \"direct_connect_gateway_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the Direct Connect Gateway belongs.\n" }, "associateCens": { "type": "array", "items": { "$ref": "#/types/volcenginecc:directconnect/DirectConnectGatewayAssociateCen:DirectConnectGatewayAssociateCen" } }, "associateEic": { "$ref": "#/types/volcenginecc:directconnect/DirectConnectGatewayAssociateEic:DirectConnectGatewayAssociateEic", "description": "Associated EIC information.\n" }, "bgpAsn": { "type": "integer", "description": "ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.\n" }, "businessStatus": { "type": "string", "description": "Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.\n" }, "createdTime": { "type": "string", "description": "Time when the Direct Connect Gateway was created.\n" }, "deletedTime": { "type": "string", "description": "Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.\n" }, "description": { "type": "string", "description": "Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.\n" }, "directConnectGatewayId": { "type": "string", "description": "ID of the Direct Connect Gateway.\n" }, "directConnectGatewayName": { "type": "string", "description": "Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.\n" }, "enableIpv6": { "type": "boolean", "description": "Whether IPv6 is supported. true: supported. false: not supported.\n" }, "lockReason": { "type": "string", "description": "Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.\n" }, "projectName": { "type": "string", "description": "Project to which the Direct Connect Gateway belongs.\n" }, "status": { "type": "string", "description": "Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:directconnect/DirectConnectGatewayTag:DirectConnectGatewayTag" } }, "updatedTime": { "type": "string", "description": "Time when the Direct Connect Gateway was updated.\n" } }, "required": [ "accountId", "associateCens", "associateEic", "bgpAsn", "businessStatus", "createdTime", "deletedTime", "description", "directConnectGatewayId", "directConnectGatewayName", "enableIpv6", "lockReason", "overdueTime", "projectName", "status", "tags", "updatedTime" ], "inputProperties": { "bgpAsn": { "type": "integer", "description": "ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.\n" }, "description": { "type": "string", "description": "Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.\n" }, "directConnectGatewayName": { "type": "string", "description": "Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.\n" }, "enableIpv6": { "type": "boolean", "description": "Whether IPv6 is supported. true: supported. false: not supported.\n" }, "projectName": { "type": "string", "description": "Project to which the Direct Connect Gateway belongs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:directconnect/DirectConnectGatewayTag:DirectConnectGatewayTag" } } }, "stateInputs": { "description": "Input properties used for looking up and filtering DirectConnectGateway resources.\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the Direct Connect Gateway belongs.\n" }, "associateCens": { "type": "array", "items": { "$ref": "#/types/volcenginecc:directconnect/DirectConnectGatewayAssociateCen:DirectConnectGatewayAssociateCen" } }, "associateEic": { "$ref": "#/types/volcenginecc:directconnect/DirectConnectGatewayAssociateEic:DirectConnectGatewayAssociateEic", "description": "Associated EIC information.\n" }, "bgpAsn": { "type": "integer", "description": "ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.\n" }, "businessStatus": { "type": "string", "description": "Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.\n" }, "createdTime": { "type": "string", "description": "Time when the Direct Connect Gateway was created.\n" }, "deletedTime": { "type": "string", "description": "Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.\n" }, "description": { "type": "string", "description": "Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.\n" }, "directConnectGatewayId": { "type": "string", "description": "ID of the Direct Connect Gateway.\n" }, "directConnectGatewayName": { "type": "string", "description": "Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.\n" }, "enableIpv6": { "type": "boolean", "description": "Whether IPv6 is supported. true: supported. false: not supported.\n" }, "lockReason": { "type": "string", "description": "Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.\n" }, "projectName": { "type": "string", "description": "Project to which the Direct Connect Gateway belongs.\n" }, "status": { "type": "string", "description": "Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:directconnect/DirectConnectGatewayTag:DirectConnectGatewayTag" } }, "updatedTime": { "type": "string", "description": "Time when the Direct Connect Gateway was updated.\n" } }, "type": "object" } }, "volcenginecc:dns/zone:Zone": { "description": "The zone in the resource is the domain name, which can be a primary domain such as example.com or a subdomain such as abc.example.com\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst dnsZoneDemo = new volcenginecc.dns.Zone(\"DnsZoneDemo\", {\n zoneName: \"DnsZoneDemo\",\n remark: \"test\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ndns_zone_demo = volcenginecc.dns.Zone(\"DnsZoneDemo\",\n zone_name=\"DnsZoneDemo\",\n remark=\"test\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var dnsZoneDemo = new Volcenginecc.Dns.Zone(\"DnsZoneDemo\", new()\n {\n ZoneName = \"DnsZoneDemo\",\n Remark = \"test\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Dns.Inputs.ZoneTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/dns\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := dns.NewZone(ctx, \"DnsZoneDemo\", \u0026dns.ZoneArgs{\n\t\t\tZoneName: pulumi.String(\"DnsZoneDemo\"),\n\t\t\tRemark: pulumi.String(\"test\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: dns.ZoneTagArray{\n\t\t\t\t\u0026dns.ZoneTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.dns.Zone;\nimport com.volcengine.volcenginecc.dns.ZoneArgs;\nimport com.pulumi.volcenginecc.dns.inputs.ZoneTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var dnsZoneDemo = new Zone(\"dnsZoneDemo\", ZoneArgs.builder()\n .zoneName(\"DnsZoneDemo\")\n .remark(\"test\")\n .projectName(\"default\")\n .tags(ZoneTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n dnsZoneDemo:\n type: volcenginecc:dns:Zone\n name: DnsZoneDemo\n properties:\n zoneName: DnsZoneDemo\n remark: test\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:dns/zone:Zone example \"zid\"\n```\n\n", "properties": { "allocateDnsServerLists": { "type": "array", "items": { "type": "string" }, "description": "List of DNS servers assigned to the domain by Cloud DNS\n" }, "autoRenew": { "type": "boolean", "description": "Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.\n" }, "cacheStage": { "type": "integer", "description": "Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.\n" }, "createdTime": { "type": "string", "description": "Domain creation time.\n" }, "dnsSecurity": { "type": "string", "description": "Version of DNS DDoS protection service. dns*security*standard_inner: Standard protection edition. \"\": No protection edition.\n" }, "expiredTime": { "type": "integer", "description": "Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.\n" }, "instanceId": { "type": "string", "description": "Instance ID. For Cloud DNS Free Edition, this field is null.\n" }, "instanceNo": { "type": "string", "description": "Instance ID. For Cloud DNS Free Edition, this field is null.\n" }, "isNsCorrect": { "type": "boolean", "description": "Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.\n" }, "isSubDomain": { "type": "boolean", "description": "Whether it is a subdomain. true: Subdomain. false: Primary domain.\n" }, "lastOperator": { "type": "string", "description": "ID of the account that created the domain.\n" }, "projectName": { "type": "string", "description": "Domain project.\n" }, "realDnsServerLists": { "type": "array", "items": { "type": "string" }, "description": "List of DNS servers actually used by the domain.\n" }, "recordCount": { "type": "integer", "description": "Total number of DNS records contained in the domain.\n" }, "remark": { "type": "string", "description": "Domain notes\n" }, "stage": { "type": "integer", "description": "Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.\n" }, "subDomainHost": { "type": "string", "description": "Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:dns/ZoneTag:ZoneTag" } }, "tradeCode": { "type": "string", "description": "Domain feature version. This parameter has the following values: free*inner: Free Edition; professional*inner: Professional Edition; enterprise*inner: Enterprise Edition; ultimate*inner: Flagship Edition; ultimate*exclusive*inner: Premium Edition.\n" }, "updatedTime": { "type": "string", "description": "Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.\n" }, "zid": { "type": "string", "description": "Domain ID.\n" }, "zoneName": { "type": "string", "description": "Domain name.\n" } }, "required": [ "allocateDnsServerLists", "autoRenew", "cacheStage", "createdTime", "dnsSecurity", "expiredTime", "instanceId", "instanceNo", "isNsCorrect", "isSubDomain", "lastOperator", "projectName", "realDnsServerLists", "recordCount", "remark", "stage", "subDomainHost", "tags", "tradeCode", "updatedTime", "zid", "zoneName" ], "inputProperties": { "projectName": { "type": "string", "description": "Domain project.\n" }, "remark": { "type": "string", "description": "Domain notes\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:dns/ZoneTag:ZoneTag" } }, "zoneName": { "type": "string", "description": "Domain name.\n" } }, "requiredInputs": [ "zoneName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Zone resources.\n", "properties": { "allocateDnsServerLists": { "type": "array", "items": { "type": "string" }, "description": "List of DNS servers assigned to the domain by Cloud DNS\n" }, "autoRenew": { "type": "boolean", "description": "Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.\n" }, "cacheStage": { "type": "integer", "description": "Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.\n" }, "createdTime": { "type": "string", "description": "Domain creation time.\n" }, "dnsSecurity": { "type": "string", "description": "Version of DNS DDoS protection service. dns*security*standard_inner: Standard protection edition. \"\": No protection edition.\n" }, "expiredTime": { "type": "integer", "description": "Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.\n" }, "instanceId": { "type": "string", "description": "Instance ID. For Cloud DNS Free Edition, this field is null.\n" }, "instanceNo": { "type": "string", "description": "Instance ID. For Cloud DNS Free Edition, this field is null.\n" }, "isNsCorrect": { "type": "boolean", "description": "Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.\n" }, "isSubDomain": { "type": "boolean", "description": "Whether it is a subdomain. true: Subdomain. false: Primary domain.\n" }, "lastOperator": { "type": "string", "description": "ID of the account that created the domain.\n" }, "projectName": { "type": "string", "description": "Domain project.\n" }, "realDnsServerLists": { "type": "array", "items": { "type": "string" }, "description": "List of DNS servers actually used by the domain.\n" }, "recordCount": { "type": "integer", "description": "Total number of DNS records contained in the domain.\n" }, "remark": { "type": "string", "description": "Domain notes\n" }, "stage": { "type": "integer", "description": "Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.\n" }, "subDomainHost": { "type": "string", "description": "Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:dns/ZoneTag:ZoneTag" } }, "tradeCode": { "type": "string", "description": "Domain feature version. This parameter has the following values: free*inner: Free Edition; professional*inner: Professional Edition; enterprise*inner: Enterprise Edition; ultimate*inner: Flagship Edition; ultimate*exclusive*inner: Premium Edition.\n" }, "updatedTime": { "type": "string", "description": "Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.\n" }, "zid": { "type": "string", "description": "Domain ID.\n" }, "zoneName": { "type": "string", "description": "Domain name.\n" } }, "type": "object" } }, "volcenginecc:ecs/command:Command": { "description": "Custom commands are features provided by Cloud Assistant to meet your personalized O\u0026M needs. If the preset public commands do not meet your requirements, you can create custom commands and batch execute your custom commands on instances using O\u0026M tasks.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n commandDemo:\n type: volcenginecc:ecs:Command\n name: CommandDemo\n properties:\n commandContent: IyEvYmluL2Jhc2gKCm1rZGlyIHt7ZGxxxxx\n description: CommandDemo Example\n enableParameter: true\n name: commandtest\n parameterDefinitions:\n - type: Digit\n name: dirname\n required: true\n default_value: '10'\n min_length: 0\n max_length: 0\n min_value: '5'\n max_value: '100'\n decimal_precision: 0\n projectName: default\n tags:\n - key: env\n value: test\n timeout: 60\n type: Shell\n username: rxxxx\n workingDir: /home\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ecs/command:Command example \"command_id\"\n```\n\n", "properties": { "commandContent": { "type": "string", "description": "Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.\n" }, "commandId": { "type": "string", "description": "Custom command ID.\n" }, "contentEncoding": { "type": "string", "description": "Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.\n" }, "enableParameter": { "type": "boolean", "description": "Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.\n" }, "invocationTimes": { "type": "integer", "description": "Number of times the command has been invoked.\n" }, "name": { "type": "string", "description": "Command name. Character length: 1~32. No restriction on special characters.\n" }, "parameterDefinitions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/CommandParameterDefinition:CommandParameterDefinition" } }, "projectName": { "type": "string", "description": "Project to which the resource belongs. Each resource can belong to only one project.\n" }, "providerName": { "type": "string", "description": "Command provider.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/CommandTag:CommandTag" } }, "timeout": { "type": "integer", "description": "Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.\n" }, "type": { "type": "string", "description": "Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "username": { "type": "string", "description": "Username for executing the command.\n" }, "workingDir": { "type": "string", "description": "Directory where the created command runs on ECS instances.\n" } }, "required": [ "commandContent", "commandId", "contentEncoding", "createdTime", "description", "enableParameter", "invocationTimes", "name", "parameterDefinitions", "projectName", "providerName", "tags", "timeout", "type", "updatedTime", "username", "workingDir" ], "inputProperties": { "commandContent": { "type": "string", "description": "Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.\n" }, "contentEncoding": { "type": "string", "description": "Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.\n" }, "description": { "type": "string", "description": "Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.\n" }, "enableParameter": { "type": "boolean", "description": "Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.\n" }, "name": { "type": "string", "description": "Command name. Character length: 1~32. No restriction on special characters.\n" }, "parameterDefinitions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/CommandParameterDefinition:CommandParameterDefinition" } }, "projectName": { "type": "string", "description": "Project to which the resource belongs. Each resource can belong to only one project.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/CommandTag:CommandTag" } }, "timeout": { "type": "integer", "description": "Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.\n" }, "type": { "type": "string", "description": "Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.\n" }, "username": { "type": "string", "description": "Username for executing the command.\n" }, "workingDir": { "type": "string", "description": "Directory where the created command runs on ECS instances.\n" } }, "requiredInputs": [ "commandContent", "name", "type" ], "stateInputs": { "description": "Input properties used for looking up and filtering Command resources.\n", "properties": { "commandContent": { "type": "string", "description": "Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.\n" }, "commandId": { "type": "string", "description": "Custom command ID.\n" }, "contentEncoding": { "type": "string", "description": "Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.\n" }, "enableParameter": { "type": "boolean", "description": "Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.\n" }, "invocationTimes": { "type": "integer", "description": "Number of times the command has been invoked.\n" }, "name": { "type": "string", "description": "Command name. Character length: 1~32. No restriction on special characters.\n" }, "parameterDefinitions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/CommandParameterDefinition:CommandParameterDefinition" } }, "projectName": { "type": "string", "description": "Project to which the resource belongs. Each resource can belong to only one project.\n" }, "providerName": { "type": "string", "description": "Command provider.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/CommandTag:CommandTag" } }, "timeout": { "type": "integer", "description": "Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.\n" }, "type": { "type": "string", "description": "Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "username": { "type": "string", "description": "Username for executing the command.\n" }, "workingDir": { "type": "string", "description": "Directory where the created command runs on ECS instances.\n" } }, "type": "object" } }, "volcenginecc:ecs/deploymentSet:DeploymentSet": { "description": "A deployment set is a strategy that controls the distribution of instances at the underlying hardware level, enabling physical-level security isolation. By creating deployment sets, you can distribute instances across different underlying hardware to ensure disaster recovery and high availability for your business.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst ecsDeploymentSetDemo = new volcenginecc.ecs.DeploymentSet(\"EcsDeploymentSetDemo\", {\n description: \"this is a test DeploymentSet\",\n deploymentSetName: \"test-deployment-set\",\n granularity: \"host\",\n instanceIds: [\"i-yedvixxxxxva4izkjtl\"],\n deploymentSetGroupNumber: 1,\n strategy: \"Availability\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\necs_deployment_set_demo = volcenginecc.ecs.DeploymentSet(\"EcsDeploymentSetDemo\",\n description=\"this is a test DeploymentSet\",\n deployment_set_name=\"test-deployment-set\",\n granularity=\"host\",\n instance_ids=[\"i-yedvixxxxxva4izkjtl\"],\n deployment_set_group_number=1,\n strategy=\"Availability\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var ecsDeploymentSetDemo = new Volcenginecc.Ecs.DeploymentSet(\"EcsDeploymentSetDemo\", new()\n {\n Description = \"this is a test DeploymentSet\",\n DeploymentSetName = \"test-deployment-set\",\n Granularity = \"host\",\n InstanceIds = new[]\n {\n \"i-yedvixxxxxva4izkjtl\",\n },\n DeploymentSetGroupNumber = 1,\n Strategy = \"Availability\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/ecs\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ecs.NewDeploymentSet(ctx, \"EcsDeploymentSetDemo\", \u0026ecs.DeploymentSetArgs{\n\t\t\tDescription: pulumi.String(\"this is a test DeploymentSet\"),\n\t\t\tDeploymentSetName: pulumi.String(\"test-deployment-set\"),\n\t\t\tGranularity: pulumi.String(\"host\"),\n\t\t\tInstanceIds: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"i-yedvixxxxxva4izkjtl\"),\n\t\t\t},\n\t\t\tDeploymentSetGroupNumber: pulumi.Int(1),\n\t\t\tStrategy: pulumi.String(\"Availability\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.ecs.DeploymentSet;\nimport com.volcengine.volcenginecc.ecs.DeploymentSetArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var ecsDeploymentSetDemo = new DeploymentSet(\"ecsDeploymentSetDemo\", DeploymentSetArgs.builder()\n .description(\"this is a test DeploymentSet\")\n .deploymentSetName(\"test-deployment-set\")\n .granularity(\"host\")\n .instanceIds(\"i-yedvixxxxxva4izkjtl\")\n .deploymentSetGroupNumber(1)\n .strategy(\"Availability\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n ecsDeploymentSetDemo:\n type: volcenginecc:ecs:DeploymentSet\n name: EcsDeploymentSetDemo\n properties:\n description: this is a test DeploymentSet\n deploymentSetName: test-deployment-set\n granularity: host\n instanceIds:\n - i-yedvixxxxxva4izkjtl\n deploymentSetGroupNumber: 1\n strategy: Availability\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ecs/deploymentSet:DeploymentSet example \"deployment_set_id\"\n```\n\n", "properties": { "capacities": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/DeploymentSetCapacity:DeploymentSetCapacity" } }, "createdAt": { "type": "string", "description": "Deployment set creation time.\n" }, "deploymentSetGroupNumber": { "type": "integer", "description": "Deployment set group index. Value range: 1–7.\n" }, "deploymentSetId": { "type": "string", "description": "Deployment set ID.\n" }, "deploymentSetName": { "type": "string", "description": "Deployment set name. Cannot start with a digit, hyphen, or underscore. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length limit: 1–128 characters.\n" }, "description": { "type": "string", "description": "Deployment set description. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, digits, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。'. Length limit: within 255 characters.\n" }, "granularity": { "type": "string", "description": "Deployment granularity. Options: host: physical machine. rack: rack. switch: switch.\n" }, "groupCount": { "type": "integer", "description": "Number of deployment set groups. Set the group count for the deployment set group high availability policy. Value range: 1–7. Default: 7.\n" }, "instanceAmount": { "type": "integer", "description": "Number of ECS instances in the deployment set.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "List of ECS instance IDs in the deployment set.\n" }, "strategy": { "type": "string", "description": "Deployment policy. Options: Availability (default): high availability policy. AvailabilityGroup: deployment set group high availability policy.\n" } }, "required": [ "capacities", "createdAt", "deploymentSetGroupNumber", "deploymentSetId", "deploymentSetName", "description", "granularity", "groupCount", "instanceAmount", "instanceIds", "strategy" ], "inputProperties": { "deploymentSetGroupNumber": { "type": "integer", "description": "Deployment set group index. Value range: 1–7.\n" }, "deploymentSetName": { "type": "string", "description": "Deployment set name. Cannot start with a digit, hyphen, or underscore. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length limit: 1–128 characters.\n" }, "description": { "type": "string", "description": "Deployment set description. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, digits, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。'. Length limit: within 255 characters.\n" }, "granularity": { "type": "string", "description": "Deployment granularity. Options: host: physical machine. rack: rack. switch: switch.\n" }, "groupCount": { "type": "integer", "description": "Number of deployment set groups. Set the group count for the deployment set group high availability policy. Value range: 1–7. Default: 7.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "List of ECS instance IDs in the deployment set.\n" }, "strategy": { "type": "string", "description": "Deployment policy. Options: Availability (default): high availability policy. AvailabilityGroup: deployment set group high availability policy.\n" } }, "requiredInputs": [ "deploymentSetName" ], "stateInputs": { "description": "Input properties used for looking up and filtering DeploymentSet resources.\n", "properties": { "capacities": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/DeploymentSetCapacity:DeploymentSetCapacity" } }, "createdAt": { "type": "string", "description": "Deployment set creation time.\n" }, "deploymentSetGroupNumber": { "type": "integer", "description": "Deployment set group index. Value range: 1–7.\n" }, "deploymentSetId": { "type": "string", "description": "Deployment set ID.\n" }, "deploymentSetName": { "type": "string", "description": "Deployment set name. Cannot start with a digit, hyphen, or underscore. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length limit: 1–128 characters.\n" }, "description": { "type": "string", "description": "Deployment set description. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, digits, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。'. Length limit: within 255 characters.\n" }, "granularity": { "type": "string", "description": "Deployment granularity. Options: host: physical machine. rack: rack. switch: switch.\n" }, "groupCount": { "type": "integer", "description": "Number of deployment set groups. Set the group count for the deployment set group high availability policy. Value range: 1–7. Default: 7.\n" }, "instanceAmount": { "type": "integer", "description": "Number of ECS instances in the deployment set.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "List of ECS instance IDs in the deployment set.\n" }, "strategy": { "type": "string", "description": "Deployment policy. Options: Availability (default): high availability policy. AvailabilityGroup: deployment set group high availability policy.\n" } }, "type": "object" } }, "volcenginecc:ecs/hpcCluster:HpcCluster": { "description": "A high performance compute cluster (HPC cluster) is a cluster computing environment designed for large-scale computational tasks. It typically consists of numerous compute nodes interconnected via RDMA (Remote Direct Memory Access) high-speed networks, working together to handle complex computational workloads. High performance compute clusters provide powerful computing capabilities, large memory, high-speed storage, and high-speed networking to meet the demands of compute-intensive, data-intensive, or combined workloads\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst eCSHpcClusterDemo = new volcenginecc.ecs.HpcCluster(\"ECSHpcClusterDemo\", {\n name: \"ECSHpcClusterDemo\",\n zoneId: \"cn-beijing-a\",\n description: \"ECSHpcClusterDemo description\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ne_cs_hpc_cluster_demo = volcenginecc.ecs.HpcCluster(\"ECSHpcClusterDemo\",\n name=\"ECSHpcClusterDemo\",\n zone_id=\"cn-beijing-a\",\n description=\"ECSHpcClusterDemo description\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var eCSHpcClusterDemo = new Volcenginecc.Ecs.HpcCluster(\"ECSHpcClusterDemo\", new()\n {\n Name = \"ECSHpcClusterDemo\",\n ZoneId = \"cn-beijing-a\",\n Description = \"ECSHpcClusterDemo description\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Ecs.Inputs.HpcClusterTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/ecs\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ecs.NewHpcCluster(ctx, \"ECSHpcClusterDemo\", \u0026ecs.HpcClusterArgs{\n\t\t\tName: pulumi.String(\"ECSHpcClusterDemo\"),\n\t\t\tZoneId: pulumi.String(\"cn-beijing-a\"),\n\t\t\tDescription: pulumi.String(\"ECSHpcClusterDemo description\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: ecs.HpcClusterTagArray{\n\t\t\t\t\u0026ecs.HpcClusterTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.ecs.HpcCluster;\nimport com.volcengine.volcenginecc.ecs.HpcClusterArgs;\nimport com.pulumi.volcenginecc.ecs.inputs.HpcClusterTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var eCSHpcClusterDemo = new HpcCluster(\"eCSHpcClusterDemo\", HpcClusterArgs.builder()\n .name(\"ECSHpcClusterDemo\")\n .zoneId(\"cn-beijing-a\")\n .description(\"ECSHpcClusterDemo description\")\n .projectName(\"default\")\n .tags(HpcClusterTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n eCSHpcClusterDemo:\n type: volcenginecc:ecs:HpcCluster\n name: ECSHpcClusterDemo\n properties:\n name: ECSHpcClusterDemo\n zoneId: cn-beijing-a\n description: ECSHpcClusterDemo description\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ecs/hpcCluster:HpcCluster example \"hpc_cluster_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time, formatted according to RFC3339\n" }, "description": { "type": "string", "description": "High performance compute cluster description. Defaults to an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length must be between 0 and 255 characters\n" }, "hpcClusterId": { "type": "string", "description": "High performance compute cluster ID\n" }, "name": { "type": "string", "description": "High performance compute cluster name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length must be between 1 and 128 characters\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/HpcClusterTag:HpcClusterTag" } }, "updatedTime": { "type": "string", "description": "Update time, formatted according to RFC3339\n" }, "vpcId": { "type": "string", "description": "Private network ID\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the high performance compute cluster\n" } }, "required": [ "createdTime", "description", "hpcClusterId", "name", "projectName", "tags", "updatedTime", "vpcId", "zoneId" ], "inputProperties": { "description": { "type": "string", "description": "High performance compute cluster description. Defaults to an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length must be between 0 and 255 characters\n" }, "name": { "type": "string", "description": "High performance compute cluster name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length must be between 1 and 128 characters\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/HpcClusterTag:HpcClusterTag" } }, "zoneId": { "type": "string", "description": "Availability zone ID of the high performance compute cluster\n" } }, "requiredInputs": [ "name", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering HpcCluster resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time, formatted according to RFC3339\n" }, "description": { "type": "string", "description": "High performance compute cluster description. Defaults to an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length must be between 0 and 255 characters\n" }, "hpcClusterId": { "type": "string", "description": "High performance compute cluster ID\n" }, "name": { "type": "string", "description": "High performance compute cluster name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length must be between 1 and 128 characters\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/HpcClusterTag:HpcClusterTag" } }, "updatedTime": { "type": "string", "description": "Update time, formatted according to RFC3339\n" }, "vpcId": { "type": "string", "description": "Private network ID\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the high performance compute cluster\n" } }, "type": "object" } }, "volcenginecc:ecs/image:Image": { "description": "An image is a special file containing the basic operating system and application data required for a cloud server instance. You must select an image when creating an instance.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst imageDemo = new volcenginecc.ecs.Image(\"ImageDemo\", {\n description: \"ImageDemo Example\",\n imageName: \"image-demo\",\n instanceId: \"i-ydzhj1el8gr9cxxdnxxxx\",\n projectName: \"default\",\n sharePermissions: [\"2000000***\"],\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nimage_demo = volcenginecc.ecs.Image(\"ImageDemo\",\n description=\"ImageDemo Example\",\n image_name=\"image-demo\",\n instance_id=\"i-ydzhj1el8gr9cxxdnxxxx\",\n project_name=\"default\",\n share_permissions=[\"2000000***\"],\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var imageDemo = new Volcenginecc.Ecs.Image(\"ImageDemo\", new()\n {\n Description = \"ImageDemo Example\",\n ImageName = \"image-demo\",\n InstanceId = \"i-ydzhj1el8gr9cxxdnxxxx\",\n ProjectName = \"default\",\n SharePermissions = new[]\n {\n \"2000000***\",\n },\n Tags = new[]\n {\n new Volcenginecc.Ecs.Inputs.ImageTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/ecs\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ecs.NewImage(ctx, \"ImageDemo\", \u0026ecs.ImageArgs{\n\t\t\tDescription: pulumi.String(\"ImageDemo Example\"),\n\t\t\tImageName: pulumi.String(\"image-demo\"),\n\t\t\tInstanceId: pulumi.String(\"i-ydzhj1el8gr9cxxdnxxxx\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tSharePermissions: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"2000000***\"),\n\t\t\t},\n\t\t\tTags: ecs.ImageTagArray{\n\t\t\t\t\u0026ecs.ImageTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.ecs.Image;\nimport com.volcengine.volcenginecc.ecs.ImageArgs;\nimport com.pulumi.volcenginecc.ecs.inputs.ImageTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var imageDemo = new Image(\"imageDemo\", ImageArgs.builder()\n .description(\"ImageDemo Example\")\n .imageName(\"image-demo\")\n .instanceId(\"i-ydzhj1el8gr9cxxdnxxxx\")\n .projectName(\"default\")\n .sharePermissions(\"2000000***\")\n .tags(ImageTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n imageDemo:\n type: volcenginecc:ecs:Image\n name: ImageDemo\n properties:\n description: ImageDemo Example\n imageName: image-demo\n instanceId: i-ydzhj1el8gr9cxxdnxxxx\n projectName: default\n sharePermissions:\n - 2000000***\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ecs/image:Image example \"image_id\"\n```\n\n", "properties": { "architecture": { "type": "string", "description": "Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).\n" }, "bootMode": { "type": "string", "description": "Image boot mode. You can select BIOS or UEFI\n" }, "createWholeImage": { "type": "boolean", "description": "Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.\n" }, "createdAt": { "type": "string", "description": "Image creation time\n" }, "description": { "type": "string", "description": "Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores \"_\", hyphens \"-\", equals signs \"=\", English commas \",\", English periods \".\", Chinese commas \"，\", Chinese periods \"。\", and spaces. Length: 0–255 characters. If left blank, defaults to empty.\n" }, "detectionResults": { "$ref": "#/types/volcenginecc:ecs/ImageDetectionResults:ImageDetectionResults", "description": "Image check result.\n" }, "imageId": { "type": "string", "description": "Image ID\n" }, "imageName": { "type": "string", "description": "Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores \"_\", hyphens \"-\", and periods \".\". Length: 1–128 characters\n" }, "imageOwnerId": { "type": "string", "description": "Account ID to which the image belongs.\n" }, "importImage": { "$ref": "#/types/volcenginecc:ecs/ImageImportImage:ImageImportImage", "description": "Imported image information\n" }, "instanceId": { "type": "string", "description": "Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.\n" }, "isInstallRunCommandAgent": { "type": "boolean", "description": "Whether Cloud Assistant Agent is installed in the image\n" }, "isLts": { "type": "boolean", "description": "Whether the public image is maintained long-term.\n" }, "isSupportCloudInit": { "type": "boolean", "description": "Whether the image supports Cloud-init.\n" }, "kernel": { "type": "string", "description": "Image kernel version.\n" }, "licenseType": { "type": "string", "description": "Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)\n" }, "needDetection": { "type": "boolean", "description": "Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.\n" }, "osName": { "type": "string", "description": "Name of the image operating system.\n" }, "osType": { "type": "string", "description": "Operating system type\n" }, "platform": { "type": "string", "description": "Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.\n" }, "platformVersion": { "type": "string", "description": "Image release version.\n" }, "productCode": { "type": "string", "description": "Product code for marketplace image\n" }, "projectName": { "type": "string", "description": "Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions\n" }, "sharePermissions": { "type": "array", "items": { "type": "string" }, "description": "Accounts with which the image is shared\n" }, "shareStatus": { "type": "string", "description": "Image sharing status. HasShared: The custom image has been shared with other users. If the custom image is not shared or a public image is used, ShareStatus returns empty.\n" }, "size": { "type": "integer", "description": "Image size, in GiB.\n" }, "snapshotGroupId": { "type": "string", "description": "Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided\n" }, "snapshotId": { "type": "string", "description": "System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.\n" }, "snapshots": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/ImageSnapshot:ImageSnapshot" } }, "status": { "type": "string", "description": "Image status.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/ImageTag:ImageTag" } }, "updatedAt": { "type": "string", "description": "Image update time\n" }, "virtualSize": { "type": "number", "description": "Image size, in Bytes.\n" }, "visibility": { "type": "string", "description": "Image visibility. public: Public image. private: Private image. shared: Shared image.\n" } }, "required": [ "architecture", "bootMode", "createWholeImage", "createdAt", "description", "detectionResults", "imageId", "imageName", "imageOwnerId", "importImage", "instanceId", "isInstallRunCommandAgent", "isLts", "isSupportCloudInit", "kernel", "licenseType", "needDetection", "osName", "osType", "platform", "platformVersion", "productCode", "projectName", "sharePermissions", "shareStatus", "size", "snapshotGroupId", "snapshotId", "snapshots", "status", "tags", "updatedAt", "virtualSize", "visibility" ], "inputProperties": { "architecture": { "type": "string", "description": "Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).\n" }, "bootMode": { "type": "string", "description": "Image boot mode. You can select BIOS or UEFI\n" }, "createWholeImage": { "type": "boolean", "description": "Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.\n" }, "description": { "type": "string", "description": "Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores \"_\", hyphens \"-\", equals signs \"=\", English commas \",\", English periods \".\", Chinese commas \"，\", Chinese periods \"。\", and spaces. Length: 0–255 characters. If left blank, defaults to empty.\n" }, "imageName": { "type": "string", "description": "Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores \"_\", hyphens \"-\", and periods \".\". Length: 1–128 characters\n" }, "importImage": { "$ref": "#/types/volcenginecc:ecs/ImageImportImage:ImageImportImage", "description": "Imported image information\n" }, "instanceId": { "type": "string", "description": "Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.\n" }, "licenseType": { "type": "string", "description": "Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)\n" }, "needDetection": { "type": "boolean", "description": "Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.\n" }, "osType": { "type": "string", "description": "Operating system type\n" }, "platform": { "type": "string", "description": "Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.\n" }, "platformVersion": { "type": "string", "description": "Image release version.\n" }, "projectName": { "type": "string", "description": "Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions\n" }, "sharePermissions": { "type": "array", "items": { "type": "string" }, "description": "Accounts with which the image is shared\n" }, "snapshotGroupId": { "type": "string", "description": "Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided\n" }, "snapshotId": { "type": "string", "description": "System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/ImageTag:ImageTag" } } }, "requiredInputs": [ "imageName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Image resources.\n", "properties": { "architecture": { "type": "string", "description": "Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).\n" }, "bootMode": { "type": "string", "description": "Image boot mode. You can select BIOS or UEFI\n" }, "createWholeImage": { "type": "boolean", "description": "Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.\n" }, "createdAt": { "type": "string", "description": "Image creation time\n" }, "description": { "type": "string", "description": "Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores \"_\", hyphens \"-\", equals signs \"=\", English commas \",\", English periods \".\", Chinese commas \"，\", Chinese periods \"。\", and spaces. Length: 0–255 characters. If left blank, defaults to empty.\n" }, "detectionResults": { "$ref": "#/types/volcenginecc:ecs/ImageDetectionResults:ImageDetectionResults", "description": "Image check result.\n" }, "imageId": { "type": "string", "description": "Image ID\n" }, "imageName": { "type": "string", "description": "Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores \"_\", hyphens \"-\", and periods \".\". Length: 1–128 characters\n" }, "imageOwnerId": { "type": "string", "description": "Account ID to which the image belongs.\n" }, "importImage": { "$ref": "#/types/volcenginecc:ecs/ImageImportImage:ImageImportImage", "description": "Imported image information\n" }, "instanceId": { "type": "string", "description": "Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.\n" }, "isInstallRunCommandAgent": { "type": "boolean", "description": "Whether Cloud Assistant Agent is installed in the image\n" }, "isLts": { "type": "boolean", "description": "Whether the public image is maintained long-term.\n" }, "isSupportCloudInit": { "type": "boolean", "description": "Whether the image supports Cloud-init.\n" }, "kernel": { "type": "string", "description": "Image kernel version.\n" }, "licenseType": { "type": "string", "description": "Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)\n" }, "needDetection": { "type": "boolean", "description": "Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.\n" }, "osName": { "type": "string", "description": "Name of the image operating system.\n" }, "osType": { "type": "string", "description": "Operating system type\n" }, "platform": { "type": "string", "description": "Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.\n" }, "platformVersion": { "type": "string", "description": "Image release version.\n" }, "productCode": { "type": "string", "description": "Product code for marketplace image\n" }, "projectName": { "type": "string", "description": "Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions\n" }, "sharePermissions": { "type": "array", "items": { "type": "string" }, "description": "Accounts with which the image is shared\n" }, "shareStatus": { "type": "string", "description": "Image sharing status. HasShared: The custom image has been shared with other users. If the custom image is not shared or a public image is used, ShareStatus returns empty.\n" }, "size": { "type": "integer", "description": "Image size, in GiB.\n" }, "snapshotGroupId": { "type": "string", "description": "Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided\n" }, "snapshotId": { "type": "string", "description": "System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.\n" }, "snapshots": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/ImageSnapshot:ImageSnapshot" } }, "status": { "type": "string", "description": "Image status.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/ImageTag:ImageTag" } }, "updatedAt": { "type": "string", "description": "Image update time\n" }, "virtualSize": { "type": "number", "description": "Image size, in Bytes.\n" }, "visibility": { "type": "string", "description": "Image visibility. public: Public image. private: Private image. shared: Shared image.\n" } }, "type": "object" } }, "volcenginecc:ecs/instance:Instance": { "description": "Represents an Elastic Compute Service (ECS) instance resource.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n ecsInstanceDemo:\n type: volcenginecc:ecs:Instance\n name: EcsInstanceDemo\n properties:\n password: '**********'\n instanceChargeType: PostPaid\n instanceName: EcsInstanceDemo\n spotStrategy: NoSpot\n hostname: EcsInstanceDemo\n description: EcsInstanceDemo Description\n projectName: default\n instanceType: ecs.g4i.large\n deletionProtection: false\n zoneId: cn-beijing-a\n deploymentSetId: dps-ydzccfzqjoaa98kxxxxx\n deploymentSetGroupNumber: 1\n image:\n image_id: image-aagd56zrw2jtdroxxxxx\n vpcId: vpc-rrco37ovjq4gv0x58zxxxxx\n eipAddress:\n charge_type: PayByTraffic\n bandwidth_mbps: 5\n isp: BGP\n release_with_instance: false\n bandwidth_package_id: \"\"\n primaryNetworkInterface:\n security_group_ids:\n - sg-1v9zvjkmx14w51j8e73xxxxx\n subnet_id: subnet-rrwqhg3qzxfkv0x57gxxxxx\n ipv_6_address_count: 1\n secondaryNetworkInterfaces:\n - security_group_ids:\n - sg-1v9zvjkmx14w51j8e73xxxxx\n subnet_id: subnet-rrwqhg3qzxfkv0x57gxxxxx\n placement:\n affinity: Default\n dedicated_host_cluster_id: \"\"\n tenancy: Default\n dedicated_host_id: \"\"\n systemVolume:\n size: 50\n delete_with_instance: true\n volume_type: ESSD_FlexPL\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ecs/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "affinityGroupId": { "type": "string", "description": "Affinity group ID.\n" }, "affinityGroupSize": { "type": "integer", "description": "Affinity group specification. Value: 2. **Note:** - Currently, only high performance computing NPU-type hpcpci3\ninstances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact\nyour account manager.\n" }, "autoPay": { "type": "boolean", "description": "Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is\ninsufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only\ngenerates the order without charging. You can log in to the order management page to complete payment after the order is\ngenerated.\n" }, "autoRenew": { "type": "boolean", "description": "Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No\nauto renewal **Note:** This parameter is effective only when `InstanceChargeType` is set to `PrePaid`.\n" }, "autoRenewPeriod": { "type": "integer", "description": "Duration for each automatic renewal. - This parameter takes effect only when `AutoRenew` is set to `True`. Default value\nis 1. - When `PeriodUnit` is `Month`, valid values are 1, 2, 3, 6, 12.\n" }, "cpuMaxFrequency": { "type": "number", "description": "Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. **Note:**\n- Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo\nfrequencies and more information, see [Instance Specifications\nIntroduction](https://www.volcengine.com/docs/6396/70840). - This feature is in invitation-only testing. To use it,\nplease contact your account manager.\n" }, "cpuMemory": { "$ref": "#/types/volcenginecc:ecs/InstanceCpuMemory:InstanceCpuMemory", "description": "The CPU options for the instance.\n" }, "createdAt": { "type": "string", "description": "Instance creation time.\n" }, "creditSpecification": { "type": "string", "description": "Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not\nsupported yet). **Note:** - This parameter is only effective when `InstanceTypeId` is set to ecs.t2 series, i.e.,\nburstable instances. - If not specified or left empty, burstable instances default to `Standard` mode.\n" }, "deletionProtection": { "type": "boolean", "description": "Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: -\ntrue: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion\nprotection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code.\nTo delete the instance, disable deletion protection first\n" }, "deploymentSetGroupNumber": { "type": "integer", "description": "When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify\nthe group number of the instance within the deployment set. Value range: 1–7.\n" }, "deploymentSetId": { "type": "string", "description": "The deployment set ID the instance needs to join. - You can call the\n[DescribeDeploymentSets](https://www.volcengine.com/docs/6396/70873) API to query existing deployment sets. - For more\ninformation about deployment sets, see [Deployment Set](https://www.volcengine.com/docs/6396/70871).\n" }, "description": { "type": "string", "description": "The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only\ncontain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma\n',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters\n" }, "eipAddress": { "$ref": "#/types/volcenginecc:ecs/InstanceEipAddress:InstanceEipAddress", "description": "The EIP address of the instance.\n" }, "elasticScheduledInstanceType": { "type": "string", "description": "Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance.\nSegmented: Elastic reservation instance - time segment type.\n" }, "enableJumboFrame": { "type": "boolean", "description": "Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces\nhave an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500\n" }, "expiredAt": { "type": "string", "description": "The expiration time of the instance.\n" }, "hostname": { "type": "string", "description": "Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters,\nnumbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use\nconsecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows\ninstances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or\nend with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15\ncharacters.\n" }, "hpcClusterId": { "type": "string", "description": "ID of the high performance computing cluster to which the instance belongs. **Note:** This parameter is only effective\nand required when creating high performance computing GPU instances.\n" }, "image": { "$ref": "#/types/volcenginecc:ecs/InstanceImage:InstanceImage", "description": "The image of the instance.\n" }, "includeDataVolumes": { "type": "boolean", "description": "Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert.\nfalse (default): Do not convert.\n" }, "installRunCommandAgent": { "type": "boolean", "description": "Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false\n(default): Do not install during creation.\n" }, "instanceChargeType": { "type": "string", "description": "The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please\nensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be\nreturned.\n" }, "instanceId": { "type": "string", "description": "The ECS instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers,\nunderscores \"_\", hyphens \"-\", and periods \".\" - Length limit: 1–128 characters\n" }, "instanceType": { "type": "string", "description": "Instance specification. - Product selection: You can refer to [Instance Specifications\nIntroduction](https://www.volcengine.com/docs/6396/70840) or call\n[DescribeInstanceTypes](https://www.volcengine.com/docs/6396/92769) to view performance data, and refer to [Instance\nSelection Best Practices](https://www.volcengine.com/docs/6396/74174) to learn how to choose specifications. - Inventory\nquery: You can call [DescribeAvailableResource](https://www.volcengine.com/docs/6396/76279) to check available compute\nresources in the zone.\n" }, "keyPair": { "$ref": "#/types/volcenginecc:ecs/InstanceKeyPair:InstanceKeyPair", "description": "Instance key pair name\n" }, "localVolumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceLocalVolume:InstanceLocalVolume" } }, "operationSystem": { "$ref": "#/types/volcenginecc:ecs/InstanceOperationSystem:InstanceOperationSystem", "description": "The operating system type of the instance.\n" }, "password": { "type": "string", "description": "The password of the instance.\n" }, "period": { "type": "integer", "description": "Resource purchase duration (N). - When `PeriodUnit` is `Month` (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9,\n12, 24, 36, 48, 60. - When `PeriodUnit` is `Year`, valid values are 1, 2, 3, 4, 5. **Note:** This parameter is valid and\nrequired only when `InstanceChargeType` is set to `PrePaid`.\n" }, "periodUnit": { "type": "string", "description": "The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year **Note:** This parameter\nis effective only when `InstanceChargeType` is set to `PrePaid`.\n" }, "placement": { "$ref": "#/types/volcenginecc:ecs/InstancePlacement:InstancePlacement", "description": "The deployment information of the instance.\n" }, "primaryNetworkInterface": { "$ref": "#/types/volcenginecc:ecs/InstancePrimaryNetworkInterface:InstancePrimaryNetworkInterface", "description": "Primary network interface card of the instance.\n" }, "projectName": { "type": "string", "description": "Project name to which the instance belongs.\n" }, "rdmaIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in\na list.\n" }, "rdmaNetworkInterfaceDetails": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceRdmaNetworkInterfaceDetail:InstanceRdmaNetworkInterfaceDetail" } }, "renewInfo": { "$ref": "#/types/volcenginecc:ecs/InstanceRenewInfo:InstanceRenewInfo", "description": "Renewal information.\n" }, "roleNames": { "type": "array", "items": { "type": "string" }, "description": "IAM role name bound to the instance\n" }, "secondaryNetworkInterfaces": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceSecondaryNetworkInterface:InstanceSecondaryNetworkInterface" } }, "spotPriceLimit": { "type": "number", "description": "Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when `SpotStrategy` is\nset to `SpotWithPriceLimit`. - When `SpotStrategy` is set to `SpotWithPriceLimit`, you can set a custom price limit for\nthe spot instance. If the market price exceeds your bid, the instance will be released. When `SpotStrategy` is set to\n`SpotAsPriceGo`, you accept the system's automatic bidding, following the current market price, and this parameter does\nnot need to be filled in.\n" }, "spotStrategy": { "type": "string", "description": "Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. -\nSpotAsPriceGo: System bids automatically, following the current market price for spot instances.\n" }, "status": { "type": "string", "description": "Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting\nSTARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting\n" }, "stoppedMode": { "type": "string", "description": "StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode.\nAfter stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the\nsame as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources\n(vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and\ncontinue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped\nmode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud\nserver console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging.\nNotApplicable: Indicates that this instance does not support cost-saving stopped mode.\n" }, "systemVolume": { "$ref": "#/types/volcenginecc:ecs/InstanceSystemVolume:InstanceSystemVolume", "description": "The system volume of the instance.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceTag:InstanceTag" } }, "updatedAt": { "type": "string", "description": "The update time of the instance.\n" }, "userData": { "type": "string", "description": "Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances:\nScript content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8\nKB and does not require Base64 encoding\n" }, "vpcId": { "type": "string", "description": "The private network ID to which the instance belongs. You can call the\n[DescribeVpcs](https://www.volcengine.com/docs/6563/66127) API to obtain VPC information for the target region.\n" }, "zoneId": { "type": "string", "description": "The availability zone ID where the instance is located.\n" } }, "required": [ "affinityGroupId", "affinityGroupSize", "autoPay", "autoRenew", "autoRenewPeriod", "cpuMaxFrequency", "cpuMemory", "createdAt", "creditSpecification", "deletionProtection", "deploymentSetGroupNumber", "deploymentSetId", "description", "eipAddress", "elasticScheduledInstanceType", "enableJumboFrame", "expiredAt", "hostname", "hpcClusterId", "image", "includeDataVolumes", "installRunCommandAgent", "instanceChargeType", "instanceId", "instanceName", "instanceType", "keyPair", "localVolumes", "operationSystem", "password", "period", "periodUnit", "placement", "primaryNetworkInterface", "projectName", "rdmaIpAddresses", "rdmaNetworkInterfaceDetails", "renewInfo", "roleNames", "secondaryNetworkInterfaces", "spotPriceLimit", "spotStrategy", "status", "stoppedMode", "systemVolume", "tags", "updatedAt", "userData", "vpcId", "zoneId" ], "inputProperties": { "affinityGroupSize": { "type": "integer", "description": "Affinity group specification. Value: 2. **Note:** - Currently, only high performance computing NPU-type hpcpci3\ninstances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact\nyour account manager.\n" }, "autoPay": { "type": "boolean", "description": "Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is\ninsufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only\ngenerates the order without charging. You can log in to the order management page to complete payment after the order is\ngenerated.\n" }, "autoRenew": { "type": "boolean", "description": "Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No\nauto renewal **Note:** This parameter is effective only when `InstanceChargeType` is set to `PrePaid`.\n" }, "autoRenewPeriod": { "type": "integer", "description": "Duration for each automatic renewal. - This parameter takes effect only when `AutoRenew` is set to `True`. Default value\nis 1. - When `PeriodUnit` is `Month`, valid values are 1, 2, 3, 6, 12.\n" }, "cpuMaxFrequency": { "type": "number", "description": "Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. **Note:**\n- Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo\nfrequencies and more information, see [Instance Specifications\nIntroduction](https://www.volcengine.com/docs/6396/70840). - This feature is in invitation-only testing. To use it,\nplease contact your account manager.\n" }, "creditSpecification": { "type": "string", "description": "Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not\nsupported yet). **Note:** - This parameter is only effective when `InstanceTypeId` is set to ecs.t2 series, i.e.,\nburstable instances. - If not specified or left empty, burstable instances default to `Standard` mode.\n" }, "deletionProtection": { "type": "boolean", "description": "Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: -\ntrue: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion\nprotection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code.\nTo delete the instance, disable deletion protection first\n" }, "deploymentSetGroupNumber": { "type": "integer", "description": "When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify\nthe group number of the instance within the deployment set. Value range: 1–7.\n" }, "deploymentSetId": { "type": "string", "description": "The deployment set ID the instance needs to join. - You can call the\n[DescribeDeploymentSets](https://www.volcengine.com/docs/6396/70873) API to query existing deployment sets. - For more\ninformation about deployment sets, see [Deployment Set](https://www.volcengine.com/docs/6396/70871).\n" }, "description": { "type": "string", "description": "The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only\ncontain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma\n',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters\n" }, "eipAddress": { "$ref": "#/types/volcenginecc:ecs/InstanceEipAddress:InstanceEipAddress", "description": "The EIP address of the instance.\n" }, "enableJumboFrame": { "type": "boolean", "description": "Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces\nhave an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500\n" }, "hostname": { "type": "string", "description": "Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters,\nnumbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use\nconsecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows\ninstances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or\nend with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15\ncharacters.\n" }, "hpcClusterId": { "type": "string", "description": "ID of the high performance computing cluster to which the instance belongs. **Note:** This parameter is only effective\nand required when creating high performance computing GPU instances.\n" }, "image": { "$ref": "#/types/volcenginecc:ecs/InstanceImage:InstanceImage", "description": "The image of the instance.\n" }, "includeDataVolumes": { "type": "boolean", "description": "Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert.\nfalse (default): Do not convert.\n" }, "installRunCommandAgent": { "type": "boolean", "description": "Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false\n(default): Do not install during creation.\n" }, "instanceChargeType": { "type": "string", "description": "The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please\nensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be\nreturned.\n" }, "instanceName": { "type": "string", "description": "Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers,\nunderscores \"_\", hyphens \"-\", and periods \".\" - Length limit: 1–128 characters\n" }, "instanceType": { "type": "string", "description": "Instance specification. - Product selection: You can refer to [Instance Specifications\nIntroduction](https://www.volcengine.com/docs/6396/70840) or call\n[DescribeInstanceTypes](https://www.volcengine.com/docs/6396/92769) to view performance data, and refer to [Instance\nSelection Best Practices](https://www.volcengine.com/docs/6396/74174) to learn how to choose specifications. - Inventory\nquery: You can call [DescribeAvailableResource](https://www.volcengine.com/docs/6396/76279) to check available compute\nresources in the zone.\n" }, "keyPair": { "$ref": "#/types/volcenginecc:ecs/InstanceKeyPair:InstanceKeyPair", "description": "Instance key pair name\n" }, "password": { "type": "string", "description": "The password of the instance.\n" }, "period": { "type": "integer", "description": "Resource purchase duration (N). - When `PeriodUnit` is `Month` (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9,\n12, 24, 36, 48, 60. - When `PeriodUnit` is `Year`, valid values are 1, 2, 3, 4, 5. **Note:** This parameter is valid and\nrequired only when `InstanceChargeType` is set to `PrePaid`.\n" }, "periodUnit": { "type": "string", "description": "The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year **Note:** This parameter\nis effective only when `InstanceChargeType` is set to `PrePaid`.\n" }, "placement": { "$ref": "#/types/volcenginecc:ecs/InstancePlacement:InstancePlacement", "description": "The deployment information of the instance.\n" }, "primaryNetworkInterface": { "$ref": "#/types/volcenginecc:ecs/InstancePrimaryNetworkInterface:InstancePrimaryNetworkInterface", "description": "Primary network interface card of the instance.\n" }, "projectName": { "type": "string", "description": "Project name to which the instance belongs.\n" }, "renewInfo": { "$ref": "#/types/volcenginecc:ecs/InstanceRenewInfo:InstanceRenewInfo", "description": "Renewal information.\n" }, "roleNames": { "type": "array", "items": { "type": "string" }, "description": "IAM role name bound to the instance\n" }, "secondaryNetworkInterfaces": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceSecondaryNetworkInterface:InstanceSecondaryNetworkInterface" } }, "spotPriceLimit": { "type": "number", "description": "Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when `SpotStrategy` is\nset to `SpotWithPriceLimit`. - When `SpotStrategy` is set to `SpotWithPriceLimit`, you can set a custom price limit for\nthe spot instance. If the market price exceeds your bid, the instance will be released. When `SpotStrategy` is set to\n`SpotAsPriceGo`, you accept the system's automatic bidding, following the current market price, and this parameter does\nnot need to be filled in.\n" }, "spotStrategy": { "type": "string", "description": "Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. -\nSpotAsPriceGo: System bids automatically, following the current market price for spot instances.\n" }, "status": { "type": "string", "description": "Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting\nSTARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting\n" }, "stoppedMode": { "type": "string", "description": "StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode.\nAfter stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the\nsame as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources\n(vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and\ncontinue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped\nmode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud\nserver console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging.\nNotApplicable: Indicates that this instance does not support cost-saving stopped mode.\n" }, "systemVolume": { "$ref": "#/types/volcenginecc:ecs/InstanceSystemVolume:InstanceSystemVolume", "description": "The system volume of the instance.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceTag:InstanceTag" } }, "userData": { "type": "string", "description": "Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances:\nScript content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8\nKB and does not require Base64 encoding\n" }, "zoneId": { "type": "string", "description": "The availability zone ID where the instance is located.\n" } }, "requiredInputs": [ "image", "instanceName", "instanceType", "primaryNetworkInterface", "systemVolume", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "affinityGroupId": { "type": "string", "description": "Affinity group ID.\n" }, "affinityGroupSize": { "type": "integer", "description": "Affinity group specification. Value: 2. **Note:** - Currently, only high performance computing NPU-type hpcpci3\ninstances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact\nyour account manager.\n" }, "autoPay": { "type": "boolean", "description": "Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is\ninsufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only\ngenerates the order without charging. You can log in to the order management page to complete payment after the order is\ngenerated.\n" }, "autoRenew": { "type": "boolean", "description": "Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No\nauto renewal **Note:** This parameter is effective only when `InstanceChargeType` is set to `PrePaid`.\n" }, "autoRenewPeriod": { "type": "integer", "description": "Duration for each automatic renewal. - This parameter takes effect only when `AutoRenew` is set to `True`. Default value\nis 1. - When `PeriodUnit` is `Month`, valid values are 1, 2, 3, 6, 12.\n" }, "cpuMaxFrequency": { "type": "number", "description": "Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. **Note:**\n- Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo\nfrequencies and more information, see [Instance Specifications\nIntroduction](https://www.volcengine.com/docs/6396/70840). - This feature is in invitation-only testing. To use it,\nplease contact your account manager.\n" }, "cpuMemory": { "$ref": "#/types/volcenginecc:ecs/InstanceCpuMemory:InstanceCpuMemory", "description": "The CPU options for the instance.\n" }, "createdAt": { "type": "string", "description": "Instance creation time.\n" }, "creditSpecification": { "type": "string", "description": "Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not\nsupported yet). **Note:** - This parameter is only effective when `InstanceTypeId` is set to ecs.t2 series, i.e.,\nburstable instances. - If not specified or left empty, burstable instances default to `Standard` mode.\n" }, "deletionProtection": { "type": "boolean", "description": "Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: -\ntrue: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion\nprotection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code.\nTo delete the instance, disable deletion protection first\n" }, "deploymentSetGroupNumber": { "type": "integer", "description": "When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify\nthe group number of the instance within the deployment set. Value range: 1–7.\n" }, "deploymentSetId": { "type": "string", "description": "The deployment set ID the instance needs to join. - You can call the\n[DescribeDeploymentSets](https://www.volcengine.com/docs/6396/70873) API to query existing deployment sets. - For more\ninformation about deployment sets, see [Deployment Set](https://www.volcengine.com/docs/6396/70871).\n" }, "description": { "type": "string", "description": "The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only\ncontain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma\n',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters\n" }, "eipAddress": { "$ref": "#/types/volcenginecc:ecs/InstanceEipAddress:InstanceEipAddress", "description": "The EIP address of the instance.\n" }, "elasticScheduledInstanceType": { "type": "string", "description": "Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance.\nSegmented: Elastic reservation instance - time segment type.\n" }, "enableJumboFrame": { "type": "boolean", "description": "Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces\nhave an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500\n" }, "expiredAt": { "type": "string", "description": "The expiration time of the instance.\n" }, "hostname": { "type": "string", "description": "Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters,\nnumbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use\nconsecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows\ninstances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or\nend with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15\ncharacters.\n" }, "hpcClusterId": { "type": "string", "description": "ID of the high performance computing cluster to which the instance belongs. **Note:** This parameter is only effective\nand required when creating high performance computing GPU instances.\n" }, "image": { "$ref": "#/types/volcenginecc:ecs/InstanceImage:InstanceImage", "description": "The image of the instance.\n" }, "includeDataVolumes": { "type": "boolean", "description": "Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert.\nfalse (default): Do not convert.\n" }, "installRunCommandAgent": { "type": "boolean", "description": "Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false\n(default): Do not install during creation.\n" }, "instanceChargeType": { "type": "string", "description": "The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please\nensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be\nreturned.\n" }, "instanceId": { "type": "string", "description": "The ECS instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers,\nunderscores \"_\", hyphens \"-\", and periods \".\" - Length limit: 1–128 characters\n" }, "instanceType": { "type": "string", "description": "Instance specification. - Product selection: You can refer to [Instance Specifications\nIntroduction](https://www.volcengine.com/docs/6396/70840) or call\n[DescribeInstanceTypes](https://www.volcengine.com/docs/6396/92769) to view performance data, and refer to [Instance\nSelection Best Practices](https://www.volcengine.com/docs/6396/74174) to learn how to choose specifications. - Inventory\nquery: You can call [DescribeAvailableResource](https://www.volcengine.com/docs/6396/76279) to check available compute\nresources in the zone.\n" }, "keyPair": { "$ref": "#/types/volcenginecc:ecs/InstanceKeyPair:InstanceKeyPair", "description": "Instance key pair name\n" }, "localVolumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceLocalVolume:InstanceLocalVolume" } }, "operationSystem": { "$ref": "#/types/volcenginecc:ecs/InstanceOperationSystem:InstanceOperationSystem", "description": "The operating system type of the instance.\n" }, "password": { "type": "string", "description": "The password of the instance.\n" }, "period": { "type": "integer", "description": "Resource purchase duration (N). - When `PeriodUnit` is `Month` (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9,\n12, 24, 36, 48, 60. - When `PeriodUnit` is `Year`, valid values are 1, 2, 3, 4, 5. **Note:** This parameter is valid and\nrequired only when `InstanceChargeType` is set to `PrePaid`.\n" }, "periodUnit": { "type": "string", "description": "The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year **Note:** This parameter\nis effective only when `InstanceChargeType` is set to `PrePaid`.\n" }, "placement": { "$ref": "#/types/volcenginecc:ecs/InstancePlacement:InstancePlacement", "description": "The deployment information of the instance.\n" }, "primaryNetworkInterface": { "$ref": "#/types/volcenginecc:ecs/InstancePrimaryNetworkInterface:InstancePrimaryNetworkInterface", "description": "Primary network interface card of the instance.\n" }, "projectName": { "type": "string", "description": "Project name to which the instance belongs.\n" }, "rdmaIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in\na list.\n" }, "rdmaNetworkInterfaceDetails": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceRdmaNetworkInterfaceDetail:InstanceRdmaNetworkInterfaceDetail" } }, "renewInfo": { "$ref": "#/types/volcenginecc:ecs/InstanceRenewInfo:InstanceRenewInfo", "description": "Renewal information.\n" }, "roleNames": { "type": "array", "items": { "type": "string" }, "description": "IAM role name bound to the instance\n" }, "secondaryNetworkInterfaces": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceSecondaryNetworkInterface:InstanceSecondaryNetworkInterface" } }, "spotPriceLimit": { "type": "number", "description": "Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when `SpotStrategy` is\nset to `SpotWithPriceLimit`. - When `SpotStrategy` is set to `SpotWithPriceLimit`, you can set a custom price limit for\nthe spot instance. If the market price exceeds your bid, the instance will be released. When `SpotStrategy` is set to\n`SpotAsPriceGo`, you accept the system's automatic bidding, following the current market price, and this parameter does\nnot need to be filled in.\n" }, "spotStrategy": { "type": "string", "description": "Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. -\nSpotAsPriceGo: System bids automatically, following the current market price for spot instances.\n" }, "status": { "type": "string", "description": "Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting\nSTARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting\n" }, "stoppedMode": { "type": "string", "description": "StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode.\nAfter stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the\nsame as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources\n(vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and\ncontinue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped\nmode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud\nserver console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging.\nNotApplicable: Indicates that this instance does not support cost-saving stopped mode.\n" }, "systemVolume": { "$ref": "#/types/volcenginecc:ecs/InstanceSystemVolume:InstanceSystemVolume", "description": "The system volume of the instance.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InstanceTag:InstanceTag" } }, "updatedAt": { "type": "string", "description": "The update time of the instance.\n" }, "userData": { "type": "string", "description": "Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances:\nScript content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8\nKB and does not require Base64 encoding\n" }, "vpcId": { "type": "string", "description": "The private network ID to which the instance belongs. You can call the\n[DescribeVpcs](https://www.volcengine.com/docs/6563/66127) API to obtain VPC information for the target region.\n" }, "zoneId": { "type": "string", "description": "The availability zone ID where the instance is located.\n" } }, "type": "object" } }, "volcenginecc:ecs/invocation:Invocation": { "description": "Cloud Assistant is a native automated operations tool developed by Volcano Engine. You can create jobs for immediate, periodic, or scheduled execution. After creation, the Cloud Assistant client automatically starts execution according to the execution mode.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst invocationDemo = new volcenginecc.ecs.Invocation(\"InvocationDemo\", {\n invocationName: \"InvocationDemo\",\n invocationDescription: \"InvocationDemo desc\",\n workingDir: \"/home\",\n username: \"InvocationDemo\",\n windowsPassword: \"********\",\n timeout: 60,\n instanceIds: [\"i-ye2v6l0pvkqc6inxxxxx\"],\n repeatMode: \"Rate\",\n frequency: \"1h\",\n launchTime: \"2025-08-30T11:10Z\",\n recurrenceEndTime: \"2025-08-31T11:04Z\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n commandId: \"cmd-ye28kugp249tzrexxxxx\",\n parameters: \"{\\\"dirname\\\":\\\"10\\\"}\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ninvocation_demo = volcenginecc.ecs.Invocation(\"InvocationDemo\",\n invocation_name=\"InvocationDemo\",\n invocation_description=\"InvocationDemo desc\",\n working_dir=\"/home\",\n username=\"InvocationDemo\",\n windows_password=\"********\",\n timeout=60,\n instance_ids=[\"i-ye2v6l0pvkqc6inxxxxx\"],\n repeat_mode=\"Rate\",\n frequency=\"1h\",\n launch_time=\"2025-08-30T11:10Z\",\n recurrence_end_time=\"2025-08-31T11:04Z\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }],\n command_id=\"cmd-ye28kugp249tzrexxxxx\",\n parameters=\"{\\\"dirname\\\":\\\"10\\\"}\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var invocationDemo = new Volcenginecc.Ecs.Invocation(\"InvocationDemo\", new()\n {\n InvocationName = \"InvocationDemo\",\n InvocationDescription = \"InvocationDemo desc\",\n WorkingDir = \"/home\",\n Username = \"InvocationDemo\",\n WindowsPassword = \"********\",\n Timeout = 60,\n InstanceIds = new[]\n {\n \"i-ye2v6l0pvkqc6inxxxxx\",\n },\n RepeatMode = \"Rate\",\n Frequency = \"1h\",\n LaunchTime = \"2025-08-30T11:10Z\",\n RecurrenceEndTime = \"2025-08-31T11:04Z\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Ecs.Inputs.InvocationTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n CommandId = \"cmd-ye28kugp249tzrexxxxx\",\n Parameters = \"{\\\"dirname\\\":\\\"10\\\"}\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/ecs\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ecs.NewInvocation(ctx, \"InvocationDemo\", \u0026ecs.InvocationArgs{\n\t\t\tInvocationName: pulumi.String(\"InvocationDemo\"),\n\t\t\tInvocationDescription: pulumi.String(\"InvocationDemo desc\"),\n\t\t\tWorkingDir: pulumi.String(\"/home\"),\n\t\t\tUsername: pulumi.String(\"InvocationDemo\"),\n\t\t\tWindowsPassword: pulumi.String(\"********\"),\n\t\t\tTimeout: pulumi.Int(60),\n\t\t\tInstanceIds: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"i-ye2v6l0pvkqc6inxxxxx\"),\n\t\t\t},\n\t\t\tRepeatMode: pulumi.String(\"Rate\"),\n\t\t\tFrequency: pulumi.String(\"1h\"),\n\t\t\tLaunchTime: pulumi.String(\"2025-08-30T11:10Z\"),\n\t\t\tRecurrenceEndTime: pulumi.String(\"2025-08-31T11:04Z\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: ecs.InvocationTagArray{\n\t\t\t\t\u0026ecs.InvocationTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tCommandId: pulumi.String(\"cmd-ye28kugp249tzrexxxxx\"),\n\t\t\tParameters: pulumi.String(\"{\\\"dirname\\\":\\\"10\\\"}\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.ecs.Invocation;\nimport com.volcengine.volcenginecc.ecs.InvocationArgs;\nimport com.pulumi.volcenginecc.ecs.inputs.InvocationTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var invocationDemo = new Invocation(\"invocationDemo\", InvocationArgs.builder()\n .invocationName(\"InvocationDemo\")\n .invocationDescription(\"InvocationDemo desc\")\n .workingDir(\"/home\")\n .username(\"InvocationDemo\")\n .windowsPassword(\"********\")\n .timeout(60)\n .instanceIds(\"i-ye2v6l0pvkqc6inxxxxx\")\n .repeatMode(\"Rate\")\n .frequency(\"1h\")\n .launchTime(\"2025-08-30T11:10Z\")\n .recurrenceEndTime(\"2025-08-31T11:04Z\")\n .projectName(\"default\")\n .tags(InvocationTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .commandId(\"cmd-ye28kugp249tzrexxxxx\")\n .parameters(\"{\\\"dirname\\\":\\\"10\\\"}\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n invocationDemo:\n type: volcenginecc:ecs:Invocation\n name: InvocationDemo\n properties:\n invocationName: InvocationDemo\n invocationDescription: InvocationDemo desc\n workingDir: /home\n username: InvocationDemo\n windowsPassword: '********'\n timeout: 60\n instanceIds:\n - i-ye2v6l0pvkqc6inxxxxx\n repeatMode: Rate\n frequency: 1h\n launchTime: 2025-08-30T11:10Z\n recurrenceEndTime: 2025-08-31T11:04Z\n projectName: default\n tags:\n - key: env\n value: test\n commandId: cmd-ye28kugp249tzrexxxxx\n parameters: '{\"dirname\":\"10\"}'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ecs/invocation:Invocation example \"invocation_id\"\n```\n\n", "properties": { "commandContent": { "type": "string", "description": "Command content.\n" }, "commandDescription": { "type": "string", "description": "Description of the invoked command.\n" }, "commandId": { "type": "string", "description": "Command ID.\n" }, "commandName": { "type": "string", "description": "Command name when the task is triggered.\n" }, "commandProvider": { "type": "string", "description": "Provider of the invoked command.\n" }, "commandType": { "type": "string", "description": "Command type triggered by the job.\n" }, "enableParameter": { "type": "boolean", "description": "Whether the invoked command uses custom parameters. true: enabled. false: not enabled.\n" }, "endTime": { "type": "string", "description": "Task end time.\n" }, "frequency": { "type": "string", "description": "Execution frequency. This parameter is required when RepeatMode=Rate. Format: \\n\\n\\n\\n. Interval units supported: minutes (5m–60m), hours (1h–24h), and days (1d–7d). The interval is based on a fixed frequency and is independent of the actual job execution time. After job creation, it executes once based on LaunchTime, and the next execution time is determined by the interval setting.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "Instance ID list, supports up to 200 IDs.\n" }, "instanceNumber": { "type": "integer", "description": "Number of instances executed.\n" }, "invocationDescription": { "type": "string", "description": "Job description. Defaults to an empty string and must not exceed 256 characters.\n" }, "invocationId": { "type": "string", "description": "Task execution ID.\n" }, "invocationName": { "type": "string", "description": "Job name. Maximum 64 characters. No restriction on special characters. Job names can be duplicated within the same region.\n" }, "invocationResults": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InvocationInvocationResult:InvocationInvocationResult" } }, "invocationStatus": { "type": "string", "description": "Overall execution status of the command.\n" }, "launchTime": { "type": "string", "description": "Execution time.\n" }, "parameterDefinitions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InvocationParameterDefinition:InvocationParameterDefinition" } }, "parameters": { "type": "string", "description": "When the command includes custom parameters, use this parameter to pass custom parameter key-value pairs. The number of custom parameters ranges from 0 to 60. Key cannot be an empty string and supports up to 64 characters. Value can be an empty string. The combined length of custom parameters and original command content after Base64 encoding must not exceed 16 KB. The set of custom parameter names must be a subset of the parameter set defined when creating the command. Default values are used for parameters not provided.\n" }, "projectName": { "type": "string", "description": "Project to which the resource belongs; each resource can belong to only one project.\n" }, "recurrenceEndTime": { "type": "string", "description": "Cycle end time, applicable only to periodic tasks (Rate).\n" }, "repeatMode": { "type": "string", "description": "Set the command execution mode. Once: Default, executes the command immediately. Rate: Executes the command periodically; specify the execution cycle using the Frequency parameter and Rate expression. Fixed: Executes the command at a scheduled time; specify the execution time using the LaunchTime parameter.\n" }, "startTime": { "type": "string", "description": "Task start time.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InvocationTag:InvocationTag" } }, "timeout": { "type": "integer", "description": "Maximum timeout for command execution in ECS instances, in seconds. Default: 60. Optional range: 30–86400.\n" }, "username": { "type": "string", "description": "User name for executing the command in the ECS instance.\n" }, "windowsPassword": { "type": "string", "description": "Password for custom Windows user.\n" }, "workingDir": { "type": "string", "description": "Directory where the created command runs in the ECS instance.\n" } }, "required": [ "commandContent", "commandDescription", "commandId", "commandName", "commandProvider", "commandType", "enableParameter", "endTime", "frequency", "instanceIds", "instanceNumber", "invocationDescription", "invocationId", "invocationName", "invocationResults", "invocationStatus", "launchTime", "parameterDefinitions", "parameters", "projectName", "recurrenceEndTime", "repeatMode", "startTime", "tags", "timeout", "username", "windowsPassword", "workingDir" ], "inputProperties": { "commandId": { "type": "string", "description": "Command ID.\n" }, "frequency": { "type": "string", "description": "Execution frequency. This parameter is required when RepeatMode=Rate. Format: \\n\\n\\n\\n. Interval units supported: minutes (5m–60m), hours (1h–24h), and days (1d–7d). The interval is based on a fixed frequency and is independent of the actual job execution time. After job creation, it executes once based on LaunchTime, and the next execution time is determined by the interval setting.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "Instance ID list, supports up to 200 IDs.\n" }, "invocationDescription": { "type": "string", "description": "Job description. Defaults to an empty string and must not exceed 256 characters.\n" }, "invocationName": { "type": "string", "description": "Job name. Maximum 64 characters. No restriction on special characters. Job names can be duplicated within the same region.\n" }, "launchTime": { "type": "string", "description": "Execution time.\n" }, "parameters": { "type": "string", "description": "When the command includes custom parameters, use this parameter to pass custom parameter key-value pairs. The number of custom parameters ranges from 0 to 60. Key cannot be an empty string and supports up to 64 characters. Value can be an empty string. The combined length of custom parameters and original command content after Base64 encoding must not exceed 16 KB. The set of custom parameter names must be a subset of the parameter set defined when creating the command. Default values are used for parameters not provided.\n" }, "projectName": { "type": "string", "description": "Project to which the resource belongs; each resource can belong to only one project.\n" }, "recurrenceEndTime": { "type": "string", "description": "Cycle end time, applicable only to periodic tasks (Rate).\n" }, "repeatMode": { "type": "string", "description": "Set the command execution mode. Once: Default, executes the command immediately. Rate: Executes the command periodically; specify the execution cycle using the Frequency parameter and Rate expression. Fixed: Executes the command at a scheduled time; specify the execution time using the LaunchTime parameter.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InvocationTag:InvocationTag" } }, "timeout": { "type": "integer", "description": "Maximum timeout for command execution in ECS instances, in seconds. Default: 60. Optional range: 30–86400.\n" }, "username": { "type": "string", "description": "User name for executing the command in the ECS instance.\n" }, "windowsPassword": { "type": "string", "description": "Password for custom Windows user.\n" }, "workingDir": { "type": "string", "description": "Directory where the created command runs in the ECS instance.\n" } }, "requiredInputs": [ "commandId", "instanceIds", "invocationName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Invocation resources.\n", "properties": { "commandContent": { "type": "string", "description": "Command content.\n" }, "commandDescription": { "type": "string", "description": "Description of the invoked command.\n" }, "commandId": { "type": "string", "description": "Command ID.\n" }, "commandName": { "type": "string", "description": "Command name when the task is triggered.\n" }, "commandProvider": { "type": "string", "description": "Provider of the invoked command.\n" }, "commandType": { "type": "string", "description": "Command type triggered by the job.\n" }, "enableParameter": { "type": "boolean", "description": "Whether the invoked command uses custom parameters. true: enabled. false: not enabled.\n" }, "endTime": { "type": "string", "description": "Task end time.\n" }, "frequency": { "type": "string", "description": "Execution frequency. This parameter is required when RepeatMode=Rate. Format: \\n\\n\\n\\n. Interval units supported: minutes (5m–60m), hours (1h–24h), and days (1d–7d). The interval is based on a fixed frequency and is independent of the actual job execution time. After job creation, it executes once based on LaunchTime, and the next execution time is determined by the interval setting.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "Instance ID list, supports up to 200 IDs.\n" }, "instanceNumber": { "type": "integer", "description": "Number of instances executed.\n" }, "invocationDescription": { "type": "string", "description": "Job description. Defaults to an empty string and must not exceed 256 characters.\n" }, "invocationId": { "type": "string", "description": "Task execution ID.\n" }, "invocationName": { "type": "string", "description": "Job name. Maximum 64 characters. No restriction on special characters. Job names can be duplicated within the same region.\n" }, "invocationResults": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InvocationInvocationResult:InvocationInvocationResult" } }, "invocationStatus": { "type": "string", "description": "Overall execution status of the command.\n" }, "launchTime": { "type": "string", "description": "Execution time.\n" }, "parameterDefinitions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InvocationParameterDefinition:InvocationParameterDefinition" } }, "parameters": { "type": "string", "description": "When the command includes custom parameters, use this parameter to pass custom parameter key-value pairs. The number of custom parameters ranges from 0 to 60. Key cannot be an empty string and supports up to 64 characters. Value can be an empty string. The combined length of custom parameters and original command content after Base64 encoding must not exceed 16 KB. The set of custom parameter names must be a subset of the parameter set defined when creating the command. Default values are used for parameters not provided.\n" }, "projectName": { "type": "string", "description": "Project to which the resource belongs; each resource can belong to only one project.\n" }, "recurrenceEndTime": { "type": "string", "description": "Cycle end time, applicable only to periodic tasks (Rate).\n" }, "repeatMode": { "type": "string", "description": "Set the command execution mode. Once: Default, executes the command immediately. Rate: Executes the command periodically; specify the execution cycle using the Frequency parameter and Rate expression. Fixed: Executes the command at a scheduled time; specify the execution time using the LaunchTime parameter.\n" }, "startTime": { "type": "string", "description": "Task start time.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/InvocationTag:InvocationTag" } }, "timeout": { "type": "integer", "description": "Maximum timeout for command execution in ECS instances, in seconds. Default: 60. Optional range: 30–86400.\n" }, "username": { "type": "string", "description": "User name for executing the command in the ECS instance.\n" }, "windowsPassword": { "type": "string", "description": "Password for custom Windows user.\n" }, "workingDir": { "type": "string", "description": "Directory where the created command runs in the ECS instance.\n" } }, "type": "object" } }, "volcenginecc:ecs/keypair:Keypair": { "description": "ECS key pair (Keypair) is generated by default using the RSA 2048-bit encryption algorithm, producing a pair of associated keys: a public key and a private key. The public key is used to encrypt data, converting plaintext into unreadable ciphertext. The private key is the sole credential for decryption, restoring ciphertext to its original plaintext, ensuring secure authentication and data transmission.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst eCSKeypairDemo = new volcenginecc.ecs.Keypair(\"ECSKeypairDemo\", {\n keyPairName: \"ECSKeypairDemo\",\n projectName: \"default\",\n description: \"ECSKeypairDemo Description\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ne_cs_keypair_demo = volcenginecc.ecs.Keypair(\"ECSKeypairDemo\",\n key_pair_name=\"ECSKeypairDemo\",\n project_name=\"default\",\n description=\"ECSKeypairDemo Description\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var eCSKeypairDemo = new Volcenginecc.Ecs.Keypair(\"ECSKeypairDemo\", new()\n {\n KeyPairName = \"ECSKeypairDemo\",\n ProjectName = \"default\",\n Description = \"ECSKeypairDemo Description\",\n Tags = new[]\n {\n new Volcenginecc.Ecs.Inputs.KeypairTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/ecs\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ecs.NewKeypair(ctx, \"ECSKeypairDemo\", \u0026ecs.KeypairArgs{\n\t\t\tKeyPairName: pulumi.String(\"ECSKeypairDemo\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tDescription: pulumi.String(\"ECSKeypairDemo Description\"),\n\t\t\tTags: ecs.KeypairTagArray{\n\t\t\t\t\u0026ecs.KeypairTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.ecs.Keypair;\nimport com.volcengine.volcenginecc.ecs.KeypairArgs;\nimport com.pulumi.volcenginecc.ecs.inputs.KeypairTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var eCSKeypairDemo = new Keypair(\"eCSKeypairDemo\", KeypairArgs.builder()\n .keyPairName(\"ECSKeypairDemo\")\n .projectName(\"default\")\n .description(\"ECSKeypairDemo Description\")\n .tags(KeypairTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n eCSKeypairDemo:\n type: volcenginecc:ecs:Keypair\n name: ECSKeypairDemo\n properties:\n keyPairName: ECSKeypairDemo\n projectName: default\n description: ECSKeypairDemo Description\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ecs/keypair:Keypair example \"key_pair_name\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the key pair.\n" }, "description": { "type": "string", "description": "Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.\n" }, "fingerPrint": { "type": "string", "description": "Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "Instance ID for the operation.\n" }, "keyPairId": { "type": "string", "description": "Unique ID of the key pair.\n" }, "keyPairName": { "type": "string", "description": "Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.\n" }, "projectName": { "type": "string", "description": "Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.\n" }, "publicKey": { "type": "string", "description": "Public key information of the key pair.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/KeypairTag:KeypairTag" } }, "updatedTime": { "type": "string", "description": "Update time of the key pair.\n" } }, "required": [ "createdTime", "description", "fingerPrint", "instanceIds", "keyPairId", "keyPairName", "projectName", "publicKey", "tags", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "Instance ID for the operation.\n" }, "keyPairName": { "type": "string", "description": "Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.\n" }, "projectName": { "type": "string", "description": "Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.\n" }, "publicKey": { "type": "string", "description": "Public key information of the key pair.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/KeypairTag:KeypairTag" } } }, "requiredInputs": [ "keyPairName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Keypair resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the key pair.\n" }, "description": { "type": "string", "description": "Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.\n" }, "fingerPrint": { "type": "string", "description": "Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "Instance ID for the operation.\n" }, "keyPairId": { "type": "string", "description": "Unique ID of the key pair.\n" }, "keyPairName": { "type": "string", "description": "Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.\n" }, "projectName": { "type": "string", "description": "Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.\n" }, "publicKey": { "type": "string", "description": "Public key information of the key pair.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/KeypairTag:KeypairTag" } }, "updatedTime": { "type": "string", "description": "Update time of the key pair.\n" } }, "type": "object" } }, "volcenginecc:ecs/launchTemplate:LaunchTemplate": { "description": "An instance launch template is a collection of instance configuration information for quickly purchasing instances. You can store all configuration information except passwords in the template, including key pairs, compute specifications, cloud disks, networks, etc. If all configuration information is valid, you can purchase instances with one click without repeated configuration.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n ecsLaunchTemplateDemo:\n type: volcenginecc:ecs:LaunchTemplate\n name: EcsLaunchTemplateDemo\n properties:\n launchTemplateVersion:\n deployment_set_group_number: 0\n deployment_set_id: dps-ydzc5xxxxxxkak3c5b9vu\n description: ecs_launch_template test\n eip:\n bandwidth: 1\n bandwidthPackageId: bwp-1a1fvbxxxxxxvepl9jzfmf\n billingType: 0\n isp: BGP\n releaseWithInstance: true\n securityProtectionInstanceId: 0\n securityProtectionTypes:\n - AntiDDoS_Enhanced\n host_name: myname\n hpc_cluster_id: \"\"\n image_id: image-yzpvmk9xxxxxxgqcsdamq\n image_name: Ubuntu 24.04 with LLM Knowledge Base 64 bit\n instance_charge_type: PostPaid\n instance_name: ccapi-dx-0\n instance_type_id: ecs.g4i.large\n keep_image_credential: false\n key_pair_name: MigrationKey-job-yecd7dromy38dfaxgxt8\n network_interfaces:\n - securityGroupIds:\n - sg-1jolcljxxxxxxpe70vpx\n subnetId: subnet-btd4nhxxxxxxb2tl1jdsb\n project_name: default\n scheduled_instance:\n scheduledInstanceDescription: test\n scheduledInstanceName: test-template\n security_enhancement_strategy: Active\n spot_price_limit: 0\n spot_strategy: NoSpot\n suffix_index: 1\n tags:\n - key: env\n value: test\n unique_suffix: false\n user_data: ZWNobyBoZWxsbyBlY3Mh\n version_description: test\n volumes:\n - deleteWithInstance: true\n extraPerformanceIops: 0\n extraPerformanceThroughputMb: 0\n extraPerformanceTypeId: \"\"\n size: 50\n snapshotId: \"\"\n volumeType: ESSD_PL0\n vpc_id: vpc-1jolcldhxxxxxxq7yms\n zone_id: cn-beijing-a\n launchTemplateName: test\n launchTemplateProjectName: default\n launchTemplateTags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ecs/launchTemplate:LaunchTemplate example \"launch_template_id\"\n```\n\n", "properties": { "createdAt": { "type": "string", "description": "Instance launch template creation time\n" }, "defaultVersionNumber": { "type": "integer", "description": "Instance launch template default version number\n" }, "latestVersionNumber": { "type": "integer", "description": "Latest version number of the instance launch template.\n" }, "launchTemplateId": { "type": "string", "description": "Instance launch template ID\n" }, "launchTemplateName": { "type": "string", "description": "Instance launch template name.\n" }, "launchTemplateProjectName": { "type": "string", "description": "Project associated with the instance launch template.\n" }, "launchTemplateTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateTag:LaunchTemplateLaunchTemplateTag" } }, "launchTemplateVersion": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateVersion:LaunchTemplateLaunchTemplateVersion", "description": "Instance launch template version information\n" }, "updatedAt": { "type": "string", "description": "Instance launch template update time\n" } }, "required": [ "createdAt", "defaultVersionNumber", "latestVersionNumber", "launchTemplateId", "launchTemplateName", "launchTemplateProjectName", "launchTemplateTags", "launchTemplateVersion", "updatedAt" ], "inputProperties": { "defaultVersionNumber": { "type": "integer", "description": "Instance launch template default version number\n" }, "launchTemplateName": { "type": "string", "description": "Instance launch template name.\n" }, "launchTemplateProjectName": { "type": "string", "description": "Project associated with the instance launch template.\n" }, "launchTemplateTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateTag:LaunchTemplateLaunchTemplateTag" } }, "launchTemplateVersion": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateVersion:LaunchTemplateLaunchTemplateVersion", "description": "Instance launch template version information\n" } }, "requiredInputs": [ "launchTemplateName" ], "stateInputs": { "description": "Input properties used for looking up and filtering LaunchTemplate resources.\n", "properties": { "createdAt": { "type": "string", "description": "Instance launch template creation time\n" }, "defaultVersionNumber": { "type": "integer", "description": "Instance launch template default version number\n" }, "latestVersionNumber": { "type": "integer", "description": "Latest version number of the instance launch template.\n" }, "launchTemplateId": { "type": "string", "description": "Instance launch template ID\n" }, "launchTemplateName": { "type": "string", "description": "Instance launch template name.\n" }, "launchTemplateProjectName": { "type": "string", "description": "Project associated with the instance launch template.\n" }, "launchTemplateTags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateTag:LaunchTemplateLaunchTemplateTag" } }, "launchTemplateVersion": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateLaunchTemplateVersion:LaunchTemplateLaunchTemplateVersion", "description": "Instance launch template version information\n" }, "updatedAt": { "type": "string", "description": "Instance launch template update time\n" } }, "type": "object" } }, "volcenginecc:ecs/launchTemplateVersion:LaunchTemplateVersion": { "description": "Instance launch template version is a collection of instance configuration information used for quick instance purchase. In the template, you can store all configuration information except passwords, including key pairs, compute specifications, disks, network, etc. If all configuration information is valid, you can purchase an instance with one click without repeated configuration\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n ecsLaunchTemplateVersionDemo:\n type: volcenginecc:ecs:LaunchTemplateVersion\n name: EcsLaunchTemplateVersionDemo\n properties:\n deploymentSetGroupNumber: 0\n deploymentSetId: dps-ydzc5xxxxxx5b9vu\n description: ecs_launch_template_version test\n eip:\n bandwidth: 1\n bandwidth_package_id: bwp-1a1fvbxxxxxx8nvepl9jzfmf\n billing_type: 0\n isp: BGP\n release_with_instance: true\n security_protection_instance_id: 0\n security_protection_types:\n - AntiDDoS_Enhanced\n hostName: myname\n imageId: image-yzpvmxxxxxxgqcsdamq\n imageName: Ubuntu 24.04 with LLM Knowledge Base 64 bit\n instanceChargeType: PostPaid\n instanceName: test-version\n instanceTypeId: ecs.g4i.large\n keepImageCredential: false\n keyPairName: MigrationKey-job-yecd7dromy38dfaxgxt8\n launchTemplateId: lt-yefdzjlbxxxxxxylmkj\n networkInterfaces:\n - security_group_ids:\n - sg-1jolcljxxxxxx1n7ampe70vpx\n subnet_id: subnet-btd4nxxxxxxb2tl1jdsb\n projectName: default\n scheduledInstance:\n scheduled_instance_description: test\n scheduled_instance_name: test-template\n securityEnhancementStrategy: Active\n spotStrategy: NoSpot\n suffixIndex: 1\n tags:\n - key: env\n value: test\n uniqueSuffix: false\n userData: ZWNobyBoZWxsbyBlY3Mh\n versionDescription: test\n volumes:\n - delete_with_instance: true\n extra_performance_iops: 0\n extra_performance_throughput_mb: 0\n extra_performance_type_id: \"\"\n size: 50\n snapshot_id: \"\"\n volume_type: ESSD_PL0\n vpcId: vpc-1jolcldhxxxxxxmq5q7yms\n zoneId: cn-beijing-a\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:ecs/launchTemplateVersion:LaunchTemplateVersion example \"launch_template_id|version_number\"\n```\n\n", "properties": { "deploymentSetGroupNumber": { "type": "integer", "description": "When the deployment set policy for an ECS instance is set to AvailabilityGroup, use this parameter to specify the group number within the deployment set.\n" }, "deploymentSetId": { "type": "string", "description": "Deployment set ID to join for the instance.\n" }, "description": { "type": "string", "description": "Instance description.\n" }, "eip": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionEip:LaunchTemplateVersionEip", "description": "Public IP information bound to the instance.\n" }, "hostName": { "type": "string", "description": "Instance hostname. Linux hostname length: 2–59 characters. Windows hostname length: 2–10 characters\n" }, "hpcClusterId": { "type": "string", "description": "Specify the high-performance computing cluster ID when creating a high-performance computing GPU instance.\n" }, "imageId": { "type": "string", "description": "Image ID\n" }, "imageName": { "type": "string", "description": "Image name.\n" }, "instanceChargeType": { "type": "string", "description": "Billing type for the instance and cloud disk. Value: PostPaid: Pay-as-you-go. PrePaid: Subscription. Esi: Elastic reservation instance. Segmented: Time-segmented elastic reservation instance.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "instanceTypeId": { "type": "string", "description": "Instance specifications\n" }, "keepImageCredential": { "type": "boolean", "description": "Retain image settings. Value: true: Retain image settings. If retained, the preset password or key pair in the image will be used to log in to the instance. false (default): Do not retain image settings.\n" }, "keyPairName": { "type": "string", "description": "Key pair bound to the instance.\n" }, "launchTemplateId": { "type": "string", "description": "Instance launch template ID.\n" }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionNetworkInterface:LaunchTemplateVersionNetworkInterface" } }, "projectName": { "type": "string", "description": "Project to which the instance belongs.\n" }, "scheduledInstance": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionScheduledInstance:LaunchTemplateVersionScheduledInstance", "description": "Elastic reservation order information\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Enable security hardening. Active: Enable security hardening, effective only for public images. InActive: Disable security hardening, effective for all images.\n" }, "spotPriceLimit": { "type": "number", "description": "Maximum hourly price for preemptible instances.\n" }, "spotStrategy": { "type": "string", "description": "Preemptive strategy for pay-as-you-go billing. Values: NoSpot: Creates a standard pay-as-you-go instance. SpotAsPriceGo: System automatically bids, creating a preemptive instance that follows the current market price. SpotWithPriceLimit: Creates a preemptive instance with a bid limit\n" }, "suffixIndex": { "type": "integer", "description": "Starting sequence number for the ordered suffix.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionTag:LaunchTemplateVersionTag" } }, "uniqueSuffix": { "type": "boolean", "description": "Indicates whether to automatically add an ordered suffix to Hostname and InstanceName when creating multiple instances.\n" }, "userData": { "type": "string", "description": "Custom data for the instance.\n" }, "versionDescription": { "type": "string", "description": "Template version description.\n" }, "versionNumber": { "type": "string", "description": "Template version number.\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionVolume:LaunchTemplateVersionVolume" } }, "vpcId": { "type": "string", "description": "Private network ID\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the instance\n" } }, "required": [ "deploymentSetGroupNumber", "deploymentSetId", "description", "eip", "hostName", "hpcClusterId", "imageId", "imageName", "instanceChargeType", "instanceName", "instanceTypeId", "keepImageCredential", "keyPairName", "launchTemplateId", "networkInterfaces", "projectName", "scheduledInstance", "securityEnhancementStrategy", "spotPriceLimit", "spotStrategy", "suffixIndex", "tags", "uniqueSuffix", "userData", "versionDescription", "versionNumber", "volumes", "vpcId", "zoneId" ], "inputProperties": { "deploymentSetGroupNumber": { "type": "integer", "description": "When the deployment set policy for an ECS instance is set to AvailabilityGroup, use this parameter to specify the group number within the deployment set.\n" }, "deploymentSetId": { "type": "string", "description": "Deployment set ID to join for the instance.\n" }, "description": { "type": "string", "description": "Instance description.\n" }, "eip": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionEip:LaunchTemplateVersionEip", "description": "Public IP information bound to the instance.\n" }, "hostName": { "type": "string", "description": "Instance hostname. Linux hostname length: 2–59 characters. Windows hostname length: 2–10 characters\n" }, "hpcClusterId": { "type": "string", "description": "Specify the high-performance computing cluster ID when creating a high-performance computing GPU instance.\n" }, "imageId": { "type": "string", "description": "Image ID\n" }, "imageName": { "type": "string", "description": "Image name.\n" }, "instanceChargeType": { "type": "string", "description": "Billing type for the instance and cloud disk. Value: PostPaid: Pay-as-you-go. PrePaid: Subscription. Esi: Elastic reservation instance. Segmented: Time-segmented elastic reservation instance.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "instanceTypeId": { "type": "string", "description": "Instance specifications\n" }, "keepImageCredential": { "type": "boolean", "description": "Retain image settings. Value: true: Retain image settings. If retained, the preset password or key pair in the image will be used to log in to the instance. false (default): Do not retain image settings.\n" }, "keyPairName": { "type": "string", "description": "Key pair bound to the instance.\n" }, "launchTemplateId": { "type": "string", "description": "Instance launch template ID.\n" }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionNetworkInterface:LaunchTemplateVersionNetworkInterface" } }, "projectName": { "type": "string", "description": "Project to which the instance belongs.\n" }, "scheduledInstance": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionScheduledInstance:LaunchTemplateVersionScheduledInstance", "description": "Elastic reservation order information\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Enable security hardening. Active: Enable security hardening, effective only for public images. InActive: Disable security hardening, effective for all images.\n" }, "spotPriceLimit": { "type": "number", "description": "Maximum hourly price for preemptible instances.\n" }, "spotStrategy": { "type": "string", "description": "Preemptive strategy for pay-as-you-go billing. Values: NoSpot: Creates a standard pay-as-you-go instance. SpotAsPriceGo: System automatically bids, creating a preemptive instance that follows the current market price. SpotWithPriceLimit: Creates a preemptive instance with a bid limit\n" }, "suffixIndex": { "type": "integer", "description": "Starting sequence number for the ordered suffix.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionTag:LaunchTemplateVersionTag" } }, "uniqueSuffix": { "type": "boolean", "description": "Indicates whether to automatically add an ordered suffix to Hostname and InstanceName when creating multiple instances.\n" }, "userData": { "type": "string", "description": "Custom data for the instance.\n" }, "versionDescription": { "type": "string", "description": "Template version description.\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionVolume:LaunchTemplateVersionVolume" } }, "vpcId": { "type": "string", "description": "Private network ID\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the instance\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering LaunchTemplateVersion resources.\n", "properties": { "deploymentSetGroupNumber": { "type": "integer", "description": "When the deployment set policy for an ECS instance is set to AvailabilityGroup, use this parameter to specify the group number within the deployment set.\n" }, "deploymentSetId": { "type": "string", "description": "Deployment set ID to join for the instance.\n" }, "description": { "type": "string", "description": "Instance description.\n" }, "eip": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionEip:LaunchTemplateVersionEip", "description": "Public IP information bound to the instance.\n" }, "hostName": { "type": "string", "description": "Instance hostname. Linux hostname length: 2–59 characters. Windows hostname length: 2–10 characters\n" }, "hpcClusterId": { "type": "string", "description": "Specify the high-performance computing cluster ID when creating a high-performance computing GPU instance.\n" }, "imageId": { "type": "string", "description": "Image ID\n" }, "imageName": { "type": "string", "description": "Image name.\n" }, "instanceChargeType": { "type": "string", "description": "Billing type for the instance and cloud disk. Value: PostPaid: Pay-as-you-go. PrePaid: Subscription. Esi: Elastic reservation instance. Segmented: Time-segmented elastic reservation instance.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "instanceTypeId": { "type": "string", "description": "Instance specifications\n" }, "keepImageCredential": { "type": "boolean", "description": "Retain image settings. Value: true: Retain image settings. If retained, the preset password or key pair in the image will be used to log in to the instance. false (default): Do not retain image settings.\n" }, "keyPairName": { "type": "string", "description": "Key pair bound to the instance.\n" }, "launchTemplateId": { "type": "string", "description": "Instance launch template ID.\n" }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionNetworkInterface:LaunchTemplateVersionNetworkInterface" } }, "projectName": { "type": "string", "description": "Project to which the instance belongs.\n" }, "scheduledInstance": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionScheduledInstance:LaunchTemplateVersionScheduledInstance", "description": "Elastic reservation order information\n" }, "securityEnhancementStrategy": { "type": "string", "description": "Enable security hardening. Active: Enable security hardening, effective only for public images. InActive: Disable security hardening, effective for all images.\n" }, "spotPriceLimit": { "type": "number", "description": "Maximum hourly price for preemptible instances.\n" }, "spotStrategy": { "type": "string", "description": "Preemptive strategy for pay-as-you-go billing. Values: NoSpot: Creates a standard pay-as-you-go instance. SpotAsPriceGo: System automatically bids, creating a preemptive instance that follows the current market price. SpotWithPriceLimit: Creates a preemptive instance with a bid limit\n" }, "suffixIndex": { "type": "integer", "description": "Starting sequence number for the ordered suffix.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionTag:LaunchTemplateVersionTag" } }, "uniqueSuffix": { "type": "boolean", "description": "Indicates whether to automatically add an ordered suffix to Hostname and InstanceName when creating multiple instances.\n" }, "userData": { "type": "string", "description": "Custom data for the instance.\n" }, "versionDescription": { "type": "string", "description": "Template version description.\n" }, "versionNumber": { "type": "string", "description": "Template version number.\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:ecs/LaunchTemplateVersionVolume:LaunchTemplateVersionVolume" } }, "vpcId": { "type": "string", "description": "Private network ID\n" }, "zoneId": { "type": "string", "description": "Availability zone ID of the instance\n" } }, "type": "object" } }, "volcenginecc:efs/fileSystem:FileSystem": { "description": "A file system is a storage system that manages files through a directory tree structure. It is divided into local file systems and remote file systems. This refers specifically to remote file systems, which support concurrent access by multiple compute nodes and shared datasets.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n eFSFileSystemDemo:\n type: volcenginecc:efs:FileSystem\n name: EFSFileSystemDemo\n properties:\n fileSystemName: cc-test\n description: description\n chargeType: PayAsYouGo\n zoneId: cn-beijing-a\n instanceType: Premium\n performanceDensity: Premium_125\n projectName: default\n performance:\n bandwidth_mode: Provisioned\n provisioned_bandwidth: 300\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:efs/fileSystem:FileSystem example \"file_system_id\"\n```\n\n", "properties": { "accessPointLimit": { "type": "integer", "description": "Access point limit.\n" }, "chargeConfig": { "$ref": "#/types/volcenginecc:efs/FileSystemChargeConfig:FileSystemChargeConfig", "description": "File system billing configuration.\n" }, "chargeType": { "type": "string", "description": "Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.\n" }, "createTime": { "type": "string", "description": "File system creation time.\n" }, "description": { "type": "string", "description": "Description.\n" }, "downgradeUnlockTime": { "type": "string", "description": "Time when file system bandwidth can be downgraded.\n" }, "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "fileSystemName": { "type": "string", "description": "File system name.\n" }, "instanceType": { "type": "string", "description": "Basic: Basic type, Premium: Premium type.\n" }, "mountPointLimit": { "type": "integer", "description": "Mount point limit.\n" }, "performance": { "$ref": "#/types/volcenginecc:efs/FileSystemPerformance:FileSystemPerformance", "description": "File system performance information.\n" }, "performanceDensity": { "type": "string", "description": "File system performance density. Value description: Basic*50: Basic type 50MB/s/TiB, Premium*125: Premium type 125MB/s/TiB.\n" }, "projectName": { "type": "string", "description": "Project name.\n" }, "protocolTypes": { "type": "array", "items": { "type": "string" }, "description": "Protocol type.\n" }, "status": { "type": "string", "description": "File system status. Value description: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Stopped: Stopped.\n" }, "storage": { "$ref": "#/types/volcenginecc:efs/FileSystemStorage:FileSystemStorage", "description": "File system capacity information.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:efs/FileSystemTag:FileSystemTag" } }, "updateTime": { "type": "string", "description": "File system update time.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" }, "zoneName": { "type": "string", "description": "Availability zone name.\n" } }, "required": [ "accessPointLimit", "chargeConfig", "chargeType", "createTime", "description", "downgradeUnlockTime", "fileSystemId", "fileSystemName", "instanceType", "mountPointLimit", "performance", "performanceDensity", "projectName", "protocolTypes", "status", "storage", "tags", "updateTime", "zoneId", "zoneName" ], "inputProperties": { "chargeType": { "type": "string", "description": "Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.\n" }, "description": { "type": "string", "description": "Description.\n" }, "fileSystemName": { "type": "string", "description": "File system name.\n" }, "instanceType": { "type": "string", "description": "Basic: Basic type, Premium: Premium type.\n" }, "performance": { "$ref": "#/types/volcenginecc:efs/FileSystemPerformance:FileSystemPerformance", "description": "File system performance information.\n" }, "performanceDensity": { "type": "string", "description": "File system performance density. Value description: Basic*50: Basic type 50MB/s/TiB, Premium*125: Premium type 125MB/s/TiB.\n" }, "projectName": { "type": "string", "description": "Project name.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:efs/FileSystemTag:FileSystemTag" } }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "requiredInputs": [ "fileSystemName", "instanceType", "performance", "performanceDensity", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering FileSystem resources.\n", "properties": { "accessPointLimit": { "type": "integer", "description": "Access point limit.\n" }, "chargeConfig": { "$ref": "#/types/volcenginecc:efs/FileSystemChargeConfig:FileSystemChargeConfig", "description": "File system billing configuration.\n" }, "chargeType": { "type": "string", "description": "Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.\n" }, "createTime": { "type": "string", "description": "File system creation time.\n" }, "description": { "type": "string", "description": "Description.\n" }, "downgradeUnlockTime": { "type": "string", "description": "Time when file system bandwidth can be downgraded.\n" }, "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "fileSystemName": { "type": "string", "description": "File system name.\n" }, "instanceType": { "type": "string", "description": "Basic: Basic type, Premium: Premium type.\n" }, "mountPointLimit": { "type": "integer", "description": "Mount point limit.\n" }, "performance": { "$ref": "#/types/volcenginecc:efs/FileSystemPerformance:FileSystemPerformance", "description": "File system performance information.\n" }, "performanceDensity": { "type": "string", "description": "File system performance density. Value description: Basic*50: Basic type 50MB/s/TiB, Premium*125: Premium type 125MB/s/TiB.\n" }, "projectName": { "type": "string", "description": "Project name.\n" }, "protocolTypes": { "type": "array", "items": { "type": "string" }, "description": "Protocol type.\n" }, "status": { "type": "string", "description": "File system status. Value description: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Stopped: Stopped.\n" }, "storage": { "$ref": "#/types/volcenginecc:efs/FileSystemStorage:FileSystemStorage", "description": "File system capacity information.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:efs/FileSystemTag:FileSystemTag" } }, "updateTime": { "type": "string", "description": "File system update time.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" }, "zoneName": { "type": "string", "description": "Availability zone name.\n" } }, "type": "object" } }, "volcenginecc:emr/cluster:Cluster": { "description": "E-MapReduce (EMR) is an enterprise-grade big data analytics system based on the open-source Hadoop ecosystem. It is fully compatible with open source and provides integration and management for ecosystem components such as Hadoop, Spark, Hive, Hudi, and Iceberg.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n eMRClusterDemo:\n type: volcenginecc:emr:Cluster\n name: EMRClusterDemo\n properties:\n projectName: default\n clusterName: ccapi-tftest-1\n clusterType: Hadoop\n releaseVersion: 3.19.0\n applicationNames:\n - HDFS\n - YARN\n - SPARK3\n deployMode: SIMPLE\n securityMode: SIMPLE\n chargeType: POST\n vpcId: vpc-rrco37ovjq4gv0xxxxxxxxx\n securityGroupId: sg-1v9zvjkmx14w51j8xxxxxxxx\n historyServerMode: LOCAL\n nodeAttribute:\n zone_id: cn-beijing-a\n ecs_iam_role: VEECSforEMRRole\n nodeGroupAttributes:\n - zone_id: cn-beijing-a\n subnet_ids:\n - subnet-rrwqhg3qzxfkv0xxxxxxxx\n node_group_name: MasterGroup\n ecs_key_pair_name: pln-test\n ecs_password: \"\"\n bandwidth: 8\n charge_type: POST\n node_group_type: MASTER\n with_public_ip: false\n ecs_instance_types:\n - ecs.r1ie.xlarge\n node_count: 1\n system_disk:\n volumeType: ESSD_FlexPL\n size: 120\n data_disks:\n - volumeType: ESSD_FlexPL\n size: 80\n count: 1\n - zone_id: cn-beijing-a\n subnet_ids:\n - subnet-rrwqhg3qzxfkv0x5xxxxxx\n node_group_name: CoreGroup\n ecs_key_pair_name: pln-test\n ecs_password: \"\"\n bandwidth: 8\n charge_type: POST\n node_group_type: CORE\n with_public_ip: false\n ecs_instance_types:\n - ecs.r1ie.xlarge\n node_count: 2\n system_disk:\n volumeType: ESSD_FlexPL\n size: 80\n data_disks:\n - volumeType: ESSD_FlexPL\n size: 80\n count: 4\n - zone_id: cn-beijing-a\n subnet_ids:\n - subnet-rrwqhg3qzxfkv0xxxxxxxx\n node_group_name: TaskGroup-1\n ecs_key_pair_name: pln-test\n ecs_password: \"\"\n bandwidth: 8\n charge_type: POST\n node_group_type: TASK\n with_public_ip: false\n ecs_instance_types:\n - ecs.r1ie.xlarge\n node_count: 1\n system_disk:\n volumeType: ESSD_FlexPL\n size: 80\n data_disks:\n - volumeType: ESSD_FlexPL\n size: 80\n count: 4\n applicationExtras:\n - application_name: HIVE\n connection_type: BUILT_IN_MYSQL\n connection_id: \"\"\n application_configs:\n - configFileName: hive-site.xml\n configItemKey: hive.metastore.warehouse.dir\n configItemValue: tos://ccapi-test-tos-1/managed\n deleted: false\n componentInstanceName: \"\"\n componentName: \"\"\n effectiveScope:\n effectiveType: CLUSTER\n nodeGroupIds: []\n nodeGroupNames: []\n nodeGroupTypes: []\n nodeNames: []\n nodeIds: []\n componentNames: []\n - configFileName: hive-site.xml\n configItemKey: hive.metastore.warehouse.external.dir\n configItemValue: tos://ccapi-test-tos-1/external\n deleted: false\n componentInstanceName: \"\"\n componentName: \"\"\n effectiveScope:\n effectiveType: CLUSTER\n nodeGroupIds: []\n nodeGroupNames: []\n nodeGroupTypes: []\n nodeNames: []\n nodeIds: []\n componentNames: []\n - configFileName: hive-site.xml\n configItemKey: hive.metastore.warehouse.dir\n configItemValue: tos://ccapi-test-tos-1/managed\n deleted: false\n componentInstanceName: \"\"\n componentName: \"\"\n effectiveScope:\n effectiveType: CLUSTER\n nodeGroupIds: []\n nodeGroupNames: []\n nodeGroupTypes: []\n nodeNames: []\n nodeIds: []\n componentNames: []\n - configFileName: hive-site.xml\n configItemKey: hive.metastore.warehouse.external.dir\n configItemValue: tos://ccapi-test-tos-1/external\n deleted: false\n componentInstanceName: \"\"\n componentName: \"\"\n effectiveScope:\n effectiveType: CLUSTER\n nodeGroupIds: []\n nodeGroupNames: []\n nodeGroupTypes: []\n nodeNames: []\n nodeIds: []\n componentNames: []\n application_component_layouts:\n - componentName: \"\"\n effectiveScope:\n effectiveType: CLUSTER\n nodeGroupIds: []\n nodeGroupNames: []\n nodeGroupTypes: []\n nodeNames: []\n nodeIds: []\n componentNames: []\n bootstrapScripts:\n - script_name: ccapi-test-script\n script_type: BOOTSTRAP\n script_path: tos://ccapi-test-tos-1/managed/\n script_args: \"\"\n priority: '1'\n effective_scope:\n effectiveType: CLUSTER\n componentNames: []\n nodeGroupIds: []\n nodeGroupNames: []\n nodeGroupTypes: []\n nodeIds: []\n nodeNames: []\n execution_moment: AFTER_APPLICATION_STARTED\n execution_fail_strategy: FAILED_BLOCK\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:emr/cluster:Cluster example \"cluster_id\"\n```\n\n", "properties": { "accountId": { "type": "integer", "description": "Account ID.\n" }, "applicationExtras": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterApplicationExtra:ClusterApplicationExtra" } }, "applicationNames": { "type": "array", "items": { "type": "string" }, "description": "List of service names installed in the cluster. Creation-related field.\n" }, "applications": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterApplication:ClusterApplication" } }, "bootstrapScripts": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterBootstrapScript:ClusterBootstrapScript" } }, "chargePreConfig": { "$ref": "#/types/volcenginecc:emr/ClusterChargePreConfig:ClusterChargePreConfig", "description": "Monthly subscription configuration parameters. Required when chargeType=PRE.\n" }, "chargeType": { "type": "string", "description": "Payment type. PRE means monthly subscription, POST means pay-as-you-go.\n" }, "clusterDomainNames": { "type": "array", "items": { "type": "string" }, "description": "Cluster DNS domain suffix list.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "clusterName": { "type": "string", "description": "Cluster name.\n" }, "clusterState": { "type": "string", "description": "Cluster status.\n", "language": { "csharp": { "name": "ClusterStateValue" } } }, "clusterType": { "type": "string", "description": "Cluster type.\n" }, "createdTime": { "type": "integer", "description": "Cluster creation time.\n" }, "creatorId": { "type": "integer", "description": "Creator ID.\n" }, "creatorName": { "type": "string", "description": "Creator name.\n" }, "deployMode": { "type": "string", "description": "Deployment mode. SIMPLE means simple mode, HIGH_AVAILABLE means high availability mode.\n" }, "ecsImageId": { "type": "string", "description": "ECS image ID.\n" }, "expireTime": { "type": "integer", "description": "Cluster expiration time.\n" }, "historyServerMode": { "type": "string", "description": "HistoryServer mode: LOCAL stores active data within the cluster, PHS stores active data outside the cluster.\n" }, "nodeAttribute": { "$ref": "#/types/volcenginecc:emr/ClusterNodeAttribute:ClusterNodeAttribute", "description": "Cluster global node information.\n" }, "nodeGroupAttributes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterNodeGroupAttribute:ClusterNodeGroupAttribute" } }, "projectName": { "type": "string", "description": "Project to which the resource belongs. Default is 'default'. Each resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length is 64 characters.\n" }, "readyTime": { "type": "integer", "description": "Cluster creation completion time.\n" }, "releaseVersion": { "type": "string", "description": "Cluster version.\n" }, "securityGroupId": { "type": "string", "description": "Cluster global security group ID. All ECS in node groups will join this security group.\n" }, "securityMode": { "type": "string", "description": "Security mode.\n" }, "stateChangeReason": { "$ref": "#/types/volcenginecc:emr/ClusterStateChangeReason:ClusterStateChangeReason", "description": "Status change reason.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterTag:ClusterTag" } }, "terminateTime": { "type": "integer", "description": "Cluster termination time.\n" }, "vpcId": { "type": "string", "description": "Vpc ID。\n" } }, "required": [ "accountId", "applicationExtras", "applicationNames", "applications", "bootstrapScripts", "chargePreConfig", "chargeType", "clusterDomainNames", "clusterId", "clusterName", "clusterState", "clusterType", "createdTime", "creatorId", "creatorName", "deployMode", "ecsImageId", "expireTime", "historyServerMode", "nodeAttribute", "nodeGroupAttributes", "projectName", "readyTime", "releaseVersion", "securityGroupId", "securityMode", "stateChangeReason", "tags", "terminateTime", "vpcId" ], "inputProperties": { "applicationExtras": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterApplicationExtra:ClusterApplicationExtra" } }, "applicationNames": { "type": "array", "items": { "type": "string" }, "description": "List of service names installed in the cluster. Creation-related field.\n" }, "bootstrapScripts": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterBootstrapScript:ClusterBootstrapScript" } }, "chargePreConfig": { "$ref": "#/types/volcenginecc:emr/ClusterChargePreConfig:ClusterChargePreConfig", "description": "Monthly subscription configuration parameters. Required when chargeType=PRE.\n" }, "chargeType": { "type": "string", "description": "Payment type. PRE means monthly subscription, POST means pay-as-you-go.\n" }, "clusterName": { "type": "string", "description": "Cluster name.\n" }, "clusterType": { "type": "string", "description": "Cluster type.\n" }, "deployMode": { "type": "string", "description": "Deployment mode. SIMPLE means simple mode, HIGH_AVAILABLE means high availability mode.\n" }, "historyServerMode": { "type": "string", "description": "HistoryServer mode: LOCAL stores active data within the cluster, PHS stores active data outside the cluster.\n" }, "nodeAttribute": { "$ref": "#/types/volcenginecc:emr/ClusterNodeAttribute:ClusterNodeAttribute", "description": "Cluster global node information.\n" }, "nodeGroupAttributes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterNodeGroupAttribute:ClusterNodeGroupAttribute" } }, "projectName": { "type": "string", "description": "Project to which the resource belongs. Default is 'default'. Each resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length is 64 characters.\n" }, "releaseVersion": { "type": "string", "description": "Cluster version.\n" }, "securityGroupId": { "type": "string", "description": "Cluster global security group ID. All ECS in node groups will join this security group.\n" }, "securityMode": { "type": "string", "description": "Security mode.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterTag:ClusterTag" } }, "vpcId": { "type": "string", "description": "Vpc ID。\n" } }, "requiredInputs": [ "chargeType", "clusterName", "clusterType", "nodeAttribute", "releaseVersion", "securityGroupId", "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Cluster resources.\n", "properties": { "accountId": { "type": "integer", "description": "Account ID.\n" }, "applicationExtras": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterApplicationExtra:ClusterApplicationExtra" } }, "applicationNames": { "type": "array", "items": { "type": "string" }, "description": "List of service names installed in the cluster. Creation-related field.\n" }, "applications": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterApplication:ClusterApplication" } }, "bootstrapScripts": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterBootstrapScript:ClusterBootstrapScript" } }, "chargePreConfig": { "$ref": "#/types/volcenginecc:emr/ClusterChargePreConfig:ClusterChargePreConfig", "description": "Monthly subscription configuration parameters. Required when chargeType=PRE.\n" }, "chargeType": { "type": "string", "description": "Payment type. PRE means monthly subscription, POST means pay-as-you-go.\n" }, "clusterDomainNames": { "type": "array", "items": { "type": "string" }, "description": "Cluster DNS domain suffix list.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "clusterName": { "type": "string", "description": "Cluster name.\n" }, "clusterState": { "type": "string", "description": "Cluster status.\n", "language": { "csharp": { "name": "ClusterStateValue" } } }, "clusterType": { "type": "string", "description": "Cluster type.\n" }, "createdTime": { "type": "integer", "description": "Cluster creation time.\n" }, "creatorId": { "type": "integer", "description": "Creator ID.\n" }, "creatorName": { "type": "string", "description": "Creator name.\n" }, "deployMode": { "type": "string", "description": "Deployment mode. SIMPLE means simple mode, HIGH_AVAILABLE means high availability mode.\n" }, "ecsImageId": { "type": "string", "description": "ECS image ID.\n" }, "expireTime": { "type": "integer", "description": "Cluster expiration time.\n" }, "historyServerMode": { "type": "string", "description": "HistoryServer mode: LOCAL stores active data within the cluster, PHS stores active data outside the cluster.\n" }, "nodeAttribute": { "$ref": "#/types/volcenginecc:emr/ClusterNodeAttribute:ClusterNodeAttribute", "description": "Cluster global node information.\n" }, "nodeGroupAttributes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterNodeGroupAttribute:ClusterNodeGroupAttribute" } }, "projectName": { "type": "string", "description": "Project to which the resource belongs. Default is 'default'. Each resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length is 64 characters.\n" }, "readyTime": { "type": "integer", "description": "Cluster creation completion time.\n" }, "releaseVersion": { "type": "string", "description": "Cluster version.\n" }, "securityGroupId": { "type": "string", "description": "Cluster global security group ID. All ECS in node groups will join this security group.\n" }, "securityMode": { "type": "string", "description": "Security mode.\n" }, "stateChangeReason": { "$ref": "#/types/volcenginecc:emr/ClusterStateChangeReason:ClusterStateChangeReason", "description": "Status change reason.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/ClusterTag:ClusterTag" } }, "terminateTime": { "type": "integer", "description": "Cluster termination time.\n" }, "vpcId": { "type": "string", "description": "Vpc ID。\n" } }, "type": "object" } }, "volcenginecc:emr/clusterUser:ClusterUser": { "description": "Users in an E-MapReduce (EMR) cluster are divided into regular users and system users. Regular users are added to the cluster manually through import or creation in the user management module. System users are built-in management users for each component created during cluster initialization and cannot be edited or deleted.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst eMRClusterUserDemo = new volcenginecc.emr.ClusterUser(\"EMRClusterUserDemo\", {\n clusterId: \"emr-xxxxxxxxxx\",\n userName: \"emrclusteruserdemo\",\n password: \"UserDemo1234\",\n userGroupNames: [\n \"users\",\n \"ccapi\",\n ],\n description: \"EMRClusterUserDemo\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ne_mr_cluster_user_demo = volcenginecc.emr.ClusterUser(\"EMRClusterUserDemo\",\n cluster_id=\"emr-xxxxxxxxxx\",\n user_name=\"emrclusteruserdemo\",\n password=\"UserDemo1234\",\n user_group_names=[\n \"users\",\n \"ccapi\",\n ],\n description=\"EMRClusterUserDemo\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var eMRClusterUserDemo = new Volcenginecc.Emr.ClusterUser(\"EMRClusterUserDemo\", new()\n {\n ClusterId = \"emr-xxxxxxxxxx\",\n UserName = \"emrclusteruserdemo\",\n Password = \"UserDemo1234\",\n UserGroupNames = new[]\n {\n \"users\",\n \"ccapi\",\n },\n Description = \"EMRClusterUserDemo\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/emr\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := emr.NewClusterUser(ctx, \"EMRClusterUserDemo\", \u0026emr.ClusterUserArgs{\n\t\t\tClusterId: pulumi.String(\"emr-xxxxxxxxxx\"),\n\t\t\tUserName: pulumi.String(\"emrclusteruserdemo\"),\n\t\t\tPassword: pulumi.String(\"UserDemo1234\"),\n\t\t\tUserGroupNames: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"users\"),\n\t\t\t\tpulumi.String(\"ccapi\"),\n\t\t\t},\n\t\t\tDescription: pulumi.String(\"EMRClusterUserDemo\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.emr.ClusterUser;\nimport com.volcengine.volcenginecc.emr.ClusterUserArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var eMRClusterUserDemo = new ClusterUser(\"eMRClusterUserDemo\", ClusterUserArgs.builder()\n .clusterId(\"emr-xxxxxxxxxx\")\n .userName(\"emrclusteruserdemo\")\n .password(\"UserDemo1234\")\n .userGroupNames( \n \"users\",\n \"ccapi\")\n .description(\"EMRClusterUserDemo\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n eMRClusterUserDemo:\n type: volcenginecc:emr:ClusterUser\n name: EMRClusterUserDemo\n properties:\n clusterId: emr-xxxxxxxxxx\n userName: emrclusteruserdemo\n password: UserDemo1234\n userGroupNames:\n - users\n - ccapi\n description: EMRClusterUserDemo\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:emr/clusterUser:ClusterUser example \"cluster_id|user_name\"\n```\n\n", "properties": { "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "createdTime": { "type": "integer", "description": "Creation time.\n" }, "creatorName": { "type": "string", "description": "Creator username.\n" }, "description": { "type": "string", "description": "User group description.\n" }, "oldPassword": { "type": "string", "description": "Old user login password. Required when changing password.\n" }, "password": { "type": "string", "description": "New user login password. Password must be 8–20 characters long, support numbers, letters, -, _, and contain at least one number and one letter.\n" }, "updatedTime": { "type": "integer", "description": "Last updated time.\n" }, "userGroupNames": { "type": "array", "items": { "type": "string" }, "description": "User group name.\n" }, "userName": { "type": "string", "description": "Cluster username. Only lowercase letters are supported.\n" } }, "required": [ "clusterId", "createdTime", "creatorName", "description", "oldPassword", "password", "updatedTime", "userGroupNames", "userName" ], "inputProperties": { "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "description": { "type": "string", "description": "User group description.\n" }, "oldPassword": { "type": "string", "description": "Old user login password. Required when changing password.\n" }, "password": { "type": "string", "description": "New user login password. Password must be 8–20 characters long, support numbers, letters, -, _, and contain at least one number and one letter.\n" }, "userGroupNames": { "type": "array", "items": { "type": "string" }, "description": "User group name.\n" }, "userName": { "type": "string", "description": "Cluster username. Only lowercase letters are supported.\n" } }, "requiredInputs": [ "clusterId", "password", "userName" ], "stateInputs": { "description": "Input properties used for looking up and filtering ClusterUser resources.\n", "properties": { "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "createdTime": { "type": "integer", "description": "Creation time.\n" }, "creatorName": { "type": "string", "description": "Creator username.\n" }, "description": { "type": "string", "description": "User group description.\n" }, "oldPassword": { "type": "string", "description": "Old user login password. Required when changing password.\n" }, "password": { "type": "string", "description": "New user login password. Password must be 8–20 characters long, support numbers, letters, -, _, and contain at least one number and one letter.\n" }, "updatedTime": { "type": "integer", "description": "Last updated time.\n" }, "userGroupNames": { "type": "array", "items": { "type": "string" }, "description": "User group name.\n" }, "userName": { "type": "string", "description": "Cluster username. Only lowercase letters are supported.\n" } }, "type": "object" } }, "volcenginecc:emr/clusterUserGroup:ClusterUserGroup": { "description": "User group management is supported in E-MapReduce (EMR) clusters, allowing you to create, edit, and delete user groups.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst eMRClusterUserGroupDemo = new volcenginecc.emr.ClusterUserGroup(\"EMRClusterUserGroupDemo\", {\n clusterId: \"emr-xxxxxxxxxx\",\n userGroupName: \"ccapi-tf-users-2\",\n description: \"EMRClusterUserGroupDemo\",\n members: [\n \"emrclusteruserdemo1\",\n \"emrclusteruserdemo3\",\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ne_mr_cluster_user_group_demo = volcenginecc.emr.ClusterUserGroup(\"EMRClusterUserGroupDemo\",\n cluster_id=\"emr-xxxxxxxxxx\",\n user_group_name=\"ccapi-tf-users-2\",\n description=\"EMRClusterUserGroupDemo\",\n members=[\n \"emrclusteruserdemo1\",\n \"emrclusteruserdemo3\",\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var eMRClusterUserGroupDemo = new Volcenginecc.Emr.ClusterUserGroup(\"EMRClusterUserGroupDemo\", new()\n {\n ClusterId = \"emr-xxxxxxxxxx\",\n UserGroupName = \"ccapi-tf-users-2\",\n Description = \"EMRClusterUserGroupDemo\",\n Members = new[]\n {\n \"emrclusteruserdemo1\",\n \"emrclusteruserdemo3\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/emr\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := emr.NewClusterUserGroup(ctx, \"EMRClusterUserGroupDemo\", \u0026emr.ClusterUserGroupArgs{\n\t\t\tClusterId: pulumi.String(\"emr-xxxxxxxxxx\"),\n\t\t\tUserGroupName: pulumi.String(\"ccapi-tf-users-2\"),\n\t\t\tDescription: pulumi.String(\"EMRClusterUserGroupDemo\"),\n\t\t\tMembers: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"emrclusteruserdemo1\"),\n\t\t\t\tpulumi.String(\"emrclusteruserdemo3\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.emr.ClusterUserGroup;\nimport com.volcengine.volcenginecc.emr.ClusterUserGroupArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var eMRClusterUserGroupDemo = new ClusterUserGroup(\"eMRClusterUserGroupDemo\", ClusterUserGroupArgs.builder()\n .clusterId(\"emr-xxxxxxxxxx\")\n .userGroupName(\"ccapi-tf-users-2\")\n .description(\"EMRClusterUserGroupDemo\")\n .members( \n \"emrclusteruserdemo1\",\n \"emrclusteruserdemo3\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n eMRClusterUserGroupDemo:\n type: volcenginecc:emr:ClusterUserGroup\n name: EMRClusterUserGroupDemo\n properties:\n clusterId: emr-xxxxxxxxxx\n userGroupName: ccapi-tf-users-2\n description: EMRClusterUserGroupDemo\n members:\n - emrclusteruserdemo1\n - emrclusteruserdemo3\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:emr/clusterUserGroup:ClusterUserGroup example \"cluster_id|user_group_name\"\n```\n\n", "properties": { "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "description": { "type": "string", "description": "User group description.\n" }, "members": { "type": "array", "items": { "type": "string" }, "description": "Operations on special users, such as admin, are not supported.\n" }, "userGroupName": { "type": "string", "description": "User group name.\n" } }, "required": [ "clusterId", "description", "members", "userGroupName" ], "inputProperties": { "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "description": { "type": "string", "description": "User group description.\n" }, "members": { "type": "array", "items": { "type": "string" }, "description": "Operations on special users, such as admin, are not supported.\n" }, "userGroupName": { "type": "string", "description": "User group name.\n" } }, "requiredInputs": [ "clusterId", "userGroupName" ], "stateInputs": { "description": "Input properties used for looking up and filtering ClusterUserGroup resources.\n", "properties": { "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "description": { "type": "string", "description": "User group description.\n" }, "members": { "type": "array", "items": { "type": "string" }, "description": "Operations on special users, such as admin, are not supported.\n" }, "userGroupName": { "type": "string", "description": "User group name.\n" } }, "type": "object" } }, "volcenginecc:emr/nodeGroup:NodeGroup": { "description": "An E-MapReduce cluster consists of multiple types of instance nodes, including master instance nodes (Master), core instance nodes (Core), and task instance nodes (Task). Different service processes are deployed on each node type, and each is responsible for different tasks.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n eMRNodeGroupDemo:\n type: volcenginecc:emr:NodeGroup\n name: EMRNodeGroupDemo\n properties:\n clusterId: emr-cluster-123456789xxxxx\n zoneId: cn-beijing-a\n nodeGroupName: CoreGroup-1002\n nodeGroupType: CORE\n withPublicIp: false\n targetDiskSize: 120\n nodeCount: 2\n chargeType: POST\n ecsInstanceTypes:\n - ecs.r1ie.xlarge\n subnetIds:\n - subnet-rrwqhg3qzxfkv0xxxxxxx\n systemDisk:\n volume_type: ESSD_FlexPL\n size: 120\n dataDisks:\n - volume_type: ESSD_FlexPL\n size: 80\n count: 1\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:emr/nodeGroup:NodeGroup example \"cluster_id|node_group_id\"\n```\n\n", "properties": { "applicationLayouts": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/NodeGroupApplicationLayout:NodeGroupApplicationLayout" } }, "chargePreConfig": { "$ref": "#/types/volcenginecc:emr/NodeGroupChargePreConfig:NodeGroupChargePreConfig", "description": "Subscription payment configuration.\n" }, "chargeType": { "type": "string", "description": "Payment type. PRE indicates monthly subscription, POST indicates pay-as-you-go.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "createdTime": { "type": "integer", "description": "Creation time.\n" }, "dataDisks": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/NodeGroupDataDisk:NodeGroupDataDisk" } }, "ecsInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "ECS instance specification list. Currently, only a single instance specification can be modified.\n" }, "layoutComponentNames": { "type": "array", "items": { "type": "string" }, "description": "Custom configuration parameter list for the returned node group components.\n" }, "nodeCount": { "type": "integer", "description": "Node count. Value range: 1~1000.\n" }, "nodeGroupId": { "type": "string", "description": "Node group ID.\n" }, "nodeGroupName": { "type": "string", "description": "Node group name.\n" }, "nodeGroupState": { "type": "string", "description": "Node group status. RUNNING: Running. EXTENDING: Expanding. REDUCING: Shrinking. DISK_EXTENDING: Disk expansion. MODIFYING: Configuration modification in progress.\n", "language": { "csharp": { "name": "NodeGroupStateValue" } } }, "nodeGroupType": { "type": "string", "description": "Node group type.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/NodeGroupNode:NodeGroupNode" } }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID list.\n" }, "systemDisk": { "$ref": "#/types/volcenginecc:emr/NodeGroupSystemDisk:NodeGroupSystemDisk", "description": "System disk.\n" }, "targetDiskSize": { "type": "integer", "description": "Target disk size for expansion. Minimum 60GB, maximum 2048GB, unit: GB.\n" }, "terminateTime": { "type": "string", "description": "Cluster termination time.\n" }, "withPublicIp": { "type": "boolean", "description": "Whether the ECS instance includes a public IP.\n" }, "zoneId": { "type": "string", "description": "zoneId. If empty, the cluster's zoneId is reused by default.\n" } }, "required": [ "applicationLayouts", "chargePreConfig", "chargeType", "clusterId", "createdTime", "dataDisks", "ecsInstanceTypes", "layoutComponentNames", "nodeCount", "nodeGroupId", "nodeGroupName", "nodeGroupState", "nodeGroupType", "nodes", "subnetIds", "systemDisk", "targetDiskSize", "terminateTime", "withPublicIp", "zoneId" ], "inputProperties": { "applicationLayouts": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/NodeGroupApplicationLayout:NodeGroupApplicationLayout" } }, "chargePreConfig": { "$ref": "#/types/volcenginecc:emr/NodeGroupChargePreConfig:NodeGroupChargePreConfig", "description": "Subscription payment configuration.\n" }, "chargeType": { "type": "string", "description": "Payment type. PRE indicates monthly subscription, POST indicates pay-as-you-go.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "dataDisks": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/NodeGroupDataDisk:NodeGroupDataDisk" } }, "ecsInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "ECS instance specification list. Currently, only a single instance specification can be modified.\n" }, "nodeCount": { "type": "integer", "description": "Node count. Value range: 1~1000.\n" }, "nodeGroupName": { "type": "string", "description": "Node group name.\n" }, "nodeGroupType": { "type": "string", "description": "Node group type.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID list.\n" }, "systemDisk": { "$ref": "#/types/volcenginecc:emr/NodeGroupSystemDisk:NodeGroupSystemDisk", "description": "System disk.\n" }, "targetDiskSize": { "type": "integer", "description": "Target disk size for expansion. Minimum 60GB, maximum 2048GB, unit: GB.\n" }, "withPublicIp": { "type": "boolean", "description": "Whether the ECS instance includes a public IP.\n" }, "zoneId": { "type": "string", "description": "zoneId. If empty, the cluster's zoneId is reused by default.\n" } }, "requiredInputs": [ "chargeType", "clusterId", "nodeCount", "nodeGroupName", "nodeGroupType" ], "stateInputs": { "description": "Input properties used for looking up and filtering NodeGroup resources.\n", "properties": { "applicationLayouts": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/NodeGroupApplicationLayout:NodeGroupApplicationLayout" } }, "chargePreConfig": { "$ref": "#/types/volcenginecc:emr/NodeGroupChargePreConfig:NodeGroupChargePreConfig", "description": "Subscription payment configuration.\n" }, "chargeType": { "type": "string", "description": "Payment type. PRE indicates monthly subscription, POST indicates pay-as-you-go.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "createdTime": { "type": "integer", "description": "Creation time.\n" }, "dataDisks": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/NodeGroupDataDisk:NodeGroupDataDisk" } }, "ecsInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "ECS instance specification list. Currently, only a single instance specification can be modified.\n" }, "layoutComponentNames": { "type": "array", "items": { "type": "string" }, "description": "Custom configuration parameter list for the returned node group components.\n" }, "nodeCount": { "type": "integer", "description": "Node count. Value range: 1~1000.\n" }, "nodeGroupId": { "type": "string", "description": "Node group ID.\n" }, "nodeGroupName": { "type": "string", "description": "Node group name.\n" }, "nodeGroupState": { "type": "string", "description": "Node group status. RUNNING: Running. EXTENDING: Expanding. REDUCING: Shrinking. DISK_EXTENDING: Disk expansion. MODIFYING: Configuration modification in progress.\n", "language": { "csharp": { "name": "NodeGroupStateValue" } } }, "nodeGroupType": { "type": "string", "description": "Node group type.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:emr/NodeGroupNode:NodeGroupNode" } }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "Subnet ID list.\n" }, "systemDisk": { "$ref": "#/types/volcenginecc:emr/NodeGroupSystemDisk:NodeGroupSystemDisk", "description": "System disk.\n" }, "targetDiskSize": { "type": "integer", "description": "Target disk size for expansion. Minimum 60GB, maximum 2048GB, unit: GB.\n" }, "terminateTime": { "type": "string", "description": "Cluster termination time.\n" }, "withPublicIp": { "type": "boolean", "description": "Whether the ECS instance includes a public IP.\n" }, "zoneId": { "type": "string", "description": "zoneId. If empty, the cluster's zoneId is reused by default.\n" } }, "type": "object" } }, "volcenginecc:escloud/instance:Instance": { "description": "Cloud Search Service is a fully managed, one-stop information retrieval and analytics platform compatible with Elasticsearch, OpenSearch, Kibana, Dashboards, Cerebro, and common open-source plugins. It supports scenarios such as full-text search, vector search, hybrid search, AI search, and spatiotemporal retrieval. With Cloud Search Service, you can deploy with one click, scale elastically, simplify operations, and quickly build log analysis and information retrieval analytics for real-world business.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n eSCloudInstanceDemo:\n type: volcenginecc:escloud:Instance\n name: ESCloudInstanceDemo\n properties:\n instanceConfiguration:\n vpc:\n vpcId: vpc-1a1vgeo93xxxg8nvepjyxxxxx\n vpcName: ESCloudInstanceDemo-vpc\n subnet:\n subnetId: subnet-3nrb3atxxxf40931eb4xxxxx\n subnetName: ESCloudInstanceDemo-Subnet\n zone_id: cn-beijing-d\n version: V7_10\n region_id: cn-beijing\n charge_type: PostPaid\n enable_https: true\n project_name: default\n instance_name: ESCloudInstanceDemo\n enable_pure_master: true\n node_specs_assigns:\n - type: Hot\n number: 1\n storageSize: 100\n storageSpecName: es.volume.essd.pl0\n resourceSpecName: es.x2.medium\n extraPerformance:\n throughput: 0\n - type: Master\n number: 3\n storageSize: 20\n storageSpecName: es.volume.essd.pl0\n resourceSpecName: es.x2.medium\n extraPerformance:\n throughput: 0\n - type: Kibana\n number: 1\n storageSize: 0\n storageSpecName: \"\"\n resourceSpecName: kibana.x2.small\n extraPerformance:\n throughput: 0\n configuration_code: es.standard\n deletion_protection: true\n network_specs:\n - type: Elasticsearch\n bandwidth: 1\n isOpen: true\n specName: es.eip.bgp_fixed_bandwidth\n - type: Kibana\n bandwidth: 1\n isOpen: true\n specName: es.eip.bgp_fixed_bandwidth\n admin_password: '********'\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:escloud/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "cerebroEnabled": { "type": "boolean", "description": "Whether to enable cerebro. true: enable cerebro; false: do not enable cerebro.\n" }, "cerebroPrivateDomain": { "type": "string", "description": "Cerebro private network access address. Note: Cerebro and Kibana share the domain name. For legacy instances, the access address may start with http(s)://kibana-***\n" }, "cerebroPublicDomain": { "type": "string", "description": "Cerebro public access address. Note: Cerebro and Kibana share the same domain name. For legacy instances, the access address may start with http(s)://kibana-***\n" }, "chargeEnabled": { "type": "boolean", "description": "Whether billing is enabled for the instance. Value description: true: Billing enabled false: Billing not enabled\n" }, "clusterId": { "type": "string", "description": "ID of the cluster to which the instance belongs.\n" }, "createTime": { "type": "string", "description": "Instance creation time.\n" }, "enableEsPrivateDomainPublic": { "type": "boolean", "description": "Whether the instance has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses\n" }, "enableEsPrivateNetwork": { "type": "boolean", "description": "Whether private network access is enabled for the instance. true: Default, private network access enabled; false: private network access not enabled.\n" }, "enableEsPublicNetwork": { "type": "boolean", "description": "Whether the instance has enabled public access. true: Public access enabled. false: Public access not enabled\n" }, "enableKibanaPrivateDomainPublic": { "type": "boolean", "description": "Whether Kibana has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses\n" }, "enableKibanaPrivateNetwork": { "type": "boolean", "description": "Whether Kibana private network access is enabled. true: Default value, private network access enabled false: Kibana private network access not enabled\n" }, "enableKibanaPublicNetwork": { "type": "boolean", "description": "Whether Kibana has enabled public access. true: Public access enabled false: Public access not enabled\n" }, "esEip": { "type": "string", "description": "EIP bound to the instance.\n" }, "esEipId": { "type": "string", "description": "ID of the EIP bound to the instance\n" }, "esPrivateEndpoint": { "type": "string", "description": "Instance private network access address.\n" }, "esPrivateIpAllowList": { "type": "string", "description": "Instance private network address access allowlist. Same as ESPrivateIpWhitelist\n" }, "esPrivateIpWhitelist": { "type": "string", "description": "Instance private network address access allowlist\n" }, "esPubBandwidth": { "type": "integer", "description": "ES public network bandwidth, unit: Mbps.\n" }, "esPublicEndpoint": { "type": "string", "description": "Instance public access address\n" }, "esPublicIpAllowList": { "type": "string", "description": "Instance public IP address access allowlist. Same as ESPublicIpWhitelist\n" }, "esPublicIpWhitelist": { "type": "string", "description": "Allowlist for instance public network address access.\n" }, "expireDate": { "type": "string", "description": "Expiration time for subscription instance payment\n" }, "instanceConfiguration": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfiguration:InstanceInstanceConfiguration", "description": "Instance configuration details\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "kibanaConfig": { "$ref": "#/types/volcenginecc:escloud/InstanceKibanaConfig:InstanceKibanaConfig", "description": "Kibana parameter configuration\n" }, "kibanaEip": { "type": "string", "description": "EIP bound to Kibana\n" }, "kibanaEipId": { "type": "string", "description": "ID of the EIP bound to Kibana.\n" }, "kibanaPrivateDomain": { "type": "string", "description": "Kibana private network access address. Note: For historical instances, the access address may start with http(s)://kibana-***.\n" }, "kibanaPrivateIpAllowList": { "type": "string", "description": "Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPrivateIpWhitelist.\n" }, "kibanaPrivateIpWhitelist": { "type": "string", "description": "Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist.\n" }, "kibanaPubBandwidth": { "type": "integer", "description": "Kibana public network bandwidth, unit: Mbps\n" }, "kibanaPublicDomain": { "type": "string", "description": "Kibana public access address. Note: For legacy instances, the access address may start with http(s)://kibana-***\n" }, "kibanaPublicIpAllowList": { "type": "string", "description": "Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPublicIpWhitelist\n" }, "kibanaPublicIpWhitelist": { "type": "string", "description": "Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist\n" }, "mainZoneId": { "type": "string", "description": "Primary availability zone\n" }, "maintenanceDays": { "type": "array", "items": { "type": "string" }, "description": "Instance maintenance date.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window.\n" }, "status": { "type": "string", "description": "Current instance status\n" }, "subInstanceEnable": { "type": "string", "description": "Sub-instance activation status\n" }, "subInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:escloud/InstanceSubInstance:InstanceSubInstance" } }, "supportColdNode": { "type": "boolean", "description": "Whether cold nodes are supported\n" }, "totalNodes": { "type": "integer", "description": "Total number of nodes in the instance\n" }, "transferInfo": { "$ref": "#/types/volcenginecc:escloud/InstanceTransferInfo:InstanceTransferInfo", "description": "Data migration task information\n" }, "userId": { "type": "string", "description": "Instance owner's user ID\n" } }, "required": [ "cerebroEnabled", "cerebroPrivateDomain", "cerebroPublicDomain", "chargeEnabled", "clusterId", "createTime", "enableEsPrivateDomainPublic", "enableEsPrivateNetwork", "enableEsPublicNetwork", "enableKibanaPrivateDomainPublic", "enableKibanaPrivateNetwork", "enableKibanaPublicNetwork", "esEip", "esEipId", "esPrivateEndpoint", "esPrivateIpAllowList", "esPrivateIpWhitelist", "esPubBandwidth", "esPublicEndpoint", "esPublicIpAllowList", "esPublicIpWhitelist", "expireDate", "instanceConfiguration", "instanceId", "kibanaConfig", "kibanaEip", "kibanaEipId", "kibanaPrivateDomain", "kibanaPrivateIpAllowList", "kibanaPrivateIpWhitelist", "kibanaPubBandwidth", "kibanaPublicDomain", "kibanaPublicIpAllowList", "kibanaPublicIpWhitelist", "mainZoneId", "maintenanceDays", "maintenanceTime", "status", "subInstanceEnable", "subInstances", "supportColdNode", "totalNodes", "transferInfo", "userId" ], "inputProperties": { "instanceConfiguration": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfiguration:InstanceInstanceConfiguration", "description": "Instance configuration details\n" }, "maintenanceDays": { "type": "array", "items": { "type": "string" }, "description": "Instance maintenance date.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window.\n" } }, "requiredInputs": [ "instanceConfiguration" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "cerebroEnabled": { "type": "boolean", "description": "Whether to enable cerebro. true: enable cerebro; false: do not enable cerebro.\n" }, "cerebroPrivateDomain": { "type": "string", "description": "Cerebro private network access address. Note: Cerebro and Kibana share the domain name. For legacy instances, the access address may start with http(s)://kibana-***\n" }, "cerebroPublicDomain": { "type": "string", "description": "Cerebro public access address. Note: Cerebro and Kibana share the same domain name. For legacy instances, the access address may start with http(s)://kibana-***\n" }, "chargeEnabled": { "type": "boolean", "description": "Whether billing is enabled for the instance. Value description: true: Billing enabled false: Billing not enabled\n" }, "clusterId": { "type": "string", "description": "ID of the cluster to which the instance belongs.\n" }, "createTime": { "type": "string", "description": "Instance creation time.\n" }, "enableEsPrivateDomainPublic": { "type": "boolean", "description": "Whether the instance has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses\n" }, "enableEsPrivateNetwork": { "type": "boolean", "description": "Whether private network access is enabled for the instance. true: Default, private network access enabled; false: private network access not enabled.\n" }, "enableEsPublicNetwork": { "type": "boolean", "description": "Whether the instance has enabled public access. true: Public access enabled. false: Public access not enabled\n" }, "enableKibanaPrivateDomainPublic": { "type": "boolean", "description": "Whether Kibana has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses\n" }, "enableKibanaPrivateNetwork": { "type": "boolean", "description": "Whether Kibana private network access is enabled. true: Default value, private network access enabled false: Kibana private network access not enabled\n" }, "enableKibanaPublicNetwork": { "type": "boolean", "description": "Whether Kibana has enabled public access. true: Public access enabled false: Public access not enabled\n" }, "esEip": { "type": "string", "description": "EIP bound to the instance.\n" }, "esEipId": { "type": "string", "description": "ID of the EIP bound to the instance\n" }, "esPrivateEndpoint": { "type": "string", "description": "Instance private network access address.\n" }, "esPrivateIpAllowList": { "type": "string", "description": "Instance private network address access allowlist. Same as ESPrivateIpWhitelist\n" }, "esPrivateIpWhitelist": { "type": "string", "description": "Instance private network address access allowlist\n" }, "esPubBandwidth": { "type": "integer", "description": "ES public network bandwidth, unit: Mbps.\n" }, "esPublicEndpoint": { "type": "string", "description": "Instance public access address\n" }, "esPublicIpAllowList": { "type": "string", "description": "Instance public IP address access allowlist. Same as ESPublicIpWhitelist\n" }, "esPublicIpWhitelist": { "type": "string", "description": "Allowlist for instance public network address access.\n" }, "expireDate": { "type": "string", "description": "Expiration time for subscription instance payment\n" }, "instanceConfiguration": { "$ref": "#/types/volcenginecc:escloud/InstanceInstanceConfiguration:InstanceInstanceConfiguration", "description": "Instance configuration details\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "kibanaConfig": { "$ref": "#/types/volcenginecc:escloud/InstanceKibanaConfig:InstanceKibanaConfig", "description": "Kibana parameter configuration\n" }, "kibanaEip": { "type": "string", "description": "EIP bound to Kibana\n" }, "kibanaEipId": { "type": "string", "description": "ID of the EIP bound to Kibana.\n" }, "kibanaPrivateDomain": { "type": "string", "description": "Kibana private network access address. Note: For historical instances, the access address may start with http(s)://kibana-***.\n" }, "kibanaPrivateIpAllowList": { "type": "string", "description": "Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPrivateIpWhitelist.\n" }, "kibanaPrivateIpWhitelist": { "type": "string", "description": "Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist.\n" }, "kibanaPubBandwidth": { "type": "integer", "description": "Kibana public network bandwidth, unit: Mbps\n" }, "kibanaPublicDomain": { "type": "string", "description": "Kibana public access address. Note: For legacy instances, the access address may start with http(s)://kibana-***\n" }, "kibanaPublicIpAllowList": { "type": "string", "description": "Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPublicIpWhitelist\n" }, "kibanaPublicIpWhitelist": { "type": "string", "description": "Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist\n" }, "mainZoneId": { "type": "string", "description": "Primary availability zone\n" }, "maintenanceDays": { "type": "array", "items": { "type": "string" }, "description": "Instance maintenance date.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window.\n" }, "status": { "type": "string", "description": "Current instance status\n" }, "subInstanceEnable": { "type": "string", "description": "Sub-instance activation status\n" }, "subInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:escloud/InstanceSubInstance:InstanceSubInstance" } }, "supportColdNode": { "type": "boolean", "description": "Whether cold nodes are supported\n" }, "totalNodes": { "type": "integer", "description": "Total number of nodes in the instance\n" }, "transferInfo": { "$ref": "#/types/volcenginecc:escloud/InstanceTransferInfo:InstanceTransferInfo", "description": "Data migration task information\n" }, "userId": { "type": "string", "description": "Instance owner's user ID\n" } }, "type": "object" } }, "volcenginecc:filenas/instance:Instance": { "description": "The file system provides file storage services through the standard NFS protocol for remote network file access. After creating a mount point in the management console, you can access the file system on your client as needed using the standard POSIX interface\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst fileNASInstanceDemo = new volcenginecc.filenas.Instance(\"FileNASInstanceDemo\", {\n fileSystemName: \"FileNASInstanceDemo\",\n capacity: {\n total: 105,\n },\n chargeType: \"PayAsYouGo\",\n fileSystemType: \"Extreme\",\n protocolType: \"NFS\",\n zoneId: \"cn-beijing-x\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nfile_nas_instance_demo = volcenginecc.filenas.Instance(\"FileNASInstanceDemo\",\n file_system_name=\"FileNASInstanceDemo\",\n capacity={\n \"total\": 105,\n },\n charge_type=\"PayAsYouGo\",\n file_system_type=\"Extreme\",\n protocol_type=\"NFS\",\n zone_id=\"cn-beijing-x\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var fileNASInstanceDemo = new Volcenginecc.Filenas.Instance(\"FileNASInstanceDemo\", new()\n {\n FileSystemName = \"FileNASInstanceDemo\",\n Capacity = new Volcenginecc.Filenas.Inputs.InstanceCapacityArgs\n {\n Total = 105,\n },\n ChargeType = \"PayAsYouGo\",\n FileSystemType = \"Extreme\",\n ProtocolType = \"NFS\",\n ZoneId = \"cn-beijing-x\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/filenas\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := filenas.NewInstance(ctx, \"FileNASInstanceDemo\", \u0026filenas.InstanceArgs{\n\t\t\tFileSystemName: pulumi.String(\"FileNASInstanceDemo\"),\n\t\t\tCapacity: \u0026filenas.InstanceCapacityArgs{\n\t\t\t\tTotal: pulumi.Float64(105),\n\t\t\t},\n\t\t\tChargeType: pulumi.String(\"PayAsYouGo\"),\n\t\t\tFileSystemType: pulumi.String(\"Extreme\"),\n\t\t\tProtocolType: pulumi.String(\"NFS\"),\n\t\t\tZoneId: pulumi.String(\"cn-beijing-x\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.filenas.Instance;\nimport com.volcengine.volcenginecc.filenas.InstanceArgs;\nimport com.pulumi.volcenginecc.filenas.inputs.InstanceCapacityArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var fileNASInstanceDemo = new Instance(\"fileNASInstanceDemo\", InstanceArgs.builder()\n .fileSystemName(\"FileNASInstanceDemo\")\n .capacity(InstanceCapacityArgs.builder()\n .total(105.0)\n .build())\n .chargeType(\"PayAsYouGo\")\n .fileSystemType(\"Extreme\")\n .protocolType(\"NFS\")\n .zoneId(\"cn-beijing-x\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n fileNASInstanceDemo:\n type: volcenginecc:filenas:Instance\n name: FileNASInstanceDemo\n properties:\n fileSystemName: FileNASInstanceDemo\n capacity:\n total: 105\n chargeType: PayAsYouGo\n fileSystemType: Extreme\n protocolType: NFS\n zoneId: cn-beijing-x\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:filenas/instance:Instance example \"file_system_id\"\n```\n\n", "properties": { "cachePerformance": { "$ref": "#/types/volcenginecc:filenas/InstanceCachePerformance:InstanceCachePerformance", "description": "Cache performance information\n" }, "capacity": { "$ref": "#/types/volcenginecc:filenas/InstanceCapacity:InstanceCapacity", "description": "File system capacity\n" }, "chargeType": { "type": "string", "description": "Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing\n" }, "createTime": { "type": "string", "description": "Creation time\n" }, "description": { "type": "string", "description": "Description\n" }, "fileSystemId": { "type": "string", "description": "File system ID\n" }, "fileSystemName": { "type": "string", "description": "File system name\n" }, "fileSystemType": { "type": "string", "description": "File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type\n" }, "projectName": { "type": "string", "description": "Project, default value is the Default project\n" }, "protocolType": { "type": "string", "description": "File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients\n" }, "snapshotCount": { "type": "integer", "description": "Number of snapshots\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot\n" }, "status": { "type": "string", "description": "File system status. Possible values: Unknown: Status unknown. Running: File system running. Creating: File system being created. Expanding: File system being upgraded. Error: File system error. Deleting: File system being deleted. DeleteError: File system deletion failed. Deleted: File system deleted. Stopped: File system stopped.\n" }, "storageType": { "type": "string", "description": "Storage type. Value: Standard, indicates standard type\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:filenas/InstanceTag:InstanceTag" } }, "updateTime": { "type": "string", "description": "Update time\n" }, "zoneId": { "type": "string", "description": "Availability Zone ID\n" }, "zoneName": { "type": "string", "description": "Availability Zone name\n" } }, "required": [ "cachePerformance", "capacity", "chargeType", "createTime", "description", "fileSystemId", "fileSystemName", "fileSystemType", "projectName", "protocolType", "snapshotCount", "snapshotId", "status", "storageType", "tags", "updateTime", "zoneId", "zoneName" ], "inputProperties": { "cachePerformance": { "$ref": "#/types/volcenginecc:filenas/InstanceCachePerformance:InstanceCachePerformance", "description": "Cache performance information\n" }, "capacity": { "$ref": "#/types/volcenginecc:filenas/InstanceCapacity:InstanceCapacity", "description": "File system capacity\n" }, "chargeType": { "type": "string", "description": "Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing\n" }, "description": { "type": "string", "description": "Description\n" }, "fileSystemName": { "type": "string", "description": "File system name\n" }, "fileSystemType": { "type": "string", "description": "File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type\n" }, "projectName": { "type": "string", "description": "Project, default value is the Default project\n" }, "protocolType": { "type": "string", "description": "File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot\n" }, "storageType": { "type": "string", "description": "Storage type. Value: Standard, indicates standard type\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:filenas/InstanceTag:InstanceTag" } }, "zoneId": { "type": "string", "description": "Availability Zone ID\n" } }, "requiredInputs": [ "chargeType", "fileSystemName", "fileSystemType", "protocolType", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "cachePerformance": { "$ref": "#/types/volcenginecc:filenas/InstanceCachePerformance:InstanceCachePerformance", "description": "Cache performance information\n" }, "capacity": { "$ref": "#/types/volcenginecc:filenas/InstanceCapacity:InstanceCapacity", "description": "File system capacity\n" }, "chargeType": { "type": "string", "description": "Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing\n" }, "createTime": { "type": "string", "description": "Creation time\n" }, "description": { "type": "string", "description": "Description\n" }, "fileSystemId": { "type": "string", "description": "File system ID\n" }, "fileSystemName": { "type": "string", "description": "File system name\n" }, "fileSystemType": { "type": "string", "description": "File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type\n" }, "projectName": { "type": "string", "description": "Project, default value is the Default project\n" }, "protocolType": { "type": "string", "description": "File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients\n" }, "snapshotCount": { "type": "integer", "description": "Number of snapshots\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot\n" }, "status": { "type": "string", "description": "File system status. Possible values: Unknown: Status unknown. Running: File system running. Creating: File system being created. Expanding: File system being upgraded. Error: File system error. Deleting: File system being deleted. DeleteError: File system deletion failed. Deleted: File system deleted. Stopped: File system stopped.\n" }, "storageType": { "type": "string", "description": "Storage type. Value: Standard, indicates standard type\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:filenas/InstanceTag:InstanceTag" } }, "updateTime": { "type": "string", "description": "Update time\n" }, "zoneId": { "type": "string", "description": "Availability Zone ID\n" }, "zoneName": { "type": "string", "description": "Availability Zone name\n" } }, "type": "object" } }, "volcenginecc:filenas/mountPoint:MountPoint": { "description": "Mount point is the connection point for the NAS file system in a network environment. The NAS file system must be mounted on a compute node to enable data access and storage. Mounting is the operation that connects the compute node to the NAS file system.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst fileNASMountPointDemo = new volcenginecc.filenas.MountPoint(\"FileNASMountPointDemo\", {\n fileSystemId: \"enas-cnbja0f8*****\",\n mountPointName: \"test-1\",\n permissionGroupId: \"pgroup-01bc1182\",\n subnetId: \"subnet-btepcsc5*****\",\n vpcId: \"vpc-3nr6adcn064u8931*****\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nfile_nas_mount_point_demo = volcenginecc.filenas.MountPoint(\"FileNASMountPointDemo\",\n file_system_id=\"enas-cnbja0f8*****\",\n mount_point_name=\"test-1\",\n permission_group_id=\"pgroup-01bc1182\",\n subnet_id=\"subnet-btepcsc5*****\",\n vpc_id=\"vpc-3nr6adcn064u8931*****\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var fileNASMountPointDemo = new Volcenginecc.Filenas.MountPoint(\"FileNASMountPointDemo\", new()\n {\n FileSystemId = \"enas-cnbja0f8*****\",\n MountPointName = \"test-1\",\n PermissionGroupId = \"pgroup-01bc1182\",\n SubnetId = \"subnet-btepcsc5*****\",\n VpcId = \"vpc-3nr6adcn064u8931*****\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/filenas\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := filenas.NewMountPoint(ctx, \"FileNASMountPointDemo\", \u0026filenas.MountPointArgs{\n\t\t\tFileSystemId: pulumi.String(\"enas-cnbja0f8*****\"),\n\t\t\tMountPointName: pulumi.String(\"test-1\"),\n\t\t\tPermissionGroupId: pulumi.String(\"pgroup-01bc1182\"),\n\t\t\tSubnetId: pulumi.String(\"subnet-btepcsc5*****\"),\n\t\t\tVpcId: pulumi.String(\"vpc-3nr6adcn064u8931*****\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.filenas.MountPoint;\nimport com.volcengine.volcenginecc.filenas.MountPointArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var fileNASMountPointDemo = new MountPoint(\"fileNASMountPointDemo\", MountPointArgs.builder()\n .fileSystemId(\"enas-cnbja0f8*****\")\n .mountPointName(\"test-1\")\n .permissionGroupId(\"pgroup-01bc1182\")\n .subnetId(\"subnet-btepcsc5*****\")\n .vpcId(\"vpc-3nr6adcn064u8931*****\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n fileNASMountPointDemo:\n type: volcenginecc:filenas:MountPoint\n name: FileNASMountPointDemo\n properties:\n fileSystemId: enas-cnbja0f8*****\n mountPointName: test-1\n permissionGroupId: pgroup-01bc1182\n subnetId: subnet-btepcsc5*****\n vpcId: vpc-3nr6adcn064u8931*****\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:filenas/mountPoint:MountPoint example \"file_system_id|mount_point_id\"\n```\n\n", "properties": { "clients": { "type": "array", "items": { "$ref": "#/types/volcenginecc:filenas/MountPointClient:MountPointClient" } }, "createdTime": { "type": "string", "description": "Mount point creation time.\n" }, "domain": { "type": "string", "description": "DNS address.\n" }, "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "ip": { "type": "string", "description": "Mount point address.\n" }, "mountPointId": { "type": "string", "description": "Mount point ID.\n" }, "mountPointName": { "type": "string", "description": "Mount point name.\n" }, "permissionGroup": { "$ref": "#/types/volcenginecc:filenas/MountPointPermissionGroup:MountPointPermissionGroup", "description": "Permission group information bound to the mount point.\n" }, "permissionGroupId": { "type": "string", "description": "Permission group ID.\n" }, "status": { "type": "string", "description": "Mount point status. Values: Running: Running. Creating: Creating. Updating: Updating. Error: Error. Deleting: Deleting. DeleteError: Delete error. Deleted: Deleted. Stopped: Stopped.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "subnetName": { "type": "string", "description": "Subnet name.\n" }, "updatedTime": { "type": "string", "description": "Mount point update time.\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "vpcName": { "type": "string", "description": "Private network name.\n" } }, "required": [ "clients", "createdTime", "domain", "fileSystemId", "ip", "mountPointId", "mountPointName", "permissionGroup", "permissionGroupId", "status", "subnetId", "subnetName", "updatedTime", "vpcId", "vpcName" ], "inputProperties": { "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "mountPointName": { "type": "string", "description": "Mount point name.\n" }, "permissionGroupId": { "type": "string", "description": "Permission group ID.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" } }, "requiredInputs": [ "fileSystemId", "mountPointName", "permissionGroupId", "subnetId", "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering MountPoint resources.\n", "properties": { "clients": { "type": "array", "items": { "$ref": "#/types/volcenginecc:filenas/MountPointClient:MountPointClient" } }, "createdTime": { "type": "string", "description": "Mount point creation time.\n" }, "domain": { "type": "string", "description": "DNS address.\n" }, "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "ip": { "type": "string", "description": "Mount point address.\n" }, "mountPointId": { "type": "string", "description": "Mount point ID.\n" }, "mountPointName": { "type": "string", "description": "Mount point name.\n" }, "permissionGroup": { "$ref": "#/types/volcenginecc:filenas/MountPointPermissionGroup:MountPointPermissionGroup", "description": "Permission group information bound to the mount point.\n" }, "permissionGroupId": { "type": "string", "description": "Permission group ID.\n" }, "status": { "type": "string", "description": "Mount point status. Values: Running: Running. Creating: Creating. Updating: Updating. Error: Error. Deleting: Deleting. DeleteError: Delete error. Deleted: Deleted. Stopped: Stopped.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "subnetName": { "type": "string", "description": "Subnet name.\n" }, "updatedTime": { "type": "string", "description": "Mount point update time.\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "vpcName": { "type": "string", "description": "Private network name.\n" } }, "type": "object" } }, "volcenginecc:filenas/snapshot:Snapshot": { "description": "A snapshot is a backup method. Each snapshot is a backup of file storage at a specific point in time. If data is lost or a failure occurs, you can use snapshots to restore file storage and recover lost data\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst fileNASSnapshotDemo = new volcenginecc.filenas.Snapshot(\"FileNASSnapshotDemo\", {\n fileSystemId: \"enas-apse1a059****\",\n snapshotName: \"FileNASSnapshotDemo\",\n description: \"FileNASSnapshotDemo description\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nfile_nas_snapshot_demo = volcenginecc.filenas.Snapshot(\"FileNASSnapshotDemo\",\n file_system_id=\"enas-apse1a059****\",\n snapshot_name=\"FileNASSnapshotDemo\",\n description=\"FileNASSnapshotDemo description\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var fileNASSnapshotDemo = new Volcenginecc.Filenas.Snapshot(\"FileNASSnapshotDemo\", new()\n {\n FileSystemId = \"enas-apse1a059****\",\n SnapshotName = \"FileNASSnapshotDemo\",\n Description = \"FileNASSnapshotDemo description\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/filenas\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := filenas.NewSnapshot(ctx, \"FileNASSnapshotDemo\", \u0026filenas.SnapshotArgs{\n\t\t\tFileSystemId: pulumi.String(\"enas-apse1a059****\"),\n\t\t\tSnapshotName: pulumi.String(\"FileNASSnapshotDemo\"),\n\t\t\tDescription: pulumi.String(\"FileNASSnapshotDemo description\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.filenas.Snapshot;\nimport com.volcengine.volcenginecc.filenas.SnapshotArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var fileNASSnapshotDemo = new Snapshot(\"fileNASSnapshotDemo\", SnapshotArgs.builder()\n .fileSystemId(\"enas-apse1a059****\")\n .snapshotName(\"FileNASSnapshotDemo\")\n .description(\"FileNASSnapshotDemo description\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n fileNASSnapshotDemo:\n type: volcenginecc:filenas:Snapshot\n name: FileNASSnapshotDemo\n properties:\n fileSystemId: enas-apse1a059****\n snapshotName: FileNASSnapshotDemo\n description: FileNASSnapshotDemo description\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:filenas/snapshot:Snapshot example \"snapshot_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Snapshot Creation Time\n" }, "description": { "type": "string", "description": "Snapshot Description\n" }, "fileSystemId": { "type": "string", "description": "File System ID\n" }, "fileSystemName": { "type": "string", "description": "File System Name\n" }, "isEncrypt": { "type": "boolean", "description": "Is encryption enabled. Currently only false is supported (not encrypted)\n" }, "progress": { "type": "string", "description": "Snapshot Creation Progress\n" }, "retentionDays": { "type": "integer", "description": "Snapshot Retention Period. Default is 2147483647 (permanent retention)\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID\n" }, "snapshotName": { "type": "string", "description": "Snapshot Name\n" }, "snapshotType": { "type": "string", "description": "Snapshot Type. Default is Manual (manual snapshot)\n" }, "sourceSize": { "type": "integer", "description": "File System Capacity (GiB)\n" }, "sourceVersion": { "type": "string", "description": "File System Version\n" }, "status": { "type": "string", "description": "Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed\n" }, "zoneId": { "type": "string", "description": "Availability Zone ID\n" } }, "required": [ "createdTime", "description", "fileSystemId", "fileSystemName", "isEncrypt", "progress", "retentionDays", "snapshotId", "snapshotName", "snapshotType", "sourceSize", "sourceVersion", "status", "zoneId" ], "inputProperties": { "description": { "type": "string", "description": "Snapshot Description\n" }, "fileSystemId": { "type": "string", "description": "File System ID\n" }, "snapshotName": { "type": "string", "description": "Snapshot Name\n" } }, "requiredInputs": [ "fileSystemId", "snapshotName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Snapshot resources.\n", "properties": { "createdTime": { "type": "string", "description": "Snapshot Creation Time\n" }, "description": { "type": "string", "description": "Snapshot Description\n" }, "fileSystemId": { "type": "string", "description": "File System ID\n" }, "fileSystemName": { "type": "string", "description": "File System Name\n" }, "isEncrypt": { "type": "boolean", "description": "Is encryption enabled. Currently only false is supported (not encrypted)\n" }, "progress": { "type": "string", "description": "Snapshot Creation Progress\n" }, "retentionDays": { "type": "integer", "description": "Snapshot Retention Period. Default is 2147483647 (permanent retention)\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID\n" }, "snapshotName": { "type": "string", "description": "Snapshot Name\n" }, "snapshotType": { "type": "string", "description": "Snapshot Type. Default is Manual (manual snapshot)\n" }, "sourceSize": { "type": "integer", "description": "File System Capacity (GiB)\n" }, "sourceVersion": { "type": "string", "description": "File System Version\n" }, "status": { "type": "string", "description": "Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed\n" }, "zoneId": { "type": "string", "description": "Availability Zone ID\n" } }, "type": "object" } }, "volcenginecc:fwcenter/dnsControlPolicy:DnsControlPolicy": { "description": "Domain denylist access control policy.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n fWCenterDnsControlPolicyDemo:\n type: volcenginecc:fwcenter:DnsControlPolicy\n name: FWCenterDnsControlPolicyDemo\n properties:\n description: FWCenterDnsControlPolicyDemo test\n destination: www.xxxx.com\n destinationType: domain\n internetFirewallId: ifw-yebxxxxx0iac7gxxxxx\n sources:\n - region: cn-beijing\n vpc_id: vpc-3rehw4xxxxk2ixxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:fwcenter/dnsControlPolicy:DnsControlPolicy example \"rule_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "User's unique identifier.\n" }, "description": { "type": "string", "description": "Policy description information.\n" }, "destination": { "type": "string", "description": "Access target, which can be the unique identifier of a domain or domain address book. Currently, only one address book is supported.\n" }, "destinationGroupLists": { "type": "array", "items": { "type": "string" }, "description": "Domain address book name list.\n" }, "destinationType": { "type": "string", "description": "Type of access target. domain: domain; group: domain address book.\n" }, "domainListV1s": { "type": "array", "items": { "$ref": "#/types/volcenginecc:fwcenter/DnsControlPolicyDomainListV1:DnsControlPolicyDomainListV1" } }, "domainLists": { "type": "array", "items": { "type": "string" }, "description": "Domain list.\n" }, "hitCnt": { "type": "integer", "description": "Hit count, indicating the number of times the domain denylist access control policy was triggered.\n" }, "internetFirewallId": { "type": "string", "description": "Internet border firewall instance ID.\n" }, "lastHitTime": { "type": "integer", "description": "Latest hit timestamp, indicating the last time the domain denylist access control policy was triggered.\n" }, "ruleId": { "type": "string", "description": "Unique identifier of the access control policy.\n" }, "sources": { "type": "array", "items": { "$ref": "#/types/volcenginecc:fwcenter/DnsControlPolicySource:DnsControlPolicySource" } }, "status": { "type": "boolean", "description": "Switch status of the domain denylist access control policy. false: Off; true: On.\n" }, "useCount": { "type": "integer", "description": "Number of policies occupied by this domain denylist access control policy.\n" } }, "required": [ "accountId", "description", "destination", "destinationGroupLists", "destinationType", "domainLists", "domainListV1s", "hitCnt", "internetFirewallId", "lastHitTime", "ruleId", "sources", "status", "useCount" ], "inputProperties": { "description": { "type": "string", "description": "Policy description information.\n" }, "destination": { "type": "string", "description": "Access target, which can be the unique identifier of a domain or domain address book. Currently, only one address book is supported.\n" }, "destinationType": { "type": "string", "description": "Type of access target. domain: domain; group: domain address book.\n" }, "internetFirewallId": { "type": "string", "description": "Internet border firewall instance ID.\n" }, "sources": { "type": "array", "items": { "$ref": "#/types/volcenginecc:fwcenter/DnsControlPolicySource:DnsControlPolicySource" } }, "status": { "type": "boolean", "description": "Switch status of the domain denylist access control policy. false: Off; true: On.\n" } }, "requiredInputs": [ "destination", "destinationType" ], "stateInputs": { "description": "Input properties used for looking up and filtering DnsControlPolicy resources.\n", "properties": { "accountId": { "type": "string", "description": "User's unique identifier.\n" }, "description": { "type": "string", "description": "Policy description information.\n" }, "destination": { "type": "string", "description": "Access target, which can be the unique identifier of a domain or domain address book. Currently, only one address book is supported.\n" }, "destinationGroupLists": { "type": "array", "items": { "type": "string" }, "description": "Domain address book name list.\n" }, "destinationType": { "type": "string", "description": "Type of access target. domain: domain; group: domain address book.\n" }, "domainListV1s": { "type": "array", "items": { "$ref": "#/types/volcenginecc:fwcenter/DnsControlPolicyDomainListV1:DnsControlPolicyDomainListV1" } }, "domainLists": { "type": "array", "items": { "type": "string" }, "description": "Domain list.\n" }, "hitCnt": { "type": "integer", "description": "Hit count, indicating the number of times the domain denylist access control policy was triggered.\n" }, "internetFirewallId": { "type": "string", "description": "Internet border firewall instance ID.\n" }, "lastHitTime": { "type": "integer", "description": "Latest hit timestamp, indicating the last time the domain denylist access control policy was triggered.\n" }, "ruleId": { "type": "string", "description": "Unique identifier of the access control policy.\n" }, "sources": { "type": "array", "items": { "$ref": "#/types/volcenginecc:fwcenter/DnsControlPolicySource:DnsControlPolicySource" } }, "status": { "type": "boolean", "description": "Switch status of the domain denylist access control policy. false: Off; true: On.\n" }, "useCount": { "type": "integer", "description": "Number of policies occupied by this domain denylist access control policy.\n" } }, "type": "object" } }, "volcenginecc:hbase/instance:Instance": { "description": "Table Database HBase Edition is a fully managed NoSQL service based on Apache HBase, compatible with the standard HBase access protocol, offering advantages such as low-cost storage and high scalability throughput.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst hBaseInstanceDemo = new volcenginecc.hbase.Instance(\"HBaseInstanceDemo\", {\n regionId: \"cn-beijing\",\n multiAz: false,\n zoneId: \"cn-beijing-a\",\n instanceName: \"HBaseInstanceDemo\",\n engineVersion: \"HBase_2.0\",\n instanceType: \"Standard\",\n masterSpec: \"hbase.x1.medium\",\n rsCount: 2,\n rsSpec: \"hbase.x1.large\",\n storageCapacity: 20000,\n vpcId: \"vpc-rrco37ovjq4gv0x5xxxxx\",\n projectName: \"default\",\n chargeType: \"PrePaid\",\n purchaseMonths: 1,\n autoRenew: false,\n subnetId: \"subnet-rrwqhg3qzxfkv0x57xxxxx\",\n deletionProtection: \"disabled\",\n enableCloudStorage: false,\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n storageType: \"HdfsSsd\",\n enableAuth: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nh_base_instance_demo = volcenginecc.hbase.Instance(\"HBaseInstanceDemo\",\n region_id=\"cn-beijing\",\n multi_az=False,\n zone_id=\"cn-beijing-a\",\n instance_name=\"HBaseInstanceDemo\",\n engine_version=\"HBase_2.0\",\n instance_type=\"Standard\",\n master_spec=\"hbase.x1.medium\",\n rs_count=2,\n rs_spec=\"hbase.x1.large\",\n storage_capacity=20000,\n vpc_id=\"vpc-rrco37ovjq4gv0x5xxxxx\",\n project_name=\"default\",\n charge_type=\"PrePaid\",\n purchase_months=1,\n auto_renew=False,\n subnet_id=\"subnet-rrwqhg3qzxfkv0x57xxxxx\",\n deletion_protection=\"disabled\",\n enable_cloud_storage=False,\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }],\n storage_type=\"HdfsSsd\",\n enable_auth=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var hBaseInstanceDemo = new Volcenginecc.Hbase.Instance(\"HBaseInstanceDemo\", new()\n {\n RegionId = \"cn-beijing\",\n MultiAz = false,\n ZoneId = \"cn-beijing-a\",\n InstanceName = \"HBaseInstanceDemo\",\n EngineVersion = \"HBase_2.0\",\n InstanceType = \"Standard\",\n MasterSpec = \"hbase.x1.medium\",\n RsCount = 2,\n RsSpec = \"hbase.x1.large\",\n StorageCapacity = 20000,\n VpcId = \"vpc-rrco37ovjq4gv0x5xxxxx\",\n ProjectName = \"default\",\n ChargeType = \"PrePaid\",\n PurchaseMonths = 1,\n AutoRenew = false,\n SubnetId = \"subnet-rrwqhg3qzxfkv0x57xxxxx\",\n DeletionProtection = \"disabled\",\n EnableCloudStorage = false,\n Tags = new[]\n {\n new Volcenginecc.Hbase.Inputs.InstanceTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n StorageType = \"HdfsSsd\",\n EnableAuth = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/hbase\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := hbase.NewInstance(ctx, \"HBaseInstanceDemo\", \u0026hbase.InstanceArgs{\n\t\t\tRegionId: pulumi.String(\"cn-beijing\"),\n\t\t\tMultiAz: pulumi.Bool(false),\n\t\t\tZoneId: pulumi.String(\"cn-beijing-a\"),\n\t\t\tInstanceName: pulumi.String(\"HBaseInstanceDemo\"),\n\t\t\tEngineVersion: pulumi.String(\"HBase_2.0\"),\n\t\t\tInstanceType: pulumi.String(\"Standard\"),\n\t\t\tMasterSpec: pulumi.String(\"hbase.x1.medium\"),\n\t\t\tRsCount: pulumi.Int(2),\n\t\t\tRsSpec: pulumi.String(\"hbase.x1.large\"),\n\t\t\tStorageCapacity: pulumi.Int(20000),\n\t\t\tVpcId: pulumi.String(\"vpc-rrco37ovjq4gv0x5xxxxx\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tChargeType: pulumi.String(\"PrePaid\"),\n\t\t\tPurchaseMonths: pulumi.Int(1),\n\t\t\tAutoRenew: pulumi.Bool(false),\n\t\t\tSubnetId: pulumi.String(\"subnet-rrwqhg3qzxfkv0x57xxxxx\"),\n\t\t\tDeletionProtection: pulumi.String(\"disabled\"),\n\t\t\tEnableCloudStorage: pulumi.Bool(false),\n\t\t\tTags: hbase.InstanceTagArray{\n\t\t\t\t\u0026hbase.InstanceTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tStorageType: pulumi.String(\"HdfsSsd\"),\n\t\t\tEnableAuth: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.hbase.Instance;\nimport com.volcengine.volcenginecc.hbase.InstanceArgs;\nimport com.pulumi.volcenginecc.hbase.inputs.InstanceTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var hBaseInstanceDemo = new Instance(\"hBaseInstanceDemo\", InstanceArgs.builder()\n .regionId(\"cn-beijing\")\n .multiAz(false)\n .zoneId(\"cn-beijing-a\")\n .instanceName(\"HBaseInstanceDemo\")\n .engineVersion(\"HBase_2.0\")\n .instanceType(\"Standard\")\n .masterSpec(\"hbase.x1.medium\")\n .rsCount(2)\n .rsSpec(\"hbase.x1.large\")\n .storageCapacity(20000)\n .vpcId(\"vpc-rrco37ovjq4gv0x5xxxxx\")\n .projectName(\"default\")\n .chargeType(\"PrePaid\")\n .purchaseMonths(1)\n .autoRenew(false)\n .subnetId(\"subnet-rrwqhg3qzxfkv0x57xxxxx\")\n .deletionProtection(\"disabled\")\n .enableCloudStorage(false)\n .tags(InstanceTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .storageType(\"HdfsSsd\")\n .enableAuth(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n hBaseInstanceDemo:\n type: volcenginecc:hbase:Instance\n name: HBaseInstanceDemo\n properties:\n regionId: cn-beijing\n multiAz: false\n zoneId: cn-beijing-a\n instanceName: HBaseInstanceDemo\n engineVersion: HBase_2.0\n instanceType: Standard\n masterSpec: hbase.x1.medium\n rsCount: 2\n rsSpec: hbase.x1.large\n storageCapacity: 20000\n vpcId: vpc-rrco37ovjq4gv0x5xxxxx\n projectName: default\n chargeType: PrePaid\n purchaseMonths: 1\n autoRenew: false\n subnetId: subnet-rrwqhg3qzxfkv0x57xxxxx\n deletionProtection: disabled\n enableCloudStorage: false\n tags:\n - key: env\n value: test\n storageType: HdfsSsd\n enableAuth: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:hbase/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "autoRenew": { "type": "boolean", "description": "Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.\n" }, "chargeStatus": { "type": "string", "description": "Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.\n" }, "chargeType": { "type": "string", "description": "Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).\n" }, "coldStorage": { "type": "integer", "description": "Total capacity-type storage space for the instance, in GiB.\n" }, "createTime": { "type": "string", "description": "Instance creation time (UTC).\n" }, "deletionProtection": { "type": "string", "description": "Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.\n" }, "enableAuth": { "type": "boolean", "description": "Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.\n" }, "enableCloudStorage": { "type": "boolean", "description": "Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:hbase/InstanceEndpoint:InstanceEndpoint" } }, "engineVersion": { "type": "string", "description": "HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance name\n" }, "instanceType": { "type": "string", "description": "Instance type. Currently, only Standard is supported. The default value is Standard\n" }, "masterCount": { "type": "integer", "description": "Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default\n" }, "masterSpec": { "type": "string", "description": "Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.\n" }, "multiAz": { "type": "boolean", "description": "Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.\n" }, "primarySubnetId": { "type": "string", "description": "Real-time primary availability zone subnet ID.\n" }, "primaryZoneId": { "type": "string", "description": "Real-time primary zone ID\n" }, "projectName": { "type": "string", "description": "Project name of the instance\n" }, "purchaseMonths": { "type": "integer", "description": "Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required\n" }, "regionId": { "type": "string", "description": "Region ID of the instance.\n" }, "rsCount": { "type": "integer", "description": "Number of RegionServer nodes\n" }, "rsSpec": { "type": "string", "description": "RegionServer node specification code.\n" }, "standbySubnetId": { "type": "string", "description": "Real-time standby availability zone subnet ID.\n" }, "standbyZoneId": { "type": "string", "description": "Real-time standby zone ID\n" }, "status": { "type": "string", "description": "Current status of the instance. For more details about instance status, see Instance Status Description\n" }, "storageCapacity": { "type": "integer", "description": "Total storage capacity of the instance, unit: GiB.\n" }, "storageType": { "type": "string", "description": "Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.\n" }, "subnetId": { "type": "string", "description": "Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:hbase/InstanceTag:InstanceTag" } }, "usedColdStorage": { "type": "integer", "description": "Capacity-type storage space used by the instance, in MiB\n" }, "usedStorage": { "type": "number", "description": "Storage capacity used by the primary instance, in MiB\n" }, "vpcId": { "type": "string", "description": "Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.\n" }, "vpcName": { "type": "string", "description": "Name of the private network to which the instance belongs.\n" }, "zoneId": { "type": "string", "description": "Zone ID of the instance\n" }, "zoneName": { "type": "string", "description": "Name of the availability zone to which the instance belongs.\n" } }, "required": [ "autoRenew", "chargeStatus", "chargeType", "coldStorage", "createTime", "deletionProtection", "enableAuth", "enableCloudStorage", "endpoints", "engineVersion", "instanceId", "instanceName", "instanceType", "masterCount", "masterSpec", "multiAz", "primarySubnetId", "primaryZoneId", "projectName", "purchaseMonths", "regionId", "rsCount", "rsSpec", "standbySubnetId", "standbyZoneId", "status", "storageCapacity", "storageType", "subnetId", "tags", "usedColdStorage", "usedStorage", "vpcId", "vpcName", "zoneId", "zoneName" ], "inputProperties": { "autoRenew": { "type": "boolean", "description": "Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.\n" }, "chargeType": { "type": "string", "description": "Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).\n" }, "coldStorage": { "type": "integer", "description": "Total capacity-type storage space for the instance, in GiB.\n" }, "deletionProtection": { "type": "string", "description": "Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.\n" }, "enableAuth": { "type": "boolean", "description": "Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.\n" }, "enableCloudStorage": { "type": "boolean", "description": "Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:hbase/InstanceEndpoint:InstanceEndpoint" } }, "engineVersion": { "type": "string", "description": "HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0\n" }, "instanceName": { "type": "string", "description": "Instance name\n" }, "instanceType": { "type": "string", "description": "Instance type. Currently, only Standard is supported. The default value is Standard\n" }, "masterSpec": { "type": "string", "description": "Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.\n" }, "multiAz": { "type": "boolean", "description": "Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.\n" }, "projectName": { "type": "string", "description": "Project name of the instance\n" }, "purchaseMonths": { "type": "integer", "description": "Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required\n" }, "regionId": { "type": "string", "description": "Region ID of the instance.\n" }, "rsCount": { "type": "integer", "description": "Number of RegionServer nodes\n" }, "rsSpec": { "type": "string", "description": "RegionServer node specification code.\n" }, "storageCapacity": { "type": "integer", "description": "Total storage capacity of the instance, unit: GiB.\n" }, "storageType": { "type": "string", "description": "Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.\n" }, "subnetId": { "type": "string", "description": "Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:hbase/InstanceTag:InstanceTag" } }, "vpcId": { "type": "string", "description": "Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.\n" }, "zoneId": { "type": "string", "description": "Zone ID of the instance\n" } }, "requiredInputs": [ "chargeType", "engineVersion", "masterSpec", "regionId", "rsCount", "rsSpec", "storageCapacity", "storageType", "subnetId", "vpcId", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "autoRenew": { "type": "boolean", "description": "Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.\n" }, "chargeStatus": { "type": "string", "description": "Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.\n" }, "chargeType": { "type": "string", "description": "Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).\n" }, "coldStorage": { "type": "integer", "description": "Total capacity-type storage space for the instance, in GiB.\n" }, "createTime": { "type": "string", "description": "Instance creation time (UTC).\n" }, "deletionProtection": { "type": "string", "description": "Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.\n" }, "enableAuth": { "type": "boolean", "description": "Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.\n" }, "enableCloudStorage": { "type": "boolean", "description": "Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:hbase/InstanceEndpoint:InstanceEndpoint" } }, "engineVersion": { "type": "string", "description": "HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance name\n" }, "instanceType": { "type": "string", "description": "Instance type. Currently, only Standard is supported. The default value is Standard\n" }, "masterCount": { "type": "integer", "description": "Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default\n" }, "masterSpec": { "type": "string", "description": "Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.\n" }, "multiAz": { "type": "boolean", "description": "Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.\n" }, "primarySubnetId": { "type": "string", "description": "Real-time primary availability zone subnet ID.\n" }, "primaryZoneId": { "type": "string", "description": "Real-time primary zone ID\n" }, "projectName": { "type": "string", "description": "Project name of the instance\n" }, "purchaseMonths": { "type": "integer", "description": "Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required\n" }, "regionId": { "type": "string", "description": "Region ID of the instance.\n" }, "rsCount": { "type": "integer", "description": "Number of RegionServer nodes\n" }, "rsSpec": { "type": "string", "description": "RegionServer node specification code.\n" }, "standbySubnetId": { "type": "string", "description": "Real-time standby availability zone subnet ID.\n" }, "standbyZoneId": { "type": "string", "description": "Real-time standby zone ID\n" }, "status": { "type": "string", "description": "Current status of the instance. For more details about instance status, see Instance Status Description\n" }, "storageCapacity": { "type": "integer", "description": "Total storage capacity of the instance, unit: GiB.\n" }, "storageType": { "type": "string", "description": "Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.\n" }, "subnetId": { "type": "string", "description": "Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:hbase/InstanceTag:InstanceTag" } }, "usedColdStorage": { "type": "integer", "description": "Capacity-type storage space used by the instance, in MiB\n" }, "usedStorage": { "type": "number", "description": "Storage capacity used by the primary instance, in MiB\n" }, "vpcId": { "type": "string", "description": "Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.\n" }, "vpcName": { "type": "string", "description": "Name of the private network to which the instance belongs.\n" }, "zoneId": { "type": "string", "description": "Zone ID of the instance\n" }, "zoneName": { "type": "string", "description": "Name of the availability zone to which the instance belongs.\n" } }, "type": "object" } }, "volcenginecc:iam/accesskey:Accesskey": { "description": "Access control (Identity and Access Management, IAM) is a permission management system provided by Volcano Engine to help customers control access to cloud resources for different identities\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst accesskeyDemo = new volcenginecc.iam.Accesskey(\"AccesskeyDemo\", {userName: \"s2222\"});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\naccesskey_demo = volcenginecc.iam.Accesskey(\"AccesskeyDemo\", user_name=\"s2222\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var accesskeyDemo = new Volcenginecc.Iam.Accesskey(\"AccesskeyDemo\", new()\n {\n UserName = \"s2222\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/iam\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := iam.NewAccesskey(ctx, \"AccesskeyDemo\", \u0026iam.AccesskeyArgs{\n\t\t\tUserName: pulumi.String(\"s2222\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.iam.Accesskey;\nimport com.volcengine.volcenginecc.iam.AccesskeyArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var accesskeyDemo = new Accesskey(\"accesskeyDemo\", AccesskeyArgs.builder()\n .userName(\"s2222\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n accesskeyDemo:\n type: volcenginecc:iam:Accesskey\n name: AccesskeyDemo\n properties:\n userName: s2222\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:iam/accesskey:Accesskey example \"access_key_id\"\n```\n\n", "properties": { "accessKeyId": { "type": "string", "description": "Key ID (Access Key Id)\n" }, "createdTime": { "type": "string", "description": "Key creation time (ISO8601 format)\n" }, "lastLoginDate": { "type": "string", "description": "Last login time\n" }, "region": { "type": "string", "description": "Last accessed region by the API key\n" }, "requestTime": { "type": "string", "description": "Last usage time of the API key\n" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key\n" }, "service": { "type": "string", "description": "English abbreviation of the last accessed service by the API key\n" }, "status": { "type": "string", "description": "Key status. \"active\" means enabled, \"inactive\" means disabled\n" }, "updatedTime": { "type": "string", "description": "Key update time (ISO8601 format)\n" }, "userName": { "type": "string", "description": "User name. Used to create a key for a specified IAM user. If no user name is specified, the key is created for the current request identity (that is, if the main account requests, the key is created for the main account; if an IAM user requests, the key is created for that IAM user. Note: Roles cannot create keys for themselves). When an IAM user has the AccessKeySelfManageAccess permission, to create a key for themselves, they must include their own UserName in the request\n" } }, "required": [ "accessKeyId", "createdTime", "lastLoginDate", "region", "requestTime", "secretAccessKey", "service", "status", "updatedTime", "userName" ], "inputProperties": { "status": { "type": "string", "description": "Key status. \"active\" means enabled, \"inactive\" means disabled\n" }, "userName": { "type": "string", "description": "User name. Used to create a key for a specified IAM user. If no user name is specified, the key is created for the current request identity (that is, if the main account requests, the key is created for the main account; if an IAM user requests, the key is created for that IAM user. Note: Roles cannot create keys for themselves). When an IAM user has the AccessKeySelfManageAccess permission, to create a key for themselves, they must include their own UserName in the request\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Accesskey resources.\n", "properties": { "accessKeyId": { "type": "string", "description": "Key ID (Access Key Id)\n" }, "createdTime": { "type": "string", "description": "Key creation time (ISO8601 format)\n" }, "lastLoginDate": { "type": "string", "description": "Last login time\n" }, "region": { "type": "string", "description": "Last accessed region by the API key\n" }, "requestTime": { "type": "string", "description": "Last usage time of the API key\n" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key\n" }, "service": { "type": "string", "description": "English abbreviation of the last accessed service by the API key\n" }, "status": { "type": "string", "description": "Key status. \"active\" means enabled, \"inactive\" means disabled\n" }, "updatedTime": { "type": "string", "description": "Key update time (ISO8601 format)\n" }, "userName": { "type": "string", "description": "User name. Used to create a key for a specified IAM user. If no user name is specified, the key is created for the current request identity (that is, if the main account requests, the key is created for the main account; if an IAM user requests, the key is created for that IAM user. Note: Roles cannot create keys for themselves). When an IAM user has the AccessKeySelfManageAccess permission, to create a key for themselves, they must include their own UserName in the request\n" } }, "type": "object" } }, "volcenginecc:iam/group:Group": { "description": "A user group is a collection of users. When a user group is associated with a policy, all users in the group gain the corresponding policy permissions. A user can belong to multiple user groups and have permissions from each group.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n groupDemo:\n type: volcenginecc:iam:Group\n name: GroupDemo\n properties:\n userGroupName: GroupDemo\n description: GroupDemo-Description\n displayName: GroupDemo-DisplayName\n users:\n - user_name: demo\n attachedPolicies:\n - policy_type: System\n policy_name: ECSFullAccess\n policy_scope:\n - attachTime: 20230810T071***Z\n policyScopeType: Project\n projectDisplayName: demo\n projectName: Project\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:iam/group:Group example \"user_group_name\"\n```\n\n", "properties": { "accountId": { "type": "integer", "description": "ID of the primary account to which the user group belongs.\n" }, "attachedPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/GroupAttachedPolicy:GroupAttachedPolicy" } }, "createdTime": { "type": "string", "description": "User group creation time.\n" }, "description": { "type": "string", "description": "User group description. Maximum length: 128 characters.\n" }, "displayName": { "type": "string", "description": "User group display name. Maximum length: 64 characters.\n" }, "updatedTime": { "type": "string", "description": "User group update time.\n" }, "userGroupId": { "type": "integer", "description": "User group ID.\n" }, "userGroupName": { "type": "string", "description": "User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.\n" }, "users": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/GroupUser:GroupUser" } } }, "required": [ "accountId", "attachedPolicies", "createdTime", "description", "displayName", "updatedTime", "userGroupId", "userGroupName", "users" ], "inputProperties": { "attachedPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/GroupAttachedPolicy:GroupAttachedPolicy" } }, "description": { "type": "string", "description": "User group description. Maximum length: 128 characters.\n" }, "displayName": { "type": "string", "description": "User group display name. Maximum length: 64 characters.\n" }, "userGroupName": { "type": "string", "description": "User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.\n" }, "users": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/GroupUser:GroupUser" } } }, "requiredInputs": [ "userGroupName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Group resources.\n", "properties": { "accountId": { "type": "integer", "description": "ID of the primary account to which the user group belongs.\n" }, "attachedPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/GroupAttachedPolicy:GroupAttachedPolicy" } }, "createdTime": { "type": "string", "description": "User group creation time.\n" }, "description": { "type": "string", "description": "User group description. Maximum length: 128 characters.\n" }, "displayName": { "type": "string", "description": "User group display name. Maximum length: 64 characters.\n" }, "updatedTime": { "type": "string", "description": "User group update time.\n" }, "userGroupId": { "type": "integer", "description": "User group ID.\n" }, "userGroupName": { "type": "string", "description": "User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.\n" }, "users": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/GroupUser:GroupUser" } } }, "type": "object" } }, "volcenginecc:iam/oidcProvider:OidcProvider": { "description": "OIDC identity provider is a user authentication service provider responsible for collecting and storing user identity data such as usernames and passwords. In access control (IAM), it is an entity containing external identity provider metadata and provides identity management services.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst iAMOidcProviderDemo = new volcenginecc.iam.OidcProvider(\"IAMOidcProviderDemo\", {\n oidcProviderName: \"ccapi-test\",\n thumbprints: [\"b676ffa3179e8812093a1b5eafee876ae7a6aaf231078dad1bfbxxxxxx\"],\n clientIds: [\n \"sts.test1.com\",\n \"sts.test2.com\",\n ],\n description: \"this is a test\",\n issuanceLimitTime: 10,\n issuerUrl: \"https://oidc-vke-cn-xxx.tos-cn-boe.volces.com/test\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ni_am_oidc_provider_demo = volcenginecc.iam.OidcProvider(\"IAMOidcProviderDemo\",\n oidc_provider_name=\"ccapi-test\",\n thumbprints=[\"b676ffa3179e8812093a1b5eafee876ae7a6aaf231078dad1bfbxxxxxx\"],\n client_ids=[\n \"sts.test1.com\",\n \"sts.test2.com\",\n ],\n description=\"this is a test\",\n issuance_limit_time=10,\n issuer_url=\"https://oidc-vke-cn-xxx.tos-cn-boe.volces.com/test\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var iAMOidcProviderDemo = new Volcenginecc.Iam.OidcProvider(\"IAMOidcProviderDemo\", new()\n {\n OidcProviderName = \"ccapi-test\",\n Thumbprints = new[]\n {\n \"b676ffa3179e8812093a1b5eafee876ae7a6aaf231078dad1bfbxxxxxx\",\n },\n ClientIds = new[]\n {\n \"sts.test1.com\",\n \"sts.test2.com\",\n },\n Description = \"this is a test\",\n IssuanceLimitTime = 10,\n IssuerUrl = \"https://oidc-vke-cn-xxx.tos-cn-boe.volces.com/test\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/iam\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := iam.NewOidcProvider(ctx, \"IAMOidcProviderDemo\", \u0026iam.OidcProviderArgs{\n\t\t\tOidcProviderName: pulumi.String(\"ccapi-test\"),\n\t\t\tThumbprints: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"b676ffa3179e8812093a1b5eafee876ae7a6aaf231078dad1bfbxxxxxx\"),\n\t\t\t},\n\t\t\tClientIds: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"sts.test1.com\"),\n\t\t\t\tpulumi.String(\"sts.test2.com\"),\n\t\t\t},\n\t\t\tDescription: pulumi.String(\"this is a test\"),\n\t\t\tIssuanceLimitTime: pulumi.Int(10),\n\t\t\tIssuerUrl: pulumi.String(\"https://oidc-vke-cn-xxx.tos-cn-boe.volces.com/test\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.iam.OidcProvider;\nimport com.volcengine.volcenginecc.iam.OidcProviderArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var iAMOidcProviderDemo = new OidcProvider(\"iAMOidcProviderDemo\", OidcProviderArgs.builder()\n .oidcProviderName(\"ccapi-test\")\n .thumbprints(\"b676ffa3179e8812093a1b5eafee876ae7a6aaf231078dad1bfbxxxxxx\")\n .clientIds( \n \"sts.test1.com\",\n \"sts.test2.com\")\n .description(\"this is a test\")\n .issuanceLimitTime(10)\n .issuerUrl(\"https://oidc-vke-cn-xxx.tos-cn-boe.volces.com/test\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n iAMOidcProviderDemo:\n type: volcenginecc:iam:OidcProvider\n name: IAMOidcProviderDemo\n properties:\n oidcProviderName: ccapi-test\n thumbprints:\n - b676ffa3179e8812093a1b5eafee876ae7a6aaf231078dad1bfbxxxxxx\n clientIds:\n - sts.test1.com\n - sts.test2.com\n description: this is a test\n issuanceLimitTime: 10\n issuerUrl: https://oidc-vke-cn-xxx.tos-cn-boe.volces.com/test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:iam/oidcProvider:OidcProvider example \"oidc_provider_name\"\n```\n\n", "properties": { "clientIds": { "type": "array", "items": { "type": "string" }, "description": "Client ID list. Provided by external IdP.\n" }, "createDate": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Identity provider description.\n" }, "issuanceLimitTime": { "type": "integer", "description": "Earliest issuance time allowed for external IdP to issue ID Token.\n" }, "issuerUrl": { "type": "string", "description": "OIDC issuer URL.\n" }, "oidcProviderName": { "type": "string", "description": "OIDC identity provider name.\n" }, "thumbprints": { "type": "array", "items": { "type": "string" }, "description": "HTTPS certificate verification fingerprint (SHA256).\n" }, "trn": { "type": "string", "description": "Identity provider Trn.\n" }, "updateDate": { "type": "string", "description": "Update time.\n" } }, "required": [ "clientIds", "createDate", "description", "issuanceLimitTime", "issuerUrl", "oidcProviderName", "thumbprints", "trn", "updateDate" ], "inputProperties": { "clientIds": { "type": "array", "items": { "type": "string" }, "description": "Client ID list. Provided by external IdP.\n" }, "description": { "type": "string", "description": "Identity provider description.\n" }, "issuanceLimitTime": { "type": "integer", "description": "Earliest issuance time allowed for external IdP to issue ID Token.\n" }, "issuerUrl": { "type": "string", "description": "OIDC issuer URL.\n" }, "oidcProviderName": { "type": "string", "description": "OIDC identity provider name.\n" }, "thumbprints": { "type": "array", "items": { "type": "string" }, "description": "HTTPS certificate verification fingerprint (SHA256).\n" } }, "requiredInputs": [ "clientIds", "issuerUrl", "oidcProviderName", "thumbprints" ], "stateInputs": { "description": "Input properties used for looking up and filtering OidcProvider resources.\n", "properties": { "clientIds": { "type": "array", "items": { "type": "string" }, "description": "Client ID list. Provided by external IdP.\n" }, "createDate": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Identity provider description.\n" }, "issuanceLimitTime": { "type": "integer", "description": "Earliest issuance time allowed for external IdP to issue ID Token.\n" }, "issuerUrl": { "type": "string", "description": "OIDC issuer URL.\n" }, "oidcProviderName": { "type": "string", "description": "OIDC identity provider name.\n" }, "thumbprints": { "type": "array", "items": { "type": "string" }, "description": "HTTPS certificate verification fingerprint (SHA256).\n" }, "trn": { "type": "string", "description": "Identity provider Trn.\n" }, "updateDate": { "type": "string", "description": "Update time.\n" } }, "type": "object" } }, "volcenginecc:iam/policy:Policy": { "description": "A policy describes permissions. IAM users, user groups, or roles must be granted permissions by associating policies. If system preset policies do not meet your requirements, you can create custom policies for fine-grained permission definition.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n policyDemo:\n type: volcenginecc:iam:Policy\n name: PolicyDemo\n properties:\n policyName: PolicyDemo\n policyType: Custom\n description: PolicyDemo description\n policyDocument: '{\"Statement\":[{\"Action\":[\"clb:DescribeAclAttributes\",\"clb:DescribeHealthCheckLogProjectAttributes\",\"clb:DescribeListenerAttributes\",\"clb:DescribeListenerHealth\",\"clb:DescribeLoadBalancerAttributes\",\"clb:DescribeLoadBalancerHealth\",\"clb:DescribeLoadBalancersBilling\",\"clb:DescribeNLBListenerAttributes\",\"clb:DescribeNLBListenerCertificates\",\"clb:DescribeNLBListenerHealth\",\"clb:DescribeNLBListeners\",\"clb:DescribeNLBServerGroupAttributes\",\"clb:DescribeNLBServerGroups\",\"clb:DescribeNLBZones\",\"clb:DescribeNetworkLoadBalancerAttributes\",\"clb:DescribeNetworkLoadBalancers\",\"clb:DescribeServerGroupAttributes\",\"clb:DescribeZones\",\"clb:ListTagsForNLBResources\",\"clb:DescribeAcls\",\"clb:DescribeCertificates\",\"clb:DescribeHealthCheckLogTopicAttributes\",\"clb:DescribeListeners\",\"clb:DescribeLoadBalancerSpecs\",\"clb:DescribeLoadBalancers\",\"clb:DescribeRules\",\"clb:DescribeServerGroups\",\"clb:ListTagsForResources\",\"clb:TagNLBResources\",\"clb:TagResources\",\"clb:UntagNLBResources\",\"clb:UntagResources\"],\"Effect\":\"Allow\",\"Resource\":[\"*\"]}]}'\n policyUsers:\n - name: test\n policy_scope:\n - project_name: default\n policy_scope_type: test\n project_display_name: test\n policyRoles:\n - name: roles\n policy_scope:\n - project_name: default\n policyUserGroups:\n - name: test\n policy_scope:\n - project_name: default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:iam/policy:Policy example \"policy_name|policy_type\"\n```\n\n", "properties": { "attachmentCount": { "type": "integer", "description": "Number of identities bound to the policy.\n" }, "category": { "type": "string", "description": "Category of the system preset policy, usually the service code. This field is not returned for custom policies.\n" }, "createdTime": { "type": "string", "description": "Policy creation time.\n" }, "description": { "type": "string", "description": "Policy description, no more than 128 characters.\n" }, "isServiceRolePolicy": { "type": "integer", "description": "Indicates whether the policy is for a service-linked role. 0 means no; 1 means yes.\n" }, "policyDocument": { "type": "string", "description": "Policy syntax content, for example: {\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iam:\",\"tag:\"],\"Resource\":[\"*\"]}]}\n" }, "policyName": { "type": "string", "description": "Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.\n" }, "policyRoles": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyRole:PolicyPolicyRole" } }, "policyTrn": { "type": "string", "description": "Policy TRN.\n" }, "policyType": { "type": "string", "description": "Policy type. System indicates a system preset policy; Custom indicates a custom policy.\n" }, "policyUserGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyUserGroup:PolicyPolicyUserGroup" } }, "policyUsers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyUser:PolicyPolicyUser" } }, "updatedTime": { "type": "string", "description": "Policy update time.\n" } }, "required": [ "attachmentCount", "category", "createdTime", "description", "isServiceRolePolicy", "policyDocument", "policyName", "policyRoles", "policyTrn", "policyType", "policyUserGroups", "policyUsers", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Policy description, no more than 128 characters.\n" }, "policyDocument": { "type": "string", "description": "Policy syntax content, for example: {\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iam:\",\"tag:\"],\"Resource\":[\"*\"]}]}\n" }, "policyName": { "type": "string", "description": "Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.\n" }, "policyRoles": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyRole:PolicyPolicyRole" } }, "policyType": { "type": "string", "description": "Policy type. System indicates a system preset policy; Custom indicates a custom policy.\n" }, "policyUserGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyUserGroup:PolicyPolicyUserGroup" } }, "policyUsers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyUser:PolicyPolicyUser" } } }, "requiredInputs": [ "policyDocument", "policyName", "policyType" ], "stateInputs": { "description": "Input properties used for looking up and filtering Policy resources.\n", "properties": { "attachmentCount": { "type": "integer", "description": "Number of identities bound to the policy.\n" }, "category": { "type": "string", "description": "Category of the system preset policy, usually the service code. This field is not returned for custom policies.\n" }, "createdTime": { "type": "string", "description": "Policy creation time.\n" }, "description": { "type": "string", "description": "Policy description, no more than 128 characters.\n" }, "isServiceRolePolicy": { "type": "integer", "description": "Indicates whether the policy is for a service-linked role. 0 means no; 1 means yes.\n" }, "policyDocument": { "type": "string", "description": "Policy syntax content, for example: {\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iam:\",\"tag:\"],\"Resource\":[\"*\"]}]}\n" }, "policyName": { "type": "string", "description": "Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.\n" }, "policyRoles": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyRole:PolicyPolicyRole" } }, "policyTrn": { "type": "string", "description": "Policy TRN.\n" }, "policyType": { "type": "string", "description": "Policy type. System indicates a system preset policy; Custom indicates a custom policy.\n" }, "policyUserGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyUserGroup:PolicyPolicyUserGroup" } }, "policyUsers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/PolicyPolicyUser:PolicyPolicyUser" } }, "updatedTime": { "type": "string", "description": "Policy update time.\n" } }, "type": "object" } }, "volcenginecc:iam/project:Project": { "description": "Resource project (Project) provides a mechanism for resource group management, helping you achieve logical resource isolation. You can use resource projects for project-based authorization, billing, and other operations.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst iAMProjectDemo = new volcenginecc.iam.Project(\"IAMProjectDemo\", {\n description: \"IAMProjectDemo description\",\n projectName: \"default\",\n displayName: \"IAMProjectDemo\",\n parentProjectName: \"default\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ni_am_project_demo = volcenginecc.iam.Project(\"IAMProjectDemo\",\n description=\"IAMProjectDemo description\",\n project_name=\"default\",\n display_name=\"IAMProjectDemo\",\n parent_project_name=\"default\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var iAMProjectDemo = new Volcenginecc.Iam.Project(\"IAMProjectDemo\", new()\n {\n Description = \"IAMProjectDemo description\",\n ProjectName = \"default\",\n DisplayName = \"IAMProjectDemo\",\n ParentProjectName = \"default\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/iam\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := iam.NewProject(ctx, \"IAMProjectDemo\", \u0026iam.ProjectArgs{\n\t\t\tDescription: pulumi.String(\"IAMProjectDemo description\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tDisplayName: pulumi.String(\"IAMProjectDemo\"),\n\t\t\tParentProjectName: pulumi.String(\"default\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.iam.Project;\nimport com.volcengine.volcenginecc.iam.ProjectArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var iAMProjectDemo = new Project(\"iAMProjectDemo\", ProjectArgs.builder()\n .description(\"IAMProjectDemo description\")\n .projectName(\"default\")\n .displayName(\"IAMProjectDemo\")\n .parentProjectName(\"default\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n iAMProjectDemo:\n type: volcenginecc:iam:Project\n name: IAMProjectDemo\n properties:\n description: IAMProjectDemo description\n projectName: default\n displayName: IAMProjectDemo\n parentProjectName: default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:iam/project:Project example \"project_name\"\n```\n\n", "properties": { "accountId": { "type": "integer", "description": "Account ID\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "Description\n" }, "displayName": { "type": "string", "description": "Display Name\n" }, "hasPermission": { "type": "boolean", "description": "Visible\n" }, "parentProjectName": { "type": "string", "description": "Parent Project Name\n" }, "path": { "type": "string", "description": "Project Path\n" }, "projectName": { "type": "string", "description": "Project Name\n" }, "status": { "type": "string", "description": "Enabled Status\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "required": [ "accountId", "createdTime", "description", "displayName", "hasPermission", "parentProjectName", "path", "projectName", "status", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Description\n" }, "displayName": { "type": "string", "description": "Display Name\n" }, "parentProjectName": { "type": "string", "description": "Parent Project Name\n" }, "projectName": { "type": "string", "description": "Project Name\n" } }, "requiredInputs": [ "projectName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Project resources.\n", "properties": { "accountId": { "type": "integer", "description": "Account ID\n" }, "createdTime": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "Description\n" }, "displayName": { "type": "string", "description": "Display Name\n" }, "hasPermission": { "type": "boolean", "description": "Visible\n" }, "parentProjectName": { "type": "string", "description": "Parent Project Name\n" }, "path": { "type": "string", "description": "Project Path\n" }, "projectName": { "type": "string", "description": "Project Name\n" }, "status": { "type": "string", "description": "Enabled Status\n" }, "updatedTime": { "type": "string", "description": "Update Time\n" } }, "type": "object" } }, "volcenginecc:iam/role:Role": { "description": "A role is a virtual identity in the IAM system that grants certain access permissions within an account to various identity entities. Trusted identity entities can assume this role to access cloud resources within the account.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst roleDemo = new volcenginecc.iam.Role(\"RoleDemo\", {\n roleName: \"RoleDemo\",\n description: \"role attach policies\",\n maxSessionDuration: 3600,\n trustPolicyDocument: `{\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"sts:AssumeRole\"\n ],\n \"Principal\": {\n \"IAM\": [\n \"trn:iam::20000000xx:root\"\n ]\n }\n }\n ]\n}`,\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nrole_demo = volcenginecc.iam.Role(\"RoleDemo\",\n role_name=\"RoleDemo\",\n description=\"role attach policies\",\n max_session_duration=3600,\n trust_policy_document=\"\"\"{\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"sts:AssumeRole\"\n ],\n \"Principal\": {\n \"IAM\": [\n \"trn:iam::20000000xx:root\"\n ]\n }\n }\n ]\n}\"\"\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var roleDemo = new Volcenginecc.Iam.Role(\"RoleDemo\", new()\n {\n RoleName = \"RoleDemo\",\n Description = \"role attach policies\",\n MaxSessionDuration = 3600,\n TrustPolicyDocument = @\"{\n \"\"Statement\"\": [\n {\n \"\"Effect\"\": \"\"Allow\"\",\n \"\"Action\"\": [\n \"\"sts:AssumeRole\"\"\n ],\n \"\"Principal\"\": {\n \"\"IAM\"\": [\n \"\"trn:iam::20000000xx:root\"\"\n ]\n }\n }\n ]\n}\",\n Tags = new[]\n {\n new Volcenginecc.Iam.Inputs.RoleTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/iam\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := iam.NewRole(ctx, \"RoleDemo\", \u0026iam.RoleArgs{\n\t\t\tRoleName: pulumi.String(\"RoleDemo\"),\n\t\t\tDescription: pulumi.String(\"role attach policies\"),\n\t\t\tMaxSessionDuration: pulumi.Int(3600),\n\t\t\tTrustPolicyDocument: pulumi.String(`{\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"sts:AssumeRole\"\n ],\n \"Principal\": {\n \"IAM\": [\n \"trn:iam::20000000xx:root\"\n ]\n }\n }\n ]\n}`),\n\t\t\tTags: iam.RoleTagArray{\n\t\t\t\t\u0026iam.RoleTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.iam.Role;\nimport com.volcengine.volcenginecc.iam.RoleArgs;\nimport com.pulumi.volcenginecc.iam.inputs.RoleTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var roleDemo = new Role(\"roleDemo\", RoleArgs.builder()\n .roleName(\"RoleDemo\")\n .description(\"role attach policies\")\n .maxSessionDuration(3600)\n .trustPolicyDocument(\"\"\"\n{\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"sts:AssumeRole\"\n ],\n \"Principal\": {\n \"IAM\": [\n \"trn:iam::20000000xx:root\"\n ]\n }\n }\n ]\n} \"\"\")\n .tags(RoleTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n roleDemo:\n type: volcenginecc:iam:Role\n name: RoleDemo\n properties:\n roleName: RoleDemo\n description: role attach policies\n maxSessionDuration: 3600\n trustPolicyDocument: |-\n {\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"sts:AssumeRole\"\n ],\n \"Principal\": {\n \"IAM\": [\n \"trn:iam::20000000xx:root\"\n ]\n }\n }\n ]\n }\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:iam/role:Role example \"role_name\"\n```\n\n", "properties": { "createDate": { "type": "string", "description": "Role creation time\n" }, "description": { "type": "string", "description": "Role description, maximum length 128\n" }, "displayName": { "type": "string", "description": "Role display name, maximum length 64\n" }, "isServiceLinkedRole": { "type": "integer", "description": "Service-linked role or not: 0 for No, 1 for Yes\n" }, "maxSessionDuration": { "type": "integer", "description": "Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200\n" }, "policies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/RolePolicy:RolePolicy" } }, "roleId": { "type": "integer", "description": "Role ID\n" }, "roleName": { "type": "string", "description": "Role name, length 1–64, supports English letters, numbers, and .-_ characters\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/RoleTag:RoleTag" } }, "trn": { "type": "string", "description": "Role TRN\n" }, "trustPolicyDocument": { "type": "string", "description": "Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.\n" }, "updateDate": { "type": "string", "description": "Role update time\n" } }, "required": [ "createDate", "description", "displayName", "isServiceLinkedRole", "maxSessionDuration", "policies", "roleId", "roleName", "tags", "trn", "trustPolicyDocument", "updateDate" ], "inputProperties": { "description": { "type": "string", "description": "Role description, maximum length 128\n" }, "displayName": { "type": "string", "description": "Role display name, maximum length 64\n" }, "maxSessionDuration": { "type": "integer", "description": "Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200\n" }, "policies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/RolePolicy:RolePolicy" } }, "roleName": { "type": "string", "description": "Role name, length 1–64, supports English letters, numbers, and .-_ characters\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/RoleTag:RoleTag" } }, "trustPolicyDocument": { "type": "string", "description": "Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.\n" } }, "requiredInputs": [ "roleName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Role resources.\n", "properties": { "createDate": { "type": "string", "description": "Role creation time\n" }, "description": { "type": "string", "description": "Role description, maximum length 128\n" }, "displayName": { "type": "string", "description": "Role display name, maximum length 64\n" }, "isServiceLinkedRole": { "type": "integer", "description": "Service-linked role or not: 0 for No, 1 for Yes\n" }, "maxSessionDuration": { "type": "integer", "description": "Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200\n" }, "policies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/RolePolicy:RolePolicy" } }, "roleId": { "type": "integer", "description": "Role ID\n" }, "roleName": { "type": "string", "description": "Role name, length 1–64, supports English letters, numbers, and .-_ characters\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/RoleTag:RoleTag" } }, "trn": { "type": "string", "description": "Role TRN\n" }, "trustPolicyDocument": { "type": "string", "description": "Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.\n" }, "updateDate": { "type": "string", "description": "Role update time\n" } }, "type": "object" } }, "volcenginecc:iam/samlProvider:SamlProvider": { "description": "SAML identity provider is a user authentication service provider responsible for collecting and storing user identity data such as usernames and passwords. In access control (IAM), it is an entity that contains external identity provider metadata and provides identity management services.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst iAMSamlProviderDemo = new volcenginecc.iam.SamlProvider(\"IAMSamlProviderDemo\", {\n samlProviderName: \"ccapi-test\",\n description: \"ccapi-test\",\n encodedSamlMetadataDocument: \"PD94bWwgdmVyc2lvbxxxxxx==\",\n ssoType: 1,\n status: 1,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ni_am_saml_provider_demo = volcenginecc.iam.SamlProvider(\"IAMSamlProviderDemo\",\n saml_provider_name=\"ccapi-test\",\n description=\"ccapi-test\",\n encoded_saml_metadata_document=\"PD94bWwgdmVyc2lvbxxxxxx==\",\n sso_type=1,\n status=1)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var iAMSamlProviderDemo = new Volcenginecc.Iam.SamlProvider(\"IAMSamlProviderDemo\", new()\n {\n SamlProviderName = \"ccapi-test\",\n Description = \"ccapi-test\",\n EncodedSamlMetadataDocument = \"PD94bWwgdmVyc2lvbxxxxxx==\",\n SsoType = 1,\n Status = 1,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/iam\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := iam.NewSamlProvider(ctx, \"IAMSamlProviderDemo\", \u0026iam.SamlProviderArgs{\n\t\t\tSamlProviderName: pulumi.String(\"ccapi-test\"),\n\t\t\tDescription: pulumi.String(\"ccapi-test\"),\n\t\t\tEncodedSamlMetadataDocument: pulumi.String(\"PD94bWwgdmVyc2lvbxxxxxx==\"),\n\t\t\tSsoType: pulumi.Int(1),\n\t\t\tStatus: pulumi.Int(1),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.iam.SamlProvider;\nimport com.volcengine.volcenginecc.iam.SamlProviderArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var iAMSamlProviderDemo = new SamlProvider(\"iAMSamlProviderDemo\", SamlProviderArgs.builder()\n .samlProviderName(\"ccapi-test\")\n .description(\"ccapi-test\")\n .encodedSamlMetadataDocument(\"PD94bWwgdmVyc2lvbxxxxxx==\")\n .ssoType(1)\n .status(1)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n iAMSamlProviderDemo:\n type: volcenginecc:iam:SamlProvider\n name: IAMSamlProviderDemo\n properties:\n samlProviderName: ccapi-test\n description: ccapi-test\n encodedSamlMetadataDocument: PD94bWwgdmVyc2lvbxxxxxx==\n ssoType: 1\n status: 1\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:iam/samlProvider:SamlProvider example \"saml_provider_name\"\n```\n\n", "properties": { "certificateExpireTime": { "type": "string", "description": "SAML Certificate Expiration Reminder Time\n" }, "certificates": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/SamlProviderCertificate:SamlProviderCertificate" } }, "createDate": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "SAML Identity Provider Description\n" }, "encodedSamlMetadataDocument": { "type": "string", "description": "Base64 Encoded SAML Identity Provider Metadata File\n" }, "samlProviderName": { "type": "string", "description": "SAML Identity Provider Name\n" }, "ssoType": { "type": "integer", "description": "Identity Provider SSO Type 1. Role SSO 2. User SSO\n" }, "status": { "type": "integer", "description": "Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled\n" }, "trn": { "type": "string", "description": "Identity Provider Trn\n" }, "updateDate": { "type": "string", "description": "Update Time\n" } }, "required": [ "certificateExpireTime", "certificates", "createDate", "description", "encodedSamlMetadataDocument", "samlProviderName", "ssoType", "status", "trn", "updateDate" ], "inputProperties": { "description": { "type": "string", "description": "SAML Identity Provider Description\n" }, "encodedSamlMetadataDocument": { "type": "string", "description": "Base64 Encoded SAML Identity Provider Metadata File\n" }, "samlProviderName": { "type": "string", "description": "SAML Identity Provider Name\n" }, "ssoType": { "type": "integer", "description": "Identity Provider SSO Type 1. Role SSO 2. User SSO\n" }, "status": { "type": "integer", "description": "Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled\n" } }, "requiredInputs": [ "encodedSamlMetadataDocument", "samlProviderName", "ssoType" ], "stateInputs": { "description": "Input properties used for looking up and filtering SamlProvider resources.\n", "properties": { "certificateExpireTime": { "type": "string", "description": "SAML Certificate Expiration Reminder Time\n" }, "certificates": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/SamlProviderCertificate:SamlProviderCertificate" } }, "createDate": { "type": "string", "description": "Creation Time\n" }, "description": { "type": "string", "description": "SAML Identity Provider Description\n" }, "encodedSamlMetadataDocument": { "type": "string", "description": "Base64 Encoded SAML Identity Provider Metadata File\n" }, "samlProviderName": { "type": "string", "description": "SAML Identity Provider Name\n" }, "ssoType": { "type": "integer", "description": "Identity Provider SSO Type 1. Role SSO 2. User SSO\n" }, "status": { "type": "integer", "description": "Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled\n" }, "trn": { "type": "string", "description": "Identity Provider Trn\n" }, "updateDate": { "type": "string", "description": "Update Time\n" } }, "type": "object" } }, "volcenginecc:iam/user:User": { "description": "An IAM sub-user is an identity for access control, created by an account or a user with permissions. After permissions are granted, the user can log in to the console or use the access key to call APIs to access cloud resources.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n userDemo:\n type: volcenginecc:iam:User\n name: UserDemo\n properties:\n userName: UserDemo\n description: user description\n groups:\n - UserGroupDemo\n policies:\n - policy_name: TOSReadOnlyAccess\n policy_type: System\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:iam/user:User example \"user_name\"\n```\n\n", "properties": { "accessKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/UserAccessKey:UserAccessKey" } }, "accountId": { "type": "number", "description": "Main account to which the sub-user belongs.\n" }, "createDate": { "type": "string", "description": "Sub-user's creation time.\n" }, "description": { "type": "string", "description": "Description for the sub-user, up to 255 characters.\n" }, "displayName": { "type": "string", "description": "Display name for the sub-user, user display name. Length 1–128. Supports Chinese, English, numbers, spaces, and .-_@ characters only.\n" }, "email": { "type": "string", "description": "Sub-user's email address.\n" }, "emailIsVerify": { "type": "boolean", "description": "Whether the sub-user's email address is verified. 'true' means verified, 'false' means not verified.\n" }, "groups": { "type": "array", "items": { "type": "string" }, "description": "User group to which the sub-user belongs.\n" }, "loginProfile": { "$ref": "#/types/volcenginecc:iam/UserLoginProfile:UserLoginProfile", "description": "Login configuration for the sub-user.\n" }, "mobilePhone": { "type": "string", "description": "Sub-user's mobile number.\n" }, "mobilePhoneIsVerify": { "type": "boolean", "description": "Whether the sub-user's phone number is verified. 'true' means verified, 'false' means not verified.\n" }, "policies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/UserPolicy:UserPolicy" } }, "securityConfig": { "$ref": "#/types/volcenginecc:iam/UserSecurityConfig:UserSecurityConfig", "description": "Operation protection configuration for the sub-user.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/UserTag:UserTag" } }, "trn": { "type": "string", "description": "TRN expression for the sub-user.\n" }, "updateDate": { "type": "string", "description": "Update time for the sub-user.\n" }, "userId": { "type": "integer", "description": "Sub-user's ID.\n" }, "userName": { "type": "string", "description": "Sub-user name, username. Length 1–64. Supports English, numbers, underscores, and .-@ characters.\n" } }, "required": [ "accessKeys", "accountId", "createDate", "description", "displayName", "email", "emailIsVerify", "groups", "loginProfile", "mobilePhone", "mobilePhoneIsVerify", "policies", "securityConfig", "tags", "trn", "updateDate", "userId", "userName" ], "inputProperties": { "description": { "type": "string", "description": "Description for the sub-user, up to 255 characters.\n" }, "displayName": { "type": "string", "description": "Display name for the sub-user, user display name. Length 1–128. Supports Chinese, English, numbers, spaces, and .-_@ characters only.\n" }, "email": { "type": "string", "description": "Sub-user's email address.\n" }, "emailIsVerify": { "type": "boolean", "description": "Whether the sub-user's email address is verified. 'true' means verified, 'false' means not verified.\n" }, "groups": { "type": "array", "items": { "type": "string" }, "description": "User group to which the sub-user belongs.\n" }, "loginProfile": { "$ref": "#/types/volcenginecc:iam/UserLoginProfile:UserLoginProfile", "description": "Login configuration for the sub-user.\n" }, "mobilePhone": { "type": "string", "description": "Sub-user's mobile number.\n" }, "policies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/UserPolicy:UserPolicy" } }, "securityConfig": { "$ref": "#/types/volcenginecc:iam/UserSecurityConfig:UserSecurityConfig", "description": "Operation protection configuration for the sub-user.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/UserTag:UserTag" } }, "userName": { "type": "string", "description": "Sub-user name, username. Length 1–64. Supports English, numbers, underscores, and .-@ characters.\n" } }, "requiredInputs": [ "userName" ], "stateInputs": { "description": "Input properties used for looking up and filtering User resources.\n", "properties": { "accessKeys": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/UserAccessKey:UserAccessKey" } }, "accountId": { "type": "number", "description": "Main account to which the sub-user belongs.\n" }, "createDate": { "type": "string", "description": "Sub-user's creation time.\n" }, "description": { "type": "string", "description": "Description for the sub-user, up to 255 characters.\n" }, "displayName": { "type": "string", "description": "Display name for the sub-user, user display name. Length 1–128. Supports Chinese, English, numbers, spaces, and .-_@ characters only.\n" }, "email": { "type": "string", "description": "Sub-user's email address.\n" }, "emailIsVerify": { "type": "boolean", "description": "Whether the sub-user's email address is verified. 'true' means verified, 'false' means not verified.\n" }, "groups": { "type": "array", "items": { "type": "string" }, "description": "User group to which the sub-user belongs.\n" }, "loginProfile": { "$ref": "#/types/volcenginecc:iam/UserLoginProfile:UserLoginProfile", "description": "Login configuration for the sub-user.\n" }, "mobilePhone": { "type": "string", "description": "Sub-user's mobile number.\n" }, "mobilePhoneIsVerify": { "type": "boolean", "description": "Whether the sub-user's phone number is verified. 'true' means verified, 'false' means not verified.\n" }, "policies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/UserPolicy:UserPolicy" } }, "securityConfig": { "$ref": "#/types/volcenginecc:iam/UserSecurityConfig:UserSecurityConfig", "description": "Operation protection configuration for the sub-user.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:iam/UserTag:UserTag" } }, "trn": { "type": "string", "description": "TRN expression for the sub-user.\n" }, "updateDate": { "type": "string", "description": "Update time for the sub-user.\n" }, "userId": { "type": "integer", "description": "Sub-user's ID.\n" }, "userName": { "type": "string", "description": "Sub-user name, username. Length 1–64. Supports English, numbers, underscores, and .-@ characters.\n" } }, "type": "object" } }, "volcenginecc:kafka/allowList:AllowList": { "description": "When creating a Kafka instance, you can bind an allowlist as needed. After binding the allowlist to the Kafka instance, only IP addresses and address ranges specified in the allowlist can access the Kafka message queue instance. For security, we recommend creating an allowlist and adding the client IP address or IP address range to the Kafka instance's allowlist. Regularly maintain and manage the allowlist to enhance the security of Kafka instance access\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@pulumi/volcenginecc\";\n\nconst kafkaAllowListDemo = new volcenginecc.index.KafkaAllowlist(\"KafkaAllowListDemo\", {\n allowList: \"127.0.0.2\",\n allowListDesc: \"test\",\n allowListName: \"ccapi-text\",\n associatedInstances: [\n {\n instanceId: \"kafka-cnng9x9s***\",\n },\n {\n instanceId: \"kafka-cnnghf99**\",\n },\n ],\n applyInstanceNum: 2,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nkafka_allow_list_demo = volcenginecc.index.KafkaAllowlist(\"KafkaAllowListDemo\",\n allow_list=127.0.0.2,\n allow_list_desc=test,\n allow_list_name=ccapi-text,\n associated_instances=[\n {\n instanceId: kafka-cnng9x9s***,\n },\n {\n instanceId: kafka-cnnghf99**,\n },\n ],\n apply_instance_num=2)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var kafkaAllowListDemo = new Volcenginecc.Index.KafkaAllowlist(\"KafkaAllowListDemo\", new()\n {\n AllowList = \"127.0.0.2\",\n AllowListDesc = \"test\",\n AllowListName = \"ccapi-text\",\n AssociatedInstances = new[]\n {\n \n {\n { \"instanceId\", \"kafka-cnng9x9s***\" },\n },\n \n {\n { \"instanceId\", \"kafka-cnnghf99**\" },\n },\n },\n ApplyInstanceNum = 2,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := volcenginecc.NewKafkaAllowlist(ctx, \"KafkaAllowListDemo\", \u0026volcenginecc.KafkaAllowlistArgs{\n\t\t\tAllowList: \"127.0.0.2\",\n\t\t\tAllowListDesc: \"test\",\n\t\t\tAllowListName: \"ccapi-text\",\n\t\t\tAssociatedInstances: []map[string]interface{}{\n\t\t\t\tmap[string]interface{}{\n\t\t\t\t\t\"instanceId\": \"kafka-cnng9x9s***\",\n\t\t\t\t},\n\t\t\t\tmap[string]interface{}{\n\t\t\t\t\t\"instanceId\": \"kafka-cnnghf99**\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tApplyInstanceNum: 2,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.volcenginecc.kafkaAllowlist;\nimport com.pulumi.volcenginecc.kafkaAllowlistArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var kafkaAllowListDemo = new KafkaAllowlist(\"kafkaAllowListDemo\", KafkaAllowlistArgs.builder()\n .allowList(\"127.0.0.2\")\n .allowListDesc(\"test\")\n .allowListName(\"ccapi-text\")\n .associatedInstances(List.of( \n Map.of(\"instanceId\", \"kafka-cnng9x9s***\"),\n Map.of(\"instanceId\", \"kafka-cnnghf99**\")))\n .applyInstanceNum(2)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n kafkaAllowListDemo:\n type: volcenginecc:kafkaAllowlist\n name: KafkaAllowListDemo\n properties:\n allowList: 127.0.0.2\n allowListDesc: test\n allowListName: ccapi-text\n associatedInstances:\n - instanceId: kafka-cnng9x9s***\n - instanceId: kafka-cnnghf99**\n applyInstanceNum: 2\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:kafka/allowList:AllowList example \"allow_list_id\"\n```\n\n", "properties": { "allowList": { "type": "string", "description": "Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListDesc": { "type": "string", "description": "Allowlist description. Maximum length: 200 characters\n" }, "allowListId": { "type": "string", "description": "Allowlist ID\n" }, "allowListIpNum": { "type": "integer", "description": "Number of rules specified in the allowlist\n" }, "allowListName": { "type": "string", "description": "Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region\n" }, "applyInstanceNum": { "type": "integer", "description": "Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails\n" }, "associatedInstanceNum": { "type": "integer", "description": "Number of instances bound to the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/AllowListAssociatedInstance:AllowListAssociatedInstance" } } }, "required": [ "allowList", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "applyInstanceNum", "associatedInstanceNum", "associatedInstances" ], "inputProperties": { "allowList": { "type": "string", "description": "Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListDesc": { "type": "string", "description": "Allowlist description. Maximum length: 200 characters\n" }, "allowListName": { "type": "string", "description": "Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region\n" }, "applyInstanceNum": { "type": "integer", "description": "Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/AllowListAssociatedInstance:AllowListAssociatedInstance" } } }, "requiredInputs": [ "allowList", "allowListName" ], "stateInputs": { "description": "Input properties used for looking up and filtering AllowList resources.\n", "properties": { "allowList": { "type": "string", "description": "Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListDesc": { "type": "string", "description": "Allowlist description. Maximum length: 200 characters\n" }, "allowListId": { "type": "string", "description": "Allowlist ID\n" }, "allowListIpNum": { "type": "integer", "description": "Number of rules specified in the allowlist\n" }, "allowListName": { "type": "string", "description": "Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region\n" }, "applyInstanceNum": { "type": "integer", "description": "Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails\n" }, "associatedInstanceNum": { "type": "integer", "description": "Number of instances bound to the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/AllowListAssociatedInstance:AllowListAssociatedInstance" } } }, "type": "object" } }, "volcenginecc:kafka/instance:Instance": { "description": "Kafka Message Queue is a distributed messaging middleware service built on Apache Kafka. It features high throughput and scalability, provides stream data publishing/subscription and multi-replica storage mechanisms, and is widely used in log compression and collection, stream data processing, message decoupling, and traffic peak shaving scenarios.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n kafkaInstanceDemo:\n type: volcenginecc:kafka:Instance\n name: KafkaInstanceDemo\n properties:\n chargeInfo:\n charge_type: PostPaid\n auto_renew: false\n computeSpec: kafka.20xrate.hw\n eipId: eip-****\n instanceDescription: CCAPI-TEST\n instanceName: CCAPI-TEST\n subnetId: subnet-****\n ipWhiteLists:\n - acl-****\n parameters: '{\"LogRetentionHours\":\"1\",\"MessageMaxByte\":\"2\",\"MessageTimestampType\":\"CreateTime\",\"OffsetRetentionMinutes\":\"10\",\"AutoDeleteGroup\":\"False\"}'\n partitionNumber: 350\n storageSpace: 300\n storageType: ESSD_PL0\n tags:\n - key: env\n value: test\n version: 2.8.2\n vpcId: vpc-****\n zoneId: cn-beijing-a\n projectName: default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:kafka/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Main account ID for creating the instance.\n" }, "chargeInfo": { "$ref": "#/types/volcenginecc:kafka/InstanceChargeInfo:InstanceChargeInfo", "description": "Billing type and related billing information for the Kafka instance.\n" }, "computeSpec": { "type": "string", "description": "Instance compute specification.\n" }, "connectionInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/InstanceConnectionInfo:InstanceConnectionInfo" } }, "createdTime": { "type": "string", "description": "Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "eipId": { "type": "string", "description": "EIP ID.\n" }, "instanceDescription": { "type": "string", "description": "Brief description of the Kafka instance. Length must be between 1 and 128 characters.\n" }, "instanceId": { "type": "string", "description": "Kafka instance ID.\n" }, "instanceName": { "type": "string", "description": "Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.\n" }, "instanceStatus": { "type": "string", "description": "Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed\n" }, "ipWhiteLists": { "type": "array", "items": { "type": "string" }, "description": "List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.\n" }, "needRebalance": { "type": "boolean", "description": "Whether to enable rebalancing.\n" }, "parameters": { "type": "string", "description": "Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.\n" }, "partitionNumber": { "type": "integer", "description": "Number of partitions.\n" }, "privateDomainOnPublic": { "type": "boolean", "description": "Whether to enable public network domain resolution.\n" }, "projectName": { "type": "string", "description": "IAM project to which the currently created Kafka instance belongs.\n" }, "storageSpace": { "type": "integer", "description": "Instance storage space, measured in GiB, must be specified as a multiple of 100.\n" }, "storageType": { "type": "string", "description": "Cloud disk type for Kafka instance data storage. Can be set to ESSD*FlexPL or ESSD*PL0; default is ESSD_FlexPL.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID where the instance is located.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/InstanceTag:InstanceTag" } }, "topics": { "type": "array", "items": { "type": "string" }, "description": "List of topics under a Kafka instance\n" }, "usableGroupNumber": { "type": "integer", "description": "The remaining number of available consumer groups for the current instance.\n" }, "usablePartitionNumber": { "type": "integer", "description": "Number of available partitions remaining for the current instance.\n" }, "usedGroupNumber": { "type": "integer", "description": "Number of consumer groups (Group) currently created in the instance.\n" }, "usedPartitionNumber": { "type": "integer", "description": "Number of partitions currently used by the instance.\n" }, "usedStorageSpace": { "type": "integer", "description": "Used storage space of the instance, measured in GiB.\n" }, "usedTopicNumber": { "type": "integer", "description": "Number of topics created in the current instance.\n" }, "userName": { "type": "string", "description": "SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.\n" }, "userPassword": { "type": "string", "description": "Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^\u0026*()_+-=\n" }, "version": { "type": "string", "description": "Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID where the instance is located.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.\n" } }, "required": [ "accountId", "chargeInfo", "computeSpec", "connectionInfos", "createdTime", "eipId", "instanceDescription", "instanceId", "instanceName", "instanceStatus", "ipWhiteLists", "needRebalance", "parameters", "partitionNumber", "privateDomainOnPublic", "projectName", "storageSpace", "storageType", "subnetId", "tags", "topics", "usableGroupNumber", "usablePartitionNumber", "usedGroupNumber", "usedPartitionNumber", "usedStorageSpace", "usedTopicNumber", "userName", "userPassword", "version", "vpcId", "zoneId" ], "inputProperties": { "chargeInfo": { "$ref": "#/types/volcenginecc:kafka/InstanceChargeInfo:InstanceChargeInfo", "description": "Billing type and related billing information for the Kafka instance.\n" }, "computeSpec": { "type": "string", "description": "Instance compute specification.\n" }, "eipId": { "type": "string", "description": "EIP ID.\n" }, "instanceDescription": { "type": "string", "description": "Brief description of the Kafka instance. Length must be between 1 and 128 characters.\n" }, "instanceName": { "type": "string", "description": "Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.\n" }, "ipWhiteLists": { "type": "array", "items": { "type": "string" }, "description": "List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.\n" }, "needRebalance": { "type": "boolean", "description": "Whether to enable rebalancing.\n" }, "parameters": { "type": "string", "description": "Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.\n" }, "partitionNumber": { "type": "integer", "description": "Number of partitions.\n" }, "projectName": { "type": "string", "description": "IAM project to which the currently created Kafka instance belongs.\n" }, "storageSpace": { "type": "integer", "description": "Instance storage space, measured in GiB, must be specified as a multiple of 100.\n" }, "storageType": { "type": "string", "description": "Cloud disk type for Kafka instance data storage. Can be set to ESSD*FlexPL or ESSD*PL0; default is ESSD_FlexPL.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID where the instance is located.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/InstanceTag:InstanceTag" } }, "userName": { "type": "string", "description": "SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.\n" }, "userPassword": { "type": "string", "description": "Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^\u0026*()_+-=\n" }, "version": { "type": "string", "description": "Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID where the instance is located.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.\n" } }, "requiredInputs": [ "computeSpec", "subnetId", "version", "vpcId", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "accountId": { "type": "string", "description": "Main account ID for creating the instance.\n" }, "chargeInfo": { "$ref": "#/types/volcenginecc:kafka/InstanceChargeInfo:InstanceChargeInfo", "description": "Billing type and related billing information for the Kafka instance.\n" }, "computeSpec": { "type": "string", "description": "Instance compute specification.\n" }, "connectionInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/InstanceConnectionInfo:InstanceConnectionInfo" } }, "createdTime": { "type": "string", "description": "Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "eipId": { "type": "string", "description": "EIP ID.\n" }, "instanceDescription": { "type": "string", "description": "Brief description of the Kafka instance. Length must be between 1 and 128 characters.\n" }, "instanceId": { "type": "string", "description": "Kafka instance ID.\n" }, "instanceName": { "type": "string", "description": "Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.\n" }, "instanceStatus": { "type": "string", "description": "Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed\n" }, "ipWhiteLists": { "type": "array", "items": { "type": "string" }, "description": "List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.\n" }, "needRebalance": { "type": "boolean", "description": "Whether to enable rebalancing.\n" }, "parameters": { "type": "string", "description": "Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.\n" }, "partitionNumber": { "type": "integer", "description": "Number of partitions.\n" }, "privateDomainOnPublic": { "type": "boolean", "description": "Whether to enable public network domain resolution.\n" }, "projectName": { "type": "string", "description": "IAM project to which the currently created Kafka instance belongs.\n" }, "storageSpace": { "type": "integer", "description": "Instance storage space, measured in GiB, must be specified as a multiple of 100.\n" }, "storageType": { "type": "string", "description": "Cloud disk type for Kafka instance data storage. Can be set to ESSD*FlexPL or ESSD*PL0; default is ESSD_FlexPL.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID where the instance is located.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/InstanceTag:InstanceTag" } }, "topics": { "type": "array", "items": { "type": "string" }, "description": "List of topics under a Kafka instance\n" }, "usableGroupNumber": { "type": "integer", "description": "The remaining number of available consumer groups for the current instance.\n" }, "usablePartitionNumber": { "type": "integer", "description": "Number of available partitions remaining for the current instance.\n" }, "usedGroupNumber": { "type": "integer", "description": "Number of consumer groups (Group) currently created in the instance.\n" }, "usedPartitionNumber": { "type": "integer", "description": "Number of partitions currently used by the instance.\n" }, "usedStorageSpace": { "type": "integer", "description": "Used storage space of the instance, measured in GiB.\n" }, "usedTopicNumber": { "type": "integer", "description": "Number of topics created in the current instance.\n" }, "userName": { "type": "string", "description": "SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.\n" }, "userPassword": { "type": "string", "description": "Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^\u0026*()_+-=\n" }, "version": { "type": "string", "description": "Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID where the instance is located.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.\n" } }, "type": "object" } }, "volcenginecc:kafka/topic:Topic": { "description": "Topic refers to the message subject and is used to categorize messages. Supports resource management at the Topic level, including creating, viewing, and deleting Topics.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n kafkaTopicDemo:\n type: volcenginecc:kafka:Topic\n name: KafkaTopicDemo\n properties:\n accessPolicies:\n - user_name: KafkaTopicDemo-A\n access_policy: Pub\n - user_name: KafkaTopicDemo-B\n access_policy: Sub\n - user_name: KafkaTopicDemo-C\n access_policy: PubSub\n allAuthority: true\n cleanupPolicies:\n - delete\n - compact\n description: KafkaTopicDemo\n instanceId: kafka-c****f\n parameters: '{\"LogRetentionHours\":\"3\",\"MessageMaxByte\":\"2\",\"MinInsyncReplicaNumber\":\"1\"}'\n partitionNumber: 1\n replicaNumber: 1\n topicName: KafkaTopicDemo\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:kafka/topic:Topic example \"instance_id|topic_name\"\n```\n\n", "properties": { "accessPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/TopicAccessPolicy:TopicAccessPolicy" } }, "allAuthority": { "type": "boolean", "description": "Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.\n" }, "cleanupPolicies": { "type": "array", "items": { "type": "string" }, "description": "Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.\n" }, "createdTime": { "type": "string", "description": "Topic creation time.\n" }, "description": { "type": "string", "description": "Topic description. Maximum length: 128 characters.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "logRetentionHours": { "type": "integer", "description": "Message retention period, in hours. The retention period at the Topic level ranges from 1 to 2160 hours (90 days).\n" }, "parameters": { "type": "string", "description": "Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.\n" }, "partitionNumber": { "type": "integer", "description": "Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.\n" }, "replicaNumber": { "type": "integer", "description": "Number of Topic replicas. Can be set to 2 or 3; the default is 3.\n" }, "status": { "type": "string", "description": "Topic status.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/TopicTag:TopicTag" } }, "topicName": { "type": "string", "description": "Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).\n" }, "usedStoragePercentageInInstance": { "type": "number", "description": "The current Topic data size as a percentage of the instance's total storage space. Displayed on the console as a percentage with two decimal places.\n" }, "usedStorageSpaceInBytes": { "type": "integer", "description": "Total storage space currently used by the Topic.\n" } }, "required": [ "accessPolicies", "allAuthority", "cleanupPolicies", "createdTime", "description", "instanceId", "logRetentionHours", "parameters", "partitionNumber", "replicaNumber", "status", "tags", "topicName", "usedStoragePercentageInInstance", "usedStorageSpaceInBytes" ], "inputProperties": { "accessPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/TopicAccessPolicy:TopicAccessPolicy" } }, "allAuthority": { "type": "boolean", "description": "Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.\n" }, "cleanupPolicies": { "type": "array", "items": { "type": "string" }, "description": "Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.\n" }, "description": { "type": "string", "description": "Topic description. Maximum length: 128 characters.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "parameters": { "type": "string", "description": "Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.\n" }, "partitionNumber": { "type": "integer", "description": "Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.\n" }, "replicaNumber": { "type": "integer", "description": "Number of Topic replicas. Can be set to 2 or 3; the default is 3.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/TopicTag:TopicTag" } }, "topicName": { "type": "string", "description": "Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).\n" } }, "requiredInputs": [ "instanceId", "partitionNumber", "topicName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Topic resources.\n", "properties": { "accessPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/TopicAccessPolicy:TopicAccessPolicy" } }, "allAuthority": { "type": "boolean", "description": "Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.\n" }, "cleanupPolicies": { "type": "array", "items": { "type": "string" }, "description": "Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.\n" }, "createdTime": { "type": "string", "description": "Topic creation time.\n" }, "description": { "type": "string", "description": "Topic description. Maximum length: 128 characters.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "logRetentionHours": { "type": "integer", "description": "Message retention period, in hours. The retention period at the Topic level ranges from 1 to 2160 hours (90 days).\n" }, "parameters": { "type": "string", "description": "Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.\n" }, "partitionNumber": { "type": "integer", "description": "Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.\n" }, "replicaNumber": { "type": "integer", "description": "Number of Topic replicas. Can be set to 2 or 3; the default is 3.\n" }, "status": { "type": "string", "description": "Topic status.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kafka/TopicTag:TopicTag" } }, "topicName": { "type": "string", "description": "Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).\n" }, "usedStoragePercentageInInstance": { "type": "number", "description": "The current Topic data size as a percentage of the instance's total storage space. Displayed on the console as a percentage with two decimal places.\n" }, "usedStorageSpaceInBytes": { "type": "integer", "description": "Total storage space currently used by the Topic.\n" } }, "type": "object" } }, "volcenginecc:kms/key:Key": { "description": "Key Management Service (KMS) is a one-stop key management and data encryption platform on Volcano Engine. It provides easy-to-use encryption interfaces. KMS helps users easily manage keys and protect the security of core cloud data. It also greatly reduces the procurement and development costs for users to deploy their own cryptographic infrastructure. KMS helps businesses easily meet regulatory and compliance requirements.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n kMSKeyDemo:\n type: volcenginecc:kms:Key\n name: KMSKeyDemo\n properties:\n keyringName: KMSKeyDemo\n keyName: KMSKeyDemoKeyName\n keySpec: SYMMETRIC_256\n description: description KMSKeyDemo\n keyUsage: ENCRYPT_DECRYPT\n protectionLevel: HSM\n rotateState: Enable\n origin: CloudKMS\n multiRegion: false\n rotateInterval: 900\n keyEnableOperation: 1\n keyRotationOperation: 1\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:kms/key:Key example \"keyring_name|key_id\"\n```\n\n", "properties": { "createdTime": { "type": "integer", "description": "Key creation time.\n" }, "description": { "type": "string", "description": "Key description: Length 0–8192 characters.\n" }, "keyArchiveOperation": { "type": "integer", "description": "User master key archive operation (enter 1 to archive, 2 to unarchive).\n" }, "keyEnableOperation": { "type": "integer", "description": "User master key enable operation (enter 1 to enable, 2 to disable).\n" }, "keyId": { "type": "string", "description": "Key unique identifier in UUID format.\n" }, "keyMaterialExpireTime": { "type": "string", "description": "Key material expiration time. If empty, the key does not expire.\n" }, "keyName": { "type": "string", "description": "Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].\n" }, "keyRotationOperation": { "type": "integer", "description": "User master key rotation operation (enter 1 to enable, 2 to disable).\n" }, "keySpec": { "type": "string", "description": "Symmetric keys: SYMMETRIC*256, SYMMETRIC*128; asymmetric keys: RSA*2048, RSA*3072, RSA*4096, EC*P256, EC*P256K, EC*P384, EC*P521, EC*SM2.\n" }, "keyState": { "type": "string", "description": "Key status: Enable, Disable, PendingDelete, Archived, PendingImport.\n", "language": { "csharp": { "name": "KeyStateValue" } } }, "keyUsage": { "type": "string", "description": "Key usage. Options: ENCRYPT*DECRYPT, SIGN*VERIFY, GENERATE*VERIFY*MAC.\n" }, "keyringName": { "type": "string", "description": "Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].\n" }, "lastRotationTime": { "type": "string", "description": "Key last rotation time.\n" }, "multiRegion": { "type": "boolean", "description": "Is this a multi-region type master key.\n" }, "multiRegionConfiguration": { "$ref": "#/types/volcenginecc:kms/KeyMultiRegionConfiguration:KeyMultiRegionConfiguration", "description": "Multi-region key configuration information.\n" }, "origin": { "type": "string", "description": "Key source. Options: CloudKMS, External, ExternalKeyStore.\n" }, "protectionLevel": { "type": "string", "description": "Key protection level. Options: SOFTWARE, HSM.\n" }, "rotateInterval": { "type": "integer", "description": "Key rotation period (days). Range: [90, 2560].\n" }, "rotateState": { "type": "string", "description": "Key rotation status. Options: Enable, Disable.\n" }, "scheduleDeleteTime": { "type": "string", "description": "Key deletion time.\n" }, "scheduleRotationTime": { "type": "string", "description": "Key rotation time.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kms/KeyTag:KeyTag" } }, "trn": { "type": "string", "description": "Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.\n" }, "updatedTime": { "type": "integer", "description": "Key update time.\n" } }, "required": [ "createdTime", "description", "keyArchiveOperation", "keyEnableOperation", "keyId", "keyMaterialExpireTime", "keyName", "keyRotationOperation", "keySpec", "keyState", "keyUsage", "keyringName", "lastRotationTime", "multiRegion", "multiRegionConfiguration", "origin", "protectionLevel", "rotateInterval", "rotateState", "scheduleDeleteTime", "scheduleRotationTime", "tags", "trn", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Key description: Length 0–8192 characters.\n" }, "keyArchiveOperation": { "type": "integer", "description": "User master key archive operation (enter 1 to archive, 2 to unarchive).\n" }, "keyEnableOperation": { "type": "integer", "description": "User master key enable operation (enter 1 to enable, 2 to disable).\n" }, "keyName": { "type": "string", "description": "Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].\n" }, "keyRotationOperation": { "type": "integer", "description": "User master key rotation operation (enter 1 to enable, 2 to disable).\n" }, "keySpec": { "type": "string", "description": "Symmetric keys: SYMMETRIC*256, SYMMETRIC*128; asymmetric keys: RSA*2048, RSA*3072, RSA*4096, EC*P256, EC*P256K, EC*P384, EC*P521, EC*SM2.\n" }, "keyUsage": { "type": "string", "description": "Key usage. Options: ENCRYPT*DECRYPT, SIGN*VERIFY, GENERATE*VERIFY*MAC.\n" }, "keyringName": { "type": "string", "description": "Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].\n" }, "multiRegion": { "type": "boolean", "description": "Is this a multi-region type master key.\n" }, "origin": { "type": "string", "description": "Key source. Options: CloudKMS, External, ExternalKeyStore.\n" }, "protectionLevel": { "type": "string", "description": "Key protection level. Options: SOFTWARE, HSM.\n" }, "rotateInterval": { "type": "integer", "description": "Key rotation period (days). Range: [90, 2560].\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kms/KeyTag:KeyTag" } } }, "requiredInputs": [ "keyName", "keyringName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Key resources.\n", "properties": { "createdTime": { "type": "integer", "description": "Key creation time.\n" }, "description": { "type": "string", "description": "Key description: Length 0–8192 characters.\n" }, "keyArchiveOperation": { "type": "integer", "description": "User master key archive operation (enter 1 to archive, 2 to unarchive).\n" }, "keyEnableOperation": { "type": "integer", "description": "User master key enable operation (enter 1 to enable, 2 to disable).\n" }, "keyId": { "type": "string", "description": "Key unique identifier in UUID format.\n" }, "keyMaterialExpireTime": { "type": "string", "description": "Key material expiration time. If empty, the key does not expire.\n" }, "keyName": { "type": "string", "description": "Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].\n" }, "keyRotationOperation": { "type": "integer", "description": "User master key rotation operation (enter 1 to enable, 2 to disable).\n" }, "keySpec": { "type": "string", "description": "Symmetric keys: SYMMETRIC*256, SYMMETRIC*128; asymmetric keys: RSA*2048, RSA*3072, RSA*4096, EC*P256, EC*P256K, EC*P384, EC*P521, EC*SM2.\n" }, "keyState": { "type": "string", "description": "Key status: Enable, Disable, PendingDelete, Archived, PendingImport.\n", "language": { "csharp": { "name": "KeyStateValue" } } }, "keyUsage": { "type": "string", "description": "Key usage. Options: ENCRYPT*DECRYPT, SIGN*VERIFY, GENERATE*VERIFY*MAC.\n" }, "keyringName": { "type": "string", "description": "Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].\n" }, "lastRotationTime": { "type": "string", "description": "Key last rotation time.\n" }, "multiRegion": { "type": "boolean", "description": "Is this a multi-region type master key.\n" }, "multiRegionConfiguration": { "$ref": "#/types/volcenginecc:kms/KeyMultiRegionConfiguration:KeyMultiRegionConfiguration", "description": "Multi-region key configuration information.\n" }, "origin": { "type": "string", "description": "Key source. Options: CloudKMS, External, ExternalKeyStore.\n" }, "protectionLevel": { "type": "string", "description": "Key protection level. Options: SOFTWARE, HSM.\n" }, "rotateInterval": { "type": "integer", "description": "Key rotation period (days). Range: [90, 2560].\n" }, "rotateState": { "type": "string", "description": "Key rotation status. Options: Enable, Disable.\n" }, "scheduleDeleteTime": { "type": "string", "description": "Key deletion time.\n" }, "scheduleRotationTime": { "type": "string", "description": "Key rotation time.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:kms/KeyTag:KeyTag" } }, "trn": { "type": "string", "description": "Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.\n" }, "updatedTime": { "type": "integer", "description": "Key update time.\n" } }, "type": "object" } }, "volcenginecc:kms/keyRing:KeyRing": { "description": "A collection for managing user keys; users place keys of the same type or purpose in the same keyring for easier management\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst kmskeyringDemo = new volcenginecc.kms.KeyRing(\"kmskeyringDemo\", {\n description: \"this is a test update\",\n keyringName: \"ccapi-test\",\n keyringType: \"CustomKeyring\",\n projectName: \"default\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nkmskeyring_demo = volcenginecc.kms.KeyRing(\"kmskeyringDemo\",\n description=\"this is a test update\",\n keyring_name=\"ccapi-test\",\n keyring_type=\"CustomKeyring\",\n project_name=\"default\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var kmskeyringDemo = new Volcenginecc.Kms.KeyRing(\"kmskeyringDemo\", new()\n {\n Description = \"this is a test update\",\n KeyringName = \"ccapi-test\",\n KeyringType = \"CustomKeyring\",\n ProjectName = \"default\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/kms\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := kms.NewKeyRing(ctx, \"kmskeyringDemo\", \u0026kms.KeyRingArgs{\n\t\t\tDescription: pulumi.String(\"this is a test update\"),\n\t\t\tKeyringName: pulumi.String(\"ccapi-test\"),\n\t\t\tKeyringType: pulumi.String(\"CustomKeyring\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.kms.KeyRing;\nimport com.volcengine.volcenginecc.kms.KeyRingArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var kmskeyringDemo = new KeyRing(\"kmskeyringDemo\", KeyRingArgs.builder()\n .description(\"this is a test update\")\n .keyringName(\"ccapi-test\")\n .keyringType(\"CustomKeyring\")\n .projectName(\"default\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n kmskeyringDemo:\n type: volcenginecc:kms:KeyRing\n properties:\n description: this is a test update\n keyringName: ccapi-test\n keyringType: CustomKeyring\n projectName: default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:kms/keyRing:KeyRing example \"key_ring_id\"\n```\n\n", "properties": { "createDate": { "type": "integer", "description": "Keyring creation date\n" }, "description": { "type": "string", "description": "Keyring description, length: 0–8192 characters\n" }, "keyCount": { "type": "integer", "description": "Number of keys in keyring\n" }, "keyRingId": { "type": "string", "description": "Keyring unique identifier, in UUID format\n" }, "keyringName": { "type": "string", "description": "Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]\n" }, "keyringType": { "type": "string", "description": "Keyring type, value: CustomKeyring\n" }, "projectName": { "type": "string", "description": "Project name, default value: default\n" }, "uid": { "type": "string", "description": "Keyring tenant ID\n" }, "updateDate": { "type": "integer", "description": "Keyring update date\n" } }, "required": [ "createDate", "description", "keyCount", "keyRingId", "keyringName", "keyringType", "projectName", "uid", "updateDate" ], "inputProperties": { "description": { "type": "string", "description": "Keyring description, length: 0–8192 characters\n" }, "keyringName": { "type": "string", "description": "Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]\n" }, "keyringType": { "type": "string", "description": "Keyring type, value: CustomKeyring\n" }, "projectName": { "type": "string", "description": "Project name, default value: default\n" } }, "requiredInputs": [ "keyringName" ], "stateInputs": { "description": "Input properties used for looking up and filtering KeyRing resources.\n", "properties": { "createDate": { "type": "integer", "description": "Keyring creation date\n" }, "description": { "type": "string", "description": "Keyring description, length: 0–8192 characters\n" }, "keyCount": { "type": "integer", "description": "Number of keys in keyring\n" }, "keyRingId": { "type": "string", "description": "Keyring unique identifier, in UUID format\n" }, "keyringName": { "type": "string", "description": "Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]\n" }, "keyringType": { "type": "string", "description": "Keyring type, value: CustomKeyring\n" }, "projectName": { "type": "string", "description": "Project name, default value: default\n" }, "uid": { "type": "string", "description": "Keyring tenant ID\n" }, "updateDate": { "type": "integer", "description": "Keyring update date\n" } }, "type": "object" } }, "volcenginecc:mongodb/allowList:AllowList": { "description": "After you create a MongoDB document database instance, you can set an allowlist for the instance to permit external devices to access it. This article describes how to set an allowlist in the console.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n mongoDBAllowListDemo:\n type: volcenginecc:mongodb:AllowList\n name: MongoDBAllowListDemo\n properties:\n allowListName: mongodb_allowlist-1\n allowListType: IPv4\n projectName: default\n allowListDesc: test\n allowListCategory: Ordinary\n allowLists:\n - 0.0.0.0/0\n - 127.0.0.1\n - 192.168.1.0/24\n associatedInstances:\n - instance_id: mongo-shard-d838exxxxx\n - instance_id: mongo-replica-63axxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:mongodb/allowList:AllowList example \"allow_list_id\"\n```\n\n", "properties": { "allowListCategory": { "type": "string", "description": "Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.\n" }, "allowListDesc": { "type": "string", "description": "Allowlist remarks. Maximum length: 200 characters.\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or address ranges) in the allowlist.\n" }, "allowListName": { "type": "string", "description": "Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 addresses are currently supported.\n" }, "allowLists": { "type": "array", "items": { "type": "string" }, "description": "Enter an IP address or a CIDR-format IP address range.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the current allowlist.\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "projectName": { "type": "string", "description": "Project to which the current allowlist belongs.\n" } }, "required": [ "allowLists", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "projectName" ], "inputProperties": { "allowListCategory": { "type": "string", "description": "Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.\n" }, "allowListDesc": { "type": "string", "description": "Allowlist remarks. Maximum length: 200 characters.\n" }, "allowListName": { "type": "string", "description": "Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 addresses are currently supported.\n" }, "allowLists": { "type": "array", "items": { "type": "string" }, "description": "Enter an IP address or a CIDR-format IP address range.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "projectName": { "type": "string", "description": "Project to which the current allowlist belongs.\n" } }, "requiredInputs": [ "allowLists", "allowListName" ], "stateInputs": { "description": "Input properties used for looking up and filtering AllowList resources.\n", "properties": { "allowListCategory": { "type": "string", "description": "Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.\n" }, "allowListDesc": { "type": "string", "description": "Allowlist remarks. Maximum length: 200 characters.\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or address ranges) in the allowlist.\n" }, "allowListName": { "type": "string", "description": "Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 addresses are currently supported.\n" }, "allowLists": { "type": "array", "items": { "type": "string" }, "description": "Enter an IP address or a CIDR-format IP address range.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the current allowlist.\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "projectName": { "type": "string", "description": "Project to which the current allowlist belongs.\n" } }, "type": "object" } }, "volcenginecc:mongodb/instance:Instance": { "description": "MongoDB document database supports multiple architectures for flexible business deployment. In addition to replica set instances, MongoDB document database also provides sharded cluster architecture for large-scale data scenarios, along with disaster recovery, backup and restore, monitoring, and a complete solution set. It is widely used in industries such as internet (gaming, e-commerce, live streaming, news, social), new retail, online education, finance, IoT, and government/enterprise.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst mongoDBInstanceDemo = new volcenginecc.mongodb.Instance(\"MongoDBInstanceDemo\", {\n zoneId: \"cn-beijing-a,cn-beijing-c,cn-beijing-d\",\n vpcId: \"vpc-1a1vgeo9xxxcg8nvepjyxxxxx\",\n subnetId: \"subnet-ij9s4hxxxs3k74o8cuxxxxx\",\n dbEngine: \"MongoDB\",\n dbEngineVersion: \"MongoDB_7_0\",\n instanceType: \"ShardedCluster\",\n nodeSpec: \"mongo.shard.2c4g\",\n nodeNumber: 3,\n mongosNodeSpec: \"mongo.mongos.2c4g\",\n mongosNodeNumber: 3,\n shardNumber: 2,\n storageSpaceGb: 100,\n configServerNodeSpec: \"mongo.config.2c4g\",\n configServerStorageSpaceGb: 20,\n superAccountName: \"****\",\n superAccountPassword: \"*******\",\n instanceName: \"MongoDBInstanceDemo\",\n instanceCount: 1,\n chargeType: \"PostPaid\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n allowListIds: [\n \"acl-c972e7b4ce4941a1a8d5xxxe57xxxxx\",\n \"acl-70dbb8ee8893467dbafxxxc964xxxxx\",\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nmongo_db_instance_demo = volcenginecc.mongodb.Instance(\"MongoDBInstanceDemo\",\n zone_id=\"cn-beijing-a,cn-beijing-c,cn-beijing-d\",\n vpc_id=\"vpc-1a1vgeo9xxxcg8nvepjyxxxxx\",\n subnet_id=\"subnet-ij9s4hxxxs3k74o8cuxxxxx\",\n db_engine=\"MongoDB\",\n db_engine_version=\"MongoDB_7_0\",\n instance_type=\"ShardedCluster\",\n node_spec=\"mongo.shard.2c4g\",\n node_number=3,\n mongos_node_spec=\"mongo.mongos.2c4g\",\n mongos_node_number=3,\n shard_number=2,\n storage_space_gb=100,\n config_server_node_spec=\"mongo.config.2c4g\",\n config_server_storage_space_gb=20,\n super_account_name=\"****\",\n super_account_password=\"*******\",\n instance_name=\"MongoDBInstanceDemo\",\n instance_count=1,\n charge_type=\"PostPaid\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }],\n allow_list_ids=[\n \"acl-c972e7b4ce4941a1a8d5xxxe57xxxxx\",\n \"acl-70dbb8ee8893467dbafxxxc964xxxxx\",\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var mongoDBInstanceDemo = new Volcenginecc.Mongodb.Instance(\"MongoDBInstanceDemo\", new()\n {\n ZoneId = \"cn-beijing-a,cn-beijing-c,cn-beijing-d\",\n VpcId = \"vpc-1a1vgeo9xxxcg8nvepjyxxxxx\",\n SubnetId = \"subnet-ij9s4hxxxs3k74o8cuxxxxx\",\n DbEngine = \"MongoDB\",\n DbEngineVersion = \"MongoDB_7_0\",\n InstanceType = \"ShardedCluster\",\n NodeSpec = \"mongo.shard.2c4g\",\n NodeNumber = 3,\n MongosNodeSpec = \"mongo.mongos.2c4g\",\n MongosNodeNumber = 3,\n ShardNumber = 2,\n StorageSpaceGb = 100,\n ConfigServerNodeSpec = \"mongo.config.2c4g\",\n ConfigServerStorageSpaceGb = 20,\n SuperAccountName = \"****\",\n SuperAccountPassword = \"*******\",\n InstanceName = \"MongoDBInstanceDemo\",\n InstanceCount = 1,\n ChargeType = \"PostPaid\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Mongodb.Inputs.InstanceTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n AllowListIds = new[]\n {\n \"acl-c972e7b4ce4941a1a8d5xxxe57xxxxx\",\n \"acl-70dbb8ee8893467dbafxxxc964xxxxx\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/mongodb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := mongodb.NewInstance(ctx, \"MongoDBInstanceDemo\", \u0026mongodb.InstanceArgs{\n\t\t\tZoneId: pulumi.String(\"cn-beijing-a,cn-beijing-c,cn-beijing-d\"),\n\t\t\tVpcId: pulumi.String(\"vpc-1a1vgeo9xxxcg8nvepjyxxxxx\"),\n\t\t\tSubnetId: pulumi.String(\"subnet-ij9s4hxxxs3k74o8cuxxxxx\"),\n\t\t\tDbEngine: pulumi.String(\"MongoDB\"),\n\t\t\tDbEngineVersion: pulumi.String(\"MongoDB_7_0\"),\n\t\t\tInstanceType: pulumi.String(\"ShardedCluster\"),\n\t\t\tNodeSpec: pulumi.String(\"mongo.shard.2c4g\"),\n\t\t\tNodeNumber: pulumi.Int(3),\n\t\t\tMongosNodeSpec: pulumi.String(\"mongo.mongos.2c4g\"),\n\t\t\tMongosNodeNumber: pulumi.Int(3),\n\t\t\tShardNumber: pulumi.Int(2),\n\t\t\tStorageSpaceGb: pulumi.Int(100),\n\t\t\tConfigServerNodeSpec: pulumi.String(\"mongo.config.2c4g\"),\n\t\t\tConfigServerStorageSpaceGb: pulumi.Int(20),\n\t\t\tSuperAccountName: pulumi.String(\"****\"),\n\t\t\tSuperAccountPassword: pulumi.String(\"*******\"),\n\t\t\tInstanceName: pulumi.String(\"MongoDBInstanceDemo\"),\n\t\t\tInstanceCount: pulumi.Int(1),\n\t\t\tChargeType: pulumi.String(\"PostPaid\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: mongodb.InstanceTagArray{\n\t\t\t\t\u0026mongodb.InstanceTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tAllowListIds: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"acl-c972e7b4ce4941a1a8d5xxxe57xxxxx\"),\n\t\t\t\tpulumi.String(\"acl-70dbb8ee8893467dbafxxxc964xxxxx\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.mongodb.Instance;\nimport com.volcengine.volcenginecc.mongodb.InstanceArgs;\nimport com.pulumi.volcenginecc.mongodb.inputs.InstanceTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var mongoDBInstanceDemo = new Instance(\"mongoDBInstanceDemo\", InstanceArgs.builder()\n .zoneId(\"cn-beijing-a,cn-beijing-c,cn-beijing-d\")\n .vpcId(\"vpc-1a1vgeo9xxxcg8nvepjyxxxxx\")\n .subnetId(\"subnet-ij9s4hxxxs3k74o8cuxxxxx\")\n .dbEngine(\"MongoDB\")\n .dbEngineVersion(\"MongoDB_7_0\")\n .instanceType(\"ShardedCluster\")\n .nodeSpec(\"mongo.shard.2c4g\")\n .nodeNumber(3)\n .mongosNodeSpec(\"mongo.mongos.2c4g\")\n .mongosNodeNumber(3)\n .shardNumber(2)\n .storageSpaceGb(100)\n .configServerNodeSpec(\"mongo.config.2c4g\")\n .configServerStorageSpaceGb(20)\n .superAccountName(\"****\")\n .superAccountPassword(\"*******\")\n .instanceName(\"MongoDBInstanceDemo\")\n .instanceCount(1)\n .chargeType(\"PostPaid\")\n .projectName(\"default\")\n .tags(InstanceTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .allowListIds( \n \"acl-c972e7b4ce4941a1a8d5xxxe57xxxxx\",\n \"acl-70dbb8ee8893467dbafxxxc964xxxxx\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n mongoDBInstanceDemo:\n type: volcenginecc:mongodb:Instance\n name: MongoDBInstanceDemo\n properties:\n zoneId: cn-beijing-a,cn-beijing-c,cn-beijing-d\n vpcId: vpc-1a1vgeo9xxxcg8nvepjyxxxxx\n subnetId: subnet-ij9s4hxxxs3k74o8cuxxxxx\n dbEngine: MongoDB\n dbEngineVersion: MongoDB_7_0\n instanceType: ShardedCluster\n nodeSpec: mongo.shard.2c4g\n nodeNumber: 3\n mongosNodeSpec: mongo.mongos.2c4g\n mongosNodeNumber: 3\n shardNumber: 2\n storageSpaceGb: 100\n configServerNodeSpec: mongo.config.2c4g\n configServerStorageSpaceGb: 20\n superAccountName: '****'\n superAccountPassword: '*******'\n instanceName: MongoDBInstanceDemo\n instanceCount: 1\n chargeType: PostPaid\n projectName: default\n tags:\n - key: env\n value: test\n allowListIds:\n - acl-c972e7b4ce4941a1a8d5xxxe57xxxxx\n - acl-70dbb8ee8893467dbafxxxc964xxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:mongodb/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID list. New instances are bound to the specified allowlist.\n" }, "autoRenew": { "type": "boolean", "description": "Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).\n" }, "closedTime": { "type": "string", "description": "Scheduled shutdown time (UTC).\n" }, "configServerNodeSpec": { "type": "string", "description": "ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.\n" }, "configServerStorageSpaceGb": { "type": "integer", "description": "ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.\n" }, "configServers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceConfigServer:InstanceConfigServer" } }, "configServersId": { "type": "string", "description": "ConfigServer ID\n" }, "createdTime": { "type": "string", "description": "Instance creation time (UTC).\n" }, "dbEngine": { "type": "string", "description": "Database engine. The value is fixed as MongoDB\n" }, "dbEngineVersion": { "type": "string", "description": "Database engine version. Options: MongoDB*4*0 (default): MongoDB 4.0. MongoDB*4*2: MongoDB 4.2. MongoDB*4*4: MongoDB 4.4. MongoDB*5*0: MongoDB 5.0. MongoDB*6*0: MongoDB 6.0. MongoDB*7*0: MongoDB 7.0.\n" }, "dbEngineVersionStr": { "type": "string", "description": "Database engine version string\n" }, "expiredTime": { "type": "string", "description": "Instance expiration time (UTC).\n" }, "instanceCount": { "type": "integer", "description": "Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.\n" }, "instanceStatus": { "type": "string", "description": "Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.\n" }, "instanceType": { "type": "string", "description": "MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.\n" }, "mongos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceMongo:InstanceMongo" } }, "mongosId": { "type": "string", "description": "Mongos ID.\n" }, "mongosNodeNumber": { "type": "integer", "description": "Number of Mongos nodes in the sharded cluster. Range: 2~32.\n" }, "mongosNodeSpec": { "type": "string", "description": "Specification code for Mongos nodes in a sharded cluster.\n" }, "nodeAvailabilityZones": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceNodeAvailabilityZone:InstanceNodeAvailabilityZone" } }, "nodeNumber": { "type": "integer", "description": "Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.\n" }, "nodeSpec": { "type": "string", "description": "Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceNode:InstanceNode" } }, "period": { "type": "integer", "description": "Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.\n" }, "periodUnit": { "type": "string", "description": "Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.\n" }, "privateEndpoint": { "type": "string", "description": "String information for the instance's private network connection address.\n" }, "projectName": { "type": "string", "description": "Select the project for the instance. If left blank, the new instance will be added to the default project.\n" }, "readOnlyNodeNumber": { "type": "integer", "description": "Number of read-only nodes in the instance\n" }, "reclaimTime": { "type": "string", "description": "Scheduled recycle time for the instance (UTC)\n" }, "shardNumber": { "type": "integer", "description": "Number of shards in the sharded cluster. Range: 2–32.\n" }, "shards": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceShard:InstanceShard" } }, "storageSpaceGb": { "type": "integer", "description": "Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.\n" }, "storageType": { "type": "string", "description": "Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "superAccountName": { "type": "string", "description": "Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.\n" }, "superAccountPassword": { "type": "string", "description": "Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^\u0026*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceTag:InstanceTag" } }, "updatedTime": { "type": "string", "description": "Instance update time (UTC).\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "zoneId": { "type": "string", "description": "The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).\n" } }, "required": [ "allowListIds", "autoRenew", "chargeStatus", "chargeType", "closedTime", "configServerNodeSpec", "configServerStorageSpaceGb", "configServers", "configServersId", "createdTime", "dbEngine", "dbEngineVersion", "dbEngineVersionStr", "expiredTime", "instanceCount", "instanceId", "instanceName", "instanceStatus", "instanceType", "mongos", "mongosId", "mongosNodeNumber", "mongosNodeSpec", "nodeAvailabilityZones", "nodeNumber", "nodeSpec", "nodes", "period", "periodUnit", "privateEndpoint", "projectName", "readOnlyNodeNumber", "reclaimTime", "shardNumber", "shards", "storageSpaceGb", "storageType", "subnetId", "superAccountName", "superAccountPassword", "tags", "updatedTime", "vpcId", "zoneId" ], "inputProperties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID list. New instances are bound to the specified allowlist.\n" }, "autoRenew": { "type": "boolean", "description": "Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).\n" }, "configServerNodeSpec": { "type": "string", "description": "ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.\n" }, "configServerStorageSpaceGb": { "type": "integer", "description": "ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.\n" }, "dbEngine": { "type": "string", "description": "Database engine. The value is fixed as MongoDB\n" }, "dbEngineVersion": { "type": "string", "description": "Database engine version. Options: MongoDB*4*0 (default): MongoDB 4.0. MongoDB*4*2: MongoDB 4.2. MongoDB*4*4: MongoDB 4.4. MongoDB*5*0: MongoDB 5.0. MongoDB*6*0: MongoDB 6.0. MongoDB*7*0: MongoDB 7.0.\n" }, "instanceCount": { "type": "integer", "description": "Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.\n" }, "instanceName": { "type": "string", "description": "Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.\n" }, "instanceType": { "type": "string", "description": "MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.\n" }, "mongosNodeNumber": { "type": "integer", "description": "Number of Mongos nodes in the sharded cluster. Range: 2~32.\n" }, "mongosNodeSpec": { "type": "string", "description": "Specification code for Mongos nodes in a sharded cluster.\n" }, "nodeAvailabilityZones": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceNodeAvailabilityZone:InstanceNodeAvailabilityZone" } }, "nodeNumber": { "type": "integer", "description": "Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.\n" }, "nodeSpec": { "type": "string", "description": "Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.\n" }, "period": { "type": "integer", "description": "Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.\n" }, "periodUnit": { "type": "string", "description": "Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.\n" }, "projectName": { "type": "string", "description": "Select the project for the instance. If left blank, the new instance will be added to the default project.\n" }, "shardNumber": { "type": "integer", "description": "Number of shards in the sharded cluster. Range: 2–32.\n" }, "storageSpaceGb": { "type": "integer", "description": "Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "superAccountName": { "type": "string", "description": "Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.\n" }, "superAccountPassword": { "type": "string", "description": "Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^\u0026*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceTag:InstanceTag" } }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "zoneId": { "type": "string", "description": "The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).\n" } }, "requiredInputs": [ "nodeSpec", "storageSpaceGb", "subnetId", "vpcId", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID list. New instances are bound to the specified allowlist.\n" }, "autoRenew": { "type": "boolean", "description": "Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.\n" }, "chargeStatus": { "type": "string", "description": "Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).\n" }, "closedTime": { "type": "string", "description": "Scheduled shutdown time (UTC).\n" }, "configServerNodeSpec": { "type": "string", "description": "ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.\n" }, "configServerStorageSpaceGb": { "type": "integer", "description": "ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.\n" }, "configServers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceConfigServer:InstanceConfigServer" } }, "configServersId": { "type": "string", "description": "ConfigServer ID\n" }, "createdTime": { "type": "string", "description": "Instance creation time (UTC).\n" }, "dbEngine": { "type": "string", "description": "Database engine. The value is fixed as MongoDB\n" }, "dbEngineVersion": { "type": "string", "description": "Database engine version. Options: MongoDB*4*0 (default): MongoDB 4.0. MongoDB*4*2: MongoDB 4.2. MongoDB*4*4: MongoDB 4.4. MongoDB*5*0: MongoDB 5.0. MongoDB*6*0: MongoDB 6.0. MongoDB*7*0: MongoDB 7.0.\n" }, "dbEngineVersionStr": { "type": "string", "description": "Database engine version string\n" }, "expiredTime": { "type": "string", "description": "Instance expiration time (UTC).\n" }, "instanceCount": { "type": "integer", "description": "Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.\n" }, "instanceStatus": { "type": "string", "description": "Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.\n" }, "instanceType": { "type": "string", "description": "MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.\n" }, "mongos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceMongo:InstanceMongo" } }, "mongosId": { "type": "string", "description": "Mongos ID.\n" }, "mongosNodeNumber": { "type": "integer", "description": "Number of Mongos nodes in the sharded cluster. Range: 2~32.\n" }, "mongosNodeSpec": { "type": "string", "description": "Specification code for Mongos nodes in a sharded cluster.\n" }, "nodeAvailabilityZones": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceNodeAvailabilityZone:InstanceNodeAvailabilityZone" } }, "nodeNumber": { "type": "integer", "description": "Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.\n" }, "nodeSpec": { "type": "string", "description": "Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceNode:InstanceNode" } }, "period": { "type": "integer", "description": "Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.\n" }, "periodUnit": { "type": "string", "description": "Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.\n" }, "privateEndpoint": { "type": "string", "description": "String information for the instance's private network connection address.\n" }, "projectName": { "type": "string", "description": "Select the project for the instance. If left blank, the new instance will be added to the default project.\n" }, "readOnlyNodeNumber": { "type": "integer", "description": "Number of read-only nodes in the instance\n" }, "reclaimTime": { "type": "string", "description": "Scheduled recycle time for the instance (UTC)\n" }, "shardNumber": { "type": "integer", "description": "Number of shards in the sharded cluster. Range: 2–32.\n" }, "shards": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceShard:InstanceShard" } }, "storageSpaceGb": { "type": "integer", "description": "Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.\n" }, "storageType": { "type": "string", "description": "Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "superAccountName": { "type": "string", "description": "Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.\n" }, "superAccountPassword": { "type": "string", "description": "Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^\u0026*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:mongodb/InstanceTag:InstanceTag" } }, "updatedTime": { "type": "string", "description": "Instance update time (UTC).\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "zoneId": { "type": "string", "description": "The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).\n" } }, "type": "object" } }, "volcenginecc:mongodb/sslState:SslState": { "description": "SSL encryption settings for the MongoDB instance, including whether the feature is enabled, SSL certificate expiration time, and other information.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst mongoDBSSLStateDemo = new volcenginecc.mongodb.SslState(\"MongoDBSSLStateDemo\", {\n instanceId: \"mongo-replica-d1****\",\n sslAction: \"Open\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nmongo_dbssl_state_demo = volcenginecc.mongodb.SslState(\"MongoDBSSLStateDemo\",\n instance_id=\"mongo-replica-d1****\",\n ssl_action=\"Open\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var mongoDBSSLStateDemo = new Volcenginecc.Mongodb.SslState(\"MongoDBSSLStateDemo\", new()\n {\n InstanceId = \"mongo-replica-d1****\",\n SslAction = \"Open\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/mongodb\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := mongodb.NewSslState(ctx, \"MongoDBSSLStateDemo\", \u0026mongodb.SslStateArgs{\n\t\t\tInstanceId: pulumi.String(\"mongo-replica-d1****\"),\n\t\t\tSslAction: pulumi.String(\"Open\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.mongodb.SslState;\nimport com.volcengine.volcenginecc.mongodb.SslStateArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var mongoDBSSLStateDemo = new SslState(\"mongoDBSSLStateDemo\", SslStateArgs.builder()\n .instanceId(\"mongo-replica-d1****\")\n .sslAction(\"Open\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n mongoDBSSLStateDemo:\n type: volcenginecc:mongodb:SslState\n name: MongoDBSSLStateDemo\n properties:\n instanceId: mongo-replica-d1****\n sslAction: Open\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:mongodb/sslState:SslState example \"instance_id\"\n```\n\n", "properties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "isValid": { "type": "boolean", "description": "Whether the SSL certificate is valid. Possible values: - true: Valid - false: Invalid\n" }, "sslAction": { "type": "string", "description": "Perform operations on the SSL encryption feature. Possible values: - Open (default): Enable SSL encryption - Close: Disable SSL encryption - Update: Update SSL certificate validity period. You can update the SSL certificate validity period only after SSL encryption is enabled.\n" }, "sslEnable": { "type": "boolean", "description": "Whether SSL encryption is enabled. Possible values: - true: Enabled - false: Disabled\n" }, "sslExpiredTime": { "type": "string", "description": "SSL certificate expiration time, formatted as yyyy-MM-ddTHH:mm:ssZ (UTC). This parameter is returned only when the SSL certificate is valid (that is, IsValid is true).\n" } }, "required": [ "instanceId", "isValid", "sslAction", "sslEnable", "sslExpiredTime" ], "inputProperties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "sslAction": { "type": "string", "description": "Perform operations on the SSL encryption feature. Possible values: - Open (default): Enable SSL encryption - Close: Disable SSL encryption - Update: Update SSL certificate validity period. You can update the SSL certificate validity period only after SSL encryption is enabled.\n" } }, "requiredInputs": [ "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering SslState resources.\n", "properties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "isValid": { "type": "boolean", "description": "Whether the SSL certificate is valid. Possible values: - true: Valid - false: Invalid\n" }, "sslAction": { "type": "string", "description": "Perform operations on the SSL encryption feature. Possible values: - Open (default): Enable SSL encryption - Close: Disable SSL encryption - Update: Update SSL certificate validity period. You can update the SSL certificate validity period only after SSL encryption is enabled.\n" }, "sslEnable": { "type": "boolean", "description": "Whether SSL encryption is enabled. Possible values: - true: Enabled - false: Disabled\n" }, "sslExpiredTime": { "type": "string", "description": "SSL certificate expiration time, formatted as yyyy-MM-ddTHH:mm:ssZ (UTC). This parameter is returned only when the SSL certificate is valid (that is, IsValid is true).\n" } }, "type": "object" } }, "volcenginecc:natgateway/dnatentry:Dnatentry": { "description": "Destination address translation. When the transit IP and port are accessed, the private NAT gateway replaces the destination address and port in the request with the private IP and port of the cloud server, then forwards the request.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst natGatewayDnatentryDemo = new volcenginecc.natgateway.Dnatentry(\"NatGatewayDnatentryDemo\", {\n dnatEntryName: \"NatGatewayDnatentryDemo\",\n protocol: \"udp\",\n internalIp: \"192.168.xxx.53\",\n internalPort: \"20-25\",\n externalIp: \"115.190.xxx.9\",\n externalPort: \"25-30\",\n natGatewayId: \"ngw-2pc28yhdpbx8g227qo1sxxxxx\",\n portType: \"specified\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nnat_gateway_dnatentry_demo = volcenginecc.natgateway.Dnatentry(\"NatGatewayDnatentryDemo\",\n dnat_entry_name=\"NatGatewayDnatentryDemo\",\n protocol=\"udp\",\n internal_ip=\"192.168.xxx.53\",\n internal_port=\"20-25\",\n external_ip=\"115.190.xxx.9\",\n external_port=\"25-30\",\n nat_gateway_id=\"ngw-2pc28yhdpbx8g227qo1sxxxxx\",\n port_type=\"specified\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var natGatewayDnatentryDemo = new Volcenginecc.Natgateway.Dnatentry(\"NatGatewayDnatentryDemo\", new()\n {\n DnatEntryName = \"NatGatewayDnatentryDemo\",\n Protocol = \"udp\",\n InternalIp = \"192.168.xxx.53\",\n InternalPort = \"20-25\",\n ExternalIp = \"115.190.xxx.9\",\n ExternalPort = \"25-30\",\n NatGatewayId = \"ngw-2pc28yhdpbx8g227qo1sxxxxx\",\n PortType = \"specified\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/natgateway\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := natgateway.NewDnatentry(ctx, \"NatGatewayDnatentryDemo\", \u0026natgateway.DnatentryArgs{\n\t\t\tDnatEntryName: pulumi.String(\"NatGatewayDnatentryDemo\"),\n\t\t\tProtocol: pulumi.String(\"udp\"),\n\t\t\tInternalIp: pulumi.String(\"192.168.xxx.53\"),\n\t\t\tInternalPort: pulumi.String(\"20-25\"),\n\t\t\tExternalIp: pulumi.String(\"115.190.xxx.9\"),\n\t\t\tExternalPort: pulumi.String(\"25-30\"),\n\t\t\tNatGatewayId: pulumi.String(\"ngw-2pc28yhdpbx8g227qo1sxxxxx\"),\n\t\t\tPortType: pulumi.String(\"specified\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.natgateway.Dnatentry;\nimport com.volcengine.volcenginecc.natgateway.DnatentryArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var natGatewayDnatentryDemo = new Dnatentry(\"natGatewayDnatentryDemo\", DnatentryArgs.builder()\n .dnatEntryName(\"NatGatewayDnatentryDemo\")\n .protocol(\"udp\")\n .internalIp(\"192.168.xxx.53\")\n .internalPort(\"20-25\")\n .externalIp(\"115.190.xxx.9\")\n .externalPort(\"25-30\")\n .natGatewayId(\"ngw-2pc28yhdpbx8g227qo1sxxxxx\")\n .portType(\"specified\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n natGatewayDnatentryDemo:\n type: volcenginecc:natgateway:Dnatentry\n name: NatGatewayDnatentryDemo\n properties:\n dnatEntryName: NatGatewayDnatentryDemo\n protocol: udp\n internalIp: 192.168.xxx.53\n internalPort: 20-25\n externalIp: 115.190.xxx.9\n externalPort: 25-30\n natGatewayId: ngw-2pc28yhdpbx8g227qo1sxxxxx\n portType: specified\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:natgateway/dnatentry:Dnatentry example \"dnat_entry_id\"\n```\n\n", "properties": { "dnatEntryId": { "type": "string", "description": "ID of the DNAT rule.\n" }, "dnatEntryName": { "type": "string", "description": "Name of the DNAT rule.\n" }, "externalIp": { "type": "string", "description": "IP address used by the NAT gateway for network address translation. If the NAT gateway is a public NAT gateway, enter its bound public IP address. If the NAT gateway is a private NAT gateway, enter its transit IP address.\n" }, "externalPort": { "type": "string", "description": "Port or port range that receives requests from the public network.\n" }, "internalIp": { "type": "string", "description": "Private IP address of the cloud server instance.\n" }, "internalPort": { "type": "string", "description": "Port or port range of the private IP address of the cloud server instance.\n" }, "natGatewayId": { "type": "string", "description": "ID of the NAT gateway to which the DNAT rule belongs.\n" }, "portType": { "type": "string", "description": "Port type of the DNAT rule. specified: Specified port. any: Any port, i.e., IP mapping.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: Forwards TCP protocol packets. udp: Forwards UDP protocol packets.\n" }, "status": { "type": "string", "description": "Status of the DNAT rule. Creating: Creating. Deleting: Deleting. Available: Available.\n" } }, "required": [ "dnatEntryId", "dnatEntryName", "externalIp", "externalPort", "internalIp", "internalPort", "natGatewayId", "portType", "protocol", "status" ], "inputProperties": { "dnatEntryName": { "type": "string", "description": "Name of the DNAT rule.\n" }, "externalIp": { "type": "string", "description": "IP address used by the NAT gateway for network address translation. If the NAT gateway is a public NAT gateway, enter its bound public IP address. If the NAT gateway is a private NAT gateway, enter its transit IP address.\n" }, "externalPort": { "type": "string", "description": "Port or port range that receives requests from the public network.\n" }, "internalIp": { "type": "string", "description": "Private IP address of the cloud server instance.\n" }, "internalPort": { "type": "string", "description": "Port or port range of the private IP address of the cloud server instance.\n" }, "natGatewayId": { "type": "string", "description": "ID of the NAT gateway to which the DNAT rule belongs.\n" }, "portType": { "type": "string", "description": "Port type of the DNAT rule. specified: Specified port. any: Any port, i.e., IP mapping.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: Forwards TCP protocol packets. udp: Forwards UDP protocol packets.\n" } }, "requiredInputs": [ "externalIp", "externalPort", "internalIp", "internalPort", "natGatewayId", "protocol" ], "stateInputs": { "description": "Input properties used for looking up and filtering Dnatentry resources.\n", "properties": { "dnatEntryId": { "type": "string", "description": "ID of the DNAT rule.\n" }, "dnatEntryName": { "type": "string", "description": "Name of the DNAT rule.\n" }, "externalIp": { "type": "string", "description": "IP address used by the NAT gateway for network address translation. If the NAT gateway is a public NAT gateway, enter its bound public IP address. If the NAT gateway is a private NAT gateway, enter its transit IP address.\n" }, "externalPort": { "type": "string", "description": "Port or port range that receives requests from the public network.\n" }, "internalIp": { "type": "string", "description": "Private IP address of the cloud server instance.\n" }, "internalPort": { "type": "string", "description": "Port or port range of the private IP address of the cloud server instance.\n" }, "natGatewayId": { "type": "string", "description": "ID of the NAT gateway to which the DNAT rule belongs.\n" }, "portType": { "type": "string", "description": "Port type of the DNAT rule. specified: Specified port. any: Any port, i.e., IP mapping.\n" }, "protocol": { "type": "string", "description": "Protocol type. tcp: Forwards TCP protocol packets. udp: Forwards UDP protocol packets.\n" }, "status": { "type": "string", "description": "Status of the DNAT rule. Creating: Creating. Deleting: Deleting. Available: Available.\n" } }, "type": "object" } }, "volcenginecc:natgateway/natIp:NatIp": { "description": "Allocated from the subnet associated with the private NAT gateway for IP address translation.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst natGatewayNatIpDemo = new volcenginecc.natgateway.NatIp(\"NatGatewayNatIpDemo\", {\n natGatewayId: \"ngw-2hgk22kpfp5a874wjohxxxxx\",\n natIpDescription: \"NatGatewayNatIpDemo description\",\n natIpName: \"NatGatewayNatIpDemo\",\n natIp: \"192.168.xxx.xx\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nnat_gateway_nat_ip_demo = volcenginecc.natgateway.NatIp(\"NatGatewayNatIpDemo\",\n nat_gateway_id=\"ngw-2hgk22kpfp5a874wjohxxxxx\",\n nat_ip_description=\"NatGatewayNatIpDemo description\",\n nat_ip_name=\"NatGatewayNatIpDemo\",\n nat_ip=\"192.168.xxx.xx\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var natGatewayNatIpDemo = new Volcenginecc.Natgateway.NatIp(\"NatGatewayNatIpDemo\", new()\n {\n NatGatewayId = \"ngw-2hgk22kpfp5a874wjohxxxxx\",\n NatIpDescription = \"NatGatewayNatIpDemo description\",\n NatIpName = \"NatGatewayNatIpDemo\",\n NatIpValue = \"192.168.xxx.xx\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/natgateway\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := natgateway.NewNatIp(ctx, \"NatGatewayNatIpDemo\", \u0026natgateway.NatIpArgs{\n\t\t\tNatGatewayId: pulumi.String(\"ngw-2hgk22kpfp5a874wjohxxxxx\"),\n\t\t\tNatIpDescription: pulumi.String(\"NatGatewayNatIpDemo description\"),\n\t\t\tNatIpName: pulumi.String(\"NatGatewayNatIpDemo\"),\n\t\t\tNatIp: pulumi.String(\"192.168.xxx.xx\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.natgateway.NatIp;\nimport com.volcengine.volcenginecc.natgateway.NatIpArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var natGatewayNatIpDemo = new NatIp(\"natGatewayNatIpDemo\", NatIpArgs.builder()\n .natGatewayId(\"ngw-2hgk22kpfp5a874wjohxxxxx\")\n .natIpDescription(\"NatGatewayNatIpDemo description\")\n .natIpName(\"NatGatewayNatIpDemo\")\n .natIp(\"192.168.xxx.xx\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n natGatewayNatIpDemo:\n type: volcenginecc:natgateway:NatIp\n name: NatGatewayNatIpDemo\n properties:\n natGatewayId: ngw-2hgk22kpfp5a874wjohxxxxx\n natIpDescription: NatGatewayNatIpDemo description\n natIpName: NatGatewayNatIpDemo\n natIp: 192.168.xxx.xx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:natgateway/natIp:NatIp example \"nat_ip_id\"\n```\n\n", "properties": { "isDefault": { "type": "boolean", "description": "Whether this is the default transit IP. true: Yes. false: No.\n" }, "natGatewayId": { "type": "string", "description": "Private NAT gateway ID.\n" }, "natIp": { "type": "string", "description": "Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.\n", "language": { "csharp": { "name": "NatIpValue" } } }, "natIpDescription": { "type": "string", "description": "Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" }, "natIpId": { "type": "string", "description": "Transit IP ID.\n" }, "natIpName": { "type": "string", "description": "Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.\n" }, "status": { "type": "string", "description": "Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.\n" }, "usingStatus": { "type": "string", "description": "Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.\n" } }, "required": [ "isDefault", "natGatewayId", "natIp", "natIpDescription", "natIpId", "natIpName", "status", "usingStatus" ], "inputProperties": { "natGatewayId": { "type": "string", "description": "Private NAT gateway ID.\n" }, "natIp": { "type": "string", "description": "Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.\n", "language": { "csharp": { "name": "NatIpValue" } } }, "natIpDescription": { "type": "string", "description": "Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" }, "natIpName": { "type": "string", "description": "Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.\n" } }, "requiredInputs": [ "natGatewayId" ], "stateInputs": { "description": "Input properties used for looking up and filtering NatIp resources.\n", "properties": { "isDefault": { "type": "boolean", "description": "Whether this is the default transit IP. true: Yes. false: No.\n" }, "natGatewayId": { "type": "string", "description": "Private NAT gateway ID.\n" }, "natIp": { "type": "string", "description": "Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.\n", "language": { "csharp": { "name": "NatIpValue" } } }, "natIpDescription": { "type": "string", "description": "Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" }, "natIpId": { "type": "string", "description": "Transit IP ID.\n" }, "natIpName": { "type": "string", "description": "Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.\n" }, "status": { "type": "string", "description": "Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.\n" }, "usingStatus": { "type": "string", "description": "Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.\n" } }, "type": "object" } }, "volcenginecc:natgateway/ngw:Ngw": { "description": "NAT Gateway provides network address translation services for cloud servers within the private network\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst natGatewayNGWDemo = new volcenginecc.natgateway.Ngw(\"NatGatewayNGWDemo\", {\n spec: \"Small\",\n vpcId: \"vpc-2f8kicbjkot8g4f4pzyyxxxxx\",\n subnetId: \"subnet-3hicda1321wqo3nkipk4xxxxx\",\n natGatewayName: \"NatGatewayNGWDemo\",\n billingType: 2,\n projectName: \"default\",\n networkType: \"internet\",\n description: \"NatGatewayNGWDemo\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nnat_gateway_ngw_demo = volcenginecc.natgateway.Ngw(\"NatGatewayNGWDemo\",\n spec=\"Small\",\n vpc_id=\"vpc-2f8kicbjkot8g4f4pzyyxxxxx\",\n subnet_id=\"subnet-3hicda1321wqo3nkipk4xxxxx\",\n nat_gateway_name=\"NatGatewayNGWDemo\",\n billing_type=2,\n project_name=\"default\",\n network_type=\"internet\",\n description=\"NatGatewayNGWDemo\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var natGatewayNGWDemo = new Volcenginecc.Natgateway.Ngw(\"NatGatewayNGWDemo\", new()\n {\n Spec = \"Small\",\n VpcId = \"vpc-2f8kicbjkot8g4f4pzyyxxxxx\",\n SubnetId = \"subnet-3hicda1321wqo3nkipk4xxxxx\",\n NatGatewayName = \"NatGatewayNGWDemo\",\n BillingType = 2,\n ProjectName = \"default\",\n NetworkType = \"internet\",\n Description = \"NatGatewayNGWDemo\",\n Tags = new[]\n {\n new Volcenginecc.Natgateway.Inputs.NgwTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/natgateway\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := natgateway.NewNgw(ctx, \"NatGatewayNGWDemo\", \u0026natgateway.NgwArgs{\n\t\t\tSpec: pulumi.String(\"Small\"),\n\t\t\tVpcId: pulumi.String(\"vpc-2f8kicbjkot8g4f4pzyyxxxxx\"),\n\t\t\tSubnetId: pulumi.String(\"subnet-3hicda1321wqo3nkipk4xxxxx\"),\n\t\t\tNatGatewayName: pulumi.String(\"NatGatewayNGWDemo\"),\n\t\t\tBillingType: pulumi.Int(2),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tNetworkType: pulumi.String(\"internet\"),\n\t\t\tDescription: pulumi.String(\"NatGatewayNGWDemo\"),\n\t\t\tTags: natgateway.NgwTagArray{\n\t\t\t\t\u0026natgateway.NgwTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.natgateway.Ngw;\nimport com.volcengine.volcenginecc.natgateway.NgwArgs;\nimport com.pulumi.volcenginecc.natgateway.inputs.NgwTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var natGatewayNGWDemo = new Ngw(\"natGatewayNGWDemo\", NgwArgs.builder()\n .spec(\"Small\")\n .vpcId(\"vpc-2f8kicbjkot8g4f4pzyyxxxxx\")\n .subnetId(\"subnet-3hicda1321wqo3nkipk4xxxxx\")\n .natGatewayName(\"NatGatewayNGWDemo\")\n .billingType(2)\n .projectName(\"default\")\n .networkType(\"internet\")\n .description(\"NatGatewayNGWDemo\")\n .tags(NgwTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n natGatewayNGWDemo:\n type: volcenginecc:natgateway:Ngw\n name: NatGatewayNGWDemo\n properties:\n spec: Small\n vpcId: vpc-2f8kicbjkot8g4f4pzyyxxxxx\n subnetId: subnet-3hicda1321wqo3nkipk4xxxxx\n natGatewayName: NatGatewayNGWDemo\n billingType: 2\n projectName: default\n networkType: internet\n description: NatGatewayNGWDemo\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:natgateway/ngw:Ngw example \"nat_gateway_id\"\n```\n\n", "properties": { "billingType": { "type": "integer", "description": "NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.\n" }, "businessStatus": { "type": "string", "description": "Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "deletedTime": { "type": "string", "description": "Deletion time\n" }, "description": { "type": "string", "description": "Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.\n" }, "directMode": { "type": "boolean", "description": "Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.\n" }, "dnatEntryIds": { "type": "array", "items": { "type": "string" }, "description": "DNAT rule ID list.\n" }, "eipAddresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:natgateway/NgwEipAddress:NgwEipAddress" } }, "expiredTime": { "type": "string", "description": "Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.\n" }, "lockReason": { "type": "string", "description": "Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.\n" }, "natGatewayId": { "type": "string", "description": "NAT gateway ID.\n" }, "natGatewayName": { "type": "string", "description": "Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.\n" }, "natIpAddresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:natgateway/NgwNatIpAddress:NgwNatIpAddress" } }, "networkInterfaceId": { "type": "string", "description": "Network interface ID occupied by the NAT gateway.\n" }, "networkType": { "type": "string", "description": "NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.\n" }, "period": { "type": "integer", "description": "Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.\n" }, "periodUnit": { "type": "string", "description": "Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.\n" }, "projectName": { "type": "string", "description": "Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.\n" }, "smartScheduleEnabled": { "type": "boolean", "description": "Whether to enable intelligent scheduling\n" }, "smartScheduleRule": { "type": "string", "description": "Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.\n" }, "snatEntryIds": { "type": "array", "items": { "type": "string" }, "description": "SNAT rule ID list\n" }, "spec": { "type": "string", "description": "NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. Extra*Large*1: Extra Large 1. Extra*Large*2: Extra Large 2.\n" }, "status": { "type": "string", "description": "Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:natgateway/NgwTag:NgwTag" } }, "updatedTime": { "type": "string", "description": "Last operation time of the NAT Gateway\n" }, "vpcId": { "type": "string", "description": "ID of the private network where the NAT Gateway is located\n" }, "zoneId": { "type": "string", "description": "ID of the primary availability zone the NAT Gateway belongs to\n" } }, "required": [ "billingType", "businessStatus", "createdTime", "deletedTime", "description", "directMode", "dnatEntryIds", "eipAddresses", "expiredTime", "lockReason", "natGatewayId", "natGatewayName", "natIpAddresses", "networkInterfaceId", "networkType", "overdueTime", "period", "periodUnit", "projectName", "smartScheduleEnabled", "smartScheduleRule", "snatEntryIds", "spec", "status", "subnetId", "tags", "updatedTime", "vpcId", "zoneId" ], "inputProperties": { "billingType": { "type": "integer", "description": "NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.\n" }, "description": { "type": "string", "description": "Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.\n" }, "natGatewayName": { "type": "string", "description": "Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.\n" }, "networkType": { "type": "string", "description": "NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.\n" }, "period": { "type": "integer", "description": "Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.\n" }, "periodUnit": { "type": "string", "description": "Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.\n" }, "projectName": { "type": "string", "description": "Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.\n" }, "smartScheduleEnabled": { "type": "boolean", "description": "Whether to enable intelligent scheduling\n" }, "smartScheduleRule": { "type": "string", "description": "Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.\n" }, "spec": { "type": "string", "description": "NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. Extra*Large*1: Extra Large 1. Extra*Large*2: Extra Large 2.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:natgateway/NgwTag:NgwTag" } }, "vpcId": { "type": "string", "description": "ID of the private network where the NAT Gateway is located\n" } }, "requiredInputs": [ "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Ngw resources.\n", "properties": { "billingType": { "type": "integer", "description": "NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.\n" }, "businessStatus": { "type": "string", "description": "Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "deletedTime": { "type": "string", "description": "Deletion time\n" }, "description": { "type": "string", "description": "Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.\n" }, "directMode": { "type": "boolean", "description": "Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.\n" }, "dnatEntryIds": { "type": "array", "items": { "type": "string" }, "description": "DNAT rule ID list.\n" }, "eipAddresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:natgateway/NgwEipAddress:NgwEipAddress" } }, "expiredTime": { "type": "string", "description": "Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.\n" }, "lockReason": { "type": "string", "description": "Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.\n" }, "natGatewayId": { "type": "string", "description": "NAT gateway ID.\n" }, "natGatewayName": { "type": "string", "description": "Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.\n" }, "natIpAddresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:natgateway/NgwNatIpAddress:NgwNatIpAddress" } }, "networkInterfaceId": { "type": "string", "description": "Network interface ID occupied by the NAT gateway.\n" }, "networkType": { "type": "string", "description": "NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.\n" }, "period": { "type": "integer", "description": "Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.\n" }, "periodUnit": { "type": "string", "description": "Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.\n" }, "projectName": { "type": "string", "description": "Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.\n" }, "smartScheduleEnabled": { "type": "boolean", "description": "Whether to enable intelligent scheduling\n" }, "smartScheduleRule": { "type": "string", "description": "Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.\n" }, "snatEntryIds": { "type": "array", "items": { "type": "string" }, "description": "SNAT rule ID list\n" }, "spec": { "type": "string", "description": "NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. Extra*Large*1: Extra Large 1. Extra*Large*2: Extra Large 2.\n" }, "status": { "type": "string", "description": "Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:natgateway/NgwTag:NgwTag" } }, "updatedTime": { "type": "string", "description": "Last operation time of the NAT Gateway\n" }, "vpcId": { "type": "string", "description": "ID of the private network where the NAT Gateway is located\n" }, "zoneId": { "type": "string", "description": "ID of the primary availability zone the NAT Gateway belongs to\n" } }, "type": "object" } }, "volcenginecc:natgateway/snatentry:Snatentry": { "description": "When multiple cloud server instances in a private network need to access the public network, you can use SNAT rules of the public NAT gateway to save public IPs and avoid exposing cloud server IPs directly to the public network for secure, convenient, and efficient access. SNAT rules support four granularities: private network, subnet, cloud server, and custom network segment. Configure flexibly based on your business needs.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst natGatewaySnatentryDemo = new volcenginecc.natgateway.Snatentry(\"NatGatewaySnatentryDemo\", {\n natGatewayId: \"ngw-2pc28yhdpbx8g227qo1xxxxx\",\n eipId: \"eip-iivdtssgbdog74o8cuxxxxx,eip-btbv1pk36g3k5h0b2vxxxxx\",\n snatEntryName: \"test\",\n sourceCidr: \"0.0.0.0/0\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nnat_gateway_snatentry_demo = volcenginecc.natgateway.Snatentry(\"NatGatewaySnatentryDemo\",\n nat_gateway_id=\"ngw-2pc28yhdpbx8g227qo1xxxxx\",\n eip_id=\"eip-iivdtssgbdog74o8cuxxxxx,eip-btbv1pk36g3k5h0b2vxxxxx\",\n snat_entry_name=\"test\",\n source_cidr=\"0.0.0.0/0\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var natGatewaySnatentryDemo = new Volcenginecc.Natgateway.Snatentry(\"NatGatewaySnatentryDemo\", new()\n {\n NatGatewayId = \"ngw-2pc28yhdpbx8g227qo1xxxxx\",\n EipId = \"eip-iivdtssgbdog74o8cuxxxxx,eip-btbv1pk36g3k5h0b2vxxxxx\",\n SnatEntryName = \"test\",\n SourceCidr = \"0.0.0.0/0\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/natgateway\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := natgateway.NewSnatentry(ctx, \"NatGatewaySnatentryDemo\", \u0026natgateway.SnatentryArgs{\n\t\t\tNatGatewayId: pulumi.String(\"ngw-2pc28yhdpbx8g227qo1xxxxx\"),\n\t\t\tEipId: pulumi.String(\"eip-iivdtssgbdog74o8cuxxxxx,eip-btbv1pk36g3k5h0b2vxxxxx\"),\n\t\t\tSnatEntryName: pulumi.String(\"test\"),\n\t\t\tSourceCidr: pulumi.String(\"0.0.0.0/0\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.natgateway.Snatentry;\nimport com.volcengine.volcenginecc.natgateway.SnatentryArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var natGatewaySnatentryDemo = new Snatentry(\"natGatewaySnatentryDemo\", SnatentryArgs.builder()\n .natGatewayId(\"ngw-2pc28yhdpbx8g227qo1xxxxx\")\n .eipId(\"eip-iivdtssgbdog74o8cuxxxxx,eip-btbv1pk36g3k5h0b2vxxxxx\")\n .snatEntryName(\"test\")\n .sourceCidr(\"0.0.0.0/0\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n natGatewaySnatentryDemo:\n type: volcenginecc:natgateway:Snatentry\n name: NatGatewaySnatentryDemo\n properties:\n natGatewayId: ngw-2pc28yhdpbx8g227qo1xxxxx\n eipId: eip-iivdtssgbdog74o8cuxxxxx,eip-btbv1pk36g3k5h0b2vxxxxx\n snatEntryName: test\n sourceCidr: 0.0.0.0/0\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:natgateway/snatentry:Snatentry example \"snat_entry_id\"\n```\n\n", "properties": { "eipAddress": { "type": "string", "description": "IP address of the public IP associated with the SNAT rule. Returns the IP address for a single public IP. Returns IP addresses for multiple public IPs.\n" }, "eipId": { "type": "string", "description": "ID of the public IP associated with the SNAT rule. Returns the ID for a single public IP. Returns IDs for multiple public IPs.\n" }, "natGatewayId": { "type": "string", "description": "ID of the NAT gateway associated with the SNAT rule\n" }, "natIpId": { "type": "string", "description": "ID of the transit IP for the private NAT gateway\n" }, "snatEntryId": { "type": "string", "description": "ID of the SNAT rule\n" }, "snatEntryName": { "type": "string", "description": "Name of the SNAT rule\n" }, "sourceCidr": { "type": "string", "description": "Network segment corresponding to the SNAT rule\n" }, "status": { "type": "string", "description": "Status of the SNAT rule. Creating: being created. Deleting: being deleted. Available: available.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet associated with the SNAT rule\n" } }, "required": [ "eipAddress", "eipId", "natGatewayId", "natIpId", "snatEntryId", "snatEntryName", "sourceCidr", "status", "subnetId" ], "inputProperties": { "eipId": { "type": "string", "description": "ID of the public IP associated with the SNAT rule. Returns the ID for a single public IP. Returns IDs for multiple public IPs.\n" }, "natGatewayId": { "type": "string", "description": "ID of the NAT gateway associated with the SNAT rule\n" }, "natIpId": { "type": "string", "description": "ID of the transit IP for the private NAT gateway\n" }, "snatEntryName": { "type": "string", "description": "Name of the SNAT rule\n" }, "sourceCidr": { "type": "string", "description": "Network segment corresponding to the SNAT rule\n" }, "subnetId": { "type": "string", "description": "ID of the subnet associated with the SNAT rule\n" } }, "requiredInputs": [ "natGatewayId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Snatentry resources.\n", "properties": { "eipAddress": { "type": "string", "description": "IP address of the public IP associated with the SNAT rule. Returns the IP address for a single public IP. Returns IP addresses for multiple public IPs.\n" }, "eipId": { "type": "string", "description": "ID of the public IP associated with the SNAT rule. Returns the ID for a single public IP. Returns IDs for multiple public IPs.\n" }, "natGatewayId": { "type": "string", "description": "ID of the NAT gateway associated with the SNAT rule\n" }, "natIpId": { "type": "string", "description": "ID of the transit IP for the private NAT gateway\n" }, "snatEntryId": { "type": "string", "description": "ID of the SNAT rule\n" }, "snatEntryName": { "type": "string", "description": "Name of the SNAT rule\n" }, "sourceCidr": { "type": "string", "description": "Network segment corresponding to the SNAT rule\n" }, "status": { "type": "string", "description": "Status of the SNAT rule. Creating: being created. Deleting: being deleted. Available: available.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet associated with the SNAT rule\n" } }, "type": "object" } }, "volcenginecc:organization/account:Account": { "description": "View and manage all accounts in your organization. Each account can be placed directly in the root node or moved to any organizational node hierarchy you create. Each account can belong to only one node. You can manage your organizational structure and member accounts in a layered tree structure\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n organizationAccountDemo:\n type: volcenginecc:organization:Account\n name: OrganizationAccountDemo\n properties:\n accountName: testdemo\n description: test-desc\n orgUnitId: 7538034613*****190\n showName: test-show-name\n allowConsole: 1\n secureContactInfo:\n new_email: \"\"\n new_phone: '*********'\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:organization/account:Account example \"account_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Volcano account ID\n" }, "accountName": { "type": "string", "description": "Account name. 5–20 characters\n" }, "allowConsole": { "type": "integer", "description": "Allow console access: 1. Allowed, 2. Not allowed\n" }, "allowExit": { "type": "integer", "description": "Allow exit: 1. Allowed, 2. Not allowed\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "deleteUk": { "type": "string", "description": "Deletion flag\n" }, "deletedTime": { "type": "string", "description": "Deletion time\n" }, "description": { "type": "string", "description": "Description\n" }, "iamRole": { "type": "string", "description": "IAM role name\n" }, "isOwner": { "type": "integer", "description": "Administrator status: 0. Non-administrator, 1. Administrator\n" }, "joinType": { "type": "integer", "description": "Join type: 1. Create, 2. Invite\n" }, "mainName": { "type": "string", "description": "Subject name\n" }, "memberAccountId": { "type": "string", "description": "Organization member account ID\n" }, "orgId": { "type": "string", "description": "Organization ID\n" }, "orgType": { "type": "integer", "description": "Organization type: 1. Enterprise organization\n" }, "orgUnitId": { "type": "string", "description": "Organizational unit ID. Enter 0 to join the root unit\n" }, "orgUnitName": { "type": "string", "description": "Organizational unit name\n" }, "orgVerificationId": { "type": "string", "description": "Authentication subject ID\n" }, "owner": { "type": "string", "description": "Administrator ID\n" }, "password": { "type": "string", "description": "Account password\n" }, "secureContactInfo": { "$ref": "#/types/volcenginecc:organization/AccountSecureContactInfo:AccountSecureContactInfo", "description": "Security contact information\n" }, "showName": { "type": "string", "description": "Display name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:organization/AccountTag:AccountTag" } }, "updatedTime": { "type": "string", "description": "Update time\n" }, "verificationRelationId": { "type": "string", "description": "Inherited authentication subject account ID, required when creating an account for a non-administrator authentication subject. The account must have joined the enterprise organization. If not specified, the authentication subject of the enterprise organization administrator is inherited by default\n" } }, "required": [ "accountId", "accountName", "allowConsole", "allowExit", "createdTime", "deleteUk", "deletedTime", "description", "iamRole", "isOwner", "joinType", "mainName", "memberAccountId", "orgId", "orgType", "orgUnitId", "orgUnitName", "orgVerificationId", "owner", "password", "secureContactInfo", "showName", "tags", "updatedTime", "verificationRelationId" ], "inputProperties": { "accountName": { "type": "string", "description": "Account name. 5–20 characters\n" }, "allowConsole": { "type": "integer", "description": "Allow console access: 1. Allowed, 2. Not allowed\n" }, "allowExit": { "type": "integer", "description": "Allow exit: 1. Allowed, 2. Not allowed\n" }, "deleteUk": { "type": "string", "description": "Deletion flag\n" }, "description": { "type": "string", "description": "Description\n" }, "orgUnitId": { "type": "string", "description": "Organizational unit ID. Enter 0 to join the root unit\n" }, "password": { "type": "string", "description": "Account password\n" }, "secureContactInfo": { "$ref": "#/types/volcenginecc:organization/AccountSecureContactInfo:AccountSecureContactInfo", "description": "Security contact information\n" }, "showName": { "type": "string", "description": "Display name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:organization/AccountTag:AccountTag" } }, "verificationRelationId": { "type": "string", "description": "Inherited authentication subject account ID, required when creating an account for a non-administrator authentication subject. The account must have joined the enterprise organization. If not specified, the authentication subject of the enterprise organization administrator is inherited by default\n" } }, "requiredInputs": [ "accountName", "showName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Account resources.\n", "properties": { "accountId": { "type": "string", "description": "Volcano account ID\n" }, "accountName": { "type": "string", "description": "Account name. 5–20 characters\n" }, "allowConsole": { "type": "integer", "description": "Allow console access: 1. Allowed, 2. Not allowed\n" }, "allowExit": { "type": "integer", "description": "Allow exit: 1. Allowed, 2. Not allowed\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "deleteUk": { "type": "string", "description": "Deletion flag\n" }, "deletedTime": { "type": "string", "description": "Deletion time\n" }, "description": { "type": "string", "description": "Description\n" }, "iamRole": { "type": "string", "description": "IAM role name\n" }, "isOwner": { "type": "integer", "description": "Administrator status: 0. Non-administrator, 1. Administrator\n" }, "joinType": { "type": "integer", "description": "Join type: 1. Create, 2. Invite\n" }, "mainName": { "type": "string", "description": "Subject name\n" }, "memberAccountId": { "type": "string", "description": "Organization member account ID\n" }, "orgId": { "type": "string", "description": "Organization ID\n" }, "orgType": { "type": "integer", "description": "Organization type: 1. Enterprise organization\n" }, "orgUnitId": { "type": "string", "description": "Organizational unit ID. Enter 0 to join the root unit\n" }, "orgUnitName": { "type": "string", "description": "Organizational unit name\n" }, "orgVerificationId": { "type": "string", "description": "Authentication subject ID\n" }, "owner": { "type": "string", "description": "Administrator ID\n" }, "password": { "type": "string", "description": "Account password\n" }, "secureContactInfo": { "$ref": "#/types/volcenginecc:organization/AccountSecureContactInfo:AccountSecureContactInfo", "description": "Security contact information\n" }, "showName": { "type": "string", "description": "Display name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:organization/AccountTag:AccountTag" } }, "updatedTime": { "type": "string", "description": "Update time\n" }, "verificationRelationId": { "type": "string", "description": "Inherited authentication subject account ID, required when creating an account for a non-administrator authentication subject. The account must have joined the enterprise organization. If not specified, the authentication subject of the enterprise organization administrator is inherited by default\n" } }, "type": "object" } }, "volcenginecc:organization/organization:Organization": { "description": "Enterprise Organization Management\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst organizationDemo = new volcenginecc.organization.Organization(\"organizationDemo\", {});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\norganization_demo = volcenginecc.organization.Organization(\"organizationDemo\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var organizationDemo = new Volcenginecc.Organization.Organization(\"organizationDemo\");\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/organization\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := organization.NewOrganization(ctx, \"organizationDemo\", nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.organization.Organization;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var organizationDemo = new Organization(\"organizationDemo\");\n\n }\n}\n```\n```yaml\nresources:\n organizationDemo:\n type: volcenginecc:organization:Organization\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:organization/organization:Organization example \"organization_id\"\n```\n\n", "properties": { "organization": { "$ref": "#/types/volcenginecc:organization/OrganizationOrganization:OrganizationOrganization", "description": "Organization Details\n", "language": { "csharp": { "name": "OrganizationValue" } } }, "organizationId": { "type": "string", "description": "Organization ID\n" }, "owner": { "$ref": "#/types/volcenginecc:organization/OrganizationOwner:OrganizationOwner", "description": "Administrator Details\n" } }, "required": [ "organization", "organizationId", "owner" ], "inputProperties": { "organization": { "$ref": "#/types/volcenginecc:organization/OrganizationOrganization:OrganizationOrganization", "description": "Organization Details\n", "language": { "csharp": { "name": "OrganizationValue" } } }, "owner": { "$ref": "#/types/volcenginecc:organization/OrganizationOwner:OrganizationOwner", "description": "Administrator Details\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Organization resources.\n", "properties": { "organization": { "$ref": "#/types/volcenginecc:organization/OrganizationOrganization:OrganizationOrganization", "description": "Organization Details\n", "language": { "csharp": { "name": "OrganizationValue" } } }, "organizationId": { "type": "string", "description": "Organization ID\n" }, "owner": { "$ref": "#/types/volcenginecc:organization/OrganizationOwner:OrganizationOwner", "description": "Administrator Details\n" } }, "type": "object" } }, "volcenginecc:organization/serviceControlPolicy:ServiceControlPolicy": { "description": "Control policy.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n organizationServiceControlPolicyDemo:\n type: volcenginecc:organization:ServiceControlPolicy\n name: OrganizationServiceControlPolicyDemo\n properties:\n policyName: ccapi-test\n description: ccapi-test-desc\n statement:\n fn::toJSON:\n Statement:\n - Effect: Deny\n Action:\n - iam:*\n Resource:\n - '*'\n Condition:\n StringNotEqualsIfExists:\n volc:UserName:\n - a\n targets:\n - target_id: 212***\n target_type: Account\n - target_id: 21****\n target_type: Account\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:organization/serviceControlPolicy:ServiceControlPolicy example \"policy_id\"\n```\n\n", "properties": { "createDate": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Description.\n" }, "policyId": { "type": "string", "description": "Policy ID.\n" }, "policyName": { "type": "string", "description": "Policy name.\n" }, "policyType": { "type": "string", "description": "Policy type.\n" }, "statement": { "type": "string", "description": "Policy expression.\n" }, "targets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:organization/ServiceControlPolicyTarget:ServiceControlPolicyTarget" } }, "updateDate": { "type": "string", "description": "Update time.\n" } }, "required": [ "createDate", "description", "policyId", "policyName", "policyType", "statement", "targets", "updateDate" ], "inputProperties": { "description": { "type": "string", "description": "Description.\n" }, "policyName": { "type": "string", "description": "Policy name.\n" }, "statement": { "type": "string", "description": "Policy expression.\n" }, "targets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:organization/ServiceControlPolicyTarget:ServiceControlPolicyTarget" } } }, "requiredInputs": [ "policyName", "statement" ], "stateInputs": { "description": "Input properties used for looking up and filtering ServiceControlPolicy resources.\n", "properties": { "createDate": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Description.\n" }, "policyId": { "type": "string", "description": "Policy ID.\n" }, "policyName": { "type": "string", "description": "Policy name.\n" }, "policyType": { "type": "string", "description": "Policy type.\n" }, "statement": { "type": "string", "description": "Policy expression.\n" }, "targets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:organization/ServiceControlPolicyTarget:ServiceControlPolicyTarget" } }, "updateDate": { "type": "string", "description": "Update time.\n" } }, "type": "object" } }, "volcenginecc:organization/unit:Unit": { "description": "The administrator account that created the enterprise organization can create organizational units to build the enterprise's organizational structure and manage accounts by organizational unit. Organizational units can have multiple hierarchical levels, and administrator accounts can belong to any organizational unit node at any level.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst organizationUnitDemo = new volcenginecc.organization.Unit(\"OrganizationUnitDemo\", {\n parentId: \"735281472xxxx3651635\",\n name: \"OrganizationUnitDemo\",\n description: \"OrganizationUnitDemo description\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\norganization_unit_demo = volcenginecc.organization.Unit(\"OrganizationUnitDemo\",\n parent_id=\"735281472xxxx3651635\",\n name=\"OrganizationUnitDemo\",\n description=\"OrganizationUnitDemo description\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var organizationUnitDemo = new Volcenginecc.Organization.Unit(\"OrganizationUnitDemo\", new()\n {\n ParentId = \"735281472xxxx3651635\",\n Name = \"OrganizationUnitDemo\",\n Description = \"OrganizationUnitDemo description\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/organization\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := organization.NewUnit(ctx, \"OrganizationUnitDemo\", \u0026organization.UnitArgs{\n\t\t\tParentId: pulumi.String(\"735281472xxxx3651635\"),\n\t\t\tName: pulumi.String(\"OrganizationUnitDemo\"),\n\t\t\tDescription: pulumi.String(\"OrganizationUnitDemo description\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.organization.Unit;\nimport com.volcengine.volcenginecc.organization.UnitArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var organizationUnitDemo = new Unit(\"organizationUnitDemo\", UnitArgs.builder()\n .parentId(\"735281472xxxx3651635\")\n .name(\"OrganizationUnitDemo\")\n .description(\"OrganizationUnitDemo description\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n organizationUnitDemo:\n type: volcenginecc:organization:Unit\n name: OrganizationUnitDemo\n properties:\n parentId: 735281472xxxx3651635\n name: OrganizationUnitDemo\n description: OrganizationUnitDemo description\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:organization/unit:Unit example \"org_unit_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time.\n" }, "deleteUk": { "type": "string", "description": "Deletion flag.\n" }, "deletedTime": { "type": "string", "description": "Deletion time.\n" }, "depth": { "type": "integer", "description": "Depth.\n" }, "description": { "type": "string", "description": "Description.\n" }, "name": { "type": "string", "description": "Organizational unit name.\n" }, "orgId": { "type": "string", "description": "Organization ID.\n" }, "orgType": { "type": "integer", "description": "Organization type. Enterprise organization: 1\n" }, "orgUnitId": { "type": "string", "description": "Organizational unit ID.\n" }, "owner": { "type": "string", "description": "Administrator ID.\n" }, "parentId": { "type": "string", "description": "Parent unit ID.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" } }, "required": [ "createdTime", "deleteUk", "deletedTime", "depth", "description", "name", "orgId", "orgType", "orgUnitId", "owner", "parentId", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Description.\n" }, "name": { "type": "string", "description": "Organizational unit name.\n" }, "parentId": { "type": "string", "description": "Parent unit ID.\n" } }, "requiredInputs": [ "name", "parentId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Unit resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time.\n" }, "deleteUk": { "type": "string", "description": "Deletion flag.\n" }, "deletedTime": { "type": "string", "description": "Deletion time.\n" }, "depth": { "type": "integer", "description": "Depth.\n" }, "description": { "type": "string", "description": "Description.\n" }, "name": { "type": "string", "description": "Organizational unit name.\n" }, "orgId": { "type": "string", "description": "Organization ID.\n" }, "orgType": { "type": "integer", "description": "Organization type. Enterprise organization: 1\n" }, "orgUnitId": { "type": "string", "description": "Organizational unit ID.\n" }, "owner": { "type": "string", "description": "Administrator ID.\n" }, "parentId": { "type": "string", "description": "Parent unit ID.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" } }, "type": "object" } }, "volcenginecc:privatelink/endpointService:EndpointService": { "description": "The endpoint service enables private network connections between VPCs via endpoints.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n privateLinkEndpointServiceDemo:\n type: volcenginecc:privatelink:EndpointService\n name: PrivateLinkEndpointServiceDemo\n properties:\n serviceType: Interface\n ipAddressVersions:\n - ipv4\n serviceResourceType: CLB\n resources:\n - resource_id: clb-rr0o8ni4dxxxx58wxxxxx\n zone_ids: []\n autoAcceptEnabled: true\n privateDnsEnabled: true\n privateDnsType: public\n privateDnsName: '*.www.example.com'\n description: PrivateLinkEndpointServiceDemo description\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:privatelink/endpointService:EndpointService example \"service_id\"\n```\n\n", "properties": { "autoAcceptEnabled": { "type": "boolean", "description": "Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.\n" }, "billingType": { "type": "integer", "description": "Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.\n" }, "businessStatus": { "type": "string", "description": "Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.\n" }, "createTime": { "type": "string", "description": "Creation time of the endpoint service.\n" }, "description": { "type": "string", "description": "Description of the endpoint service.\n" }, "ipAddressVersions": { "type": "array", "items": { "type": "string" }, "description": "IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.\n" }, "payer": { "type": "string", "description": "Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.\n" }, "permitAccountIds": { "type": "array", "items": { "type": "string" }, "description": "Details of authorized allowlist accounts.\n" }, "privateDnsEnabled": { "type": "boolean", "description": "Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.\n" }, "privateDnsName": { "type": "string", "description": "Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.\n" }, "privateDnsNameConfiguration": { "$ref": "#/types/volcenginecc:privatelink/EndpointServicePrivateDnsNameConfiguration:EndpointServicePrivateDnsNameConfiguration", "description": "Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.\n" }, "privateDnsType": { "type": "string", "description": "Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.\n" }, "projectName": { "type": "string", "description": "Project name to which the endpoint service belongs.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/EndpointServiceResource:EndpointServiceResource" } }, "serviceDomain": { "type": "string", "description": "Service domain name of the endpoint service.\n" }, "serviceId": { "type": "string", "description": "Endpoint service ID.\n" }, "serviceName": { "type": "string", "description": "Name of the endpoint service.\n" }, "serviceNameManaged": { "type": "string", "description": "Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.\n" }, "serviceNameSuffix": { "type": "string", "description": "Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.\n" }, "serviceOwner": { "type": "string", "description": "Current service principal.\n" }, "serviceResourceType": { "type": "string", "description": "Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.\n" }, "serviceType": { "type": "string", "description": "Type of the endpoint service. Interface: Interface endpoint service.\n" }, "status": { "type": "string", "description": "Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/EndpointServiceTag:EndpointServiceTag" } }, "updateTime": { "type": "string", "description": "Most recent operation time of the endpoint service.\n" }, "wildcardDomainEnabled": { "type": "boolean", "description": "Whether to enable wildcard domain name. true: Enabled. false: Not enabled.\n" }, "zoneIds": { "type": "array", "items": { "type": "string" }, "description": "Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.\n" } }, "required": [ "autoAcceptEnabled", "billingType", "businessStatus", "createTime", "description", "ipAddressVersions", "payer", "permitAccountIds", "privateDnsEnabled", "privateDnsName", "privateDnsNameConfiguration", "privateDnsType", "projectName", "resources", "serviceDomain", "serviceId", "serviceName", "serviceNameManaged", "serviceNameSuffix", "serviceOwner", "serviceResourceType", "serviceType", "status", "tags", "updateTime", "wildcardDomainEnabled", "zoneIds" ], "inputProperties": { "autoAcceptEnabled": { "type": "boolean", "description": "Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.\n" }, "description": { "type": "string", "description": "Description of the endpoint service.\n" }, "ipAddressVersions": { "type": "array", "items": { "type": "string" }, "description": "IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.\n" }, "payer": { "type": "string", "description": "Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.\n" }, "permitAccountIds": { "type": "array", "items": { "type": "string" }, "description": "Details of authorized allowlist accounts.\n" }, "privateDnsEnabled": { "type": "boolean", "description": "Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.\n" }, "privateDnsName": { "type": "string", "description": "Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.\n" }, "privateDnsType": { "type": "string", "description": "Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.\n" }, "projectName": { "type": "string", "description": "Project name to which the endpoint service belongs.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/EndpointServiceResource:EndpointServiceResource" } }, "serviceNameManaged": { "type": "string", "description": "Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.\n" }, "serviceNameSuffix": { "type": "string", "description": "Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.\n" }, "serviceOwner": { "type": "string", "description": "Current service principal.\n" }, "serviceResourceType": { "type": "string", "description": "Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.\n" }, "serviceType": { "type": "string", "description": "Type of the endpoint service. Interface: Interface endpoint service.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/EndpointServiceTag:EndpointServiceTag" } }, "wildcardDomainEnabled": { "type": "boolean", "description": "Whether to enable wildcard domain name. true: Enabled. false: Not enabled.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering EndpointService resources.\n", "properties": { "autoAcceptEnabled": { "type": "boolean", "description": "Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.\n" }, "billingType": { "type": "integer", "description": "Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.\n" }, "businessStatus": { "type": "string", "description": "Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.\n" }, "createTime": { "type": "string", "description": "Creation time of the endpoint service.\n" }, "description": { "type": "string", "description": "Description of the endpoint service.\n" }, "ipAddressVersions": { "type": "array", "items": { "type": "string" }, "description": "IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.\n" }, "payer": { "type": "string", "description": "Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.\n" }, "permitAccountIds": { "type": "array", "items": { "type": "string" }, "description": "Details of authorized allowlist accounts.\n" }, "privateDnsEnabled": { "type": "boolean", "description": "Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.\n" }, "privateDnsName": { "type": "string", "description": "Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.\n" }, "privateDnsNameConfiguration": { "$ref": "#/types/volcenginecc:privatelink/EndpointServicePrivateDnsNameConfiguration:EndpointServicePrivateDnsNameConfiguration", "description": "Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.\n" }, "privateDnsType": { "type": "string", "description": "Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.\n" }, "projectName": { "type": "string", "description": "Project name to which the endpoint service belongs.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/EndpointServiceResource:EndpointServiceResource" } }, "serviceDomain": { "type": "string", "description": "Service domain name of the endpoint service.\n" }, "serviceId": { "type": "string", "description": "Endpoint service ID.\n" }, "serviceName": { "type": "string", "description": "Name of the endpoint service.\n" }, "serviceNameManaged": { "type": "string", "description": "Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.\n" }, "serviceNameSuffix": { "type": "string", "description": "Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.\n" }, "serviceOwner": { "type": "string", "description": "Current service principal.\n" }, "serviceResourceType": { "type": "string", "description": "Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.\n" }, "serviceType": { "type": "string", "description": "Type of the endpoint service. Interface: Interface endpoint service.\n" }, "status": { "type": "string", "description": "Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/EndpointServiceTag:EndpointServiceTag" } }, "updateTime": { "type": "string", "description": "Most recent operation time of the endpoint service.\n" }, "wildcardDomainEnabled": { "type": "boolean", "description": "Whether to enable wildcard domain name. true: Enabled. false: Not enabled.\n" }, "zoneIds": { "type": "array", "items": { "type": "string" }, "description": "Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.\n" } }, "type": "object" } }, "volcenginecc:privatelink/vpcEndpoint:VpcEndpoint": { "description": "The endpoint node is a private network service access point deployed by the service user in their own VPC, used to access the service provider's services via the private network.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n privateLinkVpcEndpointDemo:\n type: volcenginecc:privatelink:VpcEndpoint\n name: PrivateLinkVpcEndpointDemo\n properties:\n description: this is a test\n endpointName: ccapi-test-1001\n ipAddressVersions:\n - ipv4\n - ipv6\n privateDnsEnabled: true\n projectName: default\n securityGroupIds:\n - sg-btg9xxxxxc5h0b2u913txw\n serviceId: epsvc-13fpxxxxx03n6nu5omuqde\n serviceName: com.volces.xxxx.cn-beijing.api-ipv6.ticket\n tags:\n - key: env\n value: test\n vpcId: vpc-btg9hmxxxxx5h0b2tnp1on8\n zones:\n - private_ip_address: 192.168.xxx.xx\n private_ipv_6_address: 2406:d440:103:xxxxx:xxxxx:7eef:35c4:8d79\n subnet_id: subnet-ijif1pxxxxx4o8culvzg85\n zone_id: cn-beijing-a\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:privatelink/vpcEndpoint:VpcEndpoint example \"endpoint_id\"\n```\n\n", "properties": { "bps": { "type": "integer", "description": "Maximum bandwidth limit for the endpoint node connection, in Mbps.\n" }, "businessStatus": { "type": "string", "description": "Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.\n" }, "connectionStatus": { "type": "string", "description": "Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.\n" }, "creationTime": { "type": "string", "description": "Creation time of the endpoint.\n" }, "deletedTime": { "type": "string", "description": "Deletion time of the endpoint.\n" }, "description": { "type": "string", "description": "Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.\n" }, "endpointDomain": { "type": "string", "description": "Domain name of the endpoint.\n" }, "endpointId": { "type": "string", "description": "ID of the endpoint node.\n" }, "endpointIndex": { "type": "integer", "description": "Endpoint index\n" }, "endpointName": { "type": "string", "description": "Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.\n" }, "endpointType": { "type": "string", "description": "Type of the endpoint node. Interface: interface endpoint node.\n" }, "ipAddressVersions": { "type": "array", "items": { "type": "string" }, "description": "IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 \u0026 ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use \u0026 to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.\n" }, "payer": { "type": "string", "description": "Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.\n" }, "privateDnsEnabled": { "type": "boolean", "description": "Enable private DNS name. false (default): disabled. true: enabled.\n" }, "privateDnsName": { "type": "string", "description": "The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the endpoint node belongs.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with \u0026.\n" }, "serviceId": { "type": "string", "description": "ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.\n" }, "serviceManaged": { "type": "boolean", "description": "Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.\n" }, "serviceName": { "type": "string", "description": "Name of the endpoint service to be associated.\n" }, "status": { "type": "string", "description": "Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointTag:VpcEndpointTag" } }, "updateTime": { "type": "string", "description": "Most recent operation time of the endpoint.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.\n" }, "zones": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointZone:VpcEndpointZone" } } }, "required": [ "bps", "businessStatus", "connectionStatus", "creationTime", "deletedTime", "description", "endpointDomain", "endpointId", "endpointIndex", "endpointName", "endpointType", "ipAddressVersions", "payer", "privateDnsEnabled", "privateDnsName", "projectName", "securityGroupIds", "serviceId", "serviceManaged", "serviceName", "status", "tags", "updateTime", "vpcId", "zones" ], "inputProperties": { "description": { "type": "string", "description": "Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.\n" }, "endpointName": { "type": "string", "description": "Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.\n" }, "ipAddressVersions": { "type": "array", "items": { "type": "string" }, "description": "IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 \u0026 ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use \u0026 to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.\n" }, "privateDnsEnabled": { "type": "boolean", "description": "Enable private DNS name. false (default): disabled. true: enabled.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the endpoint node belongs.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with \u0026.\n" }, "serviceId": { "type": "string", "description": "ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.\n" }, "serviceManaged": { "type": "boolean", "description": "Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.\n" }, "serviceName": { "type": "string", "description": "Name of the endpoint service to be associated.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointTag:VpcEndpointTag" } }, "vpcId": { "type": "string", "description": "ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.\n" }, "zones": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointZone:VpcEndpointZone" } } }, "stateInputs": { "description": "Input properties used for looking up and filtering VpcEndpoint resources.\n", "properties": { "bps": { "type": "integer", "description": "Maximum bandwidth limit for the endpoint node connection, in Mbps.\n" }, "businessStatus": { "type": "string", "description": "Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.\n" }, "connectionStatus": { "type": "string", "description": "Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.\n" }, "creationTime": { "type": "string", "description": "Creation time of the endpoint.\n" }, "deletedTime": { "type": "string", "description": "Deletion time of the endpoint.\n" }, "description": { "type": "string", "description": "Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.\n" }, "endpointDomain": { "type": "string", "description": "Domain name of the endpoint.\n" }, "endpointId": { "type": "string", "description": "ID of the endpoint node.\n" }, "endpointIndex": { "type": "integer", "description": "Endpoint index\n" }, "endpointName": { "type": "string", "description": "Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.\n" }, "endpointType": { "type": "string", "description": "Type of the endpoint node. Interface: interface endpoint node.\n" }, "ipAddressVersions": { "type": "array", "items": { "type": "string" }, "description": "IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 \u0026 ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use \u0026 to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.\n" }, "payer": { "type": "string", "description": "Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.\n" }, "privateDnsEnabled": { "type": "boolean", "description": "Enable private DNS name. false (default): disabled. true: enabled.\n" }, "privateDnsName": { "type": "string", "description": "The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the endpoint node belongs.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with \u0026.\n" }, "serviceId": { "type": "string", "description": "ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.\n" }, "serviceManaged": { "type": "boolean", "description": "Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.\n" }, "serviceName": { "type": "string", "description": "Name of the endpoint service to be associated.\n" }, "status": { "type": "string", "description": "Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointTag:VpcEndpointTag" } }, "updateTime": { "type": "string", "description": "Most recent operation time of the endpoint.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.\n" }, "zones": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointZone:VpcEndpointZone" } } }, "type": "object" } }, "volcenginecc:privatelink/vpcEndpointConnection:VpcEndpointConnection": { "description": "Unidirectional, private network connection established between the endpoint and the endpoint service\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n privateLinkVpcEndpointConnectionDemo:\n type: volcenginecc:privatelink:VpcEndpointConnection\n name: PrivateLinkVpcEndpointConnectionDemo\n properties:\n endpointId: ep-2rxb5wrxxxxxxxukcknq\n serviceId: epsvc-1mg2xrmsxxxxxxxxconsso\n resourcesAllocates:\n - resource_id: clb-13g8lgxxxxxxx6nu5ajtpp2\n zone_id: cn-beijing-c\n - resource_id: clb-13fx74xxxxxxxnu4g85ggo\n zone_id: cn-beijing-b\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:privatelink/vpcEndpointConnection:VpcEndpointConnection example \"service_id|endpoint_id\"\n```\n\n", "properties": { "bps": { "type": "integer", "description": "Maximum bandwidth for the endpoint connection, range 100–20000 Mbps\n" }, "connectionStatus": { "type": "string", "description": "Status of the endpoint connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted\n" }, "creationTime": { "type": "string", "description": "Creation time of the endpoint connection\n" }, "endpointId": { "type": "string", "description": "Endpoint ID\n" }, "endpointOwnerAccountId": { "type": "string", "description": "Account ID to which the endpoint belongs\n" }, "endpointVpcId": { "type": "string", "description": "ID of the VPC to which the endpoint network interface belongs\n" }, "replaceResourceId": { "type": "string", "description": "New service resource ID\n" }, "replacingResource": { "type": "string", "description": "Whether to operate the endpoint connection for seamless service resource replacement. true: yes, disconnect the old service resource for the seamless replacement endpoint connection. false: no, reject the specified endpoint connection. If this parameter is empty, the specified endpoint connection is rejected\n" }, "resourcesAllocates": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointConnectionResourcesAllocate:VpcEndpointConnectionResourcesAllocate" } }, "serviceId": { "type": "string", "description": "Endpoint service ID\n" }, "updateTime": { "type": "string", "description": "Most recent operation time of the endpoint connection\n" }, "zoneId": { "type": "string", "description": "Endpoint zone ID\n" }, "zones": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointConnectionZone:VpcEndpointConnectionZone" } } }, "required": [ "bps", "connectionStatus", "creationTime", "endpointId", "endpointOwnerAccountId", "endpointVpcId", "replaceResourceId", "replacingResource", "resourcesAllocates", "serviceId", "updateTime", "zoneId", "zones" ], "inputProperties": { "bps": { "type": "integer", "description": "Maximum bandwidth for the endpoint connection, range 100–20000 Mbps\n" }, "endpointId": { "type": "string", "description": "Endpoint ID\n" }, "resourcesAllocates": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointConnectionResourcesAllocate:VpcEndpointConnectionResourcesAllocate" } }, "serviceId": { "type": "string", "description": "Endpoint service ID\n" }, "zoneId": { "type": "string", "description": "Endpoint zone ID\n" } }, "requiredInputs": [ "endpointId", "serviceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering VpcEndpointConnection resources.\n", "properties": { "bps": { "type": "integer", "description": "Maximum bandwidth for the endpoint connection, range 100–20000 Mbps\n" }, "connectionStatus": { "type": "string", "description": "Status of the endpoint connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted\n" }, "creationTime": { "type": "string", "description": "Creation time of the endpoint connection\n" }, "endpointId": { "type": "string", "description": "Endpoint ID\n" }, "endpointOwnerAccountId": { "type": "string", "description": "Account ID to which the endpoint belongs\n" }, "endpointVpcId": { "type": "string", "description": "ID of the VPC to which the endpoint network interface belongs\n" }, "replaceResourceId": { "type": "string", "description": "New service resource ID\n" }, "replacingResource": { "type": "string", "description": "Whether to operate the endpoint connection for seamless service resource replacement. true: yes, disconnect the old service resource for the seamless replacement endpoint connection. false: no, reject the specified endpoint connection. If this parameter is empty, the specified endpoint connection is rejected\n" }, "resourcesAllocates": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointConnectionResourcesAllocate:VpcEndpointConnectionResourcesAllocate" } }, "serviceId": { "type": "string", "description": "Endpoint service ID\n" }, "updateTime": { "type": "string", "description": "Most recent operation time of the endpoint connection\n" }, "zoneId": { "type": "string", "description": "Endpoint zone ID\n" }, "zones": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatelink/VpcEndpointConnectionZone:VpcEndpointConnectionZone" } } }, "type": "object" } }, "volcenginecc:privatezone/record:Record": { "description": "A DNS record maps a domain name to resource information within a VPC.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst privateZoneRecordDemo = new volcenginecc.privatezone.Record(\"PrivateZoneRecordDemo\", {\n host: \"ccapi-test-1\",\n line: \"default\",\n remark: \"test\",\n ttl: 600,\n type: \"AAAA\",\n value: \"ff03:0:0:0:0:0:0:c1\",\n weight: 1,\n zid: 403215,\n enable: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nprivate_zone_record_demo = volcenginecc.privatezone.Record(\"PrivateZoneRecordDemo\",\n host=\"ccapi-test-1\",\n line=\"default\",\n remark=\"test\",\n ttl=600,\n type=\"AAAA\",\n value=\"ff03:0:0:0:0:0:0:c1\",\n weight=1,\n zid=403215,\n enable=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var privateZoneRecordDemo = new Volcenginecc.Privatezone.Record(\"PrivateZoneRecordDemo\", new()\n {\n Host = \"ccapi-test-1\",\n Line = \"default\",\n Remark = \"test\",\n Ttl = 600,\n Type = \"AAAA\",\n Value = \"ff03:0:0:0:0:0:0:c1\",\n Weight = 1,\n Zid = 403215,\n Enable = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/privatezone\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := privatezone.NewRecord(ctx, \"PrivateZoneRecordDemo\", \u0026privatezone.RecordArgs{\n\t\t\tHost: pulumi.String(\"ccapi-test-1\"),\n\t\t\tLine: pulumi.String(\"default\"),\n\t\t\tRemark: pulumi.String(\"test\"),\n\t\t\tTtl: pulumi.Int(600),\n\t\t\tType: pulumi.String(\"AAAA\"),\n\t\t\tValue: pulumi.String(\"ff03:0:0:0:0:0:0:c1\"),\n\t\t\tWeight: pulumi.Int(1),\n\t\t\tZid: pulumi.Int(403215),\n\t\t\tEnable: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.privatezone.Record;\nimport com.volcengine.volcenginecc.privatezone.RecordArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var privateZoneRecordDemo = new Record(\"privateZoneRecordDemo\", RecordArgs.builder()\n .host(\"ccapi-test-1\")\n .line(\"default\")\n .remark(\"test\")\n .ttl(600)\n .type(\"AAAA\")\n .value(\"ff03:0:0:0:0:0:0:c1\")\n .weight(1)\n .zid(403215)\n .enable(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n privateZoneRecordDemo:\n type: volcenginecc:privatezone:Record\n name: PrivateZoneRecordDemo\n properties:\n host: ccapi-test-1\n line: default\n remark: test\n ttl: 600\n type: AAAA\n value: ff03:0:0:0:0:0:0:c1\n weight: 1\n zid: 403215\n enable: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:privatezone/record:Record example \"record_id\"\n```\n\n", "properties": { "createdAt": { "type": "string", "description": "Creation time of the DNS record.\n" }, "enable": { "type": "boolean", "description": "Indicates whether the DNS record is enabled.\n" }, "host": { "type": "string", "description": "Domain prefix for the subdomain.\n" }, "lastOperator": { "type": "string", "description": "Account ID of the most recent update to the DNS record.\n" }, "line": { "type": "string", "description": "DNS record route, only the default route 'default' is supported.\n" }, "recordId": { "type": "string", "description": "DNS record ID.\n" }, "remark": { "type": "string", "description": "Remarks. Supports UTF-8 characters. Maximum 16 characters. Default is an empty string.\n" }, "ttl": { "type": "integer", "description": "DNS record TTL (time to live), in seconds. Default is 600.\n" }, "type": { "type": "string", "description": "DNS record type. Valid values are: A: A record. AAAA: AAAA record. CNAME: CNAME record. TXT: TXT record. MX: MX record. PTR: PTR record. A: A record. AAAA: AAAA record. CNAME: CNAME record. TXT: TXT record. MX: MX record. PTR: PTR record.\n" }, "updatedAt": { "type": "string", "description": "Last update time of the DNS record.\n" }, "value": { "type": "string", "description": "Record value.\n" }, "weight": { "type": "integer", "description": "Record weight. The weight takes effect only when load balancing is enabled for the domain name.\n" }, "weightEnabled": { "type": "boolean", "description": "Indicates whether load balancing is enabled for this record set.\n" }, "zid": { "type": "integer", "description": "Domain name ID.\n" } }, "required": [ "createdAt", "enable", "host", "lastOperator", "line", "recordId", "remark", "ttl", "type", "updatedAt", "value", "weight", "weightEnabled", "zid" ], "inputProperties": { "enable": { "type": "boolean", "description": "Indicates whether the DNS record is enabled.\n" }, "host": { "type": "string", "description": "Domain prefix for the subdomain.\n" }, "line": { "type": "string", "description": "DNS record route, only the default route 'default' is supported.\n" }, "remark": { "type": "string", "description": "Remarks. Supports UTF-8 characters. Maximum 16 characters. Default is an empty string.\n" }, "ttl": { "type": "integer", "description": "DNS record TTL (time to live), in seconds. Default is 600.\n" }, "type": { "type": "string", "description": "DNS record type. Valid values are: A: A record. AAAA: AAAA record. CNAME: CNAME record. TXT: TXT record. MX: MX record. PTR: PTR record. A: A record. AAAA: AAAA record. CNAME: CNAME record. TXT: TXT record. MX: MX record. PTR: PTR record.\n" }, "value": { "type": "string", "description": "Record value.\n" }, "weight": { "type": "integer", "description": "Record weight. The weight takes effect only when load balancing is enabled for the domain name.\n" }, "weightEnabled": { "type": "boolean", "description": "Indicates whether load balancing is enabled for this record set.\n" }, "zid": { "type": "integer", "description": "Domain name ID.\n" } }, "requiredInputs": [ "host", "type", "value", "zid" ], "stateInputs": { "description": "Input properties used for looking up and filtering Record resources.\n", "properties": { "createdAt": { "type": "string", "description": "Creation time of the DNS record.\n" }, "enable": { "type": "boolean", "description": "Indicates whether the DNS record is enabled.\n" }, "host": { "type": "string", "description": "Domain prefix for the subdomain.\n" }, "lastOperator": { "type": "string", "description": "Account ID of the most recent update to the DNS record.\n" }, "line": { "type": "string", "description": "DNS record route, only the default route 'default' is supported.\n" }, "recordId": { "type": "string", "description": "DNS record ID.\n" }, "remark": { "type": "string", "description": "Remarks. Supports UTF-8 characters. Maximum 16 characters. Default is an empty string.\n" }, "ttl": { "type": "integer", "description": "DNS record TTL (time to live), in seconds. Default is 600.\n" }, "type": { "type": "string", "description": "DNS record type. Valid values are: A: A record. AAAA: AAAA record. CNAME: CNAME record. TXT: TXT record. MX: MX record. PTR: PTR record. A: A record. AAAA: AAAA record. CNAME: CNAME record. TXT: TXT record. MX: MX record. PTR: PTR record.\n" }, "updatedAt": { "type": "string", "description": "Last update time of the DNS record.\n" }, "value": { "type": "string", "description": "Record value.\n" }, "weight": { "type": "integer", "description": "Record weight. The weight takes effect only when load balancing is enabled for the domain name.\n" }, "weightEnabled": { "type": "boolean", "description": "Indicates whether load balancing is enabled for this record set.\n" }, "zid": { "type": "integer", "description": "Domain name ID.\n" } }, "type": "object" } }, "volcenginecc:privatezone/resolverEndpoint:ResolverEndpoint": { "description": "In scenarios where external DNS query requests are forwarded to the resolver, you need to create an endpoint. After receiving DNS query requests forwarded by the resolver, outbound endpoints forward DNS queries to external DNS servers. After receiving DNS query requests from external sources, inbound endpoints forward DNS queries to the resolver\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n privateZoneResolverEndpointDemo:\n type: volcenginecc:privatezone:ResolverEndpoint\n name: PrivateZoneResolverEndpointDemo\n properties:\n name: PrivateZoneResolverEndpointDemo\n vpcId: vpc-3nrh1tqschwcg931eaqxxxxx\n endpointType: IPv4\n ipConfigs:\n - az_id: cn-beijing-a\n subnet_id: subnet-bt50na0bf6kg5h0b2u1xxxxx\n ip: 192.168.xx.44\n - az_id: cn-beijing-b\n subnet_id: subnet-1a14u8n59jdvk8nvepjyxxxxx\n ip: 192.168.xx.154\n projectName: default\n tags:\n - key: env\n value: test\n vpcRegion: cn-beijing\n direction: OUTBOUND\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:privatezone/resolverEndpoint:ResolverEndpoint example \"endpoint_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time\n" }, "direction": { "type": "string", "description": "DNS request forwarding direction for the endpoint. OUTBOUND (default): outbound endpoint forwards DNS queries from within the VPC to external DNS servers. INBOUND: inbound endpoint forwards DNS queries from external sources to the resolver\n" }, "endpointId": { "type": "string", "description": "Endpoint ID\n" }, "endpointType": { "type": "string", "description": "Endpoint type. IPv4: IPv4 endpoint. DualStack: dual-stack endpoint\n" }, "ipConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverEndpointIpConfig:ResolverEndpointIpConfig" } }, "name": { "type": "string", "description": "Endpoint name. Supports UTF-8 format\n" }, "projectName": { "type": "string", "description": "Project name to which the endpoint belongs. Default is default\n" }, "securityGroupId": { "type": "string", "description": "Security group ID for the endpoint IP address. The endpoint uses a default security group: For outbound endpoints, inbound traffic is denied; outbound traffic allows TCP port 53 and UDP port 53 to 0.0.0.0/0. For inbound endpoints, inbound traffic allows TCP port 53 and UDP port 53 to 0.0.0.0/0; outbound traffic is denied\n" }, "status": { "type": "string", "description": "Endpoint status. Creating: creating. Running: running. Updating: updating. Error: abnormal operation\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverEndpointTag:ResolverEndpointTag" } }, "updatedTime": { "type": "string", "description": "Update time\n" }, "vpcId": { "type": "string", "description": "VPC ID where the endpoint is located\n" }, "vpcRegion": { "type": "string", "description": "Region of the VPC where the endpoint is located\n" } }, "required": [ "createdTime", "direction", "endpointId", "endpointType", "ipConfigs", "name", "projectName", "securityGroupId", "status", "tags", "updatedTime", "vpcId", "vpcRegion" ], "inputProperties": { "direction": { "type": "string", "description": "DNS request forwarding direction for the endpoint. OUTBOUND (default): outbound endpoint forwards DNS queries from within the VPC to external DNS servers. INBOUND: inbound endpoint forwards DNS queries from external sources to the resolver\n" }, "endpointType": { "type": "string", "description": "Endpoint type. IPv4: IPv4 endpoint. DualStack: dual-stack endpoint\n" }, "ipConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverEndpointIpConfig:ResolverEndpointIpConfig" } }, "name": { "type": "string", "description": "Endpoint name. Supports UTF-8 format\n" }, "projectName": { "type": "string", "description": "Project name to which the endpoint belongs. Default is default\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverEndpointTag:ResolverEndpointTag" } }, "vpcId": { "type": "string", "description": "VPC ID where the endpoint is located\n" }, "vpcRegion": { "type": "string", "description": "Region of the VPC where the endpoint is located\n" } }, "requiredInputs": [ "name", "vpcId", "vpcRegion" ], "stateInputs": { "description": "Input properties used for looking up and filtering ResolverEndpoint resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time\n" }, "direction": { "type": "string", "description": "DNS request forwarding direction for the endpoint. OUTBOUND (default): outbound endpoint forwards DNS queries from within the VPC to external DNS servers. INBOUND: inbound endpoint forwards DNS queries from external sources to the resolver\n" }, "endpointId": { "type": "string", "description": "Endpoint ID\n" }, "endpointType": { "type": "string", "description": "Endpoint type. IPv4: IPv4 endpoint. DualStack: dual-stack endpoint\n" }, "ipConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverEndpointIpConfig:ResolverEndpointIpConfig" } }, "name": { "type": "string", "description": "Endpoint name. Supports UTF-8 format\n" }, "projectName": { "type": "string", "description": "Project name to which the endpoint belongs. Default is default\n" }, "securityGroupId": { "type": "string", "description": "Security group ID for the endpoint IP address. The endpoint uses a default security group: For outbound endpoints, inbound traffic is denied; outbound traffic allows TCP port 53 and UDP port 53 to 0.0.0.0/0. For inbound endpoints, inbound traffic allows TCP port 53 and UDP port 53 to 0.0.0.0/0; outbound traffic is denied\n" }, "status": { "type": "string", "description": "Endpoint status. Creating: creating. Running: running. Updating: updating. Error: abnormal operation\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverEndpointTag:ResolverEndpointTag" } }, "updatedTime": { "type": "string", "description": "Update time\n" }, "vpcId": { "type": "string", "description": "VPC ID where the endpoint is located\n" }, "vpcRegion": { "type": "string", "description": "Region of the VPC where the endpoint is located\n" } }, "type": "object" } }, "volcenginecc:privatezone/resolverRule:ResolverRule": { "description": "Forwarding rule details\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n privateZoneResolverRuleDemo:\n type: volcenginecc:privatezone:ResolverRule\n name: PrivateZoneResolverRuleDemo\n properties:\n line: 电信\n name: PrivateZoneResolverRuleDemo\n tags:\n - key: env\n value: test\n type: LINE\n vpCs:\n - region: cn-beijing\n vpc_id: vpc-3nqt4kq87xn28931eclihh90****\n - region: cn-beijing\n vpc_id: vpc-1a10aeq5vr2tc8nvepkauwljx****\n vpcTrns:\n - trn:vpc:cn-beijing:********:vpc/vpc-3nqt4kq87xn2893xxxxx\n - trn:vpc:cn-beijing:********:vpc/vpc-1a10aeq5vr2tc8nvepxxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:privatezone/resolverRule:ResolverRule example \"rule_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the forwarding rule\n" }, "enable": { "type": "boolean", "description": "Whether the forwarding rule is enabled. true: enabled. false: disabled\n" }, "endpointId": { "type": "integer", "description": "Endpoint ID. This parameter is only valid and required when the Type parameter is OUTBOUND\n" }, "forwardIPs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverRuleForwardIP:ResolverRuleForwardIP" } }, "lastOperator": { "type": "string", "description": "Account ID of the last update to the forwarding rule\n" }, "line": { "type": "string", "description": "Carrier for the outbound IP address of the recursive DNS server. This parameter is only valid when the Type parameter is LINE. Supported values: Mobile: China Mobile, Telecom: China Telecom, Unicom: China Unicom\n" }, "name": { "type": "string", "description": "Name of the forwarding rule. Supports UTF-8 format\n" }, "projectName": { "type": "string", "description": "Project name associated with the forwarding rule. Default is default\n" }, "ruleId": { "type": "string", "description": "Forwarding rule ID\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverRuleTag:ResolverRuleTag" } }, "type": { "type": "string", "description": "Forwarding rule type. OUTBOUND: Forward to external DNS server. LINE: Carrier for the outbound IP address of the custom public recursive DNS server\n" }, "updatedTime": { "type": "string", "description": "Update time of the forwarding rule\n" }, "vpCs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverRuleVpC:ResolverRuleVpC" } }, "zoneName": { "type": "string", "description": "Domain name(s) associated with the forwarding rule. You can enter one or more domain names. Separate multiple domain names with English commas. Up to 500 domain names are supported. This parameter is only valid and required when the Type parameter is OUTBOUND. If you set this parameter to *, the forwarding rule applies to all domain names associated with the VPC\n" } }, "required": [ "createdTime", "enable", "endpointId", "forwardIPs", "lastOperator", "line", "name", "projectName", "ruleId", "tags", "type", "updatedTime", "vpCs", "zoneName" ], "inputProperties": { "endpointId": { "type": "integer", "description": "Endpoint ID. This parameter is only valid and required when the Type parameter is OUTBOUND\n" }, "forwardIPs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverRuleForwardIP:ResolverRuleForwardIP" } }, "line": { "type": "string", "description": "Carrier for the outbound IP address of the recursive DNS server. This parameter is only valid when the Type parameter is LINE. Supported values: Mobile: China Mobile, Telecom: China Telecom, Unicom: China Unicom\n" }, "name": { "type": "string", "description": "Name of the forwarding rule. Supports UTF-8 format\n" }, "projectName": { "type": "string", "description": "Project name associated with the forwarding rule. Default is default\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverRuleTag:ResolverRuleTag" } }, "type": { "type": "string", "description": "Forwarding rule type. OUTBOUND: Forward to external DNS server. LINE: Carrier for the outbound IP address of the custom public recursive DNS server\n" }, "vpCs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverRuleVpC:ResolverRuleVpC" } }, "zoneName": { "type": "string", "description": "Domain name(s) associated with the forwarding rule. You can enter one or more domain names. Separate multiple domain names with English commas. Up to 500 domain names are supported. This parameter is only valid and required when the Type parameter is OUTBOUND. If you set this parameter to *, the forwarding rule applies to all domain names associated with the VPC\n" } }, "requiredInputs": [ "name", "type" ], "stateInputs": { "description": "Input properties used for looking up and filtering ResolverRule resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the forwarding rule\n" }, "enable": { "type": "boolean", "description": "Whether the forwarding rule is enabled. true: enabled. false: disabled\n" }, "endpointId": { "type": "integer", "description": "Endpoint ID. This parameter is only valid and required when the Type parameter is OUTBOUND\n" }, "forwardIPs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverRuleForwardIP:ResolverRuleForwardIP" } }, "lastOperator": { "type": "string", "description": "Account ID of the last update to the forwarding rule\n" }, "line": { "type": "string", "description": "Carrier for the outbound IP address of the recursive DNS server. This parameter is only valid when the Type parameter is LINE. Supported values: Mobile: China Mobile, Telecom: China Telecom, Unicom: China Unicom\n" }, "name": { "type": "string", "description": "Name of the forwarding rule. Supports UTF-8 format\n" }, "projectName": { "type": "string", "description": "Project name associated with the forwarding rule. Default is default\n" }, "ruleId": { "type": "string", "description": "Forwarding rule ID\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverRuleTag:ResolverRuleTag" } }, "type": { "type": "string", "description": "Forwarding rule type. OUTBOUND: Forward to external DNS server. LINE: Carrier for the outbound IP address of the custom public recursive DNS server\n" }, "updatedTime": { "type": "string", "description": "Update time of the forwarding rule\n" }, "vpCs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:privatezone/ResolverRuleVpC:ResolverRuleVpC" } }, "zoneName": { "type": "string", "description": "Domain name(s) associated with the forwarding rule. You can enter one or more domain names. Separate multiple domain names with English commas. Up to 500 domain names are supported. This parameter is only valid and required when the Type parameter is OUTBOUND. If you set this parameter to *, the forwarding rule applies to all domain names associated with the VPC\n" } }, "type": "object" } }, "volcenginecc:privatezone/userVpcAuthorization:UserVpcAuthorization": { "description": "Account authorization management.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst privateZoneUserVpcAuthorizationDemo = new volcenginecc.privatezone.UserVpcAuthorization(\"PrivateZoneUserVpcAuthorizationDemo\", {\n accountId: \"21xxxx272\",\n authType: 0,\n verifyCode: \"sdw\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nprivate_zone_user_vpc_authorization_demo = volcenginecc.privatezone.UserVpcAuthorization(\"PrivateZoneUserVpcAuthorizationDemo\",\n account_id=\"21xxxx272\",\n auth_type=0,\n verify_code=\"sdw\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var privateZoneUserVpcAuthorizationDemo = new Volcenginecc.Privatezone.UserVpcAuthorization(\"PrivateZoneUserVpcAuthorizationDemo\", new()\n {\n AccountId = \"21xxxx272\",\n AuthType = 0,\n VerifyCode = \"sdw\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/privatezone\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := privatezone.NewUserVpcAuthorization(ctx, \"PrivateZoneUserVpcAuthorizationDemo\", \u0026privatezone.UserVpcAuthorizationArgs{\n\t\t\tAccountId: pulumi.String(\"21xxxx272\"),\n\t\t\tAuthType: pulumi.Int(0),\n\t\t\tVerifyCode: pulumi.String(\"sdw\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.privatezone.UserVpcAuthorization;\nimport com.volcengine.volcenginecc.privatezone.UserVpcAuthorizationArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var privateZoneUserVpcAuthorizationDemo = new UserVpcAuthorization(\"privateZoneUserVpcAuthorizationDemo\", UserVpcAuthorizationArgs.builder()\n .accountId(\"21xxxx272\")\n .authType(0)\n .verifyCode(\"sdw\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n privateZoneUserVpcAuthorizationDemo:\n type: volcenginecc:privatezone:UserVpcAuthorization\n name: PrivateZoneUserVpcAuthorizationDemo\n properties:\n accountId: 21xxxx272\n authType: 0\n verifyCode: sdw\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:privatezone/userVpcAuthorization:UserVpcAuthorization example \"account_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account.\n" }, "authType": { "type": "integer", "description": "Verification method. 0: Use enterprise organization verification. 1: Use verification code.\n" }, "status": { "type": "string", "description": "Account status. Normal: The account is in the enterprise organization. Exited: The account has exited the enterprise organization.\n" }, "verifyCode": { "type": "string", "description": "Verification code. This parameter is required when AuthType is set to 1.\n" } }, "required": [ "accountId", "authType", "status", "verifyCode" ], "inputProperties": { "accountId": { "type": "string", "description": "Account.\n" }, "authType": { "type": "integer", "description": "Verification method. 0: Use enterprise organization verification. 1: Use verification code.\n" }, "verifyCode": { "type": "string", "description": "Verification code. This parameter is required when AuthType is set to 1.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering UserVpcAuthorization resources.\n", "properties": { "accountId": { "type": "string", "description": "Account.\n" }, "authType": { "type": "integer", "description": "Verification method. 0: Use enterprise organization verification. 1: Use verification code.\n" }, "status": { "type": "string", "description": "Account status. Normal: The account is in the enterprise organization. Exited: The account has exited the enterprise organization.\n" }, "verifyCode": { "type": "string", "description": "Verification code. This parameter is required when AuthType is set to 1.\n" } }, "type": "object" } }, "volcenginecc:rabbitmq/allowList:AllowList": { "description": "RabbitMQ access allowlist\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@pulumi/volcenginecc\";\n\nconst rabbitMQAllowListDemo = new volcenginecc.index.RabbitmqAllowlist(\"RabbitMQAllowListDemo\", {\n allowListType: \"IPv4\",\n allowList: \"192.x.0.0/24\",\n allowListName: \"ccapi-test\",\n allowListDesc: \"test-desc\",\n associatedInstances: [{\n instanceId: \"rbtmq-a69238e***\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nrabbit_mq_allow_list_demo = volcenginecc.index.RabbitmqAllowlist(\"RabbitMQAllowListDemo\",\n allow_list_type=IPv4,\n allow_list=192.x.0.0/24,\n allow_list_name=ccapi-test,\n allow_list_desc=test-desc,\n associated_instances=[{\n instanceId: rbtmq-a69238e***,\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var rabbitMQAllowListDemo = new Volcenginecc.Index.RabbitmqAllowlist(\"RabbitMQAllowListDemo\", new()\n {\n AllowListType = \"IPv4\",\n AllowList = \"192.x.0.0/24\",\n AllowListName = \"ccapi-test\",\n AllowListDesc = \"test-desc\",\n AssociatedInstances = new[]\n {\n \n {\n { \"instanceId\", \"rbtmq-a69238e***\" },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := volcenginecc.NewRabbitmqAllowlist(ctx, \"RabbitMQAllowListDemo\", \u0026volcenginecc.RabbitmqAllowlistArgs{\n\t\t\tAllowListType: \"IPv4\",\n\t\t\tAllowList: \"192.x.0.0/24\",\n\t\t\tAllowListName: \"ccapi-test\",\n\t\t\tAllowListDesc: \"test-desc\",\n\t\t\tAssociatedInstances: []map[string]interface{}{\n\t\t\t\tmap[string]interface{}{\n\t\t\t\t\t\"instanceId\": \"rbtmq-a69238e***\",\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.volcenginecc.rabbitmqAllowlist;\nimport com.pulumi.volcenginecc.rabbitmqAllowlistArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var rabbitMQAllowListDemo = new RabbitmqAllowlist(\"rabbitMQAllowListDemo\", RabbitmqAllowlistArgs.builder()\n .allowListType(\"IPv4\")\n .allowList(\"192.x.0.0/24\")\n .allowListName(\"ccapi-test\")\n .allowListDesc(\"test-desc\")\n .associatedInstances(List.of(Map.of(\"instanceId\", \"rbtmq-a69238e***\")))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n rabbitMQAllowListDemo:\n type: volcenginecc:rabbitmqAllowlist\n name: RabbitMQAllowListDemo\n properties:\n allowListType: IPv4\n allowList: 192.x.0.0/24\n allowListName: ccapi-test\n allowListDesc: test-desc\n associatedInstances:\n - instanceId: rbtmq-a69238e***\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rabbitmq/allowList:AllowList example \"allow_list_id\"\n```\n\n", "properties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListDesc": { "type": "string", "description": "Allowlist Description\n" }, "allowListId": { "type": "string", "description": "Allowlist ID\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or address ranges) in the allowlist\n" }, "allowListName": { "type": "string", "description": "Allowlist Name\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is currently supported\n" }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "modifyMode": { "type": "string", "description": "Allowlist modification method. Default is Cover\n" } }, "required": [ "allowList", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "modifyMode" ], "inputProperties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListDesc": { "type": "string", "description": "Allowlist Description\n" }, "allowListName": { "type": "string", "description": "Allowlist Name\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is currently supported\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "modifyMode": { "type": "string", "description": "Allowlist modification method. Default is Cover\n" } }, "requiredInputs": [ "allowList", "allowListName", "allowListType" ], "stateInputs": { "description": "Input properties used for looking up and filtering AllowList resources.\n", "properties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListDesc": { "type": "string", "description": "Allowlist Description\n" }, "allowListId": { "type": "string", "description": "Allowlist ID\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or address ranges) in the allowlist\n" }, "allowListName": { "type": "string", "description": "Allowlist Name\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is currently supported\n" }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "modifyMode": { "type": "string", "description": "Allowlist modification method. Default is Cover\n" } }, "type": "object" } }, "volcenginecc:rabbitmq/instance:Instance": { "description": "RabbitMQ Message Queue is a distributed, high-availability message queue product that supports the AMQP (Advanced Message Queuing Protocol) protocol. It is fully compatible with the RabbitMQ open-source ecosystem and multi-language clients, provides rich messaging features and flexible message routing, and offers the advantages of distributed architecture, high throughput, low latency, and flexible scalability as a cloud messaging service. No user deployment or maintenance is required, enabling easy and rapid cloud adoption.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rabbitMQInstanceDemo:\n type: volcenginecc:rabbitmq:Instance\n name: RabbitMQInstanceDemo\n properties:\n zoneId: cn-beijing-a\n userName: RabbitMQInstanceDemo\n computeSpec: rabbitmq.n1.x4.small\n version: '3.12'\n userPassword: '********'\n storageSpace: 100\n instanceDescription: RabbitMQInstanceDemo\n vpcId: vpc-1a1vgeo93yxxx8nvepjxxxxx\n chargeDetail:\n charge_type: PostPaid\n subnetId: subnet-ij9s4hxxxs3k74o8cuxxxxx\n eipId: eip-1c0qhbjo7xxxw5e8j70axxxxx\n instanceName: RabbitMQInstanceDemo\n tags:\n - key: env\n value: test\n projectName: default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rabbitmq/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Main account ID used to create the instance.\n" }, "applyPrivateDnsToPublic": { "type": "boolean", "description": "Whether public DNS resolution is enabled. true: enabled, false: disabled.\n" }, "archType": { "type": "string", "description": "Instance type, either cluster or standalone.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rabbitmq/InstanceChargeDetail:InstanceChargeDetail", "description": "Instance billing method and related billing information.\n" }, "computeSpec": { "type": "string", "description": "Compute specification of the RabbitMQ instance.\n" }, "createdTime": { "type": "string", "description": "Instance creation time.\n" }, "eipId": { "type": "string", "description": "EIP ID.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/InstanceEndpoint:InstanceEndpoint" } }, "instanceDescription": { "type": "string", "description": "Brief description of the instance.\n" }, "instanceId": { "type": "string", "description": "RabbitMQ instance ID.\n" }, "instanceName": { "type": "string", "description": "RabbitMQ instance name.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "isEncrypted": { "type": "boolean", "description": "Whether cloud disk encryption is enabled.\n" }, "projectName": { "type": "string", "description": "IAM project to which the instance belongs.\n" }, "storageSpace": { "type": "integer", "description": "Total storage space of the instance, measured in GiB.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/InstanceTag:InstanceTag" } }, "usedStorageSpace": { "type": "integer", "description": "Used storage space of the instance, measured in GiB.\n" }, "userName": { "type": "string", "description": "RabbitMQ WebUI administrator account name.\n" }, "userPassword": { "type": "string", "description": "RabbitMQ WebUI administrator password.\n" }, "version": { "type": "string", "description": "Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID.\n" }, "zoneDescription": { "type": "string", "description": "Description of the availability zone.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.\n" } }, "required": [ "accountId", "applyPrivateDnsToPublic", "archType", "chargeDetail", "computeSpec", "createdTime", "eipId", "endpoints", "instanceDescription", "instanceId", "instanceName", "instanceStatus", "isEncrypted", "projectName", "storageSpace", "subnetId", "tags", "usedStorageSpace", "userName", "userPassword", "version", "vpcId", "zoneDescription", "zoneId" ], "inputProperties": { "chargeDetail": { "$ref": "#/types/volcenginecc:rabbitmq/InstanceChargeDetail:InstanceChargeDetail", "description": "Instance billing method and related billing information.\n" }, "computeSpec": { "type": "string", "description": "Compute specification of the RabbitMQ instance.\n" }, "eipId": { "type": "string", "description": "EIP ID.\n" }, "instanceDescription": { "type": "string", "description": "Brief description of the instance.\n" }, "instanceName": { "type": "string", "description": "RabbitMQ instance name.\n" }, "projectName": { "type": "string", "description": "IAM project to which the instance belongs.\n" }, "storageSpace": { "type": "integer", "description": "Total storage space of the instance, measured in GiB.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/InstanceTag:InstanceTag" } }, "userName": { "type": "string", "description": "RabbitMQ WebUI administrator account name.\n" }, "userPassword": { "type": "string", "description": "RabbitMQ WebUI administrator password.\n" }, "version": { "type": "string", "description": "Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.\n" } }, "requiredInputs": [ "computeSpec", "storageSpace", "subnetId", "userName", "userPassword", "version", "vpcId", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "accountId": { "type": "string", "description": "Main account ID used to create the instance.\n" }, "applyPrivateDnsToPublic": { "type": "boolean", "description": "Whether public DNS resolution is enabled. true: enabled, false: disabled.\n" }, "archType": { "type": "string", "description": "Instance type, either cluster or standalone.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rabbitmq/InstanceChargeDetail:InstanceChargeDetail", "description": "Instance billing method and related billing information.\n" }, "computeSpec": { "type": "string", "description": "Compute specification of the RabbitMQ instance.\n" }, "createdTime": { "type": "string", "description": "Instance creation time.\n" }, "eipId": { "type": "string", "description": "EIP ID.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/InstanceEndpoint:InstanceEndpoint" } }, "instanceDescription": { "type": "string", "description": "Brief description of the instance.\n" }, "instanceId": { "type": "string", "description": "RabbitMQ instance ID.\n" }, "instanceName": { "type": "string", "description": "RabbitMQ instance name.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "isEncrypted": { "type": "boolean", "description": "Whether cloud disk encryption is enabled.\n" }, "projectName": { "type": "string", "description": "IAM project to which the instance belongs.\n" }, "storageSpace": { "type": "integer", "description": "Total storage space of the instance, measured in GiB.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/InstanceTag:InstanceTag" } }, "usedStorageSpace": { "type": "integer", "description": "Used storage space of the instance, measured in GiB.\n" }, "userName": { "type": "string", "description": "RabbitMQ WebUI administrator account name.\n" }, "userPassword": { "type": "string", "description": "RabbitMQ WebUI administrator password.\n" }, "version": { "type": "string", "description": "Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID.\n" }, "zoneDescription": { "type": "string", "description": "Description of the availability zone.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.\n" } }, "type": "object" } }, "volcenginecc:rabbitmq/instancePlugin:InstancePlugin": { "description": "After you create an instance in the RabbitMQ console, plugins are disabled by default. You can manually enable or disable plugins for the instance. Enabling or disabling certain plugins will cause a rolling restart of the cluster. It is recommended to perform this operation outside of business hours. A rolling restart may result in the loss of non-persistent messages and temporary connection instability, such as connection drops. After a connection drop, whether the client automatically reconnects depends on its configuration\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst instancepluginDemo = new volcenginecc.rabbitmq.InstancePlugin(\"instancepluginDemo\", {\n instanceId: \"rbtmq-db26b7****\",\n pluginName: \"ccapi-test\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ninstanceplugin_demo = volcenginecc.rabbitmq.InstancePlugin(\"instancepluginDemo\",\n instance_id=\"rbtmq-db26b7****\",\n plugin_name=\"ccapi-test\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var instancepluginDemo = new Volcenginecc.Rabbitmq.InstancePlugin(\"instancepluginDemo\", new()\n {\n InstanceId = \"rbtmq-db26b7****\",\n PluginName = \"ccapi-test\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rabbitmq\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := rabbitmq.NewInstancePlugin(ctx, \"instancepluginDemo\", \u0026rabbitmq.InstancePluginArgs{\n\t\t\tInstanceId: pulumi.String(\"rbtmq-db26b7****\"),\n\t\t\tPluginName: pulumi.String(\"ccapi-test\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.rabbitmq.InstancePlugin;\nimport com.volcengine.volcenginecc.rabbitmq.InstancePluginArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var instancepluginDemo = new InstancePlugin(\"instancepluginDemo\", InstancePluginArgs.builder()\n .instanceId(\"rbtmq-db26b7****\")\n .pluginName(\"ccapi-test\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n instancepluginDemo:\n type: volcenginecc:rabbitmq:InstancePlugin\n properties:\n instanceId: rbtmq-db26b7****\n pluginName: ccapi-test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rabbitmq/instancePlugin:InstancePlugin example \"instance_id|plugin_name\"\n```\n\n", "properties": { "description": { "type": "string", "description": "Plugin description\n" }, "disablePrompt": { "type": "string", "description": "Notes for disabling this plugin\n" }, "enablePrompt": { "type": "string", "description": "Notes for enabling this plugin\n" }, "enabled": { "type": "boolean", "description": "Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "needRebootOnChange": { "type": "boolean", "description": "Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart\n" }, "pluginName": { "type": "string", "description": "Plugin name\n" }, "port": { "type": "integer", "description": "Plugin listening port\n" }, "version": { "type": "string", "description": "Plugin version\n" } }, "required": [ "description", "disablePrompt", "enablePrompt", "enabled", "instanceId", "needRebootOnChange", "pluginName", "port", "version" ], "inputProperties": { "instanceId": { "type": "string", "description": "Instance ID\n" }, "pluginName": { "type": "string", "description": "Plugin name\n" } }, "requiredInputs": [ "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering InstancePlugin resources.\n", "properties": { "description": { "type": "string", "description": "Plugin description\n" }, "disablePrompt": { "type": "string", "description": "Notes for disabling this plugin\n" }, "enablePrompt": { "type": "string", "description": "Notes for enabling this plugin\n" }, "enabled": { "type": "boolean", "description": "Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "needRebootOnChange": { "type": "boolean", "description": "Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart\n" }, "pluginName": { "type": "string", "description": "Plugin name\n" }, "port": { "type": "integer", "description": "Plugin listening port\n" }, "version": { "type": "string", "description": "Plugin version\n" } }, "type": "object" } }, "volcenginecc:rabbitmq/publicAddress:PublicAddress": { "description": "RabbitMQ supports enabling public access. Once enabled, you can access the RabbitMQ instance via the public network.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst publicaddressDemo = new volcenginecc.rabbitmq.PublicAddress(\"publicaddressDemo\", {\n instanceId: \"rbtmq-db26b7****\",\n eipId: \"eip-2f8w9fh1qmwao4****\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\npublicaddress_demo = volcenginecc.rabbitmq.PublicAddress(\"publicaddressDemo\",\n instance_id=\"rbtmq-db26b7****\",\n eip_id=\"eip-2f8w9fh1qmwao4****\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var publicaddressDemo = new Volcenginecc.Rabbitmq.PublicAddress(\"publicaddressDemo\", new()\n {\n InstanceId = \"rbtmq-db26b7****\",\n EipId = \"eip-2f8w9fh1qmwao4****\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rabbitmq\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := rabbitmq.NewPublicAddress(ctx, \"publicaddressDemo\", \u0026rabbitmq.PublicAddressArgs{\n\t\t\tInstanceId: pulumi.String(\"rbtmq-db26b7****\"),\n\t\t\tEipId: pulumi.String(\"eip-2f8w9fh1qmwao4****\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.rabbitmq.PublicAddress;\nimport com.volcengine.volcenginecc.rabbitmq.PublicAddressArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var publicaddressDemo = new PublicAddress(\"publicaddressDemo\", PublicAddressArgs.builder()\n .instanceId(\"rbtmq-db26b7****\")\n .eipId(\"eip-2f8w9fh1qmwao4****\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n publicaddressDemo:\n type: volcenginecc:rabbitmq:PublicAddress\n properties:\n instanceId: rbtmq-db26b7****\n eipId: eip-2f8w9fh1qmwao4****\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rabbitmq/publicAddress:PublicAddress example \"instance_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Main account ID that created the instance.\n" }, "applyPrivateDnsToPublic": { "type": "boolean", "description": "Whether public DNS resolution is enabled. true: enabled, false: disabled.\n" }, "archType": { "type": "string", "description": "Instance type: cluster or standalone.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rabbitmq/PublicAddressChargeDetail:PublicAddressChargeDetail", "description": "Instance billing method and related billing information.\n" }, "computeSpec": { "type": "string", "description": "RabbitMQ instance compute specification.\n" }, "createdTime": { "type": "string", "description": "Instance creation time.\n" }, "eipId": { "type": "string", "description": "EIP ID.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/PublicAddressEndpoint:PublicAddressEndpoint" } }, "instanceDescription": { "type": "string", "description": "Brief description of the instance.\n" }, "instanceId": { "type": "string", "description": "RabbitMQ instance ID.\n" }, "instanceName": { "type": "string", "description": "RabbitMQ instance name.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "isEncrypted": { "type": "boolean", "description": "Whether cloud disk encryption is enabled.\n" }, "projectName": { "type": "string", "description": "IAM project the instance belongs to.\n" }, "storageSpace": { "type": "integer", "description": "Total storage space of the instance, in GiB.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/PublicAddressTag:PublicAddressTag" } }, "usedStorageSpace": { "type": "integer", "description": "Used storage space of the instance, in GiB.\n" }, "userName": { "type": "string", "description": "RabbitMQ WebUI administrator account name.\n" }, "version": { "type": "string", "description": "Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID.\n" }, "zoneDescription": { "type": "string", "description": "Description of the availability zone.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. For high availability instances across AZs, multiple availability zone IDs are returned.\n" } }, "required": [ "accountId", "applyPrivateDnsToPublic", "archType", "chargeDetail", "computeSpec", "createdTime", "eipId", "endpoints", "instanceDescription", "instanceId", "instanceName", "instanceStatus", "isEncrypted", "projectName", "storageSpace", "subnetId", "tags", "usedStorageSpace", "userName", "version", "vpcId", "zoneDescription", "zoneId" ], "inputProperties": { "eipId": { "type": "string", "description": "EIP ID.\n" }, "instanceId": { "type": "string", "description": "RabbitMQ instance ID.\n" } }, "requiredInputs": [ "eipId", "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering PublicAddress resources.\n", "properties": { "accountId": { "type": "string", "description": "Main account ID that created the instance.\n" }, "applyPrivateDnsToPublic": { "type": "boolean", "description": "Whether public DNS resolution is enabled. true: enabled, false: disabled.\n" }, "archType": { "type": "string", "description": "Instance type: cluster or standalone.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rabbitmq/PublicAddressChargeDetail:PublicAddressChargeDetail", "description": "Instance billing method and related billing information.\n" }, "computeSpec": { "type": "string", "description": "RabbitMQ instance compute specification.\n" }, "createdTime": { "type": "string", "description": "Instance creation time.\n" }, "eipId": { "type": "string", "description": "EIP ID.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/PublicAddressEndpoint:PublicAddressEndpoint" } }, "instanceDescription": { "type": "string", "description": "Brief description of the instance.\n" }, "instanceId": { "type": "string", "description": "RabbitMQ instance ID.\n" }, "instanceName": { "type": "string", "description": "RabbitMQ instance name.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "isEncrypted": { "type": "boolean", "description": "Whether cloud disk encryption is enabled.\n" }, "projectName": { "type": "string", "description": "IAM project the instance belongs to.\n" }, "storageSpace": { "type": "integer", "description": "Total storage space of the instance, in GiB.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rabbitmq/PublicAddressTag:PublicAddressTag" } }, "usedStorageSpace": { "type": "integer", "description": "Used storage space of the instance, in GiB.\n" }, "userName": { "type": "string", "description": "RabbitMQ WebUI administrator account name.\n" }, "version": { "type": "string", "description": "Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID.\n" }, "zoneDescription": { "type": "string", "description": "Description of the availability zone.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. For high availability instances across AZs, multiple availability zone IDs are returned.\n" } }, "type": "object" } }, "volcenginecc:rdsmssql/allowList:AllowList": { "description": "API request parameter - Create RDS SQL Server allowlist (CreateAllowList)\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rDSMsSQLAllowlistDemo:\n type: volcenginecc:rdsmssql:AllowList\n name: RDSMsSQLAllowlistDemo\n properties:\n projectName: default\n allowListName: ccapi-test-all\n allowListDesc: ccapi-test\n allowListType: IPv4\n allowListCategory: Ordinary\n allowList: 192.168.0.0/24,192.168.0.1,192.168.0.2\n userAllowList: 192.168.0.0/24,192.168.0.1,192.168.0.2\n associatedInstances:\n - instance_id: mssql-9b195******\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdsmssql/allowList:AllowList example \"allow_list_id\"\n```\n\n", "properties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListCategory": { "type": "string", "description": "Allowlist category\n" }, "allowListDesc": { "type": "string", "description": "Allowlist description\n" }, "allowListId": { "type": "string", "description": "Allowlist ID\n" }, "allowListIpNum": { "type": "integer", "description": "Allowlist IP count\n" }, "allowListName": { "type": "string", "description": "Allowlist name\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is supported\n" }, "associatedInstanceNum": { "type": "integer", "description": "Number of bound instances. Required when unbinding an instance from the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "userAllowList": { "type": "string", "description": "IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence\n" } }, "required": [ "allowList", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "instanceId", "projectName", "userAllowList" ], "inputProperties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListCategory": { "type": "string", "description": "Allowlist category\n" }, "allowListDesc": { "type": "string", "description": "Allowlist description\n" }, "allowListName": { "type": "string", "description": "Allowlist name\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is supported\n" }, "associatedInstanceNum": { "type": "integer", "description": "Number of bound instances. Required when unbinding an instance from the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "userAllowList": { "type": "string", "description": "IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence\n" } }, "requiredInputs": [ "allowListName" ], "stateInputs": { "description": "Input properties used for looking up and filtering AllowList resources.\n", "properties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListCategory": { "type": "string", "description": "Allowlist category\n" }, "allowListDesc": { "type": "string", "description": "Allowlist description\n" }, "allowListId": { "type": "string", "description": "Allowlist ID\n" }, "allowListIpNum": { "type": "integer", "description": "Allowlist IP count\n" }, "allowListName": { "type": "string", "description": "Allowlist name\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is supported\n" }, "associatedInstanceNum": { "type": "integer", "description": "Number of bound instances. Required when unbinding an instance from the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "userAllowList": { "type": "string", "description": "IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence\n" } }, "type": "object" } }, "volcenginecc:rdsmssql/instance:Instance": { "description": "Cloud Database SQL Server Edition is a stable, reliable, and scalable online database service built on the world-class commercial database product Microsoft SQL Server. Creating an instance is the first step to using Cloud Database SQL Server Edition\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rDSMsSQLInstanceDemo:\n type: volcenginecc:rdsmssql:Instance\n name: RDSMsSQLInstanceDemo\n properties:\n nodeSpec: rds.mssql.3il.x8.medium.s1\n zoneId: cn-beijing-a\n subnetId: subnet-1a0zgr5e7hslc8nvepxxxxx\n dbEngineVersion: SQLServer_2019_Std\n instanceType: Basic\n storageSpace: 20\n vpcId: vpc-3nqt4kq87xn2893xxxxx\n instanceName: RDSMsSQLInstanceDemo\n superAccountPassword: '********'\n serverCollation: Chinese_PRC_CI_AS\n timeZone: China Standard Time\n chargeInfo:\n charge_type: PostPaid\n projectName: default\n maintenanceTime: 18:00Z-21:59Z\n allowListIds:\n - acl-03f197e136c843b29e47de74e9xxxxx\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdsmssql/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "advancedFeatures": { "type": "string", "description": "Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {\"Key\":\"Value\"}\n" }, "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID list permitted for access.\n" }, "backupUse": { "type": "number", "description": "Used backup space for the instance, in GiB.\n" }, "chargeInfo": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceChargeInfo:InstanceChargeInfo", "description": "Payment method.\n" }, "connectionInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceConnectionInfo:InstanceConnectionInfo" } }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible version. Values: SQLServer*2019*Std: SQL Server 2019 Standard Edition. SQLServer*2019*Ent: SQL Server 2019 Enterprise Edition. SQLServer*2019*Web: SQL Server 2019 Web Edition. SQLServer*2022*Std: SQL Server 2022 Standard Edition. SQLServer*2022*Ent: SQL Server 2022 Enterprise Edition. SQLServer*2022*Web: SQL Server 2022 Web Edition.\n" }, "innerVersion": { "type": "string", "description": "Kernel version number.\n" }, "instanceCategory": { "type": "string", "description": "Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.\n" }, "instanceStatus": { "type": "string", "description": "Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.\n" }, "instanceType": { "type": "string", "description": "Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.\n" }, "masterNodeId": { "type": "string", "description": "Primary node ID. This parameter is required when manually switching master and standby nodes.\n" }, "memory": { "type": "integer", "description": "Memory size, in GiB.\n" }, "nodeDetailInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceNodeDetailInfo:InstanceNodeDetailInfo" } }, "nodeSpec": { "type": "string", "description": "Instance specification code.\n" }, "port": { "type": "string", "description": "Port.\n" }, "primaryInstanceId": { "type": "string", "description": "Primary instance ID. If this field is empty, this instance is the primary instance.\n" }, "projectName": { "type": "string", "description": "Project.\n" }, "readOnlyNumber": { "type": "integer", "description": "Number of read-only instances.\n" }, "serverCollation": { "type": "string", "description": "Instance collation. Default: Chinese*PRC*CI*AS. Most native collations are supported. Available values: Latin1*General*CI*AS, Latin1*General*CS*AS, SQL*Latin1*General*CP1*CI*AS, SQL*Latin1*General*CP1*CS*AS, Chinese*PRC*CI*AS, Chinese*PRC*CS*AS, Chinese*PRC*BIN, Japanese*CI*AS, Japanese*CS*AS, Chinese*Taiwan*Stroke*CI*AS, Chinese*Taiwan*Stroke*CS*AS, Thai*CI*AS, Chinese*PRC*CI*AI, Chinese*PRC*BIN2, Cyrillic*General*CI_AS.\n" }, "slowQueryEnable": { "type": "boolean", "description": "Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.\n" }, "slowQueryTime": { "type": "string", "description": "Slow log threshold. Range: [1~10], unit: seconds (s).\n" }, "storageSpace": { "type": "integer", "description": "Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.\n" }, "storageType": { "type": "string", "description": "Instance storage type.\n" }, "storageUse": { "type": "number", "description": "Used storage space for the instance. Unit: GiB.\n" }, "subnetId": { "type": "string", "description": "Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.\n" }, "superAccountPassword": { "type": "string", "description": "Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^\u0026*()_+-=.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceTag:InstanceTag" } }, "timeZone": { "type": "string", "description": "Time zone.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "vcpu": { "type": "integer", "description": "CPU size. For example: 1 means 1 core.\n" }, "vpcId": { "type": "string", "description": "VPC ID\n" }, "zoneId": { "type": "string", "description": "Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.\n" } }, "required": [ "advancedFeatures", "allowListIds", "backupUse", "chargeInfo", "connectionInfos", "createdTime", "dbEngineVersion", "innerVersion", "instanceCategory", "instanceId", "instanceName", "instanceStatus", "instanceType", "maintenanceTime", "masterNodeId", "memory", "nodeDetailInfos", "nodeSpec", "port", "primaryInstanceId", "projectName", "readOnlyNumber", "serverCollation", "slowQueryEnable", "slowQueryTime", "storageSpace", "storageType", "storageUse", "subnetId", "superAccountPassword", "tags", "timeZone", "updatedTime", "vcpu", "vpcId", "zoneId" ], "inputProperties": { "advancedFeatures": { "type": "string", "description": "Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {\"Key\":\"Value\"}\n" }, "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID list permitted for access.\n" }, "chargeInfo": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceChargeInfo:InstanceChargeInfo", "description": "Payment method.\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible version. Values: SQLServer*2019*Std: SQL Server 2019 Standard Edition. SQLServer*2019*Ent: SQL Server 2019 Enterprise Edition. SQLServer*2019*Web: SQL Server 2019 Web Edition. SQLServer*2022*Std: SQL Server 2022 Standard Edition. SQLServer*2022*Ent: SQL Server 2022 Enterprise Edition. SQLServer*2022*Web: SQL Server 2022 Web Edition.\n" }, "instanceName": { "type": "string", "description": "Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.\n" }, "instanceType": { "type": "string", "description": "Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.\n" }, "masterNodeId": { "type": "string", "description": "Primary node ID. This parameter is required when manually switching master and standby nodes.\n" }, "nodeSpec": { "type": "string", "description": "Instance specification code.\n" }, "projectName": { "type": "string", "description": "Project.\n" }, "serverCollation": { "type": "string", "description": "Instance collation. Default: Chinese*PRC*CI*AS. Most native collations are supported. Available values: Latin1*General*CI*AS, Latin1*General*CS*AS, SQL*Latin1*General*CP1*CI*AS, SQL*Latin1*General*CP1*CS*AS, Chinese*PRC*CI*AS, Chinese*PRC*CS*AS, Chinese*PRC*BIN, Japanese*CI*AS, Japanese*CS*AS, Chinese*Taiwan*Stroke*CI*AS, Chinese*Taiwan*Stroke*CS*AS, Thai*CI*AS, Chinese*PRC*CI*AI, Chinese*PRC*BIN2, Cyrillic*General*CI_AS.\n" }, "storageSpace": { "type": "integer", "description": "Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.\n" }, "subnetId": { "type": "string", "description": "Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.\n" }, "superAccountPassword": { "type": "string", "description": "Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^\u0026*()_+-=.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceTag:InstanceTag" } }, "timeZone": { "type": "string", "description": "Time zone.\n" }, "vpcId": { "type": "string", "description": "VPC ID\n" }, "zoneId": { "type": "string", "description": "Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.\n" } }, "requiredInputs": [ "dbEngineVersion", "instanceType", "nodeSpec", "storageSpace", "subnetId", "superAccountPassword", "timeZone", "vpcId", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "advancedFeatures": { "type": "string", "description": "Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {\"Key\":\"Value\"}\n" }, "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID list permitted for access.\n" }, "backupUse": { "type": "number", "description": "Used backup space for the instance, in GiB.\n" }, "chargeInfo": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceChargeInfo:InstanceChargeInfo", "description": "Payment method.\n" }, "connectionInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceConnectionInfo:InstanceConnectionInfo" } }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible version. Values: SQLServer*2019*Std: SQL Server 2019 Standard Edition. SQLServer*2019*Ent: SQL Server 2019 Enterprise Edition. SQLServer*2019*Web: SQL Server 2019 Web Edition. SQLServer*2022*Std: SQL Server 2022 Standard Edition. SQLServer*2022*Ent: SQL Server 2022 Enterprise Edition. SQLServer*2022*Web: SQL Server 2022 Web Edition.\n" }, "innerVersion": { "type": "string", "description": "Kernel version number.\n" }, "instanceCategory": { "type": "string", "description": "Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.\n" }, "instanceStatus": { "type": "string", "description": "Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.\n" }, "instanceType": { "type": "string", "description": "Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.\n" }, "maintenanceTime": { "type": "string", "description": "Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.\n" }, "masterNodeId": { "type": "string", "description": "Primary node ID. This parameter is required when manually switching master and standby nodes.\n" }, "memory": { "type": "integer", "description": "Memory size, in GiB.\n" }, "nodeDetailInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceNodeDetailInfo:InstanceNodeDetailInfo" } }, "nodeSpec": { "type": "string", "description": "Instance specification code.\n" }, "port": { "type": "string", "description": "Port.\n" }, "primaryInstanceId": { "type": "string", "description": "Primary instance ID. If this field is empty, this instance is the primary instance.\n" }, "projectName": { "type": "string", "description": "Project.\n" }, "readOnlyNumber": { "type": "integer", "description": "Number of read-only instances.\n" }, "serverCollation": { "type": "string", "description": "Instance collation. Default: Chinese*PRC*CI*AS. Most native collations are supported. Available values: Latin1*General*CI*AS, Latin1*General*CS*AS, SQL*Latin1*General*CP1*CI*AS, SQL*Latin1*General*CP1*CS*AS, Chinese*PRC*CI*AS, Chinese*PRC*CS*AS, Chinese*PRC*BIN, Japanese*CI*AS, Japanese*CS*AS, Chinese*Taiwan*Stroke*CI*AS, Chinese*Taiwan*Stroke*CS*AS, Thai*CI*AS, Chinese*PRC*CI*AI, Chinese*PRC*BIN2, Cyrillic*General*CI_AS.\n" }, "slowQueryEnable": { "type": "boolean", "description": "Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.\n" }, "slowQueryTime": { "type": "string", "description": "Slow log threshold. Range: [1~10], unit: seconds (s).\n" }, "storageSpace": { "type": "integer", "description": "Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.\n" }, "storageType": { "type": "string", "description": "Instance storage type.\n" }, "storageUse": { "type": "number", "description": "Used storage space for the instance. Unit: GiB.\n" }, "subnetId": { "type": "string", "description": "Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.\n" }, "superAccountPassword": { "type": "string", "description": "Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^\u0026*()_+-=.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmssql/InstanceTag:InstanceTag" } }, "timeZone": { "type": "string", "description": "Time zone.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "vcpu": { "type": "integer", "description": "CPU size. For example: 1 means 1 core.\n" }, "vpcId": { "type": "string", "description": "VPC ID\n" }, "zoneId": { "type": "string", "description": "Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.\n" } }, "type": "object" } }, "volcenginecc:rdsmysql/allowList:AllowList": { "description": "The allowlist is a security measure for database connections. Only IP addresses in the allowlist can access the database.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rdsMysqlAllowListDemo:\n type: volcenginecc:rdsmysql:AllowList\n name: RdsMysqlAllowListDemo\n properties:\n userAllowLists:\n - 1.2.3.4\n allowListCategory: Default\n allowListDesc: this is a test\n allowListName: ccapi-test-2\n allowListType: IPv4\n projectName: default\n securityGroupBindInfos:\n - bind_mode: AssociateEcsIp\n ip_list: null\n security_group_id: sg-1a10axxxxxvepkdgqgnu\n security_group_name: Default\n - bind_mode: IngressDirectionIp\n ip_list:\n - 100.70.0.0/16\n - 100.72.0.0/16\n - 0.0.0.0/0\n security_group_id: sg-3nqt4kwxxxxx931ebkntmrc\n security_group_name: Default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdsmysql/allowList:AllowList example \"allow_list_id\"\n```\n\n", "properties": { "allowListCategory": { "type": "string", "description": "Allowlist category. Values: Ordinary: Ordinary allowlist. Default: Default allowlist. Note: When used as a request parameter, the default value is Ordinary.\n" }, "allowListDesc": { "type": "string", "description": "Allowlist remarks.\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or ranges) in the allowlist.\n" }, "allowListName": { "type": "string", "description": "Allowlist name.\n" }, "allowListType": { "type": "string", "description": "IP address types in the allowlist. Only IPv4 addresses are currently supported.\n" }, "allowLists": { "type": "array", "items": { "type": "string" }, "description": "IP address list in the allowlist\n", "language": { "csharp": { "name": "AllowListValue" } } }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist.\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "ignoreInstanceStatus": { "type": "boolean", "description": "Ignore instance status check. Values: true: Yes. false: No. Default value.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "ipLists": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses and IP ranges included in the allowlist. Returned when the WithIpList request parameter is set to true; returns null when set to false or not specified.\n" }, "modifyMode": { "type": "string", "description": "Modification method. Available values: Cover (default): Overwrite the original allowlist with the values from the AllowList parameter. Append: Add the IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove the IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain.\n" }, "projectName": { "type": "string", "description": "Project. Note: If the AK/SK used to call the API belongs to a sub-account that only has permission for a specific project, you need to provide this request parameter.\n" }, "securityGroupBindInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo" } }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs to associate. Note: You can call the DescribeSecurityGroups API to query security group information, including security group IDs. A single allowlist can add up to 10 security groups at a time. This field cannot be used together with SecurityGroupBindInfos.\n" }, "updateSecurityGroup": { "type": "boolean", "description": "Whether to update the security group bound to the allowlist. true: update. false: do not update. Default value. This field is effective only when the allowlist is already bound to a security group. You can call the DescribeAllowLists API to check if the allowlist is bound to a security group.\n" }, "userAllowLists": { "type": "array", "items": { "type": "string" }, "description": "IP addresses entered by the user in this list. The IPs in the AllowList field are the union of IPs included in UserAllowList and SecurityGroupBindInfos.\n" } }, "required": [ "allowLists", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "ignoreInstanceStatus", "instanceId", "ipLists", "modifyMode", "projectName", "securityGroupBindInfos", "securityGroupIds", "updateSecurityGroup", "userAllowLists" ], "inputProperties": { "allowListCategory": { "type": "string", "description": "Allowlist category. Values: Ordinary: Ordinary allowlist. Default: Default allowlist. Note: When used as a request parameter, the default value is Ordinary.\n" }, "allowListDesc": { "type": "string", "description": "Allowlist remarks.\n" }, "allowListName": { "type": "string", "description": "Allowlist name.\n" }, "allowListType": { "type": "string", "description": "IP address types in the allowlist. Only IPv4 addresses are currently supported.\n" }, "allowLists": { "type": "array", "items": { "type": "string" }, "description": "IP address list in the allowlist\n", "language": { "csharp": { "name": "AllowListValue" } } }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist.\n" }, "ignoreInstanceStatus": { "type": "boolean", "description": "Ignore instance status check. Values: true: Yes. false: No. Default value.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "modifyMode": { "type": "string", "description": "Modification method. Available values: Cover (default): Overwrite the original allowlist with the values from the AllowList parameter. Append: Add the IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove the IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain.\n" }, "projectName": { "type": "string", "description": "Project. Note: If the AK/SK used to call the API belongs to a sub-account that only has permission for a specific project, you need to provide this request parameter.\n" }, "securityGroupBindInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo" } }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs to associate. Note: You can call the DescribeSecurityGroups API to query security group information, including security group IDs. A single allowlist can add up to 10 security groups at a time. This field cannot be used together with SecurityGroupBindInfos.\n" }, "updateSecurityGroup": { "type": "boolean", "description": "Whether to update the security group bound to the allowlist. true: update. false: do not update. Default value. This field is effective only when the allowlist is already bound to a security group. You can call the DescribeAllowLists API to check if the allowlist is bound to a security group.\n" }, "userAllowLists": { "type": "array", "items": { "type": "string" }, "description": "IP addresses entered by the user in this list. The IPs in the AllowList field are the union of IPs included in UserAllowList and SecurityGroupBindInfos.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering AllowList resources.\n", "properties": { "allowListCategory": { "type": "string", "description": "Allowlist category. Values: Ordinary: Ordinary allowlist. Default: Default allowlist. Note: When used as a request parameter, the default value is Ordinary.\n" }, "allowListDesc": { "type": "string", "description": "Allowlist remarks.\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or ranges) in the allowlist.\n" }, "allowListName": { "type": "string", "description": "Allowlist name.\n" }, "allowListType": { "type": "string", "description": "IP address types in the allowlist. Only IPv4 addresses are currently supported.\n" }, "allowLists": { "type": "array", "items": { "type": "string" }, "description": "IP address list in the allowlist\n", "language": { "csharp": { "name": "AllowListValue" } } }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist.\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "ignoreInstanceStatus": { "type": "boolean", "description": "Ignore instance status check. Values: true: Yes. false: No. Default value.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "ipLists": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses and IP ranges included in the allowlist. Returned when the WithIpList request parameter is set to true; returns null when set to false or not specified.\n" }, "modifyMode": { "type": "string", "description": "Modification method. Available values: Cover (default): Overwrite the original allowlist with the values from the AllowList parameter. Append: Add the IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove the IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain.\n" }, "projectName": { "type": "string", "description": "Project. Note: If the AK/SK used to call the API belongs to a sub-account that only has permission for a specific project, you need to provide this request parameter.\n" }, "securityGroupBindInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo" } }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security group IDs to associate. Note: You can call the DescribeSecurityGroups API to query security group information, including security group IDs. A single allowlist can add up to 10 security groups at a time. This field cannot be used together with SecurityGroupBindInfos.\n" }, "updateSecurityGroup": { "type": "boolean", "description": "Whether to update the security group bound to the allowlist. true: update. false: do not update. Default value. This field is effective only when the allowlist is already bound to a security group. You can call the DescribeAllowLists API to check if the allowlist is bound to a security group.\n" }, "userAllowLists": { "type": "array", "items": { "type": "string" }, "description": "IP addresses entered by the user in this list. The IPs in the AllowList field are the union of IPs included in UserAllowList and SecurityGroupBindInfos.\n" } }, "type": "object" } }, "volcenginecc:rdsmysql/backup:Backup": { "description": "Backups are important runtime files for the database. Based on backup files, the database can achieve disaster recovery and restoration. MySQL Cloud Database provides two backup capabilities: data backup and log backup. Data backup allows you to restore the database to a specific backup set, while log backup enables restoration to a specified point in time\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst rdsmysqlbackupDemo = new volcenginecc.rdsmysql.Backup(\"rdsmysqlbackupDemo\", {\n instanceId: \"mysql-9e2c59****\",\n backupMethod: \"Logical\",\n backupMetas: [{\n database: \"test\",\n tables: [],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nrdsmysqlbackup_demo = volcenginecc.rdsmysql.Backup(\"rdsmysqlbackupDemo\",\n instance_id=\"mysql-9e2c59****\",\n backup_method=\"Logical\",\n backup_metas=[{\n \"database\": \"test\",\n \"tables\": [],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var rdsmysqlbackupDemo = new Volcenginecc.Rdsmysql.Backup(\"rdsmysqlbackupDemo\", new()\n {\n InstanceId = \"mysql-9e2c59****\",\n BackupMethod = \"Logical\",\n BackupMetas = new[]\n {\n new Volcenginecc.Rdsmysql.Inputs.BackupBackupMetaArgs\n {\n Database = \"test\",\n Tables = new() { },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rdsmysql\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := rdsmysql.NewBackup(ctx, \"rdsmysqlbackupDemo\", \u0026rdsmysql.BackupArgs{\n\t\t\tInstanceId: pulumi.String(\"mysql-9e2c59****\"),\n\t\t\tBackupMethod: pulumi.String(\"Logical\"),\n\t\t\tBackupMetas: rdsmysql.BackupBackupMetaArray{\n\t\t\t\t\u0026rdsmysql.BackupBackupMetaArgs{\n\t\t\t\t\tDatabase: pulumi.String(\"test\"),\n\t\t\t\t\tTables: pulumi.StringArray{},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.rdsmysql.Backup;\nimport com.volcengine.volcenginecc.rdsmysql.BackupArgs;\nimport com.pulumi.volcenginecc.rdsmysql.inputs.BackupBackupMetaArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var rdsmysqlbackupDemo = new Backup(\"rdsmysqlbackupDemo\", BackupArgs.builder()\n .instanceId(\"mysql-9e2c59****\")\n .backupMethod(\"Logical\")\n .backupMetas(BackupBackupMetaArgs.builder()\n .database(\"test\")\n .tables()\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n rdsmysqlbackupDemo:\n type: volcenginecc:rdsmysql:Backup\n properties:\n instanceId: mysql-9e2c59****\n backupMethod: Logical\n backupMetas:\n - database: test\n tables: []\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdsmysql/backup:Backup example \"instance_id|backup_id\"\n```\n\n", "properties": { "backupEndTime": { "type": "string", "description": "Backup creation end time (UTC)\n" }, "backupFileName": { "type": "string", "description": "Backup file name\n" }, "backupFileSize": { "type": "integer", "description": "Backup file size (bytes)\n" }, "backupId": { "type": "string", "description": "Backup ID\n" }, "backupMetas": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/BackupBackupMeta:BackupBackupMeta" } }, "backupMethod": { "type": "string", "description": "Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)\n" }, "backupName": { "type": "string", "description": "Backup name\n" }, "backupRegion": { "type": "string", "description": "Backup region\n" }, "backupStartTime": { "type": "string", "description": "Backup creation start time (UTC)\n" }, "backupStatus": { "type": "string", "description": "Backup status. Values: Success, Failed, Running\n" }, "backupType": { "type": "string", "description": "Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)\n" }, "consistentTime": { "type": "string", "description": "Consistency time point\n" }, "createType": { "type": "string", "description": "Backup creator. Values: System (system), User (user)\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible version. Values: MySQL*5*7: MySQL 5.7 version; MySQL*8*0: MySQL 8.0 version\n" }, "dbTableInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/BackupDbTableInfo:BackupDbTableInfo" } }, "downloadStatus": { "type": "string", "description": "Download status\n" }, "engineType": { "type": "string", "description": "Database engine type. Values: InnoDB: InnoDB engine; RocksDB: RocksDB engine\n" }, "errorMessage": { "type": "string", "description": "Error message for backup failure\n" }, "expiredTime": { "type": "string", "description": "Backup expiration time (UTC)\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "isEncrypted": { "type": "boolean", "description": "Whether encrypted\n" }, "isExpired": { "type": "boolean", "description": "Whether expired\n" } }, "required": [ "backupEndTime", "backupFileName", "backupFileSize", "backupId", "backupMetas", "backupMethod", "backupName", "backupRegion", "backupStartTime", "backupStatus", "backupType", "consistentTime", "createType", "dbEngineVersion", "dbTableInfos", "downloadStatus", "engineType", "errorMessage", "expiredTime", "instanceId", "isEncrypted", "isExpired" ], "inputProperties": { "backupMetas": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/BackupBackupMeta:BackupBackupMeta" } }, "backupMethod": { "type": "string", "description": "Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)\n" }, "backupType": { "type": "string", "description": "Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "requiredInputs": [ "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Backup resources.\n", "properties": { "backupEndTime": { "type": "string", "description": "Backup creation end time (UTC)\n" }, "backupFileName": { "type": "string", "description": "Backup file name\n" }, "backupFileSize": { "type": "integer", "description": "Backup file size (bytes)\n" }, "backupId": { "type": "string", "description": "Backup ID\n" }, "backupMetas": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/BackupBackupMeta:BackupBackupMeta" } }, "backupMethod": { "type": "string", "description": "Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)\n" }, "backupName": { "type": "string", "description": "Backup name\n" }, "backupRegion": { "type": "string", "description": "Backup region\n" }, "backupStartTime": { "type": "string", "description": "Backup creation start time (UTC)\n" }, "backupStatus": { "type": "string", "description": "Backup status. Values: Success, Failed, Running\n" }, "backupType": { "type": "string", "description": "Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)\n" }, "consistentTime": { "type": "string", "description": "Consistency time point\n" }, "createType": { "type": "string", "description": "Backup creator. Values: System (system), User (user)\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible version. Values: MySQL*5*7: MySQL 5.7 version; MySQL*8*0: MySQL 8.0 version\n" }, "dbTableInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/BackupDbTableInfo:BackupDbTableInfo" } }, "downloadStatus": { "type": "string", "description": "Download status\n" }, "engineType": { "type": "string", "description": "Database engine type. Values: InnoDB: InnoDB engine; RocksDB: RocksDB engine\n" }, "errorMessage": { "type": "string", "description": "Error message for backup failure\n" }, "expiredTime": { "type": "string", "description": "Backup expiration time (UTC)\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "isEncrypted": { "type": "boolean", "description": "Whether encrypted\n" }, "isExpired": { "type": "boolean", "description": "Whether expired\n" } }, "type": "object" } }, "volcenginecc:rdsmysql/database:Database": { "description": "Database\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n databaseDemo:\n type: volcenginecc:rdsmysql:Database\n name: DatabaseDemo\n properties:\n characterSetName: utf8\n databasePrivileges:\n - account_name: a***\n account_privilege: ReadOnly\n host: '%'\n description: Demo Example\n instanceId: mysql-779***\n name: rdstest\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdsmysql/database:Database example \"instance_id|name\"\n```\n\n", "properties": { "characterSetName": { "type": "string", "description": "Database character set. Supported character sets: utf8, utf8mb4 (default), latin1, ascii.\n" }, "databasePrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DatabaseDatabasePrivilege:DatabaseDatabasePrivilege" } }, "description": { "type": "string", "description": "Database description, up to 256 characters. This field is optional. If not set, or if set with a description length of 0, the description will be empty.\n" }, "instanceId": { "type": "string", "description": "Database instance ID.\n" }, "name": { "type": "string", "description": "Database name. Naming rules: must be unique; length must be 2–64 characters; must start with a letter and end with a letter or number; can contain letters, numbers, underscores (_), or hyphens (-); certain reserved words, such as root and admin, cannot be used.\n" }, "status": { "type": "string", "description": "Database status. Values: Unavailable (not available), Available (available).\n" } }, "required": [ "characterSetName", "databasePrivileges", "description", "instanceId", "name", "status" ], "inputProperties": { "characterSetName": { "type": "string", "description": "Database character set. Supported character sets: utf8, utf8mb4 (default), latin1, ascii.\n" }, "databasePrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DatabaseDatabasePrivilege:DatabaseDatabasePrivilege" } }, "description": { "type": "string", "description": "Database description, up to 256 characters. This field is optional. If not set, or if set with a description length of 0, the description will be empty.\n" }, "instanceId": { "type": "string", "description": "Database instance ID.\n" }, "name": { "type": "string", "description": "Database name. Naming rules: must be unique; length must be 2–64 characters; must start with a letter and end with a letter or number; can contain letters, numbers, underscores (_), or hyphens (-); certain reserved words, such as root and admin, cannot be used.\n" } }, "requiredInputs": [ "instanceId", "name" ], "stateInputs": { "description": "Input properties used for looking up and filtering Database resources.\n", "properties": { "characterSetName": { "type": "string", "description": "Database character set. Supported character sets: utf8, utf8mb4 (default), latin1, ascii.\n" }, "databasePrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DatabaseDatabasePrivilege:DatabaseDatabasePrivilege" } }, "description": { "type": "string", "description": "Database description, up to 256 characters. This field is optional. If not set, or if set with a description length of 0, the description will be empty.\n" }, "instanceId": { "type": "string", "description": "Database instance ID.\n" }, "name": { "type": "string", "description": "Database name. Naming rules: must be unique; length must be 2–64 characters; must start with a letter and end with a letter or number; can contain letters, numbers, underscores (_), or hyphens (-); certain reserved words, such as root and admin, cannot be used.\n" }, "status": { "type": "string", "description": "Database status. Values: Unavailable (not available), Available (available).\n" } }, "type": "object" } }, "volcenginecc:rdsmysql/dbAccount:DbAccount": { "description": "Database account.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rDSMySQLDBAccountDemo:\n type: volcenginecc:rdsmysql:DbAccount\n name: RDSMySQLDBAccountDemo\n properties:\n accountDesc: RDSMySQLDBAccountDemo desc\n instanceId: mysql-a5b5caexxxxx\n accountName: RDSMySQLDBAccountDemo\n accountPassword: '********'\n accountType: Normal\n accountPrivileges:\n - account_privilege: Custom\n account_privilege_detail:\n - CREATE\n - DROP\n - REFERENCES\n - INDEX\n db_name: test\n - account_privilege: Global\n account_privilege_detail:\n - PROCESS\n - REPLICATION SLAVE\n - REPLICATION CLIENT\n - DROP\n - ALTER\n db_name: \"\"\n host: '%'\n tableColumnPrivileges: []\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdsmysql/dbAccount:DbAccount example \"instance_id|account_name|host\"\n```\n\n", "properties": { "accountDesc": { "type": "string", "description": "Account information description, maximum length 256 characters.\n" }, "accountName": { "type": "string", "description": "Database account name. Naming rules: Must be 2–32 characters long. Must start with a letter and end with a letter or number. Can contain letters, numbers, underscores (_), and hyphens (-). The account name must be unique within the instance. Certain reserved words cannot be used; for disabled reserved words, see the disabled word list. Note: The keywords root and admin can be used in high-privilege account names.\n" }, "accountPassword": { "type": "string", "description": "Database account password. Rules: Length must be 8–32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^\u0026*()_+-=,.\u0026?|/.\n" }, "accountPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DbAccountAccountPrivilege:DbAccountAccountPrivilege" } }, "accountPrivilegesSqls": { "type": "array", "items": { "type": "string" }, "description": "SQL statement for the account's specified database permission information.\n" }, "accountStatus": { "type": "string", "description": "Account status. Values: Unavailable: unavailable. Available: available.\n" }, "accountType": { "type": "string", "description": "Account type. Value options: Super: high-privilege account. Normal: regular account.\n" }, "hasTableColumnPrivilegeDbNames": { "type": "array", "items": { "type": "string" }, "description": "The database to which the account's table/column privileges belong. Note: If the account does not have table/column privileges, this field will not be returned.\n" }, "host": { "type": "string", "description": "IP address from which the specified database account can access the database.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "tableColumnPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DbAccountTableColumnPrivilege:DbAccountTableColumnPrivilege" } } }, "required": [ "accountDesc", "accountName", "accountPassword", "accountPrivileges", "accountPrivilegesSqls", "accountStatus", "accountType", "hasTableColumnPrivilegeDbNames", "host", "instanceId", "tableColumnPrivileges" ], "inputProperties": { "accountDesc": { "type": "string", "description": "Account information description, maximum length 256 characters.\n" }, "accountName": { "type": "string", "description": "Database account name. Naming rules: Must be 2–32 characters long. Must start with a letter and end with a letter or number. Can contain letters, numbers, underscores (_), and hyphens (-). The account name must be unique within the instance. Certain reserved words cannot be used; for disabled reserved words, see the disabled word list. Note: The keywords root and admin can be used in high-privilege account names.\n" }, "accountPassword": { "type": "string", "description": "Database account password. Rules: Length must be 8–32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^\u0026*()_+-=,.\u0026?|/.\n" }, "accountPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DbAccountAccountPrivilege:DbAccountAccountPrivilege" } }, "accountType": { "type": "string", "description": "Account type. Value options: Super: high-privilege account. Normal: regular account.\n" }, "host": { "type": "string", "description": "IP address from which the specified database account can access the database.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "tableColumnPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DbAccountTableColumnPrivilege:DbAccountTableColumnPrivilege" } } }, "requiredInputs": [ "accountName", "accountPassword", "accountType", "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering DbAccount resources.\n", "properties": { "accountDesc": { "type": "string", "description": "Account information description, maximum length 256 characters.\n" }, "accountName": { "type": "string", "description": "Database account name. Naming rules: Must be 2–32 characters long. Must start with a letter and end with a letter or number. Can contain letters, numbers, underscores (_), and hyphens (-). The account name must be unique within the instance. Certain reserved words cannot be used; for disabled reserved words, see the disabled word list. Note: The keywords root and admin can be used in high-privilege account names.\n" }, "accountPassword": { "type": "string", "description": "Database account password. Rules: Length must be 8–32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^\u0026*()_+-=,.\u0026?|/.\n" }, "accountPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DbAccountAccountPrivilege:DbAccountAccountPrivilege" } }, "accountPrivilegesSqls": { "type": "array", "items": { "type": "string" }, "description": "SQL statement for the account's specified database permission information.\n" }, "accountStatus": { "type": "string", "description": "Account status. Values: Unavailable: unavailable. Available: available.\n" }, "accountType": { "type": "string", "description": "Account type. Value options: Super: high-privilege account. Normal: regular account.\n" }, "hasTableColumnPrivilegeDbNames": { "type": "array", "items": { "type": "string" }, "description": "The database to which the account's table/column privileges belong. Note: If the account does not have table/column privileges, this field will not be returned.\n" }, "host": { "type": "string", "description": "IP address from which the specified database account can access the database.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "tableColumnPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/DbAccountTableColumnPrivilege:DbAccountTableColumnPrivilege" } } }, "type": "object" } }, "volcenginecc:rdsmysql/endpoint:Endpoint": { "description": "The endpoint is a network proxy service provided by Cloud Database MySQL Edition, located between the database and application. Based on endpoint functionality, endpoints are classified as proxy endpoints and direct endpoints. Connections via proxy endpoints pass through the proxy and support features such as read/write splitting, load balancing, idle connection recycling, and Multi-Statements. Connections via direct endpoints connect directly to the corresponding node and do not support proxy-related features.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rdsMysqlEndpointDemo:\n type: volcenginecc:rdsmysql:Endpoint\n name: RdsMysqlEndpointDemo\n properties:\n autoAddNewNodes: false\n connectionMode: Proxy\n connectionPoolType: Transaction\n description: this is a description\n enableConnectionPersistent: true\n endpointName: ccapi-test-1\n endpointType: Custom\n idleConnectionReclaim: true\n implicitTransSplit: true\n instanceId: mysql-2e229xxxxxd5\n masterNodeRouting: false\n masterProtectorTimeout: 60\n multiStatementsMode: Strict\n nodes: Primary,mysql-2e229xxxxxdd5-r442d,mysql-2e2xxxxxdd5-r8d0f\n overloadProtection: true\n readOnlyNodeDistributionType: RoundRobinCustom\n readOnlyNodeMaxDelayTime: 30\n readOnlyNodeWeights:\n - node_id: \"\"\n node_type: Primary\n weight: 100\n - node_id: mysql-2e2xxxxx4dd5-r442d\n node_type: ReadOnly\n weight: 200\n - node_id: mysql-2e22xxxxxdd5-r8d0f\n node_type: ReadOnly\n weight: 300\n readWriteMode: ReadWrite\n readWriteSpliting: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdsmysql/endpoint:Endpoint example \"instance_id|endpoint_id\"\n```\n\n", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/EndpointAddress:EndpointAddress" } }, "autoAddNewNodes": { "type": "boolean", "description": "When the endpoint type is read/write or read-only, you can set whether new nodes are automatically added. Values: true: automatically added. false: not automatically added (default).\n" }, "connectAllSlaveNodes": { "type": "boolean", "description": "Associate all replica nodes. Values: true: enabled (default). false: disabled. Note: Only read-only endpoints of multi-node instances support this configuration. This feature can be disabled only if the instance has two or more replica nodes.\n" }, "connectionInfoTags": { "type": "array", "items": { "type": "string" }, "description": "Connection endpoint tags.\n" }, "connectionMode": { "type": "string", "description": "Endpoint type. Options: Proxy: proxy endpoint. Direct: direct endpoint. Note: If the database proxy feature is enabled for the instance, you can select Proxy or Direct. If the database proxy feature is not enabled, only Direct is available. You can call the DescribeDBInstanceDetail API to check the status of the database proxy feature for the instance.\n" }, "connectionPoolType": { "type": "string", "description": "Connection pool type for proxy endpoints. Options: Transaction: transaction-level connection pool (default). Direct: direct mode. Note: Single-node instances do not support this feature.\n" }, "customRouteStrategy": { "$ref": "#/types/volcenginecc:rdsmysql/EndpointCustomRouteStrategy:EndpointCustomRouteStrategy", "description": "SQL forwarding rules for the connection endpoint.\n" }, "description": { "type": "string", "description": "Remarks.\n" }, "enableConnectionPersistent": { "type": "boolean", "description": "Enable connection keep-alive for the endpoint. Values: true: enabled. false: disabled. Note: Only proxy endpoints support this setting.\n" }, "enableReadOnly": { "type": "string", "description": "Enable global read-only. Values: Enable: enabled. Disable: not enabled.\n" }, "endpointId": { "type": "string", "description": "Instance connection endpoint ID.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Endpoint type. Value: Custom (custom endpoint).\n" }, "idleConnectionReclaim": { "type": "boolean", "description": "Enable idle connection recycling. true: enabled. false: not enabled. Note: This field is returned only for proxy endpoints.\n" }, "implicitTransSplit": { "type": "boolean", "description": "Enable transaction separation. Options: true: yes. false: no. Note: Only proxy endpoints return this field.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "masterNodeRouting": { "type": "boolean", "description": "Enable primary node routing. Values: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints.\n" }, "masterProtectorTimeout": { "type": "integer", "description": "Overload protection timeout. Value range: integer between 60~7200. Unit: seconds. Note: This field is returned only for proxy endpoints.\n" }, "multiStatementsMode": { "type": "string", "description": "Multi-Statements mode for proxy endpoints. Options: Strict: strict mode (default). Loose: loose mode.\n" }, "nodes": { "type": "string", "description": "List of node IDs configured for the connection endpoint. Required when EndpointType is Custom. Note: To add the primary node to the endpoint, do not enter the primary node ID; just enter Primary. Separate multiple node IDs with commas (,).\n" }, "overloadProtection": { "type": "boolean", "description": "Enable overload protection. Options: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints.\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, the value range is: LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, the value range is: Default: automatic allocation based on specification weight. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling.\n" }, "readOnlyNodeMaxDelayTime": { "type": "integer", "description": "Read-only node latency threshold. Value range: 1~3600. Default: 30. Unit: seconds.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/EndpointReadOnlyNodeWeight:EndpointReadOnlyNodeWeight" } }, "readWriteMode": { "type": "string", "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only.\n" }, "readWriteSpliting": { "type": "boolean", "description": "Enable read/write splitting. Values: true: enabled (default). false: disabled.\n" } }, "required": [ "addresses", "autoAddNewNodes", "connectAllSlaveNodes", "connectionInfoTags", "connectionMode", "connectionPoolType", "customRouteStrategy", "description", "enableConnectionPersistent", "enableReadOnly", "endpointId", "endpointName", "endpointType", "idleConnectionReclaim", "implicitTransSplit", "instanceId", "masterNodeRouting", "masterProtectorTimeout", "multiStatementsMode", "nodes", "overloadProtection", "readOnlyNodeDistributionType", "readOnlyNodeMaxDelayTime", "readOnlyNodeWeights", "readWriteMode", "readWriteSpliting" ], "inputProperties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/EndpointAddress:EndpointAddress" } }, "autoAddNewNodes": { "type": "boolean", "description": "When the endpoint type is read/write or read-only, you can set whether new nodes are automatically added. Values: true: automatically added. false: not automatically added (default).\n" }, "connectAllSlaveNodes": { "type": "boolean", "description": "Associate all replica nodes. Values: true: enabled (default). false: disabled. Note: Only read-only endpoints of multi-node instances support this configuration. This feature can be disabled only if the instance has two or more replica nodes.\n" }, "connectionMode": { "type": "string", "description": "Endpoint type. Options: Proxy: proxy endpoint. Direct: direct endpoint. Note: If the database proxy feature is enabled for the instance, you can select Proxy or Direct. If the database proxy feature is not enabled, only Direct is available. You can call the DescribeDBInstanceDetail API to check the status of the database proxy feature for the instance.\n" }, "connectionPoolType": { "type": "string", "description": "Connection pool type for proxy endpoints. Options: Transaction: transaction-level connection pool (default). Direct: direct mode. Note: Single-node instances do not support this feature.\n" }, "description": { "type": "string", "description": "Remarks.\n" }, "enableConnectionPersistent": { "type": "boolean", "description": "Enable connection keep-alive for the endpoint. Values: true: enabled. false: disabled. Note: Only proxy endpoints support this setting.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Endpoint type. Value: Custom (custom endpoint).\n" }, "idleConnectionReclaim": { "type": "boolean", "description": "Enable idle connection recycling. true: enabled. false: not enabled. Note: This field is returned only for proxy endpoints.\n" }, "implicitTransSplit": { "type": "boolean", "description": "Enable transaction separation. Options: true: yes. false: no. Note: Only proxy endpoints return this field.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "masterNodeRouting": { "type": "boolean", "description": "Enable primary node routing. Values: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints.\n" }, "masterProtectorTimeout": { "type": "integer", "description": "Overload protection timeout. Value range: integer between 60~7200. Unit: seconds. Note: This field is returned only for proxy endpoints.\n" }, "multiStatementsMode": { "type": "string", "description": "Multi-Statements mode for proxy endpoints. Options: Strict: strict mode (default). Loose: loose mode.\n" }, "nodes": { "type": "string", "description": "List of node IDs configured for the connection endpoint. Required when EndpointType is Custom. Note: To add the primary node to the endpoint, do not enter the primary node ID; just enter Primary. Separate multiple node IDs with commas (,).\n" }, "overloadProtection": { "type": "boolean", "description": "Enable overload protection. Options: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints.\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, the value range is: LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, the value range is: Default: automatic allocation based on specification weight. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling.\n" }, "readOnlyNodeMaxDelayTime": { "type": "integer", "description": "Read-only node latency threshold. Value range: 1~3600. Default: 30. Unit: seconds.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/EndpointReadOnlyNodeWeight:EndpointReadOnlyNodeWeight" } }, "readWriteMode": { "type": "string", "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only.\n" }, "readWriteSpliting": { "type": "boolean", "description": "Enable read/write splitting. Values: true: enabled (default). false: disabled.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Endpoint resources.\n", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/EndpointAddress:EndpointAddress" } }, "autoAddNewNodes": { "type": "boolean", "description": "When the endpoint type is read/write or read-only, you can set whether new nodes are automatically added. Values: true: automatically added. false: not automatically added (default).\n" }, "connectAllSlaveNodes": { "type": "boolean", "description": "Associate all replica nodes. Values: true: enabled (default). false: disabled. Note: Only read-only endpoints of multi-node instances support this configuration. This feature can be disabled only if the instance has two or more replica nodes.\n" }, "connectionInfoTags": { "type": "array", "items": { "type": "string" }, "description": "Connection endpoint tags.\n" }, "connectionMode": { "type": "string", "description": "Endpoint type. Options: Proxy: proxy endpoint. Direct: direct endpoint. Note: If the database proxy feature is enabled for the instance, you can select Proxy or Direct. If the database proxy feature is not enabled, only Direct is available. You can call the DescribeDBInstanceDetail API to check the status of the database proxy feature for the instance.\n" }, "connectionPoolType": { "type": "string", "description": "Connection pool type for proxy endpoints. Options: Transaction: transaction-level connection pool (default). Direct: direct mode. Note: Single-node instances do not support this feature.\n" }, "customRouteStrategy": { "$ref": "#/types/volcenginecc:rdsmysql/EndpointCustomRouteStrategy:EndpointCustomRouteStrategy", "description": "SQL forwarding rules for the connection endpoint.\n" }, "description": { "type": "string", "description": "Remarks.\n" }, "enableConnectionPersistent": { "type": "boolean", "description": "Enable connection keep-alive for the endpoint. Values: true: enabled. false: disabled. Note: Only proxy endpoints support this setting.\n" }, "enableReadOnly": { "type": "string", "description": "Enable global read-only. Values: Enable: enabled. Disable: not enabled.\n" }, "endpointId": { "type": "string", "description": "Instance connection endpoint ID.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Endpoint type. Value: Custom (custom endpoint).\n" }, "idleConnectionReclaim": { "type": "boolean", "description": "Enable idle connection recycling. true: enabled. false: not enabled. Note: This field is returned only for proxy endpoints.\n" }, "implicitTransSplit": { "type": "boolean", "description": "Enable transaction separation. Options: true: yes. false: no. Note: Only proxy endpoints return this field.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "masterNodeRouting": { "type": "boolean", "description": "Enable primary node routing. Values: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints.\n" }, "masterProtectorTimeout": { "type": "integer", "description": "Overload protection timeout. Value range: integer between 60~7200. Unit: seconds. Note: This field is returned only for proxy endpoints.\n" }, "multiStatementsMode": { "type": "string", "description": "Multi-Statements mode for proxy endpoints. Options: Strict: strict mode (default). Loose: loose mode.\n" }, "nodes": { "type": "string", "description": "List of node IDs configured for the connection endpoint. Required when EndpointType is Custom. Note: To add the primary node to the endpoint, do not enter the primary node ID; just enter Primary. Separate multiple node IDs with commas (,).\n" }, "overloadProtection": { "type": "boolean", "description": "Enable overload protection. Options: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints.\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, the value range is: LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, the value range is: Default: automatic allocation based on specification weight. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling.\n" }, "readOnlyNodeMaxDelayTime": { "type": "integer", "description": "Read-only node latency threshold. Value range: 1~3600. Default: 30. Unit: seconds.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/EndpointReadOnlyNodeWeight:EndpointReadOnlyNodeWeight" } }, "readWriteMode": { "type": "string", "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only.\n" }, "readWriteSpliting": { "type": "boolean", "description": "Enable read/write splitting. Values: true: enabled (default). false: disabled.\n" } }, "type": "object" } }, "volcenginecc:rdsmysql/instance:Instance": { "description": "Volcano Engine Cloud Database MySQL Edition is an elastic and reliable online relational database service built on the open-source MySQL database. MySQL instances are deployed using cloud-native methods and local SSD storage, delivering high-performance read and write capabilities. The service is fully compatible with the MySQL engine and offers a complete suite of solutions, including instance management, backup and recovery, log management, monitoring and alerts, and data migration. This helps enterprises simplify complex database management and operations, allowing them to focus more time and resources on their core business.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rDSMySQLInstanceDemo:\n type: volcenginecc:rdsmysql:Instance\n name: RDSMySQLInstanceDemo\n properties:\n deletionProtection: Disabled\n dbEngineVersion: MySQL_5_7\n nodes:\n - zone_id: cn-beijing-a\n node_spec: rds.mysql.c.s.1c2g\n node_type: Primary\n - zone_id: cn-beijing-a\n node_spec: rds.mysql.c.s.1c2g\n node_type: Secondary\n - zone_id: cn-beijing-a\n node_spec: rds.mysql.c.s.1c2g\n node_type: ReadOnly\n storageType: CloudESSD_PL0\n storageSpace: 100\n instanceType: DoubleNode\n vpcId: vpc-rrco37ovjq4gv0x58xxxxx\n subnetId: subnet-rrwqhg3qzxfkv0x57xxxxx\n instanceName: RDSMySQLInstanceDemo\n superAccountName: test_account\n superAccountPassword: '***********'\n lowerCaseTableNames: '1'\n dbTimeZone: UTC +08:00\n chargeDetail:\n charge_type: PostPaid\n auto_renew: false\n number: 1\n allowListIds:\n - acl-8cde5e16f44143788234ca4489xxxxx\n - acl-31f6053bd6be4cff88c1b205d20xxxxx\n port: 3306\n maintenanceWindow:\n day_kind: Week\n day_of_week:\n - Monday\n maintenance_time: 18:00Z-21:59Z\n autoStorageScalingConfig:\n enable_storage_auto_scale: true\n storage_threshold: 10\n storage_upper_bound: 3000\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdsmysql/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "addressObjects": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceAddressObject:InstanceAddressObject" } }, "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists\n" }, "allowListVersion": { "type": "string", "description": "Allowlist version\n" }, "autoStorageScalingConfig": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceAutoStorageScalingConfig:InstanceAutoStorageScalingConfig", "description": "Auto scaling configuration\n" }, "autoUpgradeMinorVersion": { "type": "string", "description": "Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.\n" }, "backupAuditLogSize": { "type": "integer", "description": "Space used by audit logs in backup.\n" }, "backupBinLogSize": { "type": "integer", "description": "Space used by binlog logs in backup.\n" }, "backupDataSize": { "type": "integer", "description": "Space used by data in backup.\n" }, "backupErrorLogSize": { "type": "integer", "description": "Space used by error logs in backups.\n" }, "backupFreeQuotaSize": { "type": "integer", "description": "Free backup storage space, in GB\n" }, "backupLogSize": { "type": "integer", "description": "Space used by logs in backups.\n" }, "backupSlowLogSize": { "type": "integer", "description": "Space used by slow logs in backups.\n" }, "backupUse": { "type": "number", "description": "Backup space used by the instance, in GB\n" }, "basicBackupBinlogSize": { "type": "integer", "description": "Space used by Binlog logs in basic backups.\n" }, "basicBackupDataSize": { "type": "integer", "description": "Space used by data in the base backup\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceChargeDetail:InstanceChargeDetail", "description": "Billing method\n" }, "cpuNum": { "type": "integer", "description": "Number of CPU cores for the database proxy service of the instance\n" }, "createdTime": { "type": "string", "description": "Instance creation local time.\n" }, "currentKernelVersion": { "type": "string", "description": "Instance kernel minor version.\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible versions. Values: MySQL*5*7: MySQL 5.7 version. MySQL*8*0: MySQL 8.0 version\n" }, "dbParamGroupId": { "type": "string", "description": "Parameter template ID. Default value is the default parameter template for the database engine version\n" }, "dbTimeZone": { "type": "string", "description": "Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.\n" }, "deletionProtection": { "type": "string", "description": "Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.\n" }, "disasterRecoveryInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceDisasterRecoveryInstance:InstanceDisasterRecoveryInstance" } }, "drDtsTaskId": { "type": "string", "description": "ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.\n" }, "drDtsTaskName": { "type": "string", "description": "Name of synchronization tasks between primary and disaster recovery instances.\n" }, "drDtsTaskStatus": { "type": "string", "description": "Status of synchronization tasks between primary and disaster recovery instances.\n" }, "drSecondsBehindMaster": { "type": "integer", "description": "Latency between the disaster recovery instance and the primary instance.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceEndpoint:InstanceEndpoint" } }, "globalReadOnly": { "type": "boolean", "description": "Enable global read-only mode. Values: true: enabled. false: disabled (default is false)\n" }, "hasDisasterRecoveryInstances": { "type": "boolean", "description": "Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.\n" }, "hasGreenInstance": { "type": "boolean", "description": "Is the instance in blue-green deployment? Values: true: yes. false: no.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "instanceType": { "type": "string", "description": "Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type\n" }, "lowerCaseTableNames": { "type": "string", "description": "Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.\n" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceMaintenanceWindow:InstanceMaintenanceWindow", "description": "Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).\n" }, "masterInstanceId": { "type": "string", "description": "Primary instance ID\n" }, "masterInstanceName": { "type": "string", "description": "Primary instance name.\n" }, "memory": { "type": "integer", "description": "Memory size. Unit: GB.\n" }, "nodeCpuUsedPercentage": { "type": "number", "description": "Average CPU usage of the primary node in the instance over the past minute.\n" }, "nodeMemoryUsedPercentage": { "type": "number", "description": "Average memory usage of the primary node over the past minute\n" }, "nodeNumber": { "type": "string", "description": "Number of nodes.\n" }, "nodeSpaceUsedPercentage": { "type": "number", "description": "Average disk usage of the primary node over the past minute\n" }, "nodeSpec": { "type": "string", "description": "Node specifications.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceNode:InstanceNode" } }, "port": { "type": "integer", "description": "Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.\n" }, "projectName": { "type": "string", "description": "Project.\n" }, "proxyDetail": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceProxyDetail:InstanceProxyDetail", "description": "proxy information\n" }, "storageAuditLogSize": { "type": "integer", "description": "Space used by audit logs in instance storage\n" }, "storageBinLogSize": { "type": "integer", "description": "Binlog space usage in the instance storage\n" }, "storageDataSize": { "type": "integer", "description": "Space used by data in instance storage.\n" }, "storageErrorLogSize": { "type": "integer", "description": "Space used by error logs in instance storage.\n" }, "storageLogSize": { "type": "integer", "description": "Space used by logs in the instance storage\n" }, "storageSlowLogSize": { "type": "integer", "description": "Space used by slow logs in instance storage\n" }, "storageSpace": { "type": "integer", "description": "Total storage space of the instance, in GB\n" }, "storageType": { "type": "string", "description": "Instance storage type. Value range: LocalSSD: local disk. CloudESSD*FlexPL: FlexPL cloud disk. CloudESSD*PL0: PL0 cloud disk.\n" }, "storageUse": { "type": "number", "description": "Storage space used by the instance, in GB\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "superAccountName": { "type": "string", "description": "High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.\n" }, "superAccountPassword": { "type": "string", "description": "Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^\u0026*()_+-=,.\u0026?|/.\n" }, "syncMode": { "type": "string", "description": "Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceTag:InstanceTag" } }, "timeZone": { "type": "string", "description": "Time zone\n" }, "updatedTime": { "type": "string", "description": "Instance updates local time.\n" }, "vcpu": { "type": "integer", "description": "CPU size. For example: 1 means 1U.\n" }, "vpcId": { "type": "string", "description": "VPC (Virtual Private Cloud) ID.\n" }, "zoneId": { "type": "string", "description": "Availability zone of the instance's primary node.\n" }, "zoneIds": { "type": "array", "items": { "type": "string" }, "description": "List of availability zones for each node in the instance.\n" } }, "required": [ "addressObjects", "allowListIds", "allowListVersion", "autoStorageScalingConfig", "autoUpgradeMinorVersion", "backupAuditLogSize", "backupBinLogSize", "backupDataSize", "backupErrorLogSize", "backupFreeQuotaSize", "backupLogSize", "backupSlowLogSize", "backupUse", "basicBackupBinlogSize", "basicBackupDataSize", "chargeDetail", "cpuNum", "createdTime", "currentKernelVersion", "dbEngineVersion", "dbParamGroupId", "dbTimeZone", "deletionProtection", "disasterRecoveryInstances", "drDtsTaskId", "drDtsTaskName", "drDtsTaskStatus", "drSecondsBehindMaster", "endpoints", "globalReadOnly", "hasDisasterRecoveryInstances", "hasGreenInstance", "instanceId", "instanceName", "instanceStatus", "instanceType", "lowerCaseTableNames", "maintenanceWindow", "masterInstanceId", "masterInstanceName", "memory", "nodeCpuUsedPercentage", "nodeMemoryUsedPercentage", "nodeNumber", "nodeSpaceUsedPercentage", "nodeSpec", "nodes", "port", "projectName", "proxyDetail", "storageAuditLogSize", "storageBinLogSize", "storageDataSize", "storageErrorLogSize", "storageLogSize", "storageSlowLogSize", "storageSpace", "storageType", "storageUse", "subnetId", "superAccountName", "superAccountPassword", "syncMode", "tags", "timeZone", "updatedTime", "vcpu", "vpcId", "zoneId", "zoneIds" ], "inputProperties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists\n" }, "autoStorageScalingConfig": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceAutoStorageScalingConfig:InstanceAutoStorageScalingConfig", "description": "Auto scaling configuration\n" }, "autoUpgradeMinorVersion": { "type": "string", "description": "Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceChargeDetail:InstanceChargeDetail", "description": "Billing method\n" }, "cpuNum": { "type": "integer", "description": "Number of CPU cores for the database proxy service of the instance\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible versions. Values: MySQL*5*7: MySQL 5.7 version. MySQL*8*0: MySQL 8.0 version\n" }, "dbParamGroupId": { "type": "string", "description": "Parameter template ID. Default value is the default parameter template for the database engine version\n" }, "dbTimeZone": { "type": "string", "description": "Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.\n" }, "deletionProtection": { "type": "string", "description": "Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.\n" }, "globalReadOnly": { "type": "boolean", "description": "Enable global read-only mode. Values: true: enabled. false: disabled (default is false)\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "instanceType": { "type": "string", "description": "Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type\n" }, "lowerCaseTableNames": { "type": "string", "description": "Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.\n" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceMaintenanceWindow:InstanceMaintenanceWindow", "description": "Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).\n" }, "nodeSpec": { "type": "string", "description": "Node specifications.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceNode:InstanceNode" } }, "port": { "type": "integer", "description": "Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.\n" }, "projectName": { "type": "string", "description": "Project.\n" }, "storageSpace": { "type": "integer", "description": "Total storage space of the instance, in GB\n" }, "storageType": { "type": "string", "description": "Instance storage type. Value range: LocalSSD: local disk. CloudESSD*FlexPL: FlexPL cloud disk. CloudESSD*PL0: PL0 cloud disk.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "superAccountName": { "type": "string", "description": "High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.\n" }, "superAccountPassword": { "type": "string", "description": "Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^\u0026*()_+-=,.\u0026?|/.\n" }, "syncMode": { "type": "string", "description": "Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceTag:InstanceTag" } }, "vpcId": { "type": "string", "description": "VPC (Virtual Private Cloud) ID.\n" } }, "requiredInputs": [ "chargeDetail", "dbEngineVersion", "nodes", "storageSpace", "storageType", "subnetId", "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "addressObjects": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceAddressObject:InstanceAddressObject" } }, "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists\n" }, "allowListVersion": { "type": "string", "description": "Allowlist version\n" }, "autoStorageScalingConfig": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceAutoStorageScalingConfig:InstanceAutoStorageScalingConfig", "description": "Auto scaling configuration\n" }, "autoUpgradeMinorVersion": { "type": "string", "description": "Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.\n" }, "backupAuditLogSize": { "type": "integer", "description": "Space used by audit logs in backup.\n" }, "backupBinLogSize": { "type": "integer", "description": "Space used by binlog logs in backup.\n" }, "backupDataSize": { "type": "integer", "description": "Space used by data in backup.\n" }, "backupErrorLogSize": { "type": "integer", "description": "Space used by error logs in backups.\n" }, "backupFreeQuotaSize": { "type": "integer", "description": "Free backup storage space, in GB\n" }, "backupLogSize": { "type": "integer", "description": "Space used by logs in backups.\n" }, "backupSlowLogSize": { "type": "integer", "description": "Space used by slow logs in backups.\n" }, "backupUse": { "type": "number", "description": "Backup space used by the instance, in GB\n" }, "basicBackupBinlogSize": { "type": "integer", "description": "Space used by Binlog logs in basic backups.\n" }, "basicBackupDataSize": { "type": "integer", "description": "Space used by data in the base backup\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceChargeDetail:InstanceChargeDetail", "description": "Billing method\n" }, "cpuNum": { "type": "integer", "description": "Number of CPU cores for the database proxy service of the instance\n" }, "createdTime": { "type": "string", "description": "Instance creation local time.\n" }, "currentKernelVersion": { "type": "string", "description": "Instance kernel minor version.\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible versions. Values: MySQL*5*7: MySQL 5.7 version. MySQL*8*0: MySQL 8.0 version\n" }, "dbParamGroupId": { "type": "string", "description": "Parameter template ID. Default value is the default parameter template for the database engine version\n" }, "dbTimeZone": { "type": "string", "description": "Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.\n" }, "deletionProtection": { "type": "string", "description": "Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.\n" }, "disasterRecoveryInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceDisasterRecoveryInstance:InstanceDisasterRecoveryInstance" } }, "drDtsTaskId": { "type": "string", "description": "ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.\n" }, "drDtsTaskName": { "type": "string", "description": "Name of synchronization tasks between primary and disaster recovery instances.\n" }, "drDtsTaskStatus": { "type": "string", "description": "Status of synchronization tasks between primary and disaster recovery instances.\n" }, "drSecondsBehindMaster": { "type": "integer", "description": "Latency between the disaster recovery instance and the primary instance.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceEndpoint:InstanceEndpoint" } }, "globalReadOnly": { "type": "boolean", "description": "Enable global read-only mode. Values: true: enabled. false: disabled (default is false)\n" }, "hasDisasterRecoveryInstances": { "type": "boolean", "description": "Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.\n" }, "hasGreenInstance": { "type": "boolean", "description": "Is the instance in blue-green deployment? Values: true: yes. false: no.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "instanceType": { "type": "string", "description": "Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type\n" }, "lowerCaseTableNames": { "type": "string", "description": "Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.\n" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceMaintenanceWindow:InstanceMaintenanceWindow", "description": "Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).\n" }, "masterInstanceId": { "type": "string", "description": "Primary instance ID\n" }, "masterInstanceName": { "type": "string", "description": "Primary instance name.\n" }, "memory": { "type": "integer", "description": "Memory size. Unit: GB.\n" }, "nodeCpuUsedPercentage": { "type": "number", "description": "Average CPU usage of the primary node in the instance over the past minute.\n" }, "nodeMemoryUsedPercentage": { "type": "number", "description": "Average memory usage of the primary node over the past minute\n" }, "nodeNumber": { "type": "string", "description": "Number of nodes.\n" }, "nodeSpaceUsedPercentage": { "type": "number", "description": "Average disk usage of the primary node over the past minute\n" }, "nodeSpec": { "type": "string", "description": "Node specifications.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceNode:InstanceNode" } }, "port": { "type": "integer", "description": "Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.\n" }, "projectName": { "type": "string", "description": "Project.\n" }, "proxyDetail": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceProxyDetail:InstanceProxyDetail", "description": "proxy information\n" }, "storageAuditLogSize": { "type": "integer", "description": "Space used by audit logs in instance storage\n" }, "storageBinLogSize": { "type": "integer", "description": "Binlog space usage in the instance storage\n" }, "storageDataSize": { "type": "integer", "description": "Space used by data in instance storage.\n" }, "storageErrorLogSize": { "type": "integer", "description": "Space used by error logs in instance storage.\n" }, "storageLogSize": { "type": "integer", "description": "Space used by logs in the instance storage\n" }, "storageSlowLogSize": { "type": "integer", "description": "Space used by slow logs in instance storage\n" }, "storageSpace": { "type": "integer", "description": "Total storage space of the instance, in GB\n" }, "storageType": { "type": "string", "description": "Instance storage type. Value range: LocalSSD: local disk. CloudESSD*FlexPL: FlexPL cloud disk. CloudESSD*PL0: PL0 cloud disk.\n" }, "storageUse": { "type": "number", "description": "Storage space used by the instance, in GB\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "superAccountName": { "type": "string", "description": "High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.\n" }, "superAccountPassword": { "type": "string", "description": "Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^\u0026*()_+-=,.\u0026?|/.\n" }, "syncMode": { "type": "string", "description": "Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdsmysql/InstanceTag:InstanceTag" } }, "timeZone": { "type": "string", "description": "Time zone\n" }, "updatedTime": { "type": "string", "description": "Instance updates local time.\n" }, "vcpu": { "type": "integer", "description": "CPU size. For example: 1 means 1U.\n" }, "vpcId": { "type": "string", "description": "VPC (Virtual Private Cloud) ID.\n" }, "zoneId": { "type": "string", "description": "Availability zone of the instance's primary node.\n" }, "zoneIds": { "type": "array", "items": { "type": "string" }, "description": "List of availability zones for each node in the instance.\n" } }, "type": "object" } }, "volcenginecc:rdspostgresql/allowList:AllowList": { "description": "An allowlist is a security measure for database connections. Only IP addresses in the allowlist can access the database. After a PostgreSQL instance is created, it is not bound to any allowlist, and all IP addresses are denied access by default. To connect to the instance via private or public network, you must first configure an allowlist for the instance to ensure connectivity.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst rdsPostgresqlAllowListDemo = new volcenginecc.rdspostgresql.AllowList(\"RdsPostgresqlAllowListDemo\", {\n allowLists: [\n \"1.2.3.4/32\",\n \"5.6.7.8/32\",\n ],\n allowListCategory: \"Ordinary\",\n allowListDesc: \"test\",\n allowListName: \"ccapi-test-1\",\n allowListType: \"IPv4\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nrds_postgresql_allow_list_demo = volcenginecc.rdspostgresql.AllowList(\"RdsPostgresqlAllowListDemo\",\n allow_lists=[\n \"1.2.3.4/32\",\n \"5.6.7.8/32\",\n ],\n allow_list_category=\"Ordinary\",\n allow_list_desc=\"test\",\n allow_list_name=\"ccapi-test-1\",\n allow_list_type=\"IPv4\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var rdsPostgresqlAllowListDemo = new Volcenginecc.Rdspostgresql.AllowList(\"RdsPostgresqlAllowListDemo\", new()\n {\n AllowListValue = new[]\n {\n \"1.2.3.4/32\",\n \"5.6.7.8/32\",\n },\n AllowListCategory = \"Ordinary\",\n AllowListDesc = \"test\",\n AllowListName = \"ccapi-test-1\",\n AllowListType = \"IPv4\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rdspostgresql\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := rdspostgresql.NewAllowList(ctx, \"RdsPostgresqlAllowListDemo\", \u0026rdspostgresql.AllowListArgs{\n\t\t\tAllowLists: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"1.2.3.4/32\"),\n\t\t\t\tpulumi.String(\"5.6.7.8/32\"),\n\t\t\t},\n\t\t\tAllowListCategory: pulumi.String(\"Ordinary\"),\n\t\t\tAllowListDesc: pulumi.String(\"test\"),\n\t\t\tAllowListName: pulumi.String(\"ccapi-test-1\"),\n\t\t\tAllowListType: pulumi.String(\"IPv4\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.rdspostgresql.AllowList;\nimport com.volcengine.volcenginecc.rdspostgresql.AllowListArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var rdsPostgresqlAllowListDemo = new AllowList(\"rdsPostgresqlAllowListDemo\", AllowListArgs.builder()\n .allowLists( \n \"1.2.3.4/32\",\n \"5.6.7.8/32\")\n .allowListCategory(\"Ordinary\")\n .allowListDesc(\"test\")\n .allowListName(\"ccapi-test-1\")\n .allowListType(\"IPv4\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n rdsPostgresqlAllowListDemo:\n type: volcenginecc:rdspostgresql:AllowList\n name: RdsPostgresqlAllowListDemo\n properties:\n allowLists:\n - 1.2.3.4/32\n - 5.6.7.8/32\n allowListCategory: Ordinary\n allowListDesc: test\n allowListName: ccapi-test-1\n allowListType: IPv4\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdspostgresql/allowList:AllowList example \"allow_list_id\"\n```\n\n", "properties": { "allowListCategory": { "type": "string", "description": "Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.\n" }, "allowListDesc": { "type": "string", "description": "Description of the allowlist. Up to 200 characters. Default value is an empty string.\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Number of IP addresses or IP segments in the allowlist.\n" }, "allowListName": { "type": "string", "description": "Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (*). It can only contain Chinese characters, letters, numbers, underscores (*), and hyphens (-). Length must be 1–128 characters.\n" }, "allowListType": { "type": "string", "description": "Network protocol type used by the allowlist. Value: IPv4 (default).\n" }, "allowLists": { "type": "array", "items": { "type": "string" }, "description": "IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "associatedInstanceNum": { "type": "integer", "description": "Number of instances bound to this allowlist.\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "ipAddress": { "type": "string", "description": "Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.\n" }, "modifyMode": { "type": "string", "description": "Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.\n" }, "securityGroupBindInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo" } }, "updateSecurityGroup": { "type": "boolean", "description": "Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.\n" }, "userAllowList": { "type": "string", "description": "IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.\n" } }, "required": [ "allowLists", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "ipAddress", "modifyMode", "securityGroupBindInfos", "updateSecurityGroup", "userAllowList" ], "inputProperties": { "allowListCategory": { "type": "string", "description": "Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.\n" }, "allowListDesc": { "type": "string", "description": "Description of the allowlist. Up to 200 characters. Default value is an empty string.\n" }, "allowListName": { "type": "string", "description": "Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (*). It can only contain Chinese characters, letters, numbers, underscores (*), and hyphens (-). Length must be 1–128 characters.\n" }, "allowListType": { "type": "string", "description": "Network protocol type used by the allowlist. Value: IPv4 (default).\n" }, "allowLists": { "type": "array", "items": { "type": "string" }, "description": "IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "associatedInstanceNum": { "type": "integer", "description": "Number of instances bound to this allowlist.\n" }, "ipAddress": { "type": "string", "description": "Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.\n" }, "modifyMode": { "type": "string", "description": "Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.\n" }, "securityGroupBindInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo" } }, "updateSecurityGroup": { "type": "boolean", "description": "Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.\n" }, "userAllowList": { "type": "string", "description": "IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering AllowList resources.\n", "properties": { "allowListCategory": { "type": "string", "description": "Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.\n" }, "allowListDesc": { "type": "string", "description": "Description of the allowlist. Up to 200 characters. Default value is an empty string.\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Number of IP addresses or IP segments in the allowlist.\n" }, "allowListName": { "type": "string", "description": "Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (*). It can only contain Chinese characters, letters, numbers, underscores (*), and hyphens (-). Length must be 1–128 characters.\n" }, "allowListType": { "type": "string", "description": "Network protocol type used by the allowlist. Value: IPv4 (default).\n" }, "allowLists": { "type": "array", "items": { "type": "string" }, "description": "IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "associatedInstanceNum": { "type": "integer", "description": "Number of instances bound to this allowlist.\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "ipAddress": { "type": "string", "description": "Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.\n" }, "modifyMode": { "type": "string", "description": "Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.\n" }, "securityGroupBindInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo" } }, "updateSecurityGroup": { "type": "boolean", "description": "Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.\n" }, "userAllowList": { "type": "string", "description": "IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.\n" } }, "type": "object" } }, "volcenginecc:rdspostgresql/database:Database": { "description": "The database is an independent database within a PostgreSQL instance, used to store and manage data.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst rDSPostgreSQLDatabaseDemo = new volcenginecc.rdspostgresql.Database(\"RDSPostgreSQLDatabaseDemo\", {\n instanceId: \"postgres-8d1fcxxxxxx\",\n dbName: \"ccapi-terraform-1001\",\n characterSetName: \"utf8\",\n owner: \"test-1\",\n collate: \"C\",\n cType: \"C.UTF-8\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nr_ds_postgre_sql_database_demo = volcenginecc.rdspostgresql.Database(\"RDSPostgreSQLDatabaseDemo\",\n instance_id=\"postgres-8d1fcxxxxxx\",\n db_name=\"ccapi-terraform-1001\",\n character_set_name=\"utf8\",\n owner=\"test-1\",\n collate=\"C\",\n c_type=\"C.UTF-8\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var rDSPostgreSQLDatabaseDemo = new Volcenginecc.Rdspostgresql.Database(\"RDSPostgreSQLDatabaseDemo\", new()\n {\n InstanceId = \"postgres-8d1fcxxxxxx\",\n DbName = \"ccapi-terraform-1001\",\n CharacterSetName = \"utf8\",\n Owner = \"test-1\",\n Collate = \"C\",\n CType = \"C.UTF-8\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rdspostgresql\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := rdspostgresql.NewDatabase(ctx, \"RDSPostgreSQLDatabaseDemo\", \u0026rdspostgresql.DatabaseArgs{\n\t\t\tInstanceId: pulumi.String(\"postgres-8d1fcxxxxxx\"),\n\t\t\tDbName: pulumi.String(\"ccapi-terraform-1001\"),\n\t\t\tCharacterSetName: pulumi.String(\"utf8\"),\n\t\t\tOwner: pulumi.String(\"test-1\"),\n\t\t\tCollate: pulumi.String(\"C\"),\n\t\t\tCType: pulumi.String(\"C.UTF-8\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.rdspostgresql.Database;\nimport com.volcengine.volcenginecc.rdspostgresql.DatabaseArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var rDSPostgreSQLDatabaseDemo = new Database(\"rDSPostgreSQLDatabaseDemo\", DatabaseArgs.builder()\n .instanceId(\"postgres-8d1fcxxxxxx\")\n .dbName(\"ccapi-terraform-1001\")\n .characterSetName(\"utf8\")\n .owner(\"test-1\")\n .collate(\"C\")\n .cType(\"C.UTF-8\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n rDSPostgreSQLDatabaseDemo:\n type: volcenginecc:rdspostgresql:Database\n name: RDSPostgreSQLDatabaseDemo\n properties:\n instanceId: postgres-8d1fcxxxxxx\n dbName: ccapi-terraform-1001\n characterSetName: utf8\n owner: test-1\n collate: C\n cType: C.UTF-8\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdspostgresql/database:Database example \"instance_id|db_name\"\n```\n\n", "properties": { "cType": { "type": "string", "description": "Character classification. Supported values: C (default), C.UTF-8, en*US.utf8, zh*CN.utf8, and POSIX\n" }, "characterSetName": { "type": "string", "description": "Database character set. Supported character sets: utf8 (default), latin1, ascii\n" }, "collate": { "type": "string", "description": "Collation. Supported values: C (default), C.UTF-8, en*US.utf8, zh*CN.utf8, and POSIX\n" }, "dbName": { "type": "string", "description": "Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.\n" }, "dbStatus": { "type": "string", "description": "Database status: Unavailable: Not available. Available: Available.\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "owner": { "type": "string", "description": "Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser\n" } }, "required": [ "cType", "characterSetName", "collate", "dbName", "dbStatus", "instanceId", "owner" ], "inputProperties": { "cType": { "type": "string", "description": "Character classification. Supported values: C (default), C.UTF-8, en*US.utf8, zh*CN.utf8, and POSIX\n" }, "characterSetName": { "type": "string", "description": "Database character set. Supported character sets: utf8 (default), latin1, ascii\n" }, "collate": { "type": "string", "description": "Collation. Supported values: C (default), C.UTF-8, en*US.utf8, zh*CN.utf8, and POSIX\n" }, "dbName": { "type": "string", "description": "Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "owner": { "type": "string", "description": "Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser\n" } }, "requiredInputs": [ "dbName", "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Database resources.\n", "properties": { "cType": { "type": "string", "description": "Character classification. Supported values: C (default), C.UTF-8, en*US.utf8, zh*CN.utf8, and POSIX\n" }, "characterSetName": { "type": "string", "description": "Database character set. Supported character sets: utf8 (default), latin1, ascii\n" }, "collate": { "type": "string", "description": "Collation. Supported values: C (default), C.UTF-8, en*US.utf8, zh*CN.utf8, and POSIX\n" }, "dbName": { "type": "string", "description": "Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.\n" }, "dbStatus": { "type": "string", "description": "Database status: Unavailable: Not available. Available: Available.\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "owner": { "type": "string", "description": "Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser\n" } }, "type": "object" } }, "volcenginecc:rdspostgresql/dbAccount:DbAccount": { "description": "RDS PostgreSQL Database Account\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst rDSPostgreSQLDBAccountNormalDemo = new volcenginecc.rdspostgresql.DbAccount(\"RDSPostgreSQLDBAccountNormalDemo\", {\n instanceId: \"postgres-xxxxxxx\",\n accountName: \"ccapi-test-Normal\",\n accountPassword: \"**********\",\n accountType: \"Normal\",\n accountPrivileges: \"Inherit,Login,CreateRole,CreateDB\",\n notAllowPrivileges: [\"DDL\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nr_ds_postgre_sqldb_account_normal_demo = volcenginecc.rdspostgresql.DbAccount(\"RDSPostgreSQLDBAccountNormalDemo\",\n instance_id=\"postgres-xxxxxxx\",\n account_name=\"ccapi-test-Normal\",\n account_password=\"**********\",\n account_type=\"Normal\",\n account_privileges=\"Inherit,Login,CreateRole,CreateDB\",\n not_allow_privileges=[\"DDL\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var rDSPostgreSQLDBAccountNormalDemo = new Volcenginecc.Rdspostgresql.DbAccount(\"RDSPostgreSQLDBAccountNormalDemo\", new()\n {\n InstanceId = \"postgres-xxxxxxx\",\n AccountName = \"ccapi-test-Normal\",\n AccountPassword = \"**********\",\n AccountType = \"Normal\",\n AccountPrivileges = \"Inherit,Login,CreateRole,CreateDB\",\n NotAllowPrivileges = new[]\n {\n \"DDL\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rdspostgresql\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := rdspostgresql.NewDbAccount(ctx, \"RDSPostgreSQLDBAccountNormalDemo\", \u0026rdspostgresql.DbAccountArgs{\n\t\t\tInstanceId: pulumi.String(\"postgres-xxxxxxx\"),\n\t\t\tAccountName: pulumi.String(\"ccapi-test-Normal\"),\n\t\t\tAccountPassword: pulumi.String(\"**********\"),\n\t\t\tAccountType: pulumi.String(\"Normal\"),\n\t\t\tAccountPrivileges: pulumi.String(\"Inherit,Login,CreateRole,CreateDB\"),\n\t\t\tNotAllowPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"DDL\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.rdspostgresql.DbAccount;\nimport com.volcengine.volcenginecc.rdspostgresql.DbAccountArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var rDSPostgreSQLDBAccountNormalDemo = new DbAccount(\"rDSPostgreSQLDBAccountNormalDemo\", DbAccountArgs.builder()\n .instanceId(\"postgres-xxxxxxx\")\n .accountName(\"ccapi-test-Normal\")\n .accountPassword(\"**********\")\n .accountType(\"Normal\")\n .accountPrivileges(\"Inherit,Login,CreateRole,CreateDB\")\n .notAllowPrivileges(\"DDL\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n rDSPostgreSQLDBAccountNormalDemo:\n type: volcenginecc:rdspostgresql:DbAccount\n name: RDSPostgreSQLDBAccountNormalDemo\n properties:\n instanceId: postgres-xxxxxxx\n accountName: ccapi-test-Normal\n accountPassword: '**********'\n accountType: Normal\n accountPrivileges: Inherit,Login,CreateRole,CreateDB\n notAllowPrivileges:\n - DDL\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdspostgresql/dbAccount:DbAccount example \"instance_id|account_name\"\n```\n\n", "properties": { "accountName": { "type": "string", "description": "Database account name. The account name rules are as follows: Length must be 2–63 characters. Can contain letters, numbers, underscores (*), or hyphens (-). Must start with a letter and end with a letter or number. Cannot start with pg*. Reserved keywords cannot be used. For all disabled keywords, see Disabled Keywords.\n" }, "accountPassword": { "type": "string", "description": "Database account password. The password rules are as follows: Length must be 8–32 characters. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters. Supported special characters: !@#$%^*()\u0026_+-=.\n" }, "accountPrivileges": { "type": "string", "description": "Account permission information. Separate multiple permissions with commas (,). Valid values: Login: Login permission. Inherit: Inherit permission. CreateRole: Create role permission. CreateDB: Create database permission. Note: If the account type is high privilege, you do not need to provide this parameter; all permissions are supported by default. If the account type is normal, you can provide this parameter; the default values are Login and Inherit. If the account type is instance read-only, that is, AccountType is set to InstanceReadOnly, this parameter is not supported.\n" }, "accountType": { "type": "string", "description": "Database account type. Valid values: Super: High privilege account. Normal: Normal account. InstanceReadOnly: Instance read-only account.\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "notAllowPrivileges": { "type": "array", "items": { "type": "string" }, "description": "Permissions disabled for the account. Currently, only DDL is supported. Note: This field can only be provided for high privilege or normal accounts, that is, when AccountType is set to Super or Normal.\n" } }, "required": [ "accountName", "accountPassword", "accountPrivileges", "accountType", "instanceId", "notAllowPrivileges" ], "inputProperties": { "accountName": { "type": "string", "description": "Database account name. The account name rules are as follows: Length must be 2–63 characters. Can contain letters, numbers, underscores (*), or hyphens (-). Must start with a letter and end with a letter or number. Cannot start with pg*. Reserved keywords cannot be used. For all disabled keywords, see Disabled Keywords.\n" }, "accountPassword": { "type": "string", "description": "Database account password. The password rules are as follows: Length must be 8–32 characters. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters. Supported special characters: !@#$%^*()\u0026_+-=.\n" }, "accountPrivileges": { "type": "string", "description": "Account permission information. Separate multiple permissions with commas (,). Valid values: Login: Login permission. Inherit: Inherit permission. CreateRole: Create role permission. CreateDB: Create database permission. Note: If the account type is high privilege, you do not need to provide this parameter; all permissions are supported by default. If the account type is normal, you can provide this parameter; the default values are Login and Inherit. If the account type is instance read-only, that is, AccountType is set to InstanceReadOnly, this parameter is not supported.\n" }, "accountType": { "type": "string", "description": "Database account type. Valid values: Super: High privilege account. Normal: Normal account. InstanceReadOnly: Instance read-only account.\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "notAllowPrivileges": { "type": "array", "items": { "type": "string" }, "description": "Permissions disabled for the account. Currently, only DDL is supported. Note: This field can only be provided for high privilege or normal accounts, that is, when AccountType is set to Super or Normal.\n" } }, "requiredInputs": [ "accountName", "accountPassword", "accountType" ], "stateInputs": { "description": "Input properties used for looking up and filtering DbAccount resources.\n", "properties": { "accountName": { "type": "string", "description": "Database account name. The account name rules are as follows: Length must be 2–63 characters. Can contain letters, numbers, underscores (*), or hyphens (-). Must start with a letter and end with a letter or number. Cannot start with pg*. Reserved keywords cannot be used. For all disabled keywords, see Disabled Keywords.\n" }, "accountPassword": { "type": "string", "description": "Database account password. The password rules are as follows: Length must be 8–32 characters. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters. Supported special characters: !@#$%^*()\u0026_+-=.\n" }, "accountPrivileges": { "type": "string", "description": "Account permission information. Separate multiple permissions with commas (,). Valid values: Login: Login permission. Inherit: Inherit permission. CreateRole: Create role permission. CreateDB: Create database permission. Note: If the account type is high privilege, you do not need to provide this parameter; all permissions are supported by default. If the account type is normal, you can provide this parameter; the default values are Login and Inherit. If the account type is instance read-only, that is, AccountType is set to InstanceReadOnly, this parameter is not supported.\n" }, "accountType": { "type": "string", "description": "Database account type. Valid values: Super: High privilege account. Normal: Normal account. InstanceReadOnly: Instance read-only account.\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "notAllowPrivileges": { "type": "array", "items": { "type": "string" }, "description": "Permissions disabled for the account. Currently, only DDL is supported. Note: This field can only be provided for high privilege or normal accounts, that is, when AccountType is set to Super or Normal.\n" } }, "type": "object" } }, "volcenginecc:rdspostgresql/dbEndpoint:DbEndpoint": { "description": "The connection endpoint is a network proxy service positioned between the database and the application, handling all requests from the application to the database. It features high availability, high performance, maintainability, and ease of use, and supports advanced functions such as read/write splitting and load balancing. The PostgreSQL cloud database provides two types of endpoints: default endpoint and custom read-only endpoint.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst rdsPostgresqlDbEndpointDemo = new volcenginecc.rdspostgresql.DbEndpoint(\"RdsPostgresqlDbEndpointDemo\", {\n endpointName: \"ccapi-test-1\",\n endpointType: \"Custom\",\n instanceId: \"postgres-9dxxxxxd\",\n nodes: \"Primary\",\n readWriteMode: \"ReadWrite\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nrds_postgresql_db_endpoint_demo = volcenginecc.rdspostgresql.DbEndpoint(\"RdsPostgresqlDbEndpointDemo\",\n endpoint_name=\"ccapi-test-1\",\n endpoint_type=\"Custom\",\n instance_id=\"postgres-9dxxxxxd\",\n nodes=\"Primary\",\n read_write_mode=\"ReadWrite\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var rdsPostgresqlDbEndpointDemo = new Volcenginecc.Rdspostgresql.DbEndpoint(\"RdsPostgresqlDbEndpointDemo\", new()\n {\n EndpointName = \"ccapi-test-1\",\n EndpointType = \"Custom\",\n InstanceId = \"postgres-9dxxxxxd\",\n Nodes = \"Primary\",\n ReadWriteMode = \"ReadWrite\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rdspostgresql\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := rdspostgresql.NewDbEndpoint(ctx, \"RdsPostgresqlDbEndpointDemo\", \u0026rdspostgresql.DbEndpointArgs{\n\t\t\tEndpointName: pulumi.String(\"ccapi-test-1\"),\n\t\t\tEndpointType: pulumi.String(\"Custom\"),\n\t\t\tInstanceId: pulumi.String(\"postgres-9dxxxxxd\"),\n\t\t\tNodes: pulumi.String(\"Primary\"),\n\t\t\tReadWriteMode: pulumi.String(\"ReadWrite\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.rdspostgresql.DbEndpoint;\nimport com.volcengine.volcenginecc.rdspostgresql.DbEndpointArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var rdsPostgresqlDbEndpointDemo = new DbEndpoint(\"rdsPostgresqlDbEndpointDemo\", DbEndpointArgs.builder()\n .endpointName(\"ccapi-test-1\")\n .endpointType(\"Custom\")\n .instanceId(\"postgres-9dxxxxxd\")\n .nodes(\"Primary\")\n .readWriteMode(\"ReadWrite\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n rdsPostgresqlDbEndpointDemo:\n type: volcenginecc:rdspostgresql:DbEndpoint\n name: RdsPostgresqlDbEndpointDemo\n properties:\n endpointName: ccapi-test-1\n endpointType: Custom\n instanceId: postgres-9dxxxxxd\n nodes: Primary\n readWriteMode: ReadWrite\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdspostgresql/dbEndpoint:DbEndpoint example \"instance_id|endpoint_id\"\n```\n\n", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/DbEndpointAddress:DbEndpointAddress" } }, "autoAddNewNodes": { "type": "string", "description": "When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).\n" }, "description": { "type": "string", "description": "Address description\n" }, "enableReadOnly": { "type": "string", "description": "Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.\n" }, "enableReadWriteSplitting": { "type": "string", "description": "Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.\n" }, "endpointId": { "type": "string", "description": "Instance connection endpoint ID.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "nodes": { "type": "string", "description": "List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.\n" }, "readOnlyNodeMaxDelayTime": { "type": "integer", "description": "Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/DbEndpointReadOnlyNodeWeight:DbEndpointReadOnlyNodeWeight" } }, "readWriteMode": { "type": "string", "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only.\n" }, "readWriteProxyConnection": { "type": "integer", "description": "After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.\n" }, "writeNodeHaltWriting": { "type": "boolean", "description": "Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.\n" } }, "required": [ "addresses", "autoAddNewNodes", "description", "enableReadOnly", "enableReadWriteSplitting", "endpointId", "endpointName", "endpointType", "instanceId", "nodes", "readOnlyNodeDistributionType", "readOnlyNodeMaxDelayTime", "readOnlyNodeWeights", "readWriteMode", "readWriteProxyConnection", "writeNodeHaltWriting" ], "inputProperties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/DbEndpointAddress:DbEndpointAddress" } }, "enableReadWriteSplitting": { "type": "string", "description": "Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "nodes": { "type": "string", "description": "List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.\n" }, "readOnlyNodeMaxDelayTime": { "type": "integer", "description": "Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/DbEndpointReadOnlyNodeWeight:DbEndpointReadOnlyNodeWeight" } }, "readWriteMode": { "type": "string", "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only.\n" }, "readWriteProxyConnection": { "type": "integer", "description": "After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.\n" }, "writeNodeHaltWriting": { "type": "boolean", "description": "Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering DbEndpoint resources.\n", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/DbEndpointAddress:DbEndpointAddress" } }, "autoAddNewNodes": { "type": "string", "description": "When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).\n" }, "description": { "type": "string", "description": "Address description\n" }, "enableReadOnly": { "type": "string", "description": "Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.\n" }, "enableReadWriteSplitting": { "type": "string", "description": "Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.\n" }, "endpointId": { "type": "string", "description": "Instance connection endpoint ID.\n" }, "endpointName": { "type": "string", "description": "Instance connection endpoint name.\n" }, "endpointType": { "type": "string", "description": "Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "nodes": { "type": "string", "description": "List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.\n" }, "readOnlyNodeDistributionType": { "type": "string", "description": "Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.\n" }, "readOnlyNodeMaxDelayTime": { "type": "integer", "description": "Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.\n" }, "readOnlyNodeWeights": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/DbEndpointReadOnlyNodeWeight:DbEndpointReadOnlyNodeWeight" } }, "readWriteMode": { "type": "string", "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only.\n" }, "readWriteProxyConnection": { "type": "integer", "description": "After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.\n" }, "writeNodeHaltWriting": { "type": "boolean", "description": "Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.\n" } }, "type": "object" } }, "volcenginecc:rdspostgresql/instance:Instance": { "description": "Cloud database instance management\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rDSPostgreSQLInstanceDemo:\n type: volcenginecc:rdspostgresql:Instance\n name: RDSPostgreSQLInstanceDemo\n properties:\n dbEngineVersion: PostgreSQL_14\n nodeInfos:\n - zone_id: cn-beijing-a\n node_spec: rds.postgres.1c2g\n node_type: Primary\n - zone_id: cn-beijing-a\n node_spec: rds.postgres.1c2g\n node_type: Secondary\n storageType: LocalSSD\n vpcId: vpc-***\n subnetId: subnet-***\n chargeDetail:\n charge_type: PostPaid\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdspostgresql/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceChargeDetail:InstanceChargeDetail", "description": "Payment method\n" }, "createTime": { "type": "string", "description": "Instance creation time\n" }, "dataSyncMode": { "type": "string", "description": "Synchronization mode. Value: Async (asynchronous synchronization)\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible version\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceEndpoint:InstanceEndpoint" } }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance name\n" }, "instanceStatus": { "type": "string", "description": "Instance status\n" }, "instanceType": { "type": "string", "description": "Instance type. Value: HA (high availability edition)\n" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceMaintenanceWindow:InstanceMaintenanceWindow", "description": "Instance maintenance window\n" }, "memory": { "type": "number", "description": "Memory size, unit: GB\n" }, "nodeInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceNodeInfo:InstanceNodeInfo" } }, "nodeNumber": { "type": "number", "description": "Number of nodes\n" }, "nodeSpec": { "type": "string", "description": "Primary node specification\n" }, "projectName": { "type": "string", "description": "Project. Default value: default project\n" }, "storageDataUse": { "type": "number", "description": "Data file space used by the primary node. Unit: Byte\n" }, "storageLogUse": { "type": "number", "description": "Log file space used by the primary node. Unit: Byte\n" }, "storageSpace": { "type": "number", "description": "Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100\n" }, "storageTempUse": { "type": "number", "description": "Temporary file space used by the primary node. Unit: Byte\n" }, "storageType": { "type": "string", "description": "Instance storage type, fixed value LocalSSD (local SSD disk)\n" }, "storageUse": { "type": "number", "description": "Used storage space of the instance. Unit: Byte\n" }, "storageWalUse": { "type": "number", "description": "Used WAL file space of the instance's primary node. Unit: Byte\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceTag:InstanceTag" } }, "updateTime": { "type": "string", "description": "Instance update time\n" }, "vcpu": { "type": "number", "description": "CPU size. For example: 1 means 1U\n" }, "vpcId": { "type": "string", "description": "Use this parameter to specify the private network for the instance\n" }, "zoneId": { "type": "string", "description": "Availability zone ID\n" } }, "required": [ "allowListIds", "chargeDetail", "createTime", "dataSyncMode", "dbEngineVersion", "endpoints", "instanceId", "instanceName", "instanceStatus", "instanceType", "maintenanceWindow", "memory", "nodeInfos", "nodeNumber", "nodeSpec", "projectName", "storageDataUse", "storageLogUse", "storageSpace", "storageTempUse", "storageType", "storageUse", "storageWalUse", "subnetId", "tags", "updateTime", "vcpu", "vpcId", "zoneId" ], "inputProperties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceChargeDetail:InstanceChargeDetail", "description": "Payment method\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible version\n" }, "instanceName": { "type": "string", "description": "Instance name\n" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceMaintenanceWindow:InstanceMaintenanceWindow", "description": "Instance maintenance window\n" }, "nodeInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceNodeInfo:InstanceNodeInfo" } }, "projectName": { "type": "string", "description": "Project. Default value: default project\n" }, "storageSpace": { "type": "number", "description": "Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100\n" }, "storageType": { "type": "string", "description": "Instance storage type, fixed value LocalSSD (local SSD disk)\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceTag:InstanceTag" } }, "vpcId": { "type": "string", "description": "Use this parameter to specify the private network for the instance\n" } }, "requiredInputs": [ "chargeDetail", "dbEngineVersion", "nodeInfos", "storageType", "subnetId", "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceChargeDetail:InstanceChargeDetail", "description": "Payment method\n" }, "createTime": { "type": "string", "description": "Instance creation time\n" }, "dataSyncMode": { "type": "string", "description": "Synchronization mode. Value: Async (asynchronous synchronization)\n" }, "dbEngineVersion": { "type": "string", "description": "Compatible version\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceEndpoint:InstanceEndpoint" } }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "instanceName": { "type": "string", "description": "Instance name\n" }, "instanceStatus": { "type": "string", "description": "Instance status\n" }, "instanceType": { "type": "string", "description": "Instance type. Value: HA (high availability edition)\n" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceMaintenanceWindow:InstanceMaintenanceWindow", "description": "Instance maintenance window\n" }, "memory": { "type": "number", "description": "Memory size, unit: GB\n" }, "nodeInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceNodeInfo:InstanceNodeInfo" } }, "nodeNumber": { "type": "number", "description": "Number of nodes\n" }, "nodeSpec": { "type": "string", "description": "Primary node specification\n" }, "projectName": { "type": "string", "description": "Project. Default value: default project\n" }, "storageDataUse": { "type": "number", "description": "Data file space used by the primary node. Unit: Byte\n" }, "storageLogUse": { "type": "number", "description": "Log file space used by the primary node. Unit: Byte\n" }, "storageSpace": { "type": "number", "description": "Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100\n" }, "storageTempUse": { "type": "number", "description": "Temporary file space used by the primary node. Unit: Byte\n" }, "storageType": { "type": "string", "description": "Instance storage type, fixed value LocalSSD (local SSD disk)\n" }, "storageUse": { "type": "number", "description": "Used storage space of the instance. Unit: Byte\n" }, "storageWalUse": { "type": "number", "description": "Used WAL file space of the instance's primary node. Unit: Byte\n" }, "subnetId": { "type": "string", "description": "Subnet ID\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/InstanceTag:InstanceTag" } }, "updateTime": { "type": "string", "description": "Instance update time\n" }, "vcpu": { "type": "number", "description": "CPU size. For example: 1 means 1U\n" }, "vpcId": { "type": "string", "description": "Use this parameter to specify the private network for the instance\n" }, "zoneId": { "type": "string", "description": "Availability zone ID\n" } }, "type": "object" } }, "volcenginecc:rdspostgresql/schema:Schema": { "description": "RDS PostgreSQL Schema resource type\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst rDSPostgreSQLSchemaDemo = new volcenginecc.rdspostgresql.Schema(\"RDSPostgreSQLSchemaDemo\", {\n instanceId: \"postgres-8d1fcxxxxx\",\n dbName: \"ccapi-terraform-1001\",\n schemaName: \"ccapi-terraform-1\",\n owner: \"test\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nr_ds_postgre_sql_schema_demo = volcenginecc.rdspostgresql.Schema(\"RDSPostgreSQLSchemaDemo\",\n instance_id=\"postgres-8d1fcxxxxx\",\n db_name=\"ccapi-terraform-1001\",\n schema_name=\"ccapi-terraform-1\",\n owner=\"test\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var rDSPostgreSQLSchemaDemo = new Volcenginecc.Rdspostgresql.Schema(\"RDSPostgreSQLSchemaDemo\", new()\n {\n InstanceId = \"postgres-8d1fcxxxxx\",\n DbName = \"ccapi-terraform-1001\",\n SchemaName = \"ccapi-terraform-1\",\n Owner = \"test\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rdspostgresql\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := rdspostgresql.NewSchema(ctx, \"RDSPostgreSQLSchemaDemo\", \u0026rdspostgresql.SchemaArgs{\n\t\t\tInstanceId: pulumi.String(\"postgres-8d1fcxxxxx\"),\n\t\t\tDbName: pulumi.String(\"ccapi-terraform-1001\"),\n\t\t\tSchemaName: pulumi.String(\"ccapi-terraform-1\"),\n\t\t\tOwner: pulumi.String(\"test\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.rdspostgresql.Schema;\nimport com.volcengine.volcenginecc.rdspostgresql.SchemaArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var rDSPostgreSQLSchemaDemo = new Schema(\"rDSPostgreSQLSchemaDemo\", SchemaArgs.builder()\n .instanceId(\"postgres-8d1fcxxxxx\")\n .dbName(\"ccapi-terraform-1001\")\n .schemaName(\"ccapi-terraform-1\")\n .owner(\"test\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n rDSPostgreSQLSchemaDemo:\n type: volcenginecc:rdspostgresql:Schema\n name: RDSPostgreSQLSchemaDemo\n properties:\n instanceId: postgres-8d1fcxxxxx\n dbName: ccapi-terraform-1001\n schemaName: ccapi-terraform-1\n owner: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rdspostgresql/schema:Schema example \"instance_id|db_name|schema_name\"\n```\n\n", "properties": { "dbName": { "type": "string", "description": "Database name\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "owner": { "type": "string", "description": "Schema owner. Note that instance read-only accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the Schema owner.\n" }, "schemaName": { "type": "string", "description": "Schema name. Length: 2–63 characters. Can contain letters, numbers, underscores (*), or hyphens (-). Must start with a letter and end with a letter or number. Reserved keywords are not allowed; for all disabled keywords, see Disabled Keywords. Cannot start with pg*\n" } }, "required": [ "dbName", "instanceId", "owner", "schemaName" ], "inputProperties": { "dbName": { "type": "string", "description": "Database name\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "owner": { "type": "string", "description": "Schema owner. Note that instance read-only accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the Schema owner.\n" }, "schemaName": { "type": "string", "description": "Schema name. Length: 2–63 characters. Can contain letters, numbers, underscores (*), or hyphens (-). Must start with a letter and end with a letter or number. Reserved keywords are not allowed; for all disabled keywords, see Disabled Keywords. Cannot start with pg*\n" } }, "requiredInputs": [ "dbName", "instanceId", "owner", "schemaName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Schema resources.\n", "properties": { "dbName": { "type": "string", "description": "Database name\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "owner": { "type": "string", "description": "Schema owner. Note that instance read-only accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the Schema owner.\n" }, "schemaName": { "type": "string", "description": "Schema name. Length: 2–63 characters. Can contain letters, numbers, underscores (*), or hyphens (-). Must start with a letter and end with a letter or number. Reserved keywords are not allowed; for all disabled keywords, see Disabled Keywords. Cannot start with pg*\n" } }, "type": "object" } }, "volcenginecc:redis/account:Account": { "description": "Redis Cache Database supports creating multiple accounts. You can select different roles when creating an account. Each role grants different permissions, helping you manage the database with greater precision and enhance data security.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst redisAccountDemo = new volcenginecc.redis.Account(\"RedisAccountDemo\", {\n instanceId: \"redis-mlrfiqivjttxxxxx\",\n accountName: \"ccapi_test_1\",\n description: \"this is a test\",\n password: \"******\",\n roleName: \"Administrator\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nredis_account_demo = volcenginecc.redis.Account(\"RedisAccountDemo\",\n instance_id=\"redis-mlrfiqivjttxxxxx\",\n account_name=\"ccapi_test_1\",\n description=\"this is a test\",\n password=\"******\",\n role_name=\"Administrator\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var redisAccountDemo = new Volcenginecc.Redis.Account(\"RedisAccountDemo\", new()\n {\n InstanceId = \"redis-mlrfiqivjttxxxxx\",\n AccountName = \"ccapi_test_1\",\n Description = \"this is a test\",\n Password = \"******\",\n RoleName = \"Administrator\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/redis\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := redis.NewAccount(ctx, \"RedisAccountDemo\", \u0026redis.AccountArgs{\n\t\t\tInstanceId: pulumi.String(\"redis-mlrfiqivjttxxxxx\"),\n\t\t\tAccountName: pulumi.String(\"ccapi_test_1\"),\n\t\t\tDescription: pulumi.String(\"this is a test\"),\n\t\t\tPassword: pulumi.String(\"******\"),\n\t\t\tRoleName: pulumi.String(\"Administrator\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.redis.Account;\nimport com.volcengine.volcenginecc.redis.AccountArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var redisAccountDemo = new Account(\"redisAccountDemo\", AccountArgs.builder()\n .instanceId(\"redis-mlrfiqivjttxxxxx\")\n .accountName(\"ccapi_test_1\")\n .description(\"this is a test\")\n .password(\"******\")\n .roleName(\"Administrator\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n redisAccountDemo:\n type: volcenginecc:redis:Account\n name: RedisAccountDemo\n properties:\n instanceId: redis-mlrfiqivjttxxxxx\n accountName: ccapi_test_1\n description: this is a test\n password: '******'\n roleName: Administrator\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:redis/account:Account example \"instance_id|account_name\"\n```\n\n", "properties": { "accountName": { "type": "string", "description": "Account name. The name must meet the following requirements: It must start with a lowercase letter. It must end with a lowercase letter or number. The length must be 2–16 characters. It can only contain lowercase letters, numbers, and underscores (_).\n" }, "accountStatus": { "type": "string", "description": "Account status. The value range is as follows: Available: Available. Unavailable: Unavailable.\n" }, "description": { "type": "string", "description": "Account description, up to 256 characters. Note: If this parameter is empty, no account description is set.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "password": { "type": "string", "description": "Account password. The password must meet the following requirements: Length of 8–32 characters. Must include at least two of the following: uppercase letters, lowercase letters, numbers, or special characters. Supported special characters: ()`~!@#$%^\u0026*-+=_|{}[];\u003c\u003e,.?\n" }, "roleName": { "type": "string", "description": "Account role. The following default roles are supported: Administrator: Allows all Redis instance-supported commands on all Keys. ReadWrite: Allows all commands except admin class commands on all Keys. ReadOnly: Allows all read class commands on all Keys. NotDangerous: Allows all commands except dangerous class commands on all Keys. Note: For details on the specific commands supported by each role's ACL rules, see ACL syntax.\n" } }, "required": [ "accountName", "accountStatus", "description", "instanceId", "password", "roleName" ], "inputProperties": { "accountName": { "type": "string", "description": "Account name. The name must meet the following requirements: It must start with a lowercase letter. It must end with a lowercase letter or number. The length must be 2–16 characters. It can only contain lowercase letters, numbers, and underscores (_).\n" }, "description": { "type": "string", "description": "Account description, up to 256 characters. Note: If this parameter is empty, no account description is set.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "password": { "type": "string", "description": "Account password. The password must meet the following requirements: Length of 8–32 characters. Must include at least two of the following: uppercase letters, lowercase letters, numbers, or special characters. Supported special characters: ()`~!@#$%^\u0026*-+=_|{}[];\u003c\u003e,.?\n" }, "roleName": { "type": "string", "description": "Account role. The following default roles are supported: Administrator: Allows all Redis instance-supported commands on all Keys. ReadWrite: Allows all commands except admin class commands on all Keys. ReadOnly: Allows all read class commands on all Keys. NotDangerous: Allows all commands except dangerous class commands on all Keys. Note: For details on the specific commands supported by each role's ACL rules, see ACL syntax.\n" } }, "requiredInputs": [ "accountName", "instanceId", "password", "roleName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Account resources.\n", "properties": { "accountName": { "type": "string", "description": "Account name. The name must meet the following requirements: It must start with a lowercase letter. It must end with a lowercase letter or number. The length must be 2–16 characters. It can only contain lowercase letters, numbers, and underscores (_).\n" }, "accountStatus": { "type": "string", "description": "Account status. The value range is as follows: Available: Available. Unavailable: Unavailable.\n" }, "description": { "type": "string", "description": "Account description, up to 256 characters. Note: If this parameter is empty, no account description is set.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "password": { "type": "string", "description": "Account password. The password must meet the following requirements: Length of 8–32 characters. Must include at least two of the following: uppercase letters, lowercase letters, numbers, or special characters. Supported special characters: ()`~!@#$%^\u0026*-+=_|{}[];\u003c\u003e,.?\n" }, "roleName": { "type": "string", "description": "Account role. The following default roles are supported: Administrator: Allows all Redis instance-supported commands on all Keys. ReadWrite: Allows all commands except admin class commands on all Keys. ReadOnly: Allows all read class commands on all Keys. NotDangerous: Allows all commands except dangerous class commands on all Keys. Note: For details on the specific commands supported by each role's ACL rules, see ACL syntax.\n" } }, "type": "object" } }, "volcenginecc:redis/allowList:AllowList": { "description": "After a Redis cache database instance is created, you can set an allowlist for the instance to permit devices to access it.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n redisAllowListDemo:\n type: volcenginecc:redis:AllowList\n name: RedisAllowListDemo\n properties:\n allowList: 127.0.0.1,0.0.0.0/0,192.168.0.0/24\n allowListName: ccapi_test\n allowListDesc: this is a test\n allowListCategory: Ordinary\n projectName: default\n securityGroupBindInfos:\n - bind_mode: AssociateEcsIp\n security_group_id: sg-w06pxjgvtds0865yxxxxxx\n - bind_mode: AssociateEcsIp\n security_group_id: sg-rrco3fkzzy0wv0x5xxxxxx\n - bind_mode: IngressDirectionIp\n security_group_id: sg-w07syi789s74865yxxxxxx\n instanceIds:\n - redis-cnlfwpqoohxxxxxx\n - redis-cnlfenhsypxxxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:redis/allowList:AllowList example \"allow_list_id\"\n```\n\n", "properties": { "allowList": { "type": "string", "description": "Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListCategory": { "type": "string", "description": "Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations\n" }, "allowListDesc": { "type": "string", "description": "Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Number of IP addresses in the allowlist\n" }, "allowListName": { "type": "string", "description": "Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters\n" }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "List of instance IDs bound to the current allowlist\n" }, "projectName": { "type": "string", "description": "Project name associated with the allowlist\n" }, "securityGroupBindInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo" } } }, "required": [ "allowList", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "associatedInstanceNum", "associatedInstances", "instanceIds", "projectName", "securityGroupBindInfos" ], "inputProperties": { "allowList": { "type": "string", "description": "Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListCategory": { "type": "string", "description": "Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations\n" }, "allowListDesc": { "type": "string", "description": "Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default\n" }, "allowListName": { "type": "string", "description": "Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters\n" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "List of instance IDs bound to the current allowlist\n" }, "projectName": { "type": "string", "description": "Project name associated with the allowlist\n" }, "securityGroupBindInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo" } } }, "stateInputs": { "description": "Input properties used for looking up and filtering AllowList resources.\n", "properties": { "allowList": { "type": "string", "description": "Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListCategory": { "type": "string", "description": "Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations\n" }, "allowListDesc": { "type": "string", "description": "Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Number of IP addresses in the allowlist\n" }, "allowListName": { "type": "string", "description": "Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters\n" }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "List of instance IDs bound to the current allowlist\n" }, "projectName": { "type": "string", "description": "Project name associated with the allowlist\n" }, "securityGroupBindInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/AllowListSecurityGroupBindInfo:AllowListSecurityGroupBindInfo" } } }, "type": "object" } }, "volcenginecc:redis/endpointPublicAddress:EndpointPublicAddress": { "description": "Enable public network access so that devices outside the VPC can access the Redis instance.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst redisEndpointPublicAddressDemo = new volcenginecc.redis.EndpointPublicAddress(\"RedisEndpointPublicAddressDemo\", {\n instanceId: \"redis-cnlfii2cw1xxxxxx\",\n port: 6379,\n eipId: \"eip-w08rcc38bsw0865yxxxxx\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nredis_endpoint_public_address_demo = volcenginecc.redis.EndpointPublicAddress(\"RedisEndpointPublicAddressDemo\",\n instance_id=\"redis-cnlfii2cw1xxxxxx\",\n port=6379,\n eip_id=\"eip-w08rcc38bsw0865yxxxxx\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var redisEndpointPublicAddressDemo = new Volcenginecc.Redis.EndpointPublicAddress(\"RedisEndpointPublicAddressDemo\", new()\n {\n InstanceId = \"redis-cnlfii2cw1xxxxxx\",\n Port = 6379,\n EipId = \"eip-w08rcc38bsw0865yxxxxx\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/redis\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := redis.NewEndpointPublicAddress(ctx, \"RedisEndpointPublicAddressDemo\", \u0026redis.EndpointPublicAddressArgs{\n\t\t\tInstanceId: pulumi.String(\"redis-cnlfii2cw1xxxxxx\"),\n\t\t\tPort: pulumi.Int(6379),\n\t\t\tEipId: pulumi.String(\"eip-w08rcc38bsw0865yxxxxx\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.redis.EndpointPublicAddress;\nimport com.volcengine.volcenginecc.redis.EndpointPublicAddressArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var redisEndpointPublicAddressDemo = new EndpointPublicAddress(\"redisEndpointPublicAddressDemo\", EndpointPublicAddressArgs.builder()\n .instanceId(\"redis-cnlfii2cw1xxxxxx\")\n .port(6379)\n .eipId(\"eip-w08rcc38bsw0865yxxxxx\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n redisEndpointPublicAddressDemo:\n type: volcenginecc:redis:EndpointPublicAddress\n name: RedisEndpointPublicAddressDemo\n properties:\n instanceId: redis-cnlfii2cw1xxxxxx\n port: 6379\n eipId: eip-w08rcc38bsw0865yxxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:redis/endpointPublicAddress:EndpointPublicAddress example \"instance_id|eip_id\"\n```\n\n", "properties": { "addrType": { "type": "string", "description": "Connection address type. Valid values: Private: Private network connection address. Public: Public network connection address. DirectLink: Direct connection address. Note: Direct connection address information is returned only when a sharded Redis cluster instance has applied for a direct connection address. For more information about connection address types, see Connection Address Types.\n" }, "address": { "type": "string", "description": "IP address or domain name\n" }, "eipId": { "type": "string", "description": "ID of the Elastic Public IP\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "newAddressPrefix": { "type": "string", "description": "Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.\n" }, "port": { "type": "integer", "description": "Port number\n" }, "upgradeRegionDomain": { "type": "boolean", "description": "Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.\n" }, "viPv6": { "type": "string", "description": "IPv6 address corresponding to the connection address. Note: This parameter is returned only if the instance uses an IPv6 address. Only private network addresses and direct connection addresses support IPv6; public network addresses do not. Therefore, when the connection address type is Public (i.e., AddrType is Public), this parameter is always empty.\n" }, "vip": { "type": "string", "description": "IPv4 address corresponding to the connection address\n" } }, "required": [ "addrType", "address", "eipId", "instanceId", "newAddressPrefix", "port", "upgradeRegionDomain", "viPv6", "vip" ], "inputProperties": { "eipId": { "type": "string", "description": "ID of the Elastic Public IP\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "newAddressPrefix": { "type": "string", "description": "Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.\n" }, "port": { "type": "integer", "description": "Port number\n" }, "upgradeRegionDomain": { "type": "boolean", "description": "Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.\n" } }, "requiredInputs": [ "eipId", "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering EndpointPublicAddress resources.\n", "properties": { "addrType": { "type": "string", "description": "Connection address type. Valid values: Private: Private network connection address. Public: Public network connection address. DirectLink: Direct connection address. Note: Direct connection address information is returned only when a sharded Redis cluster instance has applied for a direct connection address. For more information about connection address types, see Connection Address Types.\n" }, "address": { "type": "string", "description": "IP address or domain name\n" }, "eipId": { "type": "string", "description": "ID of the Elastic Public IP\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "newAddressPrefix": { "type": "string", "description": "Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.\n" }, "port": { "type": "integer", "description": "Port number\n" }, "upgradeRegionDomain": { "type": "boolean", "description": "Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.\n" }, "viPv6": { "type": "string", "description": "IPv6 address corresponding to the connection address. Note: This parameter is returned only if the instance uses an IPv6 address. Only private network addresses and direct connection addresses support IPv6; public network addresses do not. Therefore, when the connection address type is Public (i.e., AddrType is Public), this parameter is always empty.\n" }, "vip": { "type": "string", "description": "IPv4 address corresponding to the connection address\n" } }, "type": "object" } }, "volcenginecc:redis/instance:Instance": { "description": "The basic unit of Redis cache database is the instance. An instance is an independent, virtualized database runtime environment, consisting of multiple data nodes and proxy nodes. The Redis engine runs on the data nodes.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst redisInstanceDemo = new volcenginecc.redis.Instance(\"RedisInstanceDemo\", {\n instanceName: \"RedisInstance\",\n shardedCluster: 1,\n password: \"********\",\n nodeNumber: 2,\n shardCapacity: 512,\n shardNumber: 2,\n engineVersion: \"5.0\",\n vpcId: \"vpc-13f8xxxx\",\n subnetId: \"vpc_subnet-xxxx\",\n deletionProtection: \"disabled\",\n chargeType: \"PostPaid\",\n port: 6381,\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n multiAz: \"enabled\",\n configureNodes: [\n {\n az: \"cn-beijing-a\",\n },\n {\n az: \"cn-beijing-b\",\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nredis_instance_demo = volcenginecc.redis.Instance(\"RedisInstanceDemo\",\n instance_name=\"RedisInstance\",\n sharded_cluster=1,\n password=\"********\",\n node_number=2,\n shard_capacity=512,\n shard_number=2,\n engine_version=\"5.0\",\n vpc_id=\"vpc-13f8xxxx\",\n subnet_id=\"vpc_subnet-xxxx\",\n deletion_protection=\"disabled\",\n charge_type=\"PostPaid\",\n port=6381,\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }],\n multi_az=\"enabled\",\n configure_nodes=[\n {\n \"az\": \"cn-beijing-a\",\n },\n {\n \"az\": \"cn-beijing-b\",\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var redisInstanceDemo = new Volcenginecc.Redis.Instance(\"RedisInstanceDemo\", new()\n {\n InstanceName = \"RedisInstance\",\n ShardedCluster = 1,\n Password = \"********\",\n NodeNumber = 2,\n ShardCapacity = 512,\n ShardNumber = 2,\n EngineVersion = \"5.0\",\n VpcId = \"vpc-13f8xxxx\",\n SubnetId = \"vpc_subnet-xxxx\",\n DeletionProtection = \"disabled\",\n ChargeType = \"PostPaid\",\n Port = 6381,\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Redis.Inputs.InstanceTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n MultiAz = \"enabled\",\n ConfigureNodes = new[]\n {\n new Volcenginecc.Redis.Inputs.InstanceConfigureNodeArgs\n {\n Az = \"cn-beijing-a\",\n },\n new Volcenginecc.Redis.Inputs.InstanceConfigureNodeArgs\n {\n Az = \"cn-beijing-b\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/redis\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := redis.NewInstance(ctx, \"RedisInstanceDemo\", \u0026redis.InstanceArgs{\n\t\t\tInstanceName: pulumi.String(\"RedisInstance\"),\n\t\t\tShardedCluster: pulumi.Int(1),\n\t\t\tPassword: pulumi.String(\"********\"),\n\t\t\tNodeNumber: pulumi.Int(2),\n\t\t\tShardCapacity: pulumi.Int(512),\n\t\t\tShardNumber: pulumi.Int(2),\n\t\t\tEngineVersion: pulumi.String(\"5.0\"),\n\t\t\tVpcId: pulumi.String(\"vpc-13f8xxxx\"),\n\t\t\tSubnetId: pulumi.String(\"vpc_subnet-xxxx\"),\n\t\t\tDeletionProtection: pulumi.String(\"disabled\"),\n\t\t\tChargeType: pulumi.String(\"PostPaid\"),\n\t\t\tPort: pulumi.Int(6381),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: redis.InstanceTagArray{\n\t\t\t\t\u0026redis.InstanceTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tMultiAz: pulumi.String(\"enabled\"),\n\t\t\tConfigureNodes: redis.InstanceConfigureNodeArray{\n\t\t\t\t\u0026redis.InstanceConfigureNodeArgs{\n\t\t\t\t\tAz: pulumi.String(\"cn-beijing-a\"),\n\t\t\t\t},\n\t\t\t\t\u0026redis.InstanceConfigureNodeArgs{\n\t\t\t\t\tAz: pulumi.String(\"cn-beijing-b\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.redis.Instance;\nimport com.volcengine.volcenginecc.redis.InstanceArgs;\nimport com.pulumi.volcenginecc.redis.inputs.InstanceTagArgs;\nimport com.pulumi.volcenginecc.redis.inputs.InstanceConfigureNodeArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var redisInstanceDemo = new Instance(\"redisInstanceDemo\", InstanceArgs.builder()\n .instanceName(\"RedisInstance\")\n .shardedCluster(1)\n .password(\"********\")\n .nodeNumber(2)\n .shardCapacity(512)\n .shardNumber(2)\n .engineVersion(\"5.0\")\n .vpcId(\"vpc-13f8xxxx\")\n .subnetId(\"vpc_subnet-xxxx\")\n .deletionProtection(\"disabled\")\n .chargeType(\"PostPaid\")\n .port(6381)\n .projectName(\"default\")\n .tags(InstanceTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .multiAz(\"enabled\")\n .configureNodes( \n InstanceConfigureNodeArgs.builder()\n .az(\"cn-beijing-a\")\n .build(),\n InstanceConfigureNodeArgs.builder()\n .az(\"cn-beijing-b\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n redisInstanceDemo:\n type: volcenginecc:redis:Instance\n name: RedisInstanceDemo\n properties:\n instanceName: RedisInstance\n shardedCluster: 1\n password: '********'\n nodeNumber: 2\n shardCapacity: 512\n shardNumber: 2\n engineVersion: '5.0'\n vpcId: vpc-13f8xxxx\n subnetId: vpc_subnet-xxxx\n deletionProtection: disabled\n chargeType: PostPaid\n port: 6381\n projectName: default\n tags:\n - key: env\n value: test\n multiAz: enabled\n configureNodes:\n - az: cn-beijing-a\n - az: cn-beijing-b\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:redis/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.\n" }, "autoRenew": { "type": "boolean", "description": "Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.\n" }, "backupPointName": { "type": "string", "description": "Set a backup name for the full backup created before changes.\n" }, "blueGreenRole": { "type": "string", "description": "Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.\n" }, "capacity": { "$ref": "#/types/volcenginecc:redis/InstanceCapacity:InstanceCapacity", "description": "Capacity information of the instance.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).\n" }, "configureNodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceConfigureNode:InstanceConfigureNode" } }, "createBackup": { "type": "boolean", "description": "Whether to create a backup before making changes.\n" }, "createTime": { "type": "string", "description": "Creation time of the instance.\n" }, "dataLayout": { "type": "string", "description": "Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.\n" }, "deletionProtection": { "type": "string", "description": "Enable or disable instance deletion protection.\n" }, "engineVersion": { "type": "string", "description": "Database version number.\n" }, "expiredTime": { "type": "string", "description": "Instance expiration time.\n" }, "instanceClass": { "type": "string", "description": "Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.\n" }, "instanceShards": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceInstanceShard:InstanceInstanceShard" } }, "maintenanceTime": { "type": "string", "description": "Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).\n" }, "maxConnections": { "type": "integer", "description": "Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.\n" }, "multiAz": { "type": "string", "description": "Set the deployment scheme for the instance's availability zone.\n" }, "noAuthMode": { "type": "string", "description": "Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "List of Proxy and Server node IDs.\n" }, "nodeNumber": { "type": "integer", "description": "Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.\n" }, "parameterGroupId": { "type": "string", "description": "The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.\n" }, "password": { "type": "string", "description": "Set the password for the default account of the default database.\n" }, "port": { "type": "integer", "description": "Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.\n" }, "privateAddress": { "type": "string", "description": "The domain name for the instance's private network connection address.\n" }, "privatePort": { "type": "string", "description": "Port number for the instance's private network connection address.\n" }, "projectName": { "type": "string", "description": "Project to which the instance belongs.\n" }, "purchaseMonths": { "type": "integer", "description": "Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.\n" }, "reserveAdditionalBandwidth": { "type": "boolean", "description": "Set whether to reserve additional bandwidth\n" }, "serviceType": { "type": "string", "description": "Service type of the instance\n" }, "shardCapacity": { "type": "integer", "description": "Memory capacity of each shard in the instance. Unit: MiB.\n" }, "shardNumber": { "type": "integer", "description": "Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).\n" }, "shardedCluster": { "type": "integer", "description": "Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.\n" }, "status": { "type": "string", "description": "Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.\n" }, "subnetId": { "type": "string", "description": "Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceTag:InstanceTag" } }, "viPv6": { "type": "string", "description": "The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.\n" }, "vip": { "type": "string", "description": "IPv4 address corresponding to the instance's private network connection address.\n" }, "visitAddrs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceVisitAddr:InstanceVisitAddr" } }, "vpcAuthMode": { "type": "string", "description": "Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.\n" }, "vpcId": { "type": "string", "description": "Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.\n" }, "zoneIds": { "type": "array", "items": { "type": "string" }, "description": "List of available zones where the instance is located.\n" } }, "required": [ "allowListIds", "autoRenew", "backupPointName", "blueGreenRole", "capacity", "chargeType", "configureNodes", "createBackup", "createTime", "dataLayout", "deletionProtection", "engineVersion", "expiredTime", "instanceClass", "instanceId", "instanceName", "instanceShards", "maintenanceTime", "maxConnections", "multiAz", "noAuthMode", "nodeIds", "nodeNumber", "parameterGroupId", "password", "port", "privateAddress", "privatePort", "projectName", "purchaseMonths", "reserveAdditionalBandwidth", "serviceType", "shardCapacity", "shardNumber", "shardedCluster", "status", "subnetId", "tags", "viPv6", "vip", "visitAddrs", "vpcAuthMode", "vpcId", "zoneIds" ], "inputProperties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.\n" }, "autoRenew": { "type": "boolean", "description": "Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.\n" }, "backupPointName": { "type": "string", "description": "Set a backup name for the full backup created before changes.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).\n" }, "configureNodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceConfigureNode:InstanceConfigureNode" } }, "createBackup": { "type": "boolean", "description": "Whether to create a backup before making changes.\n" }, "deletionProtection": { "type": "string", "description": "Enable or disable instance deletion protection.\n" }, "engineVersion": { "type": "string", "description": "Database version number.\n" }, "instanceName": { "type": "string", "description": "Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.\n" }, "multiAz": { "type": "string", "description": "Set the deployment scheme for the instance's availability zone.\n" }, "noAuthMode": { "type": "string", "description": "Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.\n" }, "nodeNumber": { "type": "integer", "description": "Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.\n" }, "parameterGroupId": { "type": "string", "description": "The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.\n" }, "password": { "type": "string", "description": "Set the password for the default account of the default database.\n" }, "port": { "type": "integer", "description": "Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.\n" }, "projectName": { "type": "string", "description": "Project to which the instance belongs.\n" }, "purchaseMonths": { "type": "integer", "description": "Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.\n" }, "reserveAdditionalBandwidth": { "type": "boolean", "description": "Set whether to reserve additional bandwidth\n" }, "shardCapacity": { "type": "integer", "description": "Memory capacity of each shard in the instance. Unit: MiB.\n" }, "shardNumber": { "type": "integer", "description": "Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).\n" }, "shardedCluster": { "type": "integer", "description": "Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.\n" }, "subnetId": { "type": "string", "description": "Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceTag:InstanceTag" } }, "vpcId": { "type": "string", "description": "Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.\n" } }, "requiredInputs": [ "configureNodes", "engineVersion", "multiAz", "nodeNumber", "shardCapacity", "shardedCluster", "subnetId", "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.\n" }, "autoRenew": { "type": "boolean", "description": "Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.\n" }, "backupPointName": { "type": "string", "description": "Set a backup name for the full backup created before changes.\n" }, "blueGreenRole": { "type": "string", "description": "Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.\n" }, "capacity": { "$ref": "#/types/volcenginecc:redis/InstanceCapacity:InstanceCapacity", "description": "Capacity information of the instance.\n" }, "chargeType": { "type": "string", "description": "Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).\n" }, "configureNodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceConfigureNode:InstanceConfigureNode" } }, "createBackup": { "type": "boolean", "description": "Whether to create a backup before making changes.\n" }, "createTime": { "type": "string", "description": "Creation time of the instance.\n" }, "dataLayout": { "type": "string", "description": "Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.\n" }, "deletionProtection": { "type": "string", "description": "Enable or disable instance deletion protection.\n" }, "engineVersion": { "type": "string", "description": "Database version number.\n" }, "expiredTime": { "type": "string", "description": "Instance expiration time.\n" }, "instanceClass": { "type": "string", "description": "Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.\n" }, "instanceShards": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceInstanceShard:InstanceInstanceShard" } }, "maintenanceTime": { "type": "string", "description": "Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).\n" }, "maxConnections": { "type": "integer", "description": "Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.\n" }, "multiAz": { "type": "string", "description": "Set the deployment scheme for the instance's availability zone.\n" }, "noAuthMode": { "type": "string", "description": "Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "List of Proxy and Server node IDs.\n" }, "nodeNumber": { "type": "integer", "description": "Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.\n" }, "parameterGroupId": { "type": "string", "description": "The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.\n" }, "password": { "type": "string", "description": "Set the password for the default account of the default database.\n" }, "port": { "type": "integer", "description": "Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.\n" }, "privateAddress": { "type": "string", "description": "The domain name for the instance's private network connection address.\n" }, "privatePort": { "type": "string", "description": "Port number for the instance's private network connection address.\n" }, "projectName": { "type": "string", "description": "Project to which the instance belongs.\n" }, "purchaseMonths": { "type": "integer", "description": "Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.\n" }, "reserveAdditionalBandwidth": { "type": "boolean", "description": "Set whether to reserve additional bandwidth\n" }, "serviceType": { "type": "string", "description": "Service type of the instance\n" }, "shardCapacity": { "type": "integer", "description": "Memory capacity of each shard in the instance. Unit: MiB.\n" }, "shardNumber": { "type": "integer", "description": "Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).\n" }, "shardedCluster": { "type": "integer", "description": "Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.\n" }, "status": { "type": "string", "description": "Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.\n" }, "subnetId": { "type": "string", "description": "Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceTag:InstanceTag" } }, "viPv6": { "type": "string", "description": "The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.\n" }, "vip": { "type": "string", "description": "IPv4 address corresponding to the instance's private network connection address.\n" }, "visitAddrs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:redis/InstanceVisitAddr:InstanceVisitAddr" } }, "vpcAuthMode": { "type": "string", "description": "Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.\n" }, "vpcId": { "type": "string", "description": "Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.\n" }, "zoneIds": { "type": "array", "items": { "type": "string" }, "description": "List of available zones where the instance is located.\n" } }, "type": "object" } }, "volcenginecc:rocketmq/allowList:AllowList": { "description": "RocketMQ Access Allowlist\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rocketMQAllowListDemo:\n type: volcenginecc:rocketmq:AllowList\n name: RocketMQAllowListDemo\n properties:\n allowListType: IPv4\n allowList: 192.xxx.0.0/24\n allowListName: ccapi-test\n allowListDesc: this is a description\n associatedInstances:\n - instance_id: rocketmq-cnnxxxx68a106\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rocketmq/allowList:AllowList example \"allow_list_id\"\n```\n\n", "properties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,) and do not repeat addresses\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListCategory": { "type": "string", "description": "Allowlist Category\n" }, "allowListDesc": { "type": "string", "description": "Allowlist Description\n" }, "allowListId": { "type": "string", "description": "Allowlist ID\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or address ranges) in the allowlist\n" }, "allowListName": { "type": "string", "description": "Allowlist Name\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is supported\n" }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "required": [ "allowList", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "instanceId" ], "inputProperties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,) and do not repeat addresses\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListCategory": { "type": "string", "description": "Allowlist Category\n" }, "allowListDesc": { "type": "string", "description": "Allowlist Description\n" }, "allowListName": { "type": "string", "description": "Allowlist Name\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is supported\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "requiredInputs": [ "allowListName" ], "stateInputs": { "description": "Input properties used for looking up and filtering AllowList resources.\n", "properties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,) and do not repeat addresses\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListCategory": { "type": "string", "description": "Allowlist Category\n" }, "allowListDesc": { "type": "string", "description": "Allowlist Description\n" }, "allowListId": { "type": "string", "description": "Allowlist ID\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or address ranges) in the allowlist\n" }, "allowListName": { "type": "string", "description": "Allowlist Name\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is supported\n" }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "type": "object" } }, "volcenginecc:rocketmq/group:Group": { "description": "Group, also known as Consumer Group, is a collection of consumers with similar consumption behavior, used to categorize and manage different consumers. Each consumer group consumes different types of messages. Within each consumer group, the logic for publishing or subscribing to messages is consistent. In RocketMQ Message Queue, you need to create a Group and use the Group ID to identify different types of producers or consumers.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst rocketMQGroupDemo = new volcenginecc.rocketmq.Group(\"RocketMQGroupDemo\", {\n instanceId: \"rocketmq-cnnxxxxxc2d\",\n groupId: \"ccapi-test-test-1\",\n consumeMessageOrderly: true,\n description: \"test\",\n groupType: \"TCP\",\n retryMaxTimes: 2,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nrocket_mq_group_demo = volcenginecc.rocketmq.Group(\"RocketMQGroupDemo\",\n instance_id=\"rocketmq-cnnxxxxxc2d\",\n group_id=\"ccapi-test-test-1\",\n consume_message_orderly=True,\n description=\"test\",\n group_type=\"TCP\",\n retry_max_times=2)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var rocketMQGroupDemo = new Volcenginecc.Rocketmq.Group(\"RocketMQGroupDemo\", new()\n {\n InstanceId = \"rocketmq-cnnxxxxxc2d\",\n GroupId = \"ccapi-test-test-1\",\n ConsumeMessageOrderly = true,\n Description = \"test\",\n GroupType = \"TCP\",\n RetryMaxTimes = 2,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rocketmq\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := rocketmq.NewGroup(ctx, \"RocketMQGroupDemo\", \u0026rocketmq.GroupArgs{\n\t\t\tInstanceId: pulumi.String(\"rocketmq-cnnxxxxxc2d\"),\n\t\t\tGroupId: pulumi.String(\"ccapi-test-test-1\"),\n\t\t\tConsumeMessageOrderly: pulumi.Bool(true),\n\t\t\tDescription: pulumi.String(\"test\"),\n\t\t\tGroupType: pulumi.String(\"TCP\"),\n\t\t\tRetryMaxTimes: pulumi.Int(2),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.rocketmq.Group;\nimport com.volcengine.volcenginecc.rocketmq.GroupArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var rocketMQGroupDemo = new Group(\"rocketMQGroupDemo\", GroupArgs.builder()\n .instanceId(\"rocketmq-cnnxxxxxc2d\")\n .groupId(\"ccapi-test-test-1\")\n .consumeMessageOrderly(true)\n .description(\"test\")\n .groupType(\"TCP\")\n .retryMaxTimes(2)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n rocketMQGroupDemo:\n type: volcenginecc:rocketmq:Group\n name: RocketMQGroupDemo\n properties:\n instanceId: rocketmq-cnnxxxxxc2d\n groupId: ccapi-test-test-1\n consumeMessageOrderly: true\n description: test\n groupType: TCP\n retryMaxTimes: 2\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rocketmq/group:Group example \"instance_id|group_id\"\n```\n\n", "properties": { "consumeMessageOrderly": { "type": "boolean", "description": "Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.\n" }, "consumedClients": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/GroupConsumedClient:GroupConsumedClient" } }, "consumedTopics": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/GroupConsumedTopic:GroupConsumedTopic" } }, "createdTime": { "type": "string", "description": "Group creation time.\n" }, "description": { "type": "string", "description": "Brief description of the Group.\n" }, "groupId": { "type": "string", "description": "Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (*). It is recommended to start with GID - or GID*. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.\n" }, "groupType": { "type": "string", "description": "Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "isSubSame": { "type": "boolean", "description": "Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.\n" }, "lastUpdateTimestamp": { "type": "string", "description": "Whether consumption is sequential.\n" }, "messageDelayTime": { "type": "string", "description": "Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.\n" }, "messageModel": { "type": "string", "description": "Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.\n" }, "retryMaxTimes": { "type": "integer", "description": "Maximum number of consumption retries.\n" }, "rocketmqVersion": { "type": "string", "description": "RocketMQ version.\n" }, "serviceStatus": { "type": "string", "description": "Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.\n" }, "status": { "type": "string", "description": "Consumer group status. Online: Consuming, Offline: Not consuming.\n" }, "totalConsumedRate": { "type": "string", "description": "Total TPS of consumer instance groups under this Group, measured in messages per second.\n" }, "totalDiff": { "type": "integer", "description": "Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.\n" } }, "required": [ "consumeMessageOrderly", "consumedClients", "consumedTopics", "createdTime", "description", "groupId", "groupType", "instanceId", "isSubSame", "lastUpdateTimestamp", "messageDelayTime", "messageModel", "retryMaxTimes", "rocketmqVersion", "serviceStatus", "status", "totalConsumedRate", "totalDiff" ], "inputProperties": { "consumeMessageOrderly": { "type": "boolean", "description": "Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.\n" }, "description": { "type": "string", "description": "Brief description of the Group.\n" }, "groupId": { "type": "string", "description": "Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (*). It is recommended to start with GID - or GID*. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.\n" }, "groupType": { "type": "string", "description": "Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "retryMaxTimes": { "type": "integer", "description": "Maximum number of consumption retries.\n" } }, "requiredInputs": [ "groupId", "groupType", "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Group resources.\n", "properties": { "consumeMessageOrderly": { "type": "boolean", "description": "Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.\n" }, "consumedClients": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/GroupConsumedClient:GroupConsumedClient" } }, "consumedTopics": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/GroupConsumedTopic:GroupConsumedTopic" } }, "createdTime": { "type": "string", "description": "Group creation time.\n" }, "description": { "type": "string", "description": "Brief description of the Group.\n" }, "groupId": { "type": "string", "description": "Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (*). It is recommended to start with GID - or GID*. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.\n" }, "groupType": { "type": "string", "description": "Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "isSubSame": { "type": "boolean", "description": "Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.\n" }, "lastUpdateTimestamp": { "type": "string", "description": "Whether consumption is sequential.\n" }, "messageDelayTime": { "type": "string", "description": "Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.\n" }, "messageModel": { "type": "string", "description": "Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.\n" }, "retryMaxTimes": { "type": "integer", "description": "Maximum number of consumption retries.\n" }, "rocketmqVersion": { "type": "string", "description": "RocketMQ version.\n" }, "serviceStatus": { "type": "string", "description": "Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.\n" }, "status": { "type": "string", "description": "Consumer group status. Online: Consuming, Offline: Not consuming.\n" }, "totalConsumedRate": { "type": "string", "description": "Total TPS of consumer instance groups under this Group, measured in messages per second.\n" }, "totalDiff": { "type": "integer", "description": "Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.\n" } }, "type": "object" } }, "volcenginecc:rocketmq/instance:Instance": { "description": "RocketMQ Message Queue is a distributed messaging middleware service built on Apache RocketMQ. It is fully compatible with all open-source RocketMQ components and concepts, offering low latency, high elasticity and high reliability, and high throughput. No changes to business code are required, enabling users to quickly migrate to the cloud.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rocketMQInstanceDemo:\n type: volcenginecc:rocketmq:Instance\n name: RocketMQInstanceDemo\n properties:\n allowListIds:\n - acl-5380876c62044b658c3c7da4xxxx\n - acl-3e998a9ef43e48eda1d07e2exxxx\n ipVersionType: IPv4\n enableSsl: true\n tags:\n - key: env\n value: test\n version: 5.x\n zoneId: cn-beijing-a,cn-beijing-c,cn-beijing-d\n computeSpec: rocketmq.x2.2k\n storageSpace: 300\n vpcId: vpc-1a1vgeo93ycxxxxxxxjnuw\n subnetId: subnet-ij9s4h4xxxxxxx95wx4p\n fileReservedTime: 72\n instanceName: RocketMQInstanceDemo\n chargeDetail:\n charge_type: PostPaid\n sslMode: permissive\n networkTypes: PrivateNetwork\n projectName: default\n instanceDescription: RocketMQInstanceDemo description\n eipId: eip-bt6jb362txxxxx2zbpbo\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rocketmq/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account ID to which the instance belongs.\n" }, "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.\n" }, "applyPrivateDnsToPublic": { "type": "boolean", "description": "Whether private network domain name supports public resolution. true: enabled false: disabled\n" }, "autoScaleQueue": { "type": "boolean", "description": "Whether to automatically create queues when the instance specification changes.\n" }, "availableQueueNumber": { "type": "integer", "description": "Remaining number of partitions that can be created.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rocketmq/InstanceChargeDetail:InstanceChargeDetail", "description": "Billing method and related billing information for the instance.\n" }, "computeSpec": { "type": "string", "description": "Instance compute specification. You can view the currently available compute specifications in the product specifications list.\n" }, "connectionInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/InstanceConnectionInfo:InstanceConnectionInfo" } }, "createTime": { "type": "string", "description": "Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "eipId": { "type": "string", "description": "EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.\n" }, "enableSsl": { "type": "boolean", "description": "Whether to use SSL encryption.\n" }, "fileReservedTime": { "type": "integer", "description": "Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.\n" }, "instanceDescription": { "type": "string", "description": "Brief description of the instance. Length range: 1–128 characters.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "ipVersionType": { "type": "string", "description": "IP version. Options are IPv4 or DualStack.\n" }, "networkTypes": { "type": "string", "description": "Instance network type, fixed as PrivateNetwork.\n" }, "productInfo": { "$ref": "#/types/volcenginecc:rocketmq/InstanceProductInfo:InstanceProductInfo", "description": "Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.\n" }, "projectName": { "type": "string", "description": "The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.\n" }, "regionId": { "type": "string", "description": "Region ID where the instance is located.\n" }, "sslMode": { "type": "string", "description": "The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.\n" }, "storageSpace": { "type": "integer", "description": "Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/InstanceTag:InstanceTag" } }, "usedGroupNumber": { "type": "integer", "description": "Number of consumer groups (Group) currently created for the instance.\n" }, "usedQueueNumber": { "type": "integer", "description": "Number of queues already used by the instance.\n" }, "usedStorageSpace": { "type": "integer", "description": "Used storage space for the instance, in GiB.\n" }, "usedTopicNumber": { "type": "integer", "description": "Number of topics created in the current instance.\n" }, "version": { "type": "string", "description": "Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.\n" }, "vpcId": { "type": "string", "description": "VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.\n" } }, "required": [ "accountId", "allowListIds", "applyPrivateDnsToPublic", "autoScaleQueue", "availableQueueNumber", "chargeDetail", "computeSpec", "connectionInfos", "createTime", "eipId", "enableSsl", "fileReservedTime", "instanceDescription", "instanceId", "instanceName", "instanceStatus", "ipVersionType", "networkTypes", "productInfo", "projectName", "regionId", "sslMode", "storageSpace", "subnetId", "tags", "usedGroupNumber", "usedQueueNumber", "usedStorageSpace", "usedTopicNumber", "version", "vpcId", "zoneId" ], "inputProperties": { "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.\n" }, "autoScaleQueue": { "type": "boolean", "description": "Whether to automatically create queues when the instance specification changes.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rocketmq/InstanceChargeDetail:InstanceChargeDetail", "description": "Billing method and related billing information for the instance.\n" }, "computeSpec": { "type": "string", "description": "Instance compute specification. You can view the currently available compute specifications in the product specifications list.\n" }, "eipId": { "type": "string", "description": "EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.\n" }, "enableSsl": { "type": "boolean", "description": "Whether to use SSL encryption.\n" }, "fileReservedTime": { "type": "integer", "description": "Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.\n" }, "instanceDescription": { "type": "string", "description": "Brief description of the instance. Length range: 1–128 characters.\n" }, "instanceName": { "type": "string", "description": "Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.\n" }, "ipVersionType": { "type": "string", "description": "IP version. Options are IPv4 or DualStack.\n" }, "networkTypes": { "type": "string", "description": "Instance network type, fixed as PrivateNetwork.\n" }, "productInfo": { "$ref": "#/types/volcenginecc:rocketmq/InstanceProductInfo:InstanceProductInfo", "description": "Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.\n" }, "projectName": { "type": "string", "description": "The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.\n" }, "sslMode": { "type": "string", "description": "The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.\n" }, "storageSpace": { "type": "integer", "description": "Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/InstanceTag:InstanceTag" } }, "version": { "type": "string", "description": "Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.\n" }, "vpcId": { "type": "string", "description": "VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.\n" } }, "requiredInputs": [ "chargeDetail", "computeSpec", "fileReservedTime", "networkTypes", "storageSpace", "subnetId", "version", "vpcId", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "accountId": { "type": "string", "description": "Account ID to which the instance belongs.\n" }, "allowListIds": { "type": "array", "items": { "type": "string" }, "description": "List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.\n" }, "applyPrivateDnsToPublic": { "type": "boolean", "description": "Whether private network domain name supports public resolution. true: enabled false: disabled\n" }, "autoScaleQueue": { "type": "boolean", "description": "Whether to automatically create queues when the instance specification changes.\n" }, "availableQueueNumber": { "type": "integer", "description": "Remaining number of partitions that can be created.\n" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rocketmq/InstanceChargeDetail:InstanceChargeDetail", "description": "Billing method and related billing information for the instance.\n" }, "computeSpec": { "type": "string", "description": "Instance compute specification. You can view the currently available compute specifications in the product specifications list.\n" }, "connectionInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/InstanceConnectionInfo:InstanceConnectionInfo" } }, "createTime": { "type": "string", "description": "Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n" }, "eipId": { "type": "string", "description": "EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.\n" }, "enableSsl": { "type": "boolean", "description": "Whether to use SSL encryption.\n" }, "fileReservedTime": { "type": "integer", "description": "Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.\n" }, "instanceDescription": { "type": "string", "description": "Brief description of the instance. Length range: 1–128 characters.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "ipVersionType": { "type": "string", "description": "IP version. Options are IPv4 or DualStack.\n" }, "networkTypes": { "type": "string", "description": "Instance network type, fixed as PrivateNetwork.\n" }, "productInfo": { "$ref": "#/types/volcenginecc:rocketmq/InstanceProductInfo:InstanceProductInfo", "description": "Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.\n" }, "projectName": { "type": "string", "description": "The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.\n" }, "regionId": { "type": "string", "description": "Region ID where the instance is located.\n" }, "sslMode": { "type": "string", "description": "The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.\n" }, "storageSpace": { "type": "integer", "description": "Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.\n" }, "subnetId": { "type": "string", "description": "VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/InstanceTag:InstanceTag" } }, "usedGroupNumber": { "type": "integer", "description": "Number of consumer groups (Group) currently created for the instance.\n" }, "usedQueueNumber": { "type": "integer", "description": "Number of queues already used by the instance.\n" }, "usedStorageSpace": { "type": "integer", "description": "Used storage space for the instance, in GiB.\n" }, "usedTopicNumber": { "type": "integer", "description": "Number of topics created in the current instance.\n" }, "version": { "type": "string", "description": "Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.\n" }, "vpcId": { "type": "string", "description": "VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.\n" } }, "type": "object" } }, "volcenginecc:rocketmq/topic:Topic": { "description": "In a RocketMQ instance, a Topic is the basic unit for sending and consuming messages. RocketMQ Message Queue categorizes and manages different types of messages using Topics. Producers send messages to RocketMQ Topics, and consumers consume messages by subscribing to those Topics.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n rocketMQTopicDemo:\n type: volcenginecc:rocketmq:Topic\n name: RocketMQTopicDemo\n properties:\n instanceId: rocketmq-cnngxxxxx3c2d\n topicName: ccapi-test-test-2\n messageType: 0\n description: this is a test\n queueNumber: 6\n accessPolicies:\n - access_key: TPl1xxxxxxblh5Gpxa79\n authority: ALL\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:rocketmq/topic:Topic example \"instance_id|topic_name\"\n```\n\n", "properties": { "accessPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/TopicAccessPolicy:TopicAccessPolicy" } }, "createdTime": { "type": "string", "description": "Topic creation time.\n" }, "description": { "type": "string", "description": "Topic description, length: 0–128 characters.\n" }, "groupsInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/TopicGroupsInfo:TopicGroupsInfo" } }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "messageType": { "type": "integer", "description": "Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.\n" }, "queueNumber": { "type": "integer", "description": "Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.\n" }, "queuesInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/TopicQueuesInfo:TopicQueuesInfo" } }, "readAccessPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/TopicReadAccessPolicy:TopicReadAccessPolicy" } }, "serviceStatus": { "type": "string", "description": "Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.\n" }, "topicName": { "type": "string", "description": "Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores (*) are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQ*SYS*TRANS*OP*HALF*TOPIC, BenchmarkTest, TBW102, OFFSET*MOVED*EVENT, SELF*TEST*TOPIC, RMQ*SYS*TRANS*HALF*TOPIC, SCHEDULE*TOPIC*XXXX, RMQ*SYS*TRACE*TOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmq*sys_, %DLQ%.\n" } }, "required": [ "accessPolicies", "createdTime", "description", "groupsInfos", "instanceId", "instanceName", "messageType", "queueNumber", "queuesInfos", "readAccessPolicies", "serviceStatus", "topicName" ], "inputProperties": { "accessPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/TopicAccessPolicy:TopicAccessPolicy" } }, "description": { "type": "string", "description": "Topic description, length: 0–128 characters.\n" }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "messageType": { "type": "integer", "description": "Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.\n" }, "queueNumber": { "type": "integer", "description": "Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.\n" }, "topicName": { "type": "string", "description": "Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores (*) are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQ*SYS*TRANS*OP*HALF*TOPIC, BenchmarkTest, TBW102, OFFSET*MOVED*EVENT, SELF*TEST*TOPIC, RMQ*SYS*TRANS*HALF*TOPIC, SCHEDULE*TOPIC*XXXX, RMQ*SYS*TRACE*TOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmq*sys_, %DLQ%.\n" } }, "requiredInputs": [ "instanceId", "messageType", "queueNumber", "topicName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Topic resources.\n", "properties": { "accessPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/TopicAccessPolicy:TopicAccessPolicy" } }, "createdTime": { "type": "string", "description": "Topic creation time.\n" }, "description": { "type": "string", "description": "Topic description, length: 0–128 characters.\n" }, "groupsInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/TopicGroupsInfo:TopicGroupsInfo" } }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name.\n" }, "messageType": { "type": "integer", "description": "Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.\n" }, "queueNumber": { "type": "integer", "description": "Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.\n" }, "queuesInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/TopicQueuesInfo:TopicQueuesInfo" } }, "readAccessPolicies": { "type": "array", "items": { "$ref": "#/types/volcenginecc:rocketmq/TopicReadAccessPolicy:TopicReadAccessPolicy" } }, "serviceStatus": { "type": "string", "description": "Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.\n" }, "topicName": { "type": "string", "description": "Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores (*) are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQ*SYS*TRANS*OP*HALF*TOPIC, BenchmarkTest, TBW102, OFFSET*MOVED*EVENT, SELF*TEST*TOPIC, RMQ*SYS*TRANS*HALF*TOPIC, SCHEDULE*TOPIC*XXXX, RMQ*SYS*TRACE*TOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmq*sys_, %DLQ%.\n" } }, "type": "object" } }, "volcenginecc:storageebs/snapshot:Snapshot": { "description": "A snapshot is a backup method. Each snapshot is a backup file of cloud disk data at a specific point in time. When data is lost or a failure occurs, you can roll back cloud disk data using the snapshot to recover lost data.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst storageEBSSnapshotDemo = new volcenginecc.storageebs.Snapshot(\"StorageEBSSnapshotDemo\", {\n volumeId: \"vol-3wt6pip1dy3qu*****\",\n snapshotName: \"StorageEBSSnapshotDemo\",\n description: \"StorageEBSSnapshotDemo description\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nstorage_ebs_snapshot_demo = volcenginecc.storageebs.Snapshot(\"StorageEBSSnapshotDemo\",\n volume_id=\"vol-3wt6pip1dy3qu*****\",\n snapshot_name=\"StorageEBSSnapshotDemo\",\n description=\"StorageEBSSnapshotDemo description\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var storageEBSSnapshotDemo = new Volcenginecc.Storageebs.Snapshot(\"StorageEBSSnapshotDemo\", new()\n {\n VolumeId = \"vol-3wt6pip1dy3qu*****\",\n SnapshotName = \"StorageEBSSnapshotDemo\",\n Description = \"StorageEBSSnapshotDemo description\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Storageebs.Inputs.SnapshotTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/storageebs\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := storageebs.NewSnapshot(ctx, \"StorageEBSSnapshotDemo\", \u0026storageebs.SnapshotArgs{\n\t\t\tVolumeId: pulumi.String(\"vol-3wt6pip1dy3qu*****\"),\n\t\t\tSnapshotName: pulumi.String(\"StorageEBSSnapshotDemo\"),\n\t\t\tDescription: pulumi.String(\"StorageEBSSnapshotDemo description\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: storageebs.SnapshotTagArray{\n\t\t\t\t\u0026storageebs.SnapshotTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.storageebs.Snapshot;\nimport com.volcengine.volcenginecc.storageebs.SnapshotArgs;\nimport com.pulumi.volcenginecc.storageebs.inputs.SnapshotTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var storageEBSSnapshotDemo = new Snapshot(\"storageEBSSnapshotDemo\", SnapshotArgs.builder()\n .volumeId(\"vol-3wt6pip1dy3qu*****\")\n .snapshotName(\"StorageEBSSnapshotDemo\")\n .description(\"StorageEBSSnapshotDemo description\")\n .projectName(\"default\")\n .tags(SnapshotTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n storageEBSSnapshotDemo:\n type: volcenginecc:storageebs:Snapshot\n name: StorageEBSSnapshotDemo\n properties:\n volumeId: vol-3wt6pip1dy3qu*****\n snapshotName: StorageEBSSnapshotDemo\n description: StorageEBSSnapshotDemo description\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:storageebs/snapshot:Snapshot example \"snapshot_id\"\n```\n\n", "properties": { "creationTime": { "type": "string", "description": "Snapshot creation time.\n" }, "description": { "type": "string", "description": "Snapshot description. Default is empty. Length must be between 0 and 255 characters.\n" }, "imageId": { "type": "string", "description": "Image ID\n" }, "instantAccess": { "type": "boolean", "description": "Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.\n" }, "progress": { "type": "integer", "description": "Snapshot dump progress.\n" }, "projectName": { "type": "string", "description": "Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.\n" }, "retentionDays": { "type": "integer", "description": "Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.\n" }, "shared": { "type": "boolean", "description": "Whether the snapshot is shared.\n" }, "snapshotGroupId": { "type": "string", "description": "Snapshot consistency group ID.\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID.\n" }, "snapshotName": { "type": "string", "description": "Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.\n" }, "snapshotType": { "type": "string", "description": "Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.\n" }, "status": { "type": "string", "description": "Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/SnapshotTag:SnapshotTag" } }, "volumeId": { "type": "string", "description": "Cloud disk ID associated with the snapshot.\n" }, "volumeKind": { "type": "string", "description": "Cloud disk category. Value options: system: system disk. data: data disk.\n" }, "volumeName": { "type": "string", "description": "Cloud disk name.\n" }, "volumeSize": { "type": "integer", "description": "Cloud disk size, in GiB.\n" }, "volumeStatus": { "type": "string", "description": "Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, \"\": cloud disk deleted.\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. Value options: ESSD*PL0: Ultra-fast SSD cloud disk, PL0 specification. ESSD*FlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the snapshot is located.\n" } }, "required": [ "creationTime", "description", "imageId", "instantAccess", "progress", "projectName", "retentionDays", "shared", "snapshotGroupId", "snapshotId", "snapshotName", "snapshotType", "status", "tags", "volumeId", "volumeKind", "volumeName", "volumeSize", "volumeStatus", "volumeType", "zoneId" ], "inputProperties": { "description": { "type": "string", "description": "Snapshot description. Default is empty. Length must be between 0 and 255 characters.\n" }, "projectName": { "type": "string", "description": "Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.\n" }, "retentionDays": { "type": "integer", "description": "Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.\n" }, "snapshotName": { "type": "string", "description": "Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/SnapshotTag:SnapshotTag" } }, "volumeId": { "type": "string", "description": "Cloud disk ID associated with the snapshot.\n" } }, "requiredInputs": [ "snapshotName", "volumeId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Snapshot resources.\n", "properties": { "creationTime": { "type": "string", "description": "Snapshot creation time.\n" }, "description": { "type": "string", "description": "Snapshot description. Default is empty. Length must be between 0 and 255 characters.\n" }, "imageId": { "type": "string", "description": "Image ID\n" }, "instantAccess": { "type": "boolean", "description": "Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.\n" }, "progress": { "type": "integer", "description": "Snapshot dump progress.\n" }, "projectName": { "type": "string", "description": "Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.\n" }, "retentionDays": { "type": "integer", "description": "Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.\n" }, "shared": { "type": "boolean", "description": "Whether the snapshot is shared.\n" }, "snapshotGroupId": { "type": "string", "description": "Snapshot consistency group ID.\n" }, "snapshotId": { "type": "string", "description": "Snapshot ID.\n" }, "snapshotName": { "type": "string", "description": "Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.\n" }, "snapshotType": { "type": "string", "description": "Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.\n" }, "status": { "type": "string", "description": "Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/SnapshotTag:SnapshotTag" } }, "volumeId": { "type": "string", "description": "Cloud disk ID associated with the snapshot.\n" }, "volumeKind": { "type": "string", "description": "Cloud disk category. Value options: system: system disk. data: data disk.\n" }, "volumeName": { "type": "string", "description": "Cloud disk name.\n" }, "volumeSize": { "type": "integer", "description": "Cloud disk size, in GiB.\n" }, "volumeStatus": { "type": "string", "description": "Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, \"\": cloud disk deleted.\n" }, "volumeType": { "type": "string", "description": "Cloud disk type. Value options: ESSD*PL0: Ultra-fast SSD cloud disk, PL0 specification. ESSD*FlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk\n" }, "zoneId": { "type": "string", "description": "Availability zone ID where the snapshot is located.\n" } }, "type": "object" } }, "volcenginecc:storageebs/snapshotGroup:SnapshotGroup": { "description": "A snapshot consistency group is a combination of snapshots from multiple cloud disks. In scenarios where business systems span multiple cloud disks, you can use a snapshot consistency group to ensure write order consistency and crash consistency for data written to the disks\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst storageEBSSnapshotGroupDemo = new volcenginecc.storageebs.SnapshotGroup(\"StorageEBSSnapshotGroupDemo\", {\n name: \"ccapi-test\",\n projectName: \"default\",\n description: \"this-is_test\",\n instanceId: \"i-yekg7jsw00bw8xxxxx\",\n volumeIds: [\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbghxxxxx\",\n ],\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nstorage_ebs_snapshot_group_demo = volcenginecc.storageebs.SnapshotGroup(\"StorageEBSSnapshotGroupDemo\",\n name=\"ccapi-test\",\n project_name=\"default\",\n description=\"this-is_test\",\n instance_id=\"i-yekg7jsw00bw8xxxxx\",\n volume_ids=[\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbghxxxxx\",\n ],\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var storageEBSSnapshotGroupDemo = new Volcenginecc.Storageebs.SnapshotGroup(\"StorageEBSSnapshotGroupDemo\", new()\n {\n Name = \"ccapi-test\",\n ProjectName = \"default\",\n Description = \"this-is_test\",\n InstanceId = \"i-yekg7jsw00bw8xxxxx\",\n VolumeIds = new[]\n {\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbghxxxxx\",\n },\n Tags = new[]\n {\n new Volcenginecc.Storageebs.Inputs.SnapshotGroupTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/storageebs\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := storageebs.NewSnapshotGroup(ctx, \"StorageEBSSnapshotGroupDemo\", \u0026storageebs.SnapshotGroupArgs{\n\t\t\tName: pulumi.String(\"ccapi-test\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tDescription: pulumi.String(\"this-is_test\"),\n\t\t\tInstanceId: pulumi.String(\"i-yekg7jsw00bw8xxxxx\"),\n\t\t\tVolumeIds: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"vol-3x1q75ir0t4qbgxxxxx\"),\n\t\t\t\tpulumi.String(\"vol-3x1q75ir0t4qbgxxxxx\"),\n\t\t\t\tpulumi.String(\"vol-3x1q75ir0t4qbgxxxxx\"),\n\t\t\t\tpulumi.String(\"vol-3x1q75ir0t4qbghxxxxx\"),\n\t\t\t},\n\t\t\tTags: storageebs.SnapshotGroupTagArray{\n\t\t\t\t\u0026storageebs.SnapshotGroupTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.storageebs.SnapshotGroup;\nimport com.volcengine.volcenginecc.storageebs.SnapshotGroupArgs;\nimport com.pulumi.volcenginecc.storageebs.inputs.SnapshotGroupTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var storageEBSSnapshotGroupDemo = new SnapshotGroup(\"storageEBSSnapshotGroupDemo\", SnapshotGroupArgs.builder()\n .name(\"ccapi-test\")\n .projectName(\"default\")\n .description(\"this-is_test\")\n .instanceId(\"i-yekg7jsw00bw8xxxxx\")\n .volumeIds( \n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbgxxxxx\",\n \"vol-3x1q75ir0t4qbghxxxxx\")\n .tags(SnapshotGroupTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n storageEBSSnapshotGroupDemo:\n type: volcenginecc:storageebs:SnapshotGroup\n name: StorageEBSSnapshotGroupDemo\n properties:\n name: ccapi-test\n projectName: default\n description: this-is_test\n instanceId: i-yekg7jsw00bw8xxxxx\n volumeIds:\n - vol-3x1q75ir0t4qbgxxxxx\n - vol-3x1q75ir0t4qbgxxxxx\n - vol-3x1q75ir0t4qbgxxxxx\n - vol-3x1q75ir0t4qbghxxxxx\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:storageebs/snapshotGroup:SnapshotGroup example \"snapshot_group_id\"\n```\n\n", "properties": { "creationTime": { "type": "string", "description": "Snapshot consistency group creation time\n" }, "description": { "type": "string", "description": "Snapshot consistency group description\n" }, "imageId": { "type": "string", "description": "Image ID of the snapshot consistency group\n" }, "instanceId": { "type": "string", "description": "ECS instance ID of the snapshot consistency group\n" }, "name": { "type": "string", "description": "Snapshot consistency group name\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "snapshotGroupId": { "type": "string", "description": "Snapshot consistency group ID\n" }, "snapshots": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/SnapshotGroupSnapshot:SnapshotGroupSnapshot" } }, "status": { "type": "string", "description": "Snapshot consistency group status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/SnapshotGroupTag:SnapshotGroupTag" } }, "volumeIds": { "type": "array", "items": { "type": "string" }, "description": "Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance\n" } }, "required": [ "creationTime", "description", "imageId", "instanceId", "name", "projectName", "snapshotGroupId", "snapshots", "status", "tags", "volumeIds" ], "inputProperties": { "description": { "type": "string", "description": "Snapshot consistency group description\n" }, "instanceId": { "type": "string", "description": "ECS instance ID of the snapshot consistency group\n" }, "name": { "type": "string", "description": "Snapshot consistency group name\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/SnapshotGroupTag:SnapshotGroupTag" } }, "volumeIds": { "type": "array", "items": { "type": "string" }, "description": "Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance\n" } }, "requiredInputs": [ "volumeIds" ], "stateInputs": { "description": "Input properties used for looking up and filtering SnapshotGroup resources.\n", "properties": { "creationTime": { "type": "string", "description": "Snapshot consistency group creation time\n" }, "description": { "type": "string", "description": "Snapshot consistency group description\n" }, "imageId": { "type": "string", "description": "Image ID of the snapshot consistency group\n" }, "instanceId": { "type": "string", "description": "ECS instance ID of the snapshot consistency group\n" }, "name": { "type": "string", "description": "Snapshot consistency group name\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "snapshotGroupId": { "type": "string", "description": "Snapshot consistency group ID\n" }, "snapshots": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/SnapshotGroupSnapshot:SnapshotGroupSnapshot" } }, "status": { "type": "string", "description": "Snapshot consistency group status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/SnapshotGroupTag:SnapshotGroupTag" } }, "volumeIds": { "type": "array", "items": { "type": "string" }, "description": "Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance\n" } }, "type": "object" } }, "volcenginecc:storageebs/volume:Volume": { "description": "Cloud disk is a block storage device with high availability, high reliability, high performance, and elastic scalability. It can be used as a scalable disk for cloud servers and elastic container services.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst volumeDemo = new volcenginecc.storageebs.Volume(\"VolumeDemo\", {\n volumeName: \"EBS-VolumeDemo\",\n volumeType: \"ESSD_PL0\",\n size: 10,\n zoneId: \"cn-beijing-x\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nvolume_demo = volcenginecc.storageebs.Volume(\"VolumeDemo\",\n volume_name=\"EBS-VolumeDemo\",\n volume_type=\"ESSD_PL0\",\n size=10,\n zone_id=\"cn-beijing-x\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var volumeDemo = new Volcenginecc.Storageebs.Volume(\"VolumeDemo\", new()\n {\n VolumeName = \"EBS-VolumeDemo\",\n VolumeType = \"ESSD_PL0\",\n Size = 10,\n ZoneId = \"cn-beijing-x\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/storageebs\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := storageebs.NewVolume(ctx, \"VolumeDemo\", \u0026storageebs.VolumeArgs{\n\t\t\tVolumeName: pulumi.String(\"EBS-VolumeDemo\"),\n\t\t\tVolumeType: pulumi.String(\"ESSD_PL0\"),\n\t\t\tSize: pulumi.Float64(10),\n\t\t\tZoneId: pulumi.String(\"cn-beijing-x\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.storageebs.Volume;\nimport com.volcengine.volcenginecc.storageebs.VolumeArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var volumeDemo = new Volume(\"volumeDemo\", VolumeArgs.builder()\n .volumeName(\"EBS-VolumeDemo\")\n .volumeType(\"ESSD_PL0\")\n .size(10.0)\n .zoneId(\"cn-beijing-x\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n volumeDemo:\n type: volcenginecc:storageebs:Volume\n name: VolumeDemo\n properties:\n volumeName: EBS-VolumeDemo\n volumeType: ESSD_PL0\n size: 10\n zoneId: cn-beijing-x\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:storageebs/volume:Volume example \"volume_id\"\n```\n\n", "properties": { "autoSnapshotPolicyId": { "type": "string", "description": "Automatic snapshot policy ID.\n" }, "autoSnapshotPolicyName": { "type": "string", "description": "Automatic snapshot policy name.\n" }, "baselinePerformance": { "$ref": "#/types/volcenginecc:storageebs/VolumeBaselinePerformance:VolumeBaselinePerformance", "description": "Baseline performance.\n" }, "createdAt": { "type": "string", "description": "Disk creation time.\n" }, "deleteWithInstance": { "type": "boolean", "description": "When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.\n" }, "description": { "type": "string", "description": "Disk description. Default is empty. Length must be between 1 and 255 characters.\n" }, "deviceName": { "type": "string", "description": "Device name\n" }, "errorDetail": { "type": "string", "description": "Specific error\n" }, "expiredTime": { "type": "string", "description": "Expiration time for yearly/monthly subscription.\n" }, "extraPerformance": { "$ref": "#/types/volcenginecc:storageebs/VolumeExtraPerformance:VolumeExtraPerformance", "description": "Extra performance.\n" }, "imageId": { "type": "string", "description": "Image ID in the disk.\n" }, "instanceId": { "type": "string", "description": "ECS instance ID mounted when creating the cloud disk.\n" }, "kind": { "type": "string", "description": "Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.\n" }, "overdueReclaimTime": { "type": "string", "description": "Disk overdue reclamation time.\n" }, "overdueTime": { "type": "string", "description": "Disk overdue shutdown time.\n" }, "payType": { "type": "string", "description": "Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).\n" }, "projectName": { "type": "string", "description": "Project name to which the disk will be added.\n" }, "renewType": { "type": "number", "description": "Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.\n" }, "size": { "type": "number", "description": "Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSD*PL0: 10~65536 GiB; ESSD*FlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB\n" }, "snapshotCount": { "type": "number", "description": "Snapshot count.\n" }, "sourceSnapshotId": { "type": "string", "description": "Source snapshot.\n" }, "status": { "type": "string", "description": "Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/VolumeTag:VolumeTag" } }, "totalPerformance": { "$ref": "#/types/volcenginecc:storageebs/VolumeTotalPerformance:VolumeTotalPerformance", "description": "Total performance.\n" }, "tradeStatus": { "type": "number", "description": "Transaction status 0: Creating 1: Running 2: Creation failed\n" }, "updatedAt": { "type": "string", "description": "Disk update time.\n" }, "volumeId": { "type": "string", "description": "Disk ID.\n" }, "volumeName": { "type": "string", "description": "Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (*). Can contain Chinese characters, letters, numbers, underscores (*), or hyphens (-). Length must be between 1 and 128 characters.\n" }, "volumeType": { "type": "string", "description": "Disk type. Value description: ESSD*PL0: Ultra-fast SSD disk, PL0 specification. ESSD*FlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "required": [ "autoSnapshotPolicyId", "autoSnapshotPolicyName", "baselinePerformance", "createdAt", "deleteWithInstance", "description", "deviceName", "errorDetail", "expiredTime", "extraPerformance", "imageId", "instanceId", "kind", "overdueReclaimTime", "overdueTime", "payType", "projectName", "renewType", "size", "snapshotCount", "sourceSnapshotId", "status", "tags", "totalPerformance", "tradeStatus", "updatedAt", "volumeId", "volumeName", "volumeType", "zoneId" ], "inputProperties": { "autoSnapshotPolicyId": { "type": "string", "description": "Automatic snapshot policy ID.\n" }, "deleteWithInstance": { "type": "boolean", "description": "When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.\n" }, "description": { "type": "string", "description": "Disk description. Default is empty. Length must be between 1 and 255 characters.\n" }, "extraPerformance": { "$ref": "#/types/volcenginecc:storageebs/VolumeExtraPerformance:VolumeExtraPerformance", "description": "Extra performance.\n" }, "instanceId": { "type": "string", "description": "ECS instance ID mounted when creating the cloud disk.\n" }, "kind": { "type": "string", "description": "Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.\n" }, "payType": { "type": "string", "description": "Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).\n" }, "projectName": { "type": "string", "description": "Project name to which the disk will be added.\n" }, "size": { "type": "number", "description": "Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSD*PL0: 10~65536 GiB; ESSD*FlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB\n" }, "sourceSnapshotId": { "type": "string", "description": "Source snapshot.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/VolumeTag:VolumeTag" } }, "volumeName": { "type": "string", "description": "Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (*). Can contain Chinese characters, letters, numbers, underscores (*), or hyphens (-). Length must be between 1 and 128 characters.\n" }, "volumeType": { "type": "string", "description": "Disk type. Value description: ESSD*PL0: Ultra-fast SSD disk, PL0 specification. ESSD*FlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "requiredInputs": [ "size", "volumeName", "volumeType", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Volume resources.\n", "properties": { "autoSnapshotPolicyId": { "type": "string", "description": "Automatic snapshot policy ID.\n" }, "autoSnapshotPolicyName": { "type": "string", "description": "Automatic snapshot policy name.\n" }, "baselinePerformance": { "$ref": "#/types/volcenginecc:storageebs/VolumeBaselinePerformance:VolumeBaselinePerformance", "description": "Baseline performance.\n" }, "createdAt": { "type": "string", "description": "Disk creation time.\n" }, "deleteWithInstance": { "type": "boolean", "description": "When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.\n" }, "description": { "type": "string", "description": "Disk description. Default is empty. Length must be between 1 and 255 characters.\n" }, "deviceName": { "type": "string", "description": "Device name\n" }, "errorDetail": { "type": "string", "description": "Specific error\n" }, "expiredTime": { "type": "string", "description": "Expiration time for yearly/monthly subscription.\n" }, "extraPerformance": { "$ref": "#/types/volcenginecc:storageebs/VolumeExtraPerformance:VolumeExtraPerformance", "description": "Extra performance.\n" }, "imageId": { "type": "string", "description": "Image ID in the disk.\n" }, "instanceId": { "type": "string", "description": "ECS instance ID mounted when creating the cloud disk.\n" }, "kind": { "type": "string", "description": "Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.\n" }, "overdueReclaimTime": { "type": "string", "description": "Disk overdue reclamation time.\n" }, "overdueTime": { "type": "string", "description": "Disk overdue shutdown time.\n" }, "payType": { "type": "string", "description": "Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).\n" }, "projectName": { "type": "string", "description": "Project name to which the disk will be added.\n" }, "renewType": { "type": "number", "description": "Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.\n" }, "size": { "type": "number", "description": "Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSD*PL0: 10~65536 GiB; ESSD*FlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB\n" }, "snapshotCount": { "type": "number", "description": "Snapshot count.\n" }, "sourceSnapshotId": { "type": "string", "description": "Source snapshot.\n" }, "status": { "type": "string", "description": "Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:storageebs/VolumeTag:VolumeTag" } }, "totalPerformance": { "$ref": "#/types/volcenginecc:storageebs/VolumeTotalPerformance:VolumeTotalPerformance", "description": "Total performance.\n" }, "tradeStatus": { "type": "number", "description": "Transaction status 0: Creating 1: Running 2: Creation failed\n" }, "updatedAt": { "type": "string", "description": "Disk update time.\n" }, "volumeId": { "type": "string", "description": "Disk ID.\n" }, "volumeName": { "type": "string", "description": "Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (*). Can contain Chinese characters, letters, numbers, underscores (*), or hyphens (-). Length must be between 1 and 128 characters.\n" }, "volumeType": { "type": "string", "description": "Disk type. Value description: ESSD*PL0: Ultra-fast SSD disk, PL0 specification. ESSD*FlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "type": "object" } }, "volcenginecc:tls/alarmNotifyGroup:AlarmNotifyGroup": { "description": "The logging service notification group is a collection of alarm notification channels used to specify the action strategy after an alarm is triggered. You can add notification rules, and the logging service will intelligently assign different alarm notification channels based on these rules.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n tLSAlarmNotifyGroupDemo:\n type: volcenginecc:tls:AlarmNotifyGroup\n name: TLSAlarmNotifyGroupDemo\n properties:\n alarmNotifyGroupName: ccapi-test\n iamProjectName: default\n noticeRules:\n - rule_node: '{\"Type\":\"Operation\",\"Value\":[\"OR\"],\"Children\":[{\"Type\":\"Operation\",\"Value\":[\"AND\"],\"Children\":[{\"Type\":\"Operation\",\"Value\":[\"OR\"],\"Children\":[{\"Type\":\"Condition\",\"Value\":[\"Severity\",\"in\",\"[\\\"notice\\\"]\"]},{\"Type\":\"Condition\",\"Value\":[\"Duration\",\"\u003e=\",\"5\"]}]},{\"Type\":\"Condition\",\"Value\":[\"NotifyTime\",\"in\",\"[\\\"1776669310\\\",\\\"1777014911\\\"]\"]}]},{\"Type\":\"Condition\",\"Value\":[\"Severity\",\"in\",\"[\\\"warning\\\",\\\"critical\\\"]\"]}]}'\n receiver_infos:\n - receiverType: User\n receiverNames:\n - xxxxxxxx\n - xxxxxxx\n receiverChannels:\n - Email\n - Sms\n - Phone\n - GeneralWebhook\n startTime: 00:00:00\n endTime: 23:59:59\n generalWebhookUrl: \"\"\n generalWebhookMethod: \"\"\n generalWebhookHeaders:\n - key: Content-Type\n value: application/json\n generalWebhookBody: \"\"\n alarmContentTemplateId: default-template\n alarmWebhookIntegrationId: aa6d01cd-5cf4-449d-a944-xxxxxxx\n alarmWebhookIntegrationName: test\n alarmWebhookIsAtAll: false\n alarmWebhookAtUsers:\n - xxxxxxxxx\n alarmWebhookAtGroups:\n - xxxxxxxxx\n - receiverType: User\n receiverNames:\n - xxxxxxxxx\n - xxxxxxxxx\n receiverChannels:\n - Lark\n startTime: 00:00:00\n endTime: 23:59:59\n generalWebhookUrl: \"\"\n generalWebhookMethod: \"\"\n generalWebhookHeaders:\n - key: Content-Type\n value: application/json\n generalWebhookBody: \"\"\n alarmContentTemplateId: default-template\n alarmWebhookIntegrationId: abc47ee4-9ad3-4c25-803f-xxxxxxxxx\n alarmWebhookIntegrationName: 飞书test\n alarmWebhookIsAtAll: false\n alarmWebhookAtUsers:\n - xxxxxxxxx\n alarmWebhookAtGroups:\n - xxxxxxxxx\n - receiverType: UserGroup\n receiverNames:\n - xxxxxxxxx\n receiverChannels:\n - Email\n - Phone\n - GeneralWebhook\n startTime: 00:30:00\n endTime: 23:30:59\n generalWebhookUrl: \"\"\n generalWebhookMethod: \"\"\n generalWebhookHeaders:\n - key: Content-Type\n value: application/json\n generalWebhookBody: \"\"\n alarmContentTemplateId: default-template\n alarmWebhookIntegrationId: aa6d01cd-5cf4-449d-a944-xxxxxxxxx\n alarmWebhookIntegrationName: test\n alarmWebhookIsAtAll: false\n alarmWebhookAtUsers:\n - xxxxxxxxx\n alarmWebhookAtGroups:\n - xxxxxxxxx\n has_next: true\n has_end_node: true\n - rule_node: '{\"Type\":\"Operation\",\"Value\":[\"AND\"],\"Children\":[{\"Type\":\"Operation\",\"Value\":[\"OR\"],\"Children\":[{\"Type\":\"Operation\",\"Value\":[\"AND\"],\"Children\":[{\"Type\":\"Condition\",\"Value\":[\"Severity\",\"in\",\"[\\\"notice\\\"]\"]},{\"Type\":\"Condition\",\"Value\":[\"Alarm\",\"in\",\"[\\\"test1\\\"]\"]}]},{\"Type\":\"Condition\",\"Value\":[\"AlarmID\",\"in\",\"[\\\"66fff5a0-af57-43d1-a40d-f2d32605aa61\\\"]\"]}]},{\"Type\":\"Operation\",\"Value\":[\"AND\"],\"Children\":[{\"Type\":\"Condition\",\"Value\":[\"Duration\",\"==\",\"5\"]},{\"Type\":\"Condition\",\"Value\":[\"NotifyTime\",\"in\",\"[\\\"1776653008\\\",\\\"1776998606\\\"]\"]}]}]}'\n receiver_infos:\n - receiverType: User\n receiverNames:\n - xxxxxxxxx\n - xxxxxxxxx\n receiverChannels:\n - Email\n - Sms\n - Phone\n startTime: 00:00:00\n endTime: 23:59:59\n generalWebhookUrl: \"\"\n generalWebhookMethod: \"\"\n generalWebhookHeaders:\n - key: Content-Type\n value: application/json\n - key: env\n value: test\n generalWebhookBody: \"\"\n alarmContentTemplateId: default-template\n alarmWebhookIntegrationId: aa6d01cd-5cf4-449d-a944-xxxxxxxxx\n alarmWebhookIntegrationName: test\n alarmWebhookIsAtAll: false\n alarmWebhookAtUsers:\n - xxxxxxxxx\n - xxxxxxxxx\n alarmWebhookAtGroups:\n - xxxxxxxxx\n - receiverType: UserGroup\n receiverNames:\n - xxxxxxxxx\n - xxxxxxxxx\n receiverChannels:\n - Email\n - Sms\n - Phone\n startTime: 00:00:00\n endTime: 23:59:59\n generalWebhookUrl: \"\"\n generalWebhookMethod: \"\"\n generalWebhookHeaders:\n - key: Content-Type\n value: application/json\n generalWebhookBody: \"\"\n alarmContentTemplateId: default-template\n alarmWebhookIntegrationId: aa6d01cd-5cf4-449d-a944-xxxxxxxxx\n alarmWebhookIntegrationName: test\n alarmWebhookIsAtAll: false\n alarmWebhookAtUsers:\n - xxxxxxxxx\n - xxxxxxxxx\n alarmWebhookAtGroups:\n - xxxxxxxxx\n - receiverType: User\n receiverNames:\n - xxxxxxxxx\n - xxxxxxxxx\n receiverChannels:\n - Lark\n startTime: 00:00:00\n endTime: 23:59:59\n generalWebhookUrl: \"\"\n generalWebhookMethod: \"\"\n generalWebhookHeaders:\n - key: Content-Type\n value: application/json\n generalWebhookBody: \"\"\n alarmContentTemplateId: default-template\n alarmWebhookIntegrationId: abc47ee4-9ad3-4c25-803f-xxxxxxxxx\n alarmWebhookIntegrationName: 飞书test\n alarmWebhookIsAtAll: false\n alarmWebhookAtUsers:\n - xxxxxxxxx\n - xxxxxxxxx\n alarmWebhookAtGroups:\n - xxxxxxxxx\n - receiverType: User\n receiverNames:\n - xxxxxxxxx\n - xxxxxxxxx\n receiverChannels:\n - DingTalk\n startTime: 00:00:00\n endTime: 23:59:59\n generalWebhookUrl: \"\"\n generalWebhookMethod: \"\"\n generalWebhookHeaders:\n - key: Content-Type\n value: application/json\n generalWebhookBody: \"\"\n alarmContentTemplateId: default-template\n alarmWebhookIntegrationId: 3eaaef0a-134a-4d62-bf48-xxxxxxxxx\n alarmWebhookIntegrationName: 钉钉test\n alarmWebhookIsAtAll: false\n alarmWebhookAtUsers:\n - xxxxxxxxx\n - xxxxxxxxx\n alarmWebhookAtGroups:\n - xxxxxxxxx\n - receiverType: User\n receiverNames:\n - xxxxxxxxx\n - xxxxxxxxx\n receiverChannels:\n - WeChat\n startTime: 00:00:00\n endTime: 23:59:59\n generalWebhookUrl: \"\"\n generalWebhookMethod: \"\"\n generalWebhookHeaders:\n - key: Content-Type\n value: application/json\n generalWebhookBody: \"\"\n alarmContentTemplateId: default-template\n alarmWebhookIntegrationId: c0454fd5-6597-4fc9-ad53-xxxxxxxxx\n alarmWebhookIntegrationName: 企业微信test\n alarmWebhookIsAtAll: false\n alarmWebhookAtUsers:\n - xxxxxxxxx\n - xxxxxxxxx\n alarmWebhookAtGroups:\n - xxxxxxxxx\n has_next: false\n has_end_node: false\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tls/alarmNotifyGroup:AlarmNotifyGroup example \"alarm_notify_group_id\"\n```\n\n", "properties": { "alarmNotifyGroupId": { "type": "string", "description": "Alarm notification group ID.\n" }, "alarmNotifyGroupName": { "type": "string", "description": "Alarm notification group name. Refer to the resource naming rules.\n" }, "createdTime": { "type": "string", "description": "Time when the alarm notification group was created.\n" }, "iamProjectName": { "type": "string", "description": "Name of the IAM project to which the alarm group belongs. If not specified, the logging service adds the alarm group to the IAM project named default.\n" }, "noticeRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/AlarmNotifyGroupNoticeRule:AlarmNotifyGroupNoticeRule" } }, "notifyTypes": { "type": "array", "items": { "type": "string" }, "description": "Type of alarm notification. Trigger: alarm triggered. Recovery: alarm recovered.\n" }, "receivers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/AlarmNotifyGroupReceiver:AlarmNotifyGroupReceiver" } }, "updatedTime": { "type": "string", "description": "Time when the alarm notification group was modified.\n" } }, "required": [ "alarmNotifyGroupId", "alarmNotifyGroupName", "createdTime", "iamProjectName", "noticeRules", "notifyTypes", "receivers", "updatedTime" ], "inputProperties": { "alarmNotifyGroupName": { "type": "string", "description": "Alarm notification group name. Refer to the resource naming rules.\n" }, "iamProjectName": { "type": "string", "description": "Name of the IAM project to which the alarm group belongs. If not specified, the logging service adds the alarm group to the IAM project named default.\n" }, "noticeRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/AlarmNotifyGroupNoticeRule:AlarmNotifyGroupNoticeRule" } }, "notifyTypes": { "type": "array", "items": { "type": "string" }, "description": "Type of alarm notification. Trigger: alarm triggered. Recovery: alarm recovered.\n" }, "receivers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/AlarmNotifyGroupReceiver:AlarmNotifyGroupReceiver" } } }, "requiredInputs": [ "alarmNotifyGroupName" ], "stateInputs": { "description": "Input properties used for looking up and filtering AlarmNotifyGroup resources.\n", "properties": { "alarmNotifyGroupId": { "type": "string", "description": "Alarm notification group ID.\n" }, "alarmNotifyGroupName": { "type": "string", "description": "Alarm notification group name. Refer to the resource naming rules.\n" }, "createdTime": { "type": "string", "description": "Time when the alarm notification group was created.\n" }, "iamProjectName": { "type": "string", "description": "Name of the IAM project to which the alarm group belongs. If not specified, the logging service adds the alarm group to the IAM project named default.\n" }, "noticeRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/AlarmNotifyGroupNoticeRule:AlarmNotifyGroupNoticeRule" } }, "notifyTypes": { "type": "array", "items": { "type": "string" }, "description": "Type of alarm notification. Trigger: alarm triggered. Recovery: alarm recovered.\n" }, "receivers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/AlarmNotifyGroupReceiver:AlarmNotifyGroupReceiver" } }, "updatedTime": { "type": "string", "description": "Time when the alarm notification group was modified.\n" } }, "type": "object" } }, "volcenginecc:tls/consumerGroup:ConsumerGroup": { "description": "A virtual collection of multiple consumers. When consuming log data at the consumer group level, all consumers in the group subscribe to the same log topic and jointly consume data from that log topic. Each consumer consumes data from one or more Shards in the log topic, and there is no duplicate consumption of data among consumers.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst tLSConsumerGroupDemo = new volcenginecc.tls.ConsumerGroup(\"TLSConsumerGroupDemo\", {\n projectId: \"c6fef4c1-041f-43*****\",\n topicIdLists: [\"bead2d9c*****\"],\n consumerGroupName: \"test-gruopname\",\n heartbeatTtl: 10,\n orderedConsume: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nt_ls_consumer_group_demo = volcenginecc.tls.ConsumerGroup(\"TLSConsumerGroupDemo\",\n project_id=\"c6fef4c1-041f-43*****\",\n topic_id_lists=[\"bead2d9c*****\"],\n consumer_group_name=\"test-gruopname\",\n heartbeat_ttl=10,\n ordered_consume=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var tLSConsumerGroupDemo = new Volcenginecc.Tls.ConsumerGroup(\"TLSConsumerGroupDemo\", new()\n {\n ProjectId = \"c6fef4c1-041f-43*****\",\n TopicIdLists = new[]\n {\n \"bead2d9c*****\",\n },\n ConsumerGroupName = \"test-gruopname\",\n HeartbeatTtl = 10,\n OrderedConsume = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/tls\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := tls.NewConsumerGroup(ctx, \"TLSConsumerGroupDemo\", \u0026tls.ConsumerGroupArgs{\n\t\t\tProjectId: pulumi.String(\"c6fef4c1-041f-43*****\"),\n\t\t\tTopicIdLists: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"bead2d9c*****\"),\n\t\t\t},\n\t\t\tConsumerGroupName: pulumi.String(\"test-gruopname\"),\n\t\t\tHeartbeatTtl: pulumi.Int(10),\n\t\t\tOrderedConsume: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.tls.ConsumerGroup;\nimport com.volcengine.volcenginecc.tls.ConsumerGroupArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var tLSConsumerGroupDemo = new ConsumerGroup(\"tLSConsumerGroupDemo\", ConsumerGroupArgs.builder()\n .projectId(\"c6fef4c1-041f-43*****\")\n .topicIdLists(\"bead2d9c*****\")\n .consumerGroupName(\"test-gruopname\")\n .heartbeatTtl(10)\n .orderedConsume(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n tLSConsumerGroupDemo:\n type: volcenginecc:tls:ConsumerGroup\n name: TLSConsumerGroupDemo\n properties:\n projectId: c6fef4c1-041f-43*****\n topicIdLists:\n - bead2d9c*****\n consumerGroupName: test-gruopname\n heartbeatTtl: 10\n orderedConsume: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tls/consumerGroup:ConsumerGroup example \"project_id|consumer_group_name\"\n```\n\n", "properties": { "consumerGroupName": { "type": "string", "description": "Consumer group name.\n" }, "heartbeatTtl": { "type": "integer", "description": "Heartbeat timeout in seconds. Value range: 1~300.\n" }, "orderedConsume": { "type": "boolean", "description": "Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.\n" }, "projectId": { "type": "string", "description": "ID of the log project to which the consumer group belongs.\n" }, "projectName": { "type": "string", "description": "Name of the log project to which the consumer group belongs.\n" }, "topicIdLists": { "type": "array", "items": { "type": "string" }, "description": "List of log topic IDs to be consumed by the consumer group.\n" } }, "required": [ "consumerGroupName", "heartbeatTtl", "orderedConsume", "projectId", "projectName", "topicIdLists" ], "inputProperties": { "consumerGroupName": { "type": "string", "description": "Consumer group name.\n" }, "heartbeatTtl": { "type": "integer", "description": "Heartbeat timeout in seconds. Value range: 1~300.\n" }, "orderedConsume": { "type": "boolean", "description": "Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.\n" }, "projectId": { "type": "string", "description": "ID of the log project to which the consumer group belongs.\n" }, "topicIdLists": { "type": "array", "items": { "type": "string" }, "description": "List of log topic IDs to be consumed by the consumer group.\n" } }, "requiredInputs": [ "consumerGroupName", "heartbeatTtl", "orderedConsume", "projectId", "topicIdLists" ], "stateInputs": { "description": "Input properties used for looking up and filtering ConsumerGroup resources.\n", "properties": { "consumerGroupName": { "type": "string", "description": "Consumer group name.\n" }, "heartbeatTtl": { "type": "integer", "description": "Heartbeat timeout in seconds. Value range: 1~300.\n" }, "orderedConsume": { "type": "boolean", "description": "Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.\n" }, "projectId": { "type": "string", "description": "ID of the log project to which the consumer group belongs.\n" }, "projectName": { "type": "string", "description": "Name of the log project to which the consumer group belongs.\n" }, "topicIdLists": { "type": "array", "items": { "type": "string" }, "description": "List of log topic IDs to be consumed by the consumer group.\n" } }, "type": "object" } }, "volcenginecc:tls/importTask:ImportTask": { "description": "Log Service supports data import, allowing you to structure data stored in sources such as TOS and Kafka and save it in Log Service\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n tLSImportTaskDemo:\n type: volcenginecc:tls:ImportTask\n name: TLSImportTaskDemo\n properties:\n description: ccapi-test-kafka\n importSourceInfo:\n kafka_source_info:\n host: kafka-cnngsl83xxxxx.kafka.cn-beijing.ivolces.com:9092\n group: group1\n topic: topic1\n encode: UTF-8\n password: \"\"\n protocol: \"\"\n username: \"\"\n mechanism: \"\"\n instanceId: kafka-cnngsl83e6xxxxx\n isNeedAuth: false\n initialOffset: 0\n timeSourceDefault: 1\n projectId: 4f1af9e7-34af-4ce5-866e-xxxxxxx\n sourceType: kafka\n targetInfo:\n region: cn-beijing\n log_type: json_log\n log_sample: \"\"\n extract_rule:\n extractRule:\n beginRegex: \"\"\n delimiter: \"\"\n logRegex: \"\"\n logTemplate:\n format: \"\"\n type: \"\"\n quote: \"\"\n timeFormat: '%Y-%m-%d %H:%M:%S,%f'\n timeKey: time\n timeSample: \"\"\n unMatchLogKey: LogParseFailed\n unMatchUpLoadSwitch: true\n filterKeyRegex:\n - key: user_id\n regex: ^[0-9]+$\n skipLineCount: 0\n timeExtractRegex: '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'\n timeZone: Asia/Shanghai\n taskName: ccapi-test-kafka-1001\n topicId: b75fffd8-1986-460c-9cca-xxxxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tls/importTask:ImportTask example \"task_id\"\n```\n\n", "properties": { "createTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Task description.\n" }, "importSourceInfo": { "$ref": "#/types/volcenginecc:tls/ImportTaskImportSourceInfo:ImportTaskImportSourceInfo", "description": "Import data source information\n" }, "projectId": { "type": "string", "description": "Log project ID for storing data.\n" }, "projectName": { "type": "string", "description": "Log project name.\n" }, "sourceType": { "type": "string", "description": "Data source type. Options: tos, kafka.\n" }, "status": { "type": "integer", "description": "Status of the data import task. 0: Importing. 1: Import completed. 2: Import error. 3: Stopping. 4: Stopped. 5: Restarting\n" }, "targetInfo": { "$ref": "#/types/volcenginecc:tls/ImportTaskTargetInfo:ImportTaskTargetInfo", "description": "Output information for the data import task.\n" }, "taskId": { "type": "string", "description": "Import task ID.\n" }, "taskName": { "type": "string", "description": "Import task name\n" }, "taskStatistics": { "$ref": "#/types/volcenginecc:tls/ImportTaskTaskStatistics:ImportTaskTaskStatistics", "description": "Progress of the data import task.\n" }, "topicId": { "type": "string", "description": "Log topic ID used to store data\n" }, "topicName": { "type": "string", "description": "Log topic name.\n" } }, "required": [ "createTime", "description", "importSourceInfo", "projectId", "projectName", "sourceType", "status", "targetInfo", "taskId", "taskName", "taskStatistics", "topicId", "topicName" ], "inputProperties": { "description": { "type": "string", "description": "Task description.\n" }, "importSourceInfo": { "$ref": "#/types/volcenginecc:tls/ImportTaskImportSourceInfo:ImportTaskImportSourceInfo", "description": "Import data source information\n" }, "projectId": { "type": "string", "description": "Log project ID for storing data.\n" }, "sourceType": { "type": "string", "description": "Data source type. Options: tos, kafka.\n" }, "status": { "type": "integer", "description": "Status of the data import task. 0: Importing. 1: Import completed. 2: Import error. 3: Stopping. 4: Stopped. 5: Restarting\n" }, "targetInfo": { "$ref": "#/types/volcenginecc:tls/ImportTaskTargetInfo:ImportTaskTargetInfo", "description": "Output information for the data import task.\n" }, "taskName": { "type": "string", "description": "Import task name\n" }, "topicId": { "type": "string", "description": "Log topic ID used to store data\n" } }, "requiredInputs": [ "importSourceInfo", "sourceType", "targetInfo", "taskName", "topicId" ], "stateInputs": { "description": "Input properties used for looking up and filtering ImportTask resources.\n", "properties": { "createTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Task description.\n" }, "importSourceInfo": { "$ref": "#/types/volcenginecc:tls/ImportTaskImportSourceInfo:ImportTaskImportSourceInfo", "description": "Import data source information\n" }, "projectId": { "type": "string", "description": "Log project ID for storing data.\n" }, "projectName": { "type": "string", "description": "Log project name.\n" }, "sourceType": { "type": "string", "description": "Data source type. Options: tos, kafka.\n" }, "status": { "type": "integer", "description": "Status of the data import task. 0: Importing. 1: Import completed. 2: Import error. 3: Stopping. 4: Stopped. 5: Restarting\n" }, "targetInfo": { "$ref": "#/types/volcenginecc:tls/ImportTaskTargetInfo:ImportTaskTargetInfo", "description": "Output information for the data import task.\n" }, "taskId": { "type": "string", "description": "Import task ID.\n" }, "taskName": { "type": "string", "description": "Import task name\n" }, "taskStatistics": { "$ref": "#/types/volcenginecc:tls/ImportTaskTaskStatistics:ImportTaskTaskStatistics", "description": "Progress of the data import task.\n" }, "topicId": { "type": "string", "description": "Log topic ID used to store data\n" }, "topicName": { "type": "string", "description": "Log topic name.\n" } }, "type": "object" } }, "volcenginecc:tls/index:Index": { "description": "The log service supports log search and analysis. You must configure indexes to enable log search and analysis. When configuring indexes, specify the index type and the data type for each field. The index configuration determines the search method and the precision of search results.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n tLSIndexDemo:\n type: volcenginecc:tls:Index\n name: TLSIndexDemo\n properties:\n enableAutoIndex: true\n fullText:\n case_sensitive: true\n delimiter:\n fn::invoke:\n function: std:chomp\n arguments:\n input: |\n , '\";$#!=()[]{}?@\u0026\u003c\u003e/:\\n\\t\\r\\\\%*+-._^`|~QWE\n return: result\n include_chinese: true\n keyValues:\n - key: a\n value:\n autoIndexFlag: false\n caseSensitive: true\n delimiter:\n fn::invoke:\n function: std:chomp\n arguments:\n input: |\n , '\";$#!=()[]{}?@\u0026\u003c\u003e/:\\n\\t\\r\\\\%*+-._^`|~QWE\n return: result\n includeChinese: true\n indexAll: false\n sqlFlag: true\n valueType: text\n indexSqlAll: false\n - key: b\n value:\n autoIndexFlag: false\n caseSensitive: false\n delimiter: \"\"\n includeChinese: false\n indexAll: false\n sqlFlag: true\n valueType: long\n indexSqlAll: false\n - key: c\n value:\n autoIndexFlag: false\n caseSensitive: false\n delimiter: \"\"\n includeChinese: false\n indexAll: false\n sqlFlag: true\n valueType: double\n indexSqlAll: false\n - key: d\n value:\n autoIndexFlag: false\n caseSensitive: true\n delimiter:\n fn::invoke:\n function: std:chomp\n arguments:\n input: |\n , '\";$#!=()[]{}?@\u0026\u003c\u003e/:\\n\\t\\r\\\\%*+-._^`|~QWE\n return: result\n includeChinese: true\n indexAll: false\n indexSqlAll: true\n jsonKeys:\n - key: d1\n value:\n indexAll: false\n sqlFlag: true\n valueType: text\n indexSqlAll: false\n - key: d2\n value:\n indexAll: false\n sqlFlag: true\n valueType: long\n indexSqlAll: false\n - key: d3\n value:\n indexAll: false\n sqlFlag: true\n valueType: double\n indexSqlAll: false\n sqlFlag: true\n valueType: json\n - key: e\n value:\n autoIndexFlag: false\n caseSensitive: true\n delimiter:\n fn::invoke:\n function: std:chomp\n arguments:\n input: |\n , '\";$#!=()[]{}?@\u0026\u003c\u003e/:\\n\\t\\r\\\\%*+-._^`|~QWE\n return: result\n includeChinese: true\n indexAll: true\n indexSqlAll: false\n jsonKeys:\n - key: e1\n value:\n indexAll: false\n sqlFlag: true\n valueType: text\n indexSqlAll: false\n sqlFlag: true\n valueType: json\n maxTextLen: 20480\n topicId: 7126b1fb-b68a-47a5-8c99-1a226601ed1a\n userInnerKeyValues:\n - key: __content__\n value:\n autoIndexFlag: false\n caseSensitive: true\n delimiter:\n fn::invoke:\n function: std:chomp\n arguments:\n input: |\n , '\";$#!=()[]{}?@\u0026\u003c\u003e/:\\n\\t\\r\\\\%*+-._^`|~QWE\n return: result\n includeChinese: true\n indexAll: true\n indexSqlAll: false\n jsonKeys:\n - key: f1\n value:\n indexAll: false\n sqlFlag: true\n valueType: text\n indexSqlAll: false\n - key: f2\n value:\n indexAll: false\n sqlFlag: true\n valueType: long\n indexSqlAll: false\n - key: f3\n value:\n indexAll: false\n sqlFlag: true\n valueType: double\n indexSqlAll: false\n sqlFlag: true\n valueType: json\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tls/index:Index example \"topic_id\"\n```\n\n", "properties": { "createTime": { "type": "string", "description": "Index creation time.\n" }, "enableAutoIndex": { "type": "boolean", "description": "Enable automatic index updates? When enabled, the system will automatically add newly detected fields to the key-value index. true: Enable automatic updates. false: Do not enable automatic updates.\n" }, "fullText": { "$ref": "#/types/volcenginecc:tls/IndexFullText:IndexFullText", "description": "Full-text index configuration. If this field is null or not configured, full-text indexing is disabled. At least one of full-text index or key-value index must be configured; that is, at least one parameter between FullText and KeyValue must be specified.\n" }, "keyValues": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/IndexKeyValue:IndexKeyValue" } }, "maxTextLen": { "type": "integer", "description": "Set the maximum length for field values. The default is 2048. The valid range is 64–16384 bytes. If a single field value exceeds the specified maximum length, the excess part will be truncated and excluded from analysis. After updating the maximum field length, only incremental data is affected.\n" }, "modifyTime": { "type": "string", "description": "Last modified time of the index.\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" }, "userInnerKeyValues": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/IndexUserInnerKeyValue:IndexUserInnerKeyValue" } } }, "required": [ "createTime", "enableAutoIndex", "fullText", "keyValues", "maxTextLen", "modifyTime", "topicId", "userInnerKeyValues" ], "inputProperties": { "enableAutoIndex": { "type": "boolean", "description": "Enable automatic index updates? When enabled, the system will automatically add newly detected fields to the key-value index. true: Enable automatic updates. false: Do not enable automatic updates.\n" }, "fullText": { "$ref": "#/types/volcenginecc:tls/IndexFullText:IndexFullText", "description": "Full-text index configuration. If this field is null or not configured, full-text indexing is disabled. At least one of full-text index or key-value index must be configured; that is, at least one parameter between FullText and KeyValue must be specified.\n" }, "keyValues": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/IndexKeyValue:IndexKeyValue" } }, "maxTextLen": { "type": "integer", "description": "Set the maximum length for field values. The default is 2048. The valid range is 64–16384 bytes. If a single field value exceeds the specified maximum length, the excess part will be truncated and excluded from analysis. After updating the maximum field length, only incremental data is affected.\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" }, "userInnerKeyValues": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/IndexUserInnerKeyValue:IndexUserInnerKeyValue" } } }, "requiredInputs": [ "topicId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Index resources.\n", "properties": { "createTime": { "type": "string", "description": "Index creation time.\n" }, "enableAutoIndex": { "type": "boolean", "description": "Enable automatic index updates? When enabled, the system will automatically add newly detected fields to the key-value index. true: Enable automatic updates. false: Do not enable automatic updates.\n" }, "fullText": { "$ref": "#/types/volcenginecc:tls/IndexFullText:IndexFullText", "description": "Full-text index configuration. If this field is null or not configured, full-text indexing is disabled. At least one of full-text index or key-value index must be configured; that is, at least one parameter between FullText and KeyValue must be specified.\n" }, "keyValues": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/IndexKeyValue:IndexKeyValue" } }, "maxTextLen": { "type": "integer", "description": "Set the maximum length for field values. The default is 2048. The valid range is 64–16384 bytes. If a single field value exceeds the specified maximum length, the excess part will be truncated and excluded from analysis. After updating the maximum field length, only incremental data is affected.\n" }, "modifyTime": { "type": "string", "description": "Last modified time of the index.\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" }, "userInnerKeyValues": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/IndexUserInnerKeyValue:IndexUserInnerKeyValue" } } }, "type": "object" } }, "volcenginecc:tls/project:Project": { "description": "A log project is a data management unit used for tenant resource isolation and control. Typically, each log project corresponds to an application, service, or product\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst tLSProjectDemo = new volcenginecc.tls.Project(\"TLSProjectDemo\", {\n projectName: \"ccapi_test\",\n description: \"ccapi_test\",\n iamProjectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nt_ls_project_demo = volcenginecc.tls.Project(\"TLSProjectDemo\",\n project_name=\"ccapi_test\",\n description=\"ccapi_test\",\n iam_project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var tLSProjectDemo = new Volcenginecc.Tls.Project(\"TLSProjectDemo\", new()\n {\n ProjectName = \"ccapi_test\",\n Description = \"ccapi_test\",\n IamProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Tls.Inputs.ProjectTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/tls\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := tls.NewProject(ctx, \"TLSProjectDemo\", \u0026tls.ProjectArgs{\n\t\t\tProjectName: pulumi.String(\"ccapi_test\"),\n\t\t\tDescription: pulumi.String(\"ccapi_test\"),\n\t\t\tIamProjectName: pulumi.String(\"default\"),\n\t\t\tTags: tls.ProjectTagArray{\n\t\t\t\t\u0026tls.ProjectTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.tls.Project;\nimport com.volcengine.volcenginecc.tls.ProjectArgs;\nimport com.pulumi.volcenginecc.tls.inputs.ProjectTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var tLSProjectDemo = new Project(\"tLSProjectDemo\", ProjectArgs.builder()\n .projectName(\"ccapi_test\")\n .description(\"ccapi_test\")\n .iamProjectName(\"default\")\n .tags(ProjectTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n tLSProjectDemo:\n type: volcenginecc:tls:Project\n name: TLSProjectDemo\n properties:\n projectName: ccapi_test\n description: ccapi_test\n iamProjectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tls/project:Project example \"project_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Log project creation time\n" }, "description": { "type": "string", "description": "Brief description of the log project\n" }, "iamProjectName": { "type": "string", "description": "The IAM project associated with the log project\n" }, "innerNetDomain": { "type": "string", "description": "Private network connection domain name\n" }, "projectId": { "type": "string", "description": "Log project ID\n" }, "projectName": { "type": "string", "description": "Log project name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/ProjectTag:ProjectTag" } }, "topicCount": { "type": "integer", "description": "Number of log topics in the current log project\n" } }, "required": [ "createdTime", "description", "iamProjectName", "innerNetDomain", "projectId", "projectName", "tags", "topicCount" ], "inputProperties": { "description": { "type": "string", "description": "Brief description of the log project\n" }, "iamProjectName": { "type": "string", "description": "The IAM project associated with the log project\n" }, "projectName": { "type": "string", "description": "Log project name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/ProjectTag:ProjectTag" } } }, "requiredInputs": [ "projectName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Project resources.\n", "properties": { "createdTime": { "type": "string", "description": "Log project creation time\n" }, "description": { "type": "string", "description": "Brief description of the log project\n" }, "iamProjectName": { "type": "string", "description": "The IAM project associated with the log project\n" }, "innerNetDomain": { "type": "string", "description": "Private network connection domain name\n" }, "projectId": { "type": "string", "description": "Log project ID\n" }, "projectName": { "type": "string", "description": "Log project name\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/ProjectTag:ProjectTag" } }, "topicCount": { "type": "integer", "description": "Number of log topics in the current log project\n" } }, "type": "object" } }, "volcenginecc:tls/rule:Rule": { "description": "The log service provides log collection tools such as LogCollector and multi-language SDKs, supports various log collection methods, is compatible with open-source protocol frameworks like Kafka and OpenTelemetry, and supports log data collection from host applications, K8s clusters, mobile clients, Volcano Engine cloud products, and other cloud vendors.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n tLSRuleDemo:\n type: volcenginecc:tls:Rule\n name: TLSRuleDemo\n properties:\n containerRule:\n container_name_regex: ccapi-test\n env_tag:\n - key: k1\n val: v1\n exclude_container_env_regex:\n - key: k2\n val: v2\n exclude_container_label_regex:\n - key: k2\n val: v2\n include_container_env_regex:\n - key: k1\n val: v1\n include_container_label_regex:\n - key: k1\n val: v1\n kubernetes_rule:\n annotationTag:\n - key: k1\n val: v1\n enableAllLabelTag: true\n excludePodAnnotationRegex:\n - key: k2\n val: v2\n excludePodLabelRegex:\n - key: k2\n val: v2\n includePodAnnotationRegex:\n - key: k1\n val: v1\n includePodLabelRegex:\n - key: k1\n val: v1\n labelTag:\n - key: k1\n val: v1\n namespaceNameRegex: ccapi\n podNameRegex: ccapi\n workloadNameRegex: ccapi\n workloadType: Deployment\n stream: \"\"\n excludePaths:\n - type: Path\n value: /test\n extractRule:\n begin_regex: \"\"\n delimiter: ' '\n enable_nanosecond: true\n filter_key_regex:\n - key: k1\n regex: v1\n keys:\n - k1\n log_regex: \"\"\n log_template:\n format: \"\"\n type: \"\"\n quote: \"\"\n time_extract_regex: dsfasdf\n time_format: '%Y-%m-%d %H:%M:%S.%f'\n time_key: time_key\n time_sample: 2006-01-02T15:04:05Z07:00\n time_zone: Etc/GMT+12\n un_match_log_key: LogParseFailed\n un_match_up_load_switch: true\n hostGroupInfos:\n - host_group_id: 38feb3b9-xxxxx-de52cxxxxx\n inputType: 2\n logSample: asdfasf\n logType: delimiter_log\n paths:\n - /test\n ruleName: dx-rule-1\n topicId: b881e3cd-xxxxx-966f-fe98xxxxxxx\n userDefineRule:\n advanced:\n closeEof: false\n closeInactive: 10\n closeRemoved: false\n closeRenamed: false\n closeTimeout: 0\n noLineTerminatorEofMaxTime: 0\n enable_host_group_label: true\n enable_hostname: true\n enable_raw_log: true\n fields:\n - key: k1\n val: v1\n host_group_label_key: host_group_label\n hostname_key: hostname\n ignore_older: 72\n multi_collects_type: RuleID\n parse_path_rule:\n keys:\n - instance-id\n - pod-name\n pathSample: /var/logs/instanceid_any_podname/test.log\n regex: /var/logs/([a-z]*)_any_([a-z]*)/test.log\n plugin:\n processors: '{}'\n raw_log_key: raw\n shard_hash_key:\n hashKey: '2342134'\n tail_files: true\n tail_size_kb: 10240\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tls/rule:Rule example \"rule_id\"\n```\n\n", "properties": { "containerRule": { "$ref": "#/types/volcenginecc:tls/RuleContainerRule:RuleContainerRule", "description": "Container log collection rules.\n" }, "createTime": { "type": "string", "description": "Time when the collection configuration was created.\n" }, "excludePaths": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleExcludePath:RuleExcludePath" } }, "extractRule": { "$ref": "#/types/volcenginecc:tls/RuleExtractRule:RuleExtractRule", "description": "Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalist*log or json*log.\n" }, "hostGroupInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleHostGroupInfo:RuleHostGroupInfo" } }, "inputType": { "type": "integer", "description": "Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.\n" }, "logSample": { "type": "string", "description": "Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.\n" }, "logType": { "type": "string", "description": "Collection mode. minimalist*log: (Default) Single-line full-text mode. json*log: JSON mode. delimiter*log: Delimiter mode. multiline*log: Multi-line full-text mode. fullregex_log: Full regex mode.\n" }, "modifyTime": { "type": "string", "description": "Collection configuration modification time.\n" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.\n" }, "pause": { "type": "integer", "description": "Collection configuration status. 0: Running. 1: Paused.\n" }, "projectId": { "type": "string", "description": "ID of the project to which the collection configuration belongs.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the collection configuration belongs\n" }, "ruleId": { "type": "string", "description": "Collection configuration ID.\n" }, "ruleName": { "type": "string", "description": "Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.\n" }, "topicId": { "type": "string", "description": "Log topic ID to which the collection configuration belongs.\n" }, "topicName": { "type": "string", "description": "Name of the log topic to which the collection configuration belongs.\n" }, "userDefineRule": { "$ref": "#/types/volcenginecc:tls/RuleUserDefineRule:RuleUserDefineRule", "description": "User-defined collection rules.\n" } }, "required": [ "containerRule", "createTime", "excludePaths", "extractRule", "hostGroupInfos", "inputType", "logSample", "logType", "modifyTime", "paths", "pause", "projectId", "projectName", "ruleId", "ruleName", "topicId", "topicName", "userDefineRule" ], "inputProperties": { "containerRule": { "$ref": "#/types/volcenginecc:tls/RuleContainerRule:RuleContainerRule", "description": "Container log collection rules.\n" }, "excludePaths": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleExcludePath:RuleExcludePath" } }, "extractRule": { "$ref": "#/types/volcenginecc:tls/RuleExtractRule:RuleExtractRule", "description": "Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalist*log or json*log.\n" }, "hostGroupInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleHostGroupInfo:RuleHostGroupInfo" } }, "inputType": { "type": "integer", "description": "Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.\n" }, "logSample": { "type": "string", "description": "Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.\n" }, "logType": { "type": "string", "description": "Collection mode. minimalist*log: (Default) Single-line full-text mode. json*log: JSON mode. delimiter*log: Delimiter mode. multiline*log: Multi-line full-text mode. fullregex_log: Full regex mode.\n" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.\n" }, "pause": { "type": "integer", "description": "Collection configuration status. 0: Running. 1: Paused.\n" }, "ruleName": { "type": "string", "description": "Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.\n" }, "topicId": { "type": "string", "description": "Log topic ID to which the collection configuration belongs.\n" }, "userDefineRule": { "$ref": "#/types/volcenginecc:tls/RuleUserDefineRule:RuleUserDefineRule", "description": "User-defined collection rules.\n" } }, "requiredInputs": [ "ruleName", "topicId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Rule resources.\n", "properties": { "containerRule": { "$ref": "#/types/volcenginecc:tls/RuleContainerRule:RuleContainerRule", "description": "Container log collection rules.\n" }, "createTime": { "type": "string", "description": "Time when the collection configuration was created.\n" }, "excludePaths": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleExcludePath:RuleExcludePath" } }, "extractRule": { "$ref": "#/types/volcenginecc:tls/RuleExtractRule:RuleExtractRule", "description": "Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalist*log or json*log.\n" }, "hostGroupInfos": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/RuleHostGroupInfo:RuleHostGroupInfo" } }, "inputType": { "type": "integer", "description": "Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.\n" }, "logSample": { "type": "string", "description": "Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.\n" }, "logType": { "type": "string", "description": "Collection mode. minimalist*log: (Default) Single-line full-text mode. json*log: JSON mode. delimiter*log: Delimiter mode. multiline*log: Multi-line full-text mode. fullregex_log: Full regex mode.\n" }, "modifyTime": { "type": "string", "description": "Collection configuration modification time.\n" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.\n" }, "pause": { "type": "integer", "description": "Collection configuration status. 0: Running. 1: Paused.\n" }, "projectId": { "type": "string", "description": "ID of the project to which the collection configuration belongs.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the collection configuration belongs\n" }, "ruleId": { "type": "string", "description": "Collection configuration ID.\n" }, "ruleName": { "type": "string", "description": "Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.\n" }, "topicId": { "type": "string", "description": "Log topic ID to which the collection configuration belongs.\n" }, "topicName": { "type": "string", "description": "Name of the log topic to which the collection configuration belongs.\n" }, "userDefineRule": { "$ref": "#/types/volcenginecc:tls/RuleUserDefineRule:RuleUserDefineRule", "description": "User-defined collection rules.\n" } }, "type": "object" } }, "volcenginecc:tls/scheduleSqlTask:ScheduleSqlTask": { "description": "Resource definition for the scheduled SQL analysis task.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n tLSScheduleSqlTaskDemo:\n type: volcenginecc:tls:ScheduleSqlTask\n name: TLSScheduleSqlTaskDemo\n properties:\n description: testdesc\n destRegion: cn-beijing\n destTopicId: 42fedbb3-2c2a-4822-bc30-9c5cc****\n processEndTime: 0\n processSqlDelay: 60\n taskType: 0\n processStartTime: 1.773072e+09\n processTimeWindow: '@m-15m,@m'\n query: '* | SELECT * limit 10'\n requestCycle:\n cron_tab: 0 19 * * *\n cron_time_zone: GMT+08:00\n time: 2\n type: Fixed\n sourceTopicId: 22fca26e-a776-4925-a3ca-a9bb6d***\n status: 1\n taskName: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tls/scheduleSqlTask:ScheduleSqlTask example \"task_id\"\n```\n\n", "properties": { "createdTime": { "type": "integer", "description": "Creation time (seconds-level Unix timestamp).\n" }, "description": { "type": "string", "description": "Brief description of the scheduled SQL analysis task. Characters \u003c\u003e, ', \\, and \\ are not supported. Length: 0–64 characters.\n" }, "destProjectId": { "type": "string", "description": "Target log project ID.\n" }, "destRegion": { "type": "string", "description": "Region of the target log topic. The default is the current region.\n" }, "destTopicId": { "type": "string", "description": "Target log topic ID for storing scheduled SQL analysis result data.\n" }, "destTopicName": { "type": "string", "description": "Target log topic name.\n" }, "processEndTime": { "type": "integer", "description": "End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.\n" }, "processSqlDelay": { "type": "integer", "description": "Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.\n" }, "processStartTime": { "type": "integer", "description": "Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.\n" }, "processTimeWindow": { "type": "string", "description": "SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.\n" }, "query": { "type": "string", "description": "The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.\n" }, "requestCycle": { "$ref": "#/types/volcenginecc:tls/ScheduleSqlTaskRequestCycle:ScheduleSqlTaskRequestCycle", "description": "Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.\n" }, "sourceProjectId": { "type": "string", "description": "Source log project ID.\n" }, "sourceProjectName": { "type": "string", "description": "Source log project name.\n" }, "sourceTopicId": { "type": "string", "description": "ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.\n" }, "sourceTopicName": { "type": "string", "description": "Source log topic name.\n" }, "status": { "type": "integer", "description": "Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.\n" }, "taskId": { "type": "string", "description": "Task ID.\n" }, "taskName": { "type": "string", "description": "Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.\n" }, "taskType": { "type": "integer", "description": "Task type: 0 means log to log; 1 means log to metric.\n" }, "updatedTime": { "type": "integer", "description": "Modification time (seconds-level Unix timestamp).\n" } }, "required": [ "createdTime", "description", "destProjectId", "destRegion", "destTopicId", "destTopicName", "processEndTime", "processSqlDelay", "processStartTime", "processTimeWindow", "query", "requestCycle", "sourceProjectId", "sourceProjectName", "sourceTopicId", "sourceTopicName", "status", "taskId", "taskName", "taskType", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Brief description of the scheduled SQL analysis task. Characters \u003c\u003e, ', \\, and \\ are not supported. Length: 0–64 characters.\n" }, "destRegion": { "type": "string", "description": "Region of the target log topic. The default is the current region.\n" }, "destTopicId": { "type": "string", "description": "Target log topic ID for storing scheduled SQL analysis result data.\n" }, "processEndTime": { "type": "integer", "description": "End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.\n" }, "processSqlDelay": { "type": "integer", "description": "Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.\n" }, "processStartTime": { "type": "integer", "description": "Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.\n" }, "processTimeWindow": { "type": "string", "description": "SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.\n" }, "query": { "type": "string", "description": "The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.\n" }, "requestCycle": { "$ref": "#/types/volcenginecc:tls/ScheduleSqlTaskRequestCycle:ScheduleSqlTaskRequestCycle", "description": "Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.\n" }, "sourceTopicId": { "type": "string", "description": "ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.\n" }, "status": { "type": "integer", "description": "Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.\n" }, "taskName": { "type": "string", "description": "Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.\n" }, "taskType": { "type": "integer", "description": "Task type: 0 means log to log; 1 means log to metric.\n" } }, "requiredInputs": [ "destTopicId", "processStartTime", "processTimeWindow", "query", "requestCycle", "sourceTopicId", "status", "taskName", "taskType" ], "stateInputs": { "description": "Input properties used for looking up and filtering ScheduleSqlTask resources.\n", "properties": { "createdTime": { "type": "integer", "description": "Creation time (seconds-level Unix timestamp).\n" }, "description": { "type": "string", "description": "Brief description of the scheduled SQL analysis task. Characters \u003c\u003e, ', \\, and \\ are not supported. Length: 0–64 characters.\n" }, "destProjectId": { "type": "string", "description": "Target log project ID.\n" }, "destRegion": { "type": "string", "description": "Region of the target log topic. The default is the current region.\n" }, "destTopicId": { "type": "string", "description": "Target log topic ID for storing scheduled SQL analysis result data.\n" }, "destTopicName": { "type": "string", "description": "Target log topic name.\n" }, "processEndTime": { "type": "integer", "description": "End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.\n" }, "processSqlDelay": { "type": "integer", "description": "Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.\n" }, "processStartTime": { "type": "integer", "description": "Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.\n" }, "processTimeWindow": { "type": "string", "description": "SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.\n" }, "query": { "type": "string", "description": "The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.\n" }, "requestCycle": { "$ref": "#/types/volcenginecc:tls/ScheduleSqlTaskRequestCycle:ScheduleSqlTaskRequestCycle", "description": "Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.\n" }, "sourceProjectId": { "type": "string", "description": "Source log project ID.\n" }, "sourceProjectName": { "type": "string", "description": "Source log project name.\n" }, "sourceTopicId": { "type": "string", "description": "ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.\n" }, "sourceTopicName": { "type": "string", "description": "Source log topic name.\n" }, "status": { "type": "integer", "description": "Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.\n" }, "taskId": { "type": "string", "description": "Task ID.\n" }, "taskName": { "type": "string", "description": "Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.\n" }, "taskType": { "type": "integer", "description": "Task type: 0 means log to log; 1 means log to metric.\n" }, "updatedTime": { "type": "integer", "description": "Modification time (seconds-level Unix timestamp).\n" } }, "type": "object" } }, "volcenginecc:tls/shipper:Shipper": { "description": "Log delivery refers to sending data collected by the log service to TOS or other products for scenarios such as long-term storage of infrequently accessed data, integration with other systems for consumption, or data analysis.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n tLSShipperDemo:\n type: volcenginecc:tls:Shipper\n name: TLSShipperDemo\n properties:\n contentInfo:\n format: json\n json_info:\n enable: true\n escape: true\n keys:\n - __content__\n - __source__\n - __path__\n - __time__\n - __time_ns_part__\n - __image_name__\n - __container_name__\n - __container_ip__\n - __container_source__\n - __pod_ip__\n - __pod_name__\n - __pod_uid__\n - __namespace__\n - __tag____client_ip__\n - __tag____receive_time__\n kafkaShipperInfo:\n compress: gzip\n end_time: 1.777538948e+12\n instance: kafka-cnngsl83xxxxxxxx\n kafka_topic: topic1\n shipperEndTime: 1.777538948e+12\n shipperName: ccapi-test-kaf-1001\n shipperType: kafka\n topicId: b75fffd8-1986-460c-9cca-5axxxxxxx\n status: false\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tls/shipper:Shipper example \"shipper_id\"\n```\n\n", "properties": { "contentInfo": { "$ref": "#/types/volcenginecc:tls/ShipperContentInfo:ShipperContentInfo", "description": "Log content delivery format configuration.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "dashboardId": { "type": "string", "description": "Default built-in dashboard ID for delivery.\n" }, "kafkaShipperInfo": { "$ref": "#/types/volcenginecc:tls/ShipperKafkaShipperInfo:ShipperKafkaShipperInfo", "description": "Kafka delivery configuration.\n" }, "projectId": { "type": "string", "description": "Log project ID.\n" }, "projectName": { "type": "string", "description": "Log project name.\n" }, "shipperEndTime": { "type": "integer", "description": "Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n" }, "shipperId": { "type": "string", "description": "Delivery configuration ID.\n" }, "shipperName": { "type": "string", "description": "Delivery configuration name, unique within a log project.\n" }, "shipperStartTime": { "type": "integer", "description": "Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n" }, "shipperType": { "type": "string", "description": "Type of data source for delivery. Options: tos, kafka. Default is tos.\n" }, "status": { "type": "boolean", "description": "Whether to enable delivery configuration. Default is true.\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" }, "topicName": { "type": "string", "description": "Log topic name.\n" }, "tosShipperInfo": { "$ref": "#/types/volcenginecc:tls/ShipperTosShipperInfo:ShipperTosShipperInfo", "description": "Information related to delivery to TOS object storage.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" } }, "required": [ "contentInfo", "createdTime", "dashboardId", "kafkaShipperInfo", "projectId", "projectName", "shipperEndTime", "shipperId", "shipperName", "shipperStartTime", "shipperType", "status", "topicId", "topicName", "tosShipperInfo", "updatedTime" ], "inputProperties": { "contentInfo": { "$ref": "#/types/volcenginecc:tls/ShipperContentInfo:ShipperContentInfo", "description": "Log content delivery format configuration.\n" }, "kafkaShipperInfo": { "$ref": "#/types/volcenginecc:tls/ShipperKafkaShipperInfo:ShipperKafkaShipperInfo", "description": "Kafka delivery configuration.\n" }, "shipperEndTime": { "type": "integer", "description": "Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n" }, "shipperName": { "type": "string", "description": "Delivery configuration name, unique within a log project.\n" }, "shipperStartTime": { "type": "integer", "description": "Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n" }, "shipperType": { "type": "string", "description": "Type of data source for delivery. Options: tos, kafka. Default is tos.\n" }, "status": { "type": "boolean", "description": "Whether to enable delivery configuration. Default is true.\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" }, "tosShipperInfo": { "$ref": "#/types/volcenginecc:tls/ShipperTosShipperInfo:ShipperTosShipperInfo", "description": "Information related to delivery to TOS object storage.\n" } }, "requiredInputs": [ "contentInfo", "shipperName", "topicId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Shipper resources.\n", "properties": { "contentInfo": { "$ref": "#/types/volcenginecc:tls/ShipperContentInfo:ShipperContentInfo", "description": "Log content delivery format configuration.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "dashboardId": { "type": "string", "description": "Default built-in dashboard ID for delivery.\n" }, "kafkaShipperInfo": { "$ref": "#/types/volcenginecc:tls/ShipperKafkaShipperInfo:ShipperKafkaShipperInfo", "description": "Kafka delivery configuration.\n" }, "projectId": { "type": "string", "description": "Log project ID.\n" }, "projectName": { "type": "string", "description": "Log project name.\n" }, "shipperEndTime": { "type": "integer", "description": "Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n" }, "shipperId": { "type": "string", "description": "Delivery configuration ID.\n" }, "shipperName": { "type": "string", "description": "Delivery configuration name, unique within a log project.\n" }, "shipperStartTime": { "type": "integer", "description": "Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n" }, "shipperType": { "type": "string", "description": "Type of data source for delivery. Options: tos, kafka. Default is tos.\n" }, "status": { "type": "boolean", "description": "Whether to enable delivery configuration. Default is true.\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" }, "topicName": { "type": "string", "description": "Log topic name.\n" }, "tosShipperInfo": { "$ref": "#/types/volcenginecc:tls/ShipperTosShipperInfo:ShipperTosShipperInfo", "description": "Information related to delivery to TOS object storage.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" } }, "type": "object" } }, "volcenginecc:tls/topic:Topic": { "description": "Log topic is the basic unit for log management in the log service. Log ingestion, search and analysis, and consumption are all performed at the log topic level.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst tlsTopicDemo = new volcenginecc.tls.Topic(\"TlsTopicDemo\", {\n ttl: 187,\n hotTtl: 8,\n coldTtl: 79,\n archiveTtl: 100,\n shardCount: 2,\n autoSplit: true,\n maxSplitShard: 256,\n tags: [{\n key: \"key1\",\n value: \"v1\",\n }],\n timeKey: \"time\",\n timeFormat: \"%Y-%m-%d %H:%M:%S\",\n logPublicIp: false,\n topicName: \"ccapi-test\",\n description: \"test\",\n projectId: \"c6fef4c1-041f-434e-b0f4-d5e9*****\",\n enableHotTtl: false,\n allowConsume: false,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ntls_topic_demo = volcenginecc.tls.Topic(\"TlsTopicDemo\",\n ttl=187,\n hot_ttl=8,\n cold_ttl=79,\n archive_ttl=100,\n shard_count=2,\n auto_split=True,\n max_split_shard=256,\n tags=[{\n \"key\": \"key1\",\n \"value\": \"v1\",\n }],\n time_key=\"time\",\n time_format=\"%Y-%m-%d %H:%M:%S\",\n log_public_ip=False,\n topic_name=\"ccapi-test\",\n description=\"test\",\n project_id=\"c6fef4c1-041f-434e-b0f4-d5e9*****\",\n enable_hot_ttl=False,\n allow_consume=False)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var tlsTopicDemo = new Volcenginecc.Tls.Topic(\"TlsTopicDemo\", new()\n {\n Ttl = 187,\n HotTtl = 8,\n ColdTtl = 79,\n ArchiveTtl = 100,\n ShardCount = 2,\n AutoSplit = true,\n MaxSplitShard = 256,\n Tags = new[]\n {\n new Volcenginecc.Tls.Inputs.TopicTagArgs\n {\n Key = \"key1\",\n Value = \"v1\",\n },\n },\n TimeKey = \"time\",\n TimeFormat = \"%Y-%m-%d %H:%M:%S\",\n LogPublicIp = false,\n TopicName = \"ccapi-test\",\n Description = \"test\",\n ProjectId = \"c6fef4c1-041f-434e-b0f4-d5e9*****\",\n EnableHotTtl = false,\n AllowConsume = false,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/tls\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := tls.NewTopic(ctx, \"TlsTopicDemo\", \u0026tls.TopicArgs{\n\t\t\tTtl: pulumi.Int(187),\n\t\t\tHotTtl: pulumi.Int(8),\n\t\t\tColdTtl: pulumi.Int(79),\n\t\t\tArchiveTtl: pulumi.Int(100),\n\t\t\tShardCount: pulumi.Int(2),\n\t\t\tAutoSplit: pulumi.Bool(true),\n\t\t\tMaxSplitShard: pulumi.Int(256),\n\t\t\tTags: tls.TopicTagArray{\n\t\t\t\t\u0026tls.TopicTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"key1\"),\n\t\t\t\t\tValue: pulumi.String(\"v1\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTimeKey: pulumi.String(\"time\"),\n\t\t\tTimeFormat: pulumi.String(\"%Y-%m-%d %H:%M:%S\"),\n\t\t\tLogPublicIp: pulumi.Bool(false),\n\t\t\tTopicName: pulumi.String(\"ccapi-test\"),\n\t\t\tDescription: pulumi.String(\"test\"),\n\t\t\tProjectId: pulumi.String(\"c6fef4c1-041f-434e-b0f4-d5e9*****\"),\n\t\t\tEnableHotTtl: pulumi.Bool(false),\n\t\t\tAllowConsume: pulumi.Bool(false),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.tls.Topic;\nimport com.volcengine.volcenginecc.tls.TopicArgs;\nimport com.pulumi.volcenginecc.tls.inputs.TopicTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var tlsTopicDemo = new Topic(\"tlsTopicDemo\", TopicArgs.builder()\n .ttl(187)\n .hotTtl(8)\n .coldTtl(79)\n .archiveTtl(100)\n .shardCount(2)\n .autoSplit(true)\n .maxSplitShard(256)\n .tags(TopicTagArgs.builder()\n .key(\"key1\")\n .value(\"v1\")\n .build())\n .timeKey(\"time\")\n .timeFormat(\"%Y-%m-%d %H:%M:%S\")\n .logPublicIp(false)\n .topicName(\"ccapi-test\")\n .description(\"test\")\n .projectId(\"c6fef4c1-041f-434e-b0f4-d5e9*****\")\n .enableHotTtl(false)\n .allowConsume(false)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n tlsTopicDemo:\n type: volcenginecc:tls:Topic\n name: TlsTopicDemo\n properties:\n ttl: 187\n hotTtl: 8\n coldTtl: 79\n archiveTtl: 100\n shardCount: 2\n autoSplit: true\n maxSplitShard: 256\n tags:\n - key: key1\n value: v1\n timeKey: time\n timeFormat: '%Y-%m-%d %H:%M:%S'\n logPublicIp: false\n topicName: ccapi-test\n description: test\n projectId: c6fef4c1-041f-434e-b0f4-d5e9*****\n enableHotTtl: false\n allowConsume: false\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tls/topic:Topic example \"topic_id\"\n```\n\n", "properties": { "allowConsume": { "type": "boolean", "description": "Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.\n" }, "archiveTtl": { "type": "integer", "description": "Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.\n" }, "autoSplit": { "type": "boolean", "description": "Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.\n" }, "coldTtl": { "type": "integer", "description": "Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.\n" }, "consumeTopic": { "type": "string", "description": "Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.\n" }, "createdTime": { "type": "string", "description": "Log topic creation time.\n" }, "description": { "type": "string", "description": "Log topic description. Does not support \u003c\u003e, ', \\, \\, or any emoji symbols. Length: 0–64 characters.\n" }, "enableHotTtl": { "type": "boolean", "description": "Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.\n" }, "enableTracking": { "type": "boolean", "description": "Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.\n" }, "hotTtl": { "type": "integer", "description": "Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.\n" }, "logPublicIp": { "type": "boolean", "description": "Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: **tag****client_ip**: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. **tag****receive_time**: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.\n" }, "maxSplitShard": { "type": "integer", "description": "Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.\n" }, "projectId": { "type": "string", "description": "Log project ID to which the log topic belongs.\n" }, "shardCount": { "type": "integer", "description": "Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/TopicTag:TopicTag" } }, "timeFormat": { "type": "string", "description": "Time format\n" }, "timeKey": { "type": "string", "description": "Time field name\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" }, "topicName": { "type": "string", "description": "Log topic name.\n" }, "ttl": { "type": "integer", "description": "Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.\n" }, "updatedTime": { "type": "string", "description": "Log topic modification time.\n" } }, "required": [ "allowConsume", "archiveTtl", "autoSplit", "coldTtl", "consumeTopic", "createdTime", "description", "enableHotTtl", "enableTracking", "hotTtl", "logPublicIp", "maxSplitShard", "projectId", "shardCount", "tags", "timeFormat", "timeKey", "topicId", "topicName", "ttl", "updatedTime" ], "inputProperties": { "allowConsume": { "type": "boolean", "description": "Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.\n" }, "archiveTtl": { "type": "integer", "description": "Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.\n" }, "autoSplit": { "type": "boolean", "description": "Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.\n" }, "coldTtl": { "type": "integer", "description": "Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.\n" }, "description": { "type": "string", "description": "Log topic description. Does not support \u003c\u003e, ', \\, \\, or any emoji symbols. Length: 0–64 characters.\n" }, "enableHotTtl": { "type": "boolean", "description": "Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.\n" }, "enableTracking": { "type": "boolean", "description": "Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.\n" }, "hotTtl": { "type": "integer", "description": "Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.\n" }, "logPublicIp": { "type": "boolean", "description": "Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: **tag****client_ip**: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. **tag****receive_time**: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.\n" }, "maxSplitShard": { "type": "integer", "description": "Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.\n" }, "projectId": { "type": "string", "description": "Log project ID to which the log topic belongs.\n" }, "shardCount": { "type": "integer", "description": "Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/TopicTag:TopicTag" } }, "timeFormat": { "type": "string", "description": "Time format\n" }, "timeKey": { "type": "string", "description": "Time field name\n" }, "topicName": { "type": "string", "description": "Log topic name.\n" }, "ttl": { "type": "integer", "description": "Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.\n" } }, "requiredInputs": [ "projectId", "shardCount", "topicName" ], "stateInputs": { "description": "Input properties used for looking up and filtering Topic resources.\n", "properties": { "allowConsume": { "type": "boolean", "description": "Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.\n" }, "archiveTtl": { "type": "integer", "description": "Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.\n" }, "autoSplit": { "type": "boolean", "description": "Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.\n" }, "coldTtl": { "type": "integer", "description": "Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.\n" }, "consumeTopic": { "type": "string", "description": "Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.\n" }, "createdTime": { "type": "string", "description": "Log topic creation time.\n" }, "description": { "type": "string", "description": "Log topic description. Does not support \u003c\u003e, ', \\, \\, or any emoji symbols. Length: 0–64 characters.\n" }, "enableHotTtl": { "type": "boolean", "description": "Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.\n" }, "enableTracking": { "type": "boolean", "description": "Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.\n" }, "hotTtl": { "type": "integer", "description": "Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.\n" }, "logPublicIp": { "type": "boolean", "description": "Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: **tag****client_ip**: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. **tag****receive_time**: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.\n" }, "maxSplitShard": { "type": "integer", "description": "Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.\n" }, "projectId": { "type": "string", "description": "Log project ID to which the log topic belongs.\n" }, "shardCount": { "type": "integer", "description": "Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tls/TopicTag:TopicTag" } }, "timeFormat": { "type": "string", "description": "Time format\n" }, "timeKey": { "type": "string", "description": "Time field name\n" }, "topicId": { "type": "string", "description": "Log topic ID.\n" }, "topicName": { "type": "string", "description": "Log topic name.\n" }, "ttl": { "type": "integer", "description": "Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.\n" }, "updatedTime": { "type": "string", "description": "Log topic modification time.\n" } }, "type": "object" } }, "volcenginecc:tos/bucket:Bucket": { "description": "A bucket is a container for storing objects. All objects must belong to a bucket. Buckets have various configuration properties, including region and access permissions. You can create different types of buckets to store different data based on your needs.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n bucketDemo:\n type: volcenginecc:tos:Bucket\n name: BucketDemo\n properties:\n name: bucket-demo\n storageClass: STANDARD\n enableVersionStatus: Enabled\n bucketType: fns\n tags:\n - key: env\n value: test\n policy: '{\"Version\":\"1.0\",\"Statement\":[{\"Sid\":\"f8fd\",\"Effect\":\"Allow\",\"Principal\":[\"*******\"],\"Action\":[\"tos:Get*\",\"tos:List*\",\"tos:HeadBucket\"],\"Resource\":[\"trn:tos:::************\",\"trn:tos:::************/*\"]}]}'\n lifecycleConfigs:\n - expiration:\n date: 2027-01-18T00:00:00Z\n filter:\n greaterThanIncludeEqual: Disabled\n lessThanIncludeEqual: Disabled\n objectSizeGreaterThan: 123\n objectSizeLessThan: 789\n lifecycle_rule_id: bucketdemo\n prefix: prefix\n status: Enabled\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tos/bucket:Bucket example \"name\"\n```\n\n", "properties": { "acl": { "$ref": "#/types/volcenginecc:tos/BucketAcl:BucketAcl", "description": "Bucket access control permissions\n" }, "aclGrant": { "$ref": "#/types/volcenginecc:tos/BucketAclGrant:BucketAclGrant" }, "azRedundancy": { "type": "string", "description": "Bucket availability zone redundancy type. Includes single-az: single availability zone redundancy, multi-az: multi availability zone redundancy\n" }, "bucketType": { "type": "string", "description": "Bucket type. Includes hns: hierarchical bucket type, fns: flat bucket type\n" }, "creationDate": { "type": "string", "description": "Bucket creation time\n" }, "enableVersionStatus": { "type": "string", "description": "Bucket versioning status. Enabled: Enable versioning. Suspended: Suspend versioning\n" }, "extranetEndpoint": { "type": "string", "description": "TOS protocol public access domain name for the bucket\n" }, "intranetEndpoint": { "type": "string", "description": "Private network access domain name for the bucket's TOS protocol\n" }, "lifecycleConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfig:BucketLifecycleConfig" } }, "location": { "type": "string", "description": "Bucket region\n" }, "name": { "type": "string", "description": "Bucket name\n" }, "policy": { "type": "string", "description": "String in JSON format containing bucket policy information. The total size of all bucket policy JSONs for a single bucket must not exceed 20KB\n" }, "projectName": { "type": "string", "description": "Project associated with the bucket\n" }, "storageClass": { "type": "string", "description": "Default storage class for the bucket. Includes STANDARD: Standard storage. IA: Infrequent access storage. INTELLIGENT*TIERING: Intelligent tiering storage. ARCHIVE*FR: Archive flashback storage. ARCHIVE: Archive storage. COLD*ARCHIVE: Cold archive storage. DEEP*COLD_ARCHIVE: Deep cold archive storage\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketTag:BucketTag" } } }, "required": [ "acl", "aclGrant", "azRedundancy", "bucketType", "creationDate", "enableVersionStatus", "extranetEndpoint", "intranetEndpoint", "lifecycleConfigs", "location", "name", "policy", "projectName", "storageClass", "tags" ], "inputProperties": { "acl": { "$ref": "#/types/volcenginecc:tos/BucketAcl:BucketAcl", "description": "Bucket access control permissions\n" }, "aclGrant": { "$ref": "#/types/volcenginecc:tos/BucketAclGrant:BucketAclGrant" }, "azRedundancy": { "type": "string", "description": "Bucket availability zone redundancy type. Includes single-az: single availability zone redundancy, multi-az: multi availability zone redundancy\n" }, "bucketType": { "type": "string", "description": "Bucket type. Includes hns: hierarchical bucket type, fns: flat bucket type\n" }, "enableVersionStatus": { "type": "string", "description": "Bucket versioning status. Enabled: Enable versioning. Suspended: Suspend versioning\n" }, "lifecycleConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfig:BucketLifecycleConfig" } }, "name": { "type": "string", "description": "Bucket name\n" }, "policy": { "type": "string", "description": "String in JSON format containing bucket policy information. The total size of all bucket policy JSONs for a single bucket must not exceed 20KB\n" }, "projectName": { "type": "string", "description": "Project associated with the bucket\n" }, "storageClass": { "type": "string", "description": "Default storage class for the bucket. Includes STANDARD: Standard storage. IA: Infrequent access storage. INTELLIGENT*TIERING: Intelligent tiering storage. ARCHIVE*FR: Archive flashback storage. ARCHIVE: Archive storage. COLD*ARCHIVE: Cold archive storage. DEEP*COLD_ARCHIVE: Deep cold archive storage\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketTag:BucketTag" } } }, "requiredInputs": [ "name" ], "stateInputs": { "description": "Input properties used for looking up and filtering Bucket resources.\n", "properties": { "acl": { "$ref": "#/types/volcenginecc:tos/BucketAcl:BucketAcl", "description": "Bucket access control permissions\n" }, "aclGrant": { "$ref": "#/types/volcenginecc:tos/BucketAclGrant:BucketAclGrant" }, "azRedundancy": { "type": "string", "description": "Bucket availability zone redundancy type. Includes single-az: single availability zone redundancy, multi-az: multi availability zone redundancy\n" }, "bucketType": { "type": "string", "description": "Bucket type. Includes hns: hierarchical bucket type, fns: flat bucket type\n" }, "creationDate": { "type": "string", "description": "Bucket creation time\n" }, "enableVersionStatus": { "type": "string", "description": "Bucket versioning status. Enabled: Enable versioning. Suspended: Suspend versioning\n" }, "extranetEndpoint": { "type": "string", "description": "TOS protocol public access domain name for the bucket\n" }, "intranetEndpoint": { "type": "string", "description": "Private network access domain name for the bucket's TOS protocol\n" }, "lifecycleConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketLifecycleConfig:BucketLifecycleConfig" } }, "location": { "type": "string", "description": "Bucket region\n" }, "name": { "type": "string", "description": "Bucket name\n" }, "policy": { "type": "string", "description": "String in JSON format containing bucket policy information. The total size of all bucket policy JSONs for a single bucket must not exceed 20KB\n" }, "projectName": { "type": "string", "description": "Project associated with the bucket\n" }, "storageClass": { "type": "string", "description": "Default storage class for the bucket. Includes STANDARD: Standard storage. IA: Infrequent access storage. INTELLIGENT*TIERING: Intelligent tiering storage. ARCHIVE*FR: Archive flashback storage. ARCHIVE: Archive storage. COLD*ARCHIVE: Cold archive storage. DEEP*COLD_ARCHIVE: Deep cold archive storage\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:tos/BucketTag:BucketTag" } } }, "type": "object" } }, "volcenginecc:tos/bucketEncryption:BucketEncryption": { "description": "Set server-side encryption for the bucket. After server-side encryption is set for the bucket, if you upload a file to this bucket without specifying a server-side encryption method for the file, the file will inherit the bucket's server-side encryption method by default\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst tOSBucketEncryptionDemo = new volcenginecc.tos.BucketEncryption(\"TOSBucketEncryptionDemo\", {\n kmsMasterKeyId: \"trn:kms:cn-beijing:21xxxxxxxxxxx:keyrings/ccapi-text/keys/terratest-kms-key-u-xxxxx\",\n name: \"ccapi-test\",\n sseAlgorithm: \"kms\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nt_os_bucket_encryption_demo = volcenginecc.tos.BucketEncryption(\"TOSBucketEncryptionDemo\",\n kms_master_key_id=\"trn:kms:cn-beijing:21xxxxxxxxxxx:keyrings/ccapi-text/keys/terratest-kms-key-u-xxxxx\",\n name=\"ccapi-test\",\n sse_algorithm=\"kms\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var tOSBucketEncryptionDemo = new Volcenginecc.Tos.BucketEncryption(\"TOSBucketEncryptionDemo\", new()\n {\n KmsMasterKeyId = \"trn:kms:cn-beijing:21xxxxxxxxxxx:keyrings/ccapi-text/keys/terratest-kms-key-u-xxxxx\",\n Name = \"ccapi-test\",\n SseAlgorithm = \"kms\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/tos\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := tos.NewBucketEncryption(ctx, \"TOSBucketEncryptionDemo\", \u0026tos.BucketEncryptionArgs{\n\t\t\tKmsMasterKeyId: pulumi.String(\"trn:kms:cn-beijing:21xxxxxxxxxxx:keyrings/ccapi-text/keys/terratest-kms-key-u-xxxxx\"),\n\t\t\tName: pulumi.String(\"ccapi-test\"),\n\t\t\tSseAlgorithm: pulumi.String(\"kms\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.tos.BucketEncryption;\nimport com.volcengine.volcenginecc.tos.BucketEncryptionArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var tOSBucketEncryptionDemo = new BucketEncryption(\"tOSBucketEncryptionDemo\", BucketEncryptionArgs.builder()\n .kmsMasterKeyId(\"trn:kms:cn-beijing:21xxxxxxxxxxx:keyrings/ccapi-text/keys/terratest-kms-key-u-xxxxx\")\n .name(\"ccapi-test\")\n .sseAlgorithm(\"kms\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n tOSBucketEncryptionDemo:\n type: volcenginecc:tos:BucketEncryption\n name: TOSBucketEncryptionDemo\n properties:\n kmsMasterKeyId: trn:kms:cn-beijing:21xxxxxxxxxxx:keyrings/ccapi-text/keys/terratest-kms-key-u-xxxxx\n name: ccapi-test\n sseAlgorithm: kms\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tos/bucketEncryption:BucketEncryption example \"name\"\n```\n\n", "properties": { "kmsMasterKeyId": { "type": "string", "description": "The master key used for SSE-KMS encryption\n" }, "name": { "type": "string", "description": "Bucket name\n" }, "sseAlgorithm": { "type": "string", "description": "Default server-side encryption method. The values are explained as follows: kms: uses SSE-KMS encryption. AES256: uses SSE-TOS encryption with the AES256 algorithm. SM4: uses SSE-TOS encryption with the SM4 algorithm\n" } }, "required": [ "kmsMasterKeyId", "name", "sseAlgorithm" ], "inputProperties": { "kmsMasterKeyId": { "type": "string", "description": "The master key used for SSE-KMS encryption\n" }, "name": { "type": "string", "description": "Bucket name\n" }, "sseAlgorithm": { "type": "string", "description": "Default server-side encryption method. The values are explained as follows: kms: uses SSE-KMS encryption. AES256: uses SSE-TOS encryption with the AES256 algorithm. SM4: uses SSE-TOS encryption with the SM4 algorithm\n" } }, "requiredInputs": [ "name" ], "stateInputs": { "description": "Input properties used for looking up and filtering BucketEncryption resources.\n", "properties": { "kmsMasterKeyId": { "type": "string", "description": "The master key used for SSE-KMS encryption\n" }, "name": { "type": "string", "description": "Bucket name\n" }, "sseAlgorithm": { "type": "string", "description": "Default server-side encryption method. The values are explained as follows: kms: uses SSE-KMS encryption. AES256: uses SSE-TOS encryption with the AES256 algorithm. SM4: uses SSE-TOS encryption with the SM4 algorithm\n" } }, "type": "object" } }, "volcenginecc:tos/bucketInventory:BucketInventory": { "description": "Bucket inventory rules. After creating a bucket inventory, TOS outputs various object information daily or weekly, including object count, size, storage type, and more.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n tOSBucketInventoryDemo:\n type: volcenginecc:tos:BucketInventory\n name: TOSBucketInventoryDemo\n properties:\n bucketName: ccapi-test\n destination:\n tos_bucket_destination:\n accountId: 21xxxxxxxxx\n bucket: ccapi-test\n format: CSV\n prefix: tos_bucket_inventory\n role: TosArchiveTOSxxxxxx\n filter:\n prefix: sdfsaf\n includedObjectVersions: Current\n inventoryId: test\n isEnabled: true\n isUnCompressed: false\n optionalFields:\n field:\n - StorageClass\n - IntelligentTieringAccessTier\n schedule:\n frequency: Weekly\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:tos/bucketInventory:BucketInventory example \"bucket_name|inventory_id\"\n```\n\n", "properties": { "bucketName": { "type": "string", "description": "Bucket name.\n" }, "destination": { "$ref": "#/types/volcenginecc:tos/BucketInventoryDestination:BucketInventoryDestination", "description": "Information related to inventory files.\n" }, "filter": { "$ref": "#/types/volcenginecc:tos/BucketInventoryFilter:BucketInventoryFilter", "description": "Prefix for filtering bucket inventory.\n" }, "includedObjectVersions": { "type": "string", "description": "Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.\n" }, "inventoryId": { "type": "string", "description": "Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.\n" }, "isEnabled": { "type": "boolean", "description": "Whether to enable the bucket inventory feature. Options: true: enable; false: disable.\n" }, "isUnCompressed": { "type": "boolean", "description": "Whether it is uncompressed.\n" }, "optionalFields": { "$ref": "#/types/volcenginecc:tos/BucketInventoryOptionalFields:BucketInventoryOptionalFields", "description": "Information about exported inventory files.\n" }, "schedule": { "$ref": "#/types/volcenginecc:tos/BucketInventorySchedule:BucketInventorySchedule", "description": "Bucket inventory export frequency information.\n" } }, "required": [ "bucketName", "destination", "filter", "includedObjectVersions", "inventoryId", "isEnabled", "isUnCompressed", "optionalFields", "schedule" ], "inputProperties": { "bucketName": { "type": "string", "description": "Bucket name.\n" }, "destination": { "$ref": "#/types/volcenginecc:tos/BucketInventoryDestination:BucketInventoryDestination", "description": "Information related to inventory files.\n" }, "filter": { "$ref": "#/types/volcenginecc:tos/BucketInventoryFilter:BucketInventoryFilter", "description": "Prefix for filtering bucket inventory.\n" }, "includedObjectVersions": { "type": "string", "description": "Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.\n" }, "inventoryId": { "type": "string", "description": "Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.\n" }, "isEnabled": { "type": "boolean", "description": "Whether to enable the bucket inventory feature. Options: true: enable; false: disable.\n" }, "isUnCompressed": { "type": "boolean", "description": "Whether it is uncompressed.\n" }, "optionalFields": { "$ref": "#/types/volcenginecc:tos/BucketInventoryOptionalFields:BucketInventoryOptionalFields", "description": "Information about exported inventory files.\n" }, "schedule": { "$ref": "#/types/volcenginecc:tos/BucketInventorySchedule:BucketInventorySchedule", "description": "Bucket inventory export frequency information.\n" } }, "requiredInputs": [ "bucketName", "destination", "includedObjectVersions", "inventoryId", "isEnabled", "isUnCompressed", "schedule" ], "stateInputs": { "description": "Input properties used for looking up and filtering BucketInventory resources.\n", "properties": { "bucketName": { "type": "string", "description": "Bucket name.\n" }, "destination": { "$ref": "#/types/volcenginecc:tos/BucketInventoryDestination:BucketInventoryDestination", "description": "Information related to inventory files.\n" }, "filter": { "$ref": "#/types/volcenginecc:tos/BucketInventoryFilter:BucketInventoryFilter", "description": "Prefix for filtering bucket inventory.\n" }, "includedObjectVersions": { "type": "string", "description": "Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.\n" }, "inventoryId": { "type": "string", "description": "Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.\n" }, "isEnabled": { "type": "boolean", "description": "Whether to enable the bucket inventory feature. Options: true: enable; false: disable.\n" }, "isUnCompressed": { "type": "boolean", "description": "Whether it is uncompressed.\n" }, "optionalFields": { "$ref": "#/types/volcenginecc:tos/BucketInventoryOptionalFields:BucketInventoryOptionalFields", "description": "Information about exported inventory files.\n" }, "schedule": { "$ref": "#/types/volcenginecc:tos/BucketInventorySchedule:BucketInventorySchedule", "description": "Bucket inventory export frequency information.\n" } }, "type": "object" } }, "volcenginecc:transitrouter/peerAttachment:PeerAttachment": { "description": "A connection established between TR instances in two different regions enables cross-region communication.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst transitRouterPeerAttachmentDemo = new volcenginecc.transitrouter.PeerAttachment(\"TransitRouterPeerAttachmentDemo\", {\n transitRouterId: \"tr-mjcxxxx\",\n transitRouterAttachmentName: \"ccapi-test-tf\",\n description: \"tf-test\",\n peerTransitRouterId: \"tr-xxx\",\n peerTransitRouterRegionId: \"cn-xx\",\n transitRouterBandwidthPackageId: \"tbp-13f34rxxxx\",\n bandwidth: 2,\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ntransit_router_peer_attachment_demo = volcenginecc.transitrouter.PeerAttachment(\"TransitRouterPeerAttachmentDemo\",\n transit_router_id=\"tr-mjcxxxx\",\n transit_router_attachment_name=\"ccapi-test-tf\",\n description=\"tf-test\",\n peer_transit_router_id=\"tr-xxx\",\n peer_transit_router_region_id=\"cn-xx\",\n transit_router_bandwidth_package_id=\"tbp-13f34rxxxx\",\n bandwidth=2,\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var transitRouterPeerAttachmentDemo = new Volcenginecc.Transitrouter.PeerAttachment(\"TransitRouterPeerAttachmentDemo\", new()\n {\n TransitRouterId = \"tr-mjcxxxx\",\n TransitRouterAttachmentName = \"ccapi-test-tf\",\n Description = \"tf-test\",\n PeerTransitRouterId = \"tr-xxx\",\n PeerTransitRouterRegionId = \"cn-xx\",\n TransitRouterBandwidthPackageId = \"tbp-13f34rxxxx\",\n Bandwidth = 2,\n Tags = new[]\n {\n new Volcenginecc.Transitrouter.Inputs.PeerAttachmentTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/transitrouter\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := transitrouter.NewPeerAttachment(ctx, \"TransitRouterPeerAttachmentDemo\", \u0026transitrouter.PeerAttachmentArgs{\n\t\t\tTransitRouterId: pulumi.String(\"tr-mjcxxxx\"),\n\t\t\tTransitRouterAttachmentName: pulumi.String(\"ccapi-test-tf\"),\n\t\t\tDescription: pulumi.String(\"tf-test\"),\n\t\t\tPeerTransitRouterId: pulumi.String(\"tr-xxx\"),\n\t\t\tPeerTransitRouterRegionId: pulumi.String(\"cn-xx\"),\n\t\t\tTransitRouterBandwidthPackageId: pulumi.String(\"tbp-13f34rxxxx\"),\n\t\t\tBandwidth: pulumi.Int(2),\n\t\t\tTags: transitrouter.PeerAttachmentTagArray{\n\t\t\t\t\u0026transitrouter.PeerAttachmentTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.transitrouter.PeerAttachment;\nimport com.volcengine.volcenginecc.transitrouter.PeerAttachmentArgs;\nimport com.pulumi.volcenginecc.transitrouter.inputs.PeerAttachmentTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var transitRouterPeerAttachmentDemo = new PeerAttachment(\"transitRouterPeerAttachmentDemo\", PeerAttachmentArgs.builder()\n .transitRouterId(\"tr-mjcxxxx\")\n .transitRouterAttachmentName(\"ccapi-test-tf\")\n .description(\"tf-test\")\n .peerTransitRouterId(\"tr-xxx\")\n .peerTransitRouterRegionId(\"cn-xx\")\n .transitRouterBandwidthPackageId(\"tbp-13f34rxxxx\")\n .bandwidth(2)\n .tags(PeerAttachmentTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n transitRouterPeerAttachmentDemo:\n type: volcenginecc:transitrouter:PeerAttachment\n name: TransitRouterPeerAttachmentDemo\n properties:\n transitRouterId: tr-mjcxxxx\n transitRouterAttachmentName: ccapi-test-tf\n description: tf-test\n peerTransitRouterId: tr-xxx\n peerTransitRouterRegionId: cn-xx\n transitRouterBandwidthPackageId: tbp-13f34rxxxx\n bandwidth: 2\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:transitrouter/peerAttachment:PeerAttachment example \"transit_router_attachment_id\"\n```\n\n", "properties": { "autoPublishRouteEnabled": { "type": "boolean", "description": "Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.\n" }, "bandwidth": { "type": "integer", "description": "Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.\n" }, "creationTime": { "type": "string", "description": "Creation time of the cross-region connection.\n" }, "description": { "type": "string", "description": "Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "ipv6Enabled": { "type": "boolean", "description": "Enable IPv6. true: Yes. false: No.\n" }, "peerTransitRouterId": { "type": "string", "description": "ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.\n" }, "peerTransitRouterRegionId": { "type": "string", "description": "Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.\n" }, "status": { "type": "string", "description": "Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/PeerAttachmentTag:PeerAttachmentTag" } }, "transitRouterAttachmentId": { "type": "string", "description": "ID of the cross-region connection.\n" }, "transitRouterAttachmentName": { "type": "string", "description": "Name of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.\n" }, "transitRouterBandwidthPackageId": { "type": "string", "description": "ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.\n" }, "transitRouterForwardPolicyTableId": { "type": "string", "description": "ID of the forwarding policy associated with the cross-region connection.\n" }, "transitRouterId": { "type": "string", "description": "ID of the local transit router instance.\n" }, "transitRouterRouteTableId": { "type": "string", "description": "Associated forwarding route table for the cross-region connection.\n" }, "transitRouterTrafficQosMarkingPolicyId": { "type": "string", "description": "ID of the traffic marking policy associated with the cross-region connection.\n" }, "transitRouterTrafficQosQueuePolicyId": { "type": "string", "description": "ID of the flow queue policy associated with the cross-region connection.\n" }, "updateTime": { "type": "string", "description": "Last operation time of the cross-region connection.\n" } }, "required": [ "autoPublishRouteEnabled", "bandwidth", "creationTime", "description", "ipv6Enabled", "peerTransitRouterId", "peerTransitRouterRegionId", "status", "tags", "transitRouterAttachmentId", "transitRouterAttachmentName", "transitRouterBandwidthPackageId", "transitRouterForwardPolicyTableId", "transitRouterId", "transitRouterRouteTableId", "transitRouterTrafficQosMarkingPolicyId", "transitRouterTrafficQosQueuePolicyId", "updateTime" ], "inputProperties": { "bandwidth": { "type": "integer", "description": "Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.\n" }, "description": { "type": "string", "description": "Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "peerTransitRouterId": { "type": "string", "description": "ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.\n" }, "peerTransitRouterRegionId": { "type": "string", "description": "Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/PeerAttachmentTag:PeerAttachmentTag" } }, "transitRouterAttachmentName": { "type": "string", "description": "Name of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.\n" }, "transitRouterBandwidthPackageId": { "type": "string", "description": "ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.\n" }, "transitRouterId": { "type": "string", "description": "ID of the local transit router instance.\n" } }, "requiredInputs": [ "peerTransitRouterId", "peerTransitRouterRegionId", "transitRouterId" ], "stateInputs": { "description": "Input properties used for looking up and filtering PeerAttachment resources.\n", "properties": { "autoPublishRouteEnabled": { "type": "boolean", "description": "Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.\n" }, "bandwidth": { "type": "integer", "description": "Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.\n" }, "creationTime": { "type": "string", "description": "Creation time of the cross-region connection.\n" }, "description": { "type": "string", "description": "Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "ipv6Enabled": { "type": "boolean", "description": "Enable IPv6. true: Yes. false: No.\n" }, "peerTransitRouterId": { "type": "string", "description": "ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.\n" }, "peerTransitRouterRegionId": { "type": "string", "description": "Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.\n" }, "status": { "type": "string", "description": "Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/PeerAttachmentTag:PeerAttachmentTag" } }, "transitRouterAttachmentId": { "type": "string", "description": "ID of the cross-region connection.\n" }, "transitRouterAttachmentName": { "type": "string", "description": "Name of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.\n" }, "transitRouterBandwidthPackageId": { "type": "string", "description": "ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.\n" }, "transitRouterForwardPolicyTableId": { "type": "string", "description": "ID of the forwarding policy associated with the cross-region connection.\n" }, "transitRouterId": { "type": "string", "description": "ID of the local transit router instance.\n" }, "transitRouterRouteTableId": { "type": "string", "description": "Associated forwarding route table for the cross-region connection.\n" }, "transitRouterTrafficQosMarkingPolicyId": { "type": "string", "description": "ID of the traffic marking policy associated with the cross-region connection.\n" }, "transitRouterTrafficQosQueuePolicyId": { "type": "string", "description": "ID of the flow queue policy associated with the cross-region connection.\n" }, "updateTime": { "type": "string", "description": "Last operation time of the cross-region connection.\n" } }, "type": "object" } }, "volcenginecc:transitrouter/transitRouter:TransitRouter": { "description": "Platform on which the transit router service runs. Receives traffic from network instances and forwards it according to the associated forwarding route table\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst transitRouterDemo = new volcenginecc.transitrouter.TransitRouter(\"TransitRouterDemo\", {\n transitRouterName: \"TransitRouterDemo\",\n asn: 4200001111,\n description: \"TransitRouterDemo\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ntransit_router_demo = volcenginecc.transitrouter.TransitRouter(\"TransitRouterDemo\",\n transit_router_name=\"TransitRouterDemo\",\n asn=4200001111,\n description=\"TransitRouterDemo\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var transitRouterDemo = new Volcenginecc.Transitrouter.TransitRouter(\"TransitRouterDemo\", new()\n {\n TransitRouterName = \"TransitRouterDemo\",\n Asn = 4200001111,\n Description = \"TransitRouterDemo\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Transitrouter.Inputs.TransitRouterTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/transitrouter\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := transitrouter.NewTransitRouter(ctx, \"TransitRouterDemo\", \u0026transitrouter.TransitRouterArgs{\n\t\t\tTransitRouterName: pulumi.String(\"TransitRouterDemo\"),\n\t\t\tAsn: pulumi.Int(4200001111),\n\t\t\tDescription: pulumi.String(\"TransitRouterDemo\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: transitrouter.TransitRouterTagArray{\n\t\t\t\t\u0026transitrouter.TransitRouterTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.transitrouter.TransitRouter;\nimport com.volcengine.volcenginecc.transitrouter.TransitRouterArgs;\nimport com.pulumi.volcenginecc.transitrouter.inputs.TransitRouterTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var transitRouterDemo = new TransitRouter(\"transitRouterDemo\", TransitRouterArgs.builder()\n .transitRouterName(\"TransitRouterDemo\")\n .asn(4200001111)\n .description(\"TransitRouterDemo\")\n .projectName(\"default\")\n .tags(TransitRouterTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n transitRouterDemo:\n type: volcenginecc:transitrouter:TransitRouter\n name: TransitRouterDemo\n properties:\n transitRouterName: TransitRouterDemo\n asn: 4.200001111e+09\n description: TransitRouterDemo\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:transitrouter/transitRouter:TransitRouter example \"transit_router_id\"\n```\n\n", "properties": { "asn": { "type": "integer", "description": "ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512\n" }, "attachments": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/TransitRouterAttachment:TransitRouterAttachment" } }, "businessStatus": { "type": "string", "description": "Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.\n" }, "creationTime": { "type": "string", "description": "Creation time of the network instance connection.\n" }, "deletedTime": { "type": "string", "description": "Deletion time of the network instance connection.\n" }, "description": { "type": "string", "description": "Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string\n" }, "grantSourceType": { "type": "string", "description": "Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing\n" }, "grantStatus": { "type": "string", "description": "Instance sharing status. Accepted: Received. Initial: Pending acceptance.\n" }, "multicastEnabled": { "type": "boolean", "description": "Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled\n" }, "overdueTime": { "type": "string", "description": "Shutdown time due to overdue payment for the transit router instance\n" }, "projectName": { "type": "string", "description": "Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'\n" }, "status": { "type": "string", "description": "Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/TransitRouterTag:TransitRouterTag" } }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "transitRouterName": { "type": "string", "description": "Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.\n" }, "updateTime": { "type": "string", "description": "Last operation time of the transit router instance\n" } }, "required": [ "asn", "attachments", "businessStatus", "creationTime", "deletedTime", "description", "grantSourceType", "grantStatus", "multicastEnabled", "overdueTime", "projectName", "status", "tags", "transitRouterId", "transitRouterName", "updateTime" ], "inputProperties": { "asn": { "type": "integer", "description": "ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512\n" }, "description": { "type": "string", "description": "Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string\n" }, "multicastEnabled": { "type": "boolean", "description": "Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled\n" }, "projectName": { "type": "string", "description": "Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/TransitRouterTag:TransitRouterTag" } }, "transitRouterName": { "type": "string", "description": "Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering TransitRouter resources.\n", "properties": { "asn": { "type": "integer", "description": "ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512\n" }, "attachments": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/TransitRouterAttachment:TransitRouterAttachment" } }, "businessStatus": { "type": "string", "description": "Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.\n" }, "creationTime": { "type": "string", "description": "Creation time of the network instance connection.\n" }, "deletedTime": { "type": "string", "description": "Deletion time of the network instance connection.\n" }, "description": { "type": "string", "description": "Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string\n" }, "grantSourceType": { "type": "string", "description": "Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing\n" }, "grantStatus": { "type": "string", "description": "Instance sharing status. Accepted: Received. Initial: Pending acceptance.\n" }, "multicastEnabled": { "type": "boolean", "description": "Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled\n" }, "overdueTime": { "type": "string", "description": "Shutdown time due to overdue payment for the transit router instance\n" }, "projectName": { "type": "string", "description": "Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'\n" }, "status": { "type": "string", "description": "Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/TransitRouterTag:TransitRouterTag" } }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "transitRouterName": { "type": "string", "description": "Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.\n" }, "updateTime": { "type": "string", "description": "Last operation time of the transit router instance\n" } }, "type": "object" } }, "volcenginecc:transitrouter/transitRouterRouteEntry:TransitRouterRouteEntry": { "description": "By creating or deleting static routes in route tables associated with network instance connections or cross-region connections, you can flexibly control traffic direction in the transit router\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n transitRouterRouteEntryDemo:\n type: volcenginecc:transitrouter:TransitRouterRouteEntry\n name: TransitRouterRouteEntryDemo\n properties:\n description: Demo Example\n destinationCidrBlock: 192.168.1.101/*\n transitRouterRouteEntryName: test-Attachmentkua\n transitRouterRouteTableId: tr-rtb-mijcn***\n transitRouterRouteEntryNextHopId: tr-attach-13fs****\n transitRouterRouteEntryNextHopType: Attachment\n transitRouterRouteEntryType: Propagated\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:transitrouter/transitRouterRouteEntry:TransitRouterRouteEntry example \"transit_router_route_table_id|transit_router_route_entry_id\"\n```\n\n", "properties": { "asPaths": { "type": "array", "items": { "type": "string" }, "description": "AS path of the route entry\n" }, "createdTime": { "type": "string", "description": "Creation time of the route entry\n" }, "description": { "type": "string", "description": "Description of the TR route table entry. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If this parameter is not provided or no value is specified, the default is an empty string\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR block of the route entry\n" }, "status": { "type": "string", "description": "Status of the route entry. Available: Available. Creating: Creating. Pending: Configuring. Deleting: Deleting. Conflicted: Inactive\n" }, "transitRouterRouteEntryId": { "type": "string", "description": "ID of the TR route entry\n" }, "transitRouterRouteEntryName": { "type": "string", "description": "Name of the route entry\n" }, "transitRouterRouteEntryNextHopId": { "type": "string", "description": "Next hop ID of the route entry\n" }, "transitRouterRouteEntryNextHopResourceId": { "type": "string", "description": "Next hop network instance ID of the route entry\n" }, "transitRouterRouteEntryNextHopResourceType": { "type": "string", "description": "Type of the next hop network instance for the route entry. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router\n" }, "transitRouterRouteEntryNextHopType": { "type": "string", "description": "Next hop type of the route entry. Valid values: Attachment: Network instance. Traffic matching this route entry will be forwarded to the specified network instance. BlackHole: Black hole. Traffic matching this route entry will be dropped\n" }, "transitRouterRouteEntryType": { "type": "string", "description": "Type of the route entry. Static: Static route. Propagated: Learned route\n" }, "transitRouterRouteTableId": { "type": "string", "description": "ID of the route table associated with the transit router instance\n" }, "updatedTime": { "type": "string", "description": "Last updated time of the route entry\n" } }, "required": [ "asPaths", "createdTime", "description", "destinationCidrBlock", "status", "transitRouterRouteEntryId", "transitRouterRouteEntryName", "transitRouterRouteEntryNextHopId", "transitRouterRouteEntryNextHopResourceId", "transitRouterRouteEntryNextHopResourceType", "transitRouterRouteEntryNextHopType", "transitRouterRouteEntryType", "transitRouterRouteTableId", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Description of the TR route table entry. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If this parameter is not provided or no value is specified, the default is an empty string\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR block of the route entry\n" }, "transitRouterRouteEntryName": { "type": "string", "description": "Name of the route entry\n" }, "transitRouterRouteEntryNextHopId": { "type": "string", "description": "Next hop ID of the route entry\n" }, "transitRouterRouteEntryNextHopType": { "type": "string", "description": "Next hop type of the route entry. Valid values: Attachment: Network instance. Traffic matching this route entry will be forwarded to the specified network instance. BlackHole: Black hole. Traffic matching this route entry will be dropped\n" }, "transitRouterRouteTableId": { "type": "string", "description": "ID of the route table associated with the transit router instance\n" } }, "requiredInputs": [ "destinationCidrBlock", "transitRouterRouteEntryNextHopType", "transitRouterRouteTableId" ], "stateInputs": { "description": "Input properties used for looking up and filtering TransitRouterRouteEntry resources.\n", "properties": { "asPaths": { "type": "array", "items": { "type": "string" }, "description": "AS path of the route entry\n" }, "createdTime": { "type": "string", "description": "Creation time of the route entry\n" }, "description": { "type": "string", "description": "Description of the TR route table entry. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If this parameter is not provided or no value is specified, the default is an empty string\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination CIDR block of the route entry\n" }, "status": { "type": "string", "description": "Status of the route entry. Available: Available. Creating: Creating. Pending: Configuring. Deleting: Deleting. Conflicted: Inactive\n" }, "transitRouterRouteEntryId": { "type": "string", "description": "ID of the TR route entry\n" }, "transitRouterRouteEntryName": { "type": "string", "description": "Name of the route entry\n" }, "transitRouterRouteEntryNextHopId": { "type": "string", "description": "Next hop ID of the route entry\n" }, "transitRouterRouteEntryNextHopResourceId": { "type": "string", "description": "Next hop network instance ID of the route entry\n" }, "transitRouterRouteEntryNextHopResourceType": { "type": "string", "description": "Type of the next hop network instance for the route entry. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router\n" }, "transitRouterRouteEntryNextHopType": { "type": "string", "description": "Next hop type of the route entry. Valid values: Attachment: Network instance. Traffic matching this route entry will be forwarded to the specified network instance. BlackHole: Black hole. Traffic matching this route entry will be dropped\n" }, "transitRouterRouteEntryType": { "type": "string", "description": "Type of the route entry. Static: Static route. Propagated: Learned route\n" }, "transitRouterRouteTableId": { "type": "string", "description": "ID of the route table associated with the transit router instance\n" }, "updatedTime": { "type": "string", "description": "Last updated time of the route entry\n" } }, "type": "object" } }, "volcenginecc:transitrouter/transitRouterRouteTable:TransitRouterRouteTable": { "description": "Basis for Transit Router to forward traffic, supporting associated forwarding, static routing, route learning, and route synchronization. Multiple TR routing tables can be created under each TR instance to forward traffic for network instances with different access requirements. Multiple network instance connections can be associated with the same TR routing table.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst transitRouterTransitRouterRouteTableDemo = new volcenginecc.transitrouter.TransitRouterRouteTable(\"TransitRouterTransitRouterRouteTableDemo\", {\n transitRouterId: \"tr-mj7mc0paq******\",\n description: \"TransitRouterTransitRouterRouteTableDemo-Description\",\n transitRouterRouteTableName: \"TransitRouterTransitRouterRouteTableDemo\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ntransit_router_transit_router_route_table_demo = volcenginecc.transitrouter.TransitRouterRouteTable(\"TransitRouterTransitRouterRouteTableDemo\",\n transit_router_id=\"tr-mj7mc0paq******\",\n description=\"TransitRouterTransitRouterRouteTableDemo-Description\",\n transit_router_route_table_name=\"TransitRouterTransitRouterRouteTableDemo\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var transitRouterTransitRouterRouteTableDemo = new Volcenginecc.Transitrouter.TransitRouterRouteTable(\"TransitRouterTransitRouterRouteTableDemo\", new()\n {\n TransitRouterId = \"tr-mj7mc0paq******\",\n Description = \"TransitRouterTransitRouterRouteTableDemo-Description\",\n TransitRouterRouteTableName = \"TransitRouterTransitRouterRouteTableDemo\",\n Tags = new[]\n {\n new Volcenginecc.Transitrouter.Inputs.TransitRouterRouteTableTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/transitrouter\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := transitrouter.NewTransitRouterRouteTable(ctx, \"TransitRouterTransitRouterRouteTableDemo\", \u0026transitrouter.TransitRouterRouteTableArgs{\n\t\t\tTransitRouterId: pulumi.String(\"tr-mj7mc0paq******\"),\n\t\t\tDescription: pulumi.String(\"TransitRouterTransitRouterRouteTableDemo-Description\"),\n\t\t\tTransitRouterRouteTableName: pulumi.String(\"TransitRouterTransitRouterRouteTableDemo\"),\n\t\t\tTags: transitrouter.TransitRouterRouteTableTagArray{\n\t\t\t\t\u0026transitrouter.TransitRouterRouteTableTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.transitrouter.TransitRouterRouteTable;\nimport com.volcengine.volcenginecc.transitrouter.TransitRouterRouteTableArgs;\nimport com.pulumi.volcenginecc.transitrouter.inputs.TransitRouterRouteTableTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var transitRouterTransitRouterRouteTableDemo = new TransitRouterRouteTable(\"transitRouterTransitRouterRouteTableDemo\", TransitRouterRouteTableArgs.builder()\n .transitRouterId(\"tr-mj7mc0paq******\")\n .description(\"TransitRouterTransitRouterRouteTableDemo-Description\")\n .transitRouterRouteTableName(\"TransitRouterTransitRouterRouteTableDemo\")\n .tags(TransitRouterRouteTableTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n transitRouterTransitRouterRouteTableDemo:\n type: volcenginecc:transitrouter:TransitRouterRouteTable\n name: TransitRouterTransitRouterRouteTableDemo\n properties:\n transitRouterId: tr-mj7mc0paq******\n description: TransitRouterTransitRouterRouteTableDemo-Description\n transitRouterRouteTableName: TransitRouterTransitRouterRouteTableDemo\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:transitrouter/transitRouterRouteTable:TransitRouterRouteTable example \"transit_router_id|transit_router_route_table_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the TR routing table\n" }, "description": { "type": "string", "description": "Description of the TR routing table. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "inRoutePolicyTableId": { "type": "string", "description": "ID of the inbound routing policy associated with the TR routing table\n" }, "outRoutePolicyTableId": { "type": "string", "description": "ID of the outbound routing policy associated with the TR routing table\n" }, "status": { "type": "string", "description": "Status of the TR routing table. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/TransitRouterRouteTableTag:TransitRouterRouteTableTag" } }, "transitRouterId": { "type": "string", "description": "Transit Router instance ID\n" }, "transitRouterRouteTableId": { "type": "string", "description": "TR routing table ID\n" }, "transitRouterRouteTableName": { "type": "string", "description": "Name of the TR routing table. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the TR routing table ID\n" }, "transitRouterRouteTableType": { "type": "string", "description": "Type of TR routing table. System: system routing table. Custom: custom routing table.\n" }, "updatedTime": { "type": "string", "description": "Last operation time of the TR routing table\n" } }, "required": [ "createdTime", "description", "inRoutePolicyTableId", "outRoutePolicyTableId", "status", "tags", "transitRouterId", "transitRouterRouteTableId", "transitRouterRouteTableName", "transitRouterRouteTableType", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Description of the TR routing table. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/TransitRouterRouteTableTag:TransitRouterRouteTableTag" } }, "transitRouterId": { "type": "string", "description": "Transit Router instance ID\n" }, "transitRouterRouteTableName": { "type": "string", "description": "Name of the TR routing table. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the TR routing table ID\n" } }, "requiredInputs": [ "transitRouterId" ], "stateInputs": { "description": "Input properties used for looking up and filtering TransitRouterRouteTable resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the TR routing table\n" }, "description": { "type": "string", "description": "Description of the TR routing table. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "inRoutePolicyTableId": { "type": "string", "description": "ID of the inbound routing policy associated with the TR routing table\n" }, "outRoutePolicyTableId": { "type": "string", "description": "ID of the outbound routing policy associated with the TR routing table\n" }, "status": { "type": "string", "description": "Status of the TR routing table. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/TransitRouterRouteTableTag:TransitRouterRouteTableTag" } }, "transitRouterId": { "type": "string", "description": "Transit Router instance ID\n" }, "transitRouterRouteTableId": { "type": "string", "description": "TR routing table ID\n" }, "transitRouterRouteTableName": { "type": "string", "description": "Name of the TR routing table. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the TR routing table ID\n" }, "transitRouterRouteTableType": { "type": "string", "description": "Type of TR routing table. System: system routing table. Custom: custom routing table.\n" }, "updatedTime": { "type": "string", "description": "Last operation time of the TR routing table\n" } }, "type": "object" } }, "volcenginecc:transitrouter/vpcAttachment:VpcAttachment": { "description": "By establishing a connection between the private network and the transit router, you can enable private network communication between the private network and the transit router.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n transitRouterVpcAttachmentDemo:\n type: volcenginecc:transitrouter:VpcAttachment\n name: TransitRouterVpcAttachmentDemo\n properties:\n applianceModeEnabled: false\n attachPoints:\n - subnet_id: subnet-ijifxxxxx8culvzg85\n zone_id: cn-beijing-a\n autoPublishRouteEnabled: false\n description: test\n ipv6Enabled: false\n tags:\n - key: env\n value: test\n transitRouterAttachmentName: ccapi-test-1\n transitRouterId: tr-mjl8xxxxxg5smt1boobol4\n vpcId: vpc-btg9hmxxxxx0b2tnp1on8\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:transitrouter/vpcAttachment:VpcAttachment example \"transit_router_id|transit_router_attachment_id\"\n```\n\n", "properties": { "applianceModeEnabled": { "type": "boolean", "description": "Whether to enable path consistency mode. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. When enabled, TR forwarding traffic to this VPC connection will select the same availability zone connection point for both request and return traffic. false: No.\n" }, "attachPoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/VpcAttachmentAttachPoint:VpcAttachmentAttachPoint" } }, "autoPublishRouteEnabled": { "type": "boolean", "description": "Whether to automatically synchronize TR routes to the network instance route table. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. The system will automatically synchronize route entries from the TR route table associated with this network instance connection to the network instance's route table. The system will only synchronize TR routes if this parameter is set to true and there are route entries in the associated TR route table. false (default): No.\n" }, "bandwidth": { "type": "integer", "description": "Maximum bandwidth for the network instance connection, in Gbps.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Description of the network instance connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "ipv6Enabled": { "type": "boolean", "description": "Whether to enable IPv6. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. false: No.\n" }, "status": { "type": "string", "description": "Network instance connection status. Creating: Creating. Deleting: Deleting. Pending: Configuring. Available: Available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/VpcAttachmentTag:VpcAttachmentTag" } }, "transitRouterAttachmentId": { "type": "string", "description": "Network instance connection ID.\n" }, "transitRouterAttachmentName": { "type": "string", "description": "Name of the network instance connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the network instance connection ID.\n" }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "vpcId": { "type": "string", "description": "Private network instance ID.\n" } }, "required": [ "applianceModeEnabled", "attachPoints", "autoPublishRouteEnabled", "bandwidth", "createdTime", "description", "ipv6Enabled", "status", "tags", "transitRouterAttachmentId", "transitRouterAttachmentName", "transitRouterId", "updatedTime", "vpcId" ], "inputProperties": { "applianceModeEnabled": { "type": "boolean", "description": "Whether to enable path consistency mode. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. When enabled, TR forwarding traffic to this VPC connection will select the same availability zone connection point for both request and return traffic. false: No.\n" }, "attachPoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/VpcAttachmentAttachPoint:VpcAttachmentAttachPoint" } }, "autoPublishRouteEnabled": { "type": "boolean", "description": "Whether to automatically synchronize TR routes to the network instance route table. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. The system will automatically synchronize route entries from the TR route table associated with this network instance connection to the network instance's route table. The system will only synchronize TR routes if this parameter is set to true and there are route entries in the associated TR route table. false (default): No.\n" }, "description": { "type": "string", "description": "Description of the network instance connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "ipv6Enabled": { "type": "boolean", "description": "Whether to enable IPv6. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. false: No.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/VpcAttachmentTag:VpcAttachmentTag" } }, "transitRouterAttachmentName": { "type": "string", "description": "Name of the network instance connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the network instance connection ID.\n" }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "vpcId": { "type": "string", "description": "Private network instance ID.\n" } }, "requiredInputs": [ "attachPoints", "transitRouterId", "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering VpcAttachment resources.\n", "properties": { "applianceModeEnabled": { "type": "boolean", "description": "Whether to enable path consistency mode. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. When enabled, TR forwarding traffic to this VPC connection will select the same availability zone connection point for both request and return traffic. false: No.\n" }, "attachPoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/VpcAttachmentAttachPoint:VpcAttachmentAttachPoint" } }, "autoPublishRouteEnabled": { "type": "boolean", "description": "Whether to automatically synchronize TR routes to the network instance route table. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. The system will automatically synchronize route entries from the TR route table associated with this network instance connection to the network instance's route table. The system will only synchronize TR routes if this parameter is set to true and there are route entries in the associated TR route table. false (default): No.\n" }, "bandwidth": { "type": "integer", "description": "Maximum bandwidth for the network instance connection, in Gbps.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Description of the network instance connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "ipv6Enabled": { "type": "boolean", "description": "Whether to enable IPv6. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. false: No.\n" }, "status": { "type": "string", "description": "Network instance connection status. Creating: Creating. Deleting: Deleting. Pending: Configuring. Available: Available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/VpcAttachmentTag:VpcAttachmentTag" } }, "transitRouterAttachmentId": { "type": "string", "description": "Network instance connection ID.\n" }, "transitRouterAttachmentName": { "type": "string", "description": "Name of the network instance connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the network instance connection ID.\n" }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "vpcId": { "type": "string", "description": "Private network instance ID.\n" } }, "type": "object" } }, "volcenginecc:transitrouter/vpnAttachment:VpnAttachment": { "description": "By establishing a connection between the IPsec connection of the VPN and the transit router, you can enable communication between the VPN-connected network and the private network of the transit router.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst transitRouterVpnAttachmentDemo = new volcenginecc.transitrouter.VpnAttachment(\"TransitRouterVpnAttachmentDemo\", {\n description: \"test\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n transitRouterAttachmentName: \"ccapi-test-1\",\n transitRouterId: \"tr-mjl8zkxxxxxsmt1boobol4\",\n transitRouterRouteTableId: \"tr-rtb-mjlxxxxxo5smt1bnewrhh\",\n vpnConnectionId: \"vgc-ij0yxxxxx474o8cux0n08t\",\n zoneId: \"cn-beijing-a\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\ntransit_router_vpn_attachment_demo = volcenginecc.transitrouter.VpnAttachment(\"TransitRouterVpnAttachmentDemo\",\n description=\"test\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }],\n transit_router_attachment_name=\"ccapi-test-1\",\n transit_router_id=\"tr-mjl8zkxxxxxsmt1boobol4\",\n transit_router_route_table_id=\"tr-rtb-mjlxxxxxo5smt1bnewrhh\",\n vpn_connection_id=\"vgc-ij0yxxxxx474o8cux0n08t\",\n zone_id=\"cn-beijing-a\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var transitRouterVpnAttachmentDemo = new Volcenginecc.Transitrouter.VpnAttachment(\"TransitRouterVpnAttachmentDemo\", new()\n {\n Description = \"test\",\n Tags = new[]\n {\n new Volcenginecc.Transitrouter.Inputs.VpnAttachmentTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n TransitRouterAttachmentName = \"ccapi-test-1\",\n TransitRouterId = \"tr-mjl8zkxxxxxsmt1boobol4\",\n TransitRouterRouteTableId = \"tr-rtb-mjlxxxxxo5smt1bnewrhh\",\n VpnConnectionId = \"vgc-ij0yxxxxx474o8cux0n08t\",\n ZoneId = \"cn-beijing-a\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/transitrouter\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := transitrouter.NewVpnAttachment(ctx, \"TransitRouterVpnAttachmentDemo\", \u0026transitrouter.VpnAttachmentArgs{\n\t\t\tDescription: pulumi.String(\"test\"),\n\t\t\tTags: transitrouter.VpnAttachmentTagArray{\n\t\t\t\t\u0026transitrouter.VpnAttachmentTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTransitRouterAttachmentName: pulumi.String(\"ccapi-test-1\"),\n\t\t\tTransitRouterId: pulumi.String(\"tr-mjl8zkxxxxxsmt1boobol4\"),\n\t\t\tTransitRouterRouteTableId: pulumi.String(\"tr-rtb-mjlxxxxxo5smt1bnewrhh\"),\n\t\t\tVpnConnectionId: pulumi.String(\"vgc-ij0yxxxxx474o8cux0n08t\"),\n\t\t\tZoneId: pulumi.String(\"cn-beijing-a\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.transitrouter.VpnAttachment;\nimport com.volcengine.volcenginecc.transitrouter.VpnAttachmentArgs;\nimport com.pulumi.volcenginecc.transitrouter.inputs.VpnAttachmentTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var transitRouterVpnAttachmentDemo = new VpnAttachment(\"transitRouterVpnAttachmentDemo\", VpnAttachmentArgs.builder()\n .description(\"test\")\n .tags(VpnAttachmentTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .transitRouterAttachmentName(\"ccapi-test-1\")\n .transitRouterId(\"tr-mjl8zkxxxxxsmt1boobol4\")\n .transitRouterRouteTableId(\"tr-rtb-mjlxxxxxo5smt1bnewrhh\")\n .vpnConnectionId(\"vgc-ij0yxxxxx474o8cux0n08t\")\n .zoneId(\"cn-beijing-a\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n transitRouterVpnAttachmentDemo:\n type: volcenginecc:transitrouter:VpnAttachment\n name: TransitRouterVpnAttachmentDemo\n properties:\n description: test\n tags:\n - key: env\n value: test\n transitRouterAttachmentName: ccapi-test-1\n transitRouterId: tr-mjl8zkxxxxxsmt1boobol4\n transitRouterRouteTableId: tr-rtb-mjlxxxxxo5smt1bnewrhh\n vpnConnectionId: vgc-ij0yxxxxx474o8cux0n08t\n zoneId: cn-beijing-a\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:transitrouter/vpnAttachment:VpnAttachment example \"transit_router_id|transit_router_attachment_id\"\n```\n\n", "properties": { "autoPublishRouteEnabled": { "type": "boolean", "description": "Whether to automatically sync TR routes to the network instance route table.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "healthCheckRevokeRouteEnabled": { "type": "boolean", "description": "Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.\n" }, "ipv6Enabled": { "type": "boolean", "description": "Whether to enable IPv6.\n" }, "status": { "type": "string", "description": "Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/VpnAttachmentTag:VpnAttachmentTag" } }, "transitRouterAttachmentId": { "type": "string", "description": "Network instance connection ID.\n" }, "transitRouterAttachmentName": { "type": "string", "description": "Network instance connection name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the network instance connection ID.\n" }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "transitRouterRouteTableId": { "type": "string", "description": "Associated TR route table ID.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "vpnConnectionId": { "type": "string", "description": "IPsec connection ID.\n" }, "zoneId": { "type": "string", "description": "ID of the availability zone to which the IPsec connection belongs.\n" } }, "required": [ "autoPublishRouteEnabled", "createdTime", "description", "healthCheckRevokeRouteEnabled", "ipv6Enabled", "status", "tags", "transitRouterAttachmentId", "transitRouterAttachmentName", "transitRouterId", "transitRouterRouteTableId", "updatedTime", "vpnConnectionId", "zoneId" ], "inputProperties": { "description": { "type": "string", "description": "Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "healthCheckRevokeRouteEnabled": { "type": "boolean", "description": "Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/VpnAttachmentTag:VpnAttachmentTag" } }, "transitRouterAttachmentName": { "type": "string", "description": "Network instance connection name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the network instance connection ID.\n" }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "transitRouterRouteTableId": { "type": "string", "description": "Associated TR route table ID.\n" }, "vpnConnectionId": { "type": "string", "description": "IPsec connection ID.\n" }, "zoneId": { "type": "string", "description": "ID of the availability zone to which the IPsec connection belongs.\n" } }, "requiredInputs": [ "transitRouterId", "vpnConnectionId", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering VpnAttachment resources.\n", "properties": { "autoPublishRouteEnabled": { "type": "boolean", "description": "Whether to automatically sync TR routes to the network instance route table.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n" }, "healthCheckRevokeRouteEnabled": { "type": "boolean", "description": "Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.\n" }, "ipv6Enabled": { "type": "boolean", "description": "Whether to enable IPv6.\n" }, "status": { "type": "string", "description": "Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:transitrouter/VpnAttachmentTag:VpnAttachmentTag" } }, "transitRouterAttachmentId": { "type": "string", "description": "Network instance connection ID.\n" }, "transitRouterAttachmentName": { "type": "string", "description": "Network instance connection name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the network instance connection ID.\n" }, "transitRouterId": { "type": "string", "description": "Transit router instance ID.\n" }, "transitRouterRouteTableId": { "type": "string", "description": "Associated TR route table ID.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "vpnConnectionId": { "type": "string", "description": "IPsec connection ID.\n" }, "zoneId": { "type": "string", "description": "ID of the availability zone to which the IPsec connection belongs.\n" } }, "type": "object" } }, "volcenginecc:vedbm/account:Account": { "description": "Database Account Management\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vEDBMAccountDemo = new volcenginecc.vedbm.Account(\"VEDBMAccountDemo\", {\n instanceId: \"vedbm-r5zxxxxjdabv\",\n accountName: \"super_user\",\n accountPassword: \"Rooxxx456\",\n accountType: \"Super\",\n accountDesc: \"this is a super account\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_edbm_account_demo = volcenginecc.vedbm.Account(\"VEDBMAccountDemo\",\n instance_id=\"vedbm-r5zxxxxjdabv\",\n account_name=\"super_user\",\n account_password=\"Rooxxx456\",\n account_type=\"Super\",\n account_desc=\"this is a super account\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vEDBMAccountDemo = new Volcenginecc.Vedbm.Account(\"VEDBMAccountDemo\", new()\n {\n InstanceId = \"vedbm-r5zxxxxjdabv\",\n AccountName = \"super_user\",\n AccountPassword = \"Rooxxx456\",\n AccountType = \"Super\",\n AccountDesc = \"this is a super account\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vedbm\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vedbm.NewAccount(ctx, \"VEDBMAccountDemo\", \u0026vedbm.AccountArgs{\n\t\t\tInstanceId: pulumi.String(\"vedbm-r5zxxxxjdabv\"),\n\t\t\tAccountName: pulumi.String(\"super_user\"),\n\t\t\tAccountPassword: pulumi.String(\"Rooxxx456\"),\n\t\t\tAccountType: pulumi.String(\"Super\"),\n\t\t\tAccountDesc: pulumi.String(\"this is a super account\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vedbm.Account;\nimport com.volcengine.volcenginecc.vedbm.AccountArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vEDBMAccountDemo = new Account(\"vEDBMAccountDemo\", AccountArgs.builder()\n .instanceId(\"vedbm-r5zxxxxjdabv\")\n .accountName(\"super_user\")\n .accountPassword(\"Rooxxx456\")\n .accountType(\"Super\")\n .accountDesc(\"this is a super account\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vEDBMAccountDemo:\n type: volcenginecc:vedbm:Account\n name: VEDBMAccountDemo\n properties:\n instanceId: vedbm-r5zxxxxjdabv\n accountName: super_user\n accountPassword: Rooxxx456\n accountType: Super\n accountDesc: this is a super account\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vedbm/account:Account example \"instance_id|account_name\"\n```\n\n", "properties": { "accountDesc": { "type": "string", "description": "Account Description\n" }, "accountName": { "type": "string", "description": "Account Name\n" }, "accountPassword": { "type": "string", "description": "Database Account Password\n" }, "accountType": { "type": "string", "description": "Account Type\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "resetPrivilege": { "type": "boolean", "description": "Reset high-privilege account permissions. Only applicable to Super accounts. If users modify high-privilege account permissions via SQL on the backend, subsequent features may become unavailable. Therefore, this function is provided to restore all permissions with one click.\n" } }, "required": [ "accountDesc", "accountName", "accountPassword", "accountType", "instanceId", "resetPrivilege" ], "inputProperties": { "accountDesc": { "type": "string", "description": "Account Description\n" }, "accountName": { "type": "string", "description": "Account Name\n" }, "accountPassword": { "type": "string", "description": "Database Account Password\n" }, "accountType": { "type": "string", "description": "Account Type\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "resetPrivilege": { "type": "boolean", "description": "Reset high-privilege account permissions. Only applicable to Super accounts. If users modify high-privilege account permissions via SQL on the backend, subsequent features may become unavailable. Therefore, this function is provided to restore all permissions with one click.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Account resources.\n", "properties": { "accountDesc": { "type": "string", "description": "Account Description\n" }, "accountName": { "type": "string", "description": "Account Name\n" }, "accountPassword": { "type": "string", "description": "Database Account Password\n" }, "accountType": { "type": "string", "description": "Account Type\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "resetPrivilege": { "type": "boolean", "description": "Reset high-privilege account permissions. Only applicable to Super accounts. If users modify high-privilege account permissions via SQL on the backend, subsequent features may become unavailable. Therefore, this function is provided to restore all permissions with one click.\n" } }, "type": "object" } }, "volcenginecc:vedbm/allowList:AllowList": { "description": "vedbm access allowlist.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vEDBMAllowListDemo:\n type: volcenginecc:vedbm:AllowList\n name: VEDBMAllowListDemo\n properties:\n allowListType: IPv4\n allowList: 192.168.0.0/27,192.168.1.0/26\n allowListName: test\n allowListDesc: test\n projectName: default\n associatedInstances:\n - instance_id: vedbm-7chs5mtj2***\n - instance_id: vedbm-a5nwhmtj***\n modifyMode: Cover\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vedbm/allowList:AllowList example \"allow_list_id\"\n```\n\n", "properties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,). Duplicate entries are not allowed.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListDesc": { "type": "string", "description": "Allowlist description.\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or address ranges) in the allowlist.\n" }, "allowListName": { "type": "string", "description": "Allowlist name.\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is currently supported.\n" }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist.\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "modifyMode": { "type": "string", "description": "How to modify the allowlist. Supported settings: Cover (default): Overwrite the original allowlist with the values in the AllowList parameter. Append: Add IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain.\n" }, "projectName": { "type": "string", "description": "Project name associated with the allowlist. If left blank, the new allowlist will be added to the default project.\n" } }, "required": [ "allowList", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "modifyMode", "projectName" ], "inputProperties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,). Duplicate entries are not allowed.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListDesc": { "type": "string", "description": "Allowlist description.\n" }, "allowListName": { "type": "string", "description": "Allowlist name.\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is currently supported.\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "modifyMode": { "type": "string", "description": "How to modify the allowlist. Supported settings: Cover (default): Overwrite the original allowlist with the values in the AllowList parameter. Append: Add IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain.\n" }, "projectName": { "type": "string", "description": "Project name associated with the allowlist. If left blank, the new allowlist will be added to the default project.\n" } }, "requiredInputs": [ "allowListName" ], "stateInputs": { "description": "Input properties used for looking up and filtering AllowList resources.\n", "properties": { "allowList": { "type": "string", "description": "IP allowlist. Separate multiple IP addresses with commas (,). Duplicate entries are not allowed.\n", "language": { "csharp": { "name": "AllowListValue" } } }, "allowListDesc": { "type": "string", "description": "Allowlist description.\n" }, "allowListId": { "type": "string", "description": "Allowlist ID.\n" }, "allowListIpNum": { "type": "integer", "description": "Total number of IP addresses (or address ranges) in the allowlist.\n" }, "allowListName": { "type": "string", "description": "Allowlist name.\n" }, "allowListType": { "type": "string", "description": "IP address type in the allowlist. Only IPv4 is currently supported.\n" }, "associatedInstanceNum": { "type": "integer", "description": "Total number of instances bound to the allowlist.\n" }, "associatedInstances": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/AllowListAssociatedInstance:AllowListAssociatedInstance" } }, "modifyMode": { "type": "string", "description": "How to modify the allowlist. Supported settings: Cover (default): Overwrite the original allowlist with the values in the AllowList parameter. Append: Add IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain.\n" }, "projectName": { "type": "string", "description": "Project name associated with the allowlist. If left blank, the new allowlist will be added to the default project.\n" } }, "type": "object" } }, "volcenginecc:vedbm/backup:Backup": { "description": "Cloud Database veDB Backup Management\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vedbmbackupDemo = new volcenginecc.vedbm.Backup(\"vedbmbackupDemo\", {\n instanceId: \"vedbm-i34lvm3j***\",\n backupType: \"Full\",\n backupMethod: \"Physical\",\n backupTime: \"00:00Z-02:00Z\",\n fullBackupPeriod: \"Sunday\",\n backupRetentionPeriod: 11,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nvedbmbackup_demo = volcenginecc.vedbm.Backup(\"vedbmbackupDemo\",\n instance_id=\"vedbm-i34lvm3j***\",\n backup_type=\"Full\",\n backup_method=\"Physical\",\n backup_time=\"00:00Z-02:00Z\",\n full_backup_period=\"Sunday\",\n backup_retention_period=11)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vedbmbackupDemo = new Volcenginecc.Vedbm.Backup(\"vedbmbackupDemo\", new()\n {\n InstanceId = \"vedbm-i34lvm3j***\",\n BackupType = \"Full\",\n BackupMethod = \"Physical\",\n BackupTime = \"00:00Z-02:00Z\",\n FullBackupPeriod = \"Sunday\",\n BackupRetentionPeriod = 11,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vedbm\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vedbm.NewBackup(ctx, \"vedbmbackupDemo\", \u0026vedbm.BackupArgs{\n\t\t\tInstanceId: pulumi.String(\"vedbm-i34lvm3j***\"),\n\t\t\tBackupType: pulumi.String(\"Full\"),\n\t\t\tBackupMethod: pulumi.String(\"Physical\"),\n\t\t\tBackupTime: pulumi.String(\"00:00Z-02:00Z\"),\n\t\t\tFullBackupPeriod: pulumi.String(\"Sunday\"),\n\t\t\tBackupRetentionPeriod: pulumi.Int(11),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vedbm.Backup;\nimport com.volcengine.volcenginecc.vedbm.BackupArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vedbmbackupDemo = new Backup(\"vedbmbackupDemo\", BackupArgs.builder()\n .instanceId(\"vedbm-i34lvm3j***\")\n .backupType(\"Full\")\n .backupMethod(\"Physical\")\n .backupTime(\"00:00Z-02:00Z\")\n .fullBackupPeriod(\"Sunday\")\n .backupRetentionPeriod(11)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vedbmbackupDemo:\n type: volcenginecc:vedbm:Backup\n properties:\n instanceId: vedbm-i34lvm3j***\n backupType: Full\n backupMethod: Physical\n backupTime: 00:00Z-02:00Z\n fullBackupPeriod: Sunday\n backupRetentionPeriod: 11\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vedbm/backup:Backup example \"instance_id|backup_id\"\n```\n\n", "properties": { "backupEndTime": { "type": "string", "description": "Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "backupFileSize": { "type": "integer", "description": "Backup file size, unit: KiB\n" }, "backupId": { "type": "string", "description": "Backup ID\n" }, "backupMethod": { "type": "string", "description": "Backup method, currently only physical backup is supported\n" }, "backupRetentionPeriod": { "type": "integer", "description": "Data backup retention days\n" }, "backupStartTime": { "type": "string", "description": "Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "backupStatus": { "type": "string", "description": "Backup status\n" }, "backupTime": { "type": "string", "description": "Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)\n" }, "backupType": { "type": "string", "description": "Backup type, currently only full backup is supported\n" }, "consistentTime": { "type": "string", "description": "Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "continueBackup": { "type": "boolean", "description": "Enable continuous backup, value is always true\n" }, "createType": { "type": "string", "description": "Creation type\n" }, "fullBackupPeriod": { "type": "string", "description": "Full backup cycle, use commas (,) to separate multiple values\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "required": [ "backupEndTime", "backupFileSize", "backupId", "backupMethod", "backupRetentionPeriod", "backupStartTime", "backupStatus", "backupTime", "backupType", "consistentTime", "continueBackup", "createType", "fullBackupPeriod", "instanceId" ], "inputProperties": { "backupMethod": { "type": "string", "description": "Backup method, currently only physical backup is supported\n" }, "backupRetentionPeriod": { "type": "integer", "description": "Data backup retention days\n" }, "backupTime": { "type": "string", "description": "Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)\n" }, "backupType": { "type": "string", "description": "Backup type, currently only full backup is supported\n" }, "fullBackupPeriod": { "type": "string", "description": "Full backup cycle, use commas (,) to separate multiple values\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "requiredInputs": [ "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Backup resources.\n", "properties": { "backupEndTime": { "type": "string", "description": "Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "backupFileSize": { "type": "integer", "description": "Backup file size, unit: KiB\n" }, "backupId": { "type": "string", "description": "Backup ID\n" }, "backupMethod": { "type": "string", "description": "Backup method, currently only physical backup is supported\n" }, "backupRetentionPeriod": { "type": "integer", "description": "Data backup retention days\n" }, "backupStartTime": { "type": "string", "description": "Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "backupStatus": { "type": "string", "description": "Backup status\n" }, "backupTime": { "type": "string", "description": "Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)\n" }, "backupType": { "type": "string", "description": "Backup type, currently only full backup is supported\n" }, "consistentTime": { "type": "string", "description": "Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n" }, "continueBackup": { "type": "boolean", "description": "Enable continuous backup, value is always true\n" }, "createType": { "type": "string", "description": "Creation type\n" }, "fullBackupPeriod": { "type": "string", "description": "Full backup cycle, use commas (,) to separate multiple values\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "type": "object" } }, "volcenginecc:vedbm/database:Database": { "description": "Cloud Database Management\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vEDBMDatabaseDemo:\n type: volcenginecc:vedbm:Database\n name: VEDBMDatabaseDemo\n properties:\n dbName: testdb-tf\n instanceId: vedbm-ls2ehotj2***\n characterSetName: utf8mb4\n dbDesc: desctest\n databasesPrivileges:\n - account_name: test\n account_privilege: Custom\n account_privilege_detail:\n - SELECT\n - UPDATE\n - INSERT\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vedbm/database:Database example \"instance_id|db_name\"\n```\n\n", "properties": { "characterSetName": { "type": "string", "description": "Database character set. Options: utf8mb4 (default), utf8, latin1, ascii\n" }, "databasesPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/DatabaseDatabasesPrivilege:DatabaseDatabasesPrivilege" } }, "dbDesc": { "type": "string", "description": "Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)\n" }, "dbName": { "type": "string", "description": "Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "required": [ "characterSetName", "databasesPrivileges", "dbDesc", "dbName", "instanceId" ], "inputProperties": { "characterSetName": { "type": "string", "description": "Database character set. Options: utf8mb4 (default), utf8, latin1, ascii\n" }, "databasesPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/DatabaseDatabasesPrivilege:DatabaseDatabasesPrivilege" } }, "dbDesc": { "type": "string", "description": "Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)\n" }, "dbName": { "type": "string", "description": "Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "requiredInputs": [ "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Database resources.\n", "properties": { "characterSetName": { "type": "string", "description": "Database character set. Options: utf8mb4 (default), utf8, latin1, ascii\n" }, "databasesPrivileges": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/DatabaseDatabasesPrivilege:DatabaseDatabasesPrivilege" } }, "dbDesc": { "type": "string", "description": "Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)\n" }, "dbName": { "type": "string", "description": "Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" } }, "type": "object" } }, "volcenginecc:vedbm/endpoint:Endpoint": { "description": "Database connection terminal management\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vEDBMEndpointDemo:\n type: volcenginecc:vedbm:Endpoint\n name: VEDBMEndpointDemo\n properties:\n publicAddresses:\n eip_id: eip-ij2xxxxx74o8cubosgei\n autoAddNewNodes: true\n consistLevel: Eventual\n description: this is a test\n distributedTransaction: false\n endpointName: ccapi-test-1001\n endpointType: Custom\n instanceId: vedbm-jxxxxttjdcea\n masterAcceptReadRequests: false\n nodeIds:\n - vedbm-jxxxxttjdcea-1\n readWriteMode: ReadOnly\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vedbm/endpoint:Endpoint example \"instance_id|endpoint_id\"\n```\n\n", "properties": { "autoAddNewNodes": { "type": "boolean", "description": "Whether new read-only nodes are automatically added to this terminal\n" }, "consistLevel": { "type": "string", "description": "Consistency level\n" }, "consistTimeout": { "type": "integer", "description": "Data synchronization timeout\n" }, "consistTimeoutAction": { "type": "string", "description": "Policy after synchronization timeout\n" }, "description": { "type": "string", "description": "Description of the connection terminal\n" }, "distributedTransaction": { "type": "boolean", "description": "Enable transaction splitting\n" }, "domainPrefix": { "type": "string", "description": "New private network address prefix\n" }, "endpointId": { "type": "string", "description": "ID of the created connection terminal\n" }, "endpointName": { "type": "string", "description": "Connection terminal name\n" }, "endpointType": { "type": "string", "description": "Connection terminal type, fixed as Custom\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "masterAcceptReadRequests": { "type": "boolean", "description": "Whether the primary node accepts read requests\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node list configured for the connection terminal\n" }, "port": { "type": "string", "description": "Instance access port\n" }, "privateAddresses": { "$ref": "#/types/volcenginecc:vedbm/EndpointPrivateAddresses:EndpointPrivateAddresses", "description": "Private address information\n" }, "publicAddresses": { "$ref": "#/types/volcenginecc:vedbm/EndpointPublicAddresses:EndpointPublicAddresses", "description": "Public address information\n" }, "readWriteMode": { "type": "string", "description": "Terminal read/write mode\n" } }, "required": [ "autoAddNewNodes", "consistLevel", "consistTimeout", "consistTimeoutAction", "description", "distributedTransaction", "domainPrefix", "endpointId", "endpointName", "endpointType", "instanceId", "masterAcceptReadRequests", "nodeIds", "port", "privateAddresses", "publicAddresses", "readWriteMode" ], "inputProperties": { "autoAddNewNodes": { "type": "boolean", "description": "Whether new read-only nodes are automatically added to this terminal\n" }, "consistLevel": { "type": "string", "description": "Consistency level\n" }, "consistTimeout": { "type": "integer", "description": "Data synchronization timeout\n" }, "consistTimeoutAction": { "type": "string", "description": "Policy after synchronization timeout\n" }, "description": { "type": "string", "description": "Description of the connection terminal\n" }, "distributedTransaction": { "type": "boolean", "description": "Enable transaction splitting\n" }, "domainPrefix": { "type": "string", "description": "New private network address prefix\n" }, "endpointName": { "type": "string", "description": "Connection terminal name\n" }, "endpointType": { "type": "string", "description": "Connection terminal type, fixed as Custom\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "masterAcceptReadRequests": { "type": "boolean", "description": "Whether the primary node accepts read requests\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node list configured for the connection terminal\n" }, "port": { "type": "string", "description": "Instance access port\n" }, "privateAddresses": { "$ref": "#/types/volcenginecc:vedbm/EndpointPrivateAddresses:EndpointPrivateAddresses", "description": "Private address information\n" }, "publicAddresses": { "$ref": "#/types/volcenginecc:vedbm/EndpointPublicAddresses:EndpointPublicAddresses", "description": "Public address information\n" }, "readWriteMode": { "type": "string", "description": "Terminal read/write mode\n" } }, "requiredInputs": [ "instanceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Endpoint resources.\n", "properties": { "autoAddNewNodes": { "type": "boolean", "description": "Whether new read-only nodes are automatically added to this terminal\n" }, "consistLevel": { "type": "string", "description": "Consistency level\n" }, "consistTimeout": { "type": "integer", "description": "Data synchronization timeout\n" }, "consistTimeoutAction": { "type": "string", "description": "Policy after synchronization timeout\n" }, "description": { "type": "string", "description": "Description of the connection terminal\n" }, "distributedTransaction": { "type": "boolean", "description": "Enable transaction splitting\n" }, "domainPrefix": { "type": "string", "description": "New private network address prefix\n" }, "endpointId": { "type": "string", "description": "ID of the created connection terminal\n" }, "endpointName": { "type": "string", "description": "Connection terminal name\n" }, "endpointType": { "type": "string", "description": "Connection terminal type, fixed as Custom\n" }, "instanceId": { "type": "string", "description": "Instance ID\n" }, "masterAcceptReadRequests": { "type": "boolean", "description": "Whether the primary node accepts read requests\n" }, "nodeIds": { "type": "array", "items": { "type": "string" }, "description": "Node list configured for the connection terminal\n" }, "port": { "type": "string", "description": "Instance access port\n" }, "privateAddresses": { "$ref": "#/types/volcenginecc:vedbm/EndpointPrivateAddresses:EndpointPrivateAddresses", "description": "Private address information\n" }, "publicAddresses": { "$ref": "#/types/volcenginecc:vedbm/EndpointPublicAddresses:EndpointPublicAddresses", "description": "Public address information\n" }, "readWriteMode": { "type": "string", "description": "Terminal read/write mode\n" } }, "type": "object" } }, "volcenginecc:vedbm/instance:Instance": { "description": "veDB MySQL Edition is Volcano Engine's self-developed next-generation cloud-native relational database. veDB MySQL Edition is fully compatible with MySQL and supports diverse enterprise database application scenarios.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vEDBMInstanceDemo:\n type: volcenginecc:vedbm:Instance\n name: VEDBMInstanceDemo\n properties:\n instanceName: VEDBMInstanceDemo\n dbEngineVersion: MySQL_8_0\n dbMinorVersion: '3.0'\n nodeSpec: vedb.mysql.x4.medium\n zoneIds: cn-beijing-a\n nodeNumber: 2\n vpcId: vpc-1a1vgeoxxxccg8nvepjykjnuw\n subnetId: subnet-3nrd6xxx3log0931ech3re2r\n port: 3306\n superAccountName: username\n superAccountPassword: '*******'\n timeZone: UTC +08:00\n lowerCaseTableNames: '1'\n projectName: default\n tags:\n - key: dev\n value: test\n deletionProtection: enabled\n number: 1\n chargeDetail:\n charge_type: PostPaid\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vedbm/instance:Instance example \"instance_id\"\n```\n\n", "properties": { "chargeDetail": { "$ref": "#/types/volcenginecc:vedbm/InstanceChargeDetail:InstanceChargeDetail", "description": "Billing details.\n" }, "createdTime": { "type": "string", "description": "Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)\n" }, "dbEngineVersion": { "type": "string", "description": "Instance compatible version. Options: MySQL*8*0: Compatible with community MySQL 8.0. MySQL*5*7: Compatible with community MySQL 5.7\n" }, "dbMinorVersion": { "type": "string", "description": "Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL*5*7, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL*8*0, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.\n" }, "dbRevisionVersion": { "type": "string", "description": "Instance kernel version.\n" }, "deletionProtection": { "type": "string", "description": "Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/InstanceEndpoint:InstanceEndpoint" } }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "lowerCaseTableNames": { "type": "string", "description": "Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.\n" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:vedbm/InstanceMaintenanceWindow:InstanceMaintenanceWindow", "description": "Instance maintenance window information\n" }, "nodeNumber": { "type": "integer", "description": "Number of instance nodes. Value range: 2–16.\n" }, "nodeSpec": { "type": "string", "description": "Instance node specification code.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/InstanceNode:InstanceNode" } }, "number": { "type": "integer", "description": "Number of instances to create. Range: 1~50. Default: 1\n" }, "port": { "type": "integer", "description": "Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.\n" }, "prePaidStorageInGb": { "type": "integer", "description": "Total prepaid storage capacity, in GiB\n" }, "projectName": { "type": "string", "description": "Project name to which the instance belongs.\n" }, "specFamily": { "type": "string", "description": "Instance specification type. Values: General: general purpose. Exclusive: dedicated.\n" }, "storageChargeType": { "type": "string", "description": "Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).\n" }, "storageUsedGiB": { "type": "number", "description": "Used storage space, in GiB\n" }, "subnetId": { "type": "string", "description": "Subnet ID. The subnet must belong to the selected availability zone.\n" }, "superAccountName": { "type": "string", "description": "Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords\n" }, "superAccountPassword": { "type": "string", "description": "Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^\u0026*_-+=`|(){}[]:;'\u003c\u003e,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/InstanceTag:InstanceTag" } }, "templateId": { "type": "string", "description": "Parameter template ID\n" }, "timeZone": { "type": "string", "description": "Instance time zone. The default time zone for all regions in China is UTC +08:00.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID.\n" }, "zoneIds": { "type": "string", "description": "Availability zone ID\n" } }, "required": [ "chargeDetail", "createdTime", "dbEngineVersion", "dbMinorVersion", "dbRevisionVersion", "deletionProtection", "endpoints", "instanceId", "instanceName", "instanceStatus", "lowerCaseTableNames", "maintenanceWindow", "nodeNumber", "nodeSpec", "nodes", "number", "port", "prePaidStorageInGb", "projectName", "specFamily", "storageChargeType", "storageUsedGiB", "subnetId", "superAccountName", "superAccountPassword", "tags", "templateId", "timeZone", "vpcId", "zoneIds" ], "inputProperties": { "chargeDetail": { "$ref": "#/types/volcenginecc:vedbm/InstanceChargeDetail:InstanceChargeDetail", "description": "Billing details.\n" }, "dbEngineVersion": { "type": "string", "description": "Instance compatible version. Options: MySQL*8*0: Compatible with community MySQL 8.0. MySQL*5*7: Compatible with community MySQL 5.7\n" }, "dbMinorVersion": { "type": "string", "description": "Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL*5*7, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL*8*0, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.\n" }, "deletionProtection": { "type": "string", "description": "Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.\n" }, "instanceName": { "type": "string", "description": "Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n" }, "lowerCaseTableNames": { "type": "string", "description": "Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.\n" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:vedbm/InstanceMaintenanceWindow:InstanceMaintenanceWindow", "description": "Instance maintenance window information\n" }, "nodeNumber": { "type": "integer", "description": "Number of instance nodes. Value range: 2–16.\n" }, "nodeSpec": { "type": "string", "description": "Instance node specification code.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/InstanceNode:InstanceNode" } }, "number": { "type": "integer", "description": "Number of instances to create. Range: 1~50. Default: 1\n" }, "port": { "type": "integer", "description": "Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.\n" }, "prePaidStorageInGb": { "type": "integer", "description": "Total prepaid storage capacity, in GiB\n" }, "projectName": { "type": "string", "description": "Project name to which the instance belongs.\n" }, "storageChargeType": { "type": "string", "description": "Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).\n" }, "subnetId": { "type": "string", "description": "Subnet ID. The subnet must belong to the selected availability zone.\n" }, "superAccountName": { "type": "string", "description": "Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords\n" }, "superAccountPassword": { "type": "string", "description": "Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^\u0026*_-+=`|(){}[]:;'\u003c\u003e,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/InstanceTag:InstanceTag" } }, "templateId": { "type": "string", "description": "Parameter template ID\n" }, "timeZone": { "type": "string", "description": "Instance time zone. The default time zone for all regions in China is UTC +08:00.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID.\n" }, "zoneIds": { "type": "string", "description": "Availability zone ID\n" } }, "requiredInputs": [ "dbEngineVersion", "nodeNumber", "nodeSpec", "subnetId", "vpcId", "zoneIds" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "chargeDetail": { "$ref": "#/types/volcenginecc:vedbm/InstanceChargeDetail:InstanceChargeDetail", "description": "Billing details.\n" }, "createdTime": { "type": "string", "description": "Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)\n" }, "dbEngineVersion": { "type": "string", "description": "Instance compatible version. Options: MySQL*8*0: Compatible with community MySQL 8.0. MySQL*5*7: Compatible with community MySQL 5.7\n" }, "dbMinorVersion": { "type": "string", "description": "Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL*5*7, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL*8*0, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.\n" }, "dbRevisionVersion": { "type": "string", "description": "Instance kernel version.\n" }, "deletionProtection": { "type": "string", "description": "Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/InstanceEndpoint:InstanceEndpoint" } }, "instanceId": { "type": "string", "description": "Instance ID.\n" }, "instanceName": { "type": "string", "description": "Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n" }, "instanceStatus": { "type": "string", "description": "Instance status.\n" }, "lowerCaseTableNames": { "type": "string", "description": "Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.\n" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:vedbm/InstanceMaintenanceWindow:InstanceMaintenanceWindow", "description": "Instance maintenance window information\n" }, "nodeNumber": { "type": "integer", "description": "Number of instance nodes. Value range: 2–16.\n" }, "nodeSpec": { "type": "string", "description": "Instance node specification code.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/InstanceNode:InstanceNode" } }, "number": { "type": "integer", "description": "Number of instances to create. Range: 1~50. Default: 1\n" }, "port": { "type": "integer", "description": "Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.\n" }, "prePaidStorageInGb": { "type": "integer", "description": "Total prepaid storage capacity, in GiB\n" }, "projectName": { "type": "string", "description": "Project name to which the instance belongs.\n" }, "specFamily": { "type": "string", "description": "Instance specification type. Values: General: general purpose. Exclusive: dedicated.\n" }, "storageChargeType": { "type": "string", "description": "Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).\n" }, "storageUsedGiB": { "type": "number", "description": "Used storage space, in GiB\n" }, "subnetId": { "type": "string", "description": "Subnet ID. The subnet must belong to the selected availability zone.\n" }, "superAccountName": { "type": "string", "description": "Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords\n" }, "superAccountPassword": { "type": "string", "description": "Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^\u0026*_-+=`|(){}[]:;'\u003c\u003e,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vedbm/InstanceTag:InstanceTag" } }, "templateId": { "type": "string", "description": "Parameter template ID\n" }, "timeZone": { "type": "string", "description": "Instance time zone. The default time zone for all regions in China is UTC +08:00.\n" }, "vpcId": { "type": "string", "description": "Private network (VPC) ID.\n" }, "zoneIds": { "type": "string", "description": "Availability zone ID\n" } }, "type": "object" } }, "volcenginecc:vefaas/function:Function": { "description": "A function consists of function code and function configuration. It is the basic unit for scheduling and running function code.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vefaasFunctionDemo:\n type: volcenginecc:vefaas:Function\n name: VefaasFunctionDemo\n properties:\n name: VefaasFunction1001\n runtime: native/v1\n exclusiveMode: false\n maxConcurrency: 10\n memoryMb: 512\n requestTimeout: 30\n port: 8000\n vpcConfig:\n enable_vpc: true\n vpc_id: vpc-rrco37ovjq4gxxxxxxx\n subnet_ids:\n - subnet-rrwqhg3qzxxxxxxxx\n security_group_ids:\n - sg-rrco3fkzzy0wxxxxxxxxxxxx\n enable_shared_internet_access: true\n command: ./run.sh\n enableApmplus: false\n projectName: default\n nasStorage:\n enable_nas: true\n nas_configs:\n - remotePath: /\n localMountPath: /mnt/nas\n mountPointId: mount-xxxxxxx\n fileSystemId: enas-cnbja0bxxxxxxx\n gid: 1000\n uid: 1000\n tosMountConfig:\n enable_tos: true\n credentials:\n accessKeyId: AK**************\n secretAccessKey: '*****************=='\n mount_points:\n - bucketPath: /\n localMountPath: /mnt/tos\n readOnly: false\n bucketName: ccapi-register-test\n endpoint: http://tos-cn-beijing.ivolces.com\n envs:\n - key: env\n value: test\n asyncTaskConfig:\n enable_async_task: true\n max_retry: 2\n destination_config:\n onFailure:\n destination: https://ccapi-failure.com\n onSuccess:\n destination: https://ccapi-success.com\n role: trn:iam::*******:role/xxxxxxx\n tlsConfig:\n enable_log: true\n tls_project_id: 9248d829-21b0-43e2-a2f6-xxxxxxxxx\n tls_topic_id: 84baf7cf-0f60-44e0-a5f6-xxxxxxxxx\n source: https://vefaas-prod-xxxxxxxxxPAYLOAD\u0026X-Tos-Credential=AKxxxxxxxxxxxxFtos-cn-beijing.volces.com%2Ftos%2Frequest\u0026X-Tos-Date=20260327T080542Z\u0026X-Tos-Expires=1800\u0026X-Tos-SignedHeaders=host\u0026X-Tos-Signature=5a60f816def2be59baxxxxxxxxxxxxx\n sourceType: tos\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vefaas/function:Function example \"function_id\"\n```\n\n", "properties": { "asyncTaskConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionAsyncTaskConfig:FunctionAsyncTaskConfig", "description": "Asynchronous task configuration\n" }, "codeSize": { "type": "integer", "description": "Code package size (MB).\n" }, "codeSizeLimit": { "type": "integer", "description": "Code package size limit. SourceType=zip, CodeSizeLimit=15MB. SourceType=tos, CodeSizeLimit=256MB.\n" }, "command": { "type": "string", "description": "Custom startup command for the instance (currently only supported in native/v1 runtime)\n" }, "cpuStrategy": { "type": "string", "description": "Function CPU billing policy. When creating a microservice application type function, this field must be set to always, meaning at least one instance is running. Other function types do not support this field\n" }, "creationTime": { "type": "string", "description": "Function creation time\n" }, "description": { "type": "string", "description": "Function description. Up to 1000 Unicode characters\n" }, "enableApmplus": { "type": "boolean", "description": "Whether to enable application monitoring\n" }, "envs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/FunctionEnv:FunctionEnv" } }, "exclusiveMode": { "type": "boolean", "description": "Exclusive mode switch. true: disables multi-concurrency per instance, i.e., exclusive mode where a single instance can only handle one request at a time. false (default): enables multi-concurrency per instance, i.e., non-exclusive mode where a single instance can handle multiple requests at the same time. You can set the maximum concurrent requests per instance using MaxConcurrency.\n" }, "functionId": { "type": "string", "description": "Function ID\n" }, "initializerSec": { "type": "integer", "description": "Function initialization timeout configuration\n" }, "instanceType": { "type": "string", "description": "Instance type of the function instance. Null value: CPU instance. Non-null value: GPU instance.\n" }, "lastUpdateTime": { "type": "string", "description": "Function update time.\n" }, "maxConcurrency": { "type": "integer", "description": "Maximum concurrency per instance. Effective when ExclusiveMode = false. Range: 1–1000\n" }, "memoryMb": { "type": "integer", "description": "Maximum memory per instance, unit: MiB. Range: 512–4096, in increments of 512. Default: 1024\n" }, "name": { "type": "string", "description": "Function name. Function names must be unique within the same account. Function names support uppercase and lowercase English letters, numbers, hyphens (-), and underscores (_), with a length limit of 4–64 characters.\n" }, "nasStorage": { "$ref": "#/types/volcenginecc:vefaas/FunctionNasStorage:FunctionNasStorage", "description": "NAS file storage mount configuration\n" }, "owner": { "type": "string", "description": "Function owner (Account Id).\n" }, "port": { "type": "integer", "description": "Custom listening port for the instance (currently only supported in native/v1 runtime)\n" }, "projectName": { "type": "string", "description": "Project name associated with the function\n" }, "requestTimeout": { "type": "integer", "description": "Request timeout. Unit: seconds. Range: 1–900. Default: 30.\n" }, "role": { "type": "string", "description": "IAM role bound to the function instance\n" }, "runtime": { "type": "string", "description": "Function runtime. Values: golang/v1, native/v1, nativejava8/v1, node14/v1, node20/v1, nodeprime14/v1, python3.12/v1, python3.8/v1, python3.9/v1.\n" }, "source": { "type": "string", "description": "Code source. Values: zip: Base64-encoded binary ZIP file; tos: string in the format bucket*name:object*key; image: image address in the format host/namespace/repo:tag\n" }, "sourceAccessConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionSourceAccessConfig:FunctionSourceAccessConfig", "description": "Image repository access configuration.\n" }, "sourceType": { "type": "string", "description": "Code source type. Values: tos: object storage (TOS); zip: local compressed file; image: image repository (CR), supports Basic and Enterprise editions\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/FunctionTag:FunctionTag" } }, "tlsConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionTlsConfig:FunctionTlsConfig", "description": "TLS configuration for Log Service\n" }, "tosMountConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionTosMountConfig:FunctionTosMountConfig", "description": "TOS object storage mount configuration\n" }, "triggersCount": { "type": "integer", "description": "Number of triggers for this function.\n" }, "vpcConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionVpcConfig:FunctionVpcConfig", "description": "Private network VPC configuration.\n" } }, "required": [ "asyncTaskConfig", "codeSize", "codeSizeLimit", "command", "cpuStrategy", "creationTime", "description", "enableApmplus", "envs", "exclusiveMode", "functionId", "initializerSec", "instanceType", "lastUpdateTime", "maxConcurrency", "memoryMb", "name", "nasStorage", "owner", "port", "projectName", "requestTimeout", "role", "runtime", "source", "sourceAccessConfig", "sourceType", "tags", "tlsConfig", "tosMountConfig", "triggersCount", "vpcConfig" ], "inputProperties": { "asyncTaskConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionAsyncTaskConfig:FunctionAsyncTaskConfig", "description": "Asynchronous task configuration\n" }, "command": { "type": "string", "description": "Custom startup command for the instance (currently only supported in native/v1 runtime)\n" }, "cpuStrategy": { "type": "string", "description": "Function CPU billing policy. When creating a microservice application type function, this field must be set to always, meaning at least one instance is running. Other function types do not support this field\n" }, "description": { "type": "string", "description": "Function description. Up to 1000 Unicode characters\n" }, "enableApmplus": { "type": "boolean", "description": "Whether to enable application monitoring\n" }, "envs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/FunctionEnv:FunctionEnv" } }, "exclusiveMode": { "type": "boolean", "description": "Exclusive mode switch. true: disables multi-concurrency per instance, i.e., exclusive mode where a single instance can only handle one request at a time. false (default): enables multi-concurrency per instance, i.e., non-exclusive mode where a single instance can handle multiple requests at the same time. You can set the maximum concurrent requests per instance using MaxConcurrency.\n" }, "initializerSec": { "type": "integer", "description": "Function initialization timeout configuration\n" }, "maxConcurrency": { "type": "integer", "description": "Maximum concurrency per instance. Effective when ExclusiveMode = false. Range: 1–1000\n" }, "memoryMb": { "type": "integer", "description": "Maximum memory per instance, unit: MiB. Range: 512–4096, in increments of 512. Default: 1024\n" }, "name": { "type": "string", "description": "Function name. Function names must be unique within the same account. Function names support uppercase and lowercase English letters, numbers, hyphens (-), and underscores (_), with a length limit of 4–64 characters.\n" }, "nasStorage": { "$ref": "#/types/volcenginecc:vefaas/FunctionNasStorage:FunctionNasStorage", "description": "NAS file storage mount configuration\n" }, "port": { "type": "integer", "description": "Custom listening port for the instance (currently only supported in native/v1 runtime)\n" }, "projectName": { "type": "string", "description": "Project name associated with the function\n" }, "requestTimeout": { "type": "integer", "description": "Request timeout. Unit: seconds. Range: 1–900. Default: 30.\n" }, "role": { "type": "string", "description": "IAM role bound to the function instance\n" }, "runtime": { "type": "string", "description": "Function runtime. Values: golang/v1, native/v1, nativejava8/v1, node14/v1, node20/v1, nodeprime14/v1, python3.12/v1, python3.8/v1, python3.9/v1.\n" }, "source": { "type": "string", "description": "Code source. Values: zip: Base64-encoded binary ZIP file; tos: string in the format bucket*name:object*key; image: image address in the format host/namespace/repo:tag\n" }, "sourceAccessConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionSourceAccessConfig:FunctionSourceAccessConfig", "description": "Image repository access configuration.\n" }, "sourceType": { "type": "string", "description": "Code source type. Values: tos: object storage (TOS); zip: local compressed file; image: image repository (CR), supports Basic and Enterprise editions\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/FunctionTag:FunctionTag" } }, "tlsConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionTlsConfig:FunctionTlsConfig", "description": "TLS configuration for Log Service\n" }, "tosMountConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionTosMountConfig:FunctionTosMountConfig", "description": "TOS object storage mount configuration\n" }, "vpcConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionVpcConfig:FunctionVpcConfig", "description": "Private network VPC configuration.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Function resources.\n", "properties": { "asyncTaskConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionAsyncTaskConfig:FunctionAsyncTaskConfig", "description": "Asynchronous task configuration\n" }, "codeSize": { "type": "integer", "description": "Code package size (MB).\n" }, "codeSizeLimit": { "type": "integer", "description": "Code package size limit. SourceType=zip, CodeSizeLimit=15MB. SourceType=tos, CodeSizeLimit=256MB.\n" }, "command": { "type": "string", "description": "Custom startup command for the instance (currently only supported in native/v1 runtime)\n" }, "cpuStrategy": { "type": "string", "description": "Function CPU billing policy. When creating a microservice application type function, this field must be set to always, meaning at least one instance is running. Other function types do not support this field\n" }, "creationTime": { "type": "string", "description": "Function creation time\n" }, "description": { "type": "string", "description": "Function description. Up to 1000 Unicode characters\n" }, "enableApmplus": { "type": "boolean", "description": "Whether to enable application monitoring\n" }, "envs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/FunctionEnv:FunctionEnv" } }, "exclusiveMode": { "type": "boolean", "description": "Exclusive mode switch. true: disables multi-concurrency per instance, i.e., exclusive mode where a single instance can only handle one request at a time. false (default): enables multi-concurrency per instance, i.e., non-exclusive mode where a single instance can handle multiple requests at the same time. You can set the maximum concurrent requests per instance using MaxConcurrency.\n" }, "functionId": { "type": "string", "description": "Function ID\n" }, "initializerSec": { "type": "integer", "description": "Function initialization timeout configuration\n" }, "instanceType": { "type": "string", "description": "Instance type of the function instance. Null value: CPU instance. Non-null value: GPU instance.\n" }, "lastUpdateTime": { "type": "string", "description": "Function update time.\n" }, "maxConcurrency": { "type": "integer", "description": "Maximum concurrency per instance. Effective when ExclusiveMode = false. Range: 1–1000\n" }, "memoryMb": { "type": "integer", "description": "Maximum memory per instance, unit: MiB. Range: 512–4096, in increments of 512. Default: 1024\n" }, "name": { "type": "string", "description": "Function name. Function names must be unique within the same account. Function names support uppercase and lowercase English letters, numbers, hyphens (-), and underscores (_), with a length limit of 4–64 characters.\n" }, "nasStorage": { "$ref": "#/types/volcenginecc:vefaas/FunctionNasStorage:FunctionNasStorage", "description": "NAS file storage mount configuration\n" }, "owner": { "type": "string", "description": "Function owner (Account Id).\n" }, "port": { "type": "integer", "description": "Custom listening port for the instance (currently only supported in native/v1 runtime)\n" }, "projectName": { "type": "string", "description": "Project name associated with the function\n" }, "requestTimeout": { "type": "integer", "description": "Request timeout. Unit: seconds. Range: 1–900. Default: 30.\n" }, "role": { "type": "string", "description": "IAM role bound to the function instance\n" }, "runtime": { "type": "string", "description": "Function runtime. Values: golang/v1, native/v1, nativejava8/v1, node14/v1, node20/v1, nodeprime14/v1, python3.12/v1, python3.8/v1, python3.9/v1.\n" }, "source": { "type": "string", "description": "Code source. Values: zip: Base64-encoded binary ZIP file; tos: string in the format bucket*name:object*key; image: image address in the format host/namespace/repo:tag\n" }, "sourceAccessConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionSourceAccessConfig:FunctionSourceAccessConfig", "description": "Image repository access configuration.\n" }, "sourceType": { "type": "string", "description": "Code source type. Values: tos: object storage (TOS); zip: local compressed file; image: image repository (CR), supports Basic and Enterprise editions\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/FunctionTag:FunctionTag" } }, "tlsConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionTlsConfig:FunctionTlsConfig", "description": "TLS configuration for Log Service\n" }, "tosMountConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionTosMountConfig:FunctionTosMountConfig", "description": "TOS object storage mount configuration\n" }, "triggersCount": { "type": "integer", "description": "Number of triggers for this function.\n" }, "vpcConfig": { "$ref": "#/types/volcenginecc:vefaas/FunctionVpcConfig:FunctionVpcConfig", "description": "Private network VPC configuration.\n" } }, "type": "object" } }, "volcenginecc:vefaas/kafkaTrigger:KafkaTrigger": { "description": "Function service supports integration with Kafka message queue. By creating a Kafka trigger, the function service acts as a consumer to consume messages from Kafka and passes them to your function, triggering your function logic. You do not need to handle the details of message consumption; just write the function to process messages.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vefaasTriggerDemo = new volcenginecc.vefaas.KafkaTrigger(\"VefaasTriggerDemo\", {\n functionId: \"djb27tnr****\",\n name: \"VefaasTriggerDemo\",\n maximumRetryAttempts: 74,\n startingPosition: \"Earliest\",\n enabled: false,\n kafkaCredentials: {\n mechanism: \"PLAIN\",\n username: \"VefaasTriggerDemo\",\n password: \"*****\",\n },\n mqInstanceId: \"kafka-cnng8cm4q2fncrvs****\",\n topicName: \"VefaasTriggerDemo\",\n description: \"VefaasTriggerDemo description\",\n batchFlushDurationMilliseconds: 8637,\n batchSize: 709,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nvefaas_trigger_demo = volcenginecc.vefaas.KafkaTrigger(\"VefaasTriggerDemo\",\n function_id=\"djb27tnr****\",\n name=\"VefaasTriggerDemo\",\n maximum_retry_attempts=74,\n starting_position=\"Earliest\",\n enabled=False,\n kafka_credentials={\n \"mechanism\": \"PLAIN\",\n \"username\": \"VefaasTriggerDemo\",\n \"password\": \"*****\",\n },\n mq_instance_id=\"kafka-cnng8cm4q2fncrvs****\",\n topic_name=\"VefaasTriggerDemo\",\n description=\"VefaasTriggerDemo description\",\n batch_flush_duration_milliseconds=8637,\n batch_size=709)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vefaasTriggerDemo = new Volcenginecc.Vefaas.KafkaTrigger(\"VefaasTriggerDemo\", new()\n {\n FunctionId = \"djb27tnr****\",\n Name = \"VefaasTriggerDemo\",\n MaximumRetryAttempts = 74,\n StartingPosition = \"Earliest\",\n Enabled = false,\n KafkaCredentials = new Volcenginecc.Vefaas.Inputs.KafkaTriggerKafkaCredentialsArgs\n {\n Mechanism = \"PLAIN\",\n Username = \"VefaasTriggerDemo\",\n Password = \"*****\",\n },\n MqInstanceId = \"kafka-cnng8cm4q2fncrvs****\",\n TopicName = \"VefaasTriggerDemo\",\n Description = \"VefaasTriggerDemo description\",\n BatchFlushDurationMilliseconds = 8637,\n BatchSize = 709,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vefaas\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vefaas.NewKafkaTrigger(ctx, \"VefaasTriggerDemo\", \u0026vefaas.KafkaTriggerArgs{\n\t\t\tFunctionId: pulumi.String(\"djb27tnr****\"),\n\t\t\tName: pulumi.String(\"VefaasTriggerDemo\"),\n\t\t\tMaximumRetryAttempts: pulumi.Int(74),\n\t\t\tStartingPosition: pulumi.String(\"Earliest\"),\n\t\t\tEnabled: pulumi.Bool(false),\n\t\t\tKafkaCredentials: \u0026vefaas.KafkaTriggerKafkaCredentialsArgs{\n\t\t\t\tMechanism: pulumi.String(\"PLAIN\"),\n\t\t\t\tUsername: pulumi.String(\"VefaasTriggerDemo\"),\n\t\t\t\tPassword: pulumi.String(\"*****\"),\n\t\t\t},\n\t\t\tMqInstanceId: pulumi.String(\"kafka-cnng8cm4q2fncrvs****\"),\n\t\t\tTopicName: pulumi.String(\"VefaasTriggerDemo\"),\n\t\t\tDescription: pulumi.String(\"VefaasTriggerDemo description\"),\n\t\t\tBatchFlushDurationMilliseconds: pulumi.Int(8637),\n\t\t\tBatchSize: pulumi.Int(709),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vefaas.KafkaTrigger;\nimport com.volcengine.volcenginecc.vefaas.KafkaTriggerArgs;\nimport com.pulumi.volcenginecc.vefaas.inputs.KafkaTriggerKafkaCredentialsArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vefaasTriggerDemo = new KafkaTrigger(\"vefaasTriggerDemo\", KafkaTriggerArgs.builder()\n .functionId(\"djb27tnr****\")\n .name(\"VefaasTriggerDemo\")\n .maximumRetryAttempts(74)\n .startingPosition(\"Earliest\")\n .enabled(false)\n .kafkaCredentials(KafkaTriggerKafkaCredentialsArgs.builder()\n .mechanism(\"PLAIN\")\n .username(\"VefaasTriggerDemo\")\n .password(\"*****\")\n .build())\n .mqInstanceId(\"kafka-cnng8cm4q2fncrvs****\")\n .topicName(\"VefaasTriggerDemo\")\n .description(\"VefaasTriggerDemo description\")\n .batchFlushDurationMilliseconds(8637)\n .batchSize(709)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vefaasTriggerDemo:\n type: volcenginecc:vefaas:KafkaTrigger\n name: VefaasTriggerDemo\n properties:\n functionId: djb27tnr****\n name: VefaasTriggerDemo\n maximumRetryAttempts: 74\n startingPosition: Earliest\n enabled: false\n kafkaCredentials:\n mechanism: PLAIN\n username: VefaasTriggerDemo\n password: '*****'\n mqInstanceId: kafka-cnng8cm4q2fncrvs****\n topicName: VefaasTriggerDemo\n description: VefaasTriggerDemo description\n batchFlushDurationMilliseconds: 8637\n batchSize: 709\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vefaas/kafkaTrigger:KafkaTrigger example \"function_id|kafka_trigger_id\"\n```\n\n", "properties": { "batchFlushDurationMilliseconds": { "type": "integer", "description": "Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.\n" }, "batchSize": { "type": "integer", "description": "Number of messages per batch for trigger batch consumption.\n" }, "consumerGroup": { "type": "string", "description": "Consumer group name of the Kafka message queue instance.\n" }, "createdTime": { "type": "string", "description": "Kafka trigger creation time.\n" }, "description": { "type": "string", "description": "Description of the Kafka trigger. Limited to 200 characters.\n" }, "enabled": { "type": "boolean", "description": "Enable the trigger when creating it. Options: true—enable. false—disable.\n" }, "functionId": { "type": "string", "description": "Function ID.\n" }, "kafkaCredentials": { "$ref": "#/types/volcenginecc:vefaas/KafkaTriggerKafkaCredentials:KafkaTriggerKafkaCredentials", "description": "Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.\n" }, "kafkaTriggerId": { "type": "string", "description": "Kafka trigger ID.\n" }, "maximumRetryAttempts": { "type": "integer", "description": "Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.\n" }, "mqInstanceId": { "type": "string", "description": "Kafka message queue instance ID.\n" }, "name": { "type": "string", "description": "Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.\n" }, "startingPosition": { "type": "string", "description": "Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.\n" }, "status": { "type": "string", "description": "Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.\n" }, "topicName": { "type": "string", "description": "Topic name of the Kafka message queue instance.\n" }, "updatedTime": { "type": "string", "description": "Last update time of the Kafka trigger.\n" } }, "required": [ "batchFlushDurationMilliseconds", "batchSize", "consumerGroup", "createdTime", "description", "enabled", "functionId", "kafkaCredentials", "kafkaTriggerId", "maximumRetryAttempts", "mqInstanceId", "name", "startingPosition", "status", "topicName", "updatedTime" ], "inputProperties": { "batchFlushDurationMilliseconds": { "type": "integer", "description": "Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.\n" }, "batchSize": { "type": "integer", "description": "Number of messages per batch for trigger batch consumption.\n" }, "description": { "type": "string", "description": "Description of the Kafka trigger. Limited to 200 characters.\n" }, "enabled": { "type": "boolean", "description": "Enable the trigger when creating it. Options: true—enable. false—disable.\n" }, "functionId": { "type": "string", "description": "Function ID.\n" }, "kafkaCredentials": { "$ref": "#/types/volcenginecc:vefaas/KafkaTriggerKafkaCredentials:KafkaTriggerKafkaCredentials", "description": "Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.\n" }, "maximumRetryAttempts": { "type": "integer", "description": "Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.\n" }, "mqInstanceId": { "type": "string", "description": "Kafka message queue instance ID.\n" }, "name": { "type": "string", "description": "Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.\n" }, "startingPosition": { "type": "string", "description": "Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.\n" }, "topicName": { "type": "string", "description": "Topic name of the Kafka message queue instance.\n" } }, "requiredInputs": [ "functionId", "kafkaCredentials", "mqInstanceId", "name", "topicName" ], "stateInputs": { "description": "Input properties used for looking up and filtering KafkaTrigger resources.\n", "properties": { "batchFlushDurationMilliseconds": { "type": "integer", "description": "Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.\n" }, "batchSize": { "type": "integer", "description": "Number of messages per batch for trigger batch consumption.\n" }, "consumerGroup": { "type": "string", "description": "Consumer group name of the Kafka message queue instance.\n" }, "createdTime": { "type": "string", "description": "Kafka trigger creation time.\n" }, "description": { "type": "string", "description": "Description of the Kafka trigger. Limited to 200 characters.\n" }, "enabled": { "type": "boolean", "description": "Enable the trigger when creating it. Options: true—enable. false—disable.\n" }, "functionId": { "type": "string", "description": "Function ID.\n" }, "kafkaCredentials": { "$ref": "#/types/volcenginecc:vefaas/KafkaTriggerKafkaCredentials:KafkaTriggerKafkaCredentials", "description": "Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.\n" }, "kafkaTriggerId": { "type": "string", "description": "Kafka trigger ID.\n" }, "maximumRetryAttempts": { "type": "integer", "description": "Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.\n" }, "mqInstanceId": { "type": "string", "description": "Kafka message queue instance ID.\n" }, "name": { "type": "string", "description": "Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.\n" }, "startingPosition": { "type": "string", "description": "Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.\n" }, "status": { "type": "string", "description": "Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.\n" }, "topicName": { "type": "string", "description": "Topic name of the Kafka message queue instance.\n" }, "updatedTime": { "type": "string", "description": "Last update time of the Kafka trigger.\n" } }, "type": "object" } }, "volcenginecc:vefaas/release:Release": { "description": "Function to release\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vEFAASReleaseDemo = new volcenginecc.vefaas.Release(\"VEFAASReleaseDemo\", {\n functionId: \"xxxxxxxx\",\n revisionNumber: 0,\n targetTrafficWeight: 100,\n rollingStep: 100,\n description: \"ccapi-test\",\n maxInstance: 10,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_efaas_release_demo = volcenginecc.vefaas.Release(\"VEFAASReleaseDemo\",\n function_id=\"xxxxxxxx\",\n revision_number=0,\n target_traffic_weight=100,\n rolling_step=100,\n description=\"ccapi-test\",\n max_instance=10)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vEFAASReleaseDemo = new Volcenginecc.Vefaas.Release(\"VEFAASReleaseDemo\", new()\n {\n FunctionId = \"xxxxxxxx\",\n RevisionNumber = 0,\n TargetTrafficWeight = 100,\n RollingStep = 100,\n Description = \"ccapi-test\",\n MaxInstance = 10,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vefaas\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vefaas.NewRelease(ctx, \"VEFAASReleaseDemo\", \u0026vefaas.ReleaseArgs{\n\t\t\tFunctionId: pulumi.String(\"xxxxxxxx\"),\n\t\t\tRevisionNumber: pulumi.Int(0),\n\t\t\tTargetTrafficWeight: pulumi.Int(100),\n\t\t\tRollingStep: pulumi.Int(100),\n\t\t\tDescription: pulumi.String(\"ccapi-test\"),\n\t\t\tMaxInstance: pulumi.Int(10),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vefaas.Release;\nimport com.volcengine.volcenginecc.vefaas.ReleaseArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vEFAASReleaseDemo = new Release(\"vEFAASReleaseDemo\", ReleaseArgs.builder()\n .functionId(\"xxxxxxxx\")\n .revisionNumber(0)\n .targetTrafficWeight(100)\n .rollingStep(100)\n .description(\"ccapi-test\")\n .maxInstance(10)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vEFAASReleaseDemo:\n type: volcenginecc:vefaas:Release\n name: VEFAASReleaseDemo\n properties:\n functionId: xxxxxxxx\n revisionNumber: 0\n targetTrafficWeight: 100\n rollingStep: 100\n description: ccapi-test\n maxInstance: 10\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vefaas/release:Release example \"function_id\"\n```\n\n", "properties": { "creationTime": { "type": "string", "description": "Creation time\n" }, "currentTrafficWeight": { "type": "integer", "description": "Current release traffic percentage. Valid values: 1–100, indicates the proportion of traffic assigned to the currently releasing version. Returned only when status is inprogress or failed\n" }, "description": { "type": "string", "description": "Description for this release\n" }, "errorCode": { "type": "string", "description": "Error codes for release failures: function*start*failed: function startup failed function*start*timeout: function startup timed out function*health*check*failed: function health check failed system*internal_error: internal system error\n" }, "failedInstanceLogs": { "type": "string", "description": "Download link for logs of failed release instances\n" }, "finishTime": { "type": "string", "description": "Completion time\n" }, "functionId": { "type": "string", "description": "Function ID\n" }, "lastUpdateTime": { "type": "string", "description": "Update time\n" }, "maxInstance": { "type": "integer", "description": "Maximum number of function instances. Valid range: [0 ~ remaining available account resources/single instance maximum memory]\n" }, "newRevisionNumber": { "type": "integer", "description": "Version number of the new version being released. Not returned when status is pending; returned when status is inprogress, failed, or done\n" }, "oldRevisionNumber": { "type": "integer", "description": "Version number of the old version. Not returned when status is pending; returned when status is inprogress, failed, or done\n" }, "releaseRecordId": { "type": "string", "description": "Release record ID\n" }, "revisionNumber": { "type": "integer", "description": "Version number to release. When RevisionNumber = 0, the latest code (Latest) is released and a new version is created\n" }, "rollingStep": { "type": "integer", "description": "Canary step percentage. Valid values: 1–100, default: 10\n" }, "sourceRevisionNumber": { "type": "integer", "description": "Released historical version number\n" }, "stableRevisionNumber": { "type": "integer", "description": "Version number currently running stably online. Generated after the first successful release. Before the first release (status == pending), StableRevisionNumber is -1\n" }, "startTime": { "type": "string", "description": "Start time of the current release. Not returned when status is pending; returned when status is inprogress, failed, or done\n" }, "status": { "type": "string", "description": "Function release status: pending: never released, inprogress: releasing, done: release successful, failed: release failed\n" }, "statusMessage": { "type": "string", "description": "Detailed function release status. Supplementary information for release status\n" }, "targetRevisionNumber": { "type": "integer", "description": "Target version number for release\n" }, "targetTrafficWeight": { "type": "integer", "description": "Target release traffic percentage. Valid range: [0, 100], indicates the proportion of traffic assigned to the released version. 100 means full release\n" } }, "required": [ "creationTime", "currentTrafficWeight", "description", "errorCode", "failedInstanceLogs", "finishTime", "functionId", "lastUpdateTime", "maxInstance", "newRevisionNumber", "oldRevisionNumber", "releaseRecordId", "revisionNumber", "rollingStep", "sourceRevisionNumber", "stableRevisionNumber", "startTime", "status", "statusMessage", "targetRevisionNumber", "targetTrafficWeight" ], "inputProperties": { "description": { "type": "string", "description": "Description for this release\n" }, "functionId": { "type": "string", "description": "Function ID\n" }, "maxInstance": { "type": "integer", "description": "Maximum number of function instances. Valid range: [0 ~ remaining available account resources/single instance maximum memory]\n" }, "revisionNumber": { "type": "integer", "description": "Version number to release. When RevisionNumber = 0, the latest code (Latest) is released and a new version is created\n" }, "rollingStep": { "type": "integer", "description": "Canary step percentage. Valid values: 1–100, default: 10\n" }, "targetTrafficWeight": { "type": "integer", "description": "Target release traffic percentage. Valid range: [0, 100], indicates the proportion of traffic assigned to the released version. 100 means full release\n" } }, "requiredInputs": [ "functionId", "revisionNumber" ], "stateInputs": { "description": "Input properties used for looking up and filtering Release resources.\n", "properties": { "creationTime": { "type": "string", "description": "Creation time\n" }, "currentTrafficWeight": { "type": "integer", "description": "Current release traffic percentage. Valid values: 1–100, indicates the proportion of traffic assigned to the currently releasing version. Returned only when status is inprogress or failed\n" }, "description": { "type": "string", "description": "Description for this release\n" }, "errorCode": { "type": "string", "description": "Error codes for release failures: function*start*failed: function startup failed function*start*timeout: function startup timed out function*health*check*failed: function health check failed system*internal_error: internal system error\n" }, "failedInstanceLogs": { "type": "string", "description": "Download link for logs of failed release instances\n" }, "finishTime": { "type": "string", "description": "Completion time\n" }, "functionId": { "type": "string", "description": "Function ID\n" }, "lastUpdateTime": { "type": "string", "description": "Update time\n" }, "maxInstance": { "type": "integer", "description": "Maximum number of function instances. Valid range: [0 ~ remaining available account resources/single instance maximum memory]\n" }, "newRevisionNumber": { "type": "integer", "description": "Version number of the new version being released. Not returned when status is pending; returned when status is inprogress, failed, or done\n" }, "oldRevisionNumber": { "type": "integer", "description": "Version number of the old version. Not returned when status is pending; returned when status is inprogress, failed, or done\n" }, "releaseRecordId": { "type": "string", "description": "Release record ID\n" }, "revisionNumber": { "type": "integer", "description": "Version number to release. When RevisionNumber = 0, the latest code (Latest) is released and a new version is created\n" }, "rollingStep": { "type": "integer", "description": "Canary step percentage. Valid values: 1–100, default: 10\n" }, "sourceRevisionNumber": { "type": "integer", "description": "Released historical version number\n" }, "stableRevisionNumber": { "type": "integer", "description": "Version number currently running stably online. Generated after the first successful release. Before the first release (status == pending), StableRevisionNumber is -1\n" }, "startTime": { "type": "string", "description": "Start time of the current release. Not returned when status is pending; returned when status is inprogress, failed, or done\n" }, "status": { "type": "string", "description": "Function release status: pending: never released, inprogress: releasing, done: release successful, failed: release failed\n" }, "statusMessage": { "type": "string", "description": "Detailed function release status. Supplementary information for release status\n" }, "targetRevisionNumber": { "type": "integer", "description": "Target version number for release\n" }, "targetTrafficWeight": { "type": "integer", "description": "Target release traffic percentage. Valid range: [0, 100], indicates the proportion of traffic assigned to the released version. 100 means full release\n" } }, "type": "object" } }, "volcenginecc:vefaas/sandbox:Sandbox": { "description": "A sandbox instance is a secure and isolated container runtime environment that actually runs the sandbox image in the cloud sandbox\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vefaasSandboxDemo:\n type: volcenginecc:vefaas:Sandbox\n name: VefaasSandboxDemo\n properties:\n functionId: n5hcs3y5****\n timeout: 50\n memoryMb: 2048\n cpuMilli: 1000\n requestTimeout: 30\n maxConcurrency: 100\n metadatas:\n - key: env\n value: test\n instanceImageInfo:\n image: enterprise-public-cn-beijing.cr.volces.com/xxxxxx/all-in-one-sandbox:xxxxxx\n command: /opt/gem/run.sh\n port: 8080\n image_id: 3ewzg8x5h1***\n instanceTosMountConfig:\n enable: true\n tos_mount_points:\n - bucketPath: /mnt/tos\n localMountPath: /mnt/tos\n envs:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vefaas/sandbox:Sandbox example \"function_id|sandbox_id\"\n```\n\n", "properties": { "availabilityZone": { "type": "string", "description": "Availability zone ID of the sandbox instance\n" }, "cpuMilli": { "type": "integer", "description": "Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000\n" }, "createdTime": { "type": "string", "description": "Sandbox instance creation time.\n" }, "envs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/SandboxEnv:SandboxEnv" } }, "errorCode": { "type": "string", "description": "Sandbox instance startup failure error code. Parameter description: internal*load*request*error: internal system error, function*initialize*failed: business process initialization error, function*health*check*failed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally\n" }, "errorMessage": { "type": "string", "description": "Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.\n" }, "expireAt": { "type": "string", "description": "Sandbox instance uptime.\n" }, "functionId": { "type": "string", "description": "Sandbox application ID to which the sandbox instance belongs\n" }, "instanceImageInfo": { "$ref": "#/types/volcenginecc:vefaas/SandboxInstanceImageInfo:SandboxInstanceImageInfo", "description": "Sandbox instance image information, including image address, startup command, and listening port.\n" }, "instanceTosMountConfig": { "$ref": "#/types/volcenginecc:vefaas/SandboxInstanceTosMountConfig:SandboxInstanceTosMountConfig", "description": "Instance-level object storage (TOS) mount configuration for the sandbox instance\n" }, "instanceType": { "type": "string", "description": "Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance\n" }, "maxConcurrency": { "type": "integer", "description": "Maximum concurrent requests per instance: range: 10~1000, default: 100\n" }, "memoryMb": { "type": "integer", "description": "Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048\n" }, "metadatas": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/SandboxMetadata:SandboxMetadata" } }, "pending": { "type": "boolean", "description": "Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no\n" }, "requestTimeout": { "type": "integer", "description": "Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30\n" }, "revisionNumber": { "type": "integer", "description": "Function instance version number\n" }, "sandboxId": { "type": "string", "description": "Sandbox instance ID\n" }, "status": { "type": "string", "description": "Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating\n" }, "timeout": { "type": "integer", "description": "Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60\n" } }, "required": [ "availabilityZone", "cpuMilli", "createdTime", "envs", "errorCode", "errorMessage", "expireAt", "functionId", "instanceImageInfo", "instanceTosMountConfig", "instanceType", "maxConcurrency", "memoryMb", "metadatas", "pending", "requestTimeout", "revisionNumber", "sandboxId", "status", "timeout" ], "inputProperties": { "cpuMilli": { "type": "integer", "description": "Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000\n" }, "envs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/SandboxEnv:SandboxEnv" } }, "functionId": { "type": "string", "description": "Sandbox application ID to which the sandbox instance belongs\n" }, "instanceImageInfo": { "$ref": "#/types/volcenginecc:vefaas/SandboxInstanceImageInfo:SandboxInstanceImageInfo", "description": "Sandbox instance image information, including image address, startup command, and listening port.\n" }, "instanceTosMountConfig": { "$ref": "#/types/volcenginecc:vefaas/SandboxInstanceTosMountConfig:SandboxInstanceTosMountConfig", "description": "Instance-level object storage (TOS) mount configuration for the sandbox instance\n" }, "maxConcurrency": { "type": "integer", "description": "Maximum concurrent requests per instance: range: 10~1000, default: 100\n" }, "memoryMb": { "type": "integer", "description": "Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048\n" }, "metadatas": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/SandboxMetadata:SandboxMetadata" } }, "requestTimeout": { "type": "integer", "description": "Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30\n" }, "timeout": { "type": "integer", "description": "Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60\n" } }, "requiredInputs": [ "functionId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Sandbox resources.\n", "properties": { "availabilityZone": { "type": "string", "description": "Availability zone ID of the sandbox instance\n" }, "cpuMilli": { "type": "integer", "description": "Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000\n" }, "createdTime": { "type": "string", "description": "Sandbox instance creation time.\n" }, "envs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/SandboxEnv:SandboxEnv" } }, "errorCode": { "type": "string", "description": "Sandbox instance startup failure error code. Parameter description: internal*load*request*error: internal system error, function*initialize*failed: business process initialization error, function*health*check*failed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally\n" }, "errorMessage": { "type": "string", "description": "Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.\n" }, "expireAt": { "type": "string", "description": "Sandbox instance uptime.\n" }, "functionId": { "type": "string", "description": "Sandbox application ID to which the sandbox instance belongs\n" }, "instanceImageInfo": { "$ref": "#/types/volcenginecc:vefaas/SandboxInstanceImageInfo:SandboxInstanceImageInfo", "description": "Sandbox instance image information, including image address, startup command, and listening port.\n" }, "instanceTosMountConfig": { "$ref": "#/types/volcenginecc:vefaas/SandboxInstanceTosMountConfig:SandboxInstanceTosMountConfig", "description": "Instance-level object storage (TOS) mount configuration for the sandbox instance\n" }, "instanceType": { "type": "string", "description": "Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance\n" }, "maxConcurrency": { "type": "integer", "description": "Maximum concurrent requests per instance: range: 10~1000, default: 100\n" }, "memoryMb": { "type": "integer", "description": "Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048\n" }, "metadatas": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vefaas/SandboxMetadata:SandboxMetadata" } }, "pending": { "type": "boolean", "description": "Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no\n" }, "requestTimeout": { "type": "integer", "description": "Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30\n" }, "revisionNumber": { "type": "integer", "description": "Function instance version number\n" }, "sandboxId": { "type": "string", "description": "Sandbox instance ID\n" }, "status": { "type": "string", "description": "Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating\n" }, "timeout": { "type": "integer", "description": "Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60\n" } }, "type": "object" } }, "volcenginecc:vefaas/timer:Timer": { "description": "Trigger management\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vEFAASTimerDemo = new volcenginecc.vefaas.Timer(\"VEFAASTimerDemo\", {\n functionId: \"o1zxxx\",\n name: \"ccapi-test-timer\",\n description: \"ccapi test timer\",\n enabled: false,\n crontab: \"*/30 * * * *\",\n payload: \"{\\\"body\\\": \\\"create event payload\\\"}\",\n enableConcurrency: false,\n retries: 5,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_efaas_timer_demo = volcenginecc.vefaas.Timer(\"VEFAASTimerDemo\",\n function_id=\"o1zxxx\",\n name=\"ccapi-test-timer\",\n description=\"ccapi test timer\",\n enabled=False,\n crontab=\"*/30 * * * *\",\n payload=\"{\\\"body\\\": \\\"create event payload\\\"}\",\n enable_concurrency=False,\n retries=5)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vEFAASTimerDemo = new Volcenginecc.Vefaas.Timer(\"VEFAASTimerDemo\", new()\n {\n FunctionId = \"o1zxxx\",\n Name = \"ccapi-test-timer\",\n Description = \"ccapi test timer\",\n Enabled = false,\n Crontab = \"*/30 * * * *\",\n Payload = \"{\\\"body\\\": \\\"create event payload\\\"}\",\n EnableConcurrency = false,\n Retries = 5,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vefaas\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vefaas.NewTimer(ctx, \"VEFAASTimerDemo\", \u0026vefaas.TimerArgs{\n\t\t\tFunctionId: pulumi.String(\"o1zxxx\"),\n\t\t\tName: pulumi.String(\"ccapi-test-timer\"),\n\t\t\tDescription: pulumi.String(\"ccapi test timer\"),\n\t\t\tEnabled: pulumi.Bool(false),\n\t\t\tCrontab: pulumi.String(\"*/30 * * * *\"),\n\t\t\tPayload: pulumi.String(\"{\\\"body\\\": \\\"create event payload\\\"}\"),\n\t\t\tEnableConcurrency: pulumi.Bool(false),\n\t\t\tRetries: pulumi.Int(5),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vefaas.Timer;\nimport com.volcengine.volcenginecc.vefaas.TimerArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vEFAASTimerDemo = new Timer(\"vEFAASTimerDemo\", TimerArgs.builder()\n .functionId(\"o1zxxx\")\n .name(\"ccapi-test-timer\")\n .description(\"ccapi test timer\")\n .enabled(false)\n .crontab(\"*/30 * * * *\")\n .payload(\"{\\\"body\\\": \\\"create event payload\\\"}\")\n .enableConcurrency(false)\n .retries(5)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vEFAASTimerDemo:\n type: volcenginecc:vefaas:Timer\n name: VEFAASTimerDemo\n properties:\n functionId: o1zxxx\n name: ccapi-test-timer\n description: ccapi test timer\n enabled: false\n crontab: '*/30 * * * *'\n payload: '{\"body\": \"create event payload\"}'\n enableConcurrency: false\n retries: 5\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vefaas/timer:Timer example \"function_id|timer_id\"\n```\n\n", "properties": { "creationTime": { "type": "string", "description": "Timer trigger creation time\n" }, "crontab": { "type": "string", "description": "Timer trigger time, formatted as a crontab expression\n" }, "description": { "type": "string", "description": "Timer trigger remarks\n" }, "enableConcurrency": { "type": "boolean", "description": "Allow timer trigger concurrency; true means concurrency is allowed\n" }, "enabled": { "type": "boolean", "description": "Timer trigger enabled; true means enabled\n" }, "functionId": { "type": "string", "description": "Function ID\n" }, "lastUpdateTime": { "type": "string", "description": "Timer trigger update time\n" }, "name": { "type": "string", "description": "Timer trigger name\n" }, "payload": { "type": "string", "description": "Payload sent by timer trigger, that is, the trigger message\n" }, "retries": { "type": "integer", "description": "Timer trigger retry count\n" }, "timerId": { "type": "string", "description": "Timer trigger ID\n" } }, "required": [ "creationTime", "crontab", "description", "enableConcurrency", "enabled", "functionId", "lastUpdateTime", "name", "payload", "retries", "timerId" ], "inputProperties": { "crontab": { "type": "string", "description": "Timer trigger time, formatted as a crontab expression\n" }, "description": { "type": "string", "description": "Timer trigger remarks\n" }, "enableConcurrency": { "type": "boolean", "description": "Allow timer trigger concurrency; true means concurrency is allowed\n" }, "enabled": { "type": "boolean", "description": "Timer trigger enabled; true means enabled\n" }, "functionId": { "type": "string", "description": "Function ID\n" }, "name": { "type": "string", "description": "Timer trigger name\n" }, "payload": { "type": "string", "description": "Payload sent by timer trigger, that is, the trigger message\n" }, "retries": { "type": "integer", "description": "Timer trigger retry count\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Timer resources.\n", "properties": { "creationTime": { "type": "string", "description": "Timer trigger creation time\n" }, "crontab": { "type": "string", "description": "Timer trigger time, formatted as a crontab expression\n" }, "description": { "type": "string", "description": "Timer trigger remarks\n" }, "enableConcurrency": { "type": "boolean", "description": "Allow timer trigger concurrency; true means concurrency is allowed\n" }, "enabled": { "type": "boolean", "description": "Timer trigger enabled; true means enabled\n" }, "functionId": { "type": "string", "description": "Function ID\n" }, "lastUpdateTime": { "type": "string", "description": "Timer trigger update time\n" }, "name": { "type": "string", "description": "Timer trigger name\n" }, "payload": { "type": "string", "description": "Payload sent by timer trigger, that is, the trigger message\n" }, "retries": { "type": "integer", "description": "Timer trigger retry count\n" }, "timerId": { "type": "string", "description": "Timer trigger ID\n" } }, "type": "object" } }, "volcenginecc:vepfs/instance:Instance": { "description": "File storage vePFS is a newly launched high-throughput, low-latency, scalable parallel file system service designed to meet the high-throughput and low-latency data read/write requirements in high-performance computing scenarios. It can be widely used in HPC (high-performance computing), AI training or inference, energy exploration, industrial simulation, film rendering, life sciences, meteorological analysis, and other scenarios. vePFS also provides one-click deployment and integrated monitoring and alerting capabilities, eliminating deployment and maintenance costs while maximizing your business efficiency.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vEPFSInstanceDemo = new volcenginecc.vepfs.Instance(\"VEPFSInstanceDemo\", {\n fileSystemName: \"VEPFSInstanceDemo\",\n zoneId: \"cn-beijing-a\",\n chargeType: \"PayAsYouGo\",\n fileSystemType: \"VePFS\",\n storeType: \"Advance_100\",\n protocolType: \"VePFS\",\n projectName: \"default\",\n capacity: 8,\n vpcId: \"vpc-3nqt4kq87xn28931eclxxxxx\",\n subnetId: \"subnet-1a0zgr5e7hslc8nvepkxxxxxx\",\n versionNumber: \"1.4.0\",\n enableRestripe: true,\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_epfs_instance_demo = volcenginecc.vepfs.Instance(\"VEPFSInstanceDemo\",\n file_system_name=\"VEPFSInstanceDemo\",\n zone_id=\"cn-beijing-a\",\n charge_type=\"PayAsYouGo\",\n file_system_type=\"VePFS\",\n store_type=\"Advance_100\",\n protocol_type=\"VePFS\",\n project_name=\"default\",\n capacity=8,\n vpc_id=\"vpc-3nqt4kq87xn28931eclxxxxx\",\n subnet_id=\"subnet-1a0zgr5e7hslc8nvepkxxxxxx\",\n version_number=\"1.4.0\",\n enable_restripe=True,\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vEPFSInstanceDemo = new Volcenginecc.Vepfs.Instance(\"VEPFSInstanceDemo\", new()\n {\n FileSystemName = \"VEPFSInstanceDemo\",\n ZoneId = \"cn-beijing-a\",\n ChargeType = \"PayAsYouGo\",\n FileSystemType = \"VePFS\",\n StoreType = \"Advance_100\",\n ProtocolType = \"VePFS\",\n ProjectName = \"default\",\n Capacity = 8,\n VpcId = \"vpc-3nqt4kq87xn28931eclxxxxx\",\n SubnetId = \"subnet-1a0zgr5e7hslc8nvepkxxxxxx\",\n VersionNumber = \"1.4.0\",\n EnableRestripe = true,\n Tags = new[]\n {\n new Volcenginecc.Vepfs.Inputs.InstanceTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vepfs\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vepfs.NewInstance(ctx, \"VEPFSInstanceDemo\", \u0026vepfs.InstanceArgs{\n\t\t\tFileSystemName: pulumi.String(\"VEPFSInstanceDemo\"),\n\t\t\tZoneId: pulumi.String(\"cn-beijing-a\"),\n\t\t\tChargeType: pulumi.String(\"PayAsYouGo\"),\n\t\t\tFileSystemType: pulumi.String(\"VePFS\"),\n\t\t\tStoreType: pulumi.String(\"Advance_100\"),\n\t\t\tProtocolType: pulumi.String(\"VePFS\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tCapacity: pulumi.Int(8),\n\t\t\tVpcId: pulumi.String(\"vpc-3nqt4kq87xn28931eclxxxxx\"),\n\t\t\tSubnetId: pulumi.String(\"subnet-1a0zgr5e7hslc8nvepkxxxxxx\"),\n\t\t\tVersionNumber: pulumi.String(\"1.4.0\"),\n\t\t\tEnableRestripe: pulumi.Bool(true),\n\t\t\tTags: vepfs.InstanceTagArray{\n\t\t\t\t\u0026vepfs.InstanceTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vepfs.Instance;\nimport com.volcengine.volcenginecc.vepfs.InstanceArgs;\nimport com.pulumi.volcenginecc.vepfs.inputs.InstanceTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vEPFSInstanceDemo = new Instance(\"vEPFSInstanceDemo\", InstanceArgs.builder()\n .fileSystemName(\"VEPFSInstanceDemo\")\n .zoneId(\"cn-beijing-a\")\n .chargeType(\"PayAsYouGo\")\n .fileSystemType(\"VePFS\")\n .storeType(\"Advance_100\")\n .protocolType(\"VePFS\")\n .projectName(\"default\")\n .capacity(8)\n .vpcId(\"vpc-3nqt4kq87xn28931eclxxxxx\")\n .subnetId(\"subnet-1a0zgr5e7hslc8nvepkxxxxxx\")\n .versionNumber(\"1.4.0\")\n .enableRestripe(true)\n .tags(InstanceTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vEPFSInstanceDemo:\n type: volcenginecc:vepfs:Instance\n name: VEPFSInstanceDemo\n properties:\n fileSystemName: VEPFSInstanceDemo\n zoneId: cn-beijing-a\n chargeType: PayAsYouGo\n fileSystemType: VePFS\n storeType: Advance_100\n protocolType: VePFS\n projectName: default\n capacity: 8\n vpcId: vpc-3nqt4kq87xn28931eclxxxxx\n subnetId: subnet-1a0zgr5e7hslc8nvepkxxxxxx\n versionNumber: 1.4.0\n enableRestripe: true\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vepfs/instance:Instance example \"file_system_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account ID.\n" }, "bandwidth": { "type": "integer", "description": "VePFS file system throughput limit.\n" }, "capacity": { "type": "integer", "description": "File system capacity, unit: TiB.\n" }, "capacityInfo": { "$ref": "#/types/volcenginecc:vepfs/InstanceCapacityInfo:InstanceCapacityInfo", "description": "Capacity information.\n" }, "chargeStatus": { "type": "string", "description": "Billing status. Default is Normal, indicating standard billing.\n" }, "chargeType": { "type": "string", "description": "Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "File system description.\n" }, "enableRestripe": { "type": "boolean", "description": "Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.\n" }, "expireTime": { "type": "string", "description": "Expiration time.\n" }, "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "fileSystemName": { "type": "string", "description": "File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.\n" }, "fileSystemType": { "type": "string", "description": "File system type. Default is VePFS.\n" }, "freeTime": { "type": "string", "description": "File system release time.\n" }, "projectName": { "type": "string", "description": "Project to which the file system belongs. Default is default.\n" }, "protocolType": { "type": "string", "description": "Protocol type. Default is VePFS.\n" }, "readBandwidth": { "type": "integer", "description": "Read bandwidth value, unit: MB/s.\n" }, "securityGroupId": { "type": "string", "description": "Security group ID for the generated auxiliary NIC.\n" }, "status": { "type": "string", "description": "File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.\n" }, "stopServiceTime": { "type": "string", "description": "File system shutdown time.\n" }, "storeType": { "type": "string", "description": "File system specification. Value descriptions are as follows: Advance*100: 100MB/s/TiB. Performance: Performance. Intelligent*Computing: Intelligent Computing.\n" }, "storeTypeCn": { "type": "string", "description": "File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.\n" }, "storeTypeEn": { "type": "string", "description": "Storage type English name.\n" }, "subnetId": { "type": "string", "description": "Subnet ID. The subnet must belong to the selected availability zone.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vepfs/InstanceTag:InstanceTag" } }, "updatedTime": { "type": "string", "description": "File system update time.\n" }, "versionNumber": { "type": "string", "description": "File system version number.\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "writeBandwidth": { "type": "integer", "description": "Write bandwidth value, measured in MB/s.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" }, "zoneName": { "type": "string", "description": "Availability zone name.\n" } }, "required": [ "accountId", "bandwidth", "capacity", "capacityInfo", "chargeStatus", "chargeType", "createdTime", "description", "enableRestripe", "expireTime", "fileSystemId", "fileSystemName", "fileSystemType", "freeTime", "projectName", "protocolType", "readBandwidth", "securityGroupId", "status", "stopServiceTime", "storeType", "storeTypeCn", "storeTypeEn", "subnetId", "tags", "updatedTime", "versionNumber", "vpcId", "writeBandwidth", "zoneId", "zoneName" ], "inputProperties": { "capacity": { "type": "integer", "description": "File system capacity, unit: TiB.\n" }, "chargeType": { "type": "string", "description": "Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.\n" }, "description": { "type": "string", "description": "File system description.\n" }, "enableRestripe": { "type": "boolean", "description": "Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.\n" }, "fileSystemName": { "type": "string", "description": "File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.\n" }, "fileSystemType": { "type": "string", "description": "File system type. Default is VePFS.\n" }, "projectName": { "type": "string", "description": "Project to which the file system belongs. Default is default.\n" }, "protocolType": { "type": "string", "description": "Protocol type. Default is VePFS.\n" }, "storeType": { "type": "string", "description": "File system specification. Value descriptions are as follows: Advance*100: 100MB/s/TiB. Performance: Performance. Intelligent*Computing: Intelligent Computing.\n" }, "subnetId": { "type": "string", "description": "Subnet ID. The subnet must belong to the selected availability zone.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vepfs/InstanceTag:InstanceTag" } }, "versionNumber": { "type": "string", "description": "File system version number.\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "requiredInputs": [ "capacity", "fileSystemName", "storeType", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Instance resources.\n", "properties": { "accountId": { "type": "string", "description": "Account ID.\n" }, "bandwidth": { "type": "integer", "description": "VePFS file system throughput limit.\n" }, "capacity": { "type": "integer", "description": "File system capacity, unit: TiB.\n" }, "capacityInfo": { "$ref": "#/types/volcenginecc:vepfs/InstanceCapacityInfo:InstanceCapacityInfo", "description": "Capacity information.\n" }, "chargeStatus": { "type": "string", "description": "Billing status. Default is Normal, indicating standard billing.\n" }, "chargeType": { "type": "string", "description": "Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "description": { "type": "string", "description": "File system description.\n" }, "enableRestripe": { "type": "boolean", "description": "Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.\n" }, "expireTime": { "type": "string", "description": "Expiration time.\n" }, "fileSystemId": { "type": "string", "description": "File system ID.\n" }, "fileSystemName": { "type": "string", "description": "File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.\n" }, "fileSystemType": { "type": "string", "description": "File system type. Default is VePFS.\n" }, "freeTime": { "type": "string", "description": "File system release time.\n" }, "projectName": { "type": "string", "description": "Project to which the file system belongs. Default is default.\n" }, "protocolType": { "type": "string", "description": "Protocol type. Default is VePFS.\n" }, "readBandwidth": { "type": "integer", "description": "Read bandwidth value, unit: MB/s.\n" }, "securityGroupId": { "type": "string", "description": "Security group ID for the generated auxiliary NIC.\n" }, "status": { "type": "string", "description": "File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.\n" }, "stopServiceTime": { "type": "string", "description": "File system shutdown time.\n" }, "storeType": { "type": "string", "description": "File system specification. Value descriptions are as follows: Advance*100: 100MB/s/TiB. Performance: Performance. Intelligent*Computing: Intelligent Computing.\n" }, "storeTypeCn": { "type": "string", "description": "File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.\n" }, "storeTypeEn": { "type": "string", "description": "Storage type English name.\n" }, "subnetId": { "type": "string", "description": "Subnet ID. The subnet must belong to the selected availability zone.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vepfs/InstanceTag:InstanceTag" } }, "updatedTime": { "type": "string", "description": "File system update time.\n" }, "versionNumber": { "type": "string", "description": "File system version number.\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "writeBandwidth": { "type": "integer", "description": "Write bandwidth value, measured in MB/s.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" }, "zoneName": { "type": "string", "description": "Availability zone name.\n" } }, "type": "object" } }, "volcenginecc:vepfs/mountService:MountService": { "description": "The mount service is the connection point for the file system in a network environment. The file system must be mounted on compute nodes to enable data access and storage.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vEPFSMountServiceDemo:\n type: volcenginecc:vepfs:MountService\n name: VEPFSMountServiceDemo\n properties:\n mountServiceName: test\n project: default\n nodeType: ecs.g4i.large\n subnetId: subnet-1a185dj3sh1q8*****\n vpcId: vpc-1a17v350xa8lc8n*****\n zoneId: cn-beijing-a\n attachFileSystems:\n - file_system_id: vepfs-cnbj607*****\n customer_path: /vepfs-cnbj*****\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vepfs/mountService:MountService example \"mount_service_id\"\n```\n\n", "properties": { "attachFileSystems": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vepfs/MountServiceAttachFileSystem:MountServiceAttachFileSystem" } }, "createTime": { "type": "string", "description": "Creation time.\n" }, "mountServiceId": { "type": "string", "description": "Mount service ID.\n" }, "mountServiceName": { "type": "string", "description": "Mount service name. Naming rules: Must start with a Chinese or English character. Only Chinese characters, letters, numbers, periods (.), underscores (_), or hyphens (-) are allowed. Length must be between 1 and 128 characters. The mount service name must be unique within each region and account; duplicates are not allowed.\n" }, "nodeType": { "type": "string", "description": "Client management node type.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vepfs/MountServiceNode:MountServiceNode" } }, "project": { "type": "string", "description": "Project.\n" }, "securityGroupId": { "type": "string", "description": "Client NIC security group ID.\n" }, "status": { "type": "string", "description": "Mount service status. Details: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. UpdateError: Update failed. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Attaching: Attaching. AttachError: Attachment failed. Detaching: Detaching. DetachError: Detachment failed. Stopped: Stopped. Error: Error.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "versionNumber": { "type": "string", "description": "Mount service version.\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" }, "zoneName": { "type": "string", "description": "Availability zone name.\n" } }, "required": [ "attachFileSystems", "createTime", "mountServiceId", "mountServiceName", "nodeType", "nodes", "project", "securityGroupId", "status", "subnetId", "versionNumber", "vpcId", "zoneId", "zoneName" ], "inputProperties": { "attachFileSystems": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vepfs/MountServiceAttachFileSystem:MountServiceAttachFileSystem" } }, "mountServiceName": { "type": "string", "description": "Mount service name. Naming rules: Must start with a Chinese or English character. Only Chinese characters, letters, numbers, periods (.), underscores (_), or hyphens (-) are allowed. Length must be between 1 and 128 characters. The mount service name must be unique within each region and account; duplicates are not allowed.\n" }, "nodeType": { "type": "string", "description": "Client management node type.\n" }, "project": { "type": "string", "description": "Project.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "requiredInputs": [ "mountServiceName", "nodeType", "subnetId", "vpcId", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering MountService resources.\n", "properties": { "attachFileSystems": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vepfs/MountServiceAttachFileSystem:MountServiceAttachFileSystem" } }, "createTime": { "type": "string", "description": "Creation time.\n" }, "mountServiceId": { "type": "string", "description": "Mount service ID.\n" }, "mountServiceName": { "type": "string", "description": "Mount service name. Naming rules: Must start with a Chinese or English character. Only Chinese characters, letters, numbers, periods (.), underscores (_), or hyphens (-) are allowed. Length must be between 1 and 128 characters. The mount service name must be unique within each region and account; duplicates are not allowed.\n" }, "nodeType": { "type": "string", "description": "Client management node type.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vepfs/MountServiceNode:MountServiceNode" } }, "project": { "type": "string", "description": "Project.\n" }, "securityGroupId": { "type": "string", "description": "Client NIC security group ID.\n" }, "status": { "type": "string", "description": "Mount service status. Details: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. UpdateError: Update failed. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Attaching: Attaching. AttachError: Attachment failed. Detaching: Detaching. DetachError: Detachment failed. Stopped: Stopped. Error: Error.\n" }, "subnetId": { "type": "string", "description": "Subnet ID.\n" }, "versionNumber": { "type": "string", "description": "Mount service version.\n" }, "vpcId": { "type": "string", "description": "Private network ID.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" }, "zoneName": { "type": "string", "description": "Availability zone name.\n" } }, "type": "object" } }, "volcenginecc:vke/addon:Addon": { "description": "The cluster supports installation of various types of components, including network, storage, monitoring, DNS, security, image, GPU, and more, to meet your diverse business needs. You can deploy, upgrade, or uninstall components as needed.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vKEAddonDemo = new volcenginecc.vke.Addon(\"VKEAddonDemo\", {\n clusterId: \"cd35mtki***\",\n deployMode: \"Unmanaged\",\n deployNodeType: \"Node\",\n name: \"csi-nas\",\n version: \"v1.2.7\",\n config: \"{\\\"CsiNasDriver\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.9\\\",\\\"Memory\\\":\\\"1900Mi\\\"}}},\\\"CsiProvisioner\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.5\\\",\\\"Memory\\\":\\\"4Gi\\\"}}},\\\"LivenessProbe\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.1\\\",\\\"Memory\\\":\\\"100Mi\\\"}}}}\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_ke_addon_demo = volcenginecc.vke.Addon(\"VKEAddonDemo\",\n cluster_id=\"cd35mtki***\",\n deploy_mode=\"Unmanaged\",\n deploy_node_type=\"Node\",\n name=\"csi-nas\",\n version=\"v1.2.7\",\n config=\"{\\\"CsiNasDriver\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.9\\\",\\\"Memory\\\":\\\"1900Mi\\\"}}},\\\"CsiProvisioner\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.5\\\",\\\"Memory\\\":\\\"4Gi\\\"}}},\\\"LivenessProbe\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.1\\\",\\\"Memory\\\":\\\"100Mi\\\"}}}}\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vKEAddonDemo = new Volcenginecc.Vke.Addon(\"VKEAddonDemo\", new()\n {\n ClusterId = \"cd35mtki***\",\n DeployMode = \"Unmanaged\",\n DeployNodeType = \"Node\",\n Name = \"csi-nas\",\n Version = \"v1.2.7\",\n Config = \"{\\\"CsiNasDriver\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.9\\\",\\\"Memory\\\":\\\"1900Mi\\\"}}},\\\"CsiProvisioner\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.5\\\",\\\"Memory\\\":\\\"4Gi\\\"}}},\\\"LivenessProbe\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.1\\\",\\\"Memory\\\":\\\"100Mi\\\"}}}}\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vke\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vke.NewAddon(ctx, \"VKEAddonDemo\", \u0026vke.AddonArgs{\n\t\t\tClusterId: pulumi.String(\"cd35mtki***\"),\n\t\t\tDeployMode: pulumi.String(\"Unmanaged\"),\n\t\t\tDeployNodeType: pulumi.String(\"Node\"),\n\t\t\tName: pulumi.String(\"csi-nas\"),\n\t\t\tVersion: pulumi.String(\"v1.2.7\"),\n\t\t\tConfig: pulumi.String(\"{\\\"CsiNasDriver\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.9\\\",\\\"Memory\\\":\\\"1900Mi\\\"}}},\\\"CsiProvisioner\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.5\\\",\\\"Memory\\\":\\\"4Gi\\\"}}},\\\"LivenessProbe\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.1\\\",\\\"Memory\\\":\\\"100Mi\\\"}}}}\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vke.Addon;\nimport com.volcengine.volcenginecc.vke.AddonArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vKEAddonDemo = new Addon(\"vKEAddonDemo\", AddonArgs.builder()\n .clusterId(\"cd35mtki***\")\n .deployMode(\"Unmanaged\")\n .deployNodeType(\"Node\")\n .name(\"csi-nas\")\n .version(\"v1.2.7\")\n .config(\"{\\\"CsiNasDriver\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.9\\\",\\\"Memory\\\":\\\"1900Mi\\\"}}},\\\"CsiProvisioner\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.5\\\",\\\"Memory\\\":\\\"4Gi\\\"}}},\\\"LivenessProbe\\\":{\\\"Resources\\\":{\\\"Requests\\\":{\\\"Cpu\\\":\\\"0.01\\\",\\\"Memory\\\":\\\"20Mi\\\"},\\\"Limits\\\":{\\\"Cpu\\\":\\\"0.1\\\",\\\"Memory\\\":\\\"100Mi\\\"}}}}\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vKEAddonDemo:\n type: volcenginecc:vke:Addon\n name: VKEAddonDemo\n properties:\n clusterId: cd35mtki***\n deployMode: Unmanaged\n deployNodeType: Node\n name: csi-nas\n version: v1.2.7\n config: '{\"CsiNasDriver\":{\"Resources\":{\"Requests\":{\"Cpu\":\"0.01\",\"Memory\":\"20Mi\"},\"Limits\":{\"Cpu\":\"0.9\",\"Memory\":\"1900Mi\"}}},\"CsiProvisioner\":{\"Resources\":{\"Requests\":{\"Cpu\":\"0.01\",\"Memory\":\"20Mi\"},\"Limits\":{\"Cpu\":\"0.5\",\"Memory\":\"4Gi\"}}},\"LivenessProbe\":{\"Resources\":{\"Requests\":{\"Cpu\":\"0.01\",\"Memory\":\"20Mi\"},\"Limits\":{\"Cpu\":\"0.1\",\"Memory\":\"100Mi\"}}}}'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vke/addon:Addon example \"cluster_id|name\"\n```\n\n", "properties": { "clusterId": { "type": "string", "description": "Cluster ID where the component is located.\n" }, "config": { "type": "string", "description": "Component configuration.\n" }, "createdTime": { "type": "string", "description": "Component installation time. Standard RFC3339 format, UTC+0 time.\n" }, "deployMode": { "type": "string", "description": "Component deployment mode. Values: Unmanaged: deployed in unmanaged mode. Managed: deployed in managed mode.\n" }, "deployNodeType": { "type": "string", "description": "Type of deployment node. This parameter needs to be specified only when DeployModes=Unmanaged. Values: Node: deployed as a node. VirtualNode: deployed as a virtual node.\n" }, "name": { "type": "string", "description": "Component name.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/AddonStatus:AddonStatus", "description": "Component status.\n" }, "updatedTime": { "type": "string", "description": "Component update time. Standard RFC3339 format, UTC+0 time.\n" }, "version": { "type": "string", "description": "Component version.\n" } }, "required": [ "clusterId", "config", "createdTime", "deployMode", "deployNodeType", "name", "status", "updatedTime", "version" ], "inputProperties": { "clusterId": { "type": "string", "description": "Cluster ID where the component is located.\n" }, "config": { "type": "string", "description": "Component configuration.\n" }, "deployMode": { "type": "string", "description": "Component deployment mode. Values: Unmanaged: deployed in unmanaged mode. Managed: deployed in managed mode.\n" }, "deployNodeType": { "type": "string", "description": "Type of deployment node. This parameter needs to be specified only when DeployModes=Unmanaged. Values: Node: deployed as a node. VirtualNode: deployed as a virtual node.\n" }, "name": { "type": "string", "description": "Component name.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/AddonStatus:AddonStatus", "description": "Component status.\n" }, "version": { "type": "string", "description": "Component version.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Addon resources.\n", "properties": { "clusterId": { "type": "string", "description": "Cluster ID where the component is located.\n" }, "config": { "type": "string", "description": "Component configuration.\n" }, "createdTime": { "type": "string", "description": "Component installation time. Standard RFC3339 format, UTC+0 time.\n" }, "deployMode": { "type": "string", "description": "Component deployment mode. Values: Unmanaged: deployed in unmanaged mode. Managed: deployed in managed mode.\n" }, "deployNodeType": { "type": "string", "description": "Type of deployment node. This parameter needs to be specified only when DeployModes=Unmanaged. Values: Node: deployed as a node. VirtualNode: deployed as a virtual node.\n" }, "name": { "type": "string", "description": "Component name.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/AddonStatus:AddonStatus", "description": "Component status.\n" }, "updatedTime": { "type": "string", "description": "Component update time. Standard RFC3339 format, UTC+0 time.\n" }, "version": { "type": "string", "description": "Component version.\n" } }, "type": "object" } }, "volcenginecc:vke/cluster:Cluster": { "description": "Container Service deeply integrates next-generation cloud-native technologies to provide high-performance Kubernetes cluster management centered on containers. Build highly available Kubernetes clusters in the cloud with one click and achieve visualized full lifecycle management of containerized applications, helping users quickly build containerized applications.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vKEClusterDemo:\n type: volcenginecc:vke:Cluster\n name: VKEClusterDemo\n properties:\n projectName: default\n name: VKEClusterDemo\n description: VKEClusterDemo\n deleteProtectionEnabled: true\n clusterConfig:\n subnet_ids:\n - subnet-***\n api_server_public_access_enabled: true\n api_server_public_access_config:\n publicAccessNetworkConfig:\n billingType: 3\n bandwidth: 1\n isp: BGP\n resource_public_access_default_enabled: true\n podsConfig:\n pod_network_mode: VpcCniShared\n vpc_cni_config:\n subnetIds:\n - subnet-***\n trunkEniEnabled: false\n servicesConfig:\n service_cidrsv_4:\n - 172.22.xxx.0/22\n tags:\n - key: env\n value: test\n kubernetesVersionCreate: '1.30'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vke/cluster:Cluster example \"cluster_id\"\n```\n\n", "properties": { "clusterConfig": { "$ref": "#/types/volcenginecc:vke/ClusterClusterConfig:ClusterClusterConfig", "description": "Network configuration for the cluster control plane and some nodes.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "createdTime": { "type": "string", "description": "Cluster creation time. Standard RFC3339 format, UTC+0.\n" }, "deleteProtectionEnabled": { "type": "boolean", "description": "Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.\n" }, "description": { "type": "string", "description": "Cluster description. Maximum length is 300 characters.\n" }, "irsaConfig": { "$ref": "#/types/volcenginecc:vke/ClusterIrsaConfig:ClusterIrsaConfig", "description": "IRSA (IAM Role for Service Account) capability parameter configuration\n" }, "kubernetesVersion": { "type": "string", "description": "Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)\n" }, "kubernetesVersionCreate": { "type": "string", "description": "Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)\n" }, "loggingConfig": { "$ref": "#/types/volcenginecc:vke/ClusterLoggingConfig:ClusterLoggingConfig", "description": "Cluster log configuration information.\n" }, "message": { "type": "string", "description": "Cluster status description.\n" }, "monitoringConfig": { "$ref": "#/types/volcenginecc:vke/ClusterMonitoringConfig:ClusterMonitoringConfig", "description": "Monitoring configuration information.\n" }, "name": { "type": "string", "description": "Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.\n" }, "nodeStatistics": { "$ref": "#/types/volcenginecc:vke/ClusterNodeStatistics:ClusterNodeStatistics", "description": "Statistics of node counts for each main status in the cluster.\n" }, "podsConfig": { "$ref": "#/types/volcenginecc:vke/ClusterPodsConfig:ClusterPodsConfig", "description": "Pod network configuration.\n" }, "projectName": { "type": "string", "description": "Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.\n" }, "servicesConfig": { "$ref": "#/types/volcenginecc:vke/ClusterServicesConfig:ClusterServicesConfig", "description": "Network configuration for the service.\n" }, "sourceRegion": { "type": "string", "description": "Cluster source region\n" }, "status": { "$ref": "#/types/volcenginecc:vke/ClusterStatus:ClusterStatus", "description": "Cluster status.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/ClusterTag:ClusterTag" } }, "type": { "type": "string", "description": "Cluster type.\n" }, "updatedTime": { "type": "string", "description": "Last update time of the cluster. Standard RFC3339 format, UTC+0.\n" } }, "required": [ "clusterConfig", "clusterId", "createdTime", "deleteProtectionEnabled", "description", "irsaConfig", "kubernetesVersion", "kubernetesVersionCreate", "loggingConfig", "message", "monitoringConfig", "name", "nodeStatistics", "podsConfig", "projectName", "servicesConfig", "sourceRegion", "status", "tags", "type", "updatedTime" ], "inputProperties": { "clusterConfig": { "$ref": "#/types/volcenginecc:vke/ClusterClusterConfig:ClusterClusterConfig", "description": "Network configuration for the cluster control plane and some nodes.\n" }, "deleteProtectionEnabled": { "type": "boolean", "description": "Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.\n" }, "description": { "type": "string", "description": "Cluster description. Maximum length is 300 characters.\n" }, "irsaConfig": { "$ref": "#/types/volcenginecc:vke/ClusterIrsaConfig:ClusterIrsaConfig", "description": "IRSA (IAM Role for Service Account) capability parameter configuration\n" }, "kubernetesVersionCreate": { "type": "string", "description": "Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)\n" }, "loggingConfig": { "$ref": "#/types/volcenginecc:vke/ClusterLoggingConfig:ClusterLoggingConfig", "description": "Cluster log configuration information.\n" }, "monitoringConfig": { "$ref": "#/types/volcenginecc:vke/ClusterMonitoringConfig:ClusterMonitoringConfig", "description": "Monitoring configuration information.\n" }, "name": { "type": "string", "description": "Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.\n" }, "podsConfig": { "$ref": "#/types/volcenginecc:vke/ClusterPodsConfig:ClusterPodsConfig", "description": "Pod network configuration.\n" }, "projectName": { "type": "string", "description": "Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.\n" }, "servicesConfig": { "$ref": "#/types/volcenginecc:vke/ClusterServicesConfig:ClusterServicesConfig", "description": "Network configuration for the service.\n" }, "sourceRegion": { "type": "string", "description": "Cluster source region\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/ClusterTag:ClusterTag" } } }, "requiredInputs": [ "name" ], "stateInputs": { "description": "Input properties used for looking up and filtering Cluster resources.\n", "properties": { "clusterConfig": { "$ref": "#/types/volcenginecc:vke/ClusterClusterConfig:ClusterClusterConfig", "description": "Network configuration for the cluster control plane and some nodes.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "createdTime": { "type": "string", "description": "Cluster creation time. Standard RFC3339 format, UTC+0.\n" }, "deleteProtectionEnabled": { "type": "boolean", "description": "Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.\n" }, "description": { "type": "string", "description": "Cluster description. Maximum length is 300 characters.\n" }, "irsaConfig": { "$ref": "#/types/volcenginecc:vke/ClusterIrsaConfig:ClusterIrsaConfig", "description": "IRSA (IAM Role for Service Account) capability parameter configuration\n" }, "kubernetesVersion": { "type": "string", "description": "Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)\n" }, "kubernetesVersionCreate": { "type": "string", "description": "Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)\n" }, "loggingConfig": { "$ref": "#/types/volcenginecc:vke/ClusterLoggingConfig:ClusterLoggingConfig", "description": "Cluster log configuration information.\n" }, "message": { "type": "string", "description": "Cluster status description.\n" }, "monitoringConfig": { "$ref": "#/types/volcenginecc:vke/ClusterMonitoringConfig:ClusterMonitoringConfig", "description": "Monitoring configuration information.\n" }, "name": { "type": "string", "description": "Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.\n" }, "nodeStatistics": { "$ref": "#/types/volcenginecc:vke/ClusterNodeStatistics:ClusterNodeStatistics", "description": "Statistics of node counts for each main status in the cluster.\n" }, "podsConfig": { "$ref": "#/types/volcenginecc:vke/ClusterPodsConfig:ClusterPodsConfig", "description": "Pod network configuration.\n" }, "projectName": { "type": "string", "description": "Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.\n" }, "servicesConfig": { "$ref": "#/types/volcenginecc:vke/ClusterServicesConfig:ClusterServicesConfig", "description": "Network configuration for the service.\n" }, "sourceRegion": { "type": "string", "description": "Cluster source region\n" }, "status": { "$ref": "#/types/volcenginecc:vke/ClusterStatus:ClusterStatus", "description": "Cluster status.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/ClusterTag:ClusterTag" } }, "type": { "type": "string", "description": "Cluster type.\n" }, "updatedTime": { "type": "string", "description": "Last update time of the cluster. Standard RFC3339 format, UTC+0.\n" } }, "type": "object" } }, "volcenginecc:vke/defaultNodePool:DefaultNodePool": { "description": "In addition to standard custom node pools, container service supports the default node pool (fixed name vke-default-nodepool) for managing existing cloud server (ECS) instances. The default node pool has the same security, advanced, and additional configuration capabilities as standard node pools, but does not support scaling or editing the number of nodes.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vkeDefaultNodePoolDemo:\n type: volcenginecc:vke:DefaultNodePool\n name: VkeDefaultNodePoolDemo\n properties:\n clusterId: cd60pbhxxxxxxc4f31a0\n kubernetesConfig:\n auto_sync_disabled: false\n cordon: false\n labels:\n - key: env\n value: test\n name_prefix: name-prefix\n name_suffix: name-suffix\n name_use_hostname: false\n taints:\n - key: taint-key\n value: taint-value\n effect: NoSchedule\n nodeConfig:\n initialize_script: YmFzaCBteV9maWxlLnNo\n name_prefix: name-prefix\n security:\n login:\n password: RHgxMTIyMzM/\n securityGroupIds:\n - sg-1c0e5jxxxxxx5e8j70agemnk\n securityStrategies:\n - Hids\n tags:\n - key: env\n value: test\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vke/defaultNodePool:DefaultNodePool example \"cluster_id|node_pool_id\"\n```\n\n", "properties": { "autoScaling": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolAutoScaling:DefaultNodePoolAutoScaling", "description": "Node pool scaling policy configuration\n" }, "clusterId": { "type": "string", "description": "Cluster ID where the node pool is located\n" }, "createdTime": { "type": "string", "description": "Node pool creation time\n" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolKubernetesConfig:DefaultNodePoolKubernetesConfig", "description": "Kubernetes-related configuration for the node pool\n" }, "management": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolManagement:DefaultNodePoolManagement", "description": "Managed node pool configuration\n" }, "name": { "type": "string", "description": "Node pool name. Must be unique within the same cluster. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length: 2–64 characters\n" }, "nodeConfig": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfig:DefaultNodePoolNodeConfig", "description": "Cloud server (ECS) instance configuration in the node pool\n" }, "nodePoolId": { "type": "string", "description": "Node pool ID\n" }, "nodeStatistics": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeStatistics:DefaultNodePoolNodeStatistics", "description": "Node statistics in the node pool.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolStatus:DefaultNodePoolStatus", "description": "Node pool status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolTag:DefaultNodePoolTag" } }, "updatedTime": { "type": "string", "description": "Time when the node pool was updated\n" } }, "required": [ "autoScaling", "clusterId", "createdTime", "kubernetesConfig", "management", "name", "nodeConfig", "nodePoolId", "nodeStatistics", "status", "tags", "updatedTime" ], "inputProperties": { "clusterId": { "type": "string", "description": "Cluster ID where the node pool is located\n" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolKubernetesConfig:DefaultNodePoolKubernetesConfig", "description": "Kubernetes-related configuration for the node pool\n" }, "nodeConfig": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfig:DefaultNodePoolNodeConfig", "description": "Cloud server (ECS) instance configuration in the node pool\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolTag:DefaultNodePoolTag" } } }, "requiredInputs": [ "clusterId", "nodeConfig" ], "stateInputs": { "description": "Input properties used for looking up and filtering DefaultNodePool resources.\n", "properties": { "autoScaling": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolAutoScaling:DefaultNodePoolAutoScaling", "description": "Node pool scaling policy configuration\n" }, "clusterId": { "type": "string", "description": "Cluster ID where the node pool is located\n" }, "createdTime": { "type": "string", "description": "Node pool creation time\n" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolKubernetesConfig:DefaultNodePoolKubernetesConfig", "description": "Kubernetes-related configuration for the node pool\n" }, "management": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolManagement:DefaultNodePoolManagement", "description": "Managed node pool configuration\n" }, "name": { "type": "string", "description": "Node pool name. Must be unique within the same cluster. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length: 2–64 characters\n" }, "nodeConfig": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeConfig:DefaultNodePoolNodeConfig", "description": "Cloud server (ECS) instance configuration in the node pool\n" }, "nodePoolId": { "type": "string", "description": "Node pool ID\n" }, "nodeStatistics": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolNodeStatistics:DefaultNodePoolNodeStatistics", "description": "Node statistics in the node pool.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolStatus:DefaultNodePoolStatus", "description": "Node pool status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/DefaultNodePoolTag:DefaultNodePoolTag" } }, "updatedTime": { "type": "string", "description": "Time when the node pool was updated\n" } }, "type": "object" } }, "volcenginecc:vke/kubeconfig:Kubeconfig": { "description": "Cluster Management Kubeconfig\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vKEKubeconfigDemo = new volcenginecc.vke.Kubeconfig(\"VKEKubeconfigDemo\", {\n clusterId: \"cd****\",\n type: \"Private\",\n validDuration: 2,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_ke_kubeconfig_demo = volcenginecc.vke.Kubeconfig(\"VKEKubeconfigDemo\",\n cluster_id=\"cd****\",\n type=\"Private\",\n valid_duration=2)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vKEKubeconfigDemo = new Volcenginecc.Vke.Kubeconfig(\"VKEKubeconfigDemo\", new()\n {\n ClusterId = \"cd****\",\n Type = \"Private\",\n ValidDuration = 2,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vke\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vke.NewKubeconfig(ctx, \"VKEKubeconfigDemo\", \u0026vke.KubeconfigArgs{\n\t\t\tClusterId: pulumi.String(\"cd****\"),\n\t\t\tType: pulumi.String(\"Private\"),\n\t\t\tValidDuration: pulumi.Int(2),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vke.Kubeconfig;\nimport com.volcengine.volcenginecc.vke.KubeconfigArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vKEKubeconfigDemo = new Kubeconfig(\"vKEKubeconfigDemo\", KubeconfigArgs.builder()\n .clusterId(\"cd****\")\n .type(\"Private\")\n .validDuration(2)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vKEKubeconfigDemo:\n type: volcenginecc:vke:Kubeconfig\n name: VKEKubeconfigDemo\n properties:\n clusterId: cd****\n type: Private\n validDuration: 2\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vke/kubeconfig:Kubeconfig example \"cluster_id|kubeconfig_id\"\n```\n\n", "properties": { "clusterId": { "type": "string", "description": "Cluster ID\n" }, "createTime": { "type": "string", "description": "Kubeconfig Creation Time\n" }, "expireTime": { "type": "string", "description": "Kubeconfig Expiration Time\n" }, "kubeconfig": { "type": "string", "description": "Kubeconfig Text\n", "language": { "csharp": { "name": "KubeconfigValue" } } }, "kubeconfigId": { "type": "string", "description": "KubeconfigID。\n" }, "roleId": { "type": "integer", "description": "Role ID\n" }, "type": { "type": "string", "description": "Cluster Kubeconfig File Type\n" }, "userId": { "type": "integer", "description": "User ID\n" }, "validDuration": { "type": "integer", "description": "Kubeconfig File Validity Period\n" } }, "required": [ "clusterId", "createTime", "expireTime", "kubeconfig", "kubeconfigId", "roleId", "type", "userId", "validDuration" ], "inputProperties": { "clusterId": { "type": "string", "description": "Cluster ID\n" }, "type": { "type": "string", "description": "Cluster Kubeconfig File Type\n" }, "validDuration": { "type": "integer", "description": "Kubeconfig File Validity Period\n" } }, "requiredInputs": [ "clusterId", "type" ], "stateInputs": { "description": "Input properties used for looking up and filtering Kubeconfig resources.\n", "properties": { "clusterId": { "type": "string", "description": "Cluster ID\n" }, "createTime": { "type": "string", "description": "Kubeconfig Creation Time\n" }, "expireTime": { "type": "string", "description": "Kubeconfig Expiration Time\n" }, "kubeconfig": { "type": "string", "description": "Kubeconfig Text\n", "language": { "csharp": { "name": "KubeconfigValue" } } }, "kubeconfigId": { "type": "string", "description": "KubeconfigID。\n" }, "roleId": { "type": "integer", "description": "Role ID\n" }, "type": { "type": "string", "description": "Cluster Kubeconfig File Type\n" }, "userId": { "type": "integer", "description": "User ID\n" }, "validDuration": { "type": "integer", "description": "Kubeconfig File Validity Period\n" } }, "type": "object" } }, "volcenginecc:vke/node:Node": { "description": "Corresponds to Node in Kubernetes, which is the basic element of a Container Service cluster. Nodes mainly include: Master nodes (control nodes) and Worker nodes (compute nodes/worker nodes). Applications are actually deployed on Worker nodes, supporting random deployment on Worker nodes or deployment on specified Worker nodes through configuration. In Container Service, node generally refers to Worker node.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vkeNodeDemo = new volcenginecc.vke.Node(\"VkeNodeDemo\", {\n additionalContainerStorageEnabled: false,\n clusterId: \"cd5rdfs5ixxxxxotsc2g\",\n containerStoragePath: \"\",\n instanceId: \"i-yeekjuixxxxx4je5vfr\",\n keepInstanceName: true,\n nodePoolId: \"pd5s9srqxxxxxo88e621g\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nvke_node_demo = volcenginecc.vke.Node(\"VkeNodeDemo\",\n additional_container_storage_enabled=False,\n cluster_id=\"cd5rdfs5ixxxxxotsc2g\",\n container_storage_path=\"\",\n instance_id=\"i-yeekjuixxxxx4je5vfr\",\n keep_instance_name=True,\n node_pool_id=\"pd5s9srqxxxxxo88e621g\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vkeNodeDemo = new Volcenginecc.Vke.Node(\"VkeNodeDemo\", new()\n {\n AdditionalContainerStorageEnabled = false,\n ClusterId = \"cd5rdfs5ixxxxxotsc2g\",\n ContainerStoragePath = \"\",\n InstanceId = \"i-yeekjuixxxxx4je5vfr\",\n KeepInstanceName = true,\n NodePoolId = \"pd5s9srqxxxxxo88e621g\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vke\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vke.NewNode(ctx, \"VkeNodeDemo\", \u0026vke.NodeArgs{\n\t\t\tAdditionalContainerStorageEnabled: pulumi.Bool(false),\n\t\t\tClusterId: pulumi.String(\"cd5rdfs5ixxxxxotsc2g\"),\n\t\t\tContainerStoragePath: pulumi.String(\"\"),\n\t\t\tInstanceId: pulumi.String(\"i-yeekjuixxxxx4je5vfr\"),\n\t\t\tKeepInstanceName: pulumi.Bool(true),\n\t\t\tNodePoolId: pulumi.String(\"pd5s9srqxxxxxo88e621g\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vke.Node;\nimport com.volcengine.volcenginecc.vke.NodeArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vkeNodeDemo = new Node(\"vkeNodeDemo\", NodeArgs.builder()\n .additionalContainerStorageEnabled(false)\n .clusterId(\"cd5rdfs5ixxxxxotsc2g\")\n .containerStoragePath(\"\")\n .instanceId(\"i-yeekjuixxxxx4je5vfr\")\n .keepInstanceName(true)\n .nodePoolId(\"pd5s9srqxxxxxo88e621g\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vkeNodeDemo:\n type: volcenginecc:vke:Node\n name: VkeNodeDemo\n properties:\n additionalContainerStorageEnabled: false\n clusterId: cd5rdfs5ixxxxxotsc2g\n containerStoragePath: \"\"\n instanceId: i-yeekjuixxxxx4je5vfr\n keepInstanceName: true\n nodePoolId: pd5s9srqxxxxxo88e621g\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vke/node:Node example \"cluster_id|node_pool_id|node_id\"\n```\n\n", "properties": { "additionalContainerStorageEnabled": { "type": "boolean", "description": "Select the data disk for the node, format and mount it as the storage directory for container images and logs. Values: false (default): Disabled. Default node pool: indicates no data disk is mounted. Custom node pool: mounts according to the node pool's data disk configuration. ECS instance data disks added to the node pool must include the data disk specified for mounting by the target node pool (including local disks), and the disk type and size must match exactly. true: Enabled. You must also configure the ContainerStoragePath parameter. The node mounts according to the configuration in the ContainerStoragePath parameter and ignores the node pool's data disk configuration. There are no special requirements for ECS instance data disks added to the node pool.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "containerStoragePath": { "type": "string", "description": "Use this data disk device to mount the container and image storage directory /var/lib/containerd.\nValid only when AdditionalContainerStorageEnabled=true and cannot be empty. The following conditions must be met, otherwise initialization will fail: Only ECS instances with mounted data disks are supported. When specifying a data disk device name, ensure the device exists, otherwise initialization will fail. When specifying a data disk partition or logical volume name, ensure the partition or logical volume exists and uses the ext4 file system.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "imageId": { "type": "string", "description": "Image ID used by the ECS instance corresponding to the node.\n" }, "initializeScript": { "type": "string", "description": "Script executed after creating ECS nodes and deploying Kubernetes components. Supports Shell format. Base64-encoded length must not exceed 1 KB. If left empty, the node inherits the default node pool initialization script NodeConfig.InitializeScript. If you enter a custom script, the custom script will be used and the default node pool initialization script will be ignored.\n" }, "instanceId": { "type": "string", "description": "Cloud server instance ID corresponding to the node.\n" }, "isVirtual": { "type": "boolean", "description": "Is it a virtual node? Parameter value description: false: No, true: Yes.\n" }, "keepInstanceName": { "type": "boolean", "description": "Whether to retain the original ECS instance name. Options: false (default): do not retain the original ECS instance name; Container Service automatically assigns a name. true: retain the original ECS instance name.\n" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/NodeKubernetesConfig:NodeKubernetesConfig", "description": "Kubernetes-related configuration for the node. If empty, the node inherits the default node pool's Kubernetes configuration: KubernetesConfig.Labels/Taints/Cordon. If custom configuration is provided, the node uses the custom configuration and ignores the default node pool's Kubernetes configuration.\n" }, "name": { "type": "string", "description": "Node name.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodePoolId": { "type": "string", "description": "Node pool ID. If no parameter value is provided: add existing ECS instances to the default node pool. If a parameter value is provided: add existing ECS instances to a custom node pool.\n" }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Node role. Parameter value description: Worker: Worker node.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/NodeStatus:NodeStatus", "description": "Node status.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "required": [ "additionalContainerStorageEnabled", "clusterId", "containerStoragePath", "createdTime", "imageId", "initializeScript", "instanceId", "isVirtual", "keepInstanceName", "kubernetesConfig", "name", "nodeId", "nodePoolId", "roles", "status", "updatedTime", "zoneId" ], "inputProperties": { "additionalContainerStorageEnabled": { "type": "boolean", "description": "Select the data disk for the node, format and mount it as the storage directory for container images and logs. Values: false (default): Disabled. Default node pool: indicates no data disk is mounted. Custom node pool: mounts according to the node pool's data disk configuration. ECS instance data disks added to the node pool must include the data disk specified for mounting by the target node pool (including local disks), and the disk type and size must match exactly. true: Enabled. You must also configure the ContainerStoragePath parameter. The node mounts according to the configuration in the ContainerStoragePath parameter and ignores the node pool's data disk configuration. There are no special requirements for ECS instance data disks added to the node pool.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "containerStoragePath": { "type": "string", "description": "Use this data disk device to mount the container and image storage directory /var/lib/containerd.\nValid only when AdditionalContainerStorageEnabled=true and cannot be empty. The following conditions must be met, otherwise initialization will fail: Only ECS instances with mounted data disks are supported. When specifying a data disk device name, ensure the device exists, otherwise initialization will fail. When specifying a data disk partition or logical volume name, ensure the partition or logical volume exists and uses the ext4 file system.\n" }, "imageId": { "type": "string", "description": "Image ID used by the ECS instance corresponding to the node.\n" }, "initializeScript": { "type": "string", "description": "Script executed after creating ECS nodes and deploying Kubernetes components. Supports Shell format. Base64-encoded length must not exceed 1 KB. If left empty, the node inherits the default node pool initialization script NodeConfig.InitializeScript. If you enter a custom script, the custom script will be used and the default node pool initialization script will be ignored.\n" }, "instanceId": { "type": "string", "description": "Cloud server instance ID corresponding to the node.\n" }, "keepInstanceName": { "type": "boolean", "description": "Whether to retain the original ECS instance name. Options: false (default): do not retain the original ECS instance name; Container Service automatically assigns a name. true: retain the original ECS instance name.\n" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/NodeKubernetesConfig:NodeKubernetesConfig", "description": "Kubernetes-related configuration for the node. If empty, the node inherits the default node pool's Kubernetes configuration: KubernetesConfig.Labels/Taints/Cordon. If custom configuration is provided, the node uses the custom configuration and ignores the default node pool's Kubernetes configuration.\n" }, "nodePoolId": { "type": "string", "description": "Node pool ID. If no parameter value is provided: add existing ECS instances to the default node pool. If a parameter value is provided: add existing ECS instances to a custom node pool.\n" } }, "requiredInputs": [ "clusterId", "nodePoolId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Node resources.\n", "properties": { "additionalContainerStorageEnabled": { "type": "boolean", "description": "Select the data disk for the node, format and mount it as the storage directory for container images and logs. Values: false (default): Disabled. Default node pool: indicates no data disk is mounted. Custom node pool: mounts according to the node pool's data disk configuration. ECS instance data disks added to the node pool must include the data disk specified for mounting by the target node pool (including local disks), and the disk type and size must match exactly. true: Enabled. You must also configure the ContainerStoragePath parameter. The node mounts according to the configuration in the ContainerStoragePath parameter and ignores the node pool's data disk configuration. There are no special requirements for ECS instance data disks added to the node pool.\n" }, "clusterId": { "type": "string", "description": "Cluster ID.\n" }, "containerStoragePath": { "type": "string", "description": "Use this data disk device to mount the container and image storage directory /var/lib/containerd.\nValid only when AdditionalContainerStorageEnabled=true and cannot be empty. The following conditions must be met, otherwise initialization will fail: Only ECS instances with mounted data disks are supported. When specifying a data disk device name, ensure the device exists, otherwise initialization will fail. When specifying a data disk partition or logical volume name, ensure the partition or logical volume exists and uses the ext4 file system.\n" }, "createdTime": { "type": "string", "description": "Creation time.\n" }, "imageId": { "type": "string", "description": "Image ID used by the ECS instance corresponding to the node.\n" }, "initializeScript": { "type": "string", "description": "Script executed after creating ECS nodes and deploying Kubernetes components. Supports Shell format. Base64-encoded length must not exceed 1 KB. If left empty, the node inherits the default node pool initialization script NodeConfig.InitializeScript. If you enter a custom script, the custom script will be used and the default node pool initialization script will be ignored.\n" }, "instanceId": { "type": "string", "description": "Cloud server instance ID corresponding to the node.\n" }, "isVirtual": { "type": "boolean", "description": "Is it a virtual node? Parameter value description: false: No, true: Yes.\n" }, "keepInstanceName": { "type": "boolean", "description": "Whether to retain the original ECS instance name. Options: false (default): do not retain the original ECS instance name; Container Service automatically assigns a name. true: retain the original ECS instance name.\n" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/NodeKubernetesConfig:NodeKubernetesConfig", "description": "Kubernetes-related configuration for the node. If empty, the node inherits the default node pool's Kubernetes configuration: KubernetesConfig.Labels/Taints/Cordon. If custom configuration is provided, the node uses the custom configuration and ignores the default node pool's Kubernetes configuration.\n" }, "name": { "type": "string", "description": "Node name.\n" }, "nodeId": { "type": "string", "description": "Node ID.\n" }, "nodePoolId": { "type": "string", "description": "Node pool ID. If no parameter value is provided: add existing ECS instances to the default node pool. If a parameter value is provided: add existing ECS instances to a custom node pool.\n" }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Node role. Parameter value description: Worker: Worker node.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/NodeStatus:NodeStatus", "description": "Node status.\n" }, "updatedTime": { "type": "string", "description": "Update time.\n" }, "zoneId": { "type": "string", "description": "Availability zone ID.\n" } }, "type": "object" } }, "volcenginecc:vke/nodePool:NodePool": { "description": "A node pool is a group of nodes in a cluster with the same configuration. A node pool can contain one or more nodes. The node pool configuration includes node attributes such as node specifications, availability zones, labels, taints, and more. These attributes can be specified when creating the node pool or edited after creation.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vKENodePoolDemo:\n type: volcenginecc:vke:NodePool\n name: VKENodePoolDemo\n properties:\n autoScaling:\n max_replicas: 10\n min_replicas: 0\n enabled: true\n desired_replicas: 0\n priority: 10\n subnet_policy: ZoneBalance\n clusterId: cd6gojxxxxxxxxxxx\n kubernetesConfig:\n auto_sync_disabled: false\n containerd_config:\n insecureRegistries:\n - example.com\n registryProxyConfigs:\n - proxyEndpoints:\n - https://example.com:8080\n registry: example.com:8080\n cordon: false\n kubelet_config:\n cpuManagerPolicy: none\n evictionHard:\n - key: memory.available\n value: 15%\n kubeApiBurst: 10\n kubeApiQps: 5\n kubeReserved:\n - name: memory\n quantity: 200m\n maxPods: 110\n registryBurst: 10\n registryPullQps: 5\n serializeImagePulls: true\n systemReserved:\n - name: memory\n quantity: 200m\n topologyManagerPolicy: none\n topologyManagerScope: container\n labels:\n - key: label-key\n value: label-value\n name_prefix: name-prefix\n name_suffix: name-suffix\n name_use_hostname: false\n taints:\n - key: taint-key\n value: taint-value\n effect: NoSchedule\n management:\n enabled: true\n remedy_config:\n enabled: true\n remedyId: R20260227xxxxxxxxxxx\n name: test\n nodeConfig:\n instance_charge_type: PostPaid\n spot_strategy: SpotAsPriceGo\n instances_distribution:\n capacityRebalance: true\n compensateWithOnDemand: true\n onDemandBaseCapacity: 0\n onDemandPercentageAboveBaseCapacity: 0\n security:\n securityGroupIds:\n - sg-1a14cxqxxxxxxxxxx\n securityStrategies:\n - Hids\n login:\n sshKeyPairName: MigrationKey-job-yecd7xxxxxxxxxx\n data_volumes:\n - mountPoint: /dev/vdb\n size: 100\n snapshotId: snap-3wvah8xxxxxxxxxx\n type: ESSD_PL0\n system_volume:\n size: 40\n type: ESSD_PL0\n additional_container_storage_enabled: true\n deployment_set_group_number: 0\n deployment_set_id: dps-yedy0wxxxxxxxxxx\n hostname: node-host\n image_id: image-ybqi99xxxxxxxxxxx\n initialize_script: YmFzaCxxxxx9maxxxxx\n instance_name: node\n instance_type_ids:\n - ecs.g4il.large\n name_prefix: name-prefix\n network_traffic_mode: Standard\n project_name: default\n public_access_config:\n billingType: 2\n isp: BGP\n bandwidth: 5\n public_access_enabled: false\n subnet_ids:\n - subnet-ijifxxxxxo8cuxxxxx\n tags:\n - key: key\n value: value\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vke/nodePool:NodePool example \"cluster_id|node_pool_id\"\n```\n\n", "properties": { "autoScaling": { "$ref": "#/types/volcenginecc:vke/NodePoolAutoScaling:NodePoolAutoScaling", "description": "Node pool scaling policy configuration.\n" }, "clusterId": { "type": "string", "description": "ID of the cluster where the node pool is located\n" }, "createdTime": { "type": "string", "description": "Node pool creation time\n" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfig:NodePoolKubernetesConfig", "description": "Kubernetes-related configuration for the node pool\n" }, "management": { "$ref": "#/types/volcenginecc:vke/NodePoolManagement:NodePoolManagement", "description": "Managed node pool configuration\n" }, "name": { "type": "string", "description": "Node pool name. The node pool name must be unique within the same cluster. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length limit: 2–64 characters.\n" }, "nodeConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfig:NodePoolNodeConfig", "description": "Cloud server (ECS) instance configuration in the node pool\n" }, "nodePoolId": { "type": "string", "description": "Node pool ID\n" }, "nodeStatistics": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeStatistics:NodePoolNodeStatistics", "description": "Node statistics in the node pool.\n" }, "retainResources": { "type": "array", "items": { "type": "string" }, "description": "When deleting a node pool, specify related resources to retain. Values: Empty value (default): delete associated resources Ecs: when deleting the node pool, retain ECS instances in the node pool. If the node pool contains prepaid ECS instances and retaining ECS is not selected, this API only removes the ECS instance from the node pool and does not delete it. You can query the instance via the ECS console or ECS API and perform subsequent operations as needed.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/NodePoolStatus:NodePoolStatus", "description": "Node pool status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolTag:NodePoolTag" } }, "updatedTime": { "type": "string", "description": "Node pool update time\n" } }, "required": [ "autoScaling", "clusterId", "createdTime", "kubernetesConfig", "management", "name", "nodeConfig", "nodePoolId", "nodeStatistics", "retainResources", "status", "tags", "updatedTime" ], "inputProperties": { "autoScaling": { "$ref": "#/types/volcenginecc:vke/NodePoolAutoScaling:NodePoolAutoScaling", "description": "Node pool scaling policy configuration.\n" }, "clusterId": { "type": "string", "description": "ID of the cluster where the node pool is located\n" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfig:NodePoolKubernetesConfig", "description": "Kubernetes-related configuration for the node pool\n" }, "management": { "$ref": "#/types/volcenginecc:vke/NodePoolManagement:NodePoolManagement", "description": "Managed node pool configuration\n" }, "name": { "type": "string", "description": "Node pool name. The node pool name must be unique within the same cluster. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length limit: 2–64 characters.\n" }, "nodeConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfig:NodePoolNodeConfig", "description": "Cloud server (ECS) instance configuration in the node pool\n" }, "retainResources": { "type": "array", "items": { "type": "string" }, "description": "When deleting a node pool, specify related resources to retain. Values: Empty value (default): delete associated resources Ecs: when deleting the node pool, retain ECS instances in the node pool. If the node pool contains prepaid ECS instances and retaining ECS is not selected, this API only removes the ECS instance from the node pool and does not delete it. You can query the instance via the ECS console or ECS API and perform subsequent operations as needed.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolTag:NodePoolTag" } } }, "requiredInputs": [ "clusterId" ], "stateInputs": { "description": "Input properties used for looking up and filtering NodePool resources.\n", "properties": { "autoScaling": { "$ref": "#/types/volcenginecc:vke/NodePoolAutoScaling:NodePoolAutoScaling", "description": "Node pool scaling policy configuration.\n" }, "clusterId": { "type": "string", "description": "ID of the cluster where the node pool is located\n" }, "createdTime": { "type": "string", "description": "Node pool creation time\n" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolKubernetesConfig:NodePoolKubernetesConfig", "description": "Kubernetes-related configuration for the node pool\n" }, "management": { "$ref": "#/types/volcenginecc:vke/NodePoolManagement:NodePoolManagement", "description": "Managed node pool configuration\n" }, "name": { "type": "string", "description": "Node pool name. The node pool name must be unique within the same cluster. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length limit: 2–64 characters.\n" }, "nodeConfig": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeConfig:NodePoolNodeConfig", "description": "Cloud server (ECS) instance configuration in the node pool\n" }, "nodePoolId": { "type": "string", "description": "Node pool ID\n" }, "nodeStatistics": { "$ref": "#/types/volcenginecc:vke/NodePoolNodeStatistics:NodePoolNodeStatistics", "description": "Node statistics in the node pool.\n" }, "retainResources": { "type": "array", "items": { "type": "string" }, "description": "When deleting a node pool, specify related resources to retain. Values: Empty value (default): delete associated resources Ecs: when deleting the node pool, retain ECS instances in the node pool. If the node pool contains prepaid ECS instances and retaining ECS is not selected, this API only removes the ECS instance from the node pool and does not delete it. You can query the instance via the ECS console or ECS API and perform subsequent operations as needed.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/NodePoolStatus:NodePoolStatus", "description": "Node pool status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vke/NodePoolTag:NodePoolTag" } }, "updatedTime": { "type": "string", "description": "Node pool update time\n" } }, "type": "object" } }, "volcenginecc:vke/permission:Permission": { "description": "Container Service provides cluster RBAC authorization, granting RBAC access permissions to IAM users or roles. This includes accessible resources, scope of permissions, and predefined role types, enabling better management of cluster security access control and meeting enterprise users' requirements for fine-grained resource access control.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vKEPermissionDemo = new volcenginecc.vke.Permission(\"VKEPermissionDemo\", {\n roleDomain: \"namespace\",\n clusterId: \"cd48m3cb1b2ba7l6ebgp0xxxxx\",\n namespace: \"kube-public\",\n roleName: \"vke:visitor\",\n isCustomRole: false,\n granteeId: 59433888,\n granteeType: \"User\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_ke_permission_demo = volcenginecc.vke.Permission(\"VKEPermissionDemo\",\n role_domain=\"namespace\",\n cluster_id=\"cd48m3cb1b2ba7l6ebgp0xxxxx\",\n namespace=\"kube-public\",\n role_name=\"vke:visitor\",\n is_custom_role=False,\n grantee_id=59433888,\n grantee_type=\"User\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vKEPermissionDemo = new Volcenginecc.Vke.Permission(\"VKEPermissionDemo\", new()\n {\n RoleDomain = \"namespace\",\n ClusterId = \"cd48m3cb1b2ba7l6ebgp0xxxxx\",\n Namespace = \"kube-public\",\n RoleName = \"vke:visitor\",\n IsCustomRole = false,\n GranteeId = 59433888,\n GranteeType = \"User\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vke\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vke.NewPermission(ctx, \"VKEPermissionDemo\", \u0026vke.PermissionArgs{\n\t\t\tRoleDomain: pulumi.String(\"namespace\"),\n\t\t\tClusterId: pulumi.String(\"cd48m3cb1b2ba7l6ebgp0xxxxx\"),\n\t\t\tNamespace: pulumi.String(\"kube-public\"),\n\t\t\tRoleName: pulumi.String(\"vke:visitor\"),\n\t\t\tIsCustomRole: pulumi.Bool(false),\n\t\t\tGranteeId: pulumi.Int(59433888),\n\t\t\tGranteeType: pulumi.String(\"User\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vke.Permission;\nimport com.volcengine.volcenginecc.vke.PermissionArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vKEPermissionDemo = new Permission(\"vKEPermissionDemo\", PermissionArgs.builder()\n .roleDomain(\"namespace\")\n .clusterId(\"cd48m3cb1b2ba7l6ebgp0xxxxx\")\n .namespace(\"kube-public\")\n .roleName(\"vke:visitor\")\n .isCustomRole(false)\n .granteeId(59433888)\n .granteeType(\"User\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vKEPermissionDemo:\n type: volcenginecc:vke:Permission\n name: VKEPermissionDemo\n properties:\n roleDomain: namespace\n clusterId: cd48m3cb1b2ba7l6ebgp0xxxxx\n namespace: kube-public\n roleName: vke:visitor\n isCustomRole: false\n granteeId: 5.9433888e+07\n granteeType: User\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vke/permission:Permission example \"permission_id\"\n```\n\n", "properties": { "authorizedAt": { "type": "string", "description": "Time when the RBAC policy resource was authorized.\n" }, "authorizerId": { "type": "integer", "description": "Grantor ID. Can be an IAM user ID or an IAM role ID.\n" }, "authorizerName": { "type": "string", "description": "Grantor name\n" }, "authorizerType": { "type": "string", "description": "Type of grantor. Possible values: User: IAM user. Role: IAM role. Account: account.\n" }, "clusterId": { "type": "string", "description": "Cluster ID to be authorized for the IAM user or role. This parameter is required when roleDomain is namespace or cluster.\n" }, "createdTime": { "type": "string", "description": "Time when the RBAC policy resource was created.\n" }, "granteeId": { "type": "integer", "description": "Grantee ID. Can be an IAM user ID or an IAM role ID.\n" }, "granteeType": { "type": "string", "description": "Type of grantee. Possible values: User: IAM user. Role: IAM role. Account: account.\n" }, "isCustomRole": { "type": "boolean", "description": "Whether the RBAC role granted to the grantee is a custom role. Possible values: true: custom role. false (default): system predefined role.\n" }, "kubeRoleBindingName": { "type": "string", "description": "The object name of the RBAC policy resource in Kubernetes.\n" }, "message": { "type": "string", "description": "Authorization details message.\n" }, "namespace": { "type": "string", "description": "Namespace name to be authorized for the IAM user or role. This parameter is required when roleDomain equals namespace. If roleDomain does not equal namespace, this parameter is not effective.\n" }, "permissionId": { "type": "string", "description": "RBAC policy resource ID.\n" }, "projectSelector": { "type": "string", "description": "Project selector\n" }, "revokedAt": { "type": "string", "description": "Time when authorization is revoked.\n" }, "roleDomain": { "type": "string", "description": "The permission type granted to an IAM user or role. Possible values: namespace: grants permissions at the namespace level. cluster: grants permissions at the cluster level. all_clusters: grants permissions at the cluster level for all clusters under the current account.\n" }, "roleName": { "type": "string", "description": "Name of the RBAC role granted to the grantee. This parameter must be specified. When roleDomain is all_clusters, custom role names are not allowed.\n" }, "status": { "type": "string", "description": "Status of the RBAC access policy resource. Possible values: Success: authorization succeeded. Failed: authorization failed. Pending: authorization in progress. PartialSuccess: partial authorization succeeded.\n" } }, "required": [ "authorizedAt", "authorizerId", "authorizerName", "authorizerType", "clusterId", "createdTime", "granteeId", "granteeType", "isCustomRole", "kubeRoleBindingName", "message", "namespace", "permissionId", "projectSelector", "revokedAt", "roleDomain", "roleName", "status" ], "inputProperties": { "authorizerId": { "type": "integer", "description": "Grantor ID. Can be an IAM user ID or an IAM role ID.\n" }, "authorizerType": { "type": "string", "description": "Type of grantor. Possible values: User: IAM user. Role: IAM role. Account: account.\n" }, "clusterId": { "type": "string", "description": "Cluster ID to be authorized for the IAM user or role. This parameter is required when roleDomain is namespace or cluster.\n" }, "granteeId": { "type": "integer", "description": "Grantee ID. Can be an IAM user ID or an IAM role ID.\n" }, "granteeType": { "type": "string", "description": "Type of grantee. Possible values: User: IAM user. Role: IAM role. Account: account.\n" }, "isCustomRole": { "type": "boolean", "description": "Whether the RBAC role granted to the grantee is a custom role. Possible values: true: custom role. false (default): system predefined role.\n" }, "namespace": { "type": "string", "description": "Namespace name to be authorized for the IAM user or role. This parameter is required when roleDomain equals namespace. If roleDomain does not equal namespace, this parameter is not effective.\n" }, "roleDomain": { "type": "string", "description": "The permission type granted to an IAM user or role. Possible values: namespace: grants permissions at the namespace level. cluster: grants permissions at the cluster level. all_clusters: grants permissions at the cluster level for all clusters under the current account.\n" }, "roleName": { "type": "string", "description": "Name of the RBAC role granted to the grantee. This parameter must be specified. When roleDomain is all_clusters, custom role names are not allowed.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Permission resources.\n", "properties": { "authorizedAt": { "type": "string", "description": "Time when the RBAC policy resource was authorized.\n" }, "authorizerId": { "type": "integer", "description": "Grantor ID. Can be an IAM user ID or an IAM role ID.\n" }, "authorizerName": { "type": "string", "description": "Grantor name\n" }, "authorizerType": { "type": "string", "description": "Type of grantor. Possible values: User: IAM user. Role: IAM role. Account: account.\n" }, "clusterId": { "type": "string", "description": "Cluster ID to be authorized for the IAM user or role. This parameter is required when roleDomain is namespace or cluster.\n" }, "createdTime": { "type": "string", "description": "Time when the RBAC policy resource was created.\n" }, "granteeId": { "type": "integer", "description": "Grantee ID. Can be an IAM user ID or an IAM role ID.\n" }, "granteeType": { "type": "string", "description": "Type of grantee. Possible values: User: IAM user. Role: IAM role. Account: account.\n" }, "isCustomRole": { "type": "boolean", "description": "Whether the RBAC role granted to the grantee is a custom role. Possible values: true: custom role. false (default): system predefined role.\n" }, "kubeRoleBindingName": { "type": "string", "description": "The object name of the RBAC policy resource in Kubernetes.\n" }, "message": { "type": "string", "description": "Authorization details message.\n" }, "namespace": { "type": "string", "description": "Namespace name to be authorized for the IAM user or role. This parameter is required when roleDomain equals namespace. If roleDomain does not equal namespace, this parameter is not effective.\n" }, "permissionId": { "type": "string", "description": "RBAC policy resource ID.\n" }, "projectSelector": { "type": "string", "description": "Project selector\n" }, "revokedAt": { "type": "string", "description": "Time when authorization is revoked.\n" }, "roleDomain": { "type": "string", "description": "The permission type granted to an IAM user or role. Possible values: namespace: grants permissions at the namespace level. cluster: grants permissions at the cluster level. all_clusters: grants permissions at the cluster level for all clusters under the current account.\n" }, "roleName": { "type": "string", "description": "Name of the RBAC role granted to the grantee. This parameter must be specified. When roleDomain is all_clusters, custom role names are not allowed.\n" }, "status": { "type": "string", "description": "Status of the RBAC access policy resource. Possible values: Success: authorization succeeded. Failed: authorization failed. Pending: authorization in progress. PartialSuccess: partial authorization succeeded.\n" } }, "type": "object" } }, "volcenginecc:vmp/alertingRule:AlertingRule": { "description": "VMP alert rule configuration\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vMPAlertingRuleDemo:\n type: volcenginecc:vmp:AlertingRule\n name: VMPAlertingRuleDemo\n properties:\n name: alert-rule-demo\n description: this is a alert rule demo\n type: vmp/PromQL\n query:\n prom_ql: http_requests_total{method=\"PUT\", status=\"404\"}\n workspace_id: e9e4b146-0ba9-41ac-af2b-xxxxxx\n levels:\n - level: P0\n for: 1s\n comparator: \u003c\n threshold: 5\n - level: P1\n for: 6m\n comparator: \u003c=\n threshold: 10\n - level: P2\n for: 10m\n comparator: '!='\n threshold: 20\n notifyPolicyId: 2890eb5e-f383-4a7b-810f-xxxxxxx\n notifyGroupPolicyId: a8490e9b-4e5d-4a86-xxxx-xxxxxxx\n annotations:\n - name: Key\n value: Value\n labels:\n - name: LabelsKey\n value: LabelsValue\n status: Running\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vmp/alertingRule:AlertingRule example \"alerting_rule_id\"\n```\n\n", "properties": { "alertingRuleId": { "type": "string", "description": "Alert rule ID\n" }, "annotations": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleAnnotation:AlertingRuleAnnotation" } }, "createTime": { "type": "string", "description": "Alert rule creation time\n" }, "description": { "type": "string", "description": "Alert rule description\n" }, "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleLabel:AlertingRuleLabel" } }, "levels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleLevel:AlertingRuleLevel" } }, "name": { "type": "string", "description": "Alert rule name\n" }, "notifyGroupPolicyId": { "type": "string", "description": "Alert aggregation policy ID\n" }, "notifyPolicyId": { "type": "string", "description": "Alert notification policy ID\n" }, "query": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleQuery:AlertingRuleQuery", "description": "Alert configuration\n" }, "status": { "type": "string", "description": "Alert rule status: Running (monitoring), Disabled (disabled)\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleTag:AlertingRuleTag" } }, "type": { "type": "string", "description": "Alert rule type. Allowed values: vmp/PromQL\n" }, "updateTime": { "type": "string", "description": "Alert rule update time\n" } }, "required": [ "alertingRuleId", "annotations", "createTime", "description", "labels", "levels", "name", "notifyGroupPolicyId", "notifyPolicyId", "query", "status", "tags", "type", "updateTime" ], "inputProperties": { "annotations": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleAnnotation:AlertingRuleAnnotation" } }, "description": { "type": "string", "description": "Alert rule description\n" }, "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleLabel:AlertingRuleLabel" } }, "levels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleLevel:AlertingRuleLevel" } }, "name": { "type": "string", "description": "Alert rule name\n" }, "notifyGroupPolicyId": { "type": "string", "description": "Alert aggregation policy ID\n" }, "notifyPolicyId": { "type": "string", "description": "Alert notification policy ID\n" }, "query": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleQuery:AlertingRuleQuery", "description": "Alert configuration\n" }, "status": { "type": "string", "description": "Alert rule status: Running (monitoring), Disabled (disabled)\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleTag:AlertingRuleTag" } }, "type": { "type": "string", "description": "Alert rule type. Allowed values: vmp/PromQL\n" } }, "requiredInputs": [ "name", "type" ], "stateInputs": { "description": "Input properties used for looking up and filtering AlertingRule resources.\n", "properties": { "alertingRuleId": { "type": "string", "description": "Alert rule ID\n" }, "annotations": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleAnnotation:AlertingRuleAnnotation" } }, "createTime": { "type": "string", "description": "Alert rule creation time\n" }, "description": { "type": "string", "description": "Alert rule description\n" }, "labels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleLabel:AlertingRuleLabel" } }, "levels": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleLevel:AlertingRuleLevel" } }, "name": { "type": "string", "description": "Alert rule name\n" }, "notifyGroupPolicyId": { "type": "string", "description": "Alert aggregation policy ID\n" }, "notifyPolicyId": { "type": "string", "description": "Alert notification policy ID\n" }, "query": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleQuery:AlertingRuleQuery", "description": "Alert configuration\n" }, "status": { "type": "string", "description": "Alert rule status: Running (monitoring), Disabled (disabled)\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/AlertingRuleTag:AlertingRuleTag" } }, "type": { "type": "string", "description": "Alert rule type. Allowed values: vmp/PromQL\n" }, "updateTime": { "type": "string", "description": "Alert rule update time\n" } }, "type": "object" } }, "volcenginecc:vmp/workspace:Workspace": { "description": "Workspace is an abstract integration of data collection and rules in the VMP service, providing users with physical or logical isolation for Prometheus capabilities. You can create different workspaces in the VMP service, and data in different workspaces is isolated from each other\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst workspaceDemo = new volcenginecc.vmp.Workspace(\"WorkspaceDemo\", {\n authType: \"BearerToken\",\n bearerToken: \"M3cSN7gssM09-6wO8vdqo_xxxxxxxx\",\n deleteProtectionEnabled: false,\n description: \"test workspace\",\n instanceTypeId: \"vmp.standard.30d\",\n name: \"terraform_test_BearerToken\",\n projectName: \"default\",\n publicAccessEnabled: true,\n publicQueryBandwidth: 2,\n publicWriteBandwidth: 50,\n searchLatencyOffset: \"32s\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nworkspace_demo = volcenginecc.vmp.Workspace(\"WorkspaceDemo\",\n auth_type=\"BearerToken\",\n bearer_token=\"M3cSN7gssM09-6wO8vdqo_xxxxxxxx\",\n delete_protection_enabled=False,\n description=\"test workspace\",\n instance_type_id=\"vmp.standard.30d\",\n name=\"terraform_test_BearerToken\",\n project_name=\"default\",\n public_access_enabled=True,\n public_query_bandwidth=2,\n public_write_bandwidth=50,\n search_latency_offset=\"32s\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var workspaceDemo = new Volcenginecc.Vmp.Workspace(\"WorkspaceDemo\", new()\n {\n AuthType = \"BearerToken\",\n BearerToken = \"M3cSN7gssM09-6wO8vdqo_xxxxxxxx\",\n DeleteProtectionEnabled = false,\n Description = \"test workspace\",\n InstanceTypeId = \"vmp.standard.30d\",\n Name = \"terraform_test_BearerToken\",\n ProjectName = \"default\",\n PublicAccessEnabled = true,\n PublicQueryBandwidth = 2,\n PublicWriteBandwidth = 50,\n SearchLatencyOffset = \"32s\",\n Tags = new[]\n {\n new Volcenginecc.Vmp.Inputs.WorkspaceTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vmp\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vmp.NewWorkspace(ctx, \"WorkspaceDemo\", \u0026vmp.WorkspaceArgs{\n\t\t\tAuthType: pulumi.String(\"BearerToken\"),\n\t\t\tBearerToken: pulumi.String(\"M3cSN7gssM09-6wO8vdqo_xxxxxxxx\"),\n\t\t\tDeleteProtectionEnabled: pulumi.Bool(false),\n\t\t\tDescription: pulumi.String(\"test workspace\"),\n\t\t\tInstanceTypeId: pulumi.String(\"vmp.standard.30d\"),\n\t\t\tName: pulumi.String(\"terraform_test_BearerToken\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tPublicAccessEnabled: pulumi.Bool(true),\n\t\t\tPublicQueryBandwidth: pulumi.Int(2),\n\t\t\tPublicWriteBandwidth: pulumi.Int(50),\n\t\t\tSearchLatencyOffset: pulumi.String(\"32s\"),\n\t\t\tTags: vmp.WorkspaceTagArray{\n\t\t\t\t\u0026vmp.WorkspaceTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vmp.Workspace;\nimport com.volcengine.volcenginecc.vmp.WorkspaceArgs;\nimport com.pulumi.volcenginecc.vmp.inputs.WorkspaceTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var workspaceDemo = new Workspace(\"workspaceDemo\", WorkspaceArgs.builder()\n .authType(\"BearerToken\")\n .bearerToken(\"M3cSN7gssM09-6wO8vdqo_xxxxxxxx\")\n .deleteProtectionEnabled(false)\n .description(\"test workspace\")\n .instanceTypeId(\"vmp.standard.30d\")\n .name(\"terraform_test_BearerToken\")\n .projectName(\"default\")\n .publicAccessEnabled(true)\n .publicQueryBandwidth(2)\n .publicWriteBandwidth(50)\n .searchLatencyOffset(\"32s\")\n .tags(WorkspaceTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n workspaceDemo:\n type: volcenginecc:vmp:Workspace\n name: WorkspaceDemo\n properties:\n authType: BearerToken\n bearerToken: M3cSN7gssM09-6wO8vdqo_xxxxxxxx\n deleteProtectionEnabled: false\n description: test workspace\n instanceTypeId: vmp.standard.30d\n name: terraform_test_BearerToken\n projectName: default\n publicAccessEnabled: true\n publicQueryBandwidth: 2\n publicWriteBandwidth: 50\n searchLatencyOffset: 32s\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vmp/workspace:Workspace example \"workspace_id\"\n```\n\n", "properties": { "authType": { "type": "string", "description": "Workspace authentication type. Options: BasicAuth: Basic authentication, requires Username and Password for authentication. BearerToken: Token authentication, requires BearerToken for authentication. None: No custom authentication required. Note: When the authentication type is set to None, AK/SK authentication is used by default.\n" }, "bearerToken": { "type": "string", "description": "Workspace Bearer Token. Note: Configure this parameter only when the AuthType parameter is set to BearerToken.\n" }, "createTime": { "type": "string", "description": "Workspace creation time, RFC3339 format\n" }, "deleteProtectionEnabled": { "type": "boolean", "description": "Enable workspace deletion protection: true for enabled, false for disabled\n" }, "description": { "type": "string", "description": "Workspace description, string, length limit 0–200\n" }, "instanceType": { "$ref": "#/types/volcenginecc:vmp/WorkspaceInstanceType:WorkspaceInstanceType", "description": "Workspace specification details\n" }, "instanceTypeId": { "type": "string", "description": "Workspace specifications: vmp.standard.15d: workspace with 15 days storage duration. vmp.standard.30d: workspace with 30 days storage duration. vmp.standard.90d: workspace with 90 days storage duration. vmp.standard.180d: workspace with 180 days storage duration. vmp.standard.1y: workspace with 1 year storage duration\n" }, "name": { "type": "string", "description": "Workspace name, string, length limit 1–100\n" }, "overdueReclaimTime": { "type": "string", "description": "Workspace expected overdue recovery time, RFC3339 format\n" }, "password": { "type": "string", "description": "Workspace BasicAuth password\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "prometheusPushEndpoint": { "type": "string", "description": "Workspace public Push Gateway URL address.\n" }, "prometheusPushIntranetEndpoint": { "type": "string", "description": "Workspace Push Gateway URL address\n" }, "prometheusQueryEndpoint": { "type": "string", "description": "Workspace public Query URL address.\n" }, "prometheusQueryIntranetEndpoint": { "type": "string", "description": "Workspace Query URL address\n" }, "prometheusWriteEndpoint": { "type": "string", "description": "Workspace public RemoteWrite URL address.\n" }, "prometheusWriteIntranetEndpoint": { "type": "string", "description": "Workspace RemoteWrite URL address\n" }, "publicAccessEnabled": { "type": "boolean", "description": "Whether to enable workspace public access capability. true: enabled, false: disabled.\n" }, "publicQueryBandwidth": { "type": "integer", "description": "Workspace public Query bandwidth (Mbps).\n" }, "publicWriteBandwidth": { "type": "integer", "description": "Workspace public RemoteWrite bandwidth (Mbps).\n" }, "quota": { "$ref": "#/types/volcenginecc:vmp/WorkspaceQuota:WorkspaceQuota", "description": "Workspace quota details\n" }, "searchLatencyOffset": { "type": "string", "description": "Workspace public Query search latency offset.\n" }, "status": { "type": "string", "description": "Workspace status. Values: Creating: creating Active: active Updating: updating Deleting: deleting OverdueShutted: overdue shutdown Resuming: resuming Error: error\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/WorkspaceTag:WorkspaceTag" } }, "usage": { "$ref": "#/types/volcenginecc:vmp/WorkspaceUsage:WorkspaceUsage", "description": "Workspace usage\n" }, "username": { "type": "string", "description": "Workspace BasicAuth username\n" }, "workspaceId": { "type": "string", "description": "Workspace ID\n" } }, "required": [ "authType", "bearerToken", "createTime", "deleteProtectionEnabled", "description", "instanceType", "instanceTypeId", "name", "overdueReclaimTime", "password", "projectName", "prometheusPushEndpoint", "prometheusPushIntranetEndpoint", "prometheusQueryEndpoint", "prometheusQueryIntranetEndpoint", "prometheusWriteEndpoint", "prometheusWriteIntranetEndpoint", "publicAccessEnabled", "publicQueryBandwidth", "publicWriteBandwidth", "quota", "searchLatencyOffset", "status", "tags", "usage", "username", "workspaceId" ], "inputProperties": { "authType": { "type": "string", "description": "Workspace authentication type. Options: BasicAuth: Basic authentication, requires Username and Password for authentication. BearerToken: Token authentication, requires BearerToken for authentication. None: No custom authentication required. Note: When the authentication type is set to None, AK/SK authentication is used by default.\n" }, "bearerToken": { "type": "string", "description": "Workspace Bearer Token. Note: Configure this parameter only when the AuthType parameter is set to BearerToken.\n" }, "deleteProtectionEnabled": { "type": "boolean", "description": "Enable workspace deletion protection: true for enabled, false for disabled\n" }, "description": { "type": "string", "description": "Workspace description, string, length limit 0–200\n" }, "instanceTypeId": { "type": "string", "description": "Workspace specifications: vmp.standard.15d: workspace with 15 days storage duration. vmp.standard.30d: workspace with 30 days storage duration. vmp.standard.90d: workspace with 90 days storage duration. vmp.standard.180d: workspace with 180 days storage duration. vmp.standard.1y: workspace with 1 year storage duration\n" }, "name": { "type": "string", "description": "Workspace name, string, length limit 1–100\n" }, "password": { "type": "string", "description": "Workspace BasicAuth password\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "publicAccessEnabled": { "type": "boolean", "description": "Whether to enable workspace public access capability. true: enabled, false: disabled.\n" }, "publicQueryBandwidth": { "type": "integer", "description": "Workspace public Query bandwidth (Mbps).\n" }, "publicWriteBandwidth": { "type": "integer", "description": "Workspace public RemoteWrite bandwidth (Mbps).\n" }, "quota": { "$ref": "#/types/volcenginecc:vmp/WorkspaceQuota:WorkspaceQuota", "description": "Workspace quota details\n" }, "searchLatencyOffset": { "type": "string", "description": "Workspace public Query search latency offset.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/WorkspaceTag:WorkspaceTag" } }, "username": { "type": "string", "description": "Workspace BasicAuth username\n" } }, "requiredInputs": [ "instanceTypeId", "name" ], "stateInputs": { "description": "Input properties used for looking up and filtering Workspace resources.\n", "properties": { "authType": { "type": "string", "description": "Workspace authentication type. Options: BasicAuth: Basic authentication, requires Username and Password for authentication. BearerToken: Token authentication, requires BearerToken for authentication. None: No custom authentication required. Note: When the authentication type is set to None, AK/SK authentication is used by default.\n" }, "bearerToken": { "type": "string", "description": "Workspace Bearer Token. Note: Configure this parameter only when the AuthType parameter is set to BearerToken.\n" }, "createTime": { "type": "string", "description": "Workspace creation time, RFC3339 format\n" }, "deleteProtectionEnabled": { "type": "boolean", "description": "Enable workspace deletion protection: true for enabled, false for disabled\n" }, "description": { "type": "string", "description": "Workspace description, string, length limit 0–200\n" }, "instanceType": { "$ref": "#/types/volcenginecc:vmp/WorkspaceInstanceType:WorkspaceInstanceType", "description": "Workspace specification details\n" }, "instanceTypeId": { "type": "string", "description": "Workspace specifications: vmp.standard.15d: workspace with 15 days storage duration. vmp.standard.30d: workspace with 30 days storage duration. vmp.standard.90d: workspace with 90 days storage duration. vmp.standard.180d: workspace with 180 days storage duration. vmp.standard.1y: workspace with 1 year storage duration\n" }, "name": { "type": "string", "description": "Workspace name, string, length limit 1–100\n" }, "overdueReclaimTime": { "type": "string", "description": "Workspace expected overdue recovery time, RFC3339 format\n" }, "password": { "type": "string", "description": "Workspace BasicAuth password\n" }, "projectName": { "type": "string", "description": "Project name\n" }, "prometheusPushEndpoint": { "type": "string", "description": "Workspace public Push Gateway URL address.\n" }, "prometheusPushIntranetEndpoint": { "type": "string", "description": "Workspace Push Gateway URL address\n" }, "prometheusQueryEndpoint": { "type": "string", "description": "Workspace public Query URL address.\n" }, "prometheusQueryIntranetEndpoint": { "type": "string", "description": "Workspace Query URL address\n" }, "prometheusWriteEndpoint": { "type": "string", "description": "Workspace public RemoteWrite URL address.\n" }, "prometheusWriteIntranetEndpoint": { "type": "string", "description": "Workspace RemoteWrite URL address\n" }, "publicAccessEnabled": { "type": "boolean", "description": "Whether to enable workspace public access capability. true: enabled, false: disabled.\n" }, "publicQueryBandwidth": { "type": "integer", "description": "Workspace public Query bandwidth (Mbps).\n" }, "publicWriteBandwidth": { "type": "integer", "description": "Workspace public RemoteWrite bandwidth (Mbps).\n" }, "quota": { "$ref": "#/types/volcenginecc:vmp/WorkspaceQuota:WorkspaceQuota", "description": "Workspace quota details\n" }, "searchLatencyOffset": { "type": "string", "description": "Workspace public Query search latency offset.\n" }, "status": { "type": "string", "description": "Workspace status. Values: Creating: creating Active: active Updating: updating Deleting: deleting OverdueShutted: overdue shutdown Resuming: resuming Error: error\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vmp/WorkspaceTag:WorkspaceTag" } }, "usage": { "$ref": "#/types/volcenginecc:vmp/WorkspaceUsage:WorkspaceUsage", "description": "Workspace usage\n" }, "username": { "type": "string", "description": "Workspace BasicAuth username\n" }, "workspaceId": { "type": "string", "description": "Workspace ID\n" } }, "type": "object" } }, "volcenginecc:vpc/bandwidthPackage:BandwidthPackage": { "description": "A shared bandwidth package is a cloud resource that supports multiplexing and sharing bandwidth. Add multiple public IPs or IPv6 public bandwidths within a single region to a shared bandwidth package instance to share one bandwidth.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n bandwidthPackageDemo:\n type: volcenginecc:vpc:BandwidthPackage\n name: BandwidthPackageDemo\n properties:\n period: 1\n periodUnit: 1\n protocol: Dual-stack\n tags:\n - key: env\n value: test\n bandwidthPackageName: BandwidthPackageDemo\n description: BandwidthPackageDemo\n isp: BGP\n billingType: 2\n bandwidth: 2\n projectName: default\n eipAddresses:\n - allocation_id: eip-2f90y2a8sczcw4f4pzzx1xxxx\n eip_address: 101.126.*.143\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/bandwidthPackage:BandwidthPackage example \"bandwidth_package_id\"\n```\n\n", "properties": { "bandwidth": { "type": "integer", "description": "Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.\n" }, "bandwidthPackageId": { "type": "string", "description": "Bandwidth package ID\n" }, "bandwidthPackageName": { "type": "string", "description": "Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).\n" }, "billingType": { "type": "integer", "description": "Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).\n" }, "businessStatus": { "type": "string", "description": "Billing status\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "deletedTime": { "type": "string", "description": "Deletion time\n" }, "description": { "type": "string", "description": "Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" }, "eipAddresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/BandwidthPackageEipAddress:BandwidthPackageEipAddress" } }, "enableDualStack": { "type": "boolean", "description": "Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.\n" }, "expiredTime": { "type": "string", "description": "Expiration time\n" }, "isp": { "type": "string", "description": "Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLine*BGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use Premium*BGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use Fusion*BGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobile*Value: China Mobile economical static single line. 5.2, ChinaUnicom*Value: China Unicom economical static single line. 5.3, ChinaTelecom*Value: China Telecom economical static single line.\n" }, "overdueTime": { "type": "string", "description": "Overdue time\n" }, "period": { "type": "integer", "description": "Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.\n" }, "periodUnit": { "type": "integer", "description": "Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.\n" }, "projectName": { "type": "string", "description": "Project name. If not specified, added to the default project.\n" }, "protocol": { "type": "string", "description": "IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.\n" }, "ratio": { "type": "integer", "description": "95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.\n" }, "status": { "type": "string", "description": "Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/BandwidthPackageTag:BandwidthPackageTag" } }, "updatedTime": { "type": "string", "description": "Update time\n" } }, "required": [ "bandwidth", "bandwidthPackageId", "bandwidthPackageName", "billingType", "businessStatus", "createdTime", "deletedTime", "description", "eipAddresses", "enableDualStack", "expiredTime", "isp", "overdueTime", "period", "periodUnit", "projectName", "protocol", "ratio", "securityProtectionTypes", "status", "tags", "updatedTime" ], "inputProperties": { "bandwidth": { "type": "integer", "description": "Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.\n" }, "bandwidthPackageName": { "type": "string", "description": "Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).\n" }, "billingType": { "type": "integer", "description": "Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).\n" }, "description": { "type": "string", "description": "Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" }, "eipAddresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/BandwidthPackageEipAddress:BandwidthPackageEipAddress" } }, "enableDualStack": { "type": "boolean", "description": "Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.\n" }, "isp": { "type": "string", "description": "Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLine*BGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use Premium*BGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use Fusion*BGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobile*Value: China Mobile economical static single line. 5.2, ChinaUnicom*Value: China Unicom economical static single line. 5.3, ChinaTelecom*Value: China Telecom economical static single line.\n" }, "period": { "type": "integer", "description": "Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.\n" }, "periodUnit": { "type": "integer", "description": "Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.\n" }, "projectName": { "type": "string", "description": "Project name. If not specified, added to the default project.\n" }, "protocol": { "type": "string", "description": "IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/BandwidthPackageTag:BandwidthPackageTag" } } }, "requiredInputs": [ "bandwidth" ], "stateInputs": { "description": "Input properties used for looking up and filtering BandwidthPackage resources.\n", "properties": { "bandwidth": { "type": "integer", "description": "Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.\n" }, "bandwidthPackageId": { "type": "string", "description": "Bandwidth package ID\n" }, "bandwidthPackageName": { "type": "string", "description": "Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).\n" }, "billingType": { "type": "integer", "description": "Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).\n" }, "businessStatus": { "type": "string", "description": "Billing status\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "deletedTime": { "type": "string", "description": "Deletion time\n" }, "description": { "type": "string", "description": "Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" }, "eipAddresses": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/BandwidthPackageEipAddress:BandwidthPackageEipAddress" } }, "enableDualStack": { "type": "boolean", "description": "Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.\n" }, "expiredTime": { "type": "string", "description": "Expiration time\n" }, "isp": { "type": "string", "description": "Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLine*BGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use Premium*BGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use Fusion*BGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobile*Value: China Mobile economical static single line. 5.2, ChinaUnicom*Value: China Unicom economical static single line. 5.3, ChinaTelecom*Value: China Telecom economical static single line.\n" }, "overdueTime": { "type": "string", "description": "Overdue time\n" }, "period": { "type": "integer", "description": "Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.\n" }, "periodUnit": { "type": "integer", "description": "Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.\n" }, "projectName": { "type": "string", "description": "Project name. If not specified, added to the default project.\n" }, "protocol": { "type": "string", "description": "IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.\n" }, "ratio": { "type": "integer", "description": "95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.\n" }, "status": { "type": "string", "description": "Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/BandwidthPackageTag:BandwidthPackageTag" } }, "updatedTime": { "type": "string", "description": "Update time\n" } }, "type": "object" } }, "volcenginecc:vpc/eip:Eip": { "description": "Public IP (Elastic IP Address, EIP) and its public outbound bandwidth are IP connectivity services provided by Volcano Engine for cloud resources, which can be purchased and held independently. Public IP supports direct binding to cloud servers (including ECS cloud servers, EBM bare metal servers, GPU cloud servers), and also supports binding to public NAT gateways, load balancers, and secondary network interfaces, providing public network connectivity for cloud servers.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst eipDemo = new volcenginecc.vpc.Eip(\"EipDemo\", {\n name: \"EipDemo\",\n description: \"EipDemo description\",\n isp: \"BGP\",\n billingType: 2,\n bandwidth: 3,\n period: 5,\n projectName: \"default\",\n bandwidthPackageId: \"bwp-ij5gz1lf66m874o8cth*****\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n instanceId: \"i-ye48ymyy9s5i3z4*****\",\n instanceType: \"EcsInstance\",\n directMode: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\neip_demo = volcenginecc.vpc.Eip(\"EipDemo\",\n name=\"EipDemo\",\n description=\"EipDemo description\",\n isp=\"BGP\",\n billing_type=2,\n bandwidth=3,\n period=5,\n project_name=\"default\",\n bandwidth_package_id=\"bwp-ij5gz1lf66m874o8cth*****\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }],\n instance_id=\"i-ye48ymyy9s5i3z4*****\",\n instance_type=\"EcsInstance\",\n direct_mode=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var eipDemo = new Volcenginecc.Vpc.Eip(\"EipDemo\", new()\n {\n Name = \"EipDemo\",\n Description = \"EipDemo description\",\n Isp = \"BGP\",\n BillingType = 2,\n Bandwidth = 3,\n Period = 5,\n ProjectName = \"default\",\n BandwidthPackageId = \"bwp-ij5gz1lf66m874o8cth*****\",\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.EipTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n InstanceId = \"i-ye48ymyy9s5i3z4*****\",\n InstanceType = \"EcsInstance\",\n DirectMode = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewEip(ctx, \"EipDemo\", \u0026vpc.EipArgs{\n\t\t\tName: pulumi.String(\"EipDemo\"),\n\t\t\tDescription: pulumi.String(\"EipDemo description\"),\n\t\t\tIsp: pulumi.String(\"BGP\"),\n\t\t\tBillingType: pulumi.Int(2),\n\t\t\tBandwidth: pulumi.Int(3),\n\t\t\tPeriod: pulumi.Int(5),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tBandwidthPackageId: pulumi.String(\"bwp-ij5gz1lf66m874o8cth*****\"),\n\t\t\tTags: vpc.EipTagArray{\n\t\t\t\t\u0026vpc.EipTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tInstanceId: pulumi.String(\"i-ye48ymyy9s5i3z4*****\"),\n\t\t\tInstanceType: pulumi.String(\"EcsInstance\"),\n\t\t\tDirectMode: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.Eip;\nimport com.volcengine.volcenginecc.vpc.EipArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.EipTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var eipDemo = new Eip(\"eipDemo\", EipArgs.builder()\n .name(\"EipDemo\")\n .description(\"EipDemo description\")\n .isp(\"BGP\")\n .billingType(2)\n .bandwidth(3)\n .period(5)\n .projectName(\"default\")\n .bandwidthPackageId(\"bwp-ij5gz1lf66m874o8cth*****\")\n .tags(EipTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .instanceId(\"i-ye48ymyy9s5i3z4*****\")\n .instanceType(\"EcsInstance\")\n .directMode(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n eipDemo:\n type: volcenginecc:vpc:Eip\n name: EipDemo\n properties:\n name: EipDemo\n description: EipDemo description\n isp: BGP\n billingType: 2\n bandwidth: 3\n period: 5\n projectName: default\n bandwidthPackageId: bwp-ij5gz1lf66m874o8cth*****\n tags:\n - key: env\n value: test\n instanceId: i-ye48ymyy9s5i3z4*****\n instanceType: EcsInstance\n directMode: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/eip:Eip example \"allocation_id\"\n```\n\n", "properties": { "allocationId": { "type": "string", "description": "Public IP ID.\n" }, "bandwidth": { "type": "integer", "description": "Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.\n" }, "billingType": { "type": "integer", "description": "Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.\n" }, "businessStatus": { "type": "string", "description": "Whether the public IP is locked. Normal: normal. FinancialLocked: locked.\n" }, "createdTime": { "type": "string", "description": "Creation time of the public IP.\n" }, "deletedTime": { "type": "string", "description": "Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.\n" }, "description": { "type": "string", "description": "Description of the public IP.\n" }, "directMode": { "type": "boolean", "description": "Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.\n" }, "eipAddress": { "type": "string", "description": "Public IP address.\n" }, "expiredTime": { "type": "string", "description": "Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.\n" }, "instanceId": { "type": "string", "description": "Currently bound instance ID.\n" }, "instanceType": { "type": "string", "description": "Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.\n" }, "ipAddress": { "type": "string", "description": "Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address\n" }, "ipAddressPoolId": { "type": "string", "description": "IP address pool ID.\n" }, "isBlocked": { "type": "boolean", "description": "Whether it is blocked. true: yes. false: no.\n" }, "isp": { "type": "string", "description": "Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLine*BGP: BGP single line. Fusion*BGP: Fusion BGP. ChinaMobile*Value: China Mobile Value static single line. ChinaUnicom*Value: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.\n" }, "lockReason": { "type": "string", "description": "Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.\n" }, "name": { "type": "string", "description": "Name of the public IP.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.\n" }, "period": { "type": "integer", "description": "When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.\n" }, "periodUnit": { "type": "integer", "description": "Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.\n" }, "privateIpAddress": { "type": "string", "description": "Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the public IP belongs.\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.\n" }, "renewPeriodTimes": { "type": "integer", "description": "Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.\n" }, "renewType": { "type": "integer", "description": "Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.\n" }, "serviceManaged": { "type": "boolean", "description": "Managed by service\n" }, "status": { "type": "string", "description": "Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/EipTag:EipTag" } }, "updatedTime": { "type": "string", "description": "Time when the public IP was updated.\n" } }, "required": [ "allocationId", "bandwidth", "bandwidthPackageId", "billingType", "businessStatus", "createdTime", "deletedTime", "description", "directMode", "eipAddress", "expiredTime", "instanceId", "instanceType", "ipAddress", "ipAddressPoolId", "isBlocked", "isp", "lockReason", "name", "overdueTime", "period", "periodUnit", "privateIpAddress", "projectName", "releaseWithInstance", "renewPeriodTimes", "renewType", "securityProtectionInstanceId", "securityProtectionTypes", "serviceManaged", "status", "tags", "updatedTime" ], "inputProperties": { "bandwidth": { "type": "integer", "description": "Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.\n" }, "billingType": { "type": "integer", "description": "Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.\n" }, "description": { "type": "string", "description": "Description of the public IP.\n" }, "directMode": { "type": "boolean", "description": "Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.\n" }, "instanceId": { "type": "string", "description": "Currently bound instance ID.\n" }, "instanceType": { "type": "string", "description": "Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.\n" }, "ipAddress": { "type": "string", "description": "Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address\n" }, "ipAddressPoolId": { "type": "string", "description": "IP address pool ID.\n" }, "isp": { "type": "string", "description": "Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLine*BGP: BGP single line. Fusion*BGP: Fusion BGP. ChinaMobile*Value: China Mobile Value static single line. ChinaUnicom*Value: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.\n" }, "name": { "type": "string", "description": "Name of the public IP.\n" }, "period": { "type": "integer", "description": "When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.\n" }, "periodUnit": { "type": "integer", "description": "Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.\n" }, "privateIpAddress": { "type": "string", "description": "Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the public IP belongs.\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.\n" }, "renewPeriodTimes": { "type": "integer", "description": "Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.\n" }, "renewType": { "type": "integer", "description": "Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/EipTag:EipTag" } } }, "requiredInputs": [ "billingType" ], "stateInputs": { "description": "Input properties used for looking up and filtering Eip resources.\n", "properties": { "allocationId": { "type": "string", "description": "Public IP ID.\n" }, "bandwidth": { "type": "integer", "description": "Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.\n" }, "bandwidthPackageId": { "type": "string", "description": "Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.\n" }, "billingType": { "type": "integer", "description": "Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.\n" }, "businessStatus": { "type": "string", "description": "Whether the public IP is locked. Normal: normal. FinancialLocked: locked.\n" }, "createdTime": { "type": "string", "description": "Creation time of the public IP.\n" }, "deletedTime": { "type": "string", "description": "Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.\n" }, "description": { "type": "string", "description": "Description of the public IP.\n" }, "directMode": { "type": "boolean", "description": "Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.\n" }, "eipAddress": { "type": "string", "description": "Public IP address.\n" }, "expiredTime": { "type": "string", "description": "Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.\n" }, "instanceId": { "type": "string", "description": "Currently bound instance ID.\n" }, "instanceType": { "type": "string", "description": "Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.\n" }, "ipAddress": { "type": "string", "description": "Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address\n" }, "ipAddressPoolId": { "type": "string", "description": "IP address pool ID.\n" }, "isBlocked": { "type": "boolean", "description": "Whether it is blocked. true: yes. false: no.\n" }, "isp": { "type": "string", "description": "Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLine*BGP: BGP single line. Fusion*BGP: Fusion BGP. ChinaMobile*Value: China Mobile Value static single line. ChinaUnicom*Value: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.\n" }, "lockReason": { "type": "string", "description": "Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.\n" }, "name": { "type": "string", "description": "Name of the public IP.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.\n" }, "period": { "type": "integer", "description": "When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.\n" }, "periodUnit": { "type": "integer", "description": "Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.\n" }, "privateIpAddress": { "type": "string", "description": "Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the public IP belongs.\n" }, "releaseWithInstance": { "type": "boolean", "description": "Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.\n" }, "renewPeriodTimes": { "type": "integer", "description": "Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.\n" }, "renewType": { "type": "integer", "description": "Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.\n" }, "securityProtectionInstanceId": { "type": "integer", "description": "DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.\n" }, "securityProtectionTypes": { "type": "array", "items": { "type": "string" }, "description": "Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.\n" }, "serviceManaged": { "type": "boolean", "description": "Managed by service\n" }, "status": { "type": "string", "description": "Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/EipTag:EipTag" } }, "updatedTime": { "type": "string", "description": "Time when the public IP was updated.\n" } }, "type": "object" } }, "volcenginecc:vpc/eni:Eni": { "description": "A network interface is a virtual network interface. In a private network, it serves as a network interface attached to cloud servers, load balancers, and other cloud resources. Each network interface has a primary private IP address. You can manually assign multiple auxiliary private IP addresses if needed.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n eniDemo:\n type: volcenginecc:vpc:Eni\n name: EniDemo\n properties:\n networkInterfaceName: EniDemo\n subnetId: vpc_subnet-xxxx\n securityGroupIds:\n - vpc_security_group-xxxx\n instanceId: i-ye498lwge85i3z3kxxxx\n projectName: default\n primaryIpAddress:\n private_ip_address: 192.168.x.130\n associated_elastic_ip:\n allocationId: eip-2f80zqjduo6ps4f4pzzcxxxxx\n secondaryPrivateIpAddressCount: 2\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/eni:Eni example \"network_interface_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "NIC owner ID\n" }, "createdTime": { "type": "string", "description": "NIC creation time\n" }, "deleteOnTermination": { "type": "boolean", "description": "Enable release with cloud server instance deletion. true to enable, false to disable\n" }, "description": { "type": "string", "description": "Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). If not specified, defaults to an empty string.\n" }, "instanceId": { "type": "string", "description": "ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty\n" }, "ipv6AddressCount": { "type": "integer", "description": "Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.\n" }, "ipv6Sets": { "type": "array", "items": { "type": "string" }, "description": "IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].\n" }, "macAddress": { "type": "string", "description": "MAC address of the network interface.\n" }, "networkInterfaceId": { "type": "string", "description": "Network interface ID.\n" }, "networkInterfaceName": { "type": "string", "description": "NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC\n" }, "portSecurityEnabled": { "type": "boolean", "description": "Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)\n" }, "primaryIpAddress": { "$ref": "#/types/volcenginecc:vpc/EniPrimaryIpAddress:EniPrimaryIpAddress", "description": "Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.\n" }, "privateIpSets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/EniPrivateIpSet:EniPrivateIpSet" } }, "projectName": { "type": "string", "description": "Name of the project to which the NIC belongs\n" }, "secondaryPrivateIpAddressCount": { "type": "integer", "description": "Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of one or more security groups joined by the auxiliary network interface.\n" }, "serviceManaged": { "type": "boolean", "description": "Indicates whether this is an official service network interface. true for yes, false for no.\n" }, "status": { "type": "string", "description": "Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet where the auxiliary network interface resides.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/EniTag:EniTag" } }, "type": { "type": "string", "description": "NIC type. primary: primary NIC, secondary: secondary NIC\n" }, "updatedTime": { "type": "string", "description": "NIC update time\n" }, "vpcId": { "type": "string", "description": "ID of the VPC to which the network interface belongs.\n" }, "vpcName": { "type": "string", "description": "Name of the VPC to which the NIC belongs\n" }, "zoneId": { "type": "string", "description": "ID of the availability zone to which the network interface belongs.\n" } }, "required": [ "accountId", "createdTime", "deleteOnTermination", "description", "instanceId", "ipv6AddressCount", "ipv6Sets", "macAddress", "networkInterfaceId", "networkInterfaceName", "portSecurityEnabled", "primaryIpAddress", "privateIpSets", "projectName", "secondaryPrivateIpAddressCount", "securityGroupIds", "serviceManaged", "status", "subnetId", "tags", "type", "updatedTime", "vpcId", "vpcName", "zoneId" ], "inputProperties": { "deleteOnTermination": { "type": "boolean", "description": "Enable release with cloud server instance deletion. true to enable, false to disable\n" }, "description": { "type": "string", "description": "Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). If not specified, defaults to an empty string.\n" }, "instanceId": { "type": "string", "description": "ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty\n" }, "ipv6AddressCount": { "type": "integer", "description": "Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.\n" }, "ipv6Sets": { "type": "array", "items": { "type": "string" }, "description": "IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].\n" }, "networkInterfaceName": { "type": "string", "description": "NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC\n" }, "portSecurityEnabled": { "type": "boolean", "description": "Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)\n" }, "primaryIpAddress": { "$ref": "#/types/volcenginecc:vpc/EniPrimaryIpAddress:EniPrimaryIpAddress", "description": "Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.\n" }, "privateIpSets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/EniPrivateIpSet:EniPrivateIpSet" } }, "projectName": { "type": "string", "description": "Name of the project to which the NIC belongs\n" }, "secondaryPrivateIpAddressCount": { "type": "integer", "description": "Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of one or more security groups joined by the auxiliary network interface.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet where the auxiliary network interface resides.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/EniTag:EniTag" } } }, "stateInputs": { "description": "Input properties used for looking up and filtering Eni resources.\n", "properties": { "accountId": { "type": "string", "description": "NIC owner ID\n" }, "createdTime": { "type": "string", "description": "NIC creation time\n" }, "deleteOnTermination": { "type": "boolean", "description": "Enable release with cloud server instance deletion. true to enable, false to disable\n" }, "description": { "type": "string", "description": "Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). If not specified, defaults to an empty string.\n" }, "instanceId": { "type": "string", "description": "ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty\n" }, "ipv6AddressCount": { "type": "integer", "description": "Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.\n" }, "ipv6Sets": { "type": "array", "items": { "type": "string" }, "description": "IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].\n" }, "macAddress": { "type": "string", "description": "MAC address of the network interface.\n" }, "networkInterfaceId": { "type": "string", "description": "Network interface ID.\n" }, "networkInterfaceName": { "type": "string", "description": "NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC\n" }, "portSecurityEnabled": { "type": "boolean", "description": "Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)\n" }, "primaryIpAddress": { "$ref": "#/types/volcenginecc:vpc/EniPrimaryIpAddress:EniPrimaryIpAddress", "description": "Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.\n" }, "privateIpSets": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/EniPrivateIpSet:EniPrivateIpSet" } }, "projectName": { "type": "string", "description": "Name of the project to which the NIC belongs\n" }, "secondaryPrivateIpAddressCount": { "type": "integer", "description": "Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of one or more security groups joined by the auxiliary network interface.\n" }, "serviceManaged": { "type": "boolean", "description": "Indicates whether this is an official service network interface. true for yes, false for no.\n" }, "status": { "type": "string", "description": "Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet where the auxiliary network interface resides.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/EniTag:EniTag" } }, "type": { "type": "string", "description": "NIC type. primary: primary NIC, secondary: secondary NIC\n" }, "updatedTime": { "type": "string", "description": "NIC update time\n" }, "vpcId": { "type": "string", "description": "ID of the VPC to which the network interface belongs.\n" }, "vpcName": { "type": "string", "description": "Name of the VPC to which the NIC belongs\n" }, "zoneId": { "type": "string", "description": "ID of the availability zone to which the network interface belongs.\n" } }, "type": "object" } }, "volcenginecc:vpc/flowLog:FlowLog": { "description": "After aggregating log data for inbound and outbound traffic on network interfaces as needed, flow logs are delivered to Log Service for storage and analysis. You can use flow log analysis to monitor network traffic, troubleshoot network issues, and optimize network architecture. VPC flow logs record detailed information about VPC network traffic for network monitoring, traffic analysis, and troubleshooting.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vPCFlowLogDemo = new volcenginecc.vpc.FlowLog(\"VPCFlowLogDemo\", {\n aggregationInterval: 10,\n description: \"this is a test flow log\",\n flowLogName: \"FlowLog-ccapi-test\",\n logProjectName: \"ccapi-test-flow-log\",\n logTopicName: \"test-flow-log\",\n projectName: \"default\",\n resourceId: \"vpc-rrco37ovjq4gv0xxxxxx\",\n resourceType: \"vpc\",\n status: \"Active\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n trafficType: \"All\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_pc_flow_log_demo = volcenginecc.vpc.FlowLog(\"VPCFlowLogDemo\",\n aggregation_interval=10,\n description=\"this is a test flow log\",\n flow_log_name=\"FlowLog-ccapi-test\",\n log_project_name=\"ccapi-test-flow-log\",\n log_topic_name=\"test-flow-log\",\n project_name=\"default\",\n resource_id=\"vpc-rrco37ovjq4gv0xxxxxx\",\n resource_type=\"vpc\",\n status=\"Active\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }],\n traffic_type=\"All\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vPCFlowLogDemo = new Volcenginecc.Vpc.FlowLog(\"VPCFlowLogDemo\", new()\n {\n AggregationInterval = 10,\n Description = \"this is a test flow log\",\n FlowLogName = \"FlowLog-ccapi-test\",\n LogProjectName = \"ccapi-test-flow-log\",\n LogTopicName = \"test-flow-log\",\n ProjectName = \"default\",\n ResourceId = \"vpc-rrco37ovjq4gv0xxxxxx\",\n ResourceType = \"vpc\",\n Status = \"Active\",\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.FlowLogTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n TrafficType = \"All\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewFlowLog(ctx, \"VPCFlowLogDemo\", \u0026vpc.FlowLogArgs{\n\t\t\tAggregationInterval: pulumi.Int(10),\n\t\t\tDescription: pulumi.String(\"this is a test flow log\"),\n\t\t\tFlowLogName: pulumi.String(\"FlowLog-ccapi-test\"),\n\t\t\tLogProjectName: pulumi.String(\"ccapi-test-flow-log\"),\n\t\t\tLogTopicName: pulumi.String(\"test-flow-log\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tResourceId: pulumi.String(\"vpc-rrco37ovjq4gv0xxxxxx\"),\n\t\t\tResourceType: pulumi.String(\"vpc\"),\n\t\t\tStatus: pulumi.String(\"Active\"),\n\t\t\tTags: vpc.FlowLogTagArray{\n\t\t\t\t\u0026vpc.FlowLogTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTrafficType: pulumi.String(\"All\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.FlowLog;\nimport com.volcengine.volcenginecc.vpc.FlowLogArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.FlowLogTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vPCFlowLogDemo = new FlowLog(\"vPCFlowLogDemo\", FlowLogArgs.builder()\n .aggregationInterval(10)\n .description(\"this is a test flow log\")\n .flowLogName(\"FlowLog-ccapi-test\")\n .logProjectName(\"ccapi-test-flow-log\")\n .logTopicName(\"test-flow-log\")\n .projectName(\"default\")\n .resourceId(\"vpc-rrco37ovjq4gv0xxxxxx\")\n .resourceType(\"vpc\")\n .status(\"Active\")\n .tags(FlowLogTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .trafficType(\"All\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vPCFlowLogDemo:\n type: volcenginecc:vpc:FlowLog\n name: VPCFlowLogDemo\n properties:\n aggregationInterval: 10\n description: this is a test flow log\n flowLogName: FlowLog-ccapi-test\n logProjectName: ccapi-test-flow-log\n logTopicName: test-flow-log\n projectName: default\n resourceId: vpc-rrco37ovjq4gv0xxxxxx\n resourceType: vpc\n status: Active\n tags:\n - key: env\n value: test\n trafficType: All\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/flowLog:FlowLog example \"flow_log_id\"\n```\n\n", "properties": { "aggregationInterval": { "type": "integer", "description": "Stream log sampling interval. Options: 1: 1 minute. 5: 5 minutes. 10 (default): 10 minutes.\n" }, "businessStatus": { "type": "string", "description": "Whether the flow log is locked. Normal: normal. FinancialLocked: locked.\n" }, "createdAt": { "type": "string", "description": "Creation time of the flow log.\n" }, "description": { "type": "string", "description": "Description of the stream log. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).\n" }, "enableIndex": { "type": "boolean", "description": "Whether to automatically configure indexes. Indexes are used for retrieving and analyzing data. Stream logs must have indexes configured before retrieval and analysis. true: Yes. false (default): No.\n" }, "flowLogId": { "type": "string", "description": "Stream log ID.\n" }, "flowLogName": { "type": "string", "description": "Name of the flow log. Length must be 1–128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the flow log instance ID.\n" }, "lockReason": { "type": "string", "description": "Reason for stream log lock. financial: Locked due to overdue payment. unlock: In the process of restoring after payment following suspension due to overdue payment. Empty value: Not locked.\n" }, "logProjectId": { "type": "string", "description": "Flow log project ID.\n" }, "logProjectName": { "type": "string", "description": "Name of the flow log project. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number. The name must be 3–63 characters long.\n" }, "logTopicId": { "type": "string", "description": "Flow log topic ID.\n" }, "logTopicName": { "type": "string", "description": "Name of the flow log project. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number. The name must be 3–63 characters long.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the flow log belongs.\n" }, "resourceId": { "type": "string", "description": "Resource ID for traffic capture.\n" }, "resourceType": { "type": "string", "description": "Resource type for traffic collection. Values: vpc: Virtual Private Cloud. subnet: subnet. eni: network interface.\n" }, "status": { "type": "string", "description": "Status of the flow log. Values: Active: active. Pending: pending. Inactive: inactive. Creating: creating. Deleting: deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/FlowLogTag:FlowLogTag" } }, "trafficType": { "type": "string", "description": "Type of traffic collected. Values: All: all traffic. Allow: traffic allowed by network ACLs and security groups. Drop: traffic denied by network ACLs and security groups.\n" }, "updatedAt": { "type": "string", "description": "Time when the stream log was updated.\n" }, "vpcId": { "type": "string", "description": "VPC ID for the flow log.\n" } }, "required": [ "aggregationInterval", "businessStatus", "createdAt", "description", "enableIndex", "flowLogId", "flowLogName", "lockReason", "logProjectId", "logProjectName", "logTopicId", "logTopicName", "projectName", "resourceId", "resourceType", "status", "tags", "trafficType", "updatedAt", "vpcId" ], "inputProperties": { "aggregationInterval": { "type": "integer", "description": "Stream log sampling interval. Options: 1: 1 minute. 5: 5 minutes. 10 (default): 10 minutes.\n" }, "description": { "type": "string", "description": "Description of the stream log. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).\n" }, "flowLogName": { "type": "string", "description": "Name of the flow log. Length must be 1–128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the flow log instance ID.\n" }, "logProjectName": { "type": "string", "description": "Name of the flow log project. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number. The name must be 3–63 characters long.\n" }, "logTopicName": { "type": "string", "description": "Name of the flow log project. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number. The name must be 3–63 characters long.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the flow log belongs.\n" }, "resourceId": { "type": "string", "description": "Resource ID for traffic capture.\n" }, "resourceType": { "type": "string", "description": "Resource type for traffic collection. Values: vpc: Virtual Private Cloud. subnet: subnet. eni: network interface.\n" }, "status": { "type": "string", "description": "Status of the flow log. Values: Active: active. Pending: pending. Inactive: inactive. Creating: creating. Deleting: deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/FlowLogTag:FlowLogTag" } }, "trafficType": { "type": "string", "description": "Type of traffic collected. Values: All: all traffic. Allow: traffic allowed by network ACLs and security groups. Drop: traffic denied by network ACLs and security groups.\n" } }, "requiredInputs": [ "aggregationInterval", "flowLogName", "logProjectName", "logTopicName", "resourceId", "resourceType", "trafficType" ], "stateInputs": { "description": "Input properties used for looking up and filtering FlowLog resources.\n", "properties": { "aggregationInterval": { "type": "integer", "description": "Stream log sampling interval. Options: 1: 1 minute. 5: 5 minutes. 10 (default): 10 minutes.\n" }, "businessStatus": { "type": "string", "description": "Whether the flow log is locked. Normal: normal. FinancialLocked: locked.\n" }, "createdAt": { "type": "string", "description": "Creation time of the flow log.\n" }, "description": { "type": "string", "description": "Description of the stream log. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).\n" }, "enableIndex": { "type": "boolean", "description": "Whether to automatically configure indexes. Indexes are used for retrieving and analyzing data. Stream logs must have indexes configured before retrieval and analysis. true: Yes. false (default): No.\n" }, "flowLogId": { "type": "string", "description": "Stream log ID.\n" }, "flowLogName": { "type": "string", "description": "Name of the flow log. Length must be 1–128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the flow log instance ID.\n" }, "lockReason": { "type": "string", "description": "Reason for stream log lock. financial: Locked due to overdue payment. unlock: In the process of restoring after payment following suspension due to overdue payment. Empty value: Not locked.\n" }, "logProjectId": { "type": "string", "description": "Flow log project ID.\n" }, "logProjectName": { "type": "string", "description": "Name of the flow log project. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number. The name must be 3–63 characters long.\n" }, "logTopicId": { "type": "string", "description": "Flow log topic ID.\n" }, "logTopicName": { "type": "string", "description": "Name of the flow log project. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number. The name must be 3–63 characters long.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the flow log belongs.\n" }, "resourceId": { "type": "string", "description": "Resource ID for traffic capture.\n" }, "resourceType": { "type": "string", "description": "Resource type for traffic collection. Values: vpc: Virtual Private Cloud. subnet: subnet. eni: network interface.\n" }, "status": { "type": "string", "description": "Status of the flow log. Values: Active: active. Pending: pending. Inactive: inactive. Creating: creating. Deleting: deleting.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/FlowLogTag:FlowLogTag" } }, "trafficType": { "type": "string", "description": "Type of traffic collected. Values: All: all traffic. Allow: traffic allowed by network ACLs and security groups. Drop: traffic denied by network ACLs and security groups.\n" }, "updatedAt": { "type": "string", "description": "Time when the stream log was updated.\n" }, "vpcId": { "type": "string", "description": "VPC ID for the flow log.\n" } }, "type": "object" } }, "volcenginecc:vpc/haVip:HaVip": { "description": "A high availability virtual IP (HAVIP) is a private IP resource that can be independently owned, created, or deleted at any time based on business needs. In primary/secondary cluster scenarios, HAVIP is typically used with high availability software (such as Keepalived or Windows Server Failover Cluster) to build high availability primary/secondary services\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vPCHAVIPDemo = new volcenginecc.vpc.HaVip(\"VPCHAVIPDemo\", {\n associatedEipId: \"eip-1a1tzpbhmsphc8nvexxxxx\",\n associatedInstanceIds: [\n \"eni-btw4pmtcabr45h0b2xxxxx\",\n \"eni-iiotcbjp7r4074o8xxxxx\",\n \"eni-3nrjyim6prm68931ebbxxxxx\",\n ],\n associatedInstanceType: \"NetworkInterface\",\n description: \"this is a test\",\n haVipName: \"HaVip-test\",\n ipAddress: \"192.***.0.9\",\n subnetId: \"subnet-rrwqhg3qzxfkv0x57xxxxx\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_pchavip_demo = volcenginecc.vpc.HaVip(\"VPCHAVIPDemo\",\n associated_eip_id=\"eip-1a1tzpbhmsphc8nvexxxxx\",\n associated_instance_ids=[\n \"eni-btw4pmtcabr45h0b2xxxxx\",\n \"eni-iiotcbjp7r4074o8xxxxx\",\n \"eni-3nrjyim6prm68931ebbxxxxx\",\n ],\n associated_instance_type=\"NetworkInterface\",\n description=\"this is a test\",\n ha_vip_name=\"HaVip-test\",\n ip_address=\"192.***.0.9\",\n subnet_id=\"subnet-rrwqhg3qzxfkv0x57xxxxx\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vPCHAVIPDemo = new Volcenginecc.Vpc.HaVip(\"VPCHAVIPDemo\", new()\n {\n AssociatedEipId = \"eip-1a1tzpbhmsphc8nvexxxxx\",\n AssociatedInstanceIds = new[]\n {\n \"eni-btw4pmtcabr45h0b2xxxxx\",\n \"eni-iiotcbjp7r4074o8xxxxx\",\n \"eni-3nrjyim6prm68931ebbxxxxx\",\n },\n AssociatedInstanceType = \"NetworkInterface\",\n Description = \"this is a test\",\n HaVipName = \"HaVip-test\",\n IpAddress = \"192.***.0.9\",\n SubnetId = \"subnet-rrwqhg3qzxfkv0x57xxxxx\",\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.HaVipTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewHaVip(ctx, \"VPCHAVIPDemo\", \u0026vpc.HaVipArgs{\n\t\t\tAssociatedEipId: pulumi.String(\"eip-1a1tzpbhmsphc8nvexxxxx\"),\n\t\t\tAssociatedInstanceIds: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"eni-btw4pmtcabr45h0b2xxxxx\"),\n\t\t\t\tpulumi.String(\"eni-iiotcbjp7r4074o8xxxxx\"),\n\t\t\t\tpulumi.String(\"eni-3nrjyim6prm68931ebbxxxxx\"),\n\t\t\t},\n\t\t\tAssociatedInstanceType: pulumi.String(\"NetworkInterface\"),\n\t\t\tDescription: pulumi.String(\"this is a test\"),\n\t\t\tHaVipName: pulumi.String(\"HaVip-test\"),\n\t\t\tIpAddress: pulumi.String(\"192.***.0.9\"),\n\t\t\tSubnetId: pulumi.String(\"subnet-rrwqhg3qzxfkv0x57xxxxx\"),\n\t\t\tTags: vpc.HaVipTagArray{\n\t\t\t\t\u0026vpc.HaVipTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.HaVip;\nimport com.volcengine.volcenginecc.vpc.HaVipArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.HaVipTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vPCHAVIPDemo = new HaVip(\"vPCHAVIPDemo\", HaVipArgs.builder()\n .associatedEipId(\"eip-1a1tzpbhmsphc8nvexxxxx\")\n .associatedInstanceIds( \n \"eni-btw4pmtcabr45h0b2xxxxx\",\n \"eni-iiotcbjp7r4074o8xxxxx\",\n \"eni-3nrjyim6prm68931ebbxxxxx\")\n .associatedInstanceType(\"NetworkInterface\")\n .description(\"this is a test\")\n .haVipName(\"HaVip-test\")\n .ipAddress(\"192.***.0.9\")\n .subnetId(\"subnet-rrwqhg3qzxfkv0x57xxxxx\")\n .tags(HaVipTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vPCHAVIPDemo:\n type: volcenginecc:vpc:HaVip\n name: VPCHAVIPDemo\n properties:\n associatedEipId: eip-1a1tzpbhmsphc8nvexxxxx\n associatedInstanceIds:\n - eni-btw4pmtcabr45h0b2xxxxx\n - eni-iiotcbjp7r4074o8xxxxx\n - eni-3nrjyim6prm68931ebbxxxxx\n associatedInstanceType: NetworkInterface\n description: this is a test\n haVipName: HaVip-test\n ipAddress: 192.***.0.9\n subnetId: subnet-rrwqhg3qzxfkv0x57xxxxx\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/haVip:HaVip example \"ha_vip_id\"\n```\n\n", "properties": { "associatedEipAddress": { "type": "string", "description": "IP address of the public IP bound to the HAVIP\n" }, "associatedEipId": { "type": "string", "description": "ID of the public IP bound to the HAVIP\n" }, "associatedInstanceIds": { "type": "array", "items": { "type": "string" }, "description": "List of instance IDs bound to the HAVIP\n" }, "associatedInstanceType": { "type": "string", "description": "Instance type bound to the HAVIP. EcsInstance: cloud server instance. NetworkInterface: elastic network interface\n" }, "createdAt": { "type": "string", "description": "Creation time of the HAVIP\n" }, "description": { "type": "string", "description": "Description of the HAVIP. Length limit: 0–255 characters\n" }, "haVipId": { "type": "string", "description": "ID of the HAVIP\n" }, "haVipName": { "type": "string", "description": "Name of the HAVIP. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 0–128 characters\n" }, "ipAddress": { "type": "string", "description": "IP address of the HAVIP\n" }, "masterInstanceId": { "type": "string", "description": "ID of the primary instance bound to the HAVIP\n" }, "projectName": { "type": "string", "description": "Project name of the HAVIP\n" }, "status": { "type": "string", "description": "Status of the HAVIP. Available: available. Creating: creating. InUse: in use. Deleting: deleting\n" }, "subnetId": { "type": "string", "description": "Subnet ID to which the HAVIP belongs\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/HaVipTag:HaVipTag" } }, "updatedAt": { "type": "string", "description": "Last modification time of the HAVIP\n" }, "vpcId": { "type": "string", "description": "VPC ID to which the HAVIP belongs\n" } }, "required": [ "associatedEipAddress", "associatedEipId", "associatedInstanceIds", "associatedInstanceType", "createdAt", "description", "haVipId", "haVipName", "ipAddress", "masterInstanceId", "projectName", "status", "subnetId", "tags", "updatedAt", "vpcId" ], "inputProperties": { "associatedEipId": { "type": "string", "description": "ID of the public IP bound to the HAVIP\n" }, "associatedInstanceIds": { "type": "array", "items": { "type": "string" }, "description": "List of instance IDs bound to the HAVIP\n" }, "associatedInstanceType": { "type": "string", "description": "Instance type bound to the HAVIP. EcsInstance: cloud server instance. NetworkInterface: elastic network interface\n" }, "description": { "type": "string", "description": "Description of the HAVIP. Length limit: 0–255 characters\n" }, "haVipName": { "type": "string", "description": "Name of the HAVIP. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 0–128 characters\n" }, "ipAddress": { "type": "string", "description": "IP address of the HAVIP\n" }, "subnetId": { "type": "string", "description": "Subnet ID to which the HAVIP belongs\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/HaVipTag:HaVipTag" } } }, "requiredInputs": [ "subnetId" ], "stateInputs": { "description": "Input properties used for looking up and filtering HaVip resources.\n", "properties": { "associatedEipAddress": { "type": "string", "description": "IP address of the public IP bound to the HAVIP\n" }, "associatedEipId": { "type": "string", "description": "ID of the public IP bound to the HAVIP\n" }, "associatedInstanceIds": { "type": "array", "items": { "type": "string" }, "description": "List of instance IDs bound to the HAVIP\n" }, "associatedInstanceType": { "type": "string", "description": "Instance type bound to the HAVIP. EcsInstance: cloud server instance. NetworkInterface: elastic network interface\n" }, "createdAt": { "type": "string", "description": "Creation time of the HAVIP\n" }, "description": { "type": "string", "description": "Description of the HAVIP. Length limit: 0–255 characters\n" }, "haVipId": { "type": "string", "description": "ID of the HAVIP\n" }, "haVipName": { "type": "string", "description": "Name of the HAVIP. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 0–128 characters\n" }, "ipAddress": { "type": "string", "description": "IP address of the HAVIP\n" }, "masterInstanceId": { "type": "string", "description": "ID of the primary instance bound to the HAVIP\n" }, "projectName": { "type": "string", "description": "Project name of the HAVIP\n" }, "status": { "type": "string", "description": "Status of the HAVIP. Available: available. Creating: creating. InUse: in use. Deleting: deleting\n" }, "subnetId": { "type": "string", "description": "Subnet ID to which the HAVIP belongs\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/HaVipTag:HaVipTag" } }, "updatedAt": { "type": "string", "description": "Last modification time of the HAVIP\n" }, "vpcId": { "type": "string", "description": "VPC ID to which the HAVIP belongs\n" } }, "type": "object" } }, "volcenginecc:vpc/ipv6AddressBandwidth:Ipv6AddressBandwidth": { "description": "IPv6 public traffic bandwidth determines the public communication capability of the IPv6 address. If the IPv6 address does not have IPv6 public bandwidth enabled, it only supports private network communication. You can enable IPv6 public bandwidth for the IPv6 address as needed to allow public network communication.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vPCIpv6AddressBandwidthDemo = new volcenginecc.vpc.Ipv6AddressBandwidth(\"VPCIpv6AddressBandwidthDemo\", {\n bandwidth: 200,\n billingType: 2,\n ipv6Address: \"2406:d440:10a:****:92b:****:90b6:4f09\",\n projectName: \"default\",\n bandwidthPackageId: \"bwp-1vm41dmikjr451j8exxxxx\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_pc_ipv6_address_bandwidth_demo = volcenginecc.vpc.Ipv6AddressBandwidth(\"VPCIpv6AddressBandwidthDemo\",\n bandwidth=200,\n billing_type=2,\n ipv6_address=\"2406:d440:10a:****:92b:****:90b6:4f09\",\n project_name=\"default\",\n bandwidth_package_id=\"bwp-1vm41dmikjr451j8exxxxx\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vPCIpv6AddressBandwidthDemo = new Volcenginecc.Vpc.Ipv6AddressBandwidth(\"VPCIpv6AddressBandwidthDemo\", new()\n {\n Bandwidth = 200,\n BillingType = 2,\n Ipv6Address = \"2406:d440:10a:****:92b:****:90b6:4f09\",\n ProjectName = \"default\",\n BandwidthPackageId = \"bwp-1vm41dmikjr451j8exxxxx\",\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.Ipv6AddressBandwidthTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewIpv6AddressBandwidth(ctx, \"VPCIpv6AddressBandwidthDemo\", \u0026vpc.Ipv6AddressBandwidthArgs{\n\t\t\tBandwidth: pulumi.Int(200),\n\t\t\tBillingType: pulumi.Int(2),\n\t\t\tIpv6Address: pulumi.String(\"2406:d440:10a:****:92b:****:90b6:4f09\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tBandwidthPackageId: pulumi.String(\"bwp-1vm41dmikjr451j8exxxxx\"),\n\t\t\tTags: vpc.Ipv6AddressBandwidthTagArray{\n\t\t\t\t\u0026vpc.Ipv6AddressBandwidthTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.Ipv6AddressBandwidth;\nimport com.volcengine.volcenginecc.vpc.Ipv6AddressBandwidthArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.Ipv6AddressBandwidthTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vPCIpv6AddressBandwidthDemo = new Ipv6AddressBandwidth(\"vPCIpv6AddressBandwidthDemo\", Ipv6AddressBandwidthArgs.builder()\n .bandwidth(200)\n .billingType(2)\n .ipv6Address(\"2406:d440:10a:****:92b:****:90b6:4f09\")\n .projectName(\"default\")\n .bandwidthPackageId(\"bwp-1vm41dmikjr451j8exxxxx\")\n .tags(Ipv6AddressBandwidthTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vPCIpv6AddressBandwidthDemo:\n type: volcenginecc:vpc:Ipv6AddressBandwidth\n name: VPCIpv6AddressBandwidthDemo\n properties:\n bandwidth: 200\n billingType: 2\n ipv6Address: 2406:d440:10a:****:92b:****:90b6:4f09\n projectName: default\n bandwidthPackageId: bwp-1vm41dmikjr451j8exxxxx\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/ipv6AddressBandwidth:Ipv6AddressBandwidth example \"allocation_id\"\n```\n\n", "properties": { "allocationId": { "type": "string", "description": "IPv6 public bandwidth ID\n" }, "bandwidth": { "type": "integer", "description": "IPv6 public bandwidth cap\n" }, "bandwidthPackageId": { "type": "string", "description": "IPv6 shared bandwidth package ID\n" }, "billingType": { "type": "integer", "description": "IPv6 public bandwidth billing type. 2: Pay-as-you-go - billed by bandwidth cap. 3: Pay-as-you-go - billed by actual traffic.\n" }, "businessStatus": { "type": "string", "description": "Whether IPv6 public bandwidth is locked. Normal: Normal. FinancialLocked: Locked.\n" }, "createdTime": { "type": "string", "description": "IPv6 public bandwidth activation time\n" }, "deletedTime": { "type": "string", "description": "IPv6 public bandwidth deletion time\n" }, "instanceId": { "type": "string", "description": "Instance ID associated with IPv6 public bandwidth\n" }, "instanceType": { "type": "string", "description": "Instance type associated with IPv6 public bandwidth. EcsInstance: Cloud server instance. ClbInstance: Load balancer.\n" }, "ipv6Address": { "type": "string", "description": "IPv6 address\n" }, "ipv6GatewayId": { "type": "string", "description": "IPv6 gateway ID\n" }, "isp": { "type": "string", "description": "IPv6 public bandwidth line type. BGP: BGP (multi-line).\n" }, "lockReason": { "type": "string", "description": "Reason for IPv6 public bandwidth lock. This parameter is returned only when IPv6 public bandwidth is in FinancialLocked status. Financial: Locked due to overdue payment. Security: Locked due to security reasons.\n" }, "networkType": { "type": "string", "description": "IPv6 address communication type. Private: Private network communication type. Public: Public network communication type.\n" }, "overdueTime": { "type": "string", "description": "IPv6 public bandwidth deactivation time due to overdue payment\n" }, "projectName": { "type": "string", "description": "IPv6 public bandwidth project\n" }, "serviceManaged": { "type": "boolean", "description": "Service hosting status\n" }, "status": { "type": "string", "description": "IPv6 public bandwidth status. Creating: Creating. Available: Available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/Ipv6AddressBandwidthTag:Ipv6AddressBandwidthTag" } }, "updatedTime": { "type": "string", "description": "IPv6 public bandwidth last operation time\n" } }, "required": [ "allocationId", "bandwidth", "bandwidthPackageId", "billingType", "businessStatus", "createdTime", "deletedTime", "instanceId", "instanceType", "ipv6Address", "ipv6GatewayId", "isp", "lockReason", "networkType", "overdueTime", "projectName", "serviceManaged", "status", "tags", "updatedTime" ], "inputProperties": { "bandwidth": { "type": "integer", "description": "IPv6 public bandwidth cap\n" }, "bandwidthPackageId": { "type": "string", "description": "IPv6 shared bandwidth package ID\n" }, "billingType": { "type": "integer", "description": "IPv6 public bandwidth billing type. 2: Pay-as-you-go - billed by bandwidth cap. 3: Pay-as-you-go - billed by actual traffic.\n" }, "ipv6Address": { "type": "string", "description": "IPv6 address\n" }, "projectName": { "type": "string", "description": "IPv6 public bandwidth project\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/Ipv6AddressBandwidthTag:Ipv6AddressBandwidthTag" } } }, "requiredInputs": [ "billingType", "ipv6Address" ], "stateInputs": { "description": "Input properties used for looking up and filtering Ipv6AddressBandwidth resources.\n", "properties": { "allocationId": { "type": "string", "description": "IPv6 public bandwidth ID\n" }, "bandwidth": { "type": "integer", "description": "IPv6 public bandwidth cap\n" }, "bandwidthPackageId": { "type": "string", "description": "IPv6 shared bandwidth package ID\n" }, "billingType": { "type": "integer", "description": "IPv6 public bandwidth billing type. 2: Pay-as-you-go - billed by bandwidth cap. 3: Pay-as-you-go - billed by actual traffic.\n" }, "businessStatus": { "type": "string", "description": "Whether IPv6 public bandwidth is locked. Normal: Normal. FinancialLocked: Locked.\n" }, "createdTime": { "type": "string", "description": "IPv6 public bandwidth activation time\n" }, "deletedTime": { "type": "string", "description": "IPv6 public bandwidth deletion time\n" }, "instanceId": { "type": "string", "description": "Instance ID associated with IPv6 public bandwidth\n" }, "instanceType": { "type": "string", "description": "Instance type associated with IPv6 public bandwidth. EcsInstance: Cloud server instance. ClbInstance: Load balancer.\n" }, "ipv6Address": { "type": "string", "description": "IPv6 address\n" }, "ipv6GatewayId": { "type": "string", "description": "IPv6 gateway ID\n" }, "isp": { "type": "string", "description": "IPv6 public bandwidth line type. BGP: BGP (multi-line).\n" }, "lockReason": { "type": "string", "description": "Reason for IPv6 public bandwidth lock. This parameter is returned only when IPv6 public bandwidth is in FinancialLocked status. Financial: Locked due to overdue payment. Security: Locked due to security reasons.\n" }, "networkType": { "type": "string", "description": "IPv6 address communication type. Private: Private network communication type. Public: Public network communication type.\n" }, "overdueTime": { "type": "string", "description": "IPv6 public bandwidth deactivation time due to overdue payment\n" }, "projectName": { "type": "string", "description": "IPv6 public bandwidth project\n" }, "serviceManaged": { "type": "boolean", "description": "Service hosting status\n" }, "status": { "type": "string", "description": "IPv6 public bandwidth status. Creating: Creating. Available: Available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/Ipv6AddressBandwidthTag:Ipv6AddressBandwidthTag" } }, "updatedTime": { "type": "string", "description": "IPv6 public bandwidth last operation time\n" } }, "type": "object" } }, "volcenginecc:vpc/ipv6Gateway:Ipv6Gateway": { "description": "Carrier for the IPv6 gateway service. Creating an IPv6 gateway instance is required for IPv6 public network configuration\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst ipv6GatewayDemo = new volcenginecc.vpc.Ipv6Gateway(\"Ipv6GatewayDemo\", {\n vpcId: \"vpc-3nrh1tqschwcg931exxxxx\",\n name: \"terraform-test-2\",\n description: \"Create by terraform\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nipv6_gateway_demo = volcenginecc.vpc.Ipv6Gateway(\"Ipv6GatewayDemo\",\n vpc_id=\"vpc-3nrh1tqschwcg931exxxxx\",\n name=\"terraform-test-2\",\n description=\"Create by terraform\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var ipv6GatewayDemo = new Volcenginecc.Vpc.Ipv6Gateway(\"Ipv6GatewayDemo\", new()\n {\n VpcId = \"vpc-3nrh1tqschwcg931exxxxx\",\n Name = \"terraform-test-2\",\n Description = \"Create by terraform\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.Ipv6GatewayTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewIpv6Gateway(ctx, \"Ipv6GatewayDemo\", \u0026vpc.Ipv6GatewayArgs{\n\t\t\tVpcId: pulumi.String(\"vpc-3nrh1tqschwcg931exxxxx\"),\n\t\t\tName: pulumi.String(\"terraform-test-2\"),\n\t\t\tDescription: pulumi.String(\"Create by terraform\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: vpc.Ipv6GatewayTagArray{\n\t\t\t\t\u0026vpc.Ipv6GatewayTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.Ipv6Gateway;\nimport com.volcengine.volcenginecc.vpc.Ipv6GatewayArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.Ipv6GatewayTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var ipv6GatewayDemo = new Ipv6Gateway(\"ipv6GatewayDemo\", Ipv6GatewayArgs.builder()\n .vpcId(\"vpc-3nrh1tqschwcg931exxxxx\")\n .name(\"terraform-test-2\")\n .description(\"Create by terraform\")\n .projectName(\"default\")\n .tags(Ipv6GatewayTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n ipv6GatewayDemo:\n type: volcenginecc:vpc:Ipv6Gateway\n name: Ipv6GatewayDemo\n properties:\n vpcId: vpc-3nrh1tqschwcg931exxxxx\n name: terraform-test-2\n description: Create by terraform\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/ipv6Gateway:Ipv6Gateway example \"ipv6_gateway_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the IPv6 gateway instance\n" }, "description": { "type": "string", "description": "Description of the IPv6 gateway instance. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。)\n" }, "ipv6GatewayId": { "type": "string", "description": "IPv6 gateway instance ID\n" }, "name": { "type": "string", "description": "Name of the IPv6 gateway instance. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the IPv6 gateway ID\n" }, "projectName": { "type": "string", "description": "Name of the project to which the IPv6 gateway belongs\n" }, "routeTableId": { "type": "string", "description": "Route table ID associated with the IPv6 gateway instance\n" }, "status": { "type": "string", "description": "Operating status of the IPv6 gateway instance. Possible values: Creating: Creating. Deleting: Deleting. Available: Available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/Ipv6GatewayTag:Ipv6GatewayTag" } }, "updatedTime": { "type": "string", "description": "Modification time of the IPv6 gateway instance\n" }, "vpcId": { "type": "string", "description": "VPC ID to be associated with the IPv6 gateway instance. Each VPC can only be associated with one IPv6 gateway instance. Ensure the VPC to be associated is not linked to another IPv6 gateway instance\n" } }, "required": [ "createdTime", "description", "ipv6GatewayId", "name", "projectName", "routeTableId", "status", "tags", "updatedTime", "vpcId" ], "inputProperties": { "description": { "type": "string", "description": "Description of the IPv6 gateway instance. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。)\n" }, "name": { "type": "string", "description": "Name of the IPv6 gateway instance. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the IPv6 gateway ID\n" }, "projectName": { "type": "string", "description": "Name of the project to which the IPv6 gateway belongs\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/Ipv6GatewayTag:Ipv6GatewayTag" } }, "vpcId": { "type": "string", "description": "VPC ID to be associated with the IPv6 gateway instance. Each VPC can only be associated with one IPv6 gateway instance. Ensure the VPC to be associated is not linked to another IPv6 gateway instance\n" } }, "requiredInputs": [ "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Ipv6Gateway resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the IPv6 gateway instance\n" }, "description": { "type": "string", "description": "Description of the IPv6 gateway instance. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。)\n" }, "ipv6GatewayId": { "type": "string", "description": "IPv6 gateway instance ID\n" }, "name": { "type": "string", "description": "Name of the IPv6 gateway instance. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the IPv6 gateway ID\n" }, "projectName": { "type": "string", "description": "Name of the project to which the IPv6 gateway belongs\n" }, "routeTableId": { "type": "string", "description": "Route table ID associated with the IPv6 gateway instance\n" }, "status": { "type": "string", "description": "Operating status of the IPv6 gateway instance. Possible values: Creating: Creating. Deleting: Deleting. Available: Available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/Ipv6GatewayTag:Ipv6GatewayTag" } }, "updatedTime": { "type": "string", "description": "Modification time of the IPv6 gateway instance\n" }, "vpcId": { "type": "string", "description": "VPC ID to be associated with the IPv6 gateway instance. Each VPC can only be associated with one IPv6 gateway instance. Ensure the VPC to be associated is not linked to another IPv6 gateway instance\n" } }, "type": "object" } }, "volcenginecc:vpc/networkAcl:NetworkAcl": { "description": "The network ACL controls inbound and outbound traffic for subnets. It is designed based on the allowlist principle: traffic entering or leaving a subnet must be permitted by a network ACL rule to pass through.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n networkAclDemo:\n type: volcenginecc:vpc:NetworkAcl\n name: NetworkAclDemo\n properties:\n vpcId: vpc-rrco37ovjq4gv0x58xxxxxx\n networkAclName: NetworkAclDemo\n description: NetworkAclDemo-Description\n projectName: default\n ingressAclEntries:\n - cidr_ip: 10.0.1.0/24\n description: test-rule\n network_acl_entry_name: test-entries\n policy: drop\n port: 80/80\n protocol: tcp\n egressAclEntries:\n - cidr_ip: 0.0.0.0/0\n description: test-rule\n network_acl_entry_name: \"\"\n policy: accept\n port: -1/-1\n protocol: all\n resources:\n - resource_id: subnet-3nrjlvvxo4gsg931ebxxxxxx\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/networkAcl:NetworkAcl example \"network_acl_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the network ACL.\n" }, "defaultEgressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclDefaultEgressAclEntry:NetworkAclDefaultEgressAclEntry" } }, "defaultIngressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclDefaultIngressAclEntry:NetworkAclDefaultIngressAclEntry" } }, "description": { "type": "string", "description": "Network ACL description. Length must be 0–255 characters. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).\n" }, "egressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclEgressAclEntry:NetworkAclEgressAclEntry" } }, "ingressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclIngressAclEntry:NetworkAclIngressAclEntry" } }, "networkAclId": { "type": "string", "description": "Network ACL ID.\n" }, "networkAclName": { "type": "string", "description": "Network ACL name. Length must be 1–128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-).\n" }, "projectName": { "type": "string", "description": "Name of the project associated with the network ACL. If not specified, added to the default project.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclResource:NetworkAclResource" } }, "status": { "type": "string", "description": "Status of the network ACL. Available: Available. Creating: Creating.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclTag:NetworkAclTag" } }, "updatedTime": { "type": "string", "description": "Last updated time of the network ACL.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC associated with the network ACL.\n" } }, "required": [ "createdTime", "defaultEgressAclEntries", "defaultIngressAclEntries", "description", "egressAclEntries", "ingressAclEntries", "networkAclId", "networkAclName", "projectName", "resources", "status", "tags", "updatedTime", "vpcId" ], "inputProperties": { "description": { "type": "string", "description": "Network ACL description. Length must be 0–255 characters. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).\n" }, "egressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclEgressAclEntry:NetworkAclEgressAclEntry" } }, "ingressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclIngressAclEntry:NetworkAclIngressAclEntry" } }, "networkAclName": { "type": "string", "description": "Network ACL name. Length must be 1–128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-).\n" }, "projectName": { "type": "string", "description": "Name of the project associated with the network ACL. If not specified, added to the default project.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclResource:NetworkAclResource" } }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclTag:NetworkAclTag" } }, "vpcId": { "type": "string", "description": "ID of the VPC associated with the network ACL.\n" } }, "requiredInputs": [ "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering NetworkAcl resources.\n", "properties": { "createdTime": { "type": "string", "description": "Creation time of the network ACL.\n" }, "defaultEgressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclDefaultEgressAclEntry:NetworkAclDefaultEgressAclEntry" } }, "defaultIngressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclDefaultIngressAclEntry:NetworkAclDefaultIngressAclEntry" } }, "description": { "type": "string", "description": "Network ACL description. Length must be 0–255 characters. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).\n" }, "egressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclEgressAclEntry:NetworkAclEgressAclEntry" } }, "ingressAclEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclIngressAclEntry:NetworkAclIngressAclEntry" } }, "networkAclId": { "type": "string", "description": "Network ACL ID.\n" }, "networkAclName": { "type": "string", "description": "Network ACL name. Length must be 1–128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-).\n" }, "projectName": { "type": "string", "description": "Name of the project associated with the network ACL. If not specified, added to the default project.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclResource:NetworkAclResource" } }, "status": { "type": "string", "description": "Status of the network ACL. Available: Available. Creating: Creating.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/NetworkAclTag:NetworkAclTag" } }, "updatedTime": { "type": "string", "description": "Last updated time of the network ACL.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC associated with the network ACL.\n" } }, "type": "object" } }, "volcenginecc:vpc/prefixList:PrefixList": { "description": "A prefix list is a collection of CIDR blocks used to simplify the configuration of security group rules and route table entries. When the prefix list is modified, all associated resources are updated synchronously.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst prefixlistDemo = new volcenginecc.vpc.PrefixList(\"PrefixlistDemo\", {\n description: \"PrefixlistDemo Example\",\n ipVersion: \"IPv4\",\n maxEntries: 20,\n prefixListName: \"my-prefix-list\",\n projectName: \"default\",\n prefixListEntries: [{\n cidr: \"192.168.0.0/*\",\n description: \"privite description\",\n }],\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nprefixlist_demo = volcenginecc.vpc.PrefixList(\"PrefixlistDemo\",\n description=\"PrefixlistDemo Example\",\n ip_version=\"IPv4\",\n max_entries=20,\n prefix_list_name=\"my-prefix-list\",\n project_name=\"default\",\n prefix_list_entries=[{\n \"cidr\": \"192.168.0.0/*\",\n \"description\": \"privite description\",\n }],\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var prefixlistDemo = new Volcenginecc.Vpc.PrefixList(\"PrefixlistDemo\", new()\n {\n Description = \"PrefixlistDemo Example\",\n IpVersion = \"IPv4\",\n MaxEntries = 20,\n PrefixListName = \"my-prefix-list\",\n ProjectName = \"default\",\n PrefixListEntries = new[]\n {\n new Volcenginecc.Vpc.Inputs.PrefixListPrefixListEntryArgs\n {\n Cidr = \"192.168.0.0/*\",\n Description = \"privite description\",\n },\n },\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.PrefixListTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewPrefixList(ctx, \"PrefixlistDemo\", \u0026vpc.PrefixListArgs{\n\t\t\tDescription: pulumi.String(\"PrefixlistDemo Example\"),\n\t\t\tIpVersion: pulumi.String(\"IPv4\"),\n\t\t\tMaxEntries: pulumi.Int(20),\n\t\t\tPrefixListName: pulumi.String(\"my-prefix-list\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tPrefixListEntries: vpc.PrefixListPrefixListEntryArray{\n\t\t\t\t\u0026vpc.PrefixListPrefixListEntryArgs{\n\t\t\t\t\tCidr: pulumi.String(\"192.168.0.0/*\"),\n\t\t\t\t\tDescription: pulumi.String(\"privite description\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTags: vpc.PrefixListTagArray{\n\t\t\t\t\u0026vpc.PrefixListTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.PrefixList;\nimport com.volcengine.volcenginecc.vpc.PrefixListArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.PrefixListPrefixListEntryArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.PrefixListTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var prefixlistDemo = new PrefixList(\"prefixlistDemo\", PrefixListArgs.builder()\n .description(\"PrefixlistDemo Example\")\n .ipVersion(\"IPv4\")\n .maxEntries(20)\n .prefixListName(\"my-prefix-list\")\n .projectName(\"default\")\n .prefixListEntries(PrefixListPrefixListEntryArgs.builder()\n .cidr(\"192.168.0.0/*\")\n .description(\"privite description\")\n .build())\n .tags(PrefixListTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n prefixlistDemo:\n type: volcenginecc:vpc:PrefixList\n name: PrefixlistDemo\n properties:\n description: PrefixlistDemo Example\n ipVersion: IPv4\n maxEntries: 20\n prefixListName: my-prefix-list\n projectName: default\n prefixListEntries:\n - cidr: 192.168.0.0/*\n description: privite description\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/prefixList:PrefixList example \"prefix_list_id\"\n```\n\n", "properties": { "associationCount": { "type": "integer", "description": "Number of resources associated with the prefix list.\n" }, "associationsRouteTables": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListAssociationsRouteTable:PrefixListAssociationsRouteTable" } }, "associationsSecurityGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListAssociationsSecurityGroup:PrefixListAssociationsSecurityGroup" } }, "createdTime": { "type": "string", "description": "Creation time of the prefix list.\n" }, "description": { "type": "string", "description": "Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" }, "ipVersion": { "type": "string", "description": "IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.\n" }, "maxEntries": { "type": "integer", "description": "Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.\n" }, "prefixListEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListPrefixListEntry:PrefixListPrefixListEntry" } }, "prefixListId": { "type": "string", "description": "Prefix list ID.\n" }, "prefixListName": { "type": "string", "description": "Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).\n" }, "projectName": { "type": "string", "description": "Name of the project to which the prefix list belongs. If not specified, it is added to the default project.\n" }, "status": { "type": "string", "description": "Status of the prefix list. Values: Available: available; Creating: creating; Deleting: deleting; Pending: modifying.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListTag:PrefixListTag" } }, "updatedTime": { "type": "string", "description": "Last modification time of the prefix list.\n" } }, "required": [ "associationCount", "associationsRouteTables", "associationsSecurityGroups", "createdTime", "description", "ipVersion", "maxEntries", "prefixListEntries", "prefixListId", "prefixListName", "projectName", "status", "tags", "updatedTime" ], "inputProperties": { "description": { "type": "string", "description": "Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" }, "ipVersion": { "type": "string", "description": "IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.\n" }, "maxEntries": { "type": "integer", "description": "Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.\n" }, "prefixListEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListPrefixListEntry:PrefixListPrefixListEntry" } }, "prefixListName": { "type": "string", "description": "Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).\n" }, "projectName": { "type": "string", "description": "Name of the project to which the prefix list belongs. If not specified, it is added to the default project.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListTag:PrefixListTag" } } }, "requiredInputs": [ "maxEntries" ], "stateInputs": { "description": "Input properties used for looking up and filtering PrefixList resources.\n", "properties": { "associationCount": { "type": "integer", "description": "Number of resources associated with the prefix list.\n" }, "associationsRouteTables": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListAssociationsRouteTable:PrefixListAssociationsRouteTable" } }, "associationsSecurityGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListAssociationsSecurityGroup:PrefixListAssociationsSecurityGroup" } }, "createdTime": { "type": "string", "description": "Creation time of the prefix list.\n" }, "description": { "type": "string", "description": "Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n" }, "ipVersion": { "type": "string", "description": "IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.\n" }, "maxEntries": { "type": "integer", "description": "Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.\n" }, "prefixListEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListPrefixListEntry:PrefixListPrefixListEntry" } }, "prefixListId": { "type": "string", "description": "Prefix list ID.\n" }, "prefixListName": { "type": "string", "description": "Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).\n" }, "projectName": { "type": "string", "description": "Name of the project to which the prefix list belongs. If not specified, it is added to the default project.\n" }, "status": { "type": "string", "description": "Status of the prefix list. Values: Available: available; Creating: creating; Deleting: deleting; Pending: modifying.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/PrefixListTag:PrefixListTag" } }, "updatedTime": { "type": "string", "description": "Last modification time of the prefix list.\n" } }, "type": "object" } }, "volcenginecc:vpc/routeTable:RouteTable": { "description": "A route table consists of a series of route entries that specify the next hop cloud resource for private network traffic. Each subnet must be associated with only one route table, allowing resources within the subnet to forward traffic via the route table\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n routeTableDemo:\n type: volcenginecc:vpc:RouteTable\n name: RouteTableDemo\n properties:\n vpcId: vpc-xxxxx\n routeTableName: routeTableDemo\n description: routeTableDemo description\n projectName: default\n subnetIds:\n - subnet-rrxxxxxx\n customRouteEntries:\n - destination_cidr_block: 192.168.x.0/30\n next_hop_type: Instance\n next_hop_id: i-xxxx\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/routeTable:RouteTable example \"route_table_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "Account ID owning the route table\n" }, "associateType": { "type": "string", "description": "Association type for route table creation input. 1. Subnet: Subnet association 2. Gateway: Gateway association\n" }, "createdTime": { "type": "string", "description": "Route Table Creation Time\n" }, "customRouteEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/RouteTableCustomRouteEntry:RouteTableCustomRouteEntry" } }, "description": { "type": "string", "description": "Route Table Description\n" }, "ipv4GatewayId": { "type": "string", "description": "IPv4 Gateway ID associated with the route table\n" }, "ipv6GatewayId": { "type": "string", "description": "IPv6 Gateway ID associated with the route table\n" }, "projectName": { "type": "string", "description": "Name of the project owning the route table\n" }, "routeTableId": { "type": "string", "description": "Route Table ID\n" }, "routeTableName": { "type": "string", "description": "Route Table Name\n" }, "routeTableType": { "type": "string", "description": "Route table type. 1. Custom: Custom route table 2. System: System route table\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of associated subnet IDs\n" }, "systemRouteEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/RouteTableSystemRouteEntry:RouteTableSystemRouteEntry" } }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/RouteTableTag:RouteTableTag" } }, "updatedTime": { "type": "string", "description": "Route Table Last Updated Time\n" }, "vpcId": { "type": "string", "description": "ID of the VPC owning the route table\n" }, "vpcName": { "type": "string", "description": "VPC Name\n" } }, "required": [ "accountId", "associateType", "createdTime", "customRouteEntries", "description", "ipv4GatewayId", "ipv6GatewayId", "projectName", "routeTableId", "routeTableName", "routeTableType", "subnetIds", "systemRouteEntries", "tags", "updatedTime", "vpcId", "vpcName" ], "inputProperties": { "associateType": { "type": "string", "description": "Association type for route table creation input. 1. Subnet: Subnet association 2. Gateway: Gateway association\n" }, "customRouteEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/RouteTableCustomRouteEntry:RouteTableCustomRouteEntry" } }, "description": { "type": "string", "description": "Route Table Description\n" }, "ipv4GatewayId": { "type": "string", "description": "IPv4 Gateway ID associated with the route table\n" }, "ipv6GatewayId": { "type": "string", "description": "IPv6 Gateway ID associated with the route table\n" }, "projectName": { "type": "string", "description": "Name of the project owning the route table\n" }, "routeTableName": { "type": "string", "description": "Route Table Name\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of associated subnet IDs\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/RouteTableTag:RouteTableTag" } }, "vpcId": { "type": "string", "description": "ID of the VPC owning the route table\n" } }, "requiredInputs": [ "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering RouteTable resources.\n", "properties": { "accountId": { "type": "string", "description": "Account ID owning the route table\n" }, "associateType": { "type": "string", "description": "Association type for route table creation input. 1. Subnet: Subnet association 2. Gateway: Gateway association\n" }, "createdTime": { "type": "string", "description": "Route Table Creation Time\n" }, "customRouteEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/RouteTableCustomRouteEntry:RouteTableCustomRouteEntry" } }, "description": { "type": "string", "description": "Route Table Description\n" }, "ipv4GatewayId": { "type": "string", "description": "IPv4 Gateway ID associated with the route table\n" }, "ipv6GatewayId": { "type": "string", "description": "IPv6 Gateway ID associated with the route table\n" }, "projectName": { "type": "string", "description": "Name of the project owning the route table\n" }, "routeTableId": { "type": "string", "description": "Route Table ID\n" }, "routeTableName": { "type": "string", "description": "Route Table Name\n" }, "routeTableType": { "type": "string", "description": "Route table type. 1. Custom: Custom route table 2. System: System route table\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of associated subnet IDs\n" }, "systemRouteEntries": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/RouteTableSystemRouteEntry:RouteTableSystemRouteEntry" } }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/RouteTableTag:RouteTableTag" } }, "updatedTime": { "type": "string", "description": "Route Table Last Updated Time\n" }, "vpcId": { "type": "string", "description": "ID of the VPC owning the route table\n" }, "vpcName": { "type": "string", "description": "VPC Name\n" } }, "type": "object" } }, "volcenginecc:vpc/securityGroup:SecurityGroup": { "description": "A security group is a logical grouping that provides access policies for NICs within the same private network that share security requirements and mutual trust. You can control inbound and outbound traffic for associated NICs by configuring security group rules\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n securityGroupDemo:\n type: volcenginecc:vpc:SecurityGroup\n name: SecurityGroupDemo\n properties:\n vpcId: vpc-xxxx\n securityGroupName: SecurityGroupDemo\n description: SecurityGroupDemo description\n projectName: default\n ingressPermissions:\n - description: test-rule\n policy: drop\n port_end: 1\n port_start: 1\n priority: 11\n protocol: tcp\n cidr_ip: 192.168.xx.0/26\n prefix_list_id: \"\"\n source_group_id: \"\"\n egressPermissions:\n - description: test-rule\n policy: drop\n port_end: -1\n port_start: -1\n priority: 100\n protocol: all\n cidr_ip: 192.168.xx.0/26\n prefix_list_id: list-xxx\n source_group_id: group-xxx\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/securityGroup:SecurityGroup example \"security_group_id\"\n```\n\n", "properties": { "creationTime": { "type": "string", "description": "Security group creation time\n" }, "description": { "type": "string", "description": "Description of the security group. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). If not specified, defaults to an empty string\n" }, "egressPermissions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SecurityGroupEgressPermission:SecurityGroupEgressPermission" } }, "ingressPermissions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SecurityGroupIngressPermission:SecurityGroupIngressPermission" } }, "projectName": { "type": "string", "description": "Project name to which the security group belongs. Default project is 'default' if not specified\n" }, "securityGroupId": { "type": "string", "description": "Security group ID\n" }, "securityGroupName": { "type": "string", "description": "Security group name. Length: 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Default is security group ID if not specified\n" }, "serviceManaged": { "type": "boolean", "description": "Indicates whether the security group is managed. true means managed security group, false means unmanaged security group\n" }, "status": { "type": "string", "description": "Security group status. Available means available for use, Creating means being created\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SecurityGroupTag:SecurityGroupTag" } }, "type": { "type": "string", "description": "Security group type. 1. default: default security group. 2. normal: custom security group. 3. VpnGW: VPN gateway security group. 4. NatGW: NAT gateway security group. 5. cidr_only: CIDR-Only security group\n" }, "vpcId": { "type": "string", "description": "VPC ID to which the security group belongs\n" } }, "required": [ "creationTime", "description", "egressPermissions", "ingressPermissions", "projectName", "securityGroupId", "securityGroupName", "serviceManaged", "status", "tags", "type", "vpcId" ], "inputProperties": { "description": { "type": "string", "description": "Description of the security group. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). If not specified, defaults to an empty string\n" }, "egressPermissions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SecurityGroupEgressPermission:SecurityGroupEgressPermission" } }, "ingressPermissions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SecurityGroupIngressPermission:SecurityGroupIngressPermission" } }, "projectName": { "type": "string", "description": "Project name to which the security group belongs. Default project is 'default' if not specified\n" }, "securityGroupName": { "type": "string", "description": "Security group name. Length: 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Default is security group ID if not specified\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SecurityGroupTag:SecurityGroupTag" } }, "vpcId": { "type": "string", "description": "VPC ID to which the security group belongs\n" } }, "requiredInputs": [ "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering SecurityGroup resources.\n", "properties": { "creationTime": { "type": "string", "description": "Security group creation time\n" }, "description": { "type": "string", "description": "Description of the security group. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). If not specified, defaults to an empty string\n" }, "egressPermissions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SecurityGroupEgressPermission:SecurityGroupEgressPermission" } }, "ingressPermissions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SecurityGroupIngressPermission:SecurityGroupIngressPermission" } }, "projectName": { "type": "string", "description": "Project name to which the security group belongs. Default project is 'default' if not specified\n" }, "securityGroupId": { "type": "string", "description": "Security group ID\n" }, "securityGroupName": { "type": "string", "description": "Security group name. Length: 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Default is security group ID if not specified\n" }, "serviceManaged": { "type": "boolean", "description": "Indicates whether the security group is managed. true means managed security group, false means unmanaged security group\n" }, "status": { "type": "string", "description": "Security group status. Available means available for use, Creating means being created\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SecurityGroupTag:SecurityGroupTag" } }, "type": { "type": "string", "description": "Security group type. 1. default: default security group. 2. normal: custom security group. 3. VpnGW: VPN gateway security group. 4. NatGW: NAT gateway security group. 5. cidr_only: CIDR-Only security group\n" }, "vpcId": { "type": "string", "description": "VPC ID to which the security group belongs\n" } }, "type": "object" } }, "volcenginecc:vpc/subnet:Subnet": { "description": "The subnet is a segment allocated within a specified availability zone from a VPC CIDR block, providing private IP addresses for cloud resources such as cloud servers and load balancers\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst subnetDemo = new volcenginecc.vpc.Subnet(\"SubnetDemo\", {\n vpcId: \"vpc-xxxx\",\n zoneId: \"cn-beijing\",\n subnetName: \"subnetDemo\",\n description: \"subnetDemo description\",\n cidrBlock: \"192.168.xx.0/24\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nsubnet_demo = volcenginecc.vpc.Subnet(\"SubnetDemo\",\n vpc_id=\"vpc-xxxx\",\n zone_id=\"cn-beijing\",\n subnet_name=\"subnetDemo\",\n description=\"subnetDemo description\",\n cidr_block=\"192.168.xx.0/24\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var subnetDemo = new Volcenginecc.Vpc.Subnet(\"SubnetDemo\", new()\n {\n VpcId = \"vpc-xxxx\",\n ZoneId = \"cn-beijing\",\n SubnetName = \"subnetDemo\",\n Description = \"subnetDemo description\",\n CidrBlock = \"192.168.xx.0/24\",\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.SubnetTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewSubnet(ctx, \"SubnetDemo\", \u0026vpc.SubnetArgs{\n\t\t\tVpcId: pulumi.String(\"vpc-xxxx\"),\n\t\t\tZoneId: pulumi.String(\"cn-beijing\"),\n\t\t\tSubnetName: pulumi.String(\"subnetDemo\"),\n\t\t\tDescription: pulumi.String(\"subnetDemo description\"),\n\t\t\tCidrBlock: pulumi.String(\"192.168.xx.0/24\"),\n\t\t\tTags: vpc.SubnetTagArray{\n\t\t\t\t\u0026vpc.SubnetTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.Subnet;\nimport com.volcengine.volcenginecc.vpc.SubnetArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.SubnetTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var subnetDemo = new Subnet(\"subnetDemo\", SubnetArgs.builder()\n .vpcId(\"vpc-xxxx\")\n .zoneId(\"cn-beijing\")\n .subnetName(\"subnetDemo\")\n .description(\"subnetDemo description\")\n .cidrBlock(\"192.168.xx.0/24\")\n .tags(SubnetTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n subnetDemo:\n type: volcenginecc:vpc:Subnet\n name: SubnetDemo\n properties:\n vpcId: vpc-xxxx\n zoneId: cn-beijing\n subnetName: subnetDemo\n description: subnetDemo description\n cidrBlock: 192.168.xx.0/24\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/subnet:Subnet example \"subnet_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the subnet belongs\n" }, "availableIpAddressCount": { "type": "integer", "description": "Number of available IP addresses in the subnet\n" }, "cidrBlock": { "type": "string", "description": "Subnet IPv4 CIDR block\n" }, "createdTime": { "type": "string", "description": "Subnet creation time\n" }, "description": { "type": "string", "description": "Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Cannot start with http:// or https://\n" }, "enableIpv6": { "type": "boolean", "description": "Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses\n" }, "ipv6CidrBlock": { "type": "string", "description": "Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64\n" }, "isDefault": { "type": "boolean", "description": "Whether the subnet is a default subnet. 1. true: Default subnet, created automatically when an ECS instance is created. 2. false: Non-default subnet, created manually by the user\n" }, "networkAclId": { "type": "string", "description": "ID of the network ACL associated with the subnet\n" }, "projectName": { "type": "string", "description": "Name of the project associated with the VPC instance where the subnet resides\n" }, "readIpv6CidrBlock": { "type": "string", "description": "Read-only field, subnet IPv6 CIDR block\n" }, "routeTable": { "$ref": "#/types/volcenginecc:vpc/SubnetRouteTable:SubnetRouteTable", "description": "Route table information\n" }, "status": { "type": "string", "description": "Subnet status. 1. Pending: Configuring. 2. Available: Available\n" }, "subnetId": { "type": "string", "description": "ID of the subnet whose information is to be modified\n" }, "subnetName": { "type": "string", "description": "Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SubnetTag:SubnetTag" } }, "totalIpv4Count": { "type": "integer", "description": "Total number of available IPs in the subnet\n" }, "updatedTime": { "type": "string", "description": "Subnet update time\n" }, "vpcId": { "type": "string", "description": "ID of the VPC to which the subnet belongs\n" }, "zoneId": { "type": "string", "description": "Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones\n" } }, "required": [ "accountId", "availableIpAddressCount", "cidrBlock", "createdTime", "description", "enableIpv6", "ipv6CidrBlock", "isDefault", "networkAclId", "projectName", "readIpv6CidrBlock", "routeTable", "status", "subnetId", "subnetName", "tags", "totalIpv4Count", "updatedTime", "vpcId", "zoneId" ], "inputProperties": { "cidrBlock": { "type": "string", "description": "Subnet IPv4 CIDR block\n" }, "description": { "type": "string", "description": "Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Cannot start with http:// or https://\n" }, "enableIpv6": { "type": "boolean", "description": "Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses\n" }, "ipv6CidrBlock": { "type": "string", "description": "Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64\n" }, "subnetName": { "type": "string", "description": "Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SubnetTag:SubnetTag" } }, "vpcId": { "type": "string", "description": "ID of the VPC to which the subnet belongs\n" }, "zoneId": { "type": "string", "description": "Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones\n" } }, "requiredInputs": [ "cidrBlock", "vpcId", "zoneId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Subnet resources.\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the subnet belongs\n" }, "availableIpAddressCount": { "type": "integer", "description": "Number of available IP addresses in the subnet\n" }, "cidrBlock": { "type": "string", "description": "Subnet IPv4 CIDR block\n" }, "createdTime": { "type": "string", "description": "Subnet creation time\n" }, "description": { "type": "string", "description": "Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Cannot start with http:// or https://\n" }, "enableIpv6": { "type": "boolean", "description": "Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses\n" }, "ipv6CidrBlock": { "type": "string", "description": "Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64\n" }, "isDefault": { "type": "boolean", "description": "Whether the subnet is a default subnet. 1. true: Default subnet, created automatically when an ECS instance is created. 2. false: Non-default subnet, created manually by the user\n" }, "networkAclId": { "type": "string", "description": "ID of the network ACL associated with the subnet\n" }, "projectName": { "type": "string", "description": "Name of the project associated with the VPC instance where the subnet resides\n" }, "readIpv6CidrBlock": { "type": "string", "description": "Read-only field, subnet IPv6 CIDR block\n" }, "routeTable": { "$ref": "#/types/volcenginecc:vpc/SubnetRouteTable:SubnetRouteTable", "description": "Route table information\n" }, "status": { "type": "string", "description": "Subnet status. 1. Pending: Configuring. 2. Available: Available\n" }, "subnetId": { "type": "string", "description": "ID of the subnet whose information is to be modified\n" }, "subnetName": { "type": "string", "description": "Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/SubnetTag:SubnetTag" } }, "totalIpv4Count": { "type": "integer", "description": "Total number of available IPs in the subnet\n" }, "updatedTime": { "type": "string", "description": "Subnet update time\n" }, "vpcId": { "type": "string", "description": "ID of the VPC to which the subnet belongs\n" }, "zoneId": { "type": "string", "description": "Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones\n" } }, "type": "object" } }, "volcenginecc:vpc/trafficMirrorFilter:TrafficMirrorFilter": { "description": "With traffic mirroring, you can mirror network interface traffic based on your filter conditions and forward the mirrored traffic over the private network to a target service for monitoring and analysis\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vPCTrafficMirrorFilterDemo = new volcenginecc.vpc.TrafficMirrorFilter(\"VPCTrafficMirrorFilterDemo\", {\n description: \"ccapi-terraform-test\",\n trafficMirrorFilterName: \"test-vpc-traffic-mirror-filter-demo\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_pc_traffic_mirror_filter_demo = volcenginecc.vpc.TrafficMirrorFilter(\"VPCTrafficMirrorFilterDemo\",\n description=\"ccapi-terraform-test\",\n traffic_mirror_filter_name=\"test-vpc-traffic-mirror-filter-demo\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vPCTrafficMirrorFilterDemo = new Volcenginecc.Vpc.TrafficMirrorFilter(\"VPCTrafficMirrorFilterDemo\", new()\n {\n Description = \"ccapi-terraform-test\",\n TrafficMirrorFilterName = \"test-vpc-traffic-mirror-filter-demo\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.TrafficMirrorFilterTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewTrafficMirrorFilter(ctx, \"VPCTrafficMirrorFilterDemo\", \u0026vpc.TrafficMirrorFilterArgs{\n\t\t\tDescription: pulumi.String(\"ccapi-terraform-test\"),\n\t\t\tTrafficMirrorFilterName: pulumi.String(\"test-vpc-traffic-mirror-filter-demo\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: vpc.TrafficMirrorFilterTagArray{\n\t\t\t\t\u0026vpc.TrafficMirrorFilterTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.TrafficMirrorFilter;\nimport com.volcengine.volcenginecc.vpc.TrafficMirrorFilterArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.TrafficMirrorFilterTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vPCTrafficMirrorFilterDemo = new TrafficMirrorFilter(\"vPCTrafficMirrorFilterDemo\", TrafficMirrorFilterArgs.builder()\n .description(\"ccapi-terraform-test\")\n .trafficMirrorFilterName(\"test-vpc-traffic-mirror-filter-demo\")\n .projectName(\"default\")\n .tags(TrafficMirrorFilterTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vPCTrafficMirrorFilterDemo:\n type: volcenginecc:vpc:TrafficMirrorFilter\n name: VPCTrafficMirrorFilterDemo\n properties:\n description: ccapi-terraform-test\n trafficMirrorFilterName: test-vpc-traffic-mirror-filter-demo\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/trafficMirrorFilter:TrafficMirrorFilter example \"traffic_mirror_filter_id\"\n```\n\n", "properties": { "createdTime": { "type": "string", "description": "Filter condition creation time\n" }, "description": { "type": "string", "description": "Filter condition instance description\n" }, "egressFilterRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorFilterEgressFilterRule:TrafficMirrorFilterEgressFilterRule" } }, "ingressFilterRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorFilterIngressFilterRule:TrafficMirrorFilterIngressFilterRule" } }, "projectName": { "type": "string", "description": "Project name of the filter condition\n" }, "status": { "type": "string", "description": "Filter condition status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorFilterTag:TrafficMirrorFilterTag" } }, "trafficMirrorFilterId": { "type": "string", "description": "Filter condition instance ID\n" }, "trafficMirrorFilterName": { "type": "string", "description": "Filter condition name\n" } }, "required": [ "createdTime", "description", "egressFilterRules", "ingressFilterRules", "projectName", "status", "tags", "trafficMirrorFilterId", "trafficMirrorFilterName" ], "inputProperties": { "description": { "type": "string", "description": "Filter condition instance description\n" }, "projectName": { "type": "string", "description": "Project name of the filter condition\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorFilterTag:TrafficMirrorFilterTag" } }, "trafficMirrorFilterName": { "type": "string", "description": "Filter condition name\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering TrafficMirrorFilter resources.\n", "properties": { "createdTime": { "type": "string", "description": "Filter condition creation time\n" }, "description": { "type": "string", "description": "Filter condition instance description\n" }, "egressFilterRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorFilterEgressFilterRule:TrafficMirrorFilterEgressFilterRule" } }, "ingressFilterRules": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorFilterIngressFilterRule:TrafficMirrorFilterIngressFilterRule" } }, "projectName": { "type": "string", "description": "Project name of the filter condition\n" }, "status": { "type": "string", "description": "Filter condition status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorFilterTag:TrafficMirrorFilterTag" } }, "trafficMirrorFilterId": { "type": "string", "description": "Filter condition instance ID\n" }, "trafficMirrorFilterName": { "type": "string", "description": "Filter condition name\n" } }, "type": "object" } }, "volcenginecc:vpc/trafficMirrorFilterRule:TrafficMirrorFilterRule": { "description": "Filtering conditions are composed of filtering rules, divided into inbound filtering rules and outbound filtering rules.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vPCTrafficMirrorFilterRuleDemo = new volcenginecc.vpc.TrafficMirrorFilterRule(\"VPCTrafficMirrorFilterRuleDemo\", {\n description: \"test\",\n destinationCidrBlock: \"10.*.*.0/24\",\n destinationPortRange: \"80/80\",\n policy: \"accept\",\n priority: 1,\n protocol: \"tcp\",\n sourceCidrBlock: \"10.*.*.0/24\",\n sourcePortRange: \"80/80\",\n trafficDirection: \"ingress\",\n trafficMirrorFilterId: \"tmf-3nqp5bt6a3dog931exxxxx\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_pc_traffic_mirror_filter_rule_demo = volcenginecc.vpc.TrafficMirrorFilterRule(\"VPCTrafficMirrorFilterRuleDemo\",\n description=\"test\",\n destination_cidr_block=\"10.*.*.0/24\",\n destination_port_range=\"80/80\",\n policy=\"accept\",\n priority=1,\n protocol=\"tcp\",\n source_cidr_block=\"10.*.*.0/24\",\n source_port_range=\"80/80\",\n traffic_direction=\"ingress\",\n traffic_mirror_filter_id=\"tmf-3nqp5bt6a3dog931exxxxx\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vPCTrafficMirrorFilterRuleDemo = new Volcenginecc.Vpc.TrafficMirrorFilterRule(\"VPCTrafficMirrorFilterRuleDemo\", new()\n {\n Description = \"test\",\n DestinationCidrBlock = \"10.*.*.0/24\",\n DestinationPortRange = \"80/80\",\n Policy = \"accept\",\n Priority = 1,\n Protocol = \"tcp\",\n SourceCidrBlock = \"10.*.*.0/24\",\n SourcePortRange = \"80/80\",\n TrafficDirection = \"ingress\",\n TrafficMirrorFilterId = \"tmf-3nqp5bt6a3dog931exxxxx\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewTrafficMirrorFilterRule(ctx, \"VPCTrafficMirrorFilterRuleDemo\", \u0026vpc.TrafficMirrorFilterRuleArgs{\n\t\t\tDescription: pulumi.String(\"test\"),\n\t\t\tDestinationCidrBlock: pulumi.String(\"10.*.*.0/24\"),\n\t\t\tDestinationPortRange: pulumi.String(\"80/80\"),\n\t\t\tPolicy: pulumi.String(\"accept\"),\n\t\t\tPriority: pulumi.Int(1),\n\t\t\tProtocol: pulumi.String(\"tcp\"),\n\t\t\tSourceCidrBlock: pulumi.String(\"10.*.*.0/24\"),\n\t\t\tSourcePortRange: pulumi.String(\"80/80\"),\n\t\t\tTrafficDirection: pulumi.String(\"ingress\"),\n\t\t\tTrafficMirrorFilterId: pulumi.String(\"tmf-3nqp5bt6a3dog931exxxxx\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.TrafficMirrorFilterRule;\nimport com.volcengine.volcenginecc.vpc.TrafficMirrorFilterRuleArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vPCTrafficMirrorFilterRuleDemo = new TrafficMirrorFilterRule(\"vPCTrafficMirrorFilterRuleDemo\", TrafficMirrorFilterRuleArgs.builder()\n .description(\"test\")\n .destinationCidrBlock(\"10.*.*.0/24\")\n .destinationPortRange(\"80/80\")\n .policy(\"accept\")\n .priority(1)\n .protocol(\"tcp\")\n .sourceCidrBlock(\"10.*.*.0/24\")\n .sourcePortRange(\"80/80\")\n .trafficDirection(\"ingress\")\n .trafficMirrorFilterId(\"tmf-3nqp5bt6a3dog931exxxxx\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vPCTrafficMirrorFilterRuleDemo:\n type: volcenginecc:vpc:TrafficMirrorFilterRule\n name: VPCTrafficMirrorFilterRuleDemo\n properties:\n description: test\n destinationCidrBlock: 10.*.*.0/24\n destinationPortRange: 80/80\n policy: accept\n priority: 1\n protocol: tcp\n sourceCidrBlock: 10.*.*.0/24\n sourcePortRange: 80/80\n trafficDirection: ingress\n trafficMirrorFilterId: tmf-3nqp5bt6a3dog931exxxxx\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/trafficMirrorFilterRule:TrafficMirrorFilterRule example \"traffic_mirror_filter_id|traffic_mirror_filter_rule_id\"\n```\n\n", "properties": { "description": { "type": "string", "description": "Description of the filtering rule.\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination network segment.\n" }, "destinationPortRange": { "type": "string", "description": "Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.\n" }, "policy": { "type": "string", "description": "Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.\n" }, "priority": { "type": "integer", "description": "Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.\n" }, "protocol": { "type": "string", "description": "Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.\n" }, "sourceCidrBlock": { "type": "string", "description": "Source network segment.\n" }, "sourcePortRange": { "type": "string", "description": "Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.\n" }, "status": { "type": "string", "description": "Status of the filtering rule. Available: available. Deleting: deleting. Creating: creating. Pending: modifying.\n" }, "trafficDirection": { "type": "string", "description": "Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.\n" }, "trafficMirrorFilterId": { "type": "string", "description": "Filtering condition ID.\n" }, "trafficMirrorFilterRuleId": { "type": "string", "description": "Filtering rule ID.\n" } }, "required": [ "description", "destinationCidrBlock", "destinationPortRange", "policy", "priority", "protocol", "sourceCidrBlock", "sourcePortRange", "status", "trafficDirection", "trafficMirrorFilterId", "trafficMirrorFilterRuleId" ], "inputProperties": { "description": { "type": "string", "description": "Description of the filtering rule.\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination network segment.\n" }, "destinationPortRange": { "type": "string", "description": "Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.\n" }, "policy": { "type": "string", "description": "Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.\n" }, "priority": { "type": "integer", "description": "Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.\n" }, "protocol": { "type": "string", "description": "Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.\n" }, "sourceCidrBlock": { "type": "string", "description": "Source network segment.\n" }, "sourcePortRange": { "type": "string", "description": "Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.\n" }, "trafficDirection": { "type": "string", "description": "Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.\n" }, "trafficMirrorFilterId": { "type": "string", "description": "Filtering condition ID.\n" } }, "requiredInputs": [ "destinationCidrBlock", "policy", "protocol", "sourceCidrBlock", "trafficDirection", "trafficMirrorFilterId" ], "stateInputs": { "description": "Input properties used for looking up and filtering TrafficMirrorFilterRule resources.\n", "properties": { "description": { "type": "string", "description": "Description of the filtering rule.\n" }, "destinationCidrBlock": { "type": "string", "description": "Destination network segment.\n" }, "destinationPortRange": { "type": "string", "description": "Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.\n" }, "policy": { "type": "string", "description": "Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.\n" }, "priority": { "type": "integer", "description": "Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.\n" }, "protocol": { "type": "string", "description": "Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.\n" }, "sourceCidrBlock": { "type": "string", "description": "Source network segment.\n" }, "sourcePortRange": { "type": "string", "description": "Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.\n" }, "status": { "type": "string", "description": "Status of the filtering rule. Available: available. Deleting: deleting. Creating: creating. Pending: modifying.\n" }, "trafficDirection": { "type": "string", "description": "Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.\n" }, "trafficMirrorFilterId": { "type": "string", "description": "Filtering condition ID.\n" }, "trafficMirrorFilterRuleId": { "type": "string", "description": "Filtering rule ID.\n" } }, "type": "object" } }, "volcenginecc:vpc/trafficMirrorSession:TrafficMirrorSession": { "description": "The mirror session links the mirror source, mirror destination, and filter conditions, enabling private network forwarding of traffic copied from the mirror source to the mirror destination. It serves as the carrier for traffic mirroring\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vPCTrafficMirrorSessionDemo = new volcenginecc.vpc.TrafficMirrorSession(\"VPCTrafficMirrorSessionDemo\", {\n description: \"test-description\",\n networkInterfaceId: \"eni-1a1s0wz7xkm4g8nvexxxxx\",\n packetLength: 64,\n priority: 12,\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n trafficMirrorFilterId: \"tmf-bu54sj0bl2bk5h0xxxxx\",\n trafficMirrorSessionName: \"test-1\",\n trafficMirrorTargetId: \"tmt-ij32u0acvta874o8ctxxxxx\",\n virtualNetworkId: 13,\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_pc_traffic_mirror_session_demo = volcenginecc.vpc.TrafficMirrorSession(\"VPCTrafficMirrorSessionDemo\",\n description=\"test-description\",\n network_interface_id=\"eni-1a1s0wz7xkm4g8nvexxxxx\",\n packet_length=64,\n priority=12,\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }],\n traffic_mirror_filter_id=\"tmf-bu54sj0bl2bk5h0xxxxx\",\n traffic_mirror_session_name=\"test-1\",\n traffic_mirror_target_id=\"tmt-ij32u0acvta874o8ctxxxxx\",\n virtual_network_id=13)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vPCTrafficMirrorSessionDemo = new Volcenginecc.Vpc.TrafficMirrorSession(\"VPCTrafficMirrorSessionDemo\", new()\n {\n Description = \"test-description\",\n NetworkInterfaceId = \"eni-1a1s0wz7xkm4g8nvexxxxx\",\n PacketLength = 64,\n Priority = 12,\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.TrafficMirrorSessionTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n TrafficMirrorFilterId = \"tmf-bu54sj0bl2bk5h0xxxxx\",\n TrafficMirrorSessionName = \"test-1\",\n TrafficMirrorTargetId = \"tmt-ij32u0acvta874o8ctxxxxx\",\n VirtualNetworkId = 13,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewTrafficMirrorSession(ctx, \"VPCTrafficMirrorSessionDemo\", \u0026vpc.TrafficMirrorSessionArgs{\n\t\t\tDescription: pulumi.String(\"test-description\"),\n\t\t\tNetworkInterfaceId: pulumi.String(\"eni-1a1s0wz7xkm4g8nvexxxxx\"),\n\t\t\tPacketLength: pulumi.Int(64),\n\t\t\tPriority: pulumi.Int(12),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: vpc.TrafficMirrorSessionTagArray{\n\t\t\t\t\u0026vpc.TrafficMirrorSessionTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTrafficMirrorFilterId: pulumi.String(\"tmf-bu54sj0bl2bk5h0xxxxx\"),\n\t\t\tTrafficMirrorSessionName: pulumi.String(\"test-1\"),\n\t\t\tTrafficMirrorTargetId: pulumi.String(\"tmt-ij32u0acvta874o8ctxxxxx\"),\n\t\t\tVirtualNetworkId: pulumi.Int(13),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.TrafficMirrorSession;\nimport com.volcengine.volcenginecc.vpc.TrafficMirrorSessionArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.TrafficMirrorSessionTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vPCTrafficMirrorSessionDemo = new TrafficMirrorSession(\"vPCTrafficMirrorSessionDemo\", TrafficMirrorSessionArgs.builder()\n .description(\"test-description\")\n .networkInterfaceId(\"eni-1a1s0wz7xkm4g8nvexxxxx\")\n .packetLength(64)\n .priority(12)\n .projectName(\"default\")\n .tags(TrafficMirrorSessionTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .trafficMirrorFilterId(\"tmf-bu54sj0bl2bk5h0xxxxx\")\n .trafficMirrorSessionName(\"test-1\")\n .trafficMirrorTargetId(\"tmt-ij32u0acvta874o8ctxxxxx\")\n .virtualNetworkId(13)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vPCTrafficMirrorSessionDemo:\n type: volcenginecc:vpc:TrafficMirrorSession\n name: VPCTrafficMirrorSessionDemo\n properties:\n description: test-description\n networkInterfaceId: eni-1a1s0wz7xkm4g8nvexxxxx\n packetLength: 64\n priority: 12\n projectName: default\n tags:\n - key: env\n value: test\n trafficMirrorFilterId: tmf-bu54sj0bl2bk5h0xxxxx\n trafficMirrorSessionName: test-1\n trafficMirrorTargetId: tmt-ij32u0acvta874o8ctxxxxx\n virtualNetworkId: 13\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/trafficMirrorSession:TrafficMirrorSession example \"traffic_mirror_session_id\"\n```\n\n", "properties": { "businessStatus": { "type": "string", "description": "Session billing status. Normal: Billing in progress. - FinancialLocked: Locked due to overdue payment\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "description": { "type": "string", "description": "Mirror session instance description\n" }, "lockReason": { "type": "string", "description": "Lock reason\n" }, "networkInterfaceId": { "type": "string", "description": "Mirror source instance ID. Currently, only ECS primary and secondary network interfaces are supported\n" }, "packetLength": { "type": "integer", "description": "Mirror session MTU. Values exceeding this will be truncated. Range: 64–9600\n" }, "priority": { "type": "integer", "description": "Mirror session priority. Range: 1–32766. Priority values must be unique within the same account\n" }, "projectName": { "type": "string", "description": "Name of the associated project\n" }, "status": { "type": "string", "description": "Session status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorSessionTag:TrafficMirrorSessionTag" } }, "trafficMirrorFilterId": { "type": "string", "description": "Filter condition instance ID\n" }, "trafficMirrorSessionId": { "type": "string", "description": "Mirror session instance ID\n" }, "trafficMirrorSessionName": { "type": "string", "description": "Mirror session name\n" }, "trafficMirrorSourceIds": { "type": "array", "items": { "type": "string" }, "description": "Mirror source instance list\n" }, "trafficMirrorTargetId": { "type": "string", "description": "Mirror destination instance ID\n" }, "virtualNetworkId": { "type": "integer", "description": "Mirror session VNI. Range: 1–16777215\n" } }, "required": [ "businessStatus", "createdTime", "description", "lockReason", "networkInterfaceId", "packetLength", "priority", "projectName", "status", "tags", "trafficMirrorFilterId", "trafficMirrorSessionId", "trafficMirrorSessionName", "trafficMirrorSourceIds", "trafficMirrorTargetId", "virtualNetworkId" ], "inputProperties": { "description": { "type": "string", "description": "Mirror session instance description\n" }, "networkInterfaceId": { "type": "string", "description": "Mirror source instance ID. Currently, only ECS primary and secondary network interfaces are supported\n" }, "packetLength": { "type": "integer", "description": "Mirror session MTU. Values exceeding this will be truncated. Range: 64–9600\n" }, "priority": { "type": "integer", "description": "Mirror session priority. Range: 1–32766. Priority values must be unique within the same account\n" }, "projectName": { "type": "string", "description": "Name of the associated project\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorSessionTag:TrafficMirrorSessionTag" } }, "trafficMirrorFilterId": { "type": "string", "description": "Filter condition instance ID\n" }, "trafficMirrorSessionName": { "type": "string", "description": "Mirror session name\n" }, "trafficMirrorTargetId": { "type": "string", "description": "Mirror destination instance ID\n" }, "virtualNetworkId": { "type": "integer", "description": "Mirror session VNI. Range: 1–16777215\n" } }, "requiredInputs": [ "networkInterfaceId", "priority", "trafficMirrorFilterId", "trafficMirrorTargetId" ], "stateInputs": { "description": "Input properties used for looking up and filtering TrafficMirrorSession resources.\n", "properties": { "businessStatus": { "type": "string", "description": "Session billing status. Normal: Billing in progress. - FinancialLocked: Locked due to overdue payment\n" }, "createdTime": { "type": "string", "description": "Creation time\n" }, "description": { "type": "string", "description": "Mirror session instance description\n" }, "lockReason": { "type": "string", "description": "Lock reason\n" }, "networkInterfaceId": { "type": "string", "description": "Mirror source instance ID. Currently, only ECS primary and secondary network interfaces are supported\n" }, "packetLength": { "type": "integer", "description": "Mirror session MTU. Values exceeding this will be truncated. Range: 64–9600\n" }, "priority": { "type": "integer", "description": "Mirror session priority. Range: 1–32766. Priority values must be unique within the same account\n" }, "projectName": { "type": "string", "description": "Name of the associated project\n" }, "status": { "type": "string", "description": "Session status\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorSessionTag:TrafficMirrorSessionTag" } }, "trafficMirrorFilterId": { "type": "string", "description": "Filter condition instance ID\n" }, "trafficMirrorSessionId": { "type": "string", "description": "Mirror session instance ID\n" }, "trafficMirrorSessionName": { "type": "string", "description": "Mirror session name\n" }, "trafficMirrorSourceIds": { "type": "array", "items": { "type": "string" }, "description": "Mirror source instance list\n" }, "trafficMirrorTargetId": { "type": "string", "description": "Mirror destination instance ID\n" }, "virtualNetworkId": { "type": "integer", "description": "Mirror session VNI. Range: 1–16777215\n" } }, "type": "object" } }, "volcenginecc:vpc/trafficMirrorTarget:TrafficMirrorTarget": { "description": "The mirror target is the network interface or classic load balancer used to collect traffic. You can use traffic mirroring to replicate network interface traffic based on your filtering criteria and forward the replicated traffic over the private network to the target service for monitoring and analysis.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vPCTrafficMirrorTargetDemo = new volcenginecc.vpc.TrafficMirrorTarget(\"VPCTrafficMirrorTargetDemo\", {\n trafficMirrorTargetName: \"test-terraformtest\",\n description: \"this is a test\",\n instanceId: \"eni-2yggxh4o692bk6asvxxxxx\",\n instanceType: \"NetworkInterface\",\n projectName: \"default\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_pc_traffic_mirror_target_demo = volcenginecc.vpc.TrafficMirrorTarget(\"VPCTrafficMirrorTargetDemo\",\n traffic_mirror_target_name=\"test-terraformtest\",\n description=\"this is a test\",\n instance_id=\"eni-2yggxh4o692bk6asvxxxxx\",\n instance_type=\"NetworkInterface\",\n project_name=\"default\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vPCTrafficMirrorTargetDemo = new Volcenginecc.Vpc.TrafficMirrorTarget(\"VPCTrafficMirrorTargetDemo\", new()\n {\n TrafficMirrorTargetName = \"test-terraformtest\",\n Description = \"this is a test\",\n InstanceId = \"eni-2yggxh4o692bk6asvxxxxx\",\n InstanceType = \"NetworkInterface\",\n ProjectName = \"default\",\n Tags = new[]\n {\n new Volcenginecc.Vpc.Inputs.TrafficMirrorTargetTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpc.NewTrafficMirrorTarget(ctx, \"VPCTrafficMirrorTargetDemo\", \u0026vpc.TrafficMirrorTargetArgs{\n\t\t\tTrafficMirrorTargetName: pulumi.String(\"test-terraformtest\"),\n\t\t\tDescription: pulumi.String(\"this is a test\"),\n\t\t\tInstanceId: pulumi.String(\"eni-2yggxh4o692bk6asvxxxxx\"),\n\t\t\tInstanceType: pulumi.String(\"NetworkInterface\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tTags: vpc.TrafficMirrorTargetTagArray{\n\t\t\t\t\u0026vpc.TrafficMirrorTargetTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpc.TrafficMirrorTarget;\nimport com.volcengine.volcenginecc.vpc.TrafficMirrorTargetArgs;\nimport com.pulumi.volcenginecc.vpc.inputs.TrafficMirrorTargetTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vPCTrafficMirrorTargetDemo = new TrafficMirrorTarget(\"vPCTrafficMirrorTargetDemo\", TrafficMirrorTargetArgs.builder()\n .trafficMirrorTargetName(\"test-terraformtest\")\n .description(\"this is a test\")\n .instanceId(\"eni-2yggxh4o692bk6asvxxxxx\")\n .instanceType(\"NetworkInterface\")\n .projectName(\"default\")\n .tags(TrafficMirrorTargetTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vPCTrafficMirrorTargetDemo:\n type: volcenginecc:vpc:TrafficMirrorTarget\n name: VPCTrafficMirrorTargetDemo\n properties:\n trafficMirrorTargetName: test-terraformtest\n description: this is a test\n instanceId: eni-2yggxh4o692bk6asvxxxxx\n instanceType: NetworkInterface\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/trafficMirrorTarget:TrafficMirrorTarget example \"traffic_mirror_target_id\"\n```\n\n", "properties": { "createdAt": { "type": "string", "description": "Creation time of the mirror session.\n" }, "description": { "type": "string", "description": "Listener description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, the default value is an empty string.\n" }, "instanceId": { "type": "string", "description": "Resource ID of the mirror target.\n" }, "instanceType": { "type": "string", "description": "Resource type of the mirror target. NetworkInterface: Elastic network interface. ClbInstance: Classic load balancer.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the mirror target belongs. If not specified, it will be added to the default project.\n" }, "status": { "type": "string", "description": "Status of the mirror target. Available: Available. Creating: Creating.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorTargetTag:TrafficMirrorTargetTag" } }, "trafficMirrorTargetId": { "type": "string", "description": "ID of the mirror target.\n" }, "trafficMirrorTargetName": { "type": "string", "description": "Listener name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, the default is 'protocol-port' as the listener name.\n" }, "updatedAt": { "type": "string", "description": "Update time of the mirror session.\n" } }, "required": [ "createdAt", "description", "instanceId", "instanceType", "projectName", "status", "tags", "trafficMirrorTargetId", "trafficMirrorTargetName", "updatedAt" ], "inputProperties": { "description": { "type": "string", "description": "Listener description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, the default value is an empty string.\n" }, "instanceId": { "type": "string", "description": "Resource ID of the mirror target.\n" }, "instanceType": { "type": "string", "description": "Resource type of the mirror target. NetworkInterface: Elastic network interface. ClbInstance: Classic load balancer.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the mirror target belongs. If not specified, it will be added to the default project.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorTargetTag:TrafficMirrorTargetTag" } }, "trafficMirrorTargetName": { "type": "string", "description": "Listener name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, the default is 'protocol-port' as the listener name.\n" } }, "requiredInputs": [ "instanceId", "instanceType" ], "stateInputs": { "description": "Input properties used for looking up and filtering TrafficMirrorTarget resources.\n", "properties": { "createdAt": { "type": "string", "description": "Creation time of the mirror session.\n" }, "description": { "type": "string", "description": "Listener description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, the default value is an empty string.\n" }, "instanceId": { "type": "string", "description": "Resource ID of the mirror target.\n" }, "instanceType": { "type": "string", "description": "Resource type of the mirror target. NetworkInterface: Elastic network interface. ClbInstance: Classic load balancer.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the mirror target belongs. If not specified, it will be added to the default project.\n" }, "status": { "type": "string", "description": "Status of the mirror target. Available: Available. Creating: Creating.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/TrafficMirrorTargetTag:TrafficMirrorTargetTag" } }, "trafficMirrorTargetId": { "type": "string", "description": "ID of the mirror target.\n" }, "trafficMirrorTargetName": { "type": "string", "description": "Listener name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, the default is 'protocol-port' as the listener name.\n" }, "updatedAt": { "type": "string", "description": "Update time of the mirror session.\n" } }, "type": "object" } }, "volcenginecc:vpc/vpc:Vpc": { "description": "A private network creates an isolated, self-configurable virtual network environment for cloud resources. You can customize IP address ranges, security groups, routing policies, and other network features within the private network to manage cloud resources simply, efficiently, and securely.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vPCDemo:\n type: volcenginecc:vpc:Vpc\n name: VPCDemo\n properties:\n cidrBlock: 192.168.0.0/24\n supportIpv4Gateway: true\n vpcName: vpc-demo\n description: VpcDemo Example\n enableIpv6: false\n dnsServers:\n - 12.3.x.x\n associateCens:\n - cen_id: cen-3re8cx4vwdibk5zsk2xxxx\n cen_owner_id: 200000xxx\n cen_status: Attaching\n natGatewayIds:\n - ngw-2d6tp1y8zq41s58ozfdxxx\n routeTableIds:\n - vtb-29mkf8ft83l6o1e1hgixxx\n securityGroupIds:\n - sg-29mkx39jb80741e1hgj2bxxx\n projectName: default\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpc/vpc:Vpc example \"vpc_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the VPC belongs.\n" }, "associateCens": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/VpcAssociateCen:VpcAssociateCen" } }, "cidrBlock": { "type": "string", "description": "IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.\n" }, "creationTime": { "type": "string", "description": "Time when the VPC was created.\n" }, "description": { "type": "string", "description": "Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.\n" }, "dnsServers": { "type": "array", "items": { "type": "string" }, "description": "DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use \u0026 to separate multiple IPs. If not specified, defaults to the system DNS server addresses.\n" }, "enableIpv6": { "type": "boolean", "description": "Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.\n" }, "ipv4GatewayId": { "type": "string", "description": "ID of the IPv4 gateway bound to the VPC.\n" }, "ipv6CidrBlock": { "type": "string", "description": "IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.\n" }, "isDefault": { "type": "boolean", "description": "Whether this VPC is the default VPC. true: default VPC, meaning the VPC was automatically created by the system when creating an ECS instance. false: non-default VPC, meaning the VPC was manually created by the user.\n" }, "natGatewayIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the NAT gateway created in the VPC.\n" }, "networkAclNum": { "type": "string", "description": "Number of network ACLs in the VPC.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the VPC belongs. If not specified, it is added to the default project.\n" }, "routeTableIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the route table associated with the VPC.\n" }, "secondaryCidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "Secondary CIDR block of the VPC.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security groups in the VPC.\n" }, "status": { "type": "string", "description": "Status of the VPC. Creating: being created. Created: created. Available: available.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnets in the VPC.\n" }, "supportIpv4Gateway": { "type": "boolean", "description": "Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/VpcTag:VpcTag" } }, "updateTime": { "type": "string", "description": "Time when the VPC was updated.\n" }, "userCidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "User CIDR block of the VPC.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC.\n" }, "vpcName": { "type": "string", "description": "Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.\n" } }, "required": [ "accountId", "associateCens", "cidrBlock", "creationTime", "description", "dnsServers", "enableIpv6", "ipv4GatewayId", "ipv6CidrBlock", "isDefault", "natGatewayIds", "networkAclNum", "projectName", "routeTableIds", "secondaryCidrBlocks", "securityGroupIds", "status", "subnetIds", "supportIpv4Gateway", "tags", "updateTime", "userCidrBlocks", "vpcId", "vpcName" ], "inputProperties": { "cidrBlock": { "type": "string", "description": "IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.\n" }, "description": { "type": "string", "description": "Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.\n" }, "dnsServers": { "type": "array", "items": { "type": "string" }, "description": "DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use \u0026 to separate multiple IPs. If not specified, defaults to the system DNS server addresses.\n" }, "enableIpv6": { "type": "boolean", "description": "Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.\n" }, "ipv4GatewayId": { "type": "string", "description": "ID of the IPv4 gateway bound to the VPC.\n" }, "ipv6CidrBlock": { "type": "string", "description": "IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.\n" }, "natGatewayIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the NAT gateway created in the VPC.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the VPC belongs. If not specified, it is added to the default project.\n" }, "secondaryCidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "Secondary CIDR block of the VPC.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnets in the VPC.\n" }, "supportIpv4Gateway": { "type": "boolean", "description": "Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/VpcTag:VpcTag" } }, "vpcName": { "type": "string", "description": "Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Vpc resources.\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the VPC belongs.\n" }, "associateCens": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/VpcAssociateCen:VpcAssociateCen" } }, "cidrBlock": { "type": "string", "description": "IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.\n" }, "creationTime": { "type": "string", "description": "Time when the VPC was created.\n" }, "description": { "type": "string", "description": "Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.\n" }, "dnsServers": { "type": "array", "items": { "type": "string" }, "description": "DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use \u0026 to separate multiple IPs. If not specified, defaults to the system DNS server addresses.\n" }, "enableIpv6": { "type": "boolean", "description": "Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.\n" }, "ipv4GatewayId": { "type": "string", "description": "ID of the IPv4 gateway bound to the VPC.\n" }, "ipv6CidrBlock": { "type": "string", "description": "IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.\n" }, "isDefault": { "type": "boolean", "description": "Whether this VPC is the default VPC. true: default VPC, meaning the VPC was automatically created by the system when creating an ECS instance. false: non-default VPC, meaning the VPC was manually created by the user.\n" }, "natGatewayIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the NAT gateway created in the VPC.\n" }, "networkAclNum": { "type": "string", "description": "Number of network ACLs in the VPC.\n" }, "projectName": { "type": "string", "description": "Name of the project to which the VPC belongs. If not specified, it is added to the default project.\n" }, "routeTableIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the route table associated with the VPC.\n" }, "secondaryCidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "Secondary CIDR block of the VPC.\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of security groups in the VPC.\n" }, "status": { "type": "string", "description": "Status of the VPC. Creating: being created. Created: created. Available: available.\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "List of subnets in the VPC.\n" }, "supportIpv4Gateway": { "type": "boolean", "description": "Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpc/VpcTag:VpcTag" } }, "updateTime": { "type": "string", "description": "Time when the VPC was updated.\n" }, "userCidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "User CIDR block of the VPC.\n" }, "vpcId": { "type": "string", "description": "ID of the VPC.\n" }, "vpcName": { "type": "string", "description": "Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.\n" } }, "type": "object" } }, "volcenginecc:vpn/customerGateway:CustomerGateway": { "description": "The user gateway is a collection and abstraction of information on your local gateway side. With the user gateway, you can register local gateway information to the cloud VPC. One user gateway can connect to multiple VPN gateways\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vpncustomergatewayDemo = new volcenginecc.vpn.CustomerGateway(\"vpncustomergatewayDemo\", {\n asn: 64513,\n customerGatewayName: \"ccapi-test\",\n description: \"testdesc\",\n ipAddress: \"115.***.151.5\",\n ipVersion: \"ipv4\",\n projectName: \"default\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nvpncustomergateway_demo = volcenginecc.vpn.CustomerGateway(\"vpncustomergatewayDemo\",\n asn=64513,\n customer_gateway_name=\"ccapi-test\",\n description=\"testdesc\",\n ip_address=\"115.***.151.5\",\n ip_version=\"ipv4\",\n project_name=\"default\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vpncustomergatewayDemo = new Volcenginecc.Vpn.CustomerGateway(\"vpncustomergatewayDemo\", new()\n {\n Asn = 64513,\n CustomerGatewayName = \"ccapi-test\",\n Description = \"testdesc\",\n IpAddress = \"115.***.151.5\",\n IpVersion = \"ipv4\",\n ProjectName = \"default\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpn\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpn.NewCustomerGateway(ctx, \"vpncustomergatewayDemo\", \u0026vpn.CustomerGatewayArgs{\n\t\t\tAsn: pulumi.Int(64513),\n\t\t\tCustomerGatewayName: pulumi.String(\"ccapi-test\"),\n\t\t\tDescription: pulumi.String(\"testdesc\"),\n\t\t\tIpAddress: pulumi.String(\"115.***.151.5\"),\n\t\t\tIpVersion: pulumi.String(\"ipv4\"),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpn.CustomerGateway;\nimport com.volcengine.volcenginecc.vpn.CustomerGatewayArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vpncustomergatewayDemo = new CustomerGateway(\"vpncustomergatewayDemo\", CustomerGatewayArgs.builder()\n .asn(64513)\n .customerGatewayName(\"ccapi-test\")\n .description(\"testdesc\")\n .ipAddress(\"115.***.151.5\")\n .ipVersion(\"ipv4\")\n .projectName(\"default\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vpncustomergatewayDemo:\n type: volcenginecc:vpn:CustomerGateway\n properties:\n asn: 64513\n customerGatewayName: ccapi-test\n description: testdesc\n ipAddress: 115.***.151.5\n ipVersion: ipv4\n projectName: default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpn/customerGateway:CustomerGateway example \"customer_gateway_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the user gateway belongs\n" }, "asn": { "type": "integer", "description": "User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)\n" }, "connectionCount": { "type": "integer", "description": "Number of IPsec connections associated with the user gateway\n" }, "createdTime": { "type": "string", "description": "Time when the user gateway was created\n" }, "customerGatewayId": { "type": "string", "description": "Gateway ID\n" }, "customerGatewayName": { "type": "string", "description": "User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID\n" }, "description": { "type": "string", "description": "Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string\n" }, "ipAddress": { "type": "string", "description": "Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here\n" }, "ipVersion": { "type": "string", "description": "IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6\n" }, "projectName": { "type": "string", "description": "Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project\n" }, "status": { "type": "string", "description": "Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/CustomerGatewayTag:CustomerGatewayTag" } }, "updatedTime": { "type": "string", "description": "Time when the user gateway was updated\n" } }, "required": [ "accountId", "asn", "connectionCount", "createdTime", "customerGatewayId", "customerGatewayName", "description", "ipAddress", "ipVersion", "projectName", "status", "tags", "updatedTime" ], "inputProperties": { "asn": { "type": "integer", "description": "User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)\n" }, "customerGatewayName": { "type": "string", "description": "User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID\n" }, "description": { "type": "string", "description": "Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string\n" }, "ipAddress": { "type": "string", "description": "Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here\n" }, "ipVersion": { "type": "string", "description": "IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6\n" }, "projectName": { "type": "string", "description": "Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/CustomerGatewayTag:CustomerGatewayTag" } } }, "requiredInputs": [ "ipAddress" ], "stateInputs": { "description": "Input properties used for looking up and filtering CustomerGateway resources.\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the user gateway belongs\n" }, "asn": { "type": "integer", "description": "User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)\n" }, "connectionCount": { "type": "integer", "description": "Number of IPsec connections associated with the user gateway\n" }, "createdTime": { "type": "string", "description": "Time when the user gateway was created\n" }, "customerGatewayId": { "type": "string", "description": "Gateway ID\n" }, "customerGatewayName": { "type": "string", "description": "User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID\n" }, "description": { "type": "string", "description": "Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string\n" }, "ipAddress": { "type": "string", "description": "Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here\n" }, "ipVersion": { "type": "string", "description": "IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6\n" }, "projectName": { "type": "string", "description": "Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project\n" }, "status": { "type": "string", "description": "Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/CustomerGatewayTag:CustomerGatewayTag" } }, "updatedTime": { "type": "string", "description": "Time when the user gateway was updated\n" } }, "type": "object" } }, "volcenginecc:vpn/sslVpnClientCert:SslVpnClientCert": { "description": "SSL client certificate is a sub-resource of the SSL server.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vPNSslVpnClientCertDemo = new volcenginecc.vpn.SslVpnClientCert(\"VPNSslVpnClientCertDemo\", {\n sslVpnServerId: \"vss-xxxx\",\n sslVpnClientCertName: \"ccapi-test-client-cert\",\n description: \"ccapi-test\",\n tags: [{\n key: \"env\",\n value: \"test\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nv_pnssl_vpn_client_cert_demo = volcenginecc.vpn.SslVpnClientCert(\"VPNSslVpnClientCertDemo\",\n ssl_vpn_server_id=\"vss-xxxx\",\n ssl_vpn_client_cert_name=\"ccapi-test-client-cert\",\n description=\"ccapi-test\",\n tags=[{\n \"key\": \"env\",\n \"value\": \"test\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vPNSslVpnClientCertDemo = new Volcenginecc.Vpn.SslVpnClientCert(\"VPNSslVpnClientCertDemo\", new()\n {\n SslVpnServerId = \"vss-xxxx\",\n SslVpnClientCertName = \"ccapi-test-client-cert\",\n Description = \"ccapi-test\",\n Tags = new[]\n {\n new Volcenginecc.Vpn.Inputs.SslVpnClientCertTagArgs\n {\n Key = \"env\",\n Value = \"test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpn\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpn.NewSslVpnClientCert(ctx, \"VPNSslVpnClientCertDemo\", \u0026vpn.SslVpnClientCertArgs{\n\t\t\tSslVpnServerId: pulumi.String(\"vss-xxxx\"),\n\t\t\tSslVpnClientCertName: pulumi.String(\"ccapi-test-client-cert\"),\n\t\t\tDescription: pulumi.String(\"ccapi-test\"),\n\t\t\tTags: vpn.SslVpnClientCertTagArray{\n\t\t\t\t\u0026vpn.SslVpnClientCertTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"env\"),\n\t\t\t\t\tValue: pulumi.String(\"test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpn.SslVpnClientCert;\nimport com.volcengine.volcenginecc.vpn.SslVpnClientCertArgs;\nimport com.pulumi.volcenginecc.vpn.inputs.SslVpnClientCertTagArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vPNSslVpnClientCertDemo = new SslVpnClientCert(\"vPNSslVpnClientCertDemo\", SslVpnClientCertArgs.builder()\n .sslVpnServerId(\"vss-xxxx\")\n .sslVpnClientCertName(\"ccapi-test-client-cert\")\n .description(\"ccapi-test\")\n .tags(SslVpnClientCertTagArgs.builder()\n .key(\"env\")\n .value(\"test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vPNSslVpnClientCertDemo:\n type: volcenginecc:vpn:SslVpnClientCert\n name: VPNSslVpnClientCertDemo\n properties:\n sslVpnServerId: vss-xxxx\n sslVpnClientCertName: ccapi-test-client-cert\n description: ccapi-test\n tags:\n - key: env\n value: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpn/sslVpnClientCert:SslVpnClientCert example \"ssl_vpn_client_cert_id\"\n```\n\n", "properties": { "caCertificate": { "type": "string", "description": "CA certificate information.\n" }, "certificateStatus": { "type": "string", "description": "SSL client certificate status. Available: available; Expiring: expiring, displays this status when the expiration time is less than or equal to one week; Expired: expired.\n" }, "clientCertificate": { "type": "string", "description": "Client certificate information.\n" }, "clientKey": { "type": "string", "description": "Client key information.\n" }, "creationTime": { "type": "string", "description": "Creation time of the SSL client certificate.\n" }, "description": { "type": "string", "description": "Description of the SSL client certificate. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0–255 characters. If not specified, defaults to an empty string.\n" }, "expiredTime": { "type": "string", "description": "Expiration time of the SSL client certificate.\n" }, "openVpnClientConfig": { "type": "string", "description": "OpenVPN client configuration.\n" }, "sslVpnClientCertId": { "type": "string", "description": "SSL client certificate ID.\n" }, "sslVpnClientCertName": { "type": "string", "description": "Name of the SSL client certificate. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1–128 characters. If not specified, defaults to the SSL client certificate ID.\n" }, "sslVpnServerId": { "type": "string", "description": "ID of the SSL server used to create the SSL client certificate. You can call DescribeSslVpnServers to query the SSL server ID information.\n" }, "status": { "type": "string", "description": "SSL client status. Creating: being created; Deleting: being deleted; Pending: being configured; Available: available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/SslVpnClientCertTag:SslVpnClientCertTag" } }, "updateTime": { "type": "string", "description": "Modification time of the SSL client certificate.\n" } }, "required": [ "caCertificate", "certificateStatus", "clientCertificate", "clientKey", "creationTime", "description", "expiredTime", "openVpnClientConfig", "sslVpnClientCertId", "sslVpnClientCertName", "sslVpnServerId", "status", "tags", "updateTime" ], "inputProperties": { "description": { "type": "string", "description": "Description of the SSL client certificate. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0–255 characters. If not specified, defaults to an empty string.\n" }, "sslVpnClientCertName": { "type": "string", "description": "Name of the SSL client certificate. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1–128 characters. If not specified, defaults to the SSL client certificate ID.\n" }, "sslVpnServerId": { "type": "string", "description": "ID of the SSL server used to create the SSL client certificate. You can call DescribeSslVpnServers to query the SSL server ID information.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/SslVpnClientCertTag:SslVpnClientCertTag" } } }, "requiredInputs": [ "sslVpnServerId" ], "stateInputs": { "description": "Input properties used for looking up and filtering SslVpnClientCert resources.\n", "properties": { "caCertificate": { "type": "string", "description": "CA certificate information.\n" }, "certificateStatus": { "type": "string", "description": "SSL client certificate status. Available: available; Expiring: expiring, displays this status when the expiration time is less than or equal to one week; Expired: expired.\n" }, "clientCertificate": { "type": "string", "description": "Client certificate information.\n" }, "clientKey": { "type": "string", "description": "Client key information.\n" }, "creationTime": { "type": "string", "description": "Creation time of the SSL client certificate.\n" }, "description": { "type": "string", "description": "Description of the SSL client certificate. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0–255 characters. If not specified, defaults to an empty string.\n" }, "expiredTime": { "type": "string", "description": "Expiration time of the SSL client certificate.\n" }, "openVpnClientConfig": { "type": "string", "description": "OpenVPN client configuration.\n" }, "sslVpnClientCertId": { "type": "string", "description": "SSL client certificate ID.\n" }, "sslVpnClientCertName": { "type": "string", "description": "Name of the SSL client certificate. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1–128 characters. If not specified, defaults to the SSL client certificate ID.\n" }, "sslVpnServerId": { "type": "string", "description": "ID of the SSL server used to create the SSL client certificate. You can call DescribeSslVpnServers to query the SSL server ID information.\n" }, "status": { "type": "string", "description": "SSL client status. Creating: being created; Deleting: being deleted; Pending: being configured; Available: available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/SslVpnClientCertTag:SslVpnClientCertTag" } }, "updateTime": { "type": "string", "description": "Modification time of the SSL client certificate.\n" } }, "type": "object" } }, "volcenginecc:vpn/vpnConnection:VpnConnection": { "description": "The IPsec connection is based on the Internet and establishes an IPsec VPN communication tunnel between the VPN gateway and the user gateway. Data is encrypted using the IKE and IPsec protocols to ensure secure transmission through the tunnel.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n vpnVpnConnectionDemo:\n type: volcenginecc:vpn:VpnConnection\n name: VpnVpnConnectionDemo\n properties:\n vpnConnectionName: terraform-test\n description: IPsec-test\n vpnGatewayId: vgw-3nqn2s36hu1a89xxxxxxx\n projectName: default\n logEnabled: true\n localSubnets:\n - 0.0.0.0/2\n remoteSubnets:\n - 0.0.0.0/2\n customerGatewayId: cgw-vzzoltnuu41s865ykxxxxxx\n negotiateInstantly: false\n ikeConfig:\n psk: '88888888'\n version: ikev1\n mode: aggressive\n auth_alg: sha1\n enc_alg: aes\n dh_group: group2\n lifetime: 86400\n local_id: 0.0.0.0\n remote_id: 0.0.0.0\n ipsecConfig:\n auth_alg: sha1\n dh_group: group2\n enc_alg: aes\n lifetime: 86400\n bgpInfo:\n enable_bgp: true\n tunnel_cidr: 169.xxx.30.40/30\n local_bgp_ip: 169.xxx.30.41\n attachType: VpnGateway\n natTraversal: true\n dpdAction: restart\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpn/vpnConnection:VpnConnection example \"vpn_connection_id\"\n```\n\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the IPsec connection belongs.\n" }, "attachStatus": { "type": "string", "description": "IPsec connection status, VpnGateway: Attached: Bound; TransitRouter: Attached: Bound; Attaching: Binding; Detached: Unbound; Detaching: Unbinding.\n" }, "attachType": { "type": "string", "description": "Type of gateway associated with the IPsec connection. VpnGateway: VPN gateway; TransitRouter: transit router.\n" }, "bgpInfo": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionBgpInfo:VpnConnectionBgpInfo", "description": "BGP information for the IPsec connection.\n" }, "businessStatus": { "type": "string", "description": "Billing status of the IPsec connection. This parameter is returned only when AttachType is 'TransitRouter'. Normal: Normal. FinancialLocked: Financially locked.\n" }, "connectStatus": { "type": "string", "description": "Status of the tunnel connection. ike*sa*negotiation*failed: Phase 1 negotiation failed. ike*sa*negotiation*completed: Phase 1 negotiation succeeded. ipsec*sa*negotiation*failed: Phase 2 negotiation failed. ipsec*sa*negotiation*completed: Phase 2 negotiation succeeded.\n" }, "creationTime": { "type": "string", "description": "Time when the IPsec connection was created.\n" }, "customerGatewayId": { "type": "string", "description": "ID of the customer gateway associated with the IPsec connection. This parameter is required when creating a single-tunnel IPsec connection. If the customer gateway IP address is 0.0.0.0, NegotiateInstantly can only be set to false, IkeConfig.Version can only be set to ikev1, and IkeConfig.Mode can only be set to aggressive in IkeConfig.\n" }, "deletedTime": { "type": "string", "description": "Expected resource forced reclamation time. This parameter is returned only when AttachType is 'TransitRouter', and only when the resource is frozen due to overdue payment. Otherwise, the value is empty.\n" }, "description": { "type": "string", "description": "Description of the IPsec connection. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "dpdAction": { "type": "string", "description": "Status of the DPD feature. none: DPD feature disabled. clear (default): DPD feature enabled; IKE SA is cleared after DPD timeout. hold: DPD feature enabled; current state is maintained after DPD timeout; the connection is re-established when new traffic is detected. restart: DPD feature enabled; reconnect immediately after DPD timeout.\n" }, "dualTunnelEnabled": { "type": "boolean", "description": "Enable dual tunnel feature. true: Enabled. false: Not enabled.\n" }, "enableTunnelsBgp": { "type": "boolean", "description": "Whether to enable BGP. Valid values: false (default): No, use static routing mode. true: Yes, use BGP routing mode.\n" }, "healthCheckers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionHealthChecker:VpnConnectionHealthChecker" } }, "ikeConfig": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionIkeConfig:VpnConnectionIkeConfig", "description": "IKE configuration information for the IPsec connection\n" }, "ipAddress": { "type": "string", "description": "Public IP address of the transit router. This parameter is returned only when AttachType is 'TransitRouter'.\n" }, "ipsecConfig": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionIpsecConfig:VpnConnectionIpsecConfig", "description": "IPsec configuration information for the IPsec connection.\n" }, "isBlocked": { "type": "boolean", "description": "Whether the current resource is blocked. true: Blocked; false: Not blocked\n" }, "localSubnets": { "type": "array", "items": { "type": "string" }, "description": "Local network segment of the IPsec connection.\n" }, "logEnabled": { "type": "boolean", "description": "Enable connection logs. After connection logs are enabled, you can view and download IPsec connection logs and troubleshoot IPsec connection issues using the log information. true: Enabled. false: Not enabled.\n" }, "natTraversal": { "type": "boolean", "description": "Enable NAT traversal. true: Enabled. When NAT traversal is enabled, IKE negotiation does not verify UDP port numbers and can detect NAT gateway devices in the VPN connection tunnel. false (default): Not enabled.\n" }, "negotiateInstantly": { "type": "boolean", "description": "Whether to initiate negotiation mode immediately. true: The system actively initiates negotiation after the IPsec connection is configured. false (default): The system does not actively initiate negotiation after configuration; negotiation is initiated passively when traffic passes through.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter is returned only when AttachType is 'TransitRouter', and only when the resource is frozen due to overdue payment. Otherwise, this parameter is empty.\n" }, "projectName": { "type": "string", "description": "Project to which the IPsec connection belongs.\n" }, "remoteSubnets": { "type": "array", "items": { "type": "string" }, "description": "Peer CIDR block of the IPsec connection\n" }, "spec": { "type": "string", "description": "IPsec connection instance specification. Only effective for IPsec associated with TR instances; ineffective for IPsec associated with VPN gateway instances. This parameter takes effect only when AttachType is set to TransitRouter. default (default): Default specification, bandwidth limit is 200 Mbps. large: Large specification, bandwidth limit is 1 Gbps. xlarge: Extra large specification, bandwidth limit is 3 Gbps.\n" }, "status": { "type": "string", "description": "Status of the IPsec connection. Creating: Creating. Deleting: Deleting. Pending: Configuring. Available: Available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionTag:VpnConnectionTag" } }, "transitRouterId": { "type": "string", "description": "The ID of the transit router. This parameter is returned only when AttachType is 'TransitRouter'.\n" }, "tunnelOptions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionTunnelOption:VpnConnectionTunnelOption" } }, "updateTime": { "type": "string", "description": "The time when the IPsec connection was updated.\n" }, "vpnConnectionId": { "type": "string", "description": "ID of the IPsec connection\n" }, "vpnConnectionName": { "type": "string", "description": "Name of the IPsec connection. Must start with a Chinese character, English letter, or number, and can only contain Chinese characters, English letters, numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the IPsec connection ID.\n" }, "vpnGatewayId": { "type": "string", "description": "The ID of the VPN gateway associated with the IPsec connection. If AttachType is not specified or set to VpnGateway, this parameter must be provided. If AttachType is set to TransitRouter, this parameter is not required.\n" }, "zoneId": { "type": "string", "description": "Availability zone of the transit router attachment point. This parameter is returned only when AttachType is 'TransitRouter'.\n" } }, "required": [ "accountId", "attachStatus", "attachType", "bgpInfo", "businessStatus", "connectStatus", "creationTime", "customerGatewayId", "deletedTime", "description", "dpdAction", "dualTunnelEnabled", "enableTunnelsBgp", "healthCheckers", "ikeConfig", "ipAddress", "ipsecConfig", "isBlocked", "localSubnets", "logEnabled", "natTraversal", "negotiateInstantly", "overdueTime", "projectName", "remoteSubnets", "spec", "status", "tags", "transitRouterId", "tunnelOptions", "updateTime", "vpnConnectionId", "vpnConnectionName", "vpnGatewayId", "zoneId" ], "inputProperties": { "attachType": { "type": "string", "description": "Type of gateway associated with the IPsec connection. VpnGateway: VPN gateway; TransitRouter: transit router.\n" }, "bgpInfo": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionBgpInfo:VpnConnectionBgpInfo", "description": "BGP information for the IPsec connection.\n" }, "customerGatewayId": { "type": "string", "description": "ID of the customer gateway associated with the IPsec connection. This parameter is required when creating a single-tunnel IPsec connection. If the customer gateway IP address is 0.0.0.0, NegotiateInstantly can only be set to false, IkeConfig.Version can only be set to ikev1, and IkeConfig.Mode can only be set to aggressive in IkeConfig.\n" }, "description": { "type": "string", "description": "Description of the IPsec connection. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "dpdAction": { "type": "string", "description": "Status of the DPD feature. none: DPD feature disabled. clear (default): DPD feature enabled; IKE SA is cleared after DPD timeout. hold: DPD feature enabled; current state is maintained after DPD timeout; the connection is re-established when new traffic is detected. restart: DPD feature enabled; reconnect immediately after DPD timeout.\n" }, "enableTunnelsBgp": { "type": "boolean", "description": "Whether to enable BGP. Valid values: false (default): No, use static routing mode. true: Yes, use BGP routing mode.\n" }, "healthCheckers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionHealthChecker:VpnConnectionHealthChecker" } }, "ikeConfig": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionIkeConfig:VpnConnectionIkeConfig", "description": "IKE configuration information for the IPsec connection\n" }, "ipsecConfig": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionIpsecConfig:VpnConnectionIpsecConfig", "description": "IPsec configuration information for the IPsec connection.\n" }, "localSubnets": { "type": "array", "items": { "type": "string" }, "description": "Local network segment of the IPsec connection.\n" }, "logEnabled": { "type": "boolean", "description": "Enable connection logs. After connection logs are enabled, you can view and download IPsec connection logs and troubleshoot IPsec connection issues using the log information. true: Enabled. false: Not enabled.\n" }, "natTraversal": { "type": "boolean", "description": "Enable NAT traversal. true: Enabled. When NAT traversal is enabled, IKE negotiation does not verify UDP port numbers and can detect NAT gateway devices in the VPN connection tunnel. false (default): Not enabled.\n" }, "negotiateInstantly": { "type": "boolean", "description": "Whether to initiate negotiation mode immediately. true: The system actively initiates negotiation after the IPsec connection is configured. false (default): The system does not actively initiate negotiation after configuration; negotiation is initiated passively when traffic passes through.\n" }, "projectName": { "type": "string", "description": "Project to which the IPsec connection belongs.\n" }, "remoteSubnets": { "type": "array", "items": { "type": "string" }, "description": "Peer CIDR block of the IPsec connection\n" }, "spec": { "type": "string", "description": "IPsec connection instance specification. Only effective for IPsec associated with TR instances; ineffective for IPsec associated with VPN gateway instances. This parameter takes effect only when AttachType is set to TransitRouter. default (default): Default specification, bandwidth limit is 200 Mbps. large: Large specification, bandwidth limit is 1 Gbps. xlarge: Extra large specification, bandwidth limit is 3 Gbps.\n" }, "tunnelOptions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionTunnelOption:VpnConnectionTunnelOption" } }, "vpnConnectionName": { "type": "string", "description": "Name of the IPsec connection. Must start with a Chinese character, English letter, or number, and can only contain Chinese characters, English letters, numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the IPsec connection ID.\n" }, "vpnGatewayId": { "type": "string", "description": "The ID of the VPN gateway associated with the IPsec connection. If AttachType is not specified or set to VpnGateway, this parameter must be provided. If AttachType is set to TransitRouter, this parameter is not required.\n" } }, "requiredInputs": [ "localSubnets", "remoteSubnets" ], "stateInputs": { "description": "Input properties used for looking up and filtering VpnConnection resources.\n", "properties": { "accountId": { "type": "string", "description": "ID of the account to which the IPsec connection belongs.\n" }, "attachStatus": { "type": "string", "description": "IPsec connection status, VpnGateway: Attached: Bound; TransitRouter: Attached: Bound; Attaching: Binding; Detached: Unbound; Detaching: Unbinding.\n" }, "attachType": { "type": "string", "description": "Type of gateway associated with the IPsec connection. VpnGateway: VPN gateway; TransitRouter: transit router.\n" }, "bgpInfo": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionBgpInfo:VpnConnectionBgpInfo", "description": "BGP information for the IPsec connection.\n" }, "businessStatus": { "type": "string", "description": "Billing status of the IPsec connection. This parameter is returned only when AttachType is 'TransitRouter'. Normal: Normal. FinancialLocked: Financially locked.\n" }, "connectStatus": { "type": "string", "description": "Status of the tunnel connection. ike*sa*negotiation*failed: Phase 1 negotiation failed. ike*sa*negotiation*completed: Phase 1 negotiation succeeded. ipsec*sa*negotiation*failed: Phase 2 negotiation failed. ipsec*sa*negotiation*completed: Phase 2 negotiation succeeded.\n" }, "creationTime": { "type": "string", "description": "Time when the IPsec connection was created.\n" }, "customerGatewayId": { "type": "string", "description": "ID of the customer gateway associated with the IPsec connection. This parameter is required when creating a single-tunnel IPsec connection. If the customer gateway IP address is 0.0.0.0, NegotiateInstantly can only be set to false, IkeConfig.Version can only be set to ikev1, and IkeConfig.Mode can only be set to aggressive in IkeConfig.\n" }, "deletedTime": { "type": "string", "description": "Expected resource forced reclamation time. This parameter is returned only when AttachType is 'TransitRouter', and only when the resource is frozen due to overdue payment. Otherwise, the value is empty.\n" }, "description": { "type": "string", "description": "Description of the IPsec connection. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n" }, "dpdAction": { "type": "string", "description": "Status of the DPD feature. none: DPD feature disabled. clear (default): DPD feature enabled; IKE SA is cleared after DPD timeout. hold: DPD feature enabled; current state is maintained after DPD timeout; the connection is re-established when new traffic is detected. restart: DPD feature enabled; reconnect immediately after DPD timeout.\n" }, "dualTunnelEnabled": { "type": "boolean", "description": "Enable dual tunnel feature. true: Enabled. false: Not enabled.\n" }, "enableTunnelsBgp": { "type": "boolean", "description": "Whether to enable BGP. Valid values: false (default): No, use static routing mode. true: Yes, use BGP routing mode.\n" }, "healthCheckers": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionHealthChecker:VpnConnectionHealthChecker" } }, "ikeConfig": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionIkeConfig:VpnConnectionIkeConfig", "description": "IKE configuration information for the IPsec connection\n" }, "ipAddress": { "type": "string", "description": "Public IP address of the transit router. This parameter is returned only when AttachType is 'TransitRouter'.\n" }, "ipsecConfig": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionIpsecConfig:VpnConnectionIpsecConfig", "description": "IPsec configuration information for the IPsec connection.\n" }, "isBlocked": { "type": "boolean", "description": "Whether the current resource is blocked. true: Blocked; false: Not blocked\n" }, "localSubnets": { "type": "array", "items": { "type": "string" }, "description": "Local network segment of the IPsec connection.\n" }, "logEnabled": { "type": "boolean", "description": "Enable connection logs. After connection logs are enabled, you can view and download IPsec connection logs and troubleshoot IPsec connection issues using the log information. true: Enabled. false: Not enabled.\n" }, "natTraversal": { "type": "boolean", "description": "Enable NAT traversal. true: Enabled. When NAT traversal is enabled, IKE negotiation does not verify UDP port numbers and can detect NAT gateway devices in the VPN connection tunnel. false (default): Not enabled.\n" }, "negotiateInstantly": { "type": "boolean", "description": "Whether to initiate negotiation mode immediately. true: The system actively initiates negotiation after the IPsec connection is configured. false (default): The system does not actively initiate negotiation after configuration; negotiation is initiated passively when traffic passes through.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter is returned only when AttachType is 'TransitRouter', and only when the resource is frozen due to overdue payment. Otherwise, this parameter is empty.\n" }, "projectName": { "type": "string", "description": "Project to which the IPsec connection belongs.\n" }, "remoteSubnets": { "type": "array", "items": { "type": "string" }, "description": "Peer CIDR block of the IPsec connection\n" }, "spec": { "type": "string", "description": "IPsec connection instance specification. Only effective for IPsec associated with TR instances; ineffective for IPsec associated with VPN gateway instances. This parameter takes effect only when AttachType is set to TransitRouter. default (default): Default specification, bandwidth limit is 200 Mbps. large: Large specification, bandwidth limit is 1 Gbps. xlarge: Extra large specification, bandwidth limit is 3 Gbps.\n" }, "status": { "type": "string", "description": "Status of the IPsec connection. Creating: Creating. Deleting: Deleting. Pending: Configuring. Available: Available.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionTag:VpnConnectionTag" } }, "transitRouterId": { "type": "string", "description": "The ID of the transit router. This parameter is returned only when AttachType is 'TransitRouter'.\n" }, "tunnelOptions": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnConnectionTunnelOption:VpnConnectionTunnelOption" } }, "updateTime": { "type": "string", "description": "The time when the IPsec connection was updated.\n" }, "vpnConnectionId": { "type": "string", "description": "ID of the IPsec connection\n" }, "vpnConnectionName": { "type": "string", "description": "Name of the IPsec connection. Must start with a Chinese character, English letter, or number, and can only contain Chinese characters, English letters, numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the IPsec connection ID.\n" }, "vpnGatewayId": { "type": "string", "description": "The ID of the VPN gateway associated with the IPsec connection. If AttachType is not specified or set to VpnGateway, this parameter must be provided. If AttachType is set to TransitRouter, this parameter is not required.\n" }, "zoneId": { "type": "string", "description": "Availability zone of the transit router attachment point. This parameter is returned only when AttachType is 'TransitRouter'.\n" } }, "type": "object" } }, "volcenginecc:vpn/vpnGateway:VpnGateway": { "description": "To enable communication between your private network and a local data center or another private network via a VPN connection, you must first create a VPN gateway.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as volcenginecc from \"@volcengine/pulumi-volcenginecc\";\n\nconst vpnVpnGatewayDemo = new volcenginecc.vpn.VpnGateway(\"VpnVpnGatewayDemo\", {\n bandwidth: 5,\n billingType: 2,\n description: \"this is a test description\",\n dualTunnelEnabled: false,\n ipStackType: \"ipv4_only\",\n ipVersion: \"ipv4\",\n vpnGatewayName: \"VpnVpnGatewayDemo\",\n ipsecEnabled: true,\n sslEnabled: true,\n sslMaxConnections: 5,\n projectName: \"default\",\n vpcId: \"vpc-3nr6adxxxxu8931eb64y4z2\",\n subnetId: \"subnet-btepcsxxxxw5h0b2u6hppyd\",\n});\n```\n```python\nimport pulumi\nimport pulumi_volcenginecc as volcenginecc\n\nvpn_vpn_gateway_demo = volcenginecc.vpn.VpnGateway(\"VpnVpnGatewayDemo\",\n bandwidth=5,\n billing_type=2,\n description=\"this is a test description\",\n dual_tunnel_enabled=False,\n ip_stack_type=\"ipv4_only\",\n ip_version=\"ipv4\",\n vpn_gateway_name=\"VpnVpnGatewayDemo\",\n ipsec_enabled=True,\n ssl_enabled=True,\n ssl_max_connections=5,\n project_name=\"default\",\n vpc_id=\"vpc-3nr6adxxxxu8931eb64y4z2\",\n subnet_id=\"subnet-btepcsxxxxw5h0b2u6hppyd\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Volcenginecc = Volcengine.Pulumi.Volcenginecc;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var vpnVpnGatewayDemo = new Volcenginecc.Vpn.VpnGateway(\"VpnVpnGatewayDemo\", new()\n {\n Bandwidth = 5,\n BillingType = 2,\n Description = \"this is a test description\",\n DualTunnelEnabled = false,\n IpStackType = \"ipv4_only\",\n IpVersion = \"ipv4\",\n VpnGatewayName = \"VpnVpnGatewayDemo\",\n IpsecEnabled = true,\n SslEnabled = true,\n SslMaxConnections = 5,\n ProjectName = \"default\",\n VpcId = \"vpc-3nr6adxxxxu8931eb64y4z2\",\n SubnetId = \"subnet-btepcsxxxxw5h0b2u6hppyd\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpn\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := vpn.NewVpnGateway(ctx, \"VpnVpnGatewayDemo\", \u0026vpn.VpnGatewayArgs{\n\t\t\tBandwidth: pulumi.Int(5),\n\t\t\tBillingType: pulumi.Int(2),\n\t\t\tDescription: pulumi.String(\"this is a test description\"),\n\t\t\tDualTunnelEnabled: pulumi.Bool(false),\n\t\t\tIpStackType: pulumi.String(\"ipv4_only\"),\n\t\t\tIpVersion: pulumi.String(\"ipv4\"),\n\t\t\tVpnGatewayName: pulumi.String(\"VpnVpnGatewayDemo\"),\n\t\t\tIpsecEnabled: pulumi.Bool(true),\n\t\t\tSslEnabled: pulumi.Bool(true),\n\t\t\tSslMaxConnections: pulumi.Int(5),\n\t\t\tProjectName: pulumi.String(\"default\"),\n\t\t\tVpcId: pulumi.String(\"vpc-3nr6adxxxxu8931eb64y4z2\"),\n\t\t\tSubnetId: pulumi.String(\"subnet-btepcsxxxxw5h0b2u6hppyd\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.volcengine.volcenginecc.vpn.VpnGateway;\nimport com.volcengine.volcenginecc.vpn.VpnGatewayArgs;\nimport java.util.List;\nimport java.util.ArrayList;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var vpnVpnGatewayDemo = new VpnGateway(\"vpnVpnGatewayDemo\", VpnGatewayArgs.builder()\n .bandwidth(5)\n .billingType(2)\n .description(\"this is a test description\")\n .dualTunnelEnabled(false)\n .ipStackType(\"ipv4_only\")\n .ipVersion(\"ipv4\")\n .vpnGatewayName(\"VpnVpnGatewayDemo\")\n .ipsecEnabled(true)\n .sslEnabled(true)\n .sslMaxConnections(5)\n .projectName(\"default\")\n .vpcId(\"vpc-3nr6adxxxxu8931eb64y4z2\")\n .subnetId(\"subnet-btepcsxxxxw5h0b2u6hppyd\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n vpnVpnGatewayDemo:\n type: volcenginecc:vpn:VpnGateway\n name: VpnVpnGatewayDemo\n properties:\n bandwidth: 5\n billingType: 2\n description: this is a test description\n dualTunnelEnabled: false\n ipStackType: ipv4_only\n ipVersion: ipv4\n vpnGatewayName: VpnVpnGatewayDemo\n ipsecEnabled: true\n sslEnabled: true\n sslMaxConnections: 5\n projectName: default\n vpcId: vpc-3nr6adxxxxu8931eb64y4z2\n subnetId: subnet-btepcsxxxxw5h0b2u6hppyd\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:vpn/vpnGateway:VpnGateway example \"vpn_gateway_id\"\n```\n\n", "properties": { "asn": { "type": "integer", "description": "ASN of the VPN gateway.\n" }, "bandwidth": { "type": "integer", "description": "VPN gateway bandwidth specification.\n" }, "billingType": { "type": "integer", "description": "VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)\n" }, "businessStatus": { "type": "string", "description": "VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.\n" }, "connectionCount": { "type": "integer", "description": "Number of IPsec connections associated with the VPN gateway.\n" }, "createTime": { "type": "string", "description": "Time when the VPN gateway was created.\n" }, "deletedTime": { "type": "string", "description": "Expected resource forced reclaim time.\n" }, "description": { "type": "string", "description": "Description of the VPN gateway.\n" }, "dualTunnelEnabled": { "type": "boolean", "description": "Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled\n" }, "expiredTime": { "type": "string", "description": "VPN gateway expiration time.\n" }, "ipAddress": { "type": "string", "description": "VPN gateway public IP address.\n" }, "ipStackType": { "type": "string", "description": "VPN gateway protocol type. ipv4*only: IPv4 protocol type. ipv6*only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.\n" }, "ipVersion": { "type": "string", "description": "IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.\n" }, "ipsecEnabled": { "type": "boolean", "description": "Enable IPSec feature. true: enabled false: disabled\n" }, "isBlocked": { "type": "boolean", "description": "Whether the current resource is banned. true: Banned false: Not banned.\n" }, "lockReason": { "type": "string", "description": "VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.\n" }, "period": { "type": "integer", "description": "Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.\n" }, "periodUnit": { "type": "string", "description": "Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year\n" }, "projectName": { "type": "string", "description": "Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.\n" }, "routeCount": { "type": "integer", "description": "Number of route entries for the VPN gateway.\n" }, "secondaryIpAddress": { "type": "string", "description": "Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.\n" }, "secondarySubnetId": { "type": "string", "description": "ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.\n" }, "sslEnabled": { "type": "boolean", "description": "Enable SSL VPN feature. true: enabled false: disabled\n" }, "sslMaxConnections": { "type": "integer", "description": "Maximum SSL connections for the VPN gateway.\n" }, "status": { "type": "string", "description": "Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available\n" }, "subnetId": { "type": "string", "description": "ID of the subnet to which the port used by the VPN gateway belongs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnGatewayTag:VpnGatewayTag" } }, "updateTime": { "type": "string", "description": "VPN gateway update time.\n" }, "vpcId": { "type": "string", "description": "VPC ID where the VPN gateway is located.\n" }, "vpnGatewayId": { "type": "string", "description": "ID of the VPN gateway.\n" }, "vpnGatewayName": { "type": "string", "description": "Name of the VPN gateway.\n" } }, "required": [ "asn", "bandwidth", "billingType", "businessStatus", "connectionCount", "createTime", "deletedTime", "description", "dualTunnelEnabled", "expiredTime", "ipAddress", "ipStackType", "ipVersion", "ipsecEnabled", "isBlocked", "lockReason", "overdueTime", "period", "periodUnit", "projectName", "routeCount", "secondaryIpAddress", "secondarySubnetId", "sslEnabled", "sslMaxConnections", "status", "subnetId", "tags", "updateTime", "vpcId", "vpnGatewayId", "vpnGatewayName" ], "inputProperties": { "asn": { "type": "integer", "description": "ASN of the VPN gateway.\n" }, "bandwidth": { "type": "integer", "description": "VPN gateway bandwidth specification.\n" }, "billingType": { "type": "integer", "description": "VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)\n" }, "description": { "type": "string", "description": "Description of the VPN gateway.\n" }, "dualTunnelEnabled": { "type": "boolean", "description": "Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled\n" }, "ipStackType": { "type": "string", "description": "VPN gateway protocol type. ipv4*only: IPv4 protocol type. ipv6*only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.\n" }, "ipVersion": { "type": "string", "description": "IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.\n" }, "ipsecEnabled": { "type": "boolean", "description": "Enable IPSec feature. true: enabled false: disabled\n" }, "period": { "type": "integer", "description": "Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.\n" }, "periodUnit": { "type": "string", "description": "Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year\n" }, "projectName": { "type": "string", "description": "Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.\n" }, "secondarySubnetId": { "type": "string", "description": "ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.\n" }, "sslEnabled": { "type": "boolean", "description": "Enable SSL VPN feature. true: enabled false: disabled\n" }, "sslMaxConnections": { "type": "integer", "description": "Maximum SSL connections for the VPN gateway.\n" }, "subnetId": { "type": "string", "description": "ID of the subnet to which the port used by the VPN gateway belongs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnGatewayTag:VpnGatewayTag" } }, "vpcId": { "type": "string", "description": "VPC ID where the VPN gateway is located.\n" }, "vpnGatewayName": { "type": "string", "description": "Name of the VPN gateway.\n" } }, "requiredInputs": [ "bandwidth", "subnetId", "vpcId" ], "stateInputs": { "description": "Input properties used for looking up and filtering VpnGateway resources.\n", "properties": { "asn": { "type": "integer", "description": "ASN of the VPN gateway.\n" }, "bandwidth": { "type": "integer", "description": "VPN gateway bandwidth specification.\n" }, "billingType": { "type": "integer", "description": "VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)\n" }, "businessStatus": { "type": "string", "description": "VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.\n" }, "connectionCount": { "type": "integer", "description": "Number of IPsec connections associated with the VPN gateway.\n" }, "createTime": { "type": "string", "description": "Time when the VPN gateway was created.\n" }, "deletedTime": { "type": "string", "description": "Expected resource forced reclaim time.\n" }, "description": { "type": "string", "description": "Description of the VPN gateway.\n" }, "dualTunnelEnabled": { "type": "boolean", "description": "Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled\n" }, "expiredTime": { "type": "string", "description": "VPN gateway expiration time.\n" }, "ipAddress": { "type": "string", "description": "VPN gateway public IP address.\n" }, "ipStackType": { "type": "string", "description": "VPN gateway protocol type. ipv4*only: IPv4 protocol type. ipv6*only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.\n" }, "ipVersion": { "type": "string", "description": "IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.\n" }, "ipsecEnabled": { "type": "boolean", "description": "Enable IPSec feature. true: enabled false: disabled\n" }, "isBlocked": { "type": "boolean", "description": "Whether the current resource is banned. true: Banned false: Not banned.\n" }, "lockReason": { "type": "string", "description": "VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.\n" }, "overdueTime": { "type": "string", "description": "Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.\n" }, "period": { "type": "integer", "description": "Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.\n" }, "periodUnit": { "type": "string", "description": "Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year\n" }, "projectName": { "type": "string", "description": "Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.\n" }, "routeCount": { "type": "integer", "description": "Number of route entries for the VPN gateway.\n" }, "secondaryIpAddress": { "type": "string", "description": "Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.\n" }, "secondarySubnetId": { "type": "string", "description": "ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.\n" }, "sslEnabled": { "type": "boolean", "description": "Enable SSL VPN feature. true: enabled false: disabled\n" }, "sslMaxConnections": { "type": "integer", "description": "Maximum SSL connections for the VPN gateway.\n" }, "status": { "type": "string", "description": "Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available\n" }, "subnetId": { "type": "string", "description": "ID of the subnet to which the port used by the VPN gateway belongs.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/volcenginecc:vpn/VpnGatewayTag:VpnGatewayTag" } }, "updateTime": { "type": "string", "description": "VPN gateway update time.\n" }, "vpcId": { "type": "string", "description": "VPC ID where the VPN gateway is located.\n" }, "vpnGatewayId": { "type": "string", "description": "ID of the VPN gateway.\n" }, "vpnGatewayName": { "type": "string", "description": "Name of the VPN gateway.\n" } }, "type": "object" } }, "volcenginecc:waf/domain:Domain": { "description": "Connect the protected site via CNAME or load balancing, configure access and origin capabilities, and route business traffic to the WAF instance for protection\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```yaml\nresources:\n wafDomainDemo:\n type: volcenginecc:waf:Domain\n name: WafDomainDemo\n properties:\n accessMode: 10\n domain: www.test.com\n lbAlgorithm: wrr\n publicRealServer: 1\n vpcId: \"\"\n protocolPorts:\n http:\n - 80\n protocols:\n - HTTP\n backendGroups:\n - access_port:\n - 80\n backends:\n - protocol: HTTP\n port: 80\n ip: 1.1.1.1\n weight: 50\n name: default\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\n```sh\n$ pulumi import volcenginecc:waf/domain:Domain example \"domain\"\n```\n\n", "properties": { "accessMode": { "type": "integer", "description": "Access mode. 10: CNAME access, 11: Layer 7 load balancing (CLB) access.\n" }, "advancedDefenseIp": { "type": "string", "description": "High defense instance IP. Displayed for high-defense WAF access; otherwise blank.\n" }, "advancedDefenseIpv6": { "type": "string", "description": "High defense instance IPv6. Displayed for high-defense WAF access; otherwise blank.\n" }, "apiEnable": { "type": "integer", "description": "API protection policy enabled. 0: Off, 1: On\n" }, "attackStatus": { "type": "integer", "description": "Attack status. 0: No attack detected, 1: Attack detected.\n" }, "autoCcEnable": { "type": "integer", "description": "Whether to enable intelligent CC protection policy. 0: Disabled, 1: Enabled.\n" }, "automaticBlackEnable": { "type": "integer", "description": "Whether to enable automatic blocking. 0: Disabled, 1: Enabled.\n" }, "backendGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/DomainBackendGroup:DomainBackendGroup" } }, "blackIpEnable": { "type": "integer", "description": "Denylist policy enabled. 0: Off, 1: On\n" }, "blackLctEnable": { "type": "integer", "description": "Whether to enable regional blocking policy. 0: Disabled; 1: Enabled.\n" }, "botDytokenEnable": { "type": "integer", "description": "Dynamic token protection enabled\n" }, "botFrequencyEnable": { "type": "integer", "description": "Bot rate limit policy enabled.\n0: Off\n1: On\n" }, "botRepeatEnable": { "type": "integer", "description": "Bot statistics protection policy enabled.\n0: Off\n1: On\n" }, "botSequenceDefaultAction": { "type": "integer", "description": "Set the default action for the bot behavior map policy. Effective when BotSequenceEnable = 1 is enabled. Default is 0 (Observe).\n0: Observe\n2: Intercept\n6: JS Challenge\n7: CAPTCHA.\n" }, "botSequenceEnable": { "type": "integer", "description": "Whether to enable bot behavior map.\n0: Off\n1: On.\n" }, "ccEnable": { "type": "integer", "description": "Whether to enable CC protection policy.\n0: Disabled\n1: Enabled.\n" }, "certificateId": { "type": "string", "description": "Certificate ID managed in Certificate Center\n" }, "certificateName": { "type": "string", "description": "Certificate name. Displayed when protocol type includes HTTPS.\n" }, "certificatePlatform": { "type": "string", "description": "Certificate hosting platform: waf/certificate_service.\n" }, "clbInstanceIds": { "type": "string", "description": "CLB instance ID.\n" }, "clbListenerId": { "type": "string", "description": "CLB listener ID.\n" }, "clbPoolId": { "type": "string", "description": "CLB backend server group ID.\n" }, "clbServerId": { "type": "string", "description": "CLB backend server ID\n" }, "clientIpLocation": { "type": "integer", "description": "Client IP acquisition method. 0: Custom header field, 1: Use the first public IP address in the X-Forwarded-For (XFF) field as the real client IP address.\n" }, "clientMaxBodySize": { "type": "integer", "description": "Maximum client request body size (MB).\n" }, "cloudAccessConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/DomainCloudAccessConfig:DomainCloudAccessConfig" } }, "cname": { "type": "string", "description": "CNAME record.\n" }, "customBotEnable": { "type": "integer", "description": "Whether to enable custom bot protection.\n" }, "customHeaders": { "type": "array", "items": { "type": "string" }, "description": "Custom header.\n" }, "customRspEnable": { "type": "integer", "description": "Whether to enable custom response.\n" }, "customSni": { "type": "string", "description": "Custom SNI.\n" }, "defenceMode": { "type": "integer", "description": "Set protection mode for exception ALB instances.\n1: Enable protection. The configured protection policies take effect.\n2: Pause protection. Only forwarding is performed without inspection; the configured protection policies do not take effect.\n3: Origin mode. Requests are sent directly to the origin server and are no longer forwarded to the WAF instance.\nAfter configuring exception protection instances, the domain may also have the following protection statuses:\n5: Partially enabled. The default protection mode is enabled, but some exception instances are in paused protection or origin mode.\n6: Partially paused. The default protection mode is paused, but some exception instances are in enabled protection or origin mode.\n7: Partially origin. The default protection mode is origin mode, but some exception instances are in enabled protection or paused protection.\n" }, "dlpEnable": { "type": "integer", "description": "Data leakage protection enabled\n" }, "domain": { "type": "string", "description": "Protected domain information. Supports wildcard and exact domains\n", "language": { "csharp": { "name": "DomainValue" } } }, "enableCustomRedirect": { "type": "integer", "description": "User-defined redirection enabled. 0: Off, 1: On\n" }, "enableHttp2": { "type": "integer", "description": "Whether to enable HTTP/2.0. 0: Disabled, 1: Enabled.\n" }, "enableIpv6": { "type": "integer", "description": "IPv6 request protection supported. 0: Off, 1: On\n" }, "enableSni": { "type": "integer", "description": "Whether to enable SNI configuration. 0: Off, 1: On.\n" }, "keepAliveRequest": { "type": "integer", "description": "Persistent connection reuse count\n" }, "keepAliveTimeout": { "type": "integer", "description": "Persistent connection keep-alive time (seconds)\n" }, "lbAlgorithm": { "type": "string", "description": "Load balancing algorithm type. wrr: Weighted round robin, wlc: Weighted least connections, sh: Source address hash.\n" }, "port": { "type": "integer", "description": "Port number\n" }, "projectName": { "type": "string", "description": "Project name.\n" }, "protocolFollow": { "type": "integer", "description": "Protocol following enabled. 0: Off, 1: On\n" }, "protocolPorts": { "$ref": "#/types/volcenginecc:waf/DomainProtocolPorts:DomainProtocolPorts", "description": "Access port information\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "Access protocol type: supports HTTP/HTTPS\n" }, "proxyConfig": { "type": "integer", "description": "Proxy configuration enabled. 0: Off, 1: On\n" }, "proxyConnectTimeout": { "type": "integer", "description": "Connection timeout between WAF and backend server (seconds).\n" }, "proxyKeepAlive": { "type": "integer", "description": "Number of reusable WAF origin persistent connections.\n" }, "proxyKeepAliveTimeout": { "type": "integer", "description": "Idle persistent connection timeout (seconds)\n" }, "proxyReadTimeout": { "type": "integer", "description": "Timeout for WAF to read response from backend server (seconds).\n" }, "proxyRetry": { "type": "integer", "description": "WAF origin retry count.\n" }, "proxyWriteTimeout": { "type": "integer", "description": "Timeout for WAF to transmit request to backend server (seconds).\n" }, "publicRealServer": { "type": "integer", "description": "CNAME access origin method. 0: Private network origin, 1: Public network origin.\n" }, "rspAbnormalEnable": { "type": "integer", "description": "Whether to enable abnormal response protection.\n" }, "serverIps": { "type": "string", "description": "Service IP\n" }, "srcIps": { "type": "string", "description": "WAF origin IP.\n" }, "srcProtocol": { "type": "string", "description": "Origin protocol.\n" }, "sslCiphers": { "type": "array", "items": { "type": "string" }, "description": "Cipher suite\n" }, "sslProtocols": { "type": "array", "items": { "type": "string" }, "description": "TLS protocol version. For example: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3\n" }, "status": { "type": "integer", "description": "Access status. 0: Normal, 1: DNS not resolved, 2: Configuring, 3: Configuration failed, 4: Configuration not effective, 5: Updating, 6: Instance deleted.\n" }, "systemBotEnable": { "type": "integer", "description": "Whether to enable managed bot protection.\n" }, "tamperProofEnable": { "type": "integer", "description": "Whether to enable anti-tampering.\n" }, "tcpListenerConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/DomainTcpListenerConfig:DomainTcpListenerConfig" } }, "tlsEnable": { "type": "integer", "description": "Log service enabled. 0: Off, 1: On\n" }, "tlsFieldsConfig": { "$ref": "#/types/volcenginecc:waf/DomainTlsFieldsConfig:DomainTlsFieldsConfig", "description": "Log field configuration details\n" }, "updateTime": { "type": "string", "description": "Update time\n" }, "vpcId": { "type": "string", "description": "VPC ID。\n" }, "wafEnable": { "type": "integer", "description": "WAF protection enabled\n" }, "wafWhiteReqEnable": { "type": "integer", "description": "Allowlist request protection enabled\n" }, "whiteEnable": { "type": "integer", "description": "Whether to enable allowlist protection.\n" }, "whiteFieldEnable": { "type": "integer", "description": "Field allowlist protection enabled\n" } }, "required": [ "accessMode", "advancedDefenseIp", "advancedDefenseIpv6", "apiEnable", "attackStatus", "autoCcEnable", "automaticBlackEnable", "backendGroups", "blackIpEnable", "blackLctEnable", "botDytokenEnable", "botFrequencyEnable", "botRepeatEnable", "botSequenceDefaultAction", "botSequenceEnable", "ccEnable", "certificateId", "certificateName", "certificatePlatform", "clbInstanceIds", "clbListenerId", "clbPoolId", "clbServerId", "clientIpLocation", "clientMaxBodySize", "cloudAccessConfigs", "cname", "customBotEnable", "customHeaders", "customRspEnable", "customSni", "defenceMode", "dlpEnable", "domain", "enableCustomRedirect", "enableHttp2", "enableIpv6", "enableSni", "keepAliveRequest", "keepAliveTimeout", "lbAlgorithm", "port", "projectName", "protocolFollow", "protocolPorts", "protocols", "proxyConfig", "proxyConnectTimeout", "proxyKeepAlive", "proxyKeepAliveTimeout", "proxyReadTimeout", "proxyRetry", "proxyWriteTimeout", "publicRealServer", "rspAbnormalEnable", "serverIps", "srcIps", "srcProtocol", "sslCiphers", "sslProtocols", "status", "systemBotEnable", "tamperProofEnable", "tcpListenerConfigs", "tlsEnable", "tlsFieldsConfig", "updateTime", "vpcId", "wafEnable", "wafWhiteReqEnable", "whiteEnable", "whiteFieldEnable" ], "inputProperties": { "accessMode": { "type": "integer", "description": "Access mode. 10: CNAME access, 11: Layer 7 load balancing (CLB) access.\n" }, "apiEnable": { "type": "integer", "description": "API protection policy enabled. 0: Off, 1: On\n" }, "autoCcEnable": { "type": "integer", "description": "Whether to enable intelligent CC protection policy. 0: Disabled, 1: Enabled.\n" }, "backendGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/DomainBackendGroup:DomainBackendGroup" } }, "blackIpEnable": { "type": "integer", "description": "Denylist policy enabled. 0: Off, 1: On\n" }, "blackLctEnable": { "type": "integer", "description": "Whether to enable regional blocking policy. 0: Disabled; 1: Enabled.\n" }, "botDytokenEnable": { "type": "integer", "description": "Dynamic token protection enabled\n" }, "botFrequencyEnable": { "type": "integer", "description": "Bot rate limit policy enabled.\n0: Off\n1: On\n" }, "botRepeatEnable": { "type": "integer", "description": "Bot statistics protection policy enabled.\n0: Off\n1: On\n" }, "botSequenceDefaultAction": { "type": "integer", "description": "Set the default action for the bot behavior map policy. Effective when BotSequenceEnable = 1 is enabled. Default is 0 (Observe).\n0: Observe\n2: Intercept\n6: JS Challenge\n7: CAPTCHA.\n" }, "botSequenceEnable": { "type": "integer", "description": "Whether to enable bot behavior map.\n0: Off\n1: On.\n" }, "ccEnable": { "type": "integer", "description": "Whether to enable CC protection policy.\n0: Disabled\n1: Enabled.\n" }, "certificateId": { "type": "string", "description": "Certificate ID managed in Certificate Center\n" }, "certificatePlatform": { "type": "string", "description": "Certificate hosting platform: waf/certificate_service.\n" }, "clientIpLocation": { "type": "integer", "description": "Client IP acquisition method. 0: Custom header field, 1: Use the first public IP address in the X-Forwarded-For (XFF) field as the real client IP address.\n" }, "clientMaxBodySize": { "type": "integer", "description": "Maximum client request body size (MB).\n" }, "cloudAccessConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/DomainCloudAccessConfig:DomainCloudAccessConfig" } }, "customBotEnable": { "type": "integer", "description": "Whether to enable custom bot protection.\n" }, "customHeaders": { "type": "array", "items": { "type": "string" }, "description": "Custom header.\n" }, "customRspEnable": { "type": "integer", "description": "Whether to enable custom response.\n" }, "customSni": { "type": "string", "description": "Custom SNI.\n" }, "defenceMode": { "type": "integer", "description": "Set protection mode for exception ALB instances.\n1: Enable protection. The configured protection policies take effect.\n2: Pause protection. Only forwarding is performed without inspection; the configured protection policies do not take effect.\n3: Origin mode. Requests are sent directly to the origin server and are no longer forwarded to the WAF instance.\nAfter configuring exception protection instances, the domain may also have the following protection statuses:\n5: Partially enabled. The default protection mode is enabled, but some exception instances are in paused protection or origin mode.\n6: Partially paused. The default protection mode is paused, but some exception instances are in enabled protection or origin mode.\n7: Partially origin. The default protection mode is origin mode, but some exception instances are in enabled protection or paused protection.\n" }, "dlpEnable": { "type": "integer", "description": "Data leakage protection enabled\n" }, "domain": { "type": "string", "description": "Protected domain information. Supports wildcard and exact domains\n", "language": { "csharp": { "name": "DomainValue" } } }, "enableCustomRedirect": { "type": "integer", "description": "User-defined redirection enabled. 0: Off, 1: On\n" }, "enableHttp2": { "type": "integer", "description": "Whether to enable HTTP/2.0. 0: Disabled, 1: Enabled.\n" }, "enableIpv6": { "type": "integer", "description": "IPv6 request protection supported. 0: Off, 1: On\n" }, "enableSni": { "type": "integer", "description": "Whether to enable SNI configuration. 0: Off, 1: On.\n" }, "keepAliveRequest": { "type": "integer", "description": "Persistent connection reuse count\n" }, "keepAliveTimeout": { "type": "integer", "description": "Persistent connection keep-alive time (seconds)\n" }, "lbAlgorithm": { "type": "string", "description": "Load balancing algorithm type. wrr: Weighted round robin, wlc: Weighted least connections, sh: Source address hash.\n" }, "projectName": { "type": "string", "description": "Project name.\n" }, "protocolFollow": { "type": "integer", "description": "Protocol following enabled. 0: Off, 1: On\n" }, "protocolPorts": { "$ref": "#/types/volcenginecc:waf/DomainProtocolPorts:DomainProtocolPorts", "description": "Access port information\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "Access protocol type: supports HTTP/HTTPS\n" }, "proxyConfig": { "type": "integer", "description": "Proxy configuration enabled. 0: Off, 1: On\n" }, "proxyConnectTimeout": { "type": "integer", "description": "Connection timeout between WAF and backend server (seconds).\n" }, "proxyKeepAlive": { "type": "integer", "description": "Number of reusable WAF origin persistent connections.\n" }, "proxyKeepAliveTimeout": { "type": "integer", "description": "Idle persistent connection timeout (seconds)\n" }, "proxyReadTimeout": { "type": "integer", "description": "Timeout for WAF to read response from backend server (seconds).\n" }, "proxyRetry": { "type": "integer", "description": "WAF origin retry count.\n" }, "proxyWriteTimeout": { "type": "integer", "description": "Timeout for WAF to transmit request to backend server (seconds).\n" }, "publicRealServer": { "type": "integer", "description": "CNAME access origin method. 0: Private network origin, 1: Public network origin.\n" }, "sslCiphers": { "type": "array", "items": { "type": "string" }, "description": "Cipher suite\n" }, "sslProtocols": { "type": "array", "items": { "type": "string" }, "description": "TLS protocol version. For example: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3\n" }, "systemBotEnable": { "type": "integer", "description": "Whether to enable managed bot protection.\n" }, "tamperProofEnable": { "type": "integer", "description": "Whether to enable anti-tampering.\n" }, "tlsEnable": { "type": "integer", "description": "Log service enabled. 0: Off, 1: On\n" }, "tlsFieldsConfig": { "$ref": "#/types/volcenginecc:waf/DomainTlsFieldsConfig:DomainTlsFieldsConfig", "description": "Log field configuration details\n" }, "vpcId": { "type": "string", "description": "VPC ID。\n" }, "wafEnable": { "type": "integer", "description": "WAF protection enabled\n" }, "wafWhiteReqEnable": { "type": "integer", "description": "Allowlist request protection enabled\n" }, "whiteEnable": { "type": "integer", "description": "Whether to enable allowlist protection.\n" }, "whiteFieldEnable": { "type": "integer", "description": "Field allowlist protection enabled\n" } }, "requiredInputs": [ "accessMode", "domain" ], "stateInputs": { "description": "Input properties used for looking up and filtering Domain resources.\n", "properties": { "accessMode": { "type": "integer", "description": "Access mode. 10: CNAME access, 11: Layer 7 load balancing (CLB) access.\n" }, "advancedDefenseIp": { "type": "string", "description": "High defense instance IP. Displayed for high-defense WAF access; otherwise blank.\n" }, "advancedDefenseIpv6": { "type": "string", "description": "High defense instance IPv6. Displayed for high-defense WAF access; otherwise blank.\n" }, "apiEnable": { "type": "integer", "description": "API protection policy enabled. 0: Off, 1: On\n" }, "attackStatus": { "type": "integer", "description": "Attack status. 0: No attack detected, 1: Attack detected.\n" }, "autoCcEnable": { "type": "integer", "description": "Whether to enable intelligent CC protection policy. 0: Disabled, 1: Enabled.\n" }, "automaticBlackEnable": { "type": "integer", "description": "Whether to enable automatic blocking. 0: Disabled, 1: Enabled.\n" }, "backendGroups": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/DomainBackendGroup:DomainBackendGroup" } }, "blackIpEnable": { "type": "integer", "description": "Denylist policy enabled. 0: Off, 1: On\n" }, "blackLctEnable": { "type": "integer", "description": "Whether to enable regional blocking policy. 0: Disabled; 1: Enabled.\n" }, "botDytokenEnable": { "type": "integer", "description": "Dynamic token protection enabled\n" }, "botFrequencyEnable": { "type": "integer", "description": "Bot rate limit policy enabled.\n0: Off\n1: On\n" }, "botRepeatEnable": { "type": "integer", "description": "Bot statistics protection policy enabled.\n0: Off\n1: On\n" }, "botSequenceDefaultAction": { "type": "integer", "description": "Set the default action for the bot behavior map policy. Effective when BotSequenceEnable = 1 is enabled. Default is 0 (Observe).\n0: Observe\n2: Intercept\n6: JS Challenge\n7: CAPTCHA.\n" }, "botSequenceEnable": { "type": "integer", "description": "Whether to enable bot behavior map.\n0: Off\n1: On.\n" }, "ccEnable": { "type": "integer", "description": "Whether to enable CC protection policy.\n0: Disabled\n1: Enabled.\n" }, "certificateId": { "type": "string", "description": "Certificate ID managed in Certificate Center\n" }, "certificateName": { "type": "string", "description": "Certificate name. Displayed when protocol type includes HTTPS.\n" }, "certificatePlatform": { "type": "string", "description": "Certificate hosting platform: waf/certificate_service.\n" }, "clbInstanceIds": { "type": "string", "description": "CLB instance ID.\n" }, "clbListenerId": { "type": "string", "description": "CLB listener ID.\n" }, "clbPoolId": { "type": "string", "description": "CLB backend server group ID.\n" }, "clbServerId": { "type": "string", "description": "CLB backend server ID\n" }, "clientIpLocation": { "type": "integer", "description": "Client IP acquisition method. 0: Custom header field, 1: Use the first public IP address in the X-Forwarded-For (XFF) field as the real client IP address.\n" }, "clientMaxBodySize": { "type": "integer", "description": "Maximum client request body size (MB).\n" }, "cloudAccessConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/DomainCloudAccessConfig:DomainCloudAccessConfig" } }, "cname": { "type": "string", "description": "CNAME record.\n" }, "customBotEnable": { "type": "integer", "description": "Whether to enable custom bot protection.\n" }, "customHeaders": { "type": "array", "items": { "type": "string" }, "description": "Custom header.\n" }, "customRspEnable": { "type": "integer", "description": "Whether to enable custom response.\n" }, "customSni": { "type": "string", "description": "Custom SNI.\n" }, "defenceMode": { "type": "integer", "description": "Set protection mode for exception ALB instances.\n1: Enable protection. The configured protection policies take effect.\n2: Pause protection. Only forwarding is performed without inspection; the configured protection policies do not take effect.\n3: Origin mode. Requests are sent directly to the origin server and are no longer forwarded to the WAF instance.\nAfter configuring exception protection instances, the domain may also have the following protection statuses:\n5: Partially enabled. The default protection mode is enabled, but some exception instances are in paused protection or origin mode.\n6: Partially paused. The default protection mode is paused, but some exception instances are in enabled protection or origin mode.\n7: Partially origin. The default protection mode is origin mode, but some exception instances are in enabled protection or paused protection.\n" }, "dlpEnable": { "type": "integer", "description": "Data leakage protection enabled\n" }, "domain": { "type": "string", "description": "Protected domain information. Supports wildcard and exact domains\n", "language": { "csharp": { "name": "DomainValue" } } }, "enableCustomRedirect": { "type": "integer", "description": "User-defined redirection enabled. 0: Off, 1: On\n" }, "enableHttp2": { "type": "integer", "description": "Whether to enable HTTP/2.0. 0: Disabled, 1: Enabled.\n" }, "enableIpv6": { "type": "integer", "description": "IPv6 request protection supported. 0: Off, 1: On\n" }, "enableSni": { "type": "integer", "description": "Whether to enable SNI configuration. 0: Off, 1: On.\n" }, "keepAliveRequest": { "type": "integer", "description": "Persistent connection reuse count\n" }, "keepAliveTimeout": { "type": "integer", "description": "Persistent connection keep-alive time (seconds)\n" }, "lbAlgorithm": { "type": "string", "description": "Load balancing algorithm type. wrr: Weighted round robin, wlc: Weighted least connections, sh: Source address hash.\n" }, "port": { "type": "integer", "description": "Port number\n" }, "projectName": { "type": "string", "description": "Project name.\n" }, "protocolFollow": { "type": "integer", "description": "Protocol following enabled. 0: Off, 1: On\n" }, "protocolPorts": { "$ref": "#/types/volcenginecc:waf/DomainProtocolPorts:DomainProtocolPorts", "description": "Access port information\n" }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "Access protocol type: supports HTTP/HTTPS\n" }, "proxyConfig": { "type": "integer", "description": "Proxy configuration enabled. 0: Off, 1: On\n" }, "proxyConnectTimeout": { "type": "integer", "description": "Connection timeout between WAF and backend server (seconds).\n" }, "proxyKeepAlive": { "type": "integer", "description": "Number of reusable WAF origin persistent connections.\n" }, "proxyKeepAliveTimeout": { "type": "integer", "description": "Idle persistent connection timeout (seconds)\n" }, "proxyReadTimeout": { "type": "integer", "description": "Timeout for WAF to read response from backend server (seconds).\n" }, "proxyRetry": { "type": "integer", "description": "WAF origin retry count.\n" }, "proxyWriteTimeout": { "type": "integer", "description": "Timeout for WAF to transmit request to backend server (seconds).\n" }, "publicRealServer": { "type": "integer", "description": "CNAME access origin method. 0: Private network origin, 1: Public network origin.\n" }, "rspAbnormalEnable": { "type": "integer", "description": "Whether to enable abnormal response protection.\n" }, "serverIps": { "type": "string", "description": "Service IP\n" }, "srcIps": { "type": "string", "description": "WAF origin IP.\n" }, "srcProtocol": { "type": "string", "description": "Origin protocol.\n" }, "sslCiphers": { "type": "array", "items": { "type": "string" }, "description": "Cipher suite\n" }, "sslProtocols": { "type": "array", "items": { "type": "string" }, "description": "TLS protocol version. For example: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3\n" }, "status": { "type": "integer", "description": "Access status. 0: Normal, 1: DNS not resolved, 2: Configuring, 3: Configuration failed, 4: Configuration not effective, 5: Updating, 6: Instance deleted.\n" }, "systemBotEnable": { "type": "integer", "description": "Whether to enable managed bot protection.\n" }, "tamperProofEnable": { "type": "integer", "description": "Whether to enable anti-tampering.\n" }, "tcpListenerConfigs": { "type": "array", "items": { "$ref": "#/types/volcenginecc:waf/DomainTcpListenerConfig:DomainTcpListenerConfig" } }, "tlsEnable": { "type": "integer", "description": "Log service enabled. 0: Off, 1: On\n" }, "tlsFieldsConfig": { "$ref": "#/types/volcenginecc:waf/DomainTlsFieldsConfig:DomainTlsFieldsConfig", "description": "Log field configuration details\n" }, "updateTime": { "type": "string", "description": "Update time\n" }, "vpcId": { "type": "string", "description": "VPC ID。\n" }, "wafEnable": { "type": "integer", "description": "WAF protection enabled\n" }, "wafWhiteReqEnable": { "type": "integer", "description": "Allowlist request protection enabled\n" }, "whiteEnable": { "type": "integer", "description": "Whether to enable allowlist protection.\n" }, "whiteFieldEnable": { "type": "integer", "description": "Field allowlist protection enabled\n" } }, "type": "object" } } }, "functions": { "pulumi:providers:volcenginecc/terraformConfig": { "description": "This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.", "inputs": { "properties": { "__self__": { "type": "ref", "$ref": "#/resources/pulumi:providers:volcenginecc" } }, "type": "pulumi:providers:volcenginecc/terraformConfig", "required": [ "__self__" ] }, "outputs": { "properties": { "result": { "additionalProperties": { "$ref": "pulumi.json#/Any" }, "type": "object" } }, "required": [ "result" ], "type": "object" } }, "volcenginecc:alb/getAcl:getAcl": { "description": "Data Source schema for Volcengine::ALB::ACL\n", "inputs": { "description": "A collection of arguments for invoking getAcl.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAcl.\n", "properties": { "aclEntries": { "description": "Detailed information about IP entries in the access control policy group.\n", "items": { "$ref": "#/types/volcenginecc:alb/getAclAclEntry:getAclAclEntry" }, "type": "array" }, "aclEntryCount": { "description": "Number of IP entries in the access control policy group.\n", "type": "integer" }, "aclId": { "description": "Access control policy group ID.\n", "type": "string" }, "aclName": { "description": "Name of the access control policy group. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If not specified, defaults to the access control policy group ID.\n", "type": "string" }, "createdTime": { "description": "Creation time of the access control policy group.\n", "type": "string" }, "description": { "description": "Description of the access control policy group. Cannot start with http:// or https://. Must start with a letter or Chinese character and can include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listeners": { "description": "Detailed information about listeners associated with the access control policy group.\n", "items": { "$ref": "#/types/volcenginecc:alb/getAclListener:getAclListener" }, "type": "array" }, "projectName": { "description": "Name of the project to which the access control policy group belongs.\n", "type": "string" }, "status": { "description": "Status of the access control policy group. Creating: being created. Active: available. Configuring: being configured. Deleting: being deleted.\n", "type": "string" }, "tags": { "description": "Tags bound to the access control policy group.\n", "items": { "$ref": "#/types/volcenginecc:alb/getAclTag:getAclTag" }, "type": "array" }, "updatedTime": { "description": "Most recent operation time for the access control policy group.\n", "type": "string" } }, "required": [ "aclEntries", "aclEntryCount", "aclId", "aclName", "createdTime", "description", "id", "listeners", "projectName", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:alb/getAcls:getAcls": { "description": "Plural Data Source schema for Volcengine::ALB::ACL\n", "outputs": { "description": "A collection of values returned by getAcls.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:alb/getCertificate:getCertificate": { "description": "Data Source schema for Volcengine::ALB::Certificate\n", "inputs": { "description": "A collection of arguments for invoking getCertificate.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getCertificate.\n", "properties": { "certificateId": { "description": "Certificate ID\n", "type": "string" }, "certificateName": { "description": "Certificate name. Length must be between 1 and 128 characters, start with a letter or Chinese character, and may include numbers, periods (.), underscores (_), and hyphens (-)\n", "type": "string" }, "certificateType": { "description": "Certificate type. Options: CA: CA certificate; Server: server certificate\n", "type": "string" }, "createdTime": { "description": "Certificate creation time\n", "type": "string" }, "description": { "description": "Certificate description\n", "type": "string" }, "domainName": { "description": "Certificate domain name\n", "type": "string" }, "expiredAt": { "description": "Certificate expiration time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listeners": { "description": "List of listeners associated with the certificate\n", "items": { "type": "string" }, "type": "array" }, "privateKey": { "description": "Server certificate private key. Required when certificate type is Server\n", "type": "string" }, "projectName": { "description": "Project name\n", "type": "string" }, "publicKey": { "description": "Server certificate public key\n", "type": "string" }, "san": { "description": "Certificate subject alternative name list. Use English ',' to separate multiple domain names. Includes (commonName, DnsName, IP)\n", "type": "string" }, "status": { "description": "Certificate status. Options: Creating: creating; Active: active; Deleting: deleting\n", "type": "string" }, "tags": { "description": "Tag list\n", "items": { "$ref": "#/types/volcenginecc:alb/getCertificateTag:getCertificateTag" }, "type": "array" } }, "required": [ "certificateId", "certificateName", "certificateType", "createdTime", "description", "domainName", "expiredAt", "id", "listeners", "privateKey", "projectName", "publicKey", "san", "status", "tags" ], "type": "object" } }, "volcenginecc:alb/getCertificates:getCertificates": { "description": "Plural Data Source schema for Volcengine::ALB::Certificate\n", "outputs": { "description": "A collection of values returned by getCertificates.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:alb/getCustomizedCfg:getCustomizedCfg": { "description": "Data Source schema for Volcengine::ALB::CustomizedCfg\n", "inputs": { "description": "A collection of arguments for invoking getCustomizedCfg.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getCustomizedCfg.\n", "properties": { "createdTime": { "description": "Creation time of the personalized configuration.\n", "type": "string" }, "customizedCfgContent": { "description": "Content of the personalized configuration item. Specific rules: Length must not exceed 4096 characters. Spaces and semicolons must be escaped. Different configuration items are separated by ';\n'. Configuration items cannot be duplicated. Currently supported configuration items include ssl*protocols, ssl*ciphers, client*max*body*size, keepalive*timeout, proxy*request*buffering, proxy*connect*timeout, add*header, client*header*timeout, proxy*read*timeout, proxy*send*timeout, client*body*timeout, send*timeout, and ssl*verify*depth. For details, see the official documentation.\n", "type": "string" }, "customizedCfgId": { "description": "Personalized configuration ID.\n", "type": "string" }, "customizedCfgName": { "description": "Name of the personalized configuration. Specific rules: Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n", "type": "string" }, "description": { "description": "Description of the personalized configuration. Specific rules: Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be between 1 and 255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listeners": { "description": "List of listeners associated with the personalized configuration.\n", "items": { "$ref": "#/types/volcenginecc:alb/getCustomizedCfgListener:getCustomizedCfgListener" }, "type": "array" }, "projectName": { "description": "Project name to which the personalized configuration belongs.\n", "type": "string" }, "status": { "description": "Status of the personalized configuration. Includes Active, Configuring, Creating, or Deleting.\n", "type": "string" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:alb/getCustomizedCfgTag:getCustomizedCfgTag" }, "type": "array" }, "updatedTime": { "description": "Last operation time of the personalized configuration.\n", "type": "string" } }, "required": [ "createdTime", "customizedCfgContent", "customizedCfgId", "customizedCfgName", "description", "id", "listeners", "projectName", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:alb/getCustomizedCfgs:getCustomizedCfgs": { "description": "Plural Data Source schema for Volcengine::ALB::CustomizedCfg\n", "outputs": { "description": "A collection of values returned by getCustomizedCfgs.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:alb/getHealthCheckTemplate:getHealthCheckTemplate": { "description": "Data Source schema for Volcengine::ALB::HealthCheckTemplate\n", "inputs": { "description": "A collection of arguments for invoking getHealthCheckTemplate.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getHealthCheckTemplate.\n", "properties": { "createTime": { "description": "Creation time of the health check template.\n", "type": "string" }, "description": { "description": "Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "healthCheckDomain": { "description": "Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.\n", "type": "string" }, "healthCheckHttpCode": { "description": "HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http*2xx (default), http*3xx (default), http*4xx, http*5xx.\n", "type": "string" }, "healthCheckHttpVersion": { "description": "HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.\n", "type": "string" }, "healthCheckInterval": { "description": "Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.\n", "type": "integer" }, "healthCheckMethod": { "description": "Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)\n", "type": "string" }, "healthCheckPort": { "description": "Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.\n", "type": "integer" }, "healthCheckProtocol": { "description": "Protocol for the health check. HTTP or TCP.\n", "type": "string" }, "healthCheckTemplateId": { "description": "Health check template ID.\n", "type": "string" }, "healthCheckTemplateName": { "description": "Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n", "type": "string" }, "healthCheckTimeout": { "description": "Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.\n", "type": "integer" }, "healthCheckUri": { "description": "Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '\u0026', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.\n", "type": "string" }, "healthyThreshold": { "description": "Health threshold for the health check. Default is 3. Range: 2–10 times.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "projectName": { "description": "Project name to which the health check template belongs.\n", "type": "string" }, "tags": { "description": "List of tags associated with the health check template.\n", "items": { "$ref": "#/types/volcenginecc:alb/getHealthCheckTemplateTag:getHealthCheckTemplateTag" }, "type": "array" }, "unhealthyThreshold": { "description": "Unhealthy threshold for health checks. Default is 3; range is 2–10 times.\n", "type": "integer" }, "updateTime": { "description": "Last operation time of the health check template.\n", "type": "string" } }, "required": [ "createTime", "description", "healthCheckDomain", "healthCheckHttpCode", "healthCheckHttpVersion", "healthCheckInterval", "healthCheckMethod", "healthCheckPort", "healthCheckProtocol", "healthCheckTemplateId", "healthCheckTemplateName", "healthCheckTimeout", "healthCheckUri", "healthyThreshold", "id", "projectName", "tags", "unhealthyThreshold", "updateTime" ], "type": "object" } }, "volcenginecc:alb/getHealthCheckTemplates:getHealthCheckTemplates": { "description": "Plural Data Source schema for Volcengine::ALB::HealthCheckTemplate\n", "outputs": { "description": "A collection of values returned by getHealthCheckTemplates.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:alb/getListener:getListener": { "description": "Data Source schema for Volcengine::ALB::Listener\n", "inputs": { "description": "A collection of arguments for invoking getListener.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getListener.\n", "properties": { "accessLogRecordCustomizedHeadersEnabled": { "description": "Whether the listener has enabled 'Record custom header in access logs': on: enabled. off: not enabled.\n", "type": "string" }, "aclIds": { "description": "Access control policy group ID bound to the listener. When the AclStatus parameter is set to on, AclIds is required.\n", "items": { "type": "string" }, "type": "array" }, "aclStatus": { "description": "Whether access control is enabled. Values: on: enabled. off: not enabled (default).\n", "type": "string" }, "aclType": { "description": "Access control mode. Available values: white: allowlist mode. The listener only forwards requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will not forward any requests. black: denylist mode. The listener only rejects requests from IP addresses or address ranges specified in the selected access control policy group. If no IP addresses are added to the selected policy group, the listener will forward all requests. When the AclStatus parameter is set to on, AclType is a required parameter.\n", "type": "string" }, "caCertificateId": { "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When the certificate source is alb, you must specify the CACertificateId parameter.\n", "type": "string" }, "caCertificateSource": { "description": "Source of the CA certificate associated with the HTTPS listener, used for mutual authentication. alb (default): Certificate uploaded via ALB. Standard ALB instances do not support certificates from this source. pca*root: Private root CA certificate purchased or uploaded via Volcano Engine Certificate Center. pca*sub: Private subordinate CA certificate purchased or uploaded via Volcano Engine Certificate Center.\n", "type": "string" }, "certCenterCertificateId": { "description": "Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is cert_center.\n", "type": "string" }, "certificateId": { "description": "Certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is alb.\n", "type": "string" }, "certificateSource": { "description": "Source of the default certificate associated with the HTTPS listener. Values: alb: certificate uploaded via ALB; cert*center: SSL certificate purchased or uploaded via Volcano Engine Certificate Center; pca*leaf: private leaf certificate purchased or uploaded via Volcano Engine Certificate Center.\n", "type": "string" }, "createdTime": { "description": "Listener creation time.\n", "type": "string" }, "customizedCfgId": { "description": "Personalized configuration ID. If not bound, the value is an empty string.\n", "type": "string" }, "description": { "description": "Listener description. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, commas (,), periods (.), underscores (_), spaces, equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length limit: 1 to 255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "domainExtensions": { "description": "List of extension domains associated with the HTTPS listener. An HTTPS listener can be associated with up to 20 extension domains.\n", "items": { "$ref": "#/types/volcenginecc:alb/getListenerDomainExtension:getListenerDomainExtension" }, "type": "array" }, "enableHttp2": { "description": "HTTP 2.0 feature switch. This parameter is only valid for HTTPS listeners. Values: on: enabled; off: disabled (default).\n", "type": "string" }, "enableQuic": { "description": "QUIC feature switch. This parameter is only valid for HTTPS listeners. Available values: on: enabled. off: disabled (default). Only Standard ALB instances support QUIC.\n", "type": "string" }, "enabled": { "description": "Listener on/off status. Values: on: enabled (default); off: disabled.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listenerId": { "description": "Listener ID.\n", "type": "string" }, "listenerName": { "description": "Listener name. If not specified, it is named in the \"protocol-port\" format. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can include numbers, periods (.), underscores (_), and hyphens (-). Length limit: 1-128 characters.\n", "type": "string" }, "loadBalancerId": { "description": "Load balancer instance ID associated with the listener.\n", "type": "string" }, "pcaLeafCertificateId": { "description": "Private leaf certificate ID associated with the HTTPS listener. Required when creating an HTTPS listener and the certificate source is pca_leaf.\n", "type": "string" }, "pcaRootCaCertificateId": { "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for mutual authentication of the HTTPS listener. When the certificate source is pca_root, you must specify the PcaRootCACertificateId parameter.\n", "type": "string" }, "pcaSubCaCertificateId": { "description": "CA certificate ID associated with the HTTPS listener. This parameter is used for two-way authentication on HTTPS listeners. When the certificate source is pca_sub, you must specify the PcaSubCACertificateId parameter.\n", "type": "string" }, "port": { "description": "Listener port. Value range: 1 - 65535.\n", "type": "integer" }, "projectName": { "description": "Project name to which the listener belongs.\n", "type": "string" }, "protocol": { "description": "Listener protocol. Supports HTTP and HTTPS protocols.\n", "type": "string" }, "serverGroupId": { "description": "Default server group for the listener.\n", "type": "string" }, "serverGroups": { "description": "All server groups associated with the listener.\n", "items": { "$ref": "#/types/volcenginecc:alb/getListenerServerGroup:getListenerServerGroup" }, "type": "array" }, "status": { "description": "Listener status. Values: Creating: creating. Active: running. Pending: configuration changing. Disabled: stopped. Deleting: deleting.\n", "type": "string" }, "tags": { "description": "Tags associated with the listener.\n", "items": { "$ref": "#/types/volcenginecc:alb/getListenerTag:getListenerTag" }, "type": "array" }, "updatedTime": { "description": "The most recent operation time of the listener.\n", "type": "string" } }, "required": [ "accessLogRecordCustomizedHeadersEnabled", "aclIds", "aclStatus", "aclType", "caCertificateId", "caCertificateSource", "certCenterCertificateId", "certificateId", "certificateSource", "createdTime", "customizedCfgId", "description", "domainExtensions", "enableHttp2", "enableQuic", "enabled", "id", "listenerId", "listenerName", "loadBalancerId", "pcaLeafCertificateId", "pcaRootCaCertificateId", "pcaSubCaCertificateId", "port", "projectName", "protocol", "serverGroupId", "serverGroups", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:alb/getListeners:getListeners": { "description": "Plural Data Source schema for Volcengine::ALB::Listener\n", "outputs": { "description": "A collection of values returned by getListeners.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:alb/getLoadBalancer:getLoadBalancer": { "description": "Data Source schema for Volcengine::ALB::LoadBalancer\n", "inputs": { "description": "A collection of arguments for invoking getLoadBalancer.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getLoadBalancer.\n", "properties": { "addressIpVersion": { "description": "IP type of the ALB instance. IPv4: IPv4 type; DualStack: IPv4 \u0026 IPv6 dual stack type.\n", "type": "string" }, "bandwidthPackageId": { "description": "ID of the bound shared bandwidth package, enabling bandwidth sharing.\n", "type": "string" }, "businessStatus": { "description": "Service status of the ALB instance. Normal: normal; FinancialLocked: locked due to overdue payment.\n", "type": "string" }, "createTime": { "description": "Creation time of the ALB instance.\n", "type": "string" }, "deleteProtection": { "description": "Delete protection switch. on: enabled; off: disabled.\n", "type": "string" }, "deletedTime": { "description": "Expected reclamation time of the ALB instance. This parameter is only returned when the instance is in the FinancialLocked state.\n", "type": "string" }, "description": { "description": "Description of the ALB instance.\n", "type": "string" }, "dnsName": { "description": "DNS domain name.\n", "type": "string" }, "eipBillingConfig": { "$ref": "#/types/volcenginecc:alb/getLoadBalancerEipBillingConfig:getLoadBalancerEipBillingConfig", "description": "Billing configuration for public IP, only applicable to public instances.\n" }, "globalAccelerator": { "$ref": "#/types/volcenginecc:alb/getLoadBalancerGlobalAccelerator:getLoadBalancerGlobalAccelerator", "description": "Global accelerator configuration, used to improve cross-region access speed.\n" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipv6BandwidthPackageId": { "description": "When creating a public ALB instance, specify the shared bandwidth package ID to which the IPv6 public bandwidth will be added.\n", "type": "string" }, "ipv6EipBillingConfig": { "$ref": "#/types/volcenginecc:alb/getLoadBalancerIpv6EipBillingConfig:getLoadBalancerIpv6EipBillingConfig", "description": "Billing configuration for IPv6 public IP, only applicable to public instances.\n" }, "loadBalancerBillingType": { "description": "ALB instance billing type. Currently, only pay-as-you-go is supported (value is 1).\n", "type": "integer" }, "loadBalancerEdition": { "description": "Version of the application load balancer. Basic: Basic version; Standard: Standard version.\n", "type": "string" }, "loadBalancerId": { "description": "ALB instance ID.\n", "type": "string" }, "loadBalancerName": { "description": "Name of the ALB instance.\n", "type": "string" }, "lockReason": { "description": "Reason for ALB instance freeze, such as Financial (arrears) or Security (security reasons). Returned only when the instance is locked.\n", "type": "string" }, "modificationProtectionReason": { "description": "Reason for modification protection. This parameter is valid and legitimate only when ModificationProtectionStatus is ConsoleProtection.\n", "type": "string" }, "modificationProtectionStatus": { "description": "Modification protection status. NonProtection: Not protected; ConsoleProtection: Console modification protection, instance configuration cannot be modified through the console.\n", "type": "string" }, "overdueTime": { "description": "Freeze time of the ALB instance. This parameter is only returned when the instance is in the FinancialLocked state.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the instance belongs.\n", "type": "string" }, "proxyProtocolEnabled": { "description": "ALB supports the Proxy Protocol and records the client's real IP.\n", "type": "string" }, "status": { "description": "ALB instance status: Active (running), Provisioning (creating), Configuring (configuring), Deleting (deleting), CreateFailed (creation failed), Inactive (stopped).\n", "type": "string" }, "tags": { "description": "List of tags bound to the instance, used for categorization and billing.\n", "items": { "$ref": "#/types/volcenginecc:alb/getLoadBalancerTag:getLoadBalancerTag" }, "type": "array" }, "type": { "description": "Type of ALB instance. Values are public or private. public: Creates a public load balancer instance. The system assigns a public IP address and a private IP address, which can forward both public and private network requests. private: Creates a private load balancer instance. The system assigns a private IP address, used only for forwarding private network requests.\n", "type": "string" }, "updateTime": { "description": "Last update time of the ALB instance.\n", "type": "string" }, "vpcId": { "description": "ID of the Virtual Private Cloud (VPC) to which the load balancer instance belongs.\n", "type": "string" }, "wafInstanceId": { "description": "ID of the WAF security protection instance bound to the ALB instance.\n", "type": "string" }, "wafProtectedDomain": { "description": "Domain name protected by WAF, used for precise rule matching.\n", "type": "string" }, "wafProtectionEnabled": { "description": "WAF security protection switch. on: enabled; off: disabled.\n", "type": "string" }, "zoneMappings": { "description": "Availability zone mapping list, defines which availability zones the instance provides services in.\n", "items": { "$ref": "#/types/volcenginecc:alb/getLoadBalancerZoneMapping:getLoadBalancerZoneMapping" }, "type": "array" } }, "required": [ "addressIpVersion", "bandwidthPackageId", "businessStatus", "createTime", "deleteProtection", "deletedTime", "description", "dnsName", "eipBillingConfig", "globalAccelerator", "id", "ipv6BandwidthPackageId", "ipv6EipBillingConfig", "loadBalancerBillingType", "loadBalancerEdition", "loadBalancerId", "loadBalancerName", "lockReason", "modificationProtectionReason", "modificationProtectionStatus", "overdueTime", "projectName", "proxyProtocolEnabled", "status", "tags", "type", "updateTime", "vpcId", "wafInstanceId", "wafProtectedDomain", "wafProtectionEnabled", "zoneMappings" ], "type": "object" } }, "volcenginecc:alb/getLoadBalancers:getLoadBalancers": { "description": "Plural Data Source schema for Volcengine::ALB::LoadBalancer\n", "outputs": { "description": "A collection of values returned by getLoadBalancers.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:alb/getRule:getRule": { "description": "Data Source schema for Volcengine::ALB::Rule\n", "inputs": { "description": "A collection of arguments for invoking getRule.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRule.\n", "properties": { "description": { "description": "Forwarding rule description.\n", "type": "string" }, "domain": { "description": "Domain name of the forwarding rule.\n", "type": "string" }, "forwardGroupConfig": { "$ref": "#/types/volcenginecc:alb/getRuleForwardGroupConfig:getRuleForwardGroupConfig", "description": "Forwarding rule server group configuration.\n" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listenerId": { "description": "Listener ID.\n", "type": "string" }, "priority": { "description": "Standard edition forwarding rule priority.\n", "type": "integer" }, "redirectConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRedirectConfig:getRuleRedirectConfig", "description": "Redirect-related configuration information.\n" }, "rewriteConfig": { "$ref": "#/types/volcenginecc:alb/getRuleRewriteConfig:getRuleRewriteConfig", "description": "Redirect-related configuration information.\n" }, "rewriteEnabled": { "description": "Forwarding rule rewrite configuration switch. on: enabled. off: disabled.\n", "type": "string" }, "ruleAction": { "description": "Forwarding rule action. Empty: default forward to server group. Redirect: redirect.\n", "type": "string" }, "ruleActions": { "description": "Standard edition forwarding rule action.\n", "items": { "$ref": "#/types/volcenginecc:alb/getRuleRuleAction:getRuleRuleAction" }, "type": "array" }, "ruleConditions": { "description": "Standard edition forwarding rule condition.\n", "items": { "$ref": "#/types/volcenginecc:alb/getRuleRuleCondition:getRuleRuleCondition" }, "type": "array" }, "ruleId": { "description": "Forwarding rule ID.\n", "type": "string" }, "serverGroupId": { "description": "Backend server group ID associated with the forwarding rule.\n", "type": "string" }, "trafficLimitEnabled": { "description": "Forwarding rule QPS throttling switch. on: enabled. off: disabled.\n", "type": "string" }, "trafficLimitQps": { "description": "Requests per second. Range: 100–100000.\n", "type": "integer" }, "url": { "description": "Forwarding rule URL.\n", "type": "string" } }, "required": [ "description", "domain", "forwardGroupConfig", "id", "listenerId", "priority", "redirectConfig", "rewriteConfig", "rewriteEnabled", "ruleAction", "ruleActions", "ruleConditions", "ruleId", "serverGroupId", "trafficLimitEnabled", "trafficLimitQps", "url" ], "type": "object" } }, "volcenginecc:alb/getRules:getRules": { "description": "Plural Data Source schema for Volcengine::ALB::Rule\n", "outputs": { "description": "A collection of values returned by getRules.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:alb/getServerGroup:getServerGroup": { "description": "Data Source schema for Volcengine::ALB::ServerGroup\n", "inputs": { "description": "A collection of arguments for invoking getServerGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getServerGroup.\n", "properties": { "createTime": { "description": "Creation time of the backend server group.\n", "type": "string" }, "crossZoneEnabled": { "description": "Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.\n", "type": "string" }, "description": { "description": "Description of the backend server group.\n", "type": "string" }, "healthCheck": { "$ref": "#/types/volcenginecc:alb/getServerGroupHealthCheck:getServerGroupHealthCheck", "description": "Health check configuration information for the server group.\n" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAddressType": { "description": "IP address type of the server group. Currently, only IPv4 is supported.\n", "type": "string" }, "listeners": { "description": "Listener information associated with the backend server group.\n", "items": { "$ref": "#/types/volcenginecc:alb/getServerGroupListener:getServerGroupListener" }, "type": "array" }, "projectName": { "description": "Name of the project to which the backend server group belongs.\n", "type": "string" }, "protocol": { "description": "Backend protocol: HTTP, HTTPS.\n", "type": "string" }, "scheduler": { "description": "Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.\n", "type": "string" }, "serverCount": { "description": "Number of backend servers in the server group.\n", "type": "integer" }, "serverGroupId": { "description": "Backend server group ID.\n", "type": "string" }, "serverGroupName": { "description": "Backend server group name.\n", "type": "string" }, "serverGroupType": { "description": "Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.\n", "type": "string" }, "servers": { "description": "Information about the servers in the backend server group.\n", "items": { "$ref": "#/types/volcenginecc:alb/getServerGroupServer:getServerGroupServer" }, "type": "array" }, "status": { "description": "Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.\n", "type": "string" }, "stickySessionConfig": { "$ref": "#/types/volcenginecc:alb/getServerGroupStickySessionConfig:getServerGroupStickySessionConfig", "description": "Session persistence parameter information.\n" }, "tags": { "description": "Tag information.\n", "items": { "$ref": "#/types/volcenginecc:alb/getServerGroupTag:getServerGroupTag" }, "type": "array" }, "updateTime": { "description": "Last operation time of the backend server group.\n", "type": "string" }, "vpcId": { "description": "ID of the VPC to which the backend server group belongs.\n", "type": "string" } }, "required": [ "createTime", "crossZoneEnabled", "description", "healthCheck", "id", "ipAddressType", "listeners", "projectName", "protocol", "scheduler", "serverCount", "serverGroupId", "serverGroupName", "serverGroupType", "servers", "status", "stickySessionConfig", "tags", "updateTime", "vpcId" ], "type": "object" } }, "volcenginecc:alb/getServerGroups:getServerGroups": { "description": "Plural Data Source schema for Volcengine::ALB::ServerGroup\n", "outputs": { "description": "A collection of values returned by getServerGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:apig/getCustomDomain:getCustomDomain": { "description": "Data Source schema for Volcengine::APIG::CustomDomain\n", "inputs": { "description": "A collection of arguments for invoking getCustomDomain.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getCustomDomain.\n", "properties": { "certificateId": { "description": "Custom Domain Certificate ID\n", "type": "string" }, "comments": { "description": "Remarks\n", "type": "string" }, "createdTime": { "description": "Creation Time\n", "type": "string" }, "customDomainId": { "description": "Custom Domain ID\n", "type": "string" }, "domain": { "description": "Custom Domain\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "protocols": { "description": "Protocol. Values: HTTP, HTTPS\n", "items": { "type": "string" }, "type": "array" }, "serviceId": { "description": "Service ID\n", "type": "string" }, "sslRedirect": { "description": "Redirect to HTTPS\n", "type": "boolean" }, "status": { "description": "Status. Values: Creating: configuring; CreationFailed: configuration failed; Deleting: deleting; DeletionFailed: deletion failed; Verified: active\n", "type": "string" }, "updatedTime": { "description": "Update Time\n", "type": "string" } }, "required": [ "certificateId", "comments", "createdTime", "customDomainId", "domain", "id", "protocols", "serviceId", "sslRedirect", "status", "updatedTime" ], "type": "object" } }, "volcenginecc:apig/getCustomDomains:getCustomDomains": { "description": "Plural Data Source schema for Volcengine::APIG::CustomDomain\n", "outputs": { "description": "A collection of values returned by getCustomDomains.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:apig/getGateway:getGateway": { "description": "Data Source schema for Volcengine::APIG::Gateway\n", "inputs": { "description": "A collection of arguments for invoking getGateway.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getGateway.\n", "properties": { "backendSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayBackendSpec:getGatewayBackendSpec", "description": "Backend service configuration information\n" }, "comments": { "description": "Gateway remarks. Length limit: 0–253 characters.\n", "type": "string" }, "createdTime": { "description": "Gateway creation time\n", "type": "string" }, "customLog": { "$ref": "#/types/volcenginecc:apig/getGatewayCustomLog:getGatewayCustomLog", "description": "Custom log configuration\n" }, "events": { "description": "Event\n", "items": { "$ref": "#/types/volcenginecc:apig/getGatewayEvent:getGatewayEvent" }, "type": "array" }, "gatewayId": { "description": "Gateway instance ID\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "logSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayLogSpec:getGatewayLogSpec", "description": "Log configuration\n" }, "message": { "description": "Error message for gateway creation failure, deletion failure, or abnormal status\n", "type": "string" }, "monitorSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayMonitorSpec:getGatewayMonitorSpec", "description": "Monitoring configuration information\n" }, "name": { "description": "Gateway name\n", "type": "string" }, "networkSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayNetworkSpec:getGatewayNetworkSpec", "description": "Network configuration information\n" }, "projectName": { "description": "Project name\n", "type": "string" }, "resourceSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayResourceSpec:getGatewayResourceSpec", "description": "Resource specification configuration information\n" }, "status": { "description": "Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal\n", "type": "string" }, "subnetIds": { "description": "Subnet ID list. Length limit: 1–2\n", "items": { "type": "string" }, "type": "array" }, "traceSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayTraceSpec:getGatewayTraceSpec", "description": "Link tracing configuration information.\n" }, "type": { "description": "Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)\n", "type": "string" }, "version": { "description": "Gateway version.\n", "type": "string" }, "vpcId": { "description": "VPC ID。\n", "type": "string" } }, "required": [ "backendSpec", "comments", "createdTime", "customLog", "events", "gatewayId", "id", "logSpec", "message", "monitorSpec", "name", "networkSpec", "projectName", "resourceSpec", "status", "subnetIds", "traceSpec", "type", "version", "vpcId" ], "type": "object" } }, "volcenginecc:apig/getGatewayService:getGatewayService": { "description": "Data Source schema for Volcengine::APIG::GatewayService\n", "inputs": { "description": "A collection of arguments for invoking getGatewayService.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getGatewayService.\n", "properties": { "authSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayServiceAuthSpec:getGatewayServiceAuthSpec", "description": "Authentication configuration.\n" }, "comments": { "description": "Remarks. Length must be 0–253 characters.\n", "type": "string" }, "createdTime": { "description": "Creation time.\n", "type": "string" }, "customDomains": { "description": "Custom domain list.\n", "items": { "$ref": "#/types/volcenginecc:apig/getGatewayServiceCustomDomain:getGatewayServiceCustomDomain" }, "type": "array" }, "domainSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayServiceDomainSpec:getGatewayServiceDomainSpec", "description": "Domain details.\n" }, "domainType": { "description": "Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.\n", "type": "string" }, "domains": { "description": "Default domain.\n", "items": { "$ref": "#/types/volcenginecc:apig/getGatewayServiceDomain:getGatewayServiceDomain" }, "type": "array" }, "gatewayId": { "description": "Gateway ID.\n", "type": "string" }, "gatewayName": { "description": "Gateway name.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "message": { "description": "Error message for service creation failure, deletion failure, or abnormal status.\n", "type": "string" }, "protocols": { "description": "Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.\n", "items": { "type": "string" }, "type": "array" }, "serviceId": { "description": "Service ID.\n", "type": "string" }, "serviceName": { "description": "Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).\n", "type": "string" }, "serviceNetworkSpec": { "$ref": "#/types/volcenginecc:apig/getGatewayServiceServiceNetworkSpec:getGatewayServiceServiceNetworkSpec", "description": "Default domain network configuration..\n" }, "serviceType": { "description": "Service type. Options: AIProvider: AI model proxy.\n", "type": "string" }, "status": { "description": "Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.\n", "type": "string" } }, "required": [ "authSpec", "comments", "createdTime", "customDomains", "domainSpec", "domainType", "domains", "gatewayId", "gatewayName", "id", "message", "protocols", "serviceId", "serviceName", "serviceNetworkSpec", "serviceType", "status" ], "type": "object" } }, "volcenginecc:apig/getGatewayServices:getGatewayServices": { "description": "Plural Data Source schema for Volcengine::APIG::GatewayService\n", "outputs": { "description": "A collection of values returned by getGatewayServices.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:apig/getGateways:getGateways": { "description": "Plural Data Source schema for Volcengine::APIG::Gateway\n", "outputs": { "description": "A collection of values returned by getGateways.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:apig/getUpstream:getUpstream": { "description": "Data Source schema for Volcengine::APIG::Upstream\n", "inputs": { "description": "A collection of arguments for invoking getUpstream.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getUpstream.\n", "properties": { "backendTargets": { "description": "Backend node. Not valid when the upstream source type is VeFaas\n", "items": { "$ref": "#/types/volcenginecc:apig/getUpstreamBackendTarget:getUpstreamBackendTarget" }, "type": "array" }, "circuitBreakingSettings": { "$ref": "#/types/volcenginecc:apig/getUpstreamCircuitBreakingSettings:getUpstreamCircuitBreakingSettings", "description": "Service circuit breaking configuration\n" }, "comments": { "description": "Remarks\n", "type": "string" }, "connectionPoolSettings": { "$ref": "#/types/volcenginecc:apig/getUpstreamConnectionPoolSettings:getUpstreamConnectionPoolSettings", "description": "Connection Pool Configuration\n" }, "createdTime": { "description": "Upstream creation time\n", "type": "string" }, "gatewayId": { "description": "Gateway Instance ID\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "loadBalancerSettings": { "$ref": "#/types/volcenginecc:apig/getUpstreamLoadBalancerSettings:getUpstreamLoadBalancerSettings", "description": "Load Balancing Configuration\n" }, "name": { "description": "Upstream name\n", "type": "string" }, "protocol": { "description": "Protocol. Options: HTTP: HTTP/1.1; HTTP2: HTTP/2; GRPC: GRPC\n", "type": "string" }, "sourceType": { "description": "Upstream source type. Options: VeFaas: function service. ECS: cloud server. K8S: container service. Nacos: registry. AIProvider: AI model proxy\n", "type": "string" }, "tlsSettings": { "$ref": "#/types/volcenginecc:apig/getUpstreamTlsSettings:getUpstreamTlsSettings", "description": "TLS Configuration\n" }, "updatedTime": { "description": "Upstream update time\n", "type": "string" }, "upstreamId": { "description": "Upstream ID。\n", "type": "string" }, "upstreamSpec": { "$ref": "#/types/volcenginecc:apig/getUpstreamUpstreamSpec:getUpstreamUpstreamSpec", "description": "Upstream Configuration\n" }, "versionDetails": { "description": "Upstream version, only valid when the upstream source type is K8S\n", "items": { "$ref": "#/types/volcenginecc:apig/getUpstreamVersionDetail:getUpstreamVersionDetail" }, "type": "array" } }, "required": [ "backendTargets", "circuitBreakingSettings", "comments", "connectionPoolSettings", "createdTime", "gatewayId", "id", "loadBalancerSettings", "name", "protocol", "sourceType", "tlsSettings", "updatedTime", "upstreamId", "upstreamSpec", "versionDetails" ], "type": "object" } }, "volcenginecc:apig/getUpstreamSource:getUpstreamSource": { "description": "Data Source schema for Volcengine::APIG::UpstreamSource\n", "inputs": { "description": "A collection of arguments for invoking getUpstreamSource.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getUpstreamSource.\n", "properties": { "comments": { "description": "Remarks, length limit: 0–253 characters\n", "type": "string" }, "createdTime": { "description": "Creation time\n", "type": "string" }, "gatewayId": { "description": "Gateway instance ID\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ingressSettings": { "$ref": "#/types/volcenginecc:apig/getUpstreamSourceIngressSettings:getUpstreamSourceIngressSettings", "description": "Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type\n" }, "sourceSpec": { "$ref": "#/types/volcenginecc:apig/getUpstreamSourceSourceSpec:getUpstreamSourceSourceSpec", "description": "Upstream source configuration\n" }, "sourceType": { "description": "Upstream source type. Options: K8S: Container cluster. Nacos: Registry\n", "type": "string" }, "status": { "description": "Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed\n", "type": "string" }, "statusMessage": { "description": "Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster\n", "type": "string" }, "updatedTime": { "description": "Update time\n", "type": "string" }, "upstreamSourceId": { "description": "Upstream source ID\n", "type": "string" }, "watchNamespaces": { "description": "Specify namespace\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "comments", "createdTime", "gatewayId", "id", "ingressSettings", "sourceSpec", "sourceType", "status", "statusMessage", "updatedTime", "upstreamSourceId", "watchNamespaces" ], "type": "object" } }, "volcenginecc:apig/getUpstreamSources:getUpstreamSources": { "description": "Plural Data Source schema for Volcengine::APIG::UpstreamSource\n", "outputs": { "description": "A collection of values returned by getUpstreamSources.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:apig/getUpstreams:getUpstreams": { "description": "Plural Data Source schema for Volcengine::APIG::Upstream\n", "outputs": { "description": "A collection of values returned by getUpstreams.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ark/getEndpoint:getEndpoint": { "description": "Data Source schema for Volcengine::ARK::Endpoint\n", "inputs": { "description": "A collection of arguments for invoking getEndpoint.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getEndpoint.\n", "properties": { "batchOnly": { "description": "Whether only BatchChat is supported. If true, only batch inference interfaces can be accessed; otherwise, only online inference interfaces can be accessed\n", "type": "boolean" }, "certificate": { "$ref": "#/types/volcenginecc:ark/getEndpointCertificate:getEndpointCertificate", "description": "Certificate information\n" }, "createTime": { "description": "Endpoint creation time, RFC3339 format\n", "type": "string" }, "description": { "description": "Endpoint description\n", "type": "string" }, "endpointId": { "description": "Inference access point ID.\n", "type": "string" }, "endpointModelType": { "description": "Access point model type. Options: FoundationModel for base model; CustomModel for custom model.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "modelReference": { "$ref": "#/types/volcenginecc:ark/getEndpointModelReference:getEndpointModelReference", "description": "Endpoint access model\n" }, "modelUnitId": { "description": "Model unit. If empty, indicates postpaid; otherwise, prepaid.\n", "type": "string" }, "moderation": { "$ref": "#/types/volcenginecc:ark/getEndpointModeration:getEndpointModeration", "description": "Content guardrail scheme\n" }, "name": { "description": "Endpoint name\n", "type": "string" }, "projectName": { "description": "Project name the resource belongs to; default value is \"default\"\n", "type": "string" }, "rateLimit": { "$ref": "#/types/volcenginecc:ark/getEndpointRateLimit:getEndpointRateLimit", "description": "Endpoint rate limiting\n" }, "rollingId": { "description": "Endpoint switch ID\n", "type": "string" }, "scaleTierId": { "description": "If a TPM protection package exists, this is the TPM protection package ID.\n", "type": "string" }, "status": { "description": "Endpoint status\n", "type": "string" }, "statusReason": { "description": "Additional status information\n", "type": "string" }, "supportRolling": { "description": "Whether endpoint supports switching model versions\n", "type": "boolean" }, "supportScaleTier": { "description": "Whether TPM protection package is supported\n", "type": "boolean" }, "tags": { "description": "Tags bound to the endpoint\n", "items": { "$ref": "#/types/volcenginecc:ark/getEndpointTag:getEndpointTag" }, "type": "array" }, "updateTime": { "description": "Endpoint update time, RFC3339 format\n", "type": "string" } }, "required": [ "batchOnly", "certificate", "createTime", "description", "endpointId", "endpointModelType", "id", "modelReference", "modelUnitId", "moderation", "name", "projectName", "rateLimit", "rollingId", "scaleTierId", "status", "statusReason", "supportRolling", "supportScaleTier", "tags", "updateTime" ], "type": "object" } }, "volcenginecc:ark/getEndpoints:getEndpoints": { "description": "Plural Data Source schema for Volcengine::ARK::Endpoint\n", "outputs": { "description": "A collection of values returned by getEndpoints.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:autoscaling/getScalingConfiguration:getScalingConfiguration": { "description": "Data Source schema for Volcengine::AutoScaling::ScalingConfiguration\n", "inputs": { "description": "A collection of arguments for invoking getScalingConfiguration.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getScalingConfiguration.\n", "properties": { "createdAt": { "description": "Resource creation time (UTC)\n", "type": "string" }, "eip": { "$ref": "#/types/volcenginecc:autoscaling/getScalingConfigurationEip:getScalingConfigurationEip", "description": "Public IP.\n" }, "hostName": { "description": "Instance hostname. Value: Linux instances allow periods to separate segments; each segment can contain letters, digits, or hyphens '-'. Cannot start or end with a period '.' or hyphen '-', and periods or hyphens cannot be used consecutively. Linux hostnames must be 2–63 characters long. Windows instances allow letters, digits, or hyphens '-', but cannot be entirely numeric. Cannot start or end with a hyphen '-', and hyphens cannot be used consecutively. Windows hostnames must be 2–15 characters long. If not specified, the hostname is automatically generated as follows: Structure: iv - + initial hostname, for example iv-3tigy72q3u3vj0******. Created instances retain the original hostname generation logic and do not change upon instance restart. Initial hostname generation logic: Linux: extracts all characters after instance ID 'i-'. Windows: extracts the last 12 characters after instance ID 'i-'\n", "type": "string" }, "hpcClusterId": { "description": "ID of the high-performance computing cluster to which the instance belongs. Only valid when InstanceTypes.N is specified as 'High-Performance Computing GPU'.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "imageId": { "description": "Image ID. The image resource used when the scaling group automatically creates an instance\n", "type": "string" }, "instanceChargeType": { "description": "Instance billing type. Values: PrePaid (subscription) / PostPaid (pay-as-you-go)\n", "type": "string" }, "instanceDescription": { "description": "Instance description. Value: Cannot start with a digit or hyphen. Only Chinese characters, letters, digits, underscores, and hyphens are allowed. Length must be between 0 and 255 characters. If not specified, defaults to an empty string\n", "type": "string" }, "instanceName": { "description": "Instance name. Rules: Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscore \"_\", hyphen \"-\", and period \".\". Length: 1–128 characters.\n", "type": "string" }, "instanceTypeOverrides": { "description": "Specification information for preemptible instances\n", "items": { "$ref": "#/types/volcenginecc:autoscaling/getScalingConfigurationInstanceTypeOverride:getScalingConfigurationInstanceTypeOverride" }, "type": "array" }, "instanceTypes": { "description": "List of compute specifications for the instance\n", "items": { "type": "string" }, "type": "array" }, "ipv6AddressCount": { "description": "Assign an IPv6 address to the instance NIC. Values: 0: Do not assign an IPv6 address. 1: Assign an IPv6 address; the system automatically allocates an IPv6 subnet for you.\n", "type": "integer" }, "keyPairName": { "description": "Name of the key pair. If both KeyPairName and Password are set, only KeyPairName takes effect\n", "type": "string" }, "lifecycleState": { "description": "Lifecycle status. Values: Active (active) / InActive (inactive)\n", "type": "string" }, "password": { "description": "When logging in to the instance using the 'Password' method, set the root login password: The password must be 8–30 characters long and consist of uppercase letters, lowercase letters, numbers, and special characters. At least three types must be included. Allowed special characters: `~!#$%^\u0026*()_-+= |. The password cannot start with '/' or '$6$'\n", "type": "string" }, "projectName": { "description": "The project to which the instance created by the scaling configuration belongs. Default is empty. Each resource can belong to only one project.\nOnly letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed.\nMaximum length: 64 characters\n", "type": "string" }, "scalingConfigurationId": { "description": "Scaling configuration ID\n", "type": "string" }, "scalingConfigurationName": { "description": "Name of the scaling configuration. The name must be unique within the same scaling group in the same region. Rules: Must start with a Chinese character or letter. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length: 1–128 characters. Special characters are not supported.\n", "type": "string" }, "scalingGroupId": { "description": "Scaling group ID to which the scaling configuration belongs\n", "type": "string" }, "securityEnhancementStrategy": { "description": "Enable security hardening. Options: Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images.\n", "type": "string" }, "securityGroupIds": { "description": "Security group ID associated with the instance's primary network interface\n", "items": { "type": "string" }, "type": "array" }, "spotStrategy": { "description": "Instance preemption policy. Values: NoSpot (default): creates a standard pay-as-you-go instance. SpotAsPriceGo: system automatically bids, creating a preemptible instance that follows the current market price. SpotWithPriceLimit: creates a preemptible instance with a specified bid limit\n", "type": "string" }, "tags": { "description": "Tag key-value pairs\n", "items": { "$ref": "#/types/volcenginecc:autoscaling/getScalingConfigurationTag:getScalingConfigurationTag" }, "type": "array" }, "updatedAt": { "description": "Resource update time (UTC)\n", "type": "string" }, "userData": { "description": "Instance custom data. Custom data must be Base64 encoded, and the size before encoding must not exceed 16 KB. If not specified, defaults to empty\n", "type": "string" }, "volumes": { "description": "Cloud disk\n", "items": { "$ref": "#/types/volcenginecc:autoscaling/getScalingConfigurationVolume:getScalingConfigurationVolume" }, "type": "array" }, "zoneId": { "description": "Availability zone ID for the scaling configuration\n", "type": "string" } }, "required": [ "createdAt", "eip", "hostName", "hpcClusterId", "id", "imageId", "instanceChargeType", "instanceDescription", "instanceName", "instanceTypeOverrides", "instanceTypes", "ipv6AddressCount", "keyPairName", "lifecycleState", "password", "projectName", "scalingConfigurationId", "scalingConfigurationName", "scalingGroupId", "securityEnhancementStrategy", "securityGroupIds", "spotStrategy", "tags", "updatedAt", "userData", "volumes", "zoneId" ], "type": "object" } }, "volcenginecc:autoscaling/getScalingConfigurations:getScalingConfigurations": { "description": "Plural Data Source schema for Volcengine::AutoScaling::ScalingConfiguration\n", "outputs": { "description": "A collection of values returned by getScalingConfigurations.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:autoscaling/getScalingGroup:getScalingGroup": { "description": "Data Source schema for Volcengine::AutoScaling::ScalingGroup\n", "inputs": { "description": "A collection of arguments for invoking getScalingGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getScalingGroup.\n", "properties": { "activeScalingConfigurationId": { "description": "ID of the scaling configuration bound to the scaling group\n", "type": "string" }, "createdTime": { "description": "Scaling group creation time\n", "type": "string" }, "dbInstanceIds": { "description": "ID of the RDS database instance.\n", "items": { "type": "string" }, "type": "array" }, "defaultCooldown": { "description": "Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.\n", "type": "integer" }, "desireInstanceNumber": { "description": "Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.\n", "type": "integer" }, "healthCheckType": { "description": "Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceRemovePolicies": { "description": "Instance removal policy\n", "items": { "$ref": "#/types/volcenginecc:autoscaling/getScalingGroupInstanceRemovePolicy:getScalingGroupInstanceRemovePolicy" }, "type": "array" }, "instanceTerminatePolicy": { "description": "Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.\n", "type": "string" }, "instances": { "description": "Collection of instance subresources managed manually within the scaling group (Attach / Detach / Remove)\n", "items": { "$ref": "#/types/volcenginecc:autoscaling/getScalingGroupInstance:getScalingGroupInstance" }, "type": "array" }, "instancesDistribution": { "$ref": "#/types/volcenginecc:autoscaling/getScalingGroupInstancesDistribution:getScalingGroupInstancesDistribution", "description": "Instance distribution policy.\n" }, "isEnableScalingGroup": { "description": "Whether to enable the scaling group. true: enabled. false: stopped\n", "type": "boolean" }, "launchTemplateId": { "description": "Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.\n", "type": "string" }, "launchTemplateOverrides": { "description": "Instance launch template information\n", "items": { "$ref": "#/types/volcenginecc:autoscaling/getScalingGroupLaunchTemplateOverride:getScalingGroupLaunchTemplateOverride" }, "type": "array" }, "launchTemplateVersion": { "description": "Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.\n", "type": "string" }, "lifecycleState": { "description": "Status of the scaling group. Active: enabled. InActive: not activated. Deleting: deleting. Locked: locked. CoolingDown: cooling down. Unknown: unknown status.\n", "type": "string" }, "loadBalancerHealthCheckGracePeriod": { "description": "Grace period for CLB health checks on scaling group instances\n", "type": "integer" }, "maxInstanceNumber": { "description": "Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.\n", "type": "integer" }, "minInstanceNumber": { "description": "Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.\n", "type": "integer" }, "multiAzPolicy": { "description": "Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.\n", "type": "string" }, "projectName": { "description": "Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.\n", "type": "string" }, "scalingGroupId": { "description": "Scaling group ID.\n", "type": "string" }, "scalingGroupName": { "description": "Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.\n", "type": "string" }, "scalingMode": { "description": "Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.\n", "type": "string" }, "serverGroupAttributes": { "description": "Load balancer information associated with the scaling group.\n", "items": { "$ref": "#/types/volcenginecc:autoscaling/getScalingGroupServerGroupAttribute:getScalingGroupServerGroupAttribute" }, "type": "array" }, "stoppedInstanceCount": { "description": "Number of instances in the scaling group that are in the disabled state.\n", "type": "integer" }, "subnetIds": { "description": "List of subnet IDs for the primary network interface of instances in the scaling group\n", "items": { "type": "string" }, "type": "array" }, "suspendedProcesses": { "description": "Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.\n", "items": { "type": "string" }, "type": "array" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:autoscaling/getScalingGroupTag:getScalingGroupTag" }, "type": "array" }, "totalInstanceCount": { "description": "Number of instances currently in the scaling group\n", "type": "integer" }, "updatedTime": { "description": "Scaling group update time.\n", "type": "string" }, "vpcId": { "description": "VPC ID to which the scaling group belongs\n", "type": "string" } }, "required": [ "activeScalingConfigurationId", "createdTime", "dbInstanceIds", "defaultCooldown", "desireInstanceNumber", "healthCheckType", "id", "instanceRemovePolicies", "instanceTerminatePolicy", "instances", "instancesDistribution", "isEnableScalingGroup", "launchTemplateId", "launchTemplateOverrides", "launchTemplateVersion", "lifecycleState", "loadBalancerHealthCheckGracePeriod", "maxInstanceNumber", "minInstanceNumber", "multiAzPolicy", "projectName", "scalingGroupId", "scalingGroupName", "scalingMode", "serverGroupAttributes", "stoppedInstanceCount", "subnetIds", "suspendedProcesses", "tags", "totalInstanceCount", "updatedTime", "vpcId" ], "type": "object" } }, "volcenginecc:autoscaling/getScalingGroups:getScalingGroups": { "description": "Plural Data Source schema for Volcengine::AutoScaling::ScalingGroup\n", "outputs": { "description": "A collection of values returned by getScalingGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:autoscaling/getScalingLifecycleHook:getScalingLifecycleHook": { "description": "Data Source schema for Volcengine::AutoScaling::ScalingLifecycleHook\n", "inputs": { "description": "A collection of arguments for invoking getScalingLifecycleHook.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getScalingLifecycleHook.\n", "properties": { "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lifecycleCommand": { "$ref": "#/types/volcenginecc:autoscaling/getScalingLifecycleHookLifecycleCommand:getScalingLifecycleHookLifecycleCommand", "description": "Cloud Assistant command information.\n" }, "lifecycleHookId": { "description": "Lifecycle hook ID.\n", "type": "string" }, "lifecycleHookName": { "description": "Lifecycle hook name, cannot be modified after creation. Values: Cannot start with a digit, hyphen, or underscore. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.\n", "type": "string" }, "lifecycleHookPolicy": { "description": "Policy executed after the instance suspension ends. Values: CONTINUE: Continue execution. REJECT: Abort subsequent actions. ROLLBACK: For elastic scale-in activities, the release of ECS instances is rejected and rollback is performed; for elastic scale-out activities, the effect is the same as REJECT.\n", "type": "string" }, "lifecycleHookTimeout": { "description": "Duration for which the ECS instance remains suspended. After timeout, the suspended state ends automatically and scaling actions continue according to the execution policy. Please evaluate the processing time for custom operations and set an appropriate timeout. Values: 30 to 21600 (6 hours), unit: s, must be an integer.\n", "type": "integer" }, "lifecycleHookType": { "description": "Type of scaling activity. When a specified type of scaling activity occurs, the lifecycle hook is triggered and the ECS instance is suspended. Values: SCALE*IN: Elastic scale-in activity. SCALE*OUT: Elastic scale-out activity.\n", "type": "string" }, "scalingGroupId": { "description": "Scaling group ID.\n", "type": "string" } }, "required": [ "id", "lifecycleCommand", "lifecycleHookId", "lifecycleHookName", "lifecycleHookPolicy", "lifecycleHookTimeout", "lifecycleHookType", "scalingGroupId" ], "type": "object" } }, "volcenginecc:autoscaling/getScalingLifecycleHooks:getScalingLifecycleHooks": { "description": "Plural Data Source schema for Volcengine::AutoScaling::ScalingLifecycleHook\n", "outputs": { "description": "A collection of values returned by getScalingLifecycleHooks.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:autoscaling/getScalingPolicies:getScalingPolicies": { "description": "Plural Data Source schema for Volcengine::AutoScaling::ScalingPolicy\n", "outputs": { "description": "A collection of values returned by getScalingPolicies.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:autoscaling/getScalingPolicy:getScalingPolicy": { "description": "Data Source schema for Volcengine::AutoScaling::ScalingPolicy\n", "inputs": { "description": "A collection of arguments for invoking getScalingPolicy.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getScalingPolicy.\n", "properties": { "adjustmentType": { "description": "Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.\n", "type": "string" }, "adjustmentValue": { "description": "Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.\n", "type": "integer" }, "alarmPolicy": { "$ref": "#/types/volcenginecc:autoscaling/getScalingPolicyAlarmPolicy:getScalingPolicyAlarmPolicy", "description": "Detailed information about the alarm task.\n" }, "cooldown": { "description": "Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "isEnabledPolicy": { "description": "Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.\n", "type": "boolean" }, "scalingGroupId": { "description": "Scaling group ID.\n", "type": "string" }, "scalingPolicyId": { "description": "Scaling rule ID.\n", "type": "string" }, "scalingPolicyName": { "description": "Name of the scaling rule.\n", "type": "string" }, "scalingPolicyType": { "description": "Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.\n", "type": "string" }, "scheduledPolicy": { "$ref": "#/types/volcenginecc:autoscaling/getScalingPolicyScheduledPolicy:getScalingPolicyScheduledPolicy", "description": "Detailed information for scheduled/recurring tasks.\n" }, "status": { "description": "Status of the scaling rule. Options: Active: enabled. Inactive: disabled. The scaling group must be in Active status.\n", "type": "string" } }, "required": [ "adjustmentType", "adjustmentValue", "alarmPolicy", "cooldown", "id", "isEnabledPolicy", "scalingGroupId", "scalingPolicyId", "scalingPolicyName", "scalingPolicyType", "scheduledPolicy", "status" ], "type": "object" } }, "volcenginecc:bmq/getGroup:getGroup": { "description": "Data Source schema for Volcengine::BMQ::Group\n", "inputs": { "description": "A collection of arguments for invoking getGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getGroup.\n", "properties": { "createdTime": { "description": "Consumer Group creation time\n", "type": "string" }, "description": { "description": "Consumer Group description\n", "type": "string" }, "groupId": { "description": "Consumer Group ID\n", "type": "string" }, "groupName": { "description": "Set a custom Consumer Group name. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "BMQ instance ID\n", "type": "string" }, "ownerId": { "description": "User ID of the Consumer Group owner\n", "type": "string" }, "ownerName": { "description": "Name of the Consumer Group owner\n", "type": "string" }, "resetInfo": { "$ref": "#/types/volcenginecc:bmq/getGroupResetInfo:getGroupResetInfo", "description": "Reset consumption offset information\n" }, "status": { "description": "Consumer Group status\n", "type": "string" }, "topicInfos": { "description": "Topic list\n", "items": { "$ref": "#/types/volcenginecc:bmq/getGroupTopicInfo:getGroupTopicInfo" }, "type": "array" } }, "required": [ "createdTime", "description", "groupId", "groupName", "id", "instanceId", "ownerId", "ownerName", "resetInfo", "status", "topicInfos" ], "type": "object" } }, "volcenginecc:bmq/getGroups:getGroups": { "description": "Plural Data Source schema for Volcengine::BMQ::Group\n", "outputs": { "description": "A collection of values returned by getGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:bmq/getInstance:getInstance": { "description": "Data Source schema for Volcengine::BMQ::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "autoRenew": { "description": "Enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal.\n", "type": "string" }, "billingPeriod": { "description": "Unit of purchase duration. Options: MONTHLY—monthly subscription; YEARLY—yearly subscription\n", "type": "string" }, "billingType": { "description": "Instance billing method. Options: POST—pay-as-you-go; MIX—yearly/monthly subscription\n", "type": "string" }, "createdTime": { "description": "Instance creation time\n", "type": "string" }, "description": { "description": "Instance description\n", "type": "string" }, "eipId": { "description": "Whether public access is enabled for the instance. If public access is required, configure the ID of a public IP in the same region\n", "type": "string" }, "endpoints": { "$ref": "#/types/volcenginecc:bmq/getInstanceEndpoints:getInstanceEndpoints", "description": "Response data for all instance endpoints\n" }, "expirationTime": { "description": "Instance expiration time\n", "type": "string" }, "groupLimit": { "description": "Maximum number of consumer groups per instance\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "messageRetention": { "description": "Message retention period for all Topics under the instance, in hours\n", "type": "integer" }, "name": { "description": "Custom BMQ instance name. Constraints: must consist of lowercase letters, numbers, and hyphens (-). Length: 1–64 characters\n", "type": "string" }, "partitionLimit": { "description": "Maximum number of partitions per instance\n", "type": "integer" }, "projectName": { "description": "Project name associated with the instance\n", "type": "string" }, "resourceTags": { "description": "Instance resource tag list\n", "items": { "$ref": "#/types/volcenginecc:bmq/getInstanceResourceTag:getInstanceResourceTag" }, "type": "array" }, "resources": { "$ref": "#/types/volcenginecc:bmq/getInstanceResources:getInstanceResources", "description": "Instance resource statistics response data\n" }, "securityGroupIdLists": { "description": "Security group list used by the instance\n", "items": { "type": "string" }, "type": "array" }, "specification": { "description": "Instance specification\n", "type": "string" }, "status": { "description": "Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATION*FAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFY*FAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITY*EXPAXION*FAILED: Capacity expansion failed, EXPANDING*CAPACITY: Expanding capacity, CANCEL*EXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid\n", "type": "string" }, "subnetIdLists": { "description": "Subnet list used by the instance\n", "items": { "type": "string" }, "type": "array" }, "tags": { "description": "Instance resource tag list\n", "items": { "$ref": "#/types/volcenginecc:bmq/getInstanceTag:getInstanceTag" }, "type": "array" }, "times": { "description": "Purchase duration for yearly/monthly subscription instances, in months\n", "type": "integer" }, "topicLimit": { "description": "Maximum number of Topics per instance\n", "type": "integer" }, "vpcId": { "description": "VPC ID where the instance is located\n", "type": "string" }, "zoneIdLists": { "description": "List of availability zones for the instance\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "autoRenew", "billingPeriod", "billingType", "createdTime", "description", "eipId", "endpoints", "expirationTime", "groupLimit", "id", "instanceId", "messageRetention", "name", "partitionLimit", "projectName", "resourceTags", "resources", "securityGroupIdLists", "specification", "status", "subnetIdLists", "tags", "times", "topicLimit", "vpcId", "zoneIdLists" ], "type": "object" } }, "volcenginecc:bmq/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::BMQ::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cbr/getBackupPlan:getBackupPlan": { "description": "Data Source schema for Volcengine::CBR::BackupPlan\n", "inputs": { "description": "A collection of arguments for invoking getBackupPlan.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBackupPlan.\n", "properties": { "accountId": { "description": "Account ID that created this plan\n", "type": "string" }, "createdTime": { "description": "Creation Time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "name": { "description": "Backup Plan Name\n", "type": "string" }, "planId": { "description": "Backup Plan ID\n", "type": "string" }, "policy": { "$ref": "#/types/volcenginecc:cbr/getBackupPlanPolicy:getBackupPlanPolicy", "description": "Backup Policy\n" }, "policyId": { "description": "Backup Policy ID\n", "type": "string" }, "resourceLists": { "description": "Backup Source List\n", "items": { "$ref": "#/types/volcenginecc:cbr/getBackupPlanResourceList:getBackupPlanResourceList" }, "type": "array" }, "updatedTime": { "description": "Update Time\n", "type": "string" } }, "required": [ "accountId", "createdTime", "id", "name", "planId", "policy", "policyId", "resourceLists", "updatedTime" ], "type": "object" } }, "volcenginecc:cbr/getBackupPlans:getBackupPlans": { "description": "Plural Data Source schema for Volcengine::CBR::BackupPlan\n", "outputs": { "description": "A collection of values returned by getBackupPlans.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cbr/getBackupPolicies:getBackupPolicies": { "description": "Plural Data Source schema for Volcengine::CBR::BackupPolicy\n", "outputs": { "description": "A collection of values returned by getBackupPolicies.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cbr/getBackupPolicy:getBackupPolicy": { "description": "Data Source schema for Volcengine::CBR::BackupPolicy\n", "inputs": { "description": "A collection of arguments for invoking getBackupPolicy.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBackupPolicy.\n", "properties": { "accountId": { "description": "Account ID that created this policy\n", "type": "string" }, "backupType": { "description": "Backup type. Values are as follows: FULL: full backup; INCREMENTAL: incremental backup\n", "type": "string" }, "createdTime": { "description": "Creation time\n", "type": "string" }, "crontab": { "description": "Backup cycle, using a crontab expression\n", "type": "string" }, "enablePolicy": { "description": "Whether the policy is enabled. Values are as follows: true: policy enabled; false: policy disabled\n", "type": "boolean" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "name": { "description": "Policy Name\n", "type": "string" }, "planNumber": { "description": "Number of backup plans associated with this policy\n", "type": "integer" }, "policyId": { "description": "Backup Policy ID\n", "type": "string" }, "retentionDay": { "description": "Restore point retention period. -1 means retain indefinitely. Other valid values range from [1, 999999]\n", "type": "integer" }, "retentionNumMax": { "description": "Maximum number of restore points retained\n", "type": "integer" }, "retentionNumMin": { "description": "Minimum restore point retention limit\n", "type": "integer" }, "updatedTime": { "description": "Update time\n", "type": "string" } }, "required": [ "accountId", "backupType", "createdTime", "crontab", "enablePolicy", "id", "name", "planNumber", "policyId", "retentionDay", "retentionNumMax", "retentionNumMin", "updatedTime" ], "type": "object" } }, "volcenginecc:cbr/getBackupResource:getBackupResource": { "description": "Data Source schema for Volcengine::CBR::BackupResource\n", "inputs": { "description": "A collection of arguments for invoking getBackupResource.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBackupResource.\n", "properties": { "accountId": { "description": "Account ID that created this backup source\n", "type": "string" }, "createdTime": { "description": "Creation Time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "instanceName": { "description": "Instance Name\n", "type": "string" }, "metaInformation": { "$ref": "#/types/volcenginecc:cbr/getBackupResourceMetaInformation:getBackupResourceMetaInformation", "description": "Resource meta information (used to store additional configuration when creating a backup plan). ECS full backup parameters: see the EcsBackupConfiguration structure. vePFS backup parameters: see the VePFSBackupConfiguration structure.\n" }, "plans": { "description": "List of Associated Backup Plans\n", "items": { "$ref": "#/types/volcenginecc:cbr/getBackupResourcePlan:getBackupResourcePlan" }, "type": "array" }, "recoveryPointNumber": { "description": "Number of Restore Points\n", "type": "integer" }, "resourceId": { "description": "Backup Source ID\n", "type": "string" }, "resourceType": { "description": "Backup source type. Value description: ECS: ECS full instance. vePFS: vePFS file system.\n", "type": "string" }, "status": { "description": "Backup source status. Possible values: AVAILABLE, REMOVING, BEING*BACKED*UP, RECOVERING, CREATING, ERROR, UNAVAILABLE.\n", "type": "string" }, "updatedTime": { "description": "Update Time\n", "type": "string" }, "usedCapacityInBytes": { "description": "Bytes Already Backed Up\n", "type": "integer" } }, "required": [ "accountId", "createdTime", "id", "instanceId", "instanceName", "metaInformation", "plans", "recoveryPointNumber", "resourceId", "resourceType", "status", "updatedTime", "usedCapacityInBytes" ], "type": "object" } }, "volcenginecc:cbr/getBackupResources:getBackupResources": { "description": "Plural Data Source schema for Volcengine::CBR::BackupResource\n", "outputs": { "description": "A collection of values returned by getBackupResources.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cbr/getVault:getVault": { "description": "Data Source schema for Volcengine::CBR::Vault\n", "inputs": { "description": "A collection of arguments for invoking getVault.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getVault.\n", "properties": { "createdTime": { "description": "Creation Time\n", "type": "string" }, "endpoint": { "description": "Access Domain Name\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "projectName": { "description": "Project Name\n", "type": "string" }, "tags": { "description": "Backup Repository Tag\n", "items": { "$ref": "#/types/volcenginecc:cbr/getVaultTag:getVaultTag" }, "type": "array" }, "vaultId": { "description": "Backup Repository ID\n", "type": "string" }, "vaultName": { "description": "Backup Repository Name\n", "type": "string" } }, "required": [ "createdTime", "endpoint", "id", "projectName", "tags", "vaultId", "vaultName" ], "type": "object" } }, "volcenginecc:cbr/getVaults:getVaults": { "description": "Plural Data Source schema for Volcengine::CBR::Vault\n", "outputs": { "description": "A collection of values returned by getVaults.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cdn/getDomain:getDomain": { "description": "Data Source schema for Volcengine::CDN::Domain\n", "inputs": { "description": "A collection of arguments for invoking getDomain.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDomain.\n", "properties": { "areaAccessRule": { "$ref": "#/types/volcenginecc:cdn/getDomainAreaAccessRule:getDomainAreaAccessRule", "description": "Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.\n" }, "backupOrigins": { "description": "Indicates the backup origin server list configured for this domain. If no backup origin server is configured for this domain, the parameter value is null.\n", "items": { "type": "string" }, "type": "array" }, "browserCaches": { "description": "Indicates the configuration module for the 'browser cache' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rule at the top of the list has the highest priority. If you create multiple rules, pay attention to whether there are containment relationships between rules. If containment exists, rules with a broader scope should appear after those with a narrower scope.\n", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainBrowserCach:getDomainBrowserCach" }, "type": "array" }, "cacheHost": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheHost:getDomainCacheHost", "description": "Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.\n" }, "cacheKeys": { "description": "Indicates the configuration module for the 'cache key' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache key rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rules in the list have the highest priority. If you create multiple rules, pay attention to whether there is any inclusion relationship between rules. If inclusion exists, rules with a broader scope should appear after those with a narrower scope.\n", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCacheKey:getDomainCacheKey" }, "type": "array" }, "cacheShared": { "description": "Indicates the role of this domain in the 'shared cache' configuration. The parameter has the following values: target*host: indicates the 'target domain'. cache*shared_on: indicates the 'configured domain'. If this domain is not included in any 'shared cache' configuration, the parameter value is an empty string ('').\n", "type": "string" }, "cacheSharedTargetHost": { "description": "If CacheShared is cache*shared*on, this parameter indicates the 'Target Domain' in the 'Shared Cache' configuration for this domain name. If CacheShared is target_host, this parameter is empty (\"\").\n", "type": "string" }, "caches": { "description": "Represents the configuration module for the 'Cache Rule' feature. This feature is disabled by default, meaning no custom rules are created. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The filter in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope.\n", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainCach:getDomainCach" }, "type": "array" }, "cname": { "description": "Indicates the CNAME assigned by the content delivery network to the acceleration domain name.\n", "type": "string" }, "compression": { "$ref": "#/types/volcenginecc:cdn/getDomainCompression:getDomainCompression", "description": "Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.\n" }, "conditionalOrigin": { "$ref": "#/types/volcenginecc:cdn/getDomainConditionalOrigin:getDomainConditionalOrigin", "description": "Specifies the configuration module for the 'Conditional Origin' feature.\n" }, "createdTime": { "description": "Indicates the creation time of this accelerated domain name, in Unix timestamp format.\n", "type": "integer" }, "customErrorPage": { "$ref": "#/types/volcenginecc:cdn/getDomainCustomErrorPage:getDomainCustomErrorPage", "description": "Indicates the configuration module for the \"Custom Error Page\" feature. This feature is disabled by default.\n" }, "customizeAccessRule": { "$ref": "#/types/volcenginecc:cdn/getDomainCustomizeAccessRule:getDomainCustomizeAccessRule", "description": "Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.\n" }, "domain": { "description": "Indicates the acceleration domain name.\n", "type": "string" }, "domainLock": { "$ref": "#/types/volcenginecc:cdn/getDomainDomainLock:getDomainDomainLock", "description": "Indicates the lock status of this domain name.\n" }, "downloadSpeedLimit": { "$ref": "#/types/volcenginecc:cdn/getDomainDownloadSpeedLimit:getDomainDownloadSpeedLimit", "description": "Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.\n" }, "followRedirect": { "description": "Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.\n", "type": "boolean" }, "httpForcedRedirect": { "$ref": "#/types/volcenginecc:cdn/getDomainHttpForcedRedirect:getDomainHttpForcedRedirect", "description": "Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.\n" }, "https": { "$ref": "#/types/volcenginecc:cdn/getDomainHttps:getDomainHttps", "description": "Indicates the HTTPS configuration module. This feature is disabled by default.\n" }, "iPv6": { "$ref": "#/types/volcenginecc:cdn/getDomainIPv6:getDomainIPv6", "description": "Indicates the configuration module for the IPv6 feature.\n" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAccessRule": { "$ref": "#/types/volcenginecc:cdn/getDomainIpAccessRule:getDomainIpAccessRule", "description": "Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.\n" }, "isConflictDomain": { "description": "Indicates whether the domain is a conflicting domain. In CDN, each domain is unique. If you need to add a domain that already exists under another primary account, you must submit a ticket. If you successfully add the domain under your primary account, it becomes a conflicting domain. This parameter has the following values: true: the domain is a conflicting domain. false: the domain is not a conflicting domain.\n", "type": "boolean" }, "lockStatus": { "description": "Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.\n", "type": "string" }, "methodDeniedRule": { "$ref": "#/types/volcenginecc:cdn/getDomainMethodDeniedRule:getDomainMethodDeniedRule", "description": "Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.\n" }, "multiRange": { "$ref": "#/types/volcenginecc:cdn/getDomainMultiRange:getDomainMultiRange", "description": "Indicates the configuration module for the multi-range feature. This feature is disabled by default\n" }, "negativeCaches": { "description": "Indicates the configuration module for the 'status code cache' feature. This feature is disabled by default. The parameter value is a list, as explained below: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The first rule in the list has the highest priority. If you create multiple rules, pay attention to whether there is containment between rules. If containment exists, rules with a broader scope should appear after rules with a narrower scope.\n", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainNegativeCach:getDomainNegativeCach" }, "type": "array" }, "offlineCache": { "$ref": "#/types/volcenginecc:cdn/getDomainOfflineCache:getDomainOfflineCache", "description": "Indicates the configuration module for the 'offline cache' feature.\n" }, "originAccessRule": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginAccessRule:getDomainOriginAccessRule", "description": "Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.\n" }, "originArgs": { "description": "Represents the rule list for the 'Origin Parameters' configuration module. The list can contain up to 50 rules. Each rule includes a filter (Condition) and an action performed by the CDN (OriginArgAction). The order of rules in the list defines their priority. The first rule in the list has the highest priority. The filter in each rule defines the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules. You must add the following preset rule at the end of the rule list. You cannot modify the Condition in this rule, but you can change the configuration in OriginArgAction.\n", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginArg:getDomainOriginArg" }, "type": "array" }, "originCertCheck": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginCertCheck:getDomainOriginCertCheck", "description": "Origin certificate validation\n" }, "originHost": { "description": "If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.\n", "type": "string" }, "originIPv6": { "description": "Indicates the configuration for \"IPv6 origin fetch.\" This parameter has the following values: ipv6*first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4*first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.\n", "type": "string" }, "originProtocol": { "description": "Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.\n", "type": "string" }, "originRange": { "description": "Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.\n", "type": "boolean" }, "originRetry": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginRetry:getDomainOriginRetry", "description": "Indicates the configuration module for the \"origin fetch retry settings\" feature.\n" }, "originRewrite": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginRewrite:getDomainOriginRewrite", "description": "Indicates the configuration module for the 'Origin URL Rewrite' feature.\n" }, "originSni": { "$ref": "#/types/volcenginecc:cdn/getDomainOriginSni:getDomainOriginSni", "description": "Indicates the configuration module for the 'origin SNI' feature.\n" }, "origins": { "description": "Indicates the basic origin configuration module.\n", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainOrigin:getDomainOrigin" }, "type": "array" }, "pageOptimization": { "$ref": "#/types/volcenginecc:cdn/getDomainPageOptimization:getDomainPageOptimization", "description": "Specifies the configuration module for the 'page optimization' feature.\n" }, "primaryOrigins": { "description": "Indicates the list of primary origin servers configured for this domain name.\n", "items": { "type": "string" }, "type": "array" }, "project": { "description": "Indicates the project to which the acceleration domain belongs\n", "type": "string" }, "quic": { "$ref": "#/types/volcenginecc:cdn/getDomainQuic:getDomainQuic", "description": "Indicates the configuration module for the QUIC feature. This feature is disabled by default.\n" }, "redirectionRewrite": { "$ref": "#/types/volcenginecc:cdn/getDomainRedirectionRewrite:getDomainRedirectionRewrite", "description": "Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.\n" }, "refererAccessRule": { "$ref": "#/types/volcenginecc:cdn/getDomainRefererAccessRule:getDomainRefererAccessRule", "description": "Indicates the configuration module for the \"Referer Allowlist and Denylist\" feature. This feature is disabled by default.\n" }, "remoteAuth": { "$ref": "#/types/volcenginecc:cdn/getDomainRemoteAuth:getDomainRemoteAuth", "description": "Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.\n" }, "requestBlockRule": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestBlockRule:getDomainRequestBlockRule", "description": "Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default\n" }, "requestHeaders": { "description": "Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.\n", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainRequestHeader:getDomainRequestHeader" }, "type": "array" }, "responseHeaders": { "description": "Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.\n", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainResponseHeader:getDomainResponseHeader" }, "type": "array" }, "rewriteHls": { "$ref": "#/types/volcenginecc:cdn/getDomainRewriteHls:getDomainRewriteHls", "description": "Indicates the configuration module for the \"Standard HLS Encryption Rewrite\" feature. This feature is disabled by default.\n" }, "serviceRegion": { "description": "Indicates the acceleration region for this accelerated domain name. The parameter values are: chinese*mainland: Chinese Mainland. global: Global. outside*chinese_mainland: Global (excluding Chinese Mainland).\n", "type": "string" }, "serviceType": { "description": "Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.\n", "type": "string" }, "signedUrlAuth": { "$ref": "#/types/volcenginecc:cdn/getDomainSignedUrlAuth:getDomainSignedUrlAuth", "description": "Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default\n" }, "status": { "description": "Indicates the status of the acceleration domain name. The parameter values are as follows: online: indicates normal operation. configuring: indicates configuration in progress. offline: indicates offline status.\n", "type": "string" }, "tags": { "description": "Tag information\n", "items": { "$ref": "#/types/volcenginecc:cdn/getDomainTag:getDomainTag" }, "type": "array" }, "timeout": { "$ref": "#/types/volcenginecc:cdn/getDomainTimeout:getDomainTimeout", "description": "Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.\n" }, "uaAccessRule": { "$ref": "#/types/volcenginecc:cdn/getDomainUaAccessRule:getDomainUaAccessRule", "description": "Indicates the configuration module for the \"UA allowlist and blocklist\" feature. This feature is disabled by default.\n" }, "updatedTime": { "description": "Indicates the most recent update time for this domain configuration, in Unix timestamp format.\n", "type": "integer" }, "urlNormalize": { "$ref": "#/types/volcenginecc:cdn/getDomainUrlNormalize:getDomainUrlNormalize", "description": "Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.\n" }, "videoDrag": { "$ref": "#/types/volcenginecc:cdn/getDomainVideoDrag:getDomainVideoDrag", "description": "Indicates the configuration module for the \"Video Drag\" feature. This feature is disabled by default.\n" } }, "required": [ "areaAccessRule", "backupOrigins", "browserCaches", "caches", "cacheHost", "cacheKeys", "cacheShared", "cacheSharedTargetHost", "cname", "compression", "conditionalOrigin", "createdTime", "customErrorPage", "customizeAccessRule", "domain", "domainLock", "downloadSpeedLimit", "followRedirect", "httpForcedRedirect", "https", "iPv6", "id", "ipAccessRule", "isConflictDomain", "lockStatus", "methodDeniedRule", "multiRange", "negativeCaches", "offlineCache", "origins", "originAccessRule", "originArgs", "originCertCheck", "originHost", "originIPv6", "originProtocol", "originRange", "originRetry", "originRewrite", "originSni", "pageOptimization", "primaryOrigins", "project", "quic", "redirectionRewrite", "refererAccessRule", "remoteAuth", "requestBlockRule", "requestHeaders", "responseHeaders", "rewriteHls", "serviceRegion", "serviceType", "signedUrlAuth", "status", "tags", "timeout", "uaAccessRule", "updatedTime", "urlNormalize", "videoDrag" ], "type": "object" } }, "volcenginecc:cdn/getDomains:getDomains": { "description": "Plural Data Source schema for Volcengine::CDN::Domain\n", "outputs": { "description": "A collection of values returned by getDomains.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cdn/getShareConfig:getShareConfig": { "description": "Data Source schema for Volcengine::CDN::ShareConfig\n", "inputs": { "description": "A collection of arguments for invoking getShareConfig.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getShareConfig.\n", "properties": { "allowIpAccessRule": { "$ref": "#/types/volcenginecc:cdn/getShareConfigAllowIpAccessRule:getShareConfigAllowIpAccessRule", "description": "Specifies the configuration for an IP allowlist, where ConfigType is allow*ip*access*rule.\n" }, "allowRefererAccessRule": { "$ref": "#/types/volcenginecc:cdn/getShareConfigAllowRefererAccessRule:getShareConfigAllowRefererAccessRule", "description": "Indicates a configuration for a Referer allowlist. The corresponding ConfigType is allow*referer*access*rule.\n" }, "commonMatchList": { "$ref": "#/types/volcenginecc:cdn/getShareConfigCommonMatchList:getShareConfigCommonMatchList", "description": "Specifies the configuration for a common list, where ConfigType is common*match*list.\n" }, "configName": { "description": "Specifies the name of the global configuration. Naming requirements: Names can include Chinese characters, letters, numbers, and underscores (_), and must be 3–45 characters long. One Chinese character counts as 3 characters. The name cannot be the same as any existing global configuration name under the primary account.\n", "type": "string" }, "configType": { "description": "This parameter specifies the type of global configuration. Available values are: deny*ip*access*rule: indicates an IP denylist. allow*ip*access*rule: indicates an IP allowlist. deny*referer*access*rule: indicates a Referer denylist. allow*referer*access*rule: indicates a Referer allowlist. common*match*list: indicates a common list.\n", "type": "string" }, "denyIpAccessRule": { "$ref": "#/types/volcenginecc:cdn/getShareConfigDenyIpAccessRule:getShareConfigDenyIpAccessRule", "description": "Specifies the configuration for an IP denylist, where ConfigType is deny*ip*access*rule.\n" }, "denyRefererAccessRule": { "$ref": "#/types/volcenginecc:cdn/getShareConfigDenyRefererAccessRule:getShareConfigDenyRefererAccessRule", "description": "Indicates a configuration for a Referer denylist. The corresponding ConfigType is deny*referer*access*rule.\n" }, "domainCount": { "description": "Indicates the number of accelerated domains associated with this global configuration.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "project": { "description": "Specifies the project name to which the global configuration belongs.\n", "type": "string" }, "ruleContent": { "description": "Specifies the HTML code for the custom error page.\n", "type": "string" }, "updatedTime": { "description": "Indicates the last modification time of this global configuration, in Unix timestamp.\n", "type": "integer" } }, "required": [ "allowIpAccessRule", "allowRefererAccessRule", "commonMatchList", "configName", "configType", "denyIpAccessRule", "denyRefererAccessRule", "domainCount", "id", "project", "ruleContent", "updatedTime" ], "type": "object" } }, "volcenginecc:cdn/getShareConfigs:getShareConfigs": { "description": "Plural Data Source schema for Volcengine::CDN::ShareConfig\n", "outputs": { "description": "A collection of values returned by getShareConfigs.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cen/getBandwidthPackage:getBandwidthPackage": { "description": "Data Source schema for Volcengine::CEN::BandwidthPackage\n", "inputs": { "description": "A collection of arguments for invoking getBandwidthPackage.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBandwidthPackage.\n", "properties": { "bandwidth": { "description": "Bandwidth peak of the bandwidth package. Value range: 2–10000 Mbps. Default: 2 Mbps.\n", "type": "integer" }, "billingStatus": { "description": "Billing status of the bandwidth package instance. 0: Creating 1: Running 3: Unsubscribed 4: Expired and stopped 5: Expired and recycled 8: Unsubscribed and stopped\n", "type": "integer" }, "billingType": { "description": "Billing method of the bandwidth package. Valid values: 1 (default): yearly/monthly subscription. 4: pay-as-you-go—95th percentile billing.\n", "type": "integer" }, "businessStatus": { "description": "Frozen status of the bandwidth package. Normal: normal. FinancialLocked: frozen.\n", "type": "string" }, "cenBandwidthPackageId": { "description": "Bandwidth package ID.\n", "type": "string" }, "cenBandwidthPackageName": { "description": "Name of the bandwidth package. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the bandwidth package ID.\n", "type": "string" }, "cenIds": { "description": "List of associated CEN instance IDs.\n", "items": { "type": "string" }, "type": "array" }, "creationTime": { "description": "Creation time of the bandwidth package.\n", "type": "string" }, "deletedTime": { "description": "Deletion time of the bandwidth package.\n", "type": "string" }, "description": { "description": "Description of the bandwidth package. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "expiredTime": { "description": "Expiration time of the bandwidth package.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lineOperator": { "description": "Carrier for cross-border bandwidth package lines. If LocalGeographicRegionSetId and PeerGeographicRegionSetId are the same, this parameter is not supported. If LocalGeographicRegionSetId and PeerGeographicRegionSetId are different, available values are: ChinaUnicom (default): China Unicom.\n", "type": "string" }, "localGeographicRegionSetId": { "description": "Local geographic region ID for Cloud Enterprise Network communication. Available values: China: Chinese mainland. Asia: Asia-Pacific.\n", "type": "string" }, "peerGeographicRegionSetId": { "description": "Peer geographic region ID for Cloud Enterprise Network interconnection. Valid values: China: Chinese mainland. Asia: Asia-Pacific.\n", "type": "string" }, "period": { "description": "Purchase duration of the bandwidth package. Default is 1. Valid values: If PeriodUnit is Month, range is 1–9, 12, 24, and 36. If PeriodUnit is Year, range is 1–3.\n", "type": "integer" }, "periodUnit": { "description": "Billing cycle of the bandwidth package. Valid values: Month (default): month. Year: year.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the bandwidth package belongs. If not specified, defaults to 'default'.\n", "type": "string" }, "reclaimTime": { "description": "Recycle time after the bandwidth package instance expires.\n", "type": "string" }, "remainRenewTimes": { "description": "Number of automatic renewals. Values include -1 and 1–100. Default is -1, which means unlimited automatic renewals.\n", "type": "integer" }, "remainingBandwidth": { "description": "Remaining bandwidth, measured in Mbps.\n", "type": "integer" }, "renewPeriod": { "description": "Duration of each automatic renewal, in months. Valid values: 1–3, 6, and 12. Default is 1.\n", "type": "integer" }, "renewType": { "description": "Renewal type of the bandwidth package instance. Manual: Manual renewal. Auto: Automatic renewal. NoRenew: No renewal.\n", "type": "string" }, "status": { "description": "Status of the bandwidth package. Creating: Being created. Deleting: Being deleted. Pending: In progress. Available: Unbound. InUse: Bound.\n", "type": "string" }, "tags": { "description": "Tag list\n", "items": { "$ref": "#/types/volcenginecc:cen/getBandwidthPackageTag:getBandwidthPackageTag" }, "type": "array" }, "updateTime": { "description": "Update time of the bandwidth package.\n", "type": "string" } }, "required": [ "bandwidth", "billingStatus", "billingType", "businessStatus", "cenBandwidthPackageId", "cenBandwidthPackageName", "cenIds", "creationTime", "deletedTime", "description", "expiredTime", "id", "lineOperator", "localGeographicRegionSetId", "peerGeographicRegionSetId", "period", "periodUnit", "projectName", "reclaimTime", "remainRenewTimes", "remainingBandwidth", "renewPeriod", "renewType", "status", "tags", "updateTime" ], "type": "object" } }, "volcenginecc:cen/getBandwidthPackages:getBandwidthPackages": { "description": "Plural Data Source schema for Volcengine::CEN::BandwidthPackage\n", "outputs": { "description": "A collection of values returned by getBandwidthPackages.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cen/getCen:getCen": { "description": "Data Source schema for Volcengine::CEN::CEN\n", "inputs": { "description": "A collection of arguments for invoking getCen.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getCen.\n", "properties": { "accountId": { "description": "Account ID to which the CEN instance belongs\n", "type": "string" }, "cenBandwidthPackageIds": { "description": "Bandwidth package ID\n", "items": { "type": "string" }, "type": "array" }, "cenId": { "description": "CEN instance ID\n", "type": "string" }, "cenName": { "description": "Name of the CEN instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If not specified, defaults to the CEN instance ID\n", "type": "string" }, "creationTime": { "description": "Time when the CEN instance was created\n", "type": "string" }, "description": { "description": "Description for the CEN instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to empty\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instances": { "description": "List of associated network instances\n", "items": { "$ref": "#/types/volcenginecc:cen/getCenInstance:getCenInstance" }, "type": "array" }, "projectName": { "description": "Name of the project to which the CEN instance belongs. If not specified, defaults to 'default'\n", "type": "string" }, "status": { "description": "Status of the CEN instance. Creating: Creating Deleting: Deleting Pending: Configuring Available: Available\n", "type": "string" }, "tags": { "description": "Tag information\n", "items": { "$ref": "#/types/volcenginecc:cen/getCenTag:getCenTag" }, "type": "array" }, "updateTime": { "description": "Time when the CEN instance was updated\n", "type": "string" } }, "required": [ "accountId", "cenBandwidthPackageIds", "cenId", "cenName", "creationTime", "description", "id", "instances", "projectName", "status", "tags", "updateTime" ], "type": "object" } }, "volcenginecc:cen/getCens:getCens": { "description": "Plural Data Source schema for Volcengine::CEN::CEN\n", "outputs": { "description": "A collection of values returned by getCens.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cen/getGrantInstance:getGrantInstance": { "description": "Data Source schema for Volcengine::CEN::GrantInstance\n", "inputs": { "description": "A collection of arguments for invoking getGrantInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getGrantInstance.\n", "properties": { "cenId": { "description": "Cloud Enterprise Network instance ID of the other party's account\n", "type": "string" }, "cenOwnerId": { "description": "Other party's account\n", "type": "string" }, "creationTime": { "description": "Network instance authorization time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "ID of the network instance to be authorized\n", "type": "string" }, "instanceRegionId": { "description": "Region where the network instance is located\n", "type": "string" }, "instanceType": { "description": "Network instance type. Options: VPC: Virtual Private Cloud. DCGW: Direct Connect Gateway\n", "type": "string" } }, "required": [ "cenId", "cenOwnerId", "creationTime", "id", "instanceId", "instanceRegionId", "instanceType" ], "type": "object" } }, "volcenginecc:cen/getGrantInstances:getGrantInstances": { "description": "Plural Data Source schema for Volcengine::CEN::GrantInstance\n", "outputs": { "description": "A collection of values returned by getGrantInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cen/getInterRegionBandwidth:getInterRegionBandwidth": { "description": "Data Source schema for Volcengine::CEN::InterRegionBandwidth\n", "inputs": { "description": "A collection of arguments for invoking getInterRegionBandwidth.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInterRegionBandwidth.\n", "properties": { "bandwidth": { "description": "Peak bandwidth of CEN inter-region bandwidth, measured in Mbps. The value cannot exceed the bandwidth that can be allocated by the associated bandwidth package.\n", "type": "integer" }, "cenBandwidthPackageId": { "description": "Instance ID of the bandwidth package.\n", "type": "string" }, "cenId": { "description": "ID of the Cloud Enterprise Network instance.\n", "type": "string" }, "creationTime": { "description": "Time when the CEN inter-region bandwidth was created.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "interRegionBandwidthId": { "description": "ID of the CEN inter-region bandwidth.\n", "type": "string" }, "localRegionId": { "description": "ID of the local region for CEN inter-region bandwidth.\n", "type": "string" }, "peerRegionId": { "description": "ID of the remote region for CEN inter-region bandwidth.\n", "type": "string" }, "status": { "description": "Status of CEN inter-region bandwidth. Creating: Being created. Deleting: Being deleted. Pending: Configuring. Available: Available.\n", "type": "string" }, "updateTime": { "description": "Time when the CEN inter-region bandwidth was updated.\n", "type": "string" } }, "required": [ "bandwidth", "cenBandwidthPackageId", "cenId", "creationTime", "id", "interRegionBandwidthId", "localRegionId", "peerRegionId", "status", "updateTime" ], "type": "object" } }, "volcenginecc:cen/getInterRegionBandwidths:getInterRegionBandwidths": { "description": "Plural Data Source schema for Volcengine::CEN::InterRegionBandwidth\n", "outputs": { "description": "A collection of values returned by getInterRegionBandwidths.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cen/getRouteEntries:getRouteEntries": { "description": "Plural Data Source schema for Volcengine::CEN::RouteEntry\n", "outputs": { "description": "A collection of values returned by getRouteEntries.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cen/getRouteEntry:getRouteEntry": { "description": "Data Source schema for Volcengine::CEN::RouteEntry\n", "inputs": { "description": "A collection of arguments for invoking getRouteEntry.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRouteEntry.\n", "properties": { "asPaths": { "description": "AS path\n", "items": { "type": "string" }, "type": "array" }, "cenId": { "description": "Cloud enterprise network instance ID\n", "type": "string" }, "destinationCidrBlock": { "description": "Destination CIDR of the route entry\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Network instance ID\n", "type": "string" }, "instanceRegionId": { "description": "Region ID of the network instance\n", "type": "string" }, "instanceType": { "description": "Network instance type\n", "type": "string" }, "publishStatus": { "description": "Publish status of the route entry\n", "type": "string" }, "status": { "description": "Effective status of the route entry\n", "type": "string" }, "type": { "description": "Route entry type\n", "type": "string" } }, "required": [ "asPaths", "cenId", "destinationCidrBlock", "id", "instanceId", "instanceRegionId", "instanceType", "publishStatus", "status", "type" ], "type": "object" } }, "volcenginecc:cen/getServiceRouteEntries:getServiceRouteEntries": { "description": "Plural Data Source schema for Volcengine::CEN::ServiceRouteEntry\n", "outputs": { "description": "A collection of values returned by getServiceRouteEntries.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cen/getServiceRouteEntry:getServiceRouteEntry": { "description": "Data Source schema for Volcengine::CEN::ServiceRouteEntry\n", "inputs": { "description": "A collection of arguments for invoking getServiceRouteEntry.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getServiceRouteEntry.\n", "properties": { "cenId": { "description": "Cloud Enterprise Network instance ID.\n", "type": "string" }, "creationTime": { "description": "Resource creation time.\n", "type": "string" }, "description": { "description": "Custom remarks for the route.\n", "type": "string" }, "destinationCidrBlock": { "description": "Address range where the cloud service is deployed.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "publishMode": { "description": "Route publishing scope mode.\n", "type": "string" }, "publishToInstances": { "description": "List of network instances associated with batch route publishing.\n", "items": { "$ref": "#/types/volcenginecc:cen/getServiceRouteEntryPublishToInstance:getServiceRouteEntryPublishToInstance" }, "type": "array" }, "serviceRegionId": { "description": "Region where the cloud service is located.\n", "type": "string" }, "serviceVpcId": { "description": "Private network ID bound to the backend cloud service.\n", "type": "string" }, "status": { "description": "Cloud service access route status.\n", "type": "string" } }, "required": [ "cenId", "creationTime", "description", "destinationCidrBlock", "id", "publishMode", "publishToInstances", "serviceRegionId", "serviceVpcId", "status" ], "type": "object" } }, "volcenginecc:clb/getAcl:getAcl": { "description": "Data Source schema for Volcengine::CLB::ACL\n", "inputs": { "description": "A collection of arguments for invoking getAcl.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAcl.\n", "properties": { "aclEntries": { "description": "Detailed information about IP entries in the access control policy group.\n", "items": { "$ref": "#/types/volcenginecc:clb/getAclAclEntry:getAclAclEntry" }, "type": "array" }, "aclEntryCount": { "description": "Number of IP entries contained in the access control policy group.\n", "type": "integer" }, "aclId": { "description": "Access control policy group ID\n", "type": "string" }, "aclName": { "description": "Name of the access control policy group. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the access control policy group ID.\n", "type": "string" }, "createTime": { "description": "Creation time of the access control policy group\n", "type": "string" }, "description": { "description": "Description of the access control policy group. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listeners": { "description": "Detailed information about listeners associated with the access control policy group\n", "items": { "$ref": "#/types/volcenginecc:clb/getAclListener:getAclListener" }, "type": "array" }, "projectName": { "description": "Name of the project to which the access control policy group belongs. If not specified, defaults to 'default'.\n", "type": "string" }, "serviceManaged": { "description": "Is this a managed resource. true: yes. false: no.\n", "type": "boolean" }, "status": { "description": "Status of the access control policy group. Creating: creating. Active: available. Configuring: configuring. Deleting: deleting.\n", "type": "string" }, "tags": { "description": "Detailed information about access control policy group tags\n", "items": { "$ref": "#/types/volcenginecc:clb/getAclTag:getAclTag" }, "type": "array" }, "updateTime": { "description": "Last operation time of the access control policy group\n", "type": "string" } }, "required": [ "aclEntries", "aclEntryCount", "aclId", "aclName", "createTime", "description", "id", "listeners", "projectName", "serviceManaged", "status", "tags", "updateTime" ], "type": "object" } }, "volcenginecc:clb/getAcls:getAcls": { "description": "Plural Data Source schema for Volcengine::CLB::ACL\n", "outputs": { "description": "A collection of values returned by getAcls.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:clb/getCertificate:getCertificate": { "description": "Data Source schema for Volcengine::CLB::Certificate\n", "inputs": { "description": "A collection of arguments for invoking getCertificate.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getCertificate.\n", "properties": { "certificateId": { "description": "Certificate ID.\n", "type": "string" }, "certificateName": { "description": "Certificate name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters.\n", "type": "string" }, "createdTime": { "description": "Certificate creation time.\n", "type": "string" }, "description": { "description": "Certificate description. Default value is an empty string. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.\n", "type": "string" }, "domainName": { "description": "Certificate primary domain name.\n", "type": "string" }, "expiredAt": { "description": "Certificate expiration time.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listeners": { "description": "ID of the listener associated with the certificate.\n", "items": { "type": "string" }, "type": "array" }, "privateKey": { "description": "Certificate private key.\n", "type": "string" }, "projectName": { "description": "Name of the project the certificate belongs to. If not specified, defaults to 'default'.\n", "type": "string" }, "publicKey": { "description": "Certificate public key.\n", "type": "string" }, "serviceManaged": { "description": "Managed resource status. true: managed resource. false: unmanaged resource.\n", "type": "boolean" }, "subjectAlternativeNames": { "description": "List of alternate domain names for the certificate.\n", "items": { "type": "string" }, "type": "array" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:clb/getCertificateTag:getCertificateTag" }, "type": "array" } }, "required": [ "certificateId", "certificateName", "createdTime", "description", "domainName", "expiredAt", "id", "listeners", "privateKey", "projectName", "publicKey", "serviceManaged", "subjectAlternativeNames", "tags" ], "type": "object" } }, "volcenginecc:clb/getCertificates:getCertificates": { "description": "Plural Data Source schema for Volcengine::CLB::Certificate\n", "outputs": { "description": "A collection of values returned by getCertificates.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:clb/getClb:getClb": { "description": "Data Source schema for Volcengine::CLB::CLB\n", "inputs": { "description": "A collection of arguments for invoking getClb.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getClb.\n", "properties": { "accessLog": { "$ref": "#/types/volcenginecc:clb/getClbAccessLog:getClbAccessLog", "description": "Access log information in the load balancer instance\n" }, "accountId": { "description": "Account ID to which the load balancer instance belongs\n", "type": "string" }, "addressIpVersion": { "description": "IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private\n", "type": "string" }, "allowedPorts": { "description": "Allowed port ranges\n", "items": { "type": "string" }, "type": "array" }, "autoRenewal": { "description": "Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No\n", "type": "boolean" }, "businessStatus": { "description": "Whether the load balancer instance is locked\n", "type": "string" }, "bypassSecurityGroupEnabled": { "description": "Whether to enable bypass security group feature\n", "type": "string" }, "createTime": { "description": "Creation time of the load balancer instance\n", "type": "string" }, "deletedTime": { "description": "Expected recycling time of the load balancer instance\n", "type": "string" }, "description": { "description": "Description of the load balancer instance\n", "type": "string" }, "eip": { "$ref": "#/types/volcenginecc:clb/getClbEip:getClbEip", "description": "Public IP information of the load balancer instance\n" }, "eipAddress": { "description": "Public IP address\n", "type": "string" }, "eipId": { "description": "Public IP ID\n", "type": "string" }, "enabled": { "description": "Enable status of the load balancer instance\n", "type": "boolean" }, "eni": { "$ref": "#/types/volcenginecc:clb/getClbEni:getClbEni", "description": "Private IPv4 address information of the load balancer instance\n" }, "eniAddressNum": { "description": "Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required\n", "type": "number" }, "eniIpv6Address": { "description": "Private IPv6 address of the load balancer instance\n", "type": "string" }, "enis": { "$ref": "#/types/volcenginecc:clb/getClbEnis:getClbEnis", "description": "List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation\n" }, "exclusiveClusterId": { "description": "Dedicated cluster ID\n", "type": "string" }, "expiredTime": { "description": "Expiration time of the load balancer instance\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipv6AddressBandwidth": { "$ref": "#/types/volcenginecc:clb/getClbIpv6AddressBandwidth:getClbIpv6AddressBandwidth", "description": "IPv6 public bandwidth information for the load balancing instance\n" }, "listeners": { "description": "Listener information in the load balancer instance\n", "items": { "$ref": "#/types/volcenginecc:clb/getClbListener:getClbListener" }, "type": "array" }, "loadBalancerBillingType": { "description": "CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)\n", "type": "number" }, "loadBalancerId": { "description": "Load balancer instance ID\n", "type": "string" }, "loadBalancerName": { "description": "Name of the load balancer instance\n", "type": "string" }, "loadBalancerSpec": { "description": "CLB instance specification. Different specifications provide different forwarding capabilities. small*1: Small I. small*2: Small II. medium*1: Medium I. medium*2: Medium II. large*1: Large I. large*2: Large II\n", "type": "string" }, "lockReason": { "description": "Reason why the load balancer instance is frozen\n", "type": "string" }, "masterZoneId": { "description": "Main availability zone ID of the load balancer instance\n", "type": "string" }, "modificationProtectionReason": { "description": "Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters\n", "type": "string" }, "modificationProtectionStatus": { "description": "Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled\n", "type": "string" }, "newArch": { "description": "Whether it is a new architecture\n", "type": "boolean" }, "orderId": { "description": "Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation\n", "type": "string" }, "overdueTime": { "description": "Freeze time of the load balancer instance\n", "type": "string" }, "period": { "description": "Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3\n", "type": "number" }, "periodUnit": { "description": "Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year\n", "type": "string" }, "projectName": { "description": "Name of the project associated with the CLB instance\n", "type": "string" }, "serverGroups": { "description": "Backend server group information in the load balancer instance\n", "items": { "$ref": "#/types/volcenginecc:clb/getClbServerGroup:getClbServerGroup" }, "type": "array" }, "serviceManaged": { "description": "Whether the CLB instance is a managed resource\n", "type": "boolean" }, "slaveZoneId": { "description": "Secondary availability zone ID of the load balancer instance\n", "type": "string" }, "status": { "description": "Load balancer instance status: Inactive: stopped. Active: running. Creating: creating. Provisioning: creating. Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.\n", "type": "string" }, "subnetId": { "description": "Subnet ID within the VPC of the load balancer instance\n", "type": "string" }, "tags": { "description": "CLB instance tags\n", "items": { "$ref": "#/types/volcenginecc:clb/getClbTag:getClbTag" }, "type": "array" }, "timestampRemoveEnabled": { "description": "Enable TCP timestamp removal\n", "type": "string" }, "type": { "description": "CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests\n", "type": "string" }, "updateTime": { "description": "Most recent operation time of the load balancer instance\n", "type": "string" }, "vpcId": { "description": "VPC ID of the load balancer instance\n", "type": "string" }, "zoneType": { "description": "Availability zone type of the load balancer instance\n", "type": "string" } }, "required": [ "accessLog", "accountId", "addressIpVersion", "allowedPorts", "autoRenewal", "businessStatus", "bypassSecurityGroupEnabled", "createTime", "deletedTime", "description", "eip", "eipAddress", "eipId", "enabled", "eni", "eniAddressNum", "eniIpv6Address", "enis", "exclusiveClusterId", "expiredTime", "id", "ipv6AddressBandwidth", "listeners", "loadBalancerBillingType", "loadBalancerId", "loadBalancerName", "loadBalancerSpec", "lockReason", "masterZoneId", "modificationProtectionReason", "modificationProtectionStatus", "newArch", "orderId", "overdueTime", "period", "periodUnit", "projectName", "serverGroups", "serviceManaged", "slaveZoneId", "status", "subnetId", "tags", "timestampRemoveEnabled", "type", "updateTime", "vpcId", "zoneType" ], "type": "object" } }, "volcenginecc:clb/getClbs:getClbs": { "description": "Plural Data Source schema for Volcengine::CLB::CLB\n", "outputs": { "description": "A collection of values returned by getClbs.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:clb/getListener:getListener": { "description": "Data Source schema for Volcengine::CLB::Listener\n", "inputs": { "description": "A collection of arguments for invoking getListener.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getListener.\n", "properties": { "aclIds": { "description": "ID of the access control policy group bound to the listener. Returned only when the AclStatus parameter is set to on.\n", "items": { "type": "string" }, "type": "array" }, "aclStatus": { "description": "Enable access control. Values: on: enabled. off (default): disabled.\n", "type": "string" }, "aclType": { "description": "Access control mode. white: Allowlist. black: Denylist. This parameter is valid only when the AclStatus parameter is on.\n", "type": "string" }, "bandwidth": { "description": "Bandwidth limit for the listener, which means this listener exclusively uses the bandwidth of the CLB instance. Unit: Mbps. -1 (default): This listener does not exclusively use CLB bandwidth and shares the non-exclusive bandwidth of the CLB instance with other listeners. Value range: 1 to the non-exclusive bandwidth of the CLB instance.\n", "type": "integer" }, "caCertificateId": { "description": "CA certificate for mutual authentication.\n", "type": "string" }, "caEnabled": { "description": "Enable mutual authentication. on: enabled. off (default): disabled.\n", "type": "string" }, "certCenterCertificateId": { "description": "Certificate ID from Certificate Center.\n", "type": "string" }, "certificateId": { "description": "Certificate ID from the CLB certificate management module.\n", "type": "string" }, "certificateSource": { "description": "Certificate source. clb (default): certificate uploaded to CLB. cert_center: certificate uploaded to Certificate Center. user: certificate uploaded by user.\n", "type": "string" }, "clientBodyTimeout": { "description": "Timeout for reading the client request body. This timeout applies only between two consecutive read operations, not the entire request transmission. Range: 30–120 seconds, default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n", "type": "integer" }, "clientHeaderTimeout": { "description": "Timeout for reading the client request header. Value range: 30–120 seconds. Default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n", "type": "integer" }, "connectionDrainEnabled": { "description": "Whether the listener enables graceful connection termination. on: enabled. off: not enabled. When Protocol returns HTTP or HTTPS, this parameter always returns off.\n", "type": "string" }, "connectionDrainTimeout": { "description": "Timeout for graceful connection termination, in seconds. If ConnectionDrainEnabled returns off, this parameter returns 0.\n", "type": "integer" }, "cookie": { "description": "Name of the session persistence cookie configured on the backend server. This parameter is valid and required only when PersistenceType is set to server. Only letters, numbers, underscores (_), and hyphens (-) are allowed. Length must be between 1 and 200 characters.\n", "type": "string" }, "cps": { "description": "Maximum number of new connections per second. -1 (default): No limit, which means the maximum number of new connections allowed by the CLB instance. Value range: 1 to the maximum number of new connections allowed by the CLB instance.\n", "type": "integer" }, "createdTime": { "description": "Creation time of the listener.\n", "type": "string" }, "description": { "description": "Listener description. Must start with a letter, digit, or Chinese character. Can include letters, digits, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 0–255 characters. If not specified, the default is an empty string.\n", "type": "string" }, "domainExtensions": { "description": "List of extended domain names associated with the HTTPS listener. Each HTTPS listener can be associated with up to 20 extended domain names.\n", "items": { "$ref": "#/types/volcenginecc:clb/getListenerDomainExtension:getListenerDomainExtension" }, "type": "array" }, "enabled": { "description": "Enable listener. on (default): enabled. off: disabled.\n", "type": "string" }, "endPort": { "description": "End port for all-port listening. Range: 1–65535. When Port is '0', this parameter is required and must be greater than startPort.\n", "type": "integer" }, "establishedTimeout": { "description": "Listener connection timeout. This parameter is valid only when Protocol is set to TCP or UDP. Values: TCP protocol: 10–900 seconds, default is 900 seconds. UDP protocol: 1–300 seconds, default is 90 seconds.\n", "type": "integer" }, "healthCheck": { "$ref": "#/types/volcenginecc:clb/getListenerHealthCheck:getListenerHealthCheck", "description": "Health check information.\n" }, "http2Enabled": { "description": "Whether the listener enables frontend HTTP 2.0 protocol. This parameter is valid only when Protocol is set to HTTPS. Values: on: enabled. off (default): disabled.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "keepaliveTimeout": { "description": "Keep-alive timeout between the client and CLB. Range: 0–900 seconds, default is 75 seconds. 0 disables keep-alive. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n", "type": "integer" }, "listenerId": { "description": "Listener ID.\n", "type": "string" }, "listenerName": { "description": "Listener name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If left blank, 'Protocol-Port' will be used as the default listener name.\n", "type": "string" }, "loadBalancerId": { "description": "ID of the CLB instance.\n", "type": "string" }, "maxConnections": { "description": "Maximum concurrent connections limit. -1 (default): unlimited (up to the maximum concurrent connections supported by the CLB instance). Value range: 1 to the maximum concurrent connections limit of the CLB instance.\n", "type": "integer" }, "persistenceTimeout": { "description": "Session persistence timeout, in seconds. The value range depends on the PersistenceType parameter. When PersistenceType is set to source_ip, the range is 1–3600. When PersistenceType is set to insert, the range is 1–86400.\n", "type": "integer" }, "persistenceType": { "description": "Session persistence type. Values: off (default): session persistence disabled. source_ip: source IP address, valid only when Protocol is TCP or UDP. insert: insert Cookie, valid only when Protocol is HTTP or HTTPS and Scheduler is wrr. server: rewrite Cookie, valid only when Protocol is HTTP or HTTPS and Scheduler is wrr.\n", "type": "string" }, "port": { "description": "Port used by the listener to receive requests. Value range: 0–65535. When the Protocol parameter is 'TCP' or 'UDP', 0 is supported, which enables listening on all ports.\n", "type": "integer" }, "protocol": { "description": "Listener protocol. Includes: TCP, UDP, HTTP, HTTPS.\n", "type": "string" }, "proxyConnectTimeout": { "description": "Connection establishment timeout between CLB and backend server. Recommended to be greater than the health check timeout. Range: 4–120 seconds, default is 4. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n", "type": "integer" }, "proxyProtocolType": { "description": "Enable Proxy-Protocol. This parameter is valid only when Protocol is TCP or UDP. Values: off (default): disabled. standard: enabled.\n", "type": "string" }, "proxyReadTimeout": { "description": "Timeout for CLB to read responses from backend servers. This timeout applies only between two consecutive read operations, not for the entire response transmission. Value range: 30–3600 seconds. Default: 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n", "type": "integer" }, "proxySendTimeout": { "description": "Timeout for CLB to transmit requests to backend servers. This timeout applies only between two consecutive write operations, not the entire request transmission process. Value range: 30–3600 seconds. Default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n", "type": "integer" }, "ruleIds": { "description": "List of rule IDs bound to the listener.\n", "items": { "type": "string" }, "type": "array" }, "scheduler": { "description": "Scheduling algorithm used by the listener. wrr (default): Weighted round robin. wlc: Weighted least connections. sh: Source address hash.\n", "type": "string" }, "securityPolicyId": { "description": "TLS security policy for HTTPS listeners. This parameter is valid only when Protocol is set to HTTPS. Values: default*policy (default): supports SSL v3, TLS v1.0, TLS v1.1, TLS v1.2. tls*cipher*policy*1*0: supports TLS v1.0, TLS v1.1, TLS v1.2. tls*cipher*policy*1*1: supports TLS v1.1, TLS v1.2. tls*cipher*policy*1*2: supports TLS v1.2. tls*cipher*policy*1*2*strict: supports TLS v1.2.\n", "type": "string" }, "sendTimeout": { "description": "Timeout for CLB to send responses to the client. This timeout applies only between two consecutive write operations, not the entire response transmission. Range: 1–3600 seconds, default is 60 seconds. This parameter is valid only when Protocol is set to HTTP or HTTPS.\n", "type": "integer" }, "serverGroupId": { "description": "ID of the backend server group associated with the listener.\n", "type": "string" }, "startPort": { "description": "Start port for all-port listening. Range: 1–65535. When Port is '0', this parameter is required.\n", "type": "integer" }, "status": { "description": "Listener status. Creating: being created. Active: running. Deleting: being deleted. Disabled: disabled.\n", "type": "string" }, "tags": { "description": "Tag associated with the listener.\n", "items": { "$ref": "#/types/volcenginecc:clb/getListenerTag:getListenerTag" }, "type": "array" }, "updatedTime": { "description": "Last operation time of the listener.\n", "type": "string" }, "wafProtectionEnabled": { "description": "Send traffic passing through the Layer 7 listener to the Web Application Firewall for inspection and filtering. on: yes. off: no.\n", "type": "string" } }, "required": [ "aclIds", "aclStatus", "aclType", "bandwidth", "caCertificateId", "caEnabled", "certCenterCertificateId", "certificateId", "certificateSource", "clientBodyTimeout", "clientHeaderTimeout", "connectionDrainEnabled", "connectionDrainTimeout", "cookie", "cps", "createdTime", "description", "domainExtensions", "enabled", "endPort", "establishedTimeout", "healthCheck", "http2Enabled", "id", "keepaliveTimeout", "listenerId", "listenerName", "loadBalancerId", "maxConnections", "persistenceTimeout", "persistenceType", "port", "protocol", "proxyConnectTimeout", "proxyProtocolType", "proxyReadTimeout", "proxySendTimeout", "ruleIds", "scheduler", "securityPolicyId", "sendTimeout", "serverGroupId", "startPort", "status", "tags", "updatedTime", "wafProtectionEnabled" ], "type": "object" } }, "volcenginecc:clb/getListeners:getListeners": { "description": "Plural Data Source schema for Volcengine::CLB::Listener\n", "outputs": { "description": "A collection of values returned by getListeners.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:clb/getNlb:getNlb": { "description": "Data Source schema for Volcengine::CLB::NLB\n", "inputs": { "description": "A collection of arguments for invoking getNlb.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNlb.\n", "properties": { "accessLog": { "$ref": "#/types/volcenginecc:clb/getNlbAccessLog:getNlbAccessLog", "description": "Access log information of the NLB instance.\n" }, "accountId": { "description": "Account ID to which the NLB instance belongs.\n", "type": "string" }, "billingStatus": { "description": "Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.\n", "type": "string" }, "billingType": { "description": "Billing type of the NLB instance. 3: pay-as-you-go\n", "type": "integer" }, "createdTime": { "description": "Creation time of the NLB instance.\n", "type": "string" }, "crossZoneEnabled": { "description": "Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.\n", "type": "boolean" }, "description": { "description": "Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.\n", "type": "string" }, "dnsName": { "description": "DNS address of the NLB instance.\n", "type": "string" }, "expectedOverdueTime": { "description": "Time when the NLB instance is suspended due to overdue payment.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAddressVersion": { "description": "IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.\n", "type": "string" }, "ipv4BandwidthPackageId": { "description": "Shared bandwidth package ID for IPv4 type.\n", "type": "string" }, "ipv4NetworkType": { "description": "IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.\n", "type": "string" }, "ipv6BandwidthPackageId": { "description": "Shared bandwidth package ID for IPv6 type.\n", "type": "string" }, "ipv6NetworkType": { "description": "IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.\n", "type": "string" }, "loadBalancerId": { "description": "NLB instance ID.\n", "type": "string" }, "loadBalancerName": { "description": "Name of the NLB instance.\n", "type": "string" }, "managedSecurityGroupId": { "description": "Managed security group ID automatically associated with the NLB instance by the system.\n", "type": "string" }, "modificationProtectionStatus": { "description": "Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.\n", "type": "string" }, "overdueTime": { "description": "Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the NLB instance belongs.\n", "type": "string" }, "reclaimedTime": { "description": "Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.\n", "type": "string" }, "securityGroupIds": { "description": "List of security group IDs associated with the NLB instance.\n", "items": { "type": "string" }, "type": "array" }, "status": { "description": "Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.\n", "type": "string" }, "tags": { "description": "Tag information of the NLB instance.\n", "items": { "$ref": "#/types/volcenginecc:clb/getNlbTag:getNlbTag" }, "type": "array" }, "updatedTime": { "description": "Update time of the NLB instance.\n", "type": "string" }, "vpcId": { "description": "VPC ID to which the NLB instance belongs.\n", "type": "string" }, "zoneMappings": { "description": "Availability zone information for the NLB instance.\n", "items": { "$ref": "#/types/volcenginecc:clb/getNlbZoneMapping:getNlbZoneMapping" }, "type": "array" } }, "required": [ "accessLog", "accountId", "billingStatus", "billingType", "createdTime", "crossZoneEnabled", "description", "dnsName", "expectedOverdueTime", "id", "ipAddressVersion", "ipv4BandwidthPackageId", "ipv4NetworkType", "ipv6BandwidthPackageId", "ipv6NetworkType", "loadBalancerId", "loadBalancerName", "managedSecurityGroupId", "modificationProtectionStatus", "overdueTime", "projectName", "reclaimedTime", "securityGroupIds", "status", "tags", "updatedTime", "vpcId", "zoneMappings" ], "type": "object" } }, "volcenginecc:clb/getNlbListener:getNlbListener": { "description": "Data Source schema for Volcengine::CLB::NLBListener\n", "inputs": { "description": "A collection of arguments for invoking getNlbListener.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNlbListener.\n", "properties": { "certificateId": { "description": "TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.\n", "type": "string" }, "connectionTimeout": { "description": "Listener connection timeout (seconds)\n", "type": "integer" }, "createdTime": { "description": "Listener creation time\n", "type": "string" }, "description": { "description": "Listener description\n", "type": "string" }, "enabled": { "description": "Listener enabled: true (enabled); false (disabled)\n", "type": "boolean" }, "endPort": { "description": "End port for all-port listening. Valid only when Port is 0.\n", "type": "integer" }, "healths": { "description": "Backend instance health check response information\n", "items": { "$ref": "#/types/volcenginecc:clb/getNlbListenerHealth:getNlbListenerHealth" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listenerId": { "description": "Listener unique identifier\n", "type": "string" }, "listenerName": { "description": "Listener name\n", "type": "string" }, "loadBalancerId": { "description": "Load balancer instance ID\n", "type": "string" }, "port": { "description": "Port on which the listener receives requests. 0 indicates all-port listening is enabled.\n", "type": "integer" }, "protocol": { "description": "Listener protocol type: TCP, UDP, TLS\n", "type": "string" }, "securityPolicyId": { "description": "TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tls*cipher*policy*1*0 .tls*cipher*policy*1*1 .tls*cipher*policy*1*2 .tls*cipher*policy*1*2*strict .tls*cipher*policy*1*2*strict*with*1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.\n", "type": "string" }, "serverGroupId": { "description": "Server group ID associated with the listener\n", "type": "string" }, "startPort": { "description": "Start port for all-port listening. Valid only when Port is 0.\n", "type": "integer" }, "status": { "description": "Listener status\n", "type": "string" }, "tags": { "description": "Resource tags\n", "items": { "$ref": "#/types/volcenginecc:clb/getNlbListenerTag:getNlbListenerTag" }, "type": "array" }, "updatedTime": { "description": "Listener's most recent operation time\n", "type": "string" } }, "required": [ "certificateId", "connectionTimeout", "createdTime", "description", "enabled", "endPort", "healths", "id", "listenerId", "listenerName", "loadBalancerId", "port", "protocol", "securityPolicyId", "serverGroupId", "startPort", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:clb/getNlbListeners:getNlbListeners": { "description": "Plural Data Source schema for Volcengine::CLB::NLBListener\n", "outputs": { "description": "A collection of values returned by getNlbListeners.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:clb/getNlbSecurityPolicies:getNlbSecurityPolicies": { "description": "Plural Data Source schema for Volcengine::CLB::NLBSecurityPolicy\n", "outputs": { "description": "A collection of values returned by getNlbSecurityPolicies.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:clb/getNlbSecurityPolicy:getNlbSecurityPolicy": { "description": "Data Source schema for Volcengine::CLB::NLBSecurityPolicy\n", "inputs": { "description": "A collection of arguments for invoking getNlbSecurityPolicy.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNlbSecurityPolicy.\n", "properties": { "accountId": { "description": "Account ID associated with the TLS security policy\n", "type": "string" }, "ciphers": { "description": "Cipher suites for the TLS custom security policy. Supported cipher suites for different TLS protocol versions are as follows: TLSv1.0 \u0026 TLSv1.1: ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, DES-CBC3-SHA. TLSv1.2: ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256. TLSv1.3: TLS*CHACHA20*POLY1305*SHA256, TLS*AES*256*GCM*SHA384, TLS*AES*128*GCM*SHA256, TLS*AES*128*CCM*8*SHA256, TLS*AES*128*CCM*SHA256, TLS*SM4*GCM*SM3, TLS*SM4*CCM*SM3. When specifying this parameter, you must provide all supported cipher suites. Adding or removing cipher suites individually is not supported via this interface. If only Ciphers.N is provided and TlsVersions.N is not, validation is based on the TLS protocol versions supported by the current listener and the cipher suites specified in the request. If both TlsVersions.N and Ciphers.N are provided, validation is based on the TLS protocol versions and cipher suites specified in the request. TLS*SM4*GCM*SM3 and TLS*SM4*CCM*SM3 are currently in pilot testing. To request access, please contact your account manager\n", "items": { "type": "string" }, "type": "array" }, "createdTime": { "description": "Creation time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the TLS custom security policy belongs. If not specified, defaults to default\n", "type": "string" }, "relatedListenerIds": { "description": "Listener associated with the TLS security policy\n", "items": { "type": "string" }, "type": "array" }, "securityPolicyId": { "description": "Security policy ID\n", "type": "string" }, "securityPolicyName": { "description": "Security policy name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If this parameter is not specified, defaults to the policy ID\n", "type": "string" }, "status": { "description": "TLS custom security policy status. Creating: Being created. Configuring: Being configured. Active: Active. Deleting: Being deleted.\n", "type": "string" }, "tags": { "description": "Tag list\n", "items": { "$ref": "#/types/volcenginecc:clb/getNlbSecurityPolicyTag:getNlbSecurityPolicyTag" }, "type": "array" }, "tlsVersions": { "description": "Update the TLS protocol versions for the TLS custom security policy. Valid values: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. When specifying this parameter, you must provide all supported TLS versions. Adding or removing TLS protocol versions individually is not supported via this interface. If only TlsVersions.N is provided and Ciphers.N is not, validation is based on the TLS protocol versions in the request and the cipher suites supported by the current listener. If both TlsVersions.N and Ciphers.N are provided, validation is based on the TLS protocol versions and cipher suites specified in the request\n", "items": { "type": "string" }, "type": "array" }, "updatedTime": { "description": "Update time\n", "type": "string" } }, "required": [ "accountId", "ciphers", "createdTime", "id", "projectName", "relatedListenerIds", "securityPolicyId", "securityPolicyName", "status", "tags", "tlsVersions", "updatedTime" ], "type": "object" } }, "volcenginecc:clb/getNlbServerGroup:getNlbServerGroup": { "description": "Data Source schema for Volcengine::CLB::NLBServerGroup\n", "inputs": { "description": "A collection of arguments for invoking getNlbServerGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNlbServerGroup.\n", "properties": { "accountId": { "description": "Account ID\n", "type": "string" }, "anyPortEnabled": { "description": "Enable all-port forwarding\n", "type": "boolean" }, "bypassSecurityGroupEnabled": { "description": "Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.\n", "type": "boolean" }, "connectionDrainEnabled": { "description": "Enable graceful connection termination.\n", "type": "boolean" }, "connectionDrainTimeout": { "description": "Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.\n", "type": "integer" }, "createdTime": { "description": "Backend server group creation time\n", "type": "string" }, "description": { "description": "Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.\n", "type": "string" }, "healthCheck": { "$ref": "#/types/volcenginecc:clb/getNlbServerGroupHealthCheck:getNlbServerGroupHealthCheck", "description": "Health check parameters\n" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAddressVersion": { "description": "IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.\n", "type": "string" }, "preserveClientIpEnabled": { "description": "Enable source address persistence\n", "type": "boolean" }, "projectName": { "description": "Project name\n", "type": "string" }, "protocol": { "description": "Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.\n", "type": "string" }, "proxyProtocolType": { "description": "Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.\n", "type": "string" }, "relatedLoadBalancerIds": { "description": "NLB instance associated with the server group.\n", "items": { "type": "string" }, "type": "array" }, "scheduler": { "description": "Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.\n", "type": "string" }, "serverCount": { "description": "Number of backend servers in the server group.\n", "type": "integer" }, "serverGroupId": { "description": "Server group ID\n", "type": "string" }, "serverGroupName": { "description": "Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID\n", "type": "string" }, "servers": { "description": "Information about backend servers to be added to the server group\n", "items": { "$ref": "#/types/volcenginecc:clb/getNlbServerGroupServer:getNlbServerGroupServer" }, "type": "array" }, "sessionPersistenceEnabled": { "description": "Enable session persistence.\n", "type": "boolean" }, "sessionPersistenceTimeout": { "description": "Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds\n", "type": "integer" }, "status": { "description": "Server group status\n", "type": "string" }, "tags": { "description": "Tag\n", "items": { "$ref": "#/types/volcenginecc:clb/getNlbServerGroupTag:getNlbServerGroupTag" }, "type": "array" }, "timestampRemoveEnabled": { "description": "Enable removal of TCP/HTTP/HTTPS packet timestamps\n", "type": "boolean" }, "type": { "description": "Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.\n", "type": "string" }, "updatedTime": { "description": "Last update time of the backend server group.\n", "type": "string" }, "vpcId": { "description": "ID of the private network to which the server group belongs\n", "type": "string" } }, "required": [ "accountId", "anyPortEnabled", "bypassSecurityGroupEnabled", "connectionDrainEnabled", "connectionDrainTimeout", "createdTime", "description", "healthCheck", "id", "ipAddressVersion", "preserveClientIpEnabled", "projectName", "protocol", "proxyProtocolType", "relatedLoadBalancerIds", "scheduler", "serverCount", "serverGroupId", "serverGroupName", "servers", "sessionPersistenceEnabled", "sessionPersistenceTimeout", "status", "tags", "timestampRemoveEnabled", "type", "updatedTime", "vpcId" ], "type": "object" } }, "volcenginecc:clb/getNlbServerGroups:getNlbServerGroups": { "description": "Plural Data Source schema for Volcengine::CLB::NLBServerGroup\n", "outputs": { "description": "A collection of values returned by getNlbServerGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:clb/getNlbs:getNlbs": { "description": "Plural Data Source schema for Volcengine::CLB::NLB\n", "outputs": { "description": "A collection of values returned by getNlbs.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:clb/getRule:getRule": { "description": "Data Source schema for Volcengine::CLB::Rule\n", "inputs": { "description": "A collection of arguments for invoking getRule.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRule.\n", "properties": { "actionType": { "description": "Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.\n", "type": "string" }, "description": { "description": "Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length must be between 0 and 255 characters.\n", "type": "string" }, "domain": { "description": "Domain name of the forwarding rule.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listenerId": { "description": "Listener ID.\n", "type": "string" }, "redirectConfig": { "$ref": "#/types/volcenginecc:clb/getRuleRedirectConfig:getRuleRedirectConfig", "description": "Redirection-related configuration information.\n" }, "ruleId": { "description": "Forwarding rule ID.\n", "type": "string" }, "serverGroupId": { "description": "ID of the backend server group associated with the forwarding rule.\n", "type": "string" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:clb/getRuleTag:getRuleTag" }, "type": "array" }, "url": { "description": "URL of the forwarding rule.\n", "type": "string" } }, "required": [ "actionType", "description", "domain", "id", "listenerId", "redirectConfig", "ruleId", "serverGroupId", "tags", "url" ], "type": "object" } }, "volcenginecc:clb/getRules:getRules": { "description": "Plural Data Source schema for Volcengine::CLB::Rule\n", "outputs": { "description": "A collection of values returned by getRules.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:clb/getServerGroup:getServerGroup": { "description": "Data Source schema for Volcengine::CLB::ServerGroup\n", "inputs": { "description": "A collection of arguments for invoking getServerGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getServerGroup.\n", "properties": { "addressIpVersion": { "description": "IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.\n", "type": "string" }, "anyPortEnabled": { "description": "Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.\n", "type": "string" }, "createTime": { "description": "Creation time of the backend server group.\n", "type": "string" }, "description": { "description": "Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "listeners": { "description": "Listener information associated with the backend server group.\n", "items": { "$ref": "#/types/volcenginecc:clb/getServerGroupListener:getServerGroupListener" }, "type": "array" }, "loadBalancerId": { "description": "CLB instance ID to which the backend server group belongs.\n", "type": "string" }, "serverGroupId": { "description": "Backend server group ID.\n", "type": "string" }, "serverGroupName": { "description": "Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.\n", "type": "string" }, "servers": { "description": "Information about servers in the backend server group.\n", "items": { "$ref": "#/types/volcenginecc:clb/getServerGroupServer:getServerGroupServer" }, "type": "array" }, "tags": { "description": "Tag information.\n", "items": { "$ref": "#/types/volcenginecc:clb/getServerGroupTag:getServerGroupTag" }, "type": "array" }, "type": { "description": "Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.\n", "type": "string" }, "updateTime": { "description": "Last operation time of the backend server group.\n", "type": "string" } }, "required": [ "addressIpVersion", "anyPortEnabled", "createTime", "description", "id", "listeners", "loadBalancerId", "serverGroupId", "serverGroupName", "servers", "tags", "type", "updateTime" ], "type": "object" } }, "volcenginecc:clb/getServerGroups:getServerGroups": { "description": "Plural Data Source schema for Volcengine::CLB::ServerGroup\n", "outputs": { "description": "A collection of values returned by getServerGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cloudidentity/getGroup:getGroup": { "description": "Data Source schema for Volcengine::CloudIdentity::Group\n", "inputs": { "description": "A collection of arguments for invoking getGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getGroup.\n", "properties": { "createdTime": { "description": "Creation Time\n", "type": "string" }, "description": { "description": "Description\n", "type": "string" }, "displayName": { "description": "Display Name\n", "type": "string" }, "groupId": { "description": "User Group ID\n", "type": "string" }, "groupName": { "description": "User Group Name\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "joinType": { "description": "User Group Type\n", "type": "string" }, "members": { "description": "User Group Member List\n", "items": { "$ref": "#/types/volcenginecc:cloudidentity/getGroupMember:getGroupMember" }, "type": "array" }, "source": { "description": "User Group Source\n", "type": "string" }, "updatedTime": { "description": "Update Time\n", "type": "string" } }, "required": [ "createdTime", "description", "displayName", "groupId", "groupName", "id", "joinType", "members", "source", "updatedTime" ], "type": "object" } }, "volcenginecc:cloudidentity/getGroups:getGroups": { "description": "Plural Data Source schema for Volcengine::CloudIdentity::Group\n", "outputs": { "description": "A collection of values returned by getGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cloudidentity/getPermissionSet:getPermissionSet": { "description": "Data Source schema for Volcengine::CloudIdentity::PermissionSet\n", "inputs": { "description": "A collection of arguments for invoking getPermissionSet.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getPermissionSet.\n", "properties": { "createdTime": { "description": "Creation Time\n", "type": "string" }, "description": { "description": "Permission Set Description\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "name": { "description": "Permission Set Name\n", "type": "string" }, "permissionPolicies": { "description": "Policy List Under Permission Set\n", "items": { "$ref": "#/types/volcenginecc:cloudidentity/getPermissionSetPermissionPolicy:getPermissionSetPermissionPolicy" }, "type": "array" }, "permissionSetId": { "description": "Permission Set ID\n", "type": "string" }, "relayState": { "description": "Console Redirect URL\n", "type": "string" }, "sessionDuration": { "description": "Session Expiration Time (seconds)\n", "type": "integer" }, "statusNotifications": { "description": "Status Notification Configuration\n", "items": { "type": "string" }, "type": "array" }, "updatedTime": { "description": "Update Time\n", "type": "string" } }, "required": [ "createdTime", "description", "id", "name", "permissionPolicies", "permissionSetId", "relayState", "sessionDuration", "statusNotifications", "updatedTime" ], "type": "object" } }, "volcenginecc:cloudidentity/getPermissionSetAssignment:getPermissionSetAssignment": { "description": "Data Source schema for Volcengine::CloudIdentity::PermissionSetAssignment\n", "inputs": { "description": "A collection of arguments for invoking getPermissionSetAssignment.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getPermissionSetAssignment.\n", "properties": { "createdTime": { "description": "Authorization creation time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "permissionSetId": { "description": "Permission set ID\n", "type": "string" }, "permissionSetName": { "description": "Permission set name\n", "type": "string" }, "principalId": { "description": "Cloud Identity Center object ID\n", "type": "string" }, "principalName": { "description": "Cloud Identity Center object name\n", "type": "string" }, "principalType": { "description": "Cloud Identity Center object type: User or Group\n", "type": "string" }, "targetId": { "description": "Authorized account ID\n", "type": "string" }, "targetName": { "description": "Authorized account name\n", "type": "string" } }, "required": [ "createdTime", "id", "permissionSetId", "permissionSetName", "principalId", "principalName", "principalType", "targetId", "targetName" ], "type": "object" } }, "volcenginecc:cloudidentity/getPermissionSetAssignments:getPermissionSetAssignments": { "description": "Plural Data Source schema for Volcengine::CloudIdentity::PermissionSetAssignment\n", "outputs": { "description": "A collection of values returned by getPermissionSetAssignments.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cloudidentity/getPermissionSetProvisioning:getPermissionSetProvisioning": { "description": "Data Source schema for Volcengine::CloudIdentity::PermissionSetProvisioning\n", "inputs": { "description": "A collection of arguments for invoking getPermissionSetProvisioning.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getPermissionSetProvisioning.\n", "properties": { "createdTime": { "description": "Creation time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "permissionSetId": { "description": "Permission set ID\n", "type": "string" }, "permissionSetName": { "description": "Permission set name\n", "type": "string" }, "provisioningStatus": { "description": "Permission set status Running: In progress, Reprovision Required: Redeployment required, Provision Failed: Deployment failed, Provisioned: Deployed\n", "type": "string" }, "targetId": { "description": "Authorized account ID\n", "type": "string" }, "targetName": { "description": "Account name\n", "type": "string" }, "updatedTime": { "description": "Update time\n", "type": "string" } }, "required": [ "createdTime", "id", "permissionSetId", "permissionSetName", "provisioningStatus", "targetId", "targetName", "updatedTime" ], "type": "object" } }, "volcenginecc:cloudidentity/getPermissionSetProvisionings:getPermissionSetProvisionings": { "description": "Plural Data Source schema for Volcengine::CloudIdentity::PermissionSetProvisioning\n", "outputs": { "description": "A collection of values returned by getPermissionSetProvisionings.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cloudidentity/getPermissionSets:getPermissionSets": { "description": "Plural Data Source schema for Volcengine::CloudIdentity::PermissionSet\n", "outputs": { "description": "A collection of values returned by getPermissionSets.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cloudidentity/getUser:getUser": { "description": "Data Source schema for Volcengine::CloudIdentity::User\n", "inputs": { "description": "A collection of arguments for invoking getUser.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getUser.\n", "properties": { "createdTime": { "description": "Creation Time.\n", "type": "string" }, "description": { "description": "User Description.\n", "type": "string" }, "displayName": { "description": "User Display Name.\n", "type": "string" }, "email": { "description": "Email.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "identityType": { "description": "Identity Type.\n", "type": "string" }, "password": { "description": "Password. Password must be 8–32 characters long and include at least three of the following: uppercase letters, lowercase letters, numbers, and special symbols.\n", "type": "string" }, "passwordResetRequired": { "description": "Is password reset required on first login?\n", "type": "boolean" }, "phone": { "description": "Mobile Number.\n", "type": "string" }, "source": { "description": "User Source.\n", "type": "string" }, "updatedTime": { "description": "Update Time.\n", "type": "string" }, "userId": { "description": "User ID.\n", "type": "string" }, "userName": { "description": "Username.\n", "type": "string" } }, "required": [ "createdTime", "description", "displayName", "email", "id", "identityType", "password", "passwordResetRequired", "phone", "source", "updatedTime", "userId", "userName" ], "type": "object" } }, "volcenginecc:cloudidentity/getUserProvisioning:getUserProvisioning": { "description": "Data Source schema for Volcengine::CloudIdentity::UserProvisioning\n", "inputs": { "description": "A collection of arguments for invoking getUserProvisioning.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getUserProvisioning.\n", "properties": { "createdTime": { "description": "Creation Time\n", "type": "string" }, "deletionStrategy": { "description": "Deletion Policy\n", "type": "string" }, "description": { "description": "Task Description\n", "type": "string" }, "duplicationStrategy": { "description": "Username Conflict Policy\n", "type": "string" }, "duplicationSuffix": { "description": "Suffix for IAM user name in this synchronization\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "identitySourceStrategy": { "description": "Identity Source Conflict Policy\n", "type": "string" }, "principalId": { "description": "Identity ID\n", "type": "string" }, "principalName": { "description": "Target Name\n", "type": "string" }, "principalType": { "description": "Identity Type\n", "type": "string" }, "provisionStatus": { "description": "Authorization Task Status. Provisioned: authorization successful, Provisioning: authorizing, DeleteProvisioning: revoking authorization, DeleteProvisioned: authorization revoked successfully.\n", "type": "string" }, "targetId": { "description": "Target ID\n", "type": "string" }, "updatedTime": { "description": "Update Time\n", "type": "string" }, "userProvisioningId": { "description": "IAM User Synchronization Task ID\n", "type": "string" } }, "required": [ "createdTime", "deletionStrategy", "description", "duplicationStrategy", "duplicationSuffix", "id", "identitySourceStrategy", "principalId", "principalName", "principalType", "provisionStatus", "targetId", "updatedTime", "userProvisioningId" ], "type": "object" } }, "volcenginecc:cloudidentity/getUserProvisionings:getUserProvisionings": { "description": "Plural Data Source schema for Volcengine::CloudIdentity::UserProvisioning\n", "outputs": { "description": "A collection of values returned by getUserProvisionings.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cloudidentity/getUsers:getUsers": { "description": "Plural Data Source schema for Volcengine::CloudIdentity::User\n", "outputs": { "description": "A collection of values returned by getUsers.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cloudmonitor/getRule:getRule": { "description": "Data Source schema for Volcengine::CloudMonitor::Rule\n", "inputs": { "description": "A collection of arguments for invoking getRule.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRule.\n", "properties": { "alertMethods": { "description": "Alert notification method. Email: email, Phone: phone, SMS: SMS, Webhook: webhook callback.\n", "items": { "type": "string" }, "type": "array" }, "alertState": { "description": "Alert status. alerting: In alert; normal: Normal.\n", "type": "string" }, "conditionOperator": { "description": "Multi-metric determination condition. \u0026\u0026: Alert is triggered only if all metrics meet the condition; ||: Alert is triggered if any metric meets the condition.\n", "type": "string" }, "conditions": { "description": "Alert conditions. Array format; supports multiple metric evaluation statements, up to 10.\n", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleCondition:getRuleCondition" }, "type": "array" }, "contactGroupIds": { "description": "Alert notification group ID bound to the alert policy.\n", "items": { "type": "string" }, "type": "array" }, "createdAt": { "description": "Alert policy creation time, in timestamp format.\n", "type": "string" }, "description": { "description": "Alert policy description.\n", "type": "string" }, "dimensionConditions": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleDimensionConditions:getRuleDimensionConditions", "description": "Dimension configuration.\n" }, "effectEndAt": { "description": "Policy expiration time, in HH:MM format.\n", "type": "string" }, "effectStartAt": { "description": "Policy start time, in HH:MM format.\n", "type": "string" }, "enableState": { "description": "Alert policy status. enable: enabled, disable: disabled\n", "type": "string" }, "evaluationCount": { "description": "Duration required to trigger an alert, in minutes.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "level": { "description": "Alert level. critical: critical, warning: warning, notice: notification\n", "type": "string" }, "levelConditions": { "description": "Alert severity configuration.\n", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleLevelCondition:getRuleLevelCondition" }, "type": "array" }, "multipleConditions": { "description": "Does the alert policy use multiple metrics? true: multiple metrics, false: single metric (default).\n", "type": "boolean" }, "namespace": { "description": "Cloud product associated with the monitoring metric. For details, see Namespace for each product in Cloud Product Monitoring Metrics.\n", "type": "string" }, "noData": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleNoData:getRuleNoData", "description": "No data alert.\n" }, "notificationId": { "description": "Notification policy ID.\n", "type": "string" }, "notifyTemplates": { "description": "Notification template configuration.\n", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleNotifyTemplate:getRuleNotifyTemplate" }, "type": "array" }, "originalDimensions": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleOriginalDimensions:getRuleOriginalDimensions", "description": "Resource ID detected by the alert policy.\n" }, "projectName": { "description": "Project to which the alert policy belongs.\n", "type": "string" }, "recoveryNotify": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleRecoveryNotify:getRuleRecoveryNotify", "description": "Alert recovery notification.\n" }, "regions": { "description": "Availability zone ID of the cloud product.\n", "items": { "type": "string" }, "type": "array" }, "resourceType": { "description": "Resource type detected by the alert policy.\n", "type": "string" }, "ruleId": { "description": "Alarm policy ID.\n", "type": "string" }, "ruleName": { "description": "Alert policy name.\n", "type": "string" }, "ruleType": { "description": "Alert policy type. static: manual selection, dynamic: select by resource name, project, and tag.\n", "type": "string" }, "silenceTime": { "description": "Alert sending interval, in minutes. Supported values: 5, 10, 15, 30, 60, 180, 360, 720, 1440.\n", "type": "integer" }, "subNamespace": { "description": "Dimension of the metric referenced by this policy. For details, see SubNamespace for each product in Cloud Product Monitoring Metrics.\n", "type": "string" }, "tags": { "description": "Bind alert policy to Tag.\n", "items": { "$ref": "#/types/volcenginecc:cloudmonitor/getRuleTag:getRuleTag" }, "type": "array" }, "updatedAt": { "description": "Alarm policy update time, in timestamp format.\n", "type": "string" }, "webhook": { "description": "Alarm callback URL bound to the alarm policy.\n", "type": "string" }, "webhookIds": { "description": "Alarm callback ID list when an alarm occurs.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "alertMethods", "alertState", "conditionOperator", "conditions", "contactGroupIds", "createdAt", "description", "dimensionConditions", "effectEndAt", "effectStartAt", "enableState", "evaluationCount", "id", "level", "levelConditions", "multipleConditions", "namespace", "noData", "notificationId", "notifyTemplates", "originalDimensions", "projectName", "recoveryNotify", "regions", "resourceType", "ruleId", "ruleName", "ruleType", "silenceTime", "subNamespace", "tags", "updatedAt", "webhook", "webhookIds" ], "type": "object" } }, "volcenginecc:cloudmonitor/getRules:getRules": { "description": "Plural Data Source schema for Volcengine::CloudMonitor::Rule\n", "outputs": { "description": "A collection of values returned by getRules.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cr/getEndpointAclPolicies:getEndpointAclPolicies": { "description": "Plural Data Source schema for Volcengine::CR::EndpointAclPolicy\n", "outputs": { "description": "A collection of values returned by getEndpointAclPolicies.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cr/getEndpointAclPolicy:getEndpointAclPolicy": { "description": "Data Source schema for Volcengine::CR::EndpointAclPolicy\n", "inputs": { "description": "A collection of arguments for invoking getEndpointAclPolicy.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getEndpointAclPolicy.\n", "properties": { "description": { "description": "Description of the allowlist IPs\n", "type": "string" }, "entry": { "description": "Allowlist IPs to be added\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "registry": { "description": "Name of the image repository instance. On the Instance List page in the Image Repository Console, obtain the instance name\n", "type": "string" }, "type": { "description": "Network type of the allowlist; currently only Public is supported\n", "type": "string" } }, "required": [ "description", "entry", "id", "registry", "type" ], "type": "object" } }, "volcenginecc:cr/getNameSpace:getNameSpace": { "description": "Data Source schema for Volcengine::CR::NameSpace\n", "inputs": { "description": "A collection of arguments for invoking getNameSpace.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNameSpace.\n", "properties": { "createdTime": { "description": "Namespace creation time.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "name": { "description": "Namespace name. Supports lowercase English letters, numbers, periods (.), hyphens (-), and underscores (_). Punctuation cannot appear at the beginning or end, nor be used consecutively. Length must be between 2 and 90 characters. Standard edition instance: The name must be unique within the same image repository instance. Trial edition instance: The namespace name must be unique across all accounts within the same region. If the namespace name you set is already taken, try another name or purchase a standard edition instance.\n", "type": "string" }, "project": { "description": "Name of the project to which the namespace belongs. This parameter is case-sensitive and must not exceed 64 characters. If the parameter is empty, the namespace is associated with the default project.\n", "type": "string" }, "registry": { "description": "Specify the image repository instance name. Obtain it via ListRegistries or from the instance list page in the image repository console.\n", "type": "string" } }, "required": [ "createdTime", "id", "name", "project", "registry" ], "type": "object" } }, "volcenginecc:cr/getNameSpaces:getNameSpaces": { "description": "Plural Data Source schema for Volcengine::CR::NameSpace\n", "outputs": { "description": "A collection of values returned by getNameSpaces.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cr/getRegistries:getRegistries": { "description": "Plural Data Source schema for Volcengine::CR::Registry\n", "outputs": { "description": "A collection of values returned by getRegistries.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cr/getRegistry:getRegistry": { "description": "Data Source schema for Volcengine::CR::Registry\n", "inputs": { "description": "A collection of arguments for invoking getRegistry.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRegistry.\n", "properties": { "chargeType": { "description": "Container registry instance billing type. Currently, only the PostCharge pay-as-you-go mode is supported.\n", "type": "string" }, "createdTime": { "description": "Time when the container registry instance was created.\n", "type": "string" }, "endpoint": { "$ref": "#/types/volcenginecc:cr/getRegistryEndpoint:getRegistryEndpoint", "description": "Public endpoint information for the image repository instance\n" }, "expireTime": { "description": "Only applicable when the billing type is HybridCharge. Instance expiration time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "name": { "description": "Standard Edition instance name. Names must be unique within the same region. Supports lowercase English letters, numbers, and hyphens (-). Numbers cannot be the first character, and hyphens (-) cannot be the first or last character. Length must be between 3 and 30 characters.\n", "type": "string" }, "project": { "description": "Specify the project to associate with the instance. Each instance can only be associated with one project\n", "type": "string" }, "proxyCache": { "$ref": "#/types/volcenginecc:cr/getRegistryProxyCache:getRegistryProxyCache", "description": "ProxyCache configuration. Required when set to ProxyCache\n" }, "proxyCacheEnabled": { "description": "Whether to set as ProxyCache instance\n", "type": "boolean" }, "renewType": { "description": "Only applicable when the billing type is HybridCharge. Instance auto-renewal type\n", "type": "string" }, "status": { "$ref": "#/types/volcenginecc:cr/getRegistryStatus:getRegistryStatus", "description": "Container registry instance status, composed of Phase and Conditions. Valid Phase and Conditions combinations are as follows: {Creating, [Progressing]}: Creating, {Running, [Ok]}: Running, {Running, [Degraded]}: Running, {Stopped, [Balance]}: Suspended due to overdue payment, {Stopped, [Released]}: Pending recycle, {Stopped, [Released, Balance]}: Suspended due to overdue payment, {Starting, [Progressing]}: Starting, {Deleting, [Progressing]}: Deleting, {Failed, [Unknown]}: Error\n" }, "tags": { "description": "Instance tags\n", "items": { "$ref": "#/types/volcenginecc:cr/getRegistryTag:getRegistryTag" }, "type": "array" }, "type": { "description": "If not specified, a Standard Edition instance will be created by default. Enterprise: Standard Edition, Micro: Micro Edition\n", "type": "string" } }, "required": [ "chargeType", "createdTime", "endpoint", "expireTime", "id", "name", "project", "proxyCache", "proxyCacheEnabled", "renewType", "status", "tags", "type" ], "type": "object" } }, "volcenginecc:cr/getRepositories:getRepositories": { "description": "Plural Data Source schema for Volcengine::CR::Repository\n", "outputs": { "description": "A collection of values returned by getRepositories.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:cr/getRepository:getRepository": { "description": "Data Source schema for Volcengine::CR::Repository\n", "inputs": { "description": "A collection of arguments for invoking getRepository.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRepository.\n", "properties": { "accessLevel": { "description": "Access level. Values include: Private: Private OCI artifact repository, accessible only to authorized users. Public: Public OCI artifact repository, accessible to all users. You can specify one or more access levels in a single entry.\n", "type": "string" }, "createTime": { "description": "Creation time of the OCI artifact repository. RFC3339 format, UTC+0 time.\n", "type": "string" }, "description": { "description": "Image repository description, with a length of 0–300 UTF-8 characters.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "name": { "description": "OCI artifact repository name. The name must be unique within the same namespace. Supports lowercase English letters, numbers, and delimiters (delimiters can be a single '.' or '/', one or more '-', or one or two '_'. Delimiters cannot appear at the beginning or end of the name, nor can they appear consecutively). Length must be between 1 and 128 characters.\n", "type": "string" }, "namespace": { "description": "Target namespace name. Obtain the namespace name from the Namespace page of the target instance in the Image Repository Console.\n", "type": "string" }, "registry": { "description": "Specify the name of the image repository instance to which the namespace belongs. Obtain the instance name from the Instance List page in the Image Repository Console.\n", "type": "string" }, "updateTime": { "description": "Last updated time for the OCI artifact repository. RFC3339 format, UTC+0 time.\n", "type": "string" } }, "required": [ "accessLevel", "createTime", "description", "id", "name", "namespace", "registry", "updateTime" ], "type": "object" } }, "volcenginecc:directconnect/getDirectConnectGateway:getDirectConnectGateway": { "description": "Data Source schema for Volcengine::DirectConnect::DirectConnectGateway\n", "inputs": { "description": "A collection of arguments for invoking getDirectConnectGateway.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDirectConnectGateway.\n", "properties": { "accountId": { "description": "ID of the account to which the Direct Connect Gateway belongs.\n", "type": "string" }, "associateCens": { "description": "Associated CEN information.\n", "items": { "$ref": "#/types/volcenginecc:directconnect/getDirectConnectGatewayAssociateCen:getDirectConnectGatewayAssociateCen" }, "type": "array" }, "associateEic": { "$ref": "#/types/volcenginecc:directconnect/getDirectConnectGatewayAssociateEic:getDirectConnectGatewayAssociateEic", "description": "Associated EIC information.\n" }, "bgpAsn": { "description": "ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.\n", "type": "integer" }, "businessStatus": { "description": "Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.\n", "type": "string" }, "createdTime": { "description": "Time when the Direct Connect Gateway was created.\n", "type": "string" }, "deletedTime": { "description": "Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.\n", "type": "string" }, "description": { "description": "Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.\n", "type": "string" }, "directConnectGatewayId": { "description": "ID of the Direct Connect Gateway.\n", "type": "string" }, "directConnectGatewayName": { "description": "Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.\n", "type": "string" }, "enableIpv6": { "description": "Whether IPv6 is supported. true: supported. false: not supported.\n", "type": "boolean" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lockReason": { "description": "Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.\n", "type": "string" }, "overdueTime": { "description": "Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.\n", "type": "string" }, "projectName": { "description": "Project to which the Direct Connect Gateway belongs.\n", "type": "string" }, "status": { "description": "Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.\n", "type": "string" }, "tags": { "description": "All tag information added to the Direct Connect Gateway.\n", "items": { "$ref": "#/types/volcenginecc:directconnect/getDirectConnectGatewayTag:getDirectConnectGatewayTag" }, "type": "array" }, "updatedTime": { "description": "Time when the Direct Connect Gateway was updated.\n", "type": "string" } }, "required": [ "accountId", "associateCens", "associateEic", "bgpAsn", "businessStatus", "createdTime", "deletedTime", "description", "directConnectGatewayId", "directConnectGatewayName", "enableIpv6", "id", "lockReason", "overdueTime", "projectName", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:directconnect/getDirectConnectGateways:getDirectConnectGateways": { "description": "Plural Data Source schema for Volcengine::DirectConnect::DirectConnectGateway\n", "outputs": { "description": "A collection of values returned by getDirectConnectGateways.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:dns/getZone:getZone": { "description": "Data Source schema for Volcengine::DNS::Zone\n", "inputs": { "description": "A collection of arguments for invoking getZone.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getZone.\n", "properties": { "allocateDnsServerLists": { "description": "List of DNS servers assigned to the domain by Cloud DNS\n", "items": { "type": "string" }, "type": "array" }, "autoRenew": { "description": "Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.\n", "type": "boolean" }, "cacheStage": { "description": "Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.\n", "type": "integer" }, "createdTime": { "description": "Domain creation time.\n", "type": "string" }, "dnsSecurity": { "description": "Version of DNS DDoS protection service. dns*security*standard_inner: Standard protection edition. \"\": No protection edition.\n", "type": "string" }, "expiredTime": { "description": "Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID. For Cloud DNS Free Edition, this field is null.\n", "type": "string" }, "instanceNo": { "description": "Instance ID. For Cloud DNS Free Edition, this field is null.\n", "type": "string" }, "isNsCorrect": { "description": "Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.\n", "type": "boolean" }, "isSubDomain": { "description": "Whether it is a subdomain. true: Subdomain. false: Primary domain.\n", "type": "boolean" }, "lastOperator": { "description": "ID of the account that created the domain.\n", "type": "string" }, "projectName": { "description": "Domain project.\n", "type": "string" }, "realDnsServerLists": { "description": "List of DNS servers actually used by the domain.\n", "items": { "type": "string" }, "type": "array" }, "recordCount": { "description": "Total number of DNS records contained in the domain.\n", "type": "integer" }, "remark": { "description": "Domain notes\n", "type": "string" }, "stage": { "description": "Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.\n", "type": "integer" }, "subDomainHost": { "description": "Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.\n", "type": "string" }, "tags": { "description": "Tags for the domain. Default is empty.\n", "items": { "$ref": "#/types/volcenginecc:dns/getZoneTag:getZoneTag" }, "type": "array" }, "tradeCode": { "description": "Domain feature version. This parameter has the following values: free*inner: Free Edition; professional*inner: Professional Edition; enterprise*inner: Enterprise Edition; ultimate*inner: Flagship Edition; ultimate*exclusive*inner: Premium Edition.\n", "type": "string" }, "updatedTime": { "description": "Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.\n", "type": "string" }, "zid": { "description": "Domain ID.\n", "type": "string" }, "zoneName": { "description": "Domain name.\n", "type": "string" } }, "required": [ "allocateDnsServerLists", "autoRenew", "cacheStage", "createdTime", "dnsSecurity", "expiredTime", "id", "instanceId", "instanceNo", "isNsCorrect", "isSubDomain", "lastOperator", "projectName", "realDnsServerLists", "recordCount", "remark", "stage", "subDomainHost", "tags", "tradeCode", "updatedTime", "zid", "zoneName" ], "type": "object" } }, "volcenginecc:dns/getZones:getZones": { "description": "Plural Data Source schema for Volcengine::DNS::Zone\n", "outputs": { "description": "A collection of values returned by getZones.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ecs/getCommand:getCommand": { "description": "Data Source schema for Volcengine::ECS::Command\n", "inputs": { "description": "A collection of arguments for invoking getCommand.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getCommand.\n", "properties": { "commandContent": { "description": "Command content. Enter the command content according to the ContentEncoding parameter. Command content must not exceed 16 KB.\n", "type": "string" }, "commandId": { "description": "Custom command ID.\n", "type": "string" }, "contentEncoding": { "description": "Whether the command content is processed with Base64 encoding. Base64 (default): Processed with Base64 encoding. PlainText: Not encoded.\n", "type": "string" }, "createdTime": { "description": "Creation time.\n", "type": "string" }, "description": { "description": "Command description. Defaults to an empty string. Character length: 0~256. No restriction on special characters.\n", "type": "string" }, "enableParameter": { "description": "Whether the created command uses custom parameters. false: Default, does not use custom parameters. true: Uses custom parameters.\n", "type": "boolean" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "invocationTimes": { "description": "Number of times the command has been invoked.\n", "type": "integer" }, "name": { "description": "Command name. Character length: 1~32. No restriction on special characters.\n", "type": "string" }, "parameterDefinitions": { "description": "Custom parameter definition information.\n", "items": { "$ref": "#/types/volcenginecc:ecs/getCommandParameterDefinition:getCommandParameterDefinition" }, "type": "array" }, "projectName": { "description": "Project to which the resource belongs. Each resource can belong to only one project.\n", "type": "string" }, "providerName": { "description": "Command provider.\n", "type": "string" }, "tags": { "description": "Tag key-value pair.\n", "items": { "$ref": "#/types/volcenginecc:ecs/getCommandTag:getCommandTag" }, "type": "array" }, "timeout": { "description": "Maximum timeout for executing the created command on ECS instances, in seconds. Value range: 30~86400. Default: 60.\n", "type": "integer" }, "type": { "description": "Command type. Shell: Creates a Shell script for Linux instances. Python: Creates a Python script. Bat: Creates a Bat script. PowerShell: Creates a PowerShell script.\n", "type": "string" }, "updatedTime": { "description": "Update time.\n", "type": "string" }, "username": { "description": "Username for executing the command.\n", "type": "string" }, "workingDir": { "description": "Directory where the created command runs on ECS instances.\n", "type": "string" } }, "required": [ "commandContent", "commandId", "contentEncoding", "createdTime", "description", "enableParameter", "id", "invocationTimes", "name", "parameterDefinitions", "projectName", "providerName", "tags", "timeout", "type", "updatedTime", "username", "workingDir" ], "type": "object" } }, "volcenginecc:ecs/getCommands:getCommands": { "description": "Plural Data Source schema for Volcengine::ECS::Command\n", "outputs": { "description": "A collection of values returned by getCommands.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ecs/getDeploymentSet:getDeploymentSet": { "description": "Data Source schema for Volcengine::ECS::DeploymentSet\n", "inputs": { "description": "A collection of arguments for invoking getDeploymentSet.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDeploymentSet.\n", "properties": { "capacities": { "description": "Instance launch template version information.\n", "items": { "$ref": "#/types/volcenginecc:ecs/getDeploymentSetCapacity:getDeploymentSetCapacity" }, "type": "array" }, "createdAt": { "description": "Deployment set creation time.\n", "type": "string" }, "deploymentSetGroupNumber": { "description": "Deployment set group index. Value range: 1–7.\n", "type": "integer" }, "deploymentSetId": { "description": "Deployment set ID.\n", "type": "string" }, "deploymentSetName": { "description": "Deployment set name. Cannot start with a digit, hyphen, or underscore. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length limit: 1–128 characters.\n", "type": "string" }, "description": { "description": "Deployment set description. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, digits, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。'. Length limit: within 255 characters.\n", "type": "string" }, "granularity": { "description": "Deployment granularity. Options: host: physical machine. rack: rack. switch: switch.\n", "type": "string" }, "groupCount": { "description": "Number of deployment set groups. Set the group count for the deployment set group high availability policy. Value range: 1–7. Default: 7.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceAmount": { "description": "Number of ECS instances in the deployment set.\n", "type": "integer" }, "instanceIds": { "description": "List of ECS instance IDs in the deployment set.\n", "items": { "type": "string" }, "type": "array" }, "strategy": { "description": "Deployment policy. Options: Availability (default): high availability policy. AvailabilityGroup: deployment set group high availability policy.\n", "type": "string" } }, "required": [ "capacities", "createdAt", "deploymentSetGroupNumber", "deploymentSetId", "deploymentSetName", "description", "granularity", "groupCount", "id", "instanceAmount", "instanceIds", "strategy" ], "type": "object" } }, "volcenginecc:ecs/getDeploymentSets:getDeploymentSets": { "description": "Plural Data Source schema for Volcengine::ECS::DeploymentSet\n", "outputs": { "description": "A collection of values returned by getDeploymentSets.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ecs/getHpcCluster:getHpcCluster": { "description": "Data Source schema for Volcengine::ECS::HpcCluster\n", "inputs": { "description": "A collection of arguments for invoking getHpcCluster.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getHpcCluster.\n", "properties": { "createdTime": { "description": "Creation time, formatted according to RFC3339\n", "type": "string" }, "description": { "description": "High performance compute cluster description. Defaults to an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length must be between 0 and 255 characters\n", "type": "string" }, "hpcClusterId": { "description": "High performance compute cluster ID\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "name": { "description": "High performance compute cluster name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length must be between 1 and 128 characters\n", "type": "string" }, "projectName": { "description": "Project name\n", "type": "string" }, "tags": { "description": "Tag information\n", "items": { "$ref": "#/types/volcenginecc:ecs/getHpcClusterTag:getHpcClusterTag" }, "type": "array" }, "updatedTime": { "description": "Update time, formatted according to RFC3339\n", "type": "string" }, "vpcId": { "description": "Private network ID\n", "type": "string" }, "zoneId": { "description": "Availability zone ID of the high performance compute cluster\n", "type": "string" } }, "required": [ "createdTime", "description", "hpcClusterId", "id", "name", "projectName", "tags", "updatedTime", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:ecs/getHpcClusters:getHpcClusters": { "description": "Plural Data Source schema for Volcengine::ECS::HpcCluster\n", "outputs": { "description": "A collection of values returned by getHpcClusters.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ecs/getImage:getImage": { "description": "Data Source schema for Volcengine::ECS::Image\n", "inputs": { "description": "A collection of arguments for invoking getImage.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getImage.\n", "properties": { "architecture": { "description": "Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).\n", "type": "string" }, "bootMode": { "description": "Image boot mode. You can select BIOS or UEFI\n", "type": "string" }, "createWholeImage": { "description": "Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.\n", "type": "boolean" }, "createdAt": { "description": "Image creation time\n", "type": "string" }, "description": { "description": "Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores \"_\", hyphens \"-\", equals signs \"=\", English commas \",\", English periods \".\", Chinese commas \"，\", Chinese periods \"。\", and spaces. Length: 0–255 characters. If left blank, defaults to empty.\n", "type": "string" }, "detectionResults": { "$ref": "#/types/volcenginecc:ecs/getImageDetectionResults:getImageDetectionResults", "description": "Image check result.\n" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "imageId": { "description": "Image ID\n", "type": "string" }, "imageName": { "description": "Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores \"_\", hyphens \"-\", and periods \".\". Length: 1–128 characters\n", "type": "string" }, "imageOwnerId": { "description": "Account ID to which the image belongs.\n", "type": "string" }, "importImage": { "$ref": "#/types/volcenginecc:ecs/getImageImportImage:getImageImportImage", "description": "Imported image information\n" }, "instanceId": { "description": "Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.\n", "type": "string" }, "isInstallRunCommandAgent": { "description": "Whether Cloud Assistant Agent is installed in the image\n", "type": "boolean" }, "isLts": { "description": "Whether the public image is maintained long-term.\n", "type": "boolean" }, "isSupportCloudInit": { "description": "Whether the image supports Cloud-init.\n", "type": "boolean" }, "kernel": { "description": "Image kernel version.\n", "type": "string" }, "licenseType": { "description": "Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)\n", "type": "string" }, "needDetection": { "description": "Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.\n", "type": "boolean" }, "osName": { "description": "Name of the image operating system.\n", "type": "string" }, "osType": { "description": "Operating system type\n", "type": "string" }, "platform": { "description": "Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.\n", "type": "string" }, "platformVersion": { "description": "Image release version.\n", "type": "string" }, "productCode": { "description": "Product code for marketplace image\n", "type": "string" }, "projectName": { "description": "Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions\n", "type": "string" }, "sharePermissions": { "description": "Accounts with which the image is shared\n", "items": { "type": "string" }, "type": "array" }, "shareStatus": { "description": "Image sharing status. HasShared: The custom image has been shared with other users. If the custom image is not shared or a public image is used, ShareStatus returns empty.\n", "type": "string" }, "size": { "description": "Image size, in GiB.\n", "type": "integer" }, "snapshotGroupId": { "description": "Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided\n", "type": "string" }, "snapshotId": { "description": "System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.\n", "type": "string" }, "snapshots": { "description": "Information about snapshots associated with the image.\n", "items": { "$ref": "#/types/volcenginecc:ecs/getImageSnapshot:getImageSnapshot" }, "type": "array" }, "status": { "description": "Image status.\n", "type": "string" }, "tags": { "description": "List of tags bound to the image.\n", "items": { "$ref": "#/types/volcenginecc:ecs/getImageTag:getImageTag" }, "type": "array" }, "updatedAt": { "description": "Image update time\n", "type": "string" }, "virtualSize": { "description": "Image size, in Bytes.\n", "type": "number" }, "visibility": { "description": "Image visibility. public: Public image. private: Private image. shared: Shared image.\n", "type": "string" } }, "required": [ "architecture", "bootMode", "createWholeImage", "createdAt", "description", "detectionResults", "id", "imageId", "imageName", "imageOwnerId", "importImage", "instanceId", "isInstallRunCommandAgent", "isLts", "isSupportCloudInit", "kernel", "licenseType", "needDetection", "osName", "osType", "platform", "platformVersion", "productCode", "projectName", "sharePermissions", "shareStatus", "size", "snapshotGroupId", "snapshotId", "snapshots", "status", "tags", "updatedAt", "virtualSize", "visibility" ], "type": "object" } }, "volcenginecc:ecs/getImages:getImages": { "description": "Plural Data Source schema for Volcengine::ECS::Image\n", "outputs": { "description": "A collection of values returned by getImages.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ecs/getInstance:getInstance": { "description": "Data Source schema for Volcengine::ECS::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "affinityGroupId": { "type": "string" }, "affinityGroupSize": { "type": "integer" }, "autoPay": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "autoRenewPeriod": { "type": "integer" }, "cpuMaxFrequency": { "type": "number" }, "cpuMemory": { "$ref": "#/types/volcenginecc:ecs/getInstanceCpuMemory:getInstanceCpuMemory" }, "createdAt": { "type": "string" }, "creditSpecification": { "type": "string" }, "deletionProtection": { "type": "boolean" }, "deploymentSetGroupNumber": { "type": "integer" }, "deploymentSetId": { "type": "string" }, "description": { "type": "string" }, "eipAddress": { "$ref": "#/types/volcenginecc:ecs/getInstanceEipAddress:getInstanceEipAddress" }, "elasticScheduledInstanceType": { "type": "string" }, "enableJumboFrame": { "type": "boolean" }, "expiredAt": { "type": "string" }, "hostname": { "type": "string" }, "hpcClusterId": { "type": "string" }, "id": { "type": "string" }, "image": { "$ref": "#/types/volcenginecc:ecs/getInstanceImage:getInstanceImage" }, "includeDataVolumes": { "type": "boolean" }, "installRunCommandAgent": { "type": "boolean" }, "instanceChargeType": { "type": "string" }, "instanceId": { "type": "string" }, "instanceName": { "type": "string" }, "instanceType": { "type": "string" }, "keyPair": { "$ref": "#/types/volcenginecc:ecs/getInstanceKeyPair:getInstanceKeyPair" }, "localVolumes": { "items": { "$ref": "#/types/volcenginecc:ecs/getInstanceLocalVolume:getInstanceLocalVolume" }, "type": "array" }, "operationSystem": { "$ref": "#/types/volcenginecc:ecs/getInstanceOperationSystem:getInstanceOperationSystem" }, "password": { "type": "string" }, "period": { "type": "integer" }, "periodUnit": { "type": "string" }, "placement": { "$ref": "#/types/volcenginecc:ecs/getInstancePlacement:getInstancePlacement" }, "primaryNetworkInterface": { "$ref": "#/types/volcenginecc:ecs/getInstancePrimaryNetworkInterface:getInstancePrimaryNetworkInterface" }, "projectName": { "type": "string" }, "rdmaIpAddresses": { "items": { "type": "string" }, "type": "array" }, "rdmaNetworkInterfaceDetails": { "items": { "$ref": "#/types/volcenginecc:ecs/getInstanceRdmaNetworkInterfaceDetail:getInstanceRdmaNetworkInterfaceDetail" }, "type": "array" }, "renewInfo": { "$ref": "#/types/volcenginecc:ecs/getInstanceRenewInfo:getInstanceRenewInfo" }, "roleNames": { "items": { "type": "string" }, "type": "array" }, "secondaryNetworkInterfaces": { "items": { "$ref": "#/types/volcenginecc:ecs/getInstanceSecondaryNetworkInterface:getInstanceSecondaryNetworkInterface" }, "type": "array" }, "spotPriceLimit": { "type": "number" }, "spotStrategy": { "type": "string" }, "status": { "type": "string" }, "stoppedMode": { "type": "string" }, "systemVolume": { "$ref": "#/types/volcenginecc:ecs/getInstanceSystemVolume:getInstanceSystemVolume" }, "tags": { "items": { "$ref": "#/types/volcenginecc:ecs/getInstanceTag:getInstanceTag" }, "type": "array" }, "updatedAt": { "type": "string" }, "userData": { "type": "string" }, "vpcId": { "type": "string" }, "zoneId": { "type": "string" } }, "required": [ "affinityGroupId", "affinityGroupSize", "autoPay", "autoRenew", "autoRenewPeriod", "cpuMaxFrequency", "cpuMemory", "createdAt", "creditSpecification", "deletionProtection", "deploymentSetGroupNumber", "deploymentSetId", "description", "eipAddress", "elasticScheduledInstanceType", "enableJumboFrame", "expiredAt", "hostname", "hpcClusterId", "id", "image", "includeDataVolumes", "installRunCommandAgent", "instanceChargeType", "instanceId", "instanceName", "instanceType", "keyPair", "localVolumes", "operationSystem", "password", "period", "periodUnit", "placement", "primaryNetworkInterface", "projectName", "rdmaIpAddresses", "rdmaNetworkInterfaceDetails", "renewInfo", "roleNames", "secondaryNetworkInterfaces", "spotPriceLimit", "spotStrategy", "status", "stoppedMode", "systemVolume", "tags", "updatedAt", "userData", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:ecs/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::ECS::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ecs/getInvocation:getInvocation": { "description": "Data Source schema for Volcengine::ECS::Invocation\n", "inputs": { "description": "A collection of arguments for invoking getInvocation.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInvocation.\n", "properties": { "commandContent": { "description": "Command content.\n", "type": "string" }, "commandDescription": { "description": "Description of the invoked command.\n", "type": "string" }, "commandId": { "description": "Command ID.\n", "type": "string" }, "commandName": { "description": "Command name when the task is triggered.\n", "type": "string" }, "commandProvider": { "description": "Provider of the invoked command.\n", "type": "string" }, "commandType": { "description": "Command type triggered by the job.\n", "type": "string" }, "enableParameter": { "description": "Whether the invoked command uses custom parameters. true: enabled. false: not enabled.\n", "type": "boolean" }, "endTime": { "description": "Task end time.\n", "type": "string" }, "frequency": { "description": "Execution frequency. This parameter is required when RepeatMode=Rate. Format: \\n\\n\\n\\n. Interval units supported: minutes (5m–60m), hours (1h–24h), and days (1d–7d). The interval is based on a fixed frequency and is independent of the actual job execution time. After job creation, it executes once based on LaunchTime, and the next execution time is determined by the interval setting.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceIds": { "description": "Instance ID list, supports up to 200 IDs.\n", "items": { "type": "string" }, "type": "array" }, "instanceNumber": { "description": "Number of instances executed.\n", "type": "integer" }, "invocationDescription": { "description": "Job description. Defaults to an empty string and must not exceed 256 characters.\n", "type": "string" }, "invocationId": { "description": "Task execution ID.\n", "type": "string" }, "invocationName": { "description": "Job name. Maximum 64 characters. No restriction on special characters. Job names can be duplicated within the same region.\n", "type": "string" }, "invocationResults": { "description": "Result of command execution on a single instance.\n", "items": { "$ref": "#/types/volcenginecc:ecs/getInvocationInvocationResult:getInvocationInvocationResult" }, "type": "array" }, "invocationStatus": { "description": "Overall execution status of the command.\n", "type": "string" }, "launchTime": { "description": "Execution time.\n", "type": "string" }, "parameterDefinitions": { "description": "Custom parameter definition for the command triggered by the task.\n", "items": { "$ref": "#/types/volcenginecc:ecs/getInvocationParameterDefinition:getInvocationParameterDefinition" }, "type": "array" }, "parameters": { "description": "When the command includes custom parameters, use this parameter to pass custom parameter key-value pairs. The number of custom parameters ranges from 0 to 60. Key cannot be an empty string and supports up to 64 characters. Value can be an empty string. The combined length of custom parameters and original command content after Base64 encoding must not exceed 16 KB. The set of custom parameter names must be a subset of the parameter set defined when creating the command. Default values are used for parameters not provided.\n", "type": "string" }, "projectName": { "description": "Project to which the resource belongs; each resource can belong to only one project.\n", "type": "string" }, "recurrenceEndTime": { "description": "Cycle end time, applicable only to periodic tasks (Rate).\n", "type": "string" }, "repeatMode": { "description": "Set the command execution mode. Once: Default, executes the command immediately. Rate: Executes the command periodically; specify the execution cycle using the Frequency parameter and Rate expression. Fixed: Executes the command at a scheduled time; specify the execution time using the LaunchTime parameter.\n", "type": "string" }, "startTime": { "description": "Task start time.\n", "type": "string" }, "tags": { "description": "Tag key-value pair.\n", "items": { "$ref": "#/types/volcenginecc:ecs/getInvocationTag:getInvocationTag" }, "type": "array" }, "timeout": { "description": "Maximum timeout for command execution in ECS instances, in seconds. Default: 60. Optional range: 30–86400.\n", "type": "integer" }, "username": { "description": "User name for executing the command in the ECS instance.\n", "type": "string" }, "windowsPassword": { "description": "Password for custom Windows user.\n", "type": "string" }, "workingDir": { "description": "Directory where the created command runs in the ECS instance.\n", "type": "string" } }, "required": [ "commandContent", "commandDescription", "commandId", "commandName", "commandProvider", "commandType", "enableParameter", "endTime", "frequency", "id", "instanceIds", "instanceNumber", "invocationDescription", "invocationId", "invocationName", "invocationResults", "invocationStatus", "launchTime", "parameterDefinitions", "parameters", "projectName", "recurrenceEndTime", "repeatMode", "startTime", "tags", "timeout", "username", "windowsPassword", "workingDir" ], "type": "object" } }, "volcenginecc:ecs/getInvocations:getInvocations": { "description": "Plural Data Source schema for Volcengine::ECS::Invocation\n", "outputs": { "description": "A collection of values returned by getInvocations.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ecs/getKeypair:getKeypair": { "description": "Data Source schema for Volcengine::ECS::Keypair\n", "inputs": { "description": "A collection of arguments for invoking getKeypair.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getKeypair.\n", "properties": { "createdTime": { "description": "Creation time of the key pair.\n", "type": "string" }, "description": { "description": "Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.\n", "type": "string" }, "fingerPrint": { "description": "Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceIds": { "description": "Instance ID for the operation.\n", "items": { "type": "string" }, "type": "array" }, "keyPairId": { "description": "Unique ID of the key pair.\n", "type": "string" }, "keyPairName": { "description": "Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.\n", "type": "string" }, "projectName": { "description": "Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.\n", "type": "string" }, "publicKey": { "description": "Public key information of the key pair.\n", "type": "string" }, "tags": { "description": "Tags of the key pair.\n", "items": { "$ref": "#/types/volcenginecc:ecs/getKeypairTag:getKeypairTag" }, "type": "array" }, "updatedTime": { "description": "Update time of the key pair.\n", "type": "string" } }, "required": [ "createdTime", "description", "fingerPrint", "id", "instanceIds", "keyPairId", "keyPairName", "projectName", "publicKey", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:ecs/getKeypairs:getKeypairs": { "description": "Plural Data Source schema for Volcengine::ECS::Keypair\n", "outputs": { "description": "A collection of values returned by getKeypairs.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ecs/getLaunchTemplate:getLaunchTemplate": { "description": "Data Source schema for Volcengine::ECS::LaunchTemplate\n", "inputs": { "description": "A collection of arguments for invoking getLaunchTemplate.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getLaunchTemplate.\n", "properties": { "createdAt": { "description": "Instance launch template creation time\n", "type": "string" }, "defaultVersionNumber": { "description": "Instance launch template default version number\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "latestVersionNumber": { "description": "Latest version number of the instance launch template.\n", "type": "integer" }, "launchTemplateId": { "description": "Instance launch template ID\n", "type": "string" }, "launchTemplateName": { "description": "Instance launch template name.\n", "type": "string" }, "launchTemplateProjectName": { "description": "Project associated with the instance launch template.\n", "type": "string" }, "launchTemplateTags": { "description": "Instance launch template tag information\n", "items": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateLaunchTemplateTag:getLaunchTemplateLaunchTemplateTag" }, "type": "array" }, "launchTemplateVersion": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateLaunchTemplateVersion:getLaunchTemplateLaunchTemplateVersion", "description": "Instance launch template version information\n" }, "updatedAt": { "description": "Instance launch template update time\n", "type": "string" } }, "required": [ "createdAt", "defaultVersionNumber", "id", "latestVersionNumber", "launchTemplateId", "launchTemplateName", "launchTemplateProjectName", "launchTemplateTags", "launchTemplateVersion", "updatedAt" ], "type": "object" } }, "volcenginecc:ecs/getLaunchTemplateVersion:getLaunchTemplateVersion": { "description": "Data Source schema for Volcengine::ECS::LaunchTemplateVersion\n", "inputs": { "description": "A collection of arguments for invoking getLaunchTemplateVersion.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getLaunchTemplateVersion.\n", "properties": { "deploymentSetGroupNumber": { "description": "When the deployment set policy for an ECS instance is set to AvailabilityGroup, use this parameter to specify the group number within the deployment set.\n", "type": "integer" }, "deploymentSetId": { "description": "Deployment set ID to join for the instance.\n", "type": "string" }, "description": { "description": "Instance description.\n", "type": "string" }, "eip": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateVersionEip:getLaunchTemplateVersionEip", "description": "Public IP information bound to the instance.\n" }, "hostName": { "description": "Instance hostname. Linux hostname length: 2–59 characters. Windows hostname length: 2–10 characters\n", "type": "string" }, "hpcClusterId": { "description": "Specify the high-performance computing cluster ID when creating a high-performance computing GPU instance.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "imageId": { "description": "Image ID\n", "type": "string" }, "imageName": { "description": "Image name.\n", "type": "string" }, "instanceChargeType": { "description": "Billing type for the instance and cloud disk. Value: PostPaid: Pay-as-you-go. PrePaid: Subscription. Esi: Elastic reservation instance. Segmented: Time-segmented elastic reservation instance.\n", "type": "string" }, "instanceName": { "description": "Instance name.\n", "type": "string" }, "instanceTypeId": { "description": "Instance specifications\n", "type": "string" }, "keepImageCredential": { "description": "Retain image settings. Value: true: Retain image settings. If retained, the preset password or key pair in the image will be used to log in to the instance. false (default): Do not retain image settings.\n", "type": "boolean" }, "keyPairName": { "description": "Key pair bound to the instance.\n", "type": "string" }, "launchTemplateId": { "description": "Instance launch template ID.\n", "type": "string" }, "networkInterfaces": { "description": "Network interface information attached to the instance\n", "items": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateVersionNetworkInterface:getLaunchTemplateVersionNetworkInterface" }, "type": "array" }, "projectName": { "description": "Project to which the instance belongs.\n", "type": "string" }, "scheduledInstance": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateVersionScheduledInstance:getLaunchTemplateVersionScheduledInstance", "description": "Elastic reservation order information\n" }, "securityEnhancementStrategy": { "description": "Enable security hardening. Active: Enable security hardening, effective only for public images. InActive: Disable security hardening, effective for all images.\n", "type": "string" }, "spotPriceLimit": { "description": "Maximum hourly price for preemptible instances.\n", "type": "number" }, "spotStrategy": { "description": "Preemptive strategy for pay-as-you-go billing. Values: NoSpot: Creates a standard pay-as-you-go instance. SpotAsPriceGo: System automatically bids, creating a preemptive instance that follows the current market price. SpotWithPriceLimit: Creates a preemptive instance with a bid limit\n", "type": "string" }, "suffixIndex": { "description": "Starting sequence number for the ordered suffix.\n", "type": "integer" }, "tags": { "description": "Instance tag information\n", "items": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateVersionTag:getLaunchTemplateVersionTag" }, "type": "array" }, "uniqueSuffix": { "description": "Indicates whether to automatically add an ordered suffix to Hostname and InstanceName when creating multiple instances.\n", "type": "boolean" }, "userData": { "description": "Custom data for the instance.\n", "type": "string" }, "versionDescription": { "description": "Template version description.\n", "type": "string" }, "versionNumber": { "description": "Template version number.\n", "type": "string" }, "volumes": { "description": "Disk information bound to the instance\n", "items": { "$ref": "#/types/volcenginecc:ecs/getLaunchTemplateVersionVolume:getLaunchTemplateVersionVolume" }, "type": "array" }, "vpcId": { "description": "Private network ID\n", "type": "string" }, "zoneId": { "description": "Availability zone ID of the instance\n", "type": "string" } }, "required": [ "deploymentSetGroupNumber", "deploymentSetId", "description", "eip", "hostName", "hpcClusterId", "id", "imageId", "imageName", "instanceChargeType", "instanceName", "instanceTypeId", "keepImageCredential", "keyPairName", "launchTemplateId", "networkInterfaces", "projectName", "scheduledInstance", "securityEnhancementStrategy", "spotPriceLimit", "spotStrategy", "suffixIndex", "tags", "uniqueSuffix", "userData", "versionDescription", "versionNumber", "volumes", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:ecs/getLaunchTemplateVersions:getLaunchTemplateVersions": { "description": "Plural Data Source schema for Volcengine::ECS::LaunchTemplateVersion\n", "outputs": { "description": "A collection of values returned by getLaunchTemplateVersions.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:ecs/getLaunchTemplates:getLaunchTemplates": { "description": "Plural Data Source schema for Volcengine::ECS::LaunchTemplate\n", "outputs": { "description": "A collection of values returned by getLaunchTemplates.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:efs/getFileSystem:getFileSystem": { "description": "Data Source schema for Volcengine::EFS::FileSystem\n", "inputs": { "description": "A collection of arguments for invoking getFileSystem.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getFileSystem.\n", "properties": { "accessPointLimit": { "description": "Access point limit.\n", "type": "integer" }, "chargeConfig": { "$ref": "#/types/volcenginecc:efs/getFileSystemChargeConfig:getFileSystemChargeConfig", "description": "File system billing configuration.\n" }, "chargeType": { "description": "Billing type. Only supports PayAsYouGo, which means pay-as-you-go billing.\n", "type": "string" }, "createTime": { "description": "File system creation time.\n", "type": "string" }, "description": { "description": "Description.\n", "type": "string" }, "downgradeUnlockTime": { "description": "Time when file system bandwidth can be downgraded.\n", "type": "string" }, "fileSystemId": { "description": "File system ID.\n", "type": "string" }, "fileSystemName": { "description": "File system name.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceType": { "description": "Basic: Basic type, Premium: Premium type.\n", "type": "string" }, "mountPointLimit": { "description": "Mount point limit.\n", "type": "integer" }, "performance": { "$ref": "#/types/volcenginecc:efs/getFileSystemPerformance:getFileSystemPerformance", "description": "File system performance information.\n" }, "performanceDensity": { "description": "File system performance density. Value description: Basic*50: Basic type 50MB/s/TiB, Premium*125: Premium type 125MB/s/TiB.\n", "type": "string" }, "projectName": { "description": "Project name.\n", "type": "string" }, "protocolTypes": { "description": "Protocol type.\n", "items": { "type": "string" }, "type": "array" }, "status": { "description": "File system status. Value description: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Stopped: Stopped.\n", "type": "string" }, "storage": { "$ref": "#/types/volcenginecc:efs/getFileSystemStorage:getFileSystemStorage", "description": "File system capacity information.\n" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:efs/getFileSystemTag:getFileSystemTag" }, "type": "array" }, "updateTime": { "description": "File system update time.\n", "type": "string" }, "zoneId": { "description": "Availability zone ID.\n", "type": "string" }, "zoneName": { "description": "Availability zone name.\n", "type": "string" } }, "required": [ "accessPointLimit", "chargeConfig", "chargeType", "createTime", "description", "downgradeUnlockTime", "fileSystemId", "fileSystemName", "id", "instanceType", "mountPointLimit", "performance", "performanceDensity", "projectName", "protocolTypes", "status", "storage", "tags", "updateTime", "zoneId", "zoneName" ], "type": "object" } }, "volcenginecc:efs/getFileSystems:getFileSystems": { "description": "Plural Data Source schema for Volcengine::EFS::FileSystem\n", "outputs": { "description": "A collection of values returned by getFileSystems.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:emr/getCluster:getCluster": { "description": "Data Source schema for Volcengine::EMR::Cluster\n", "inputs": { "description": "A collection of arguments for invoking getCluster.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getCluster.\n", "properties": { "accountId": { "description": "Account ID.\n", "type": "integer" }, "applicationExtras": { "description": "Cluster service extension information list, including custom configuration items for services, custom deployment topology settings for service components, and metadata connection configuration information for services.\n", "items": { "$ref": "#/types/volcenginecc:emr/getClusterApplicationExtra:getClusterApplicationExtra" }, "type": "array" }, "applicationNames": { "description": "List of service names installed in the cluster. Creation-related field.\n", "items": { "type": "string" }, "type": "array" }, "applications": { "description": "Installed service list for cluster. Read-only field.\n", "items": { "$ref": "#/types/volcenginecc:emr/getClusterApplication:getClusterApplication" }, "type": "array" }, "bootstrapScripts": { "description": "Cluster bootstrap script list.\n", "items": { "$ref": "#/types/volcenginecc:emr/getClusterBootstrapScript:getClusterBootstrapScript" }, "type": "array" }, "chargePreConfig": { "$ref": "#/types/volcenginecc:emr/getClusterChargePreConfig:getClusterChargePreConfig", "description": "Monthly subscription configuration parameters. Required when chargeType=PRE.\n" }, "chargeType": { "description": "Payment type. PRE means monthly subscription, POST means pay-as-you-go.\n", "type": "string" }, "clusterDomainNames": { "description": "Cluster DNS domain suffix list.\n", "items": { "type": "string" }, "type": "array" }, "clusterId": { "description": "Cluster ID.\n", "type": "string" }, "clusterName": { "description": "Cluster name.\n", "type": "string" }, "clusterState": { "description": "Cluster status.\n", "type": "string" }, "clusterType": { "description": "Cluster type.\n", "type": "string" }, "createdTime": { "description": "Cluster creation time.\n", "type": "integer" }, "creatorId": { "description": "Creator ID.\n", "type": "integer" }, "creatorName": { "description": "Creator name.\n", "type": "string" }, "deployMode": { "description": "Deployment mode. SIMPLE means simple mode, HIGH_AVAILABLE means high availability mode.\n", "type": "string" }, "ecsImageId": { "description": "ECS image ID.\n", "type": "string" }, "expireTime": { "description": "Cluster expiration time.\n", "type": "integer" }, "historyServerMode": { "description": "HistoryServer mode: LOCAL stores active data within the cluster, PHS stores active data outside the cluster.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "nodeAttribute": { "$ref": "#/types/volcenginecc:emr/getClusterNodeAttribute:getClusterNodeAttribute", "description": "Cluster global node information.\n" }, "nodeGroupAttributes": { "description": "Node group property list.\n", "items": { "$ref": "#/types/volcenginecc:emr/getClusterNodeGroupAttribute:getClusterNodeGroupAttribute" }, "type": "array" }, "projectName": { "description": "Project to which the resource belongs. Default is 'default'. Each resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length is 64 characters.\n", "type": "string" }, "readyTime": { "description": "Cluster creation completion time.\n", "type": "integer" }, "releaseVersion": { "description": "Cluster version.\n", "type": "string" }, "securityGroupId": { "description": "Cluster global security group ID. All ECS in node groups will join this security group.\n", "type": "string" }, "securityMode": { "description": "Security mode.\n", "type": "string" }, "stateChangeReason": { "$ref": "#/types/volcenginecc:emr/getClusterStateChangeReason:getClusterStateChangeReason", "description": "Status change reason.\n" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:emr/getClusterTag:getClusterTag" }, "type": "array" }, "terminateTime": { "description": "Cluster termination time.\n", "type": "integer" }, "vpcId": { "description": "Vpc ID。\n", "type": "string" } }, "required": [ "accountId", "applicationExtras", "applicationNames", "applications", "bootstrapScripts", "chargePreConfig", "chargeType", "clusterDomainNames", "clusterId", "clusterName", "clusterState", "clusterType", "createdTime", "creatorId", "creatorName", "deployMode", "ecsImageId", "expireTime", "historyServerMode", "id", "nodeAttribute", "nodeGroupAttributes", "projectName", "readyTime", "releaseVersion", "securityGroupId", "securityMode", "stateChangeReason", "tags", "terminateTime", "vpcId" ], "type": "object" } }, "volcenginecc:emr/getClusterUser:getClusterUser": { "description": "Data Source schema for Volcengine::EMR::ClusterUser\n", "inputs": { "description": "A collection of arguments for invoking getClusterUser.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getClusterUser.\n", "properties": { "clusterId": { "description": "Cluster ID.\n", "type": "string" }, "createdTime": { "description": "Creation time.\n", "type": "integer" }, "creatorName": { "description": "Creator username.\n", "type": "string" }, "description": { "description": "User group description.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "oldPassword": { "description": "Old user login password. Required when changing password.\n", "type": "string" }, "password": { "description": "New user login password. Password must be 8–20 characters long, support numbers, letters, -, _, and contain at least one number and one letter.\n", "type": "string" }, "updatedTime": { "description": "Last updated time.\n", "type": "integer" }, "userGroupNames": { "description": "User group name.\n", "items": { "type": "string" }, "type": "array" }, "userName": { "description": "Cluster username. Only lowercase letters are supported.\n", "type": "string" } }, "required": [ "clusterId", "createdTime", "creatorName", "description", "id", "oldPassword", "password", "updatedTime", "userGroupNames", "userName" ], "type": "object" } }, "volcenginecc:emr/getClusterUserGroup:getClusterUserGroup": { "description": "Data Source schema for Volcengine::EMR::ClusterUserGroup\n", "inputs": { "description": "A collection of arguments for invoking getClusterUserGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getClusterUserGroup.\n", "properties": { "clusterId": { "description": "Cluster ID.\n", "type": "string" }, "description": { "description": "User group description.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "members": { "description": "Operations on special users, such as admin, are not supported.\n", "items": { "type": "string" }, "type": "array" }, "userGroupName": { "description": "User group name.\n", "type": "string" } }, "required": [ "clusterId", "description", "id", "members", "userGroupName" ], "type": "object" } }, "volcenginecc:emr/getClusterUserGroups:getClusterUserGroups": { "description": "Plural Data Source schema for Volcengine::EMR::ClusterUserGroup\n", "outputs": { "description": "A collection of values returned by getClusterUserGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:emr/getClusterUsers:getClusterUsers": { "description": "Plural Data Source schema for Volcengine::EMR::ClusterUser\n", "outputs": { "description": "A collection of values returned by getClusterUsers.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:emr/getClusters:getClusters": { "description": "Plural Data Source schema for Volcengine::EMR::Cluster\n", "outputs": { "description": "A collection of values returned by getClusters.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:emr/getNodeGroup:getNodeGroup": { "description": "Data Source schema for Volcengine::EMR::NodeGroup\n", "inputs": { "description": "A collection of arguments for invoking getNodeGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNodeGroup.\n", "properties": { "applicationLayouts": { "description": "List of component names that can be deployed in the current node group.\n", "items": { "$ref": "#/types/volcenginecc:emr/getNodeGroupApplicationLayout:getNodeGroupApplicationLayout" }, "type": "array" }, "chargePreConfig": { "$ref": "#/types/volcenginecc:emr/getNodeGroupChargePreConfig:getNodeGroupChargePreConfig", "description": "Subscription payment configuration.\n" }, "chargeType": { "description": "Payment type. PRE indicates monthly subscription, POST indicates pay-as-you-go.\n", "type": "string" }, "clusterId": { "description": "Cluster ID.\n", "type": "string" }, "createdTime": { "description": "Creation time.\n", "type": "integer" }, "dataDisks": { "description": "Data disk configuration.\n", "items": { "$ref": "#/types/volcenginecc:emr/getNodeGroupDataDisk:getNodeGroupDataDisk" }, "type": "array" }, "ecsInstanceTypes": { "description": "ECS instance specification list. Currently, only a single instance specification can be modified.\n", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "layoutComponentNames": { "description": "Custom configuration parameter list for the returned node group components.\n", "items": { "type": "string" }, "type": "array" }, "nodeCount": { "description": "Node count. Value range: 1~1000.\n", "type": "integer" }, "nodeGroupId": { "description": "Node group ID.\n", "type": "string" }, "nodeGroupName": { "description": "Node group name.\n", "type": "string" }, "nodeGroupState": { "description": "Node group status. RUNNING: Running. EXTENDING: Expanding. REDUCING: Shrinking. DISK_EXTENDING: Disk expansion. MODIFYING: Configuration modification in progress.\n", "type": "string" }, "nodeGroupType": { "description": "Node group type.\n", "type": "string" }, "nodes": { "description": "Node list.\n", "items": { "$ref": "#/types/volcenginecc:emr/getNodeGroupNode:getNodeGroupNode" }, "type": "array" }, "subnetIds": { "description": "Subnet ID list.\n", "items": { "type": "string" }, "type": "array" }, "systemDisk": { "$ref": "#/types/volcenginecc:emr/getNodeGroupSystemDisk:getNodeGroupSystemDisk", "description": "System disk.\n" }, "targetDiskSize": { "description": "Target disk size for expansion. Minimum 60GB, maximum 2048GB, unit: GB.\n", "type": "integer" }, "terminateTime": { "description": "Cluster termination time.\n", "type": "string" }, "withPublicIp": { "description": "Whether the ECS instance includes a public IP.\n", "type": "boolean" }, "zoneId": { "description": "zoneId. If empty, the cluster's zoneId is reused by default.\n", "type": "string" } }, "required": [ "applicationLayouts", "chargePreConfig", "chargeType", "clusterId", "createdTime", "dataDisks", "ecsInstanceTypes", "id", "layoutComponentNames", "nodeCount", "nodeGroupId", "nodeGroupName", "nodeGroupState", "nodeGroupType", "nodes", "subnetIds", "systemDisk", "targetDiskSize", "terminateTime", "withPublicIp", "zoneId" ], "type": "object" } }, "volcenginecc:emr/getNodeGroups:getNodeGroups": { "description": "Plural Data Source schema for Volcengine::EMR::NodeGroup\n", "outputs": { "description": "A collection of values returned by getNodeGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:escloud/getInstance:getInstance": { "description": "Data Source schema for Volcengine::ESCloud::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "cerebroEnabled": { "description": "Whether to enable cerebro. true: enable cerebro; false: do not enable cerebro.\n", "type": "boolean" }, "cerebroPrivateDomain": { "description": "Cerebro private network access address. Note: Cerebro and Kibana share the domain name. For legacy instances, the access address may start with http(s)://kibana-***\n", "type": "string" }, "cerebroPublicDomain": { "description": "Cerebro public access address. Note: Cerebro and Kibana share the same domain name. For legacy instances, the access address may start with http(s)://kibana-***\n", "type": "string" }, "chargeEnabled": { "description": "Whether billing is enabled for the instance. Value description: true: Billing enabled false: Billing not enabled\n", "type": "boolean" }, "clusterId": { "description": "ID of the cluster to which the instance belongs.\n", "type": "string" }, "createTime": { "description": "Instance creation time.\n", "type": "string" }, "enableEsPrivateDomainPublic": { "description": "Whether the instance has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses\n", "type": "boolean" }, "enableEsPrivateNetwork": { "description": "Whether private network access is enabled for the instance. true: Default, private network access enabled; false: private network access not enabled.\n", "type": "boolean" }, "enableEsPublicNetwork": { "description": "Whether the instance has enabled public access. true: Public access enabled. false: Public access not enabled\n", "type": "boolean" }, "enableKibanaPrivateDomainPublic": { "description": "Whether Kibana has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses\n", "type": "boolean" }, "enableKibanaPrivateNetwork": { "description": "Whether Kibana private network access is enabled. true: Default value, private network access enabled false: Kibana private network access not enabled\n", "type": "boolean" }, "enableKibanaPublicNetwork": { "description": "Whether Kibana has enabled public access. true: Public access enabled false: Public access not enabled\n", "type": "boolean" }, "esEip": { "description": "EIP bound to the instance.\n", "type": "string" }, "esEipId": { "description": "ID of the EIP bound to the instance\n", "type": "string" }, "esPrivateEndpoint": { "description": "Instance private network access address.\n", "type": "string" }, "esPrivateIpAllowList": { "description": "Instance private network address access allowlist. Same as ESPrivateIpWhitelist\n", "type": "string" }, "esPrivateIpWhitelist": { "description": "Instance private network address access allowlist\n", "type": "string" }, "esPubBandwidth": { "description": "ES public network bandwidth, unit: Mbps.\n", "type": "integer" }, "esPublicEndpoint": { "description": "Instance public access address\n", "type": "string" }, "esPublicIpAllowList": { "description": "Instance public IP address access allowlist. Same as ESPublicIpWhitelist\n", "type": "string" }, "esPublicIpWhitelist": { "description": "Allowlist for instance public network address access.\n", "type": "string" }, "expireDate": { "description": "Expiration time for subscription instance payment\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceConfiguration": { "$ref": "#/types/volcenginecc:escloud/getInstanceInstanceConfiguration:getInstanceInstanceConfiguration", "description": "Instance configuration details\n" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "kibanaConfig": { "$ref": "#/types/volcenginecc:escloud/getInstanceKibanaConfig:getInstanceKibanaConfig", "description": "Kibana parameter configuration\n" }, "kibanaEip": { "description": "EIP bound to Kibana\n", "type": "string" }, "kibanaEipId": { "description": "ID of the EIP bound to Kibana.\n", "type": "string" }, "kibanaPrivateDomain": { "description": "Kibana private network access address. Note: For historical instances, the access address may start with http(s)://kibana-***.\n", "type": "string" }, "kibanaPrivateIpAllowList": { "description": "Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPrivateIpWhitelist.\n", "type": "string" }, "kibanaPrivateIpWhitelist": { "description": "Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist.\n", "type": "string" }, "kibanaPubBandwidth": { "description": "Kibana public network bandwidth, unit: Mbps\n", "type": "integer" }, "kibanaPublicDomain": { "description": "Kibana public access address. Note: For legacy instances, the access address may start with http(s)://kibana-***\n", "type": "string" }, "kibanaPublicIpAllowList": { "description": "Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPublicIpWhitelist\n", "type": "string" }, "kibanaPublicIpWhitelist": { "description": "Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist\n", "type": "string" }, "mainZoneId": { "description": "Primary availability zone\n", "type": "string" }, "maintenanceDays": { "description": "Instance maintenance date.\n", "items": { "type": "string" }, "type": "array" }, "maintenanceTime": { "description": "Instance maintenance window.\n", "type": "string" }, "status": { "description": "Current instance status\n", "type": "string" }, "subInstanceEnable": { "description": "Sub-instance activation status\n", "type": "string" }, "subInstances": { "description": "Enterprise SQL analytics instance configuration information\n", "items": { "$ref": "#/types/volcenginecc:escloud/getInstanceSubInstance:getInstanceSubInstance" }, "type": "array" }, "supportColdNode": { "description": "Whether cold nodes are supported\n", "type": "boolean" }, "totalNodes": { "description": "Total number of nodes in the instance\n", "type": "integer" }, "transferInfo": { "$ref": "#/types/volcenginecc:escloud/getInstanceTransferInfo:getInstanceTransferInfo", "description": "Data migration task information\n" }, "userId": { "description": "Instance owner's user ID\n", "type": "string" } }, "required": [ "cerebroEnabled", "cerebroPrivateDomain", "cerebroPublicDomain", "chargeEnabled", "clusterId", "createTime", "enableEsPrivateDomainPublic", "enableEsPrivateNetwork", "enableEsPublicNetwork", "enableKibanaPrivateDomainPublic", "enableKibanaPrivateNetwork", "enableKibanaPublicNetwork", "esEip", "esEipId", "esPrivateEndpoint", "esPrivateIpAllowList", "esPrivateIpWhitelist", "esPubBandwidth", "esPublicEndpoint", "esPublicIpAllowList", "esPublicIpWhitelist", "expireDate", "id", "instanceConfiguration", "instanceId", "kibanaConfig", "kibanaEip", "kibanaEipId", "kibanaPrivateDomain", "kibanaPrivateIpAllowList", "kibanaPrivateIpWhitelist", "kibanaPubBandwidth", "kibanaPublicDomain", "kibanaPublicIpAllowList", "kibanaPublicIpWhitelist", "mainZoneId", "maintenanceDays", "maintenanceTime", "status", "subInstanceEnable", "subInstances", "supportColdNode", "totalNodes", "transferInfo", "userId" ], "type": "object" } }, "volcenginecc:escloud/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::ESCloud::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:filenas/getInstance:getInstance": { "description": "Data Source schema for Volcengine::FileNAS::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "cachePerformance": { "$ref": "#/types/volcenginecc:filenas/getInstanceCachePerformance:getInstanceCachePerformance", "description": "Cache performance information\n" }, "capacity": { "$ref": "#/types/volcenginecc:filenas/getInstanceCapacity:getInstanceCapacity", "description": "File system capacity\n" }, "chargeType": { "description": "Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing\n", "type": "string" }, "createTime": { "description": "Creation time\n", "type": "string" }, "description": { "description": "Description\n", "type": "string" }, "fileSystemId": { "description": "File system ID\n", "type": "string" }, "fileSystemName": { "description": "File system name\n", "type": "string" }, "fileSystemType": { "description": "File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "projectName": { "description": "Project, default value is the Default project\n", "type": "string" }, "protocolType": { "description": "File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients\n", "type": "string" }, "snapshotCount": { "description": "Number of snapshots\n", "type": "integer" }, "snapshotId": { "description": "Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot\n", "type": "string" }, "status": { "description": "File system status. Possible values: Unknown: Status unknown. Running: File system running. Creating: File system being created. Expanding: File system being upgraded. Error: File system error. Deleting: File system being deleted. DeleteError: File system deletion failed. Deleted: File system deleted. Stopped: File system stopped.\n", "type": "string" }, "storageType": { "description": "Storage type. Value: Standard, indicates standard type\n", "type": "string" }, "tags": { "description": "File system tag information\n", "items": { "$ref": "#/types/volcenginecc:filenas/getInstanceTag:getInstanceTag" }, "type": "array" }, "updateTime": { "description": "Update time\n", "type": "string" }, "zoneId": { "description": "Availability Zone ID\n", "type": "string" }, "zoneName": { "description": "Availability Zone name\n", "type": "string" } }, "required": [ "cachePerformance", "capacity", "chargeType", "createTime", "description", "fileSystemId", "fileSystemName", "fileSystemType", "id", "projectName", "protocolType", "snapshotCount", "snapshotId", "status", "storageType", "tags", "updateTime", "zoneId", "zoneName" ], "type": "object" } }, "volcenginecc:filenas/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::FileNAS::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:filenas/getMountPoint:getMountPoint": { "description": "Data Source schema for Volcengine::FileNAS::MountPoint\n", "inputs": { "description": "A collection of arguments for invoking getMountPoint.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getMountPoint.\n", "properties": { "clients": { "description": "Client information.\n", "items": { "$ref": "#/types/volcenginecc:filenas/getMountPointClient:getMountPointClient" }, "type": "array" }, "createdTime": { "description": "Mount point creation time.\n", "type": "string" }, "domain": { "description": "DNS address.\n", "type": "string" }, "fileSystemId": { "description": "File system ID.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ip": { "description": "Mount point address.\n", "type": "string" }, "mountPointId": { "description": "Mount point ID.\n", "type": "string" }, "mountPointName": { "description": "Mount point name.\n", "type": "string" }, "permissionGroup": { "$ref": "#/types/volcenginecc:filenas/getMountPointPermissionGroup:getMountPointPermissionGroup", "description": "Permission group information bound to the mount point.\n" }, "permissionGroupId": { "description": "Permission group ID.\n", "type": "string" }, "status": { "description": "Mount point status. Values: Running: Running. Creating: Creating. Updating: Updating. Error: Error. Deleting: Deleting. DeleteError: Delete error. Deleted: Deleted. Stopped: Stopped.\n", "type": "string" }, "subnetId": { "description": "Subnet ID.\n", "type": "string" }, "subnetName": { "description": "Subnet name.\n", "type": "string" }, "updatedTime": { "description": "Mount point update time.\n", "type": "string" }, "vpcId": { "description": "Private network ID.\n", "type": "string" }, "vpcName": { "description": "Private network name.\n", "type": "string" } }, "required": [ "clients", "createdTime", "domain", "fileSystemId", "id", "ip", "mountPointId", "mountPointName", "permissionGroup", "permissionGroupId", "status", "subnetId", "subnetName", "updatedTime", "vpcId", "vpcName" ], "type": "object" } }, "volcenginecc:filenas/getMountPoints:getMountPoints": { "description": "Plural Data Source schema for Volcengine::FileNAS::MountPoint\n", "outputs": { "description": "A collection of values returned by getMountPoints.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:filenas/getSnapshot:getSnapshot": { "description": "Data Source schema for Volcengine::FileNAS::Snapshot\n", "inputs": { "description": "A collection of arguments for invoking getSnapshot.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSnapshot.\n", "properties": { "createdTime": { "description": "Snapshot Creation Time\n", "type": "string" }, "description": { "description": "Snapshot Description\n", "type": "string" }, "fileSystemId": { "description": "File System ID\n", "type": "string" }, "fileSystemName": { "description": "File System Name\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "isEncrypt": { "description": "Is encryption enabled. Currently only false is supported (not encrypted)\n", "type": "boolean" }, "progress": { "description": "Snapshot Creation Progress\n", "type": "string" }, "retentionDays": { "description": "Snapshot Retention Period. Default is 2147483647 (permanent retention)\n", "type": "integer" }, "snapshotId": { "description": "Snapshot ID\n", "type": "string" }, "snapshotName": { "description": "Snapshot Name\n", "type": "string" }, "snapshotType": { "description": "Snapshot Type. Default is Manual (manual snapshot)\n", "type": "string" }, "sourceSize": { "description": "File System Capacity (GiB)\n", "type": "integer" }, "sourceVersion": { "description": "File System Version\n", "type": "string" }, "status": { "description": "Snapshot Status. Details: Progressing: Creating. Accomplished: Created successfully. Failed: Creation failed\n", "type": "string" }, "zoneId": { "description": "Availability Zone ID\n", "type": "string" } }, "required": [ "createdTime", "description", "fileSystemId", "fileSystemName", "id", "isEncrypt", "progress", "retentionDays", "snapshotId", "snapshotName", "snapshotType", "sourceSize", "sourceVersion", "status", "zoneId" ], "type": "object" } }, "volcenginecc:filenas/getSnapshots:getSnapshots": { "description": "Plural Data Source schema for Volcengine::FileNAS::Snapshot\n", "outputs": { "description": "A collection of values returned by getSnapshots.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:fwcenter/getDnsControlPolicies:getDnsControlPolicies": { "description": "Plural Data Source schema for Volcengine::FWCenter::DnsControlPolicy\n", "outputs": { "description": "A collection of values returned by getDnsControlPolicies.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:fwcenter/getDnsControlPolicy:getDnsControlPolicy": { "description": "Data Source schema for Volcengine::FWCenter::DnsControlPolicy\n", "inputs": { "description": "A collection of arguments for invoking getDnsControlPolicy.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDnsControlPolicy.\n", "properties": { "accountId": { "description": "User's unique identifier.\n", "type": "string" }, "description": { "description": "Policy description information.\n", "type": "string" }, "destination": { "description": "Access target, which can be the unique identifier of a domain or domain address book. Currently, only one address book is supported.\n", "type": "string" }, "destinationGroupLists": { "description": "Domain address book name list.\n", "items": { "type": "string" }, "type": "array" }, "destinationType": { "description": "Type of access target. domain: domain; group: domain address book.\n", "type": "string" }, "domainListV1s": { "description": "Domain list in the domain address book.\n", "items": { "$ref": "#/types/volcenginecc:fwcenter/getDnsControlPolicyDomainListV1:getDnsControlPolicyDomainListV1" }, "type": "array" }, "domainLists": { "description": "Domain list.\n", "items": { "type": "string" }, "type": "array" }, "hitCnt": { "description": "Hit count, indicating the number of times the domain denylist access control policy was triggered.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "internetFirewallId": { "description": "Internet border firewall instance ID.\n", "type": "string" }, "lastHitTime": { "description": "Latest hit timestamp, indicating the last time the domain denylist access control policy was triggered.\n", "type": "integer" }, "ruleId": { "description": "Unique identifier of the access control policy.\n", "type": "string" }, "sources": { "description": "Access source information, including VPC list.\n", "items": { "$ref": "#/types/volcenginecc:fwcenter/getDnsControlPolicySource:getDnsControlPolicySource" }, "type": "array" }, "status": { "description": "Switch status of the domain denylist access control policy. false: Off; true: On.\n", "type": "boolean" }, "useCount": { "description": "Number of policies occupied by this domain denylist access control policy.\n", "type": "integer" } }, "required": [ "accountId", "description", "destination", "destinationGroupLists", "destinationType", "domainLists", "domainListV1s", "hitCnt", "id", "internetFirewallId", "lastHitTime", "ruleId", "sources", "status", "useCount" ], "type": "object" } }, "volcenginecc:hbase/getInstance:getInstance": { "description": "Data Source schema for Volcengine::HBase::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "autoRenew": { "description": "Whether auto-renewal is enabled for subscription scenarios. Values: true: auto-renewal enabled. false: auto-renewal not enabled.\n", "type": "boolean" }, "chargeStatus": { "description": "Billing status. Values: Normal: normal. Overdue: overdue. Shutdown: shutdown.\n", "type": "string" }, "chargeType": { "description": "Billing type. Values: PostPaid: pay-as-you-go (postpaid). PrePaid: subscription (prepaid, yearly/monthly).\n", "type": "string" }, "coldStorage": { "description": "Total capacity-type storage space for the instance, in GiB.\n", "type": "integer" }, "createTime": { "description": "Instance creation time (UTC).\n", "type": "string" }, "deletionProtection": { "description": "Instance deletion protection switch status. Value range: enabled: enabled. disabled: not enabled. For more information about instance deletion protection, see Instance Deletion Protection.\n", "type": "string" }, "enableAuth": { "description": "Whether login authentication is enabled. Values: true: login authentication enabled. false: login authentication disabled.\n", "type": "boolean" }, "enableCloudStorage": { "description": "Whether capacity-type storage is enabled. Values: true: capacity-type storage enabled. false: capacity-type storage not enabled. For details about capacity-type storage, see Hot and Cold Data Separation. The hot and cold data separation feature is supported only when MultiAZ (deployment mode) is set to false (single availability zone deployment).\n", "type": "boolean" }, "endpoints": { "description": "Connection address information list\n", "items": { "$ref": "#/types/volcenginecc:hbase/getInstanceEndpoint:getInstanceEndpoint" }, "type": "array" }, "engineVersion": { "description": "HBase database engine version. Currently, only HBase 2.0 is supported. The default value is HBase_2.0\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "instanceName": { "description": "Instance name\n", "type": "string" }, "instanceType": { "description": "Instance type. Currently, only Standard is supported. The default value is Standard\n", "type": "string" }, "masterCount": { "description": "Number of Master nodes. For single-zone deployment, 2 Master nodes are included by default\n", "type": "integer" }, "masterSpec": { "description": "Master node specification code. For information about supported specifications for Master nodes, see Instance Specifications. The number of Master nodes is fixed and cannot be changed.\n", "type": "string" }, "multiAz": { "description": "Instance deployment mode. Values: true: multi-availability zone deployment. false: single availability zone deployment. Currently, only single availability zone deployment is supported.\n", "type": "boolean" }, "primarySubnetId": { "description": "Real-time primary availability zone subnet ID.\n", "type": "string" }, "primaryZoneId": { "description": "Real-time primary zone ID\n", "type": "string" }, "projectName": { "description": "Project name of the instance\n", "type": "string" }, "purchaseMonths": { "description": "Purchase duration, in months. The value range is: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36. When ChargeType is PrePaid, this parameter is required\n", "type": "integer" }, "regionId": { "description": "Region ID of the instance.\n", "type": "string" }, "rsCount": { "description": "Number of RegionServer nodes\n", "type": "integer" }, "rsSpec": { "description": "RegionServer node specification code.\n", "type": "string" }, "standbySubnetId": { "description": "Real-time standby availability zone subnet ID.\n", "type": "string" }, "standbyZoneId": { "description": "Real-time standby zone ID\n", "type": "string" }, "status": { "description": "Current status of the instance. For more details about instance status, see Instance Status Description\n", "type": "string" }, "storageCapacity": { "description": "Total storage capacity of the instance, unit: GiB.\n", "type": "integer" }, "storageType": { "description": "Instance storage type. Values: HdfsHdd: HDD file storage. HdfsSsd: SSD file storage.\n", "type": "string" }, "subnetId": { "description": "Subnet ID of the instance. For single-zone instances, only one subnet ID for the zone is included\n", "type": "string" }, "tags": { "description": "Array of tag keys and tag values to bind. Supports passing multiple sets of tag key-value objects at once, separated by commas (,). Up to 20 tag key-value pairs can be passed at a time, and up to 50 tags can be bound to a single instance. Tag keys and values must comply with the setting rules. For details, see Tag Setting Rules\n", "items": { "$ref": "#/types/volcenginecc:hbase/getInstanceTag:getInstanceTag" }, "type": "array" }, "usedColdStorage": { "description": "Capacity-type storage space used by the instance, in MiB\n", "type": "integer" }, "usedStorage": { "description": "Storage capacity used by the primary instance, in MiB\n", "type": "number" }, "vpcId": { "description": "Private network ID. You can call the DescribeVpcs API to query information about private networks available for HBase instance creation, including the private network ID.\n", "type": "string" }, "vpcName": { "description": "Name of the private network to which the instance belongs.\n", "type": "string" }, "zoneId": { "description": "Zone ID of the instance\n", "type": "string" }, "zoneName": { "description": "Name of the availability zone to which the instance belongs.\n", "type": "string" } }, "required": [ "autoRenew", "chargeStatus", "chargeType", "coldStorage", "createTime", "deletionProtection", "enableAuth", "enableCloudStorage", "endpoints", "engineVersion", "id", "instanceId", "instanceName", "instanceType", "masterCount", "masterSpec", "multiAz", "primarySubnetId", "primaryZoneId", "projectName", "purchaseMonths", "regionId", "rsCount", "rsSpec", "standbySubnetId", "standbyZoneId", "status", "storageCapacity", "storageType", "subnetId", "tags", "usedColdStorage", "usedStorage", "vpcId", "vpcName", "zoneId", "zoneName" ], "type": "object" } }, "volcenginecc:hbase/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::HBase::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:iam/getAccesskey:getAccesskey": { "description": "Data Source schema for Volcengine::IAM::Accesskey\n", "inputs": { "description": "A collection of arguments for invoking getAccesskey.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAccesskey.\n", "properties": { "accessKeyId": { "description": "Key ID (Access Key Id)\n", "type": "string" }, "createdTime": { "description": "Key creation time (ISO8601 format)\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lastLoginDate": { "description": "Last login time\n", "type": "string" }, "region": { "description": "Last accessed region by the API key\n", "type": "string" }, "requestTime": { "description": "Last usage time of the API key\n", "type": "string" }, "secretAccessKey": { "description": "Secret Access Key\n", "type": "string" }, "service": { "description": "English abbreviation of the last accessed service by the API key\n", "type": "string" }, "status": { "description": "Key status. \"active\" means enabled, \"inactive\" means disabled\n", "type": "string" }, "updatedTime": { "description": "Key update time (ISO8601 format)\n", "type": "string" }, "userName": { "description": "User name. Used to create a key for a specified IAM user. If no user name is specified, the key is created for the current request identity (that is, if the main account requests, the key is created for the main account; if an IAM user requests, the key is created for that IAM user. Note: Roles cannot create keys for themselves). When an IAM user has the AccessKeySelfManageAccess permission, to create a key for themselves, they must include their own UserName in the request\n", "type": "string" } }, "required": [ "accessKeyId", "createdTime", "id", "lastLoginDate", "region", "requestTime", "secretAccessKey", "service", "status", "updatedTime", "userName" ], "type": "object" } }, "volcenginecc:iam/getAccesskeys:getAccesskeys": { "description": "Plural Data Source schema for Volcengine::IAM::Accesskey\n", "outputs": { "description": "A collection of values returned by getAccesskeys.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:iam/getGroup:getGroup": { "description": "Data Source schema for Volcengine::IAM::Group\n", "inputs": { "description": "A collection of arguments for invoking getGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getGroup.\n", "properties": { "accountId": { "description": "ID of the primary account to which the user group belongs.\n", "type": "integer" }, "attachedPolicies": { "description": "Policy information bound to the user group.\n", "items": { "$ref": "#/types/volcenginecc:iam/getGroupAttachedPolicy:getGroupAttachedPolicy" }, "type": "array" }, "createdTime": { "description": "User group creation time.\n", "type": "string" }, "description": { "description": "User group description. Maximum length: 128 characters.\n", "type": "string" }, "displayName": { "description": "User group display name. Maximum length: 64 characters.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "updatedTime": { "description": "User group update time.\n", "type": "string" }, "userGroupId": { "description": "User group ID.\n", "type": "integer" }, "userGroupName": { "description": "User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.\n", "type": "string" }, "users": { "description": "User information associated with the user group.\n", "items": { "$ref": "#/types/volcenginecc:iam/getGroupUser:getGroupUser" }, "type": "array" } }, "required": [ "accountId", "attachedPolicies", "createdTime", "description", "displayName", "id", "updatedTime", "userGroupId", "userGroupName", "users" ], "type": "object" } }, "volcenginecc:iam/getGroups:getGroups": { "description": "Plural Data Source schema for Volcengine::IAM::Group\n", "outputs": { "description": "A collection of values returned by getGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:iam/getOidcProvider:getOidcProvider": { "description": "Data Source schema for Volcengine::IAM::OidcProvider\n", "inputs": { "description": "A collection of arguments for invoking getOidcProvider.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getOidcProvider.\n", "properties": { "clientIds": { "description": "Client ID list. Provided by external IdP.\n", "items": { "type": "string" }, "type": "array" }, "createDate": { "description": "Creation time.\n", "type": "string" }, "description": { "description": "Identity provider description.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "issuanceLimitTime": { "description": "Earliest issuance time allowed for external IdP to issue ID Token.\n", "type": "integer" }, "issuerUrl": { "description": "OIDC issuer URL.\n", "type": "string" }, "oidcProviderName": { "description": "OIDC identity provider name.\n", "type": "string" }, "thumbprints": { "description": "HTTPS certificate verification fingerprint (SHA256).\n", "items": { "type": "string" }, "type": "array" }, "trn": { "description": "Identity provider Trn.\n", "type": "string" }, "updateDate": { "description": "Update time.\n", "type": "string" } }, "required": [ "clientIds", "createDate", "description", "id", "issuanceLimitTime", "issuerUrl", "oidcProviderName", "thumbprints", "trn", "updateDate" ], "type": "object" } }, "volcenginecc:iam/getOidcProviders:getOidcProviders": { "description": "Plural Data Source schema for Volcengine::IAM::OidcProvider\n", "outputs": { "description": "A collection of values returned by getOidcProviders.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:iam/getPolicies:getPolicies": { "description": "Plural Data Source schema for Volcengine::IAM::Policy\n", "outputs": { "description": "A collection of values returned by getPolicies.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:iam/getPolicy:getPolicy": { "description": "Data Source schema for Volcengine::IAM::Policy\n", "inputs": { "description": "A collection of arguments for invoking getPolicy.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getPolicy.\n", "properties": { "attachmentCount": { "description": "Number of identities bound to the policy.\n", "type": "integer" }, "category": { "description": "Category of the system preset policy, usually the service code. This field is not returned for custom policies.\n", "type": "string" }, "createdTime": { "description": "Policy creation time.\n", "type": "string" }, "description": { "description": "Policy description, no more than 128 characters.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "isServiceRolePolicy": { "description": "Indicates whether the policy is for a service-linked role. 0 means no; 1 means yes.\n", "type": "integer" }, "policyDocument": { "description": "Policy syntax content, for example: {\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iam:\",\"tag:\"],\"Resource\":[\"*\"]}]}\n", "type": "string" }, "policyName": { "description": "Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.\n", "type": "string" }, "policyRoles": { "description": "List of roles bound to the policy.\n", "items": { "$ref": "#/types/volcenginecc:iam/getPolicyPolicyRole:getPolicyPolicyRole" }, "type": "array" }, "policyTrn": { "description": "Policy TRN.\n", "type": "string" }, "policyType": { "description": "Policy type. System indicates a system preset policy; Custom indicates a custom policy.\n", "type": "string" }, "policyUserGroups": { "description": "List of user groups bound to the policy.\n", "items": { "$ref": "#/types/volcenginecc:iam/getPolicyPolicyUserGroup:getPolicyPolicyUserGroup" }, "type": "array" }, "policyUsers": { "description": "List of users bound to the policy.\n", "items": { "$ref": "#/types/volcenginecc:iam/getPolicyPolicyUser:getPolicyPolicyUser" }, "type": "array" }, "updatedTime": { "description": "Policy update time.\n", "type": "string" } }, "required": [ "attachmentCount", "category", "createdTime", "description", "id", "isServiceRolePolicy", "policyDocument", "policyName", "policyRoles", "policyTrn", "policyType", "policyUserGroups", "policyUsers", "updatedTime" ], "type": "object" } }, "volcenginecc:iam/getProject:getProject": { "description": "Data Source schema for Volcengine::IAM::Project\n", "inputs": { "description": "A collection of arguments for invoking getProject.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getProject.\n", "properties": { "accountId": { "description": "Account ID\n", "type": "integer" }, "createdTime": { "description": "Creation Time\n", "type": "string" }, "description": { "description": "Description\n", "type": "string" }, "displayName": { "description": "Display Name\n", "type": "string" }, "hasPermission": { "description": "Visible\n", "type": "boolean" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "parentProjectName": { "description": "Parent Project Name\n", "type": "string" }, "path": { "description": "Project Path\n", "type": "string" }, "projectName": { "description": "Project Name\n", "type": "string" }, "status": { "description": "Enabled Status\n", "type": "string" }, "updatedTime": { "description": "Update Time\n", "type": "string" } }, "required": [ "accountId", "createdTime", "description", "displayName", "hasPermission", "id", "parentProjectName", "path", "projectName", "status", "updatedTime" ], "type": "object" } }, "volcenginecc:iam/getProjects:getProjects": { "description": "Plural Data Source schema for Volcengine::IAM::Project\n", "outputs": { "description": "A collection of values returned by getProjects.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:iam/getRole:getRole": { "description": "Data Source schema for Volcengine::IAM::Role\n", "inputs": { "description": "A collection of arguments for invoking getRole.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRole.\n", "properties": { "createDate": { "description": "Role creation time\n", "type": "string" }, "description": { "description": "Role description, maximum length 128\n", "type": "string" }, "displayName": { "description": "Role display name, maximum length 64\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "isServiceLinkedRole": { "description": "Service-linked role or not: 0 for No, 1 for Yes\n", "type": "integer" }, "maxSessionDuration": { "description": "Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200\n", "type": "integer" }, "policies": { "items": { "$ref": "#/types/volcenginecc:iam/getRolePolicy:getRolePolicy" }, "type": "array" }, "roleId": { "description": "Role ID\n", "type": "integer" }, "roleName": { "description": "Role name, length 1–64, supports English letters, numbers, and .-_ characters\n", "type": "string" }, "tags": { "items": { "$ref": "#/types/volcenginecc:iam/getRoleTag:getRoleTag" }, "type": "array" }, "trn": { "description": "Role TRN\n", "type": "string" }, "trustPolicyDocument": { "description": "Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.\n", "type": "string" }, "updateDate": { "description": "Role update time\n", "type": "string" } }, "required": [ "createDate", "description", "displayName", "id", "isServiceLinkedRole", "maxSessionDuration", "policies", "roleId", "roleName", "tags", "trn", "trustPolicyDocument", "updateDate" ], "type": "object" } }, "volcenginecc:iam/getRoles:getRoles": { "description": "Plural Data Source schema for Volcengine::IAM::Role\n", "outputs": { "description": "A collection of values returned by getRoles.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:iam/getSamlProvider:getSamlProvider": { "description": "Data Source schema for Volcengine::IAM::SamlProvider\n", "inputs": { "description": "A collection of arguments for invoking getSamlProvider.\n", "properties": { "id": { "type": "string" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSamlProvider.\n", "properties": { "certificateExpireTime": { "type": "string" }, "certificates": { "items": { "$ref": "#/types/volcenginecc:iam/getSamlProviderCertificate:getSamlProviderCertificate" }, "type": "array" }, "createDate": { "type": "string" }, "description": { "type": "string" }, "encodedSamlMetadataDocument": { "type": "string" }, "id": { "type": "string" }, "samlProviderName": { "type": "string" }, "ssoType": { "type": "integer" }, "status": { "type": "integer" }, "trn": { "type": "string" }, "updateDate": { "type": "string" } }, "required": [ "certificateExpireTime", "certificates", "createDate", "description", "encodedSamlMetadataDocument", "id", "samlProviderName", "ssoType", "status", "trn", "updateDate" ], "type": "object" } }, "volcenginecc:iam/getSamlProviders:getSamlProviders": { "description": "Plural Data Source schema for Volcengine::IAM::SamlProvider\n", "outputs": { "description": "A collection of values returned by getSamlProviders.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:iam/getUser:getUser": { "description": "Data Source schema for Volcengine::IAM::User\n", "inputs": { "description": "A collection of arguments for invoking getUser.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getUser.\n", "properties": { "accessKeys": { "description": "Sub-user's access key.\n", "items": { "$ref": "#/types/volcenginecc:iam/getUserAccessKey:getUserAccessKey" }, "type": "array" }, "accountId": { "description": "Main account to which the sub-user belongs.\n", "type": "number" }, "createDate": { "description": "Sub-user's creation time.\n", "type": "string" }, "description": { "description": "Description for the sub-user, up to 255 characters.\n", "type": "string" }, "displayName": { "description": "Display name for the sub-user, user display name. Length 1–128. Supports Chinese, English, numbers, spaces, and .-_@ characters only.\n", "type": "string" }, "email": { "description": "Sub-user's email address.\n", "type": "string" }, "emailIsVerify": { "description": "Whether the sub-user's email address is verified. 'true' means verified, 'false' means not verified.\n", "type": "boolean" }, "groups": { "description": "User group to which the sub-user belongs.\n", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "loginProfile": { "$ref": "#/types/volcenginecc:iam/getUserLoginProfile:getUserLoginProfile", "description": "Login configuration for the sub-user.\n" }, "mobilePhone": { "description": "Sub-user's mobile number.\n", "type": "string" }, "mobilePhoneIsVerify": { "description": "Whether the sub-user's phone number is verified. 'true' means verified, 'false' means not verified.\n", "type": "boolean" }, "policies": { "description": "Sub-user's permission policy.\n", "items": { "$ref": "#/types/volcenginecc:iam/getUserPolicy:getUserPolicy" }, "type": "array" }, "securityConfig": { "$ref": "#/types/volcenginecc:iam/getUserSecurityConfig:getUserSecurityConfig", "description": "Operation protection configuration for the sub-user.\n" }, "tags": { "description": "Sub-user's resource tags.\n", "items": { "$ref": "#/types/volcenginecc:iam/getUserTag:getUserTag" }, "type": "array" }, "trn": { "description": "TRN expression for the sub-user.\n", "type": "string" }, "updateDate": { "description": "Update time for the sub-user.\n", "type": "string" }, "userId": { "description": "Sub-user's ID.\n", "type": "integer" }, "userName": { "description": "Sub-user name, username. Length 1–64. Supports English, numbers, underscores, and .-@ characters.\n", "type": "string" } }, "required": [ "accessKeys", "accountId", "createDate", "description", "displayName", "email", "emailIsVerify", "groups", "id", "loginProfile", "mobilePhone", "mobilePhoneIsVerify", "policies", "securityConfig", "tags", "trn", "updateDate", "userId", "userName" ], "type": "object" } }, "volcenginecc:iam/getUsers:getUsers": { "description": "Plural Data Source schema for Volcengine::IAM::User\n", "outputs": { "description": "A collection of values returned by getUsers.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:kafka/getAllowList:getAllowList": { "description": "Data Source schema for Volcengine::Kafka::AllowList\n", "inputs": { "description": "A collection of arguments for invoking getAllowList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAllowList.\n", "properties": { "allowList": { "description": "Allowlist rule list. Supports specifying IP addresses or IP ranges. Separate multiple IP addresses or ranges with commas (,). Each allowlist can contain up to 300 IP addresses or ranges\n", "type": "string" }, "allowListDesc": { "description": "Allowlist description. Maximum length: 200 characters\n", "type": "string" }, "allowListId": { "description": "Allowlist ID\n", "type": "string" }, "allowListIpNum": { "description": "Number of rules specified in the allowlist\n", "type": "integer" }, "allowListName": { "description": "Allowlist rule name. Length: 1–128 characters. Can only contain Chinese characters, letters, numbers, underscores, and hyphens (-). Cannot start with a number or hyphen (-). The allowlist name must be unique within the current region\n", "type": "string" }, "applyInstanceNum": { "description": "Number of instances already bound to this allowlist. If the AllowList parameter is specified, this field is required to indicate the expected number of instances affected after rule modification. If the expected number does not match the actual number, the request fails\n", "type": "integer" }, "associatedInstanceNum": { "description": "Number of instances bound to the allowlist\n", "type": "integer" }, "associatedInstances": { "description": "Information about the instance bound to the allowlist\n", "items": { "$ref": "#/types/volcenginecc:kafka/getAllowListAssociatedInstance:getAllowListAssociatedInstance" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" } }, "required": [ "allowList", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "applyInstanceNum", "associatedInstanceNum", "associatedInstances", "id" ], "type": "object" } }, "volcenginecc:kafka/getAllowLists:getAllowLists": { "description": "Plural Data Source schema for Volcengine::Kafka::AllowList\n", "outputs": { "description": "A collection of values returned by getAllowLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:kafka/getInstance:getInstance": { "description": "Data Source schema for Volcengine::Kafka::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "accountId": { "description": "Main account ID for creating the instance.\n", "type": "string" }, "chargeInfo": { "$ref": "#/types/volcenginecc:kafka/getInstanceChargeInfo:getInstanceChargeInfo", "description": "Billing type and related billing information for the Kafka instance.\n" }, "computeSpec": { "description": "Instance compute specification.\n", "type": "string" }, "connectionInfos": { "description": "Connection information for the Kafka instance.\n", "items": { "$ref": "#/types/volcenginecc:kafka/getInstanceConnectionInfo:getInstanceConnectionInfo" }, "type": "array" }, "createdTime": { "description": "Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.\n", "type": "string" }, "eipId": { "description": "EIP ID.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceDescription": { "description": "Brief description of the Kafka instance. Length must be between 1 and 128 characters.\n", "type": "string" }, "instanceId": { "description": "Kafka instance ID.\n", "type": "string" }, "instanceName": { "description": "Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.\n", "type": "string" }, "instanceStatus": { "description": "Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed\n", "type": "string" }, "ipWhiteLists": { "description": "List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.\n", "items": { "type": "string" }, "type": "array" }, "needRebalance": { "description": "Whether to enable rebalancing.\n", "type": "boolean" }, "parameters": { "description": "Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.\n", "type": "string" }, "partitionNumber": { "description": "Number of partitions.\n", "type": "integer" }, "privateDomainOnPublic": { "description": "Whether to enable public network domain resolution.\n", "type": "boolean" }, "projectName": { "description": "IAM project to which the currently created Kafka instance belongs.\n", "type": "string" }, "storageSpace": { "description": "Instance storage space, measured in GiB, must be specified as a multiple of 100.\n", "type": "integer" }, "storageType": { "description": "Cloud disk type for Kafka instance data storage. Can be set to ESSD*FlexPL or ESSD*PL0; default is ESSD_FlexPL.\n", "type": "string" }, "subnetId": { "description": "VPC subnet ID where the instance is located.\n", "type": "string" }, "tags": { "description": "Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation.\n", "items": { "$ref": "#/types/volcenginecc:kafka/getInstanceTag:getInstanceTag" }, "type": "array" }, "topics": { "description": "List of topics under a Kafka instance\n", "items": { "type": "string" }, "type": "array" }, "usableGroupNumber": { "description": "The remaining number of available consumer groups for the current instance.\n", "type": "integer" }, "usablePartitionNumber": { "description": "Number of available partitions remaining for the current instance.\n", "type": "integer" }, "usedGroupNumber": { "description": "Number of consumer groups (Group) currently created in the instance.\n", "type": "integer" }, "usedPartitionNumber": { "description": "Number of partitions currently used by the instance.\n", "type": "integer" }, "usedStorageSpace": { "description": "Used storage space of the instance, measured in GiB.\n", "type": "integer" }, "usedTopicNumber": { "description": "Number of topics created in the current instance.\n", "type": "integer" }, "userName": { "description": "SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.\n", "type": "string" }, "userPassword": { "description": "Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^\u0026*()_+-=\n", "type": "string" }, "version": { "description": "Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.\n", "type": "string" }, "vpcId": { "description": "Private network (VPC) ID where the instance is located.\n", "type": "string" }, "zoneId": { "description": "Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.\n", "type": "string" } }, "required": [ "accountId", "chargeInfo", "computeSpec", "connectionInfos", "createdTime", "eipId", "id", "instanceDescription", "instanceId", "instanceName", "instanceStatus", "ipWhiteLists", "needRebalance", "parameters", "partitionNumber", "privateDomainOnPublic", "projectName", "storageSpace", "storageType", "subnetId", "tags", "topics", "usableGroupNumber", "usablePartitionNumber", "usedGroupNumber", "usedPartitionNumber", "usedStorageSpace", "usedTopicNumber", "userName", "userPassword", "version", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:kafka/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::Kafka::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:kafka/getTopic:getTopic": { "description": "Data Source schema for Volcengine::Kafka::Topic\n", "inputs": { "description": "A collection of arguments for invoking getTopic.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTopic.\n", "properties": { "accessPolicies": { "description": "Custom permission configuration, which sets custom permissions for certain users on this Topic. Only required when AllAuthority is False.\n", "items": { "$ref": "#/types/volcenginecc:kafka/getTopicAccessPolicy:getTopicAccessPolicy" }, "type": "array" }, "allAuthority": { "description": "Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.\n", "type": "boolean" }, "cleanupPolicies": { "description": "Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.\n", "items": { "type": "string" }, "type": "array" }, "createdTime": { "description": "Topic creation time.\n", "type": "string" }, "description": { "description": "Topic description. Maximum length: 128 characters.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "logRetentionHours": { "description": "Message retention period, in hours. The retention period at the Topic level ranges from 1 to 2160 hours (90 days).\n", "type": "integer" }, "parameters": { "description": "Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.\n", "type": "string" }, "partitionNumber": { "description": "Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.\n", "type": "integer" }, "replicaNumber": { "description": "Number of Topic replicas. Can be set to 2 or 3; the default is 3.\n", "type": "integer" }, "status": { "description": "Topic status.\n", "type": "string" }, "tags": { "description": "Topic label information\n", "items": { "$ref": "#/types/volcenginecc:kafka/getTopicTag:getTopicTag" }, "type": "array" }, "topicName": { "description": "Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).\n", "type": "string" }, "usedStoragePercentageInInstance": { "description": "The current Topic data size as a percentage of the instance's total storage space. Displayed on the console as a percentage with two decimal places.\n", "type": "number" }, "usedStorageSpaceInBytes": { "description": "Total storage space currently used by the Topic.\n", "type": "integer" } }, "required": [ "accessPolicies", "allAuthority", "cleanupPolicies", "createdTime", "description", "id", "instanceId", "logRetentionHours", "parameters", "partitionNumber", "replicaNumber", "status", "tags", "topicName", "usedStoragePercentageInInstance", "usedStorageSpaceInBytes" ], "type": "object" } }, "volcenginecc:kafka/getTopics:getTopics": { "description": "Plural Data Source schema for Volcengine::Kafka::Topic\n", "outputs": { "description": "A collection of values returned by getTopics.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:kms/getKey:getKey": { "description": "Data Source schema for Volcengine::KMS::Key\n", "inputs": { "description": "A collection of arguments for invoking getKey.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getKey.\n", "properties": { "createdTime": { "description": "Key creation time.\n", "type": "integer" }, "description": { "description": "Key description: Length 0–8192 characters.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "keyArchiveOperation": { "description": "User master key archive operation (enter 1 to archive, 2 to unarchive).\n", "type": "integer" }, "keyEnableOperation": { "description": "User master key enable operation (enter 1 to enable, 2 to disable).\n", "type": "integer" }, "keyId": { "description": "Key unique identifier in UUID format.\n", "type": "string" }, "keyMaterialExpireTime": { "description": "Key material expiration time. If empty, the key does not expire.\n", "type": "string" }, "keyName": { "description": "Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].\n", "type": "string" }, "keyRotationOperation": { "description": "User master key rotation operation (enter 1 to enable, 2 to disable).\n", "type": "integer" }, "keySpec": { "description": "Symmetric keys: SYMMETRIC*256, SYMMETRIC*128; asymmetric keys: RSA*2048, RSA*3072, RSA*4096, EC*P256, EC*P256K, EC*P384, EC*P521, EC*SM2.\n", "type": "string" }, "keyState": { "description": "Key status: Enable, Disable, PendingDelete, Archived, PendingImport.\n", "type": "string" }, "keyUsage": { "description": "Key usage. Options: ENCRYPT*DECRYPT, SIGN*VERIFY, GENERATE*VERIFY*MAC.\n", "type": "string" }, "keyringName": { "description": "Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].\n", "type": "string" }, "lastRotationTime": { "description": "Key last rotation time.\n", "type": "string" }, "multiRegion": { "description": "Is this a multi-region type master key.\n", "type": "boolean" }, "multiRegionConfiguration": { "$ref": "#/types/volcenginecc:kms/getKeyMultiRegionConfiguration:getKeyMultiRegionConfiguration", "description": "Multi-region key configuration information.\n" }, "origin": { "description": "Key source. Options: CloudKMS, External, ExternalKeyStore.\n", "type": "string" }, "protectionLevel": { "description": "Key protection level. Options: SOFTWARE, HSM.\n", "type": "string" }, "rotateInterval": { "description": "Key rotation period (days). Range: [90, 2560].\n", "type": "integer" }, "rotateState": { "description": "Key rotation status. Options: Enable, Disable.\n", "type": "string" }, "scheduleDeleteTime": { "description": "Key deletion time.\n", "type": "string" }, "scheduleRotationTime": { "description": "Key rotation time.\n", "type": "string" }, "tags": { "description": "KMS key label information.\n", "items": { "$ref": "#/types/volcenginecc:kms/getKeyTag:getKeyTag" }, "type": "array" }, "trn": { "description": "Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.\n", "type": "string" }, "updatedTime": { "description": "Key update time.\n", "type": "integer" } }, "required": [ "createdTime", "description", "id", "keyArchiveOperation", "keyEnableOperation", "keyId", "keyMaterialExpireTime", "keyName", "keyRotationOperation", "keySpec", "keyState", "keyUsage", "keyringName", "lastRotationTime", "multiRegion", "multiRegionConfiguration", "origin", "protectionLevel", "rotateInterval", "rotateState", "scheduleDeleteTime", "scheduleRotationTime", "tags", "trn", "updatedTime" ], "type": "object" } }, "volcenginecc:kms/getKeyRing:getKeyRing": { "description": "Data Source schema for Volcengine::KMS::KeyRing\n", "inputs": { "description": "A collection of arguments for invoking getKeyRing.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getKeyRing.\n", "properties": { "createDate": { "description": "Keyring creation date\n", "type": "integer" }, "description": { "description": "Keyring description, length: 0–8192 characters\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "keyCount": { "description": "Number of keys in keyring\n", "type": "integer" }, "keyRingId": { "description": "Keyring unique identifier, in UUID format\n", "type": "string" }, "keyringName": { "description": "Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]\n", "type": "string" }, "keyringType": { "description": "Keyring type, value: CustomKeyring\n", "type": "string" }, "projectName": { "description": "Project name, default value: default\n", "type": "string" }, "uid": { "description": "Keyring tenant ID\n", "type": "string" }, "updateDate": { "description": "Keyring update date\n", "type": "integer" } }, "required": [ "createDate", "description", "id", "keyCount", "keyRingId", "keyringName", "keyringType", "projectName", "uid", "updateDate" ], "type": "object" } }, "volcenginecc:kms/getKeyRings:getKeyRings": { "description": "Plural Data Source schema for Volcengine::KMS::KeyRing\n", "outputs": { "description": "A collection of values returned by getKeyRings.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:kms/getKeys:getKeys": { "description": "Plural Data Source schema for Volcengine::KMS::Key\n", "outputs": { "description": "A collection of values returned by getKeys.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:mongodb/getAllowList:getAllowList": { "description": "Data Source schema for Volcengine::MongoDB::AllowList\n", "inputs": { "description": "A collection of arguments for invoking getAllowList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAllowList.\n", "properties": { "allowListCategory": { "description": "Allowlist type. Valid values: Ordinary: ordinary allowlist; Default: default allowlist.\n", "type": "string" }, "allowListDesc": { "description": "Allowlist remarks. Maximum length: 200 characters.\n", "type": "string" }, "allowListId": { "description": "Allowlist ID.\n", "type": "string" }, "allowListIpNum": { "description": "Total number of IP addresses (or address ranges) in the allowlist.\n", "type": "integer" }, "allowListName": { "description": "Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters.\n", "type": "string" }, "allowListType": { "description": "IP address type in the allowlist. Only IPv4 addresses are currently supported.\n", "type": "string" }, "allowLists": { "description": "Enter an IP address or a CIDR-format IP address range.\n", "items": { "type": "string" }, "type": "array" }, "associatedInstanceNum": { "description": "Total number of instances bound to the current allowlist.\n", "type": "integer" }, "associatedInstances": { "description": "Instance information bound to the current allowlist.\n", "items": { "$ref": "#/types/volcenginecc:mongodb/getAllowListAssociatedInstance:getAllowListAssociatedInstance" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "projectName": { "description": "Project to which the current allowlist belongs.\n", "type": "string" } }, "required": [ "allowLists", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "id", "projectName" ], "type": "object" } }, "volcenginecc:mongodb/getAllowLists:getAllowLists": { "description": "Plural Data Source schema for Volcengine::MongoDB::AllowList\n", "outputs": { "description": "A collection of values returned by getAllowLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:mongodb/getInstance:getInstance": { "description": "Data Source schema for Volcengine::MongoDB::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "allowListIds": { "description": "Allowlist ID list. New instances are bound to the specified allowlist.\n", "items": { "type": "string" }, "type": "array" }, "autoRenew": { "description": "Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.\n", "type": "boolean" }, "chargeStatus": { "description": "Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.\n", "type": "string" }, "chargeType": { "description": "Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).\n", "type": "string" }, "closedTime": { "description": "Scheduled shutdown time (UTC).\n", "type": "string" }, "configServerNodeSpec": { "description": "ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.\n", "type": "string" }, "configServerStorageSpaceGb": { "description": "ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.\n", "type": "integer" }, "configServers": { "description": "ConfigServer information list.\n", "items": { "$ref": "#/types/volcenginecc:mongodb/getInstanceConfigServer:getInstanceConfigServer" }, "type": "array" }, "configServersId": { "description": "ConfigServer ID\n", "type": "string" }, "createdTime": { "description": "Instance creation time (UTC).\n", "type": "string" }, "dbEngine": { "description": "Database engine. The value is fixed as MongoDB\n", "type": "string" }, "dbEngineVersion": { "description": "Database engine version. Options: MongoDB*4*0 (default): MongoDB 4.0. MongoDB*4*2: MongoDB 4.2. MongoDB*4*4: MongoDB 4.4. MongoDB*5*0: MongoDB 5.0. MongoDB*6*0: MongoDB 6.0. MongoDB*7*0: MongoDB 7.0.\n", "type": "string" }, "dbEngineVersionStr": { "description": "Database engine version string\n", "type": "string" }, "expiredTime": { "description": "Instance expiration time (UTC).\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceCount": { "description": "Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.\n", "type": "integer" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "instanceName": { "description": "Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.\n", "type": "string" }, "instanceStatus": { "description": "Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.\n", "type": "string" }, "instanceType": { "description": "MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.\n", "type": "string" }, "mongos": { "description": "Mongos information list\n", "items": { "$ref": "#/types/volcenginecc:mongodb/getInstanceMongo:getInstanceMongo" }, "type": "array" }, "mongosId": { "description": "Mongos ID.\n", "type": "string" }, "mongosNodeNumber": { "description": "Number of Mongos nodes in the sharded cluster. Range: 2~32.\n", "type": "integer" }, "mongosNodeSpec": { "description": "Specification code for Mongos nodes in a sharded cluster.\n", "type": "string" }, "nodeAvailabilityZones": { "description": "Add read-only node information, including the availability zone and quantity of read-only nodes.\n", "items": { "$ref": "#/types/volcenginecc:mongodb/getInstanceNodeAvailabilityZone:getInstanceNodeAvailabilityZone" }, "type": "array" }, "nodeNumber": { "description": "Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.\n", "type": "integer" }, "nodeSpec": { "description": "Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.\n", "type": "string" }, "nodes": { "description": "Information list for each node in the replica set instance or each node in the sharded cluster shard\n", "items": { "$ref": "#/types/volcenginecc:mongodb/getInstanceNode:getInstanceNode" }, "type": "array" }, "period": { "description": "Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.\n", "type": "integer" }, "periodUnit": { "description": "Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.\n", "type": "string" }, "privateEndpoint": { "description": "String information for the instance's private network connection address.\n", "type": "string" }, "projectName": { "description": "Select the project for the instance. If left blank, the new instance will be added to the default project.\n", "type": "string" }, "readOnlyNodeNumber": { "description": "Number of read-only nodes in the instance\n", "type": "integer" }, "reclaimTime": { "description": "Scheduled recycle time for the instance (UTC)\n", "type": "string" }, "shardNumber": { "description": "Number of shards in the sharded cluster. Range: 2–32.\n", "type": "integer" }, "shards": { "description": "Shard information list\n", "items": { "$ref": "#/types/volcenginecc:mongodb/getInstanceShard:getInstanceShard" }, "type": "array" }, "storageSpaceGb": { "description": "Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.\n", "type": "integer" }, "storageType": { "description": "Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.\n", "type": "string" }, "subnetId": { "description": "Subnet ID.\n", "type": "string" }, "superAccountName": { "description": "Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.\n", "type": "string" }, "superAccountPassword": { "description": "Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^\u0026*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.\n", "type": "string" }, "tags": { "description": "MongoDB instance tag information\n", "items": { "$ref": "#/types/volcenginecc:mongodb/getInstanceTag:getInstanceTag" }, "type": "array" }, "updatedTime": { "description": "Instance update time (UTC).\n", "type": "string" }, "vpcId": { "description": "Private network ID.\n", "type": "string" }, "zoneId": { "description": "The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).\n", "type": "string" } }, "required": [ "allowListIds", "autoRenew", "chargeStatus", "chargeType", "closedTime", "configServerNodeSpec", "configServerStorageSpaceGb", "configServers", "configServersId", "createdTime", "dbEngine", "dbEngineVersion", "dbEngineVersionStr", "expiredTime", "id", "instanceCount", "instanceId", "instanceName", "instanceStatus", "instanceType", "mongos", "mongosId", "mongosNodeNumber", "mongosNodeSpec", "nodeAvailabilityZones", "nodeNumber", "nodeSpec", "nodes", "period", "periodUnit", "privateEndpoint", "projectName", "readOnlyNodeNumber", "reclaimTime", "shardNumber", "shards", "storageSpaceGb", "storageType", "subnetId", "superAccountName", "superAccountPassword", "tags", "updatedTime", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:mongodb/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::MongoDB::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:mongodb/getSslState:getSslState": { "description": "Data Source schema for Volcengine::MongoDB::SSLState\n", "inputs": { "description": "A collection of arguments for invoking getSslState.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSslState.\n", "properties": { "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "isValid": { "description": "Whether the SSL certificate is valid. Possible values: - true: Valid - false: Invalid\n", "type": "boolean" }, "sslAction": { "description": "Perform operations on the SSL encryption feature. Possible values: - Open (default): Enable SSL encryption - Close: Disable SSL encryption - Update: Update SSL certificate validity period. You can update the SSL certificate validity period only after SSL encryption is enabled.\n", "type": "string" }, "sslEnable": { "description": "Whether SSL encryption is enabled. Possible values: - true: Enabled - false: Disabled\n", "type": "boolean" }, "sslExpiredTime": { "description": "SSL certificate expiration time, formatted as yyyy-MM-ddTHH:mm:ssZ (UTC). This parameter is returned only when the SSL certificate is valid (that is, IsValid is true).\n", "type": "string" } }, "required": [ "id", "instanceId", "isValid", "sslAction", "sslEnable", "sslExpiredTime" ], "type": "object" } }, "volcenginecc:mongodb/getSslStates:getSslStates": { "description": "Plural Data Source schema for Volcengine::MongoDB::SSLState\n", "outputs": { "description": "A collection of values returned by getSslStates.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:natgateway/getDnatentries:getDnatentries": { "description": "Plural Data Source schema for Volcengine::NatGateway::Dnatentry\n", "outputs": { "description": "A collection of values returned by getDnatentries.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:natgateway/getDnatentry:getDnatentry": { "description": "Data Source schema for Volcengine::NatGateway::Dnatentry\n", "inputs": { "description": "A collection of arguments for invoking getDnatentry.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDnatentry.\n", "properties": { "dnatEntryId": { "description": "ID of the DNAT rule.\n", "type": "string" }, "dnatEntryName": { "description": "Name of the DNAT rule.\n", "type": "string" }, "externalIp": { "description": "IP address used by the NAT gateway for network address translation. If the NAT gateway is a public NAT gateway, enter its bound public IP address. If the NAT gateway is a private NAT gateway, enter its transit IP address.\n", "type": "string" }, "externalPort": { "description": "Port or port range that receives requests from the public network.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "internalIp": { "description": "Private IP address of the cloud server instance.\n", "type": "string" }, "internalPort": { "description": "Port or port range of the private IP address of the cloud server instance.\n", "type": "string" }, "natGatewayId": { "description": "ID of the NAT gateway to which the DNAT rule belongs.\n", "type": "string" }, "portType": { "description": "Port type of the DNAT rule. specified: Specified port. any: Any port, i.e., IP mapping.\n", "type": "string" }, "protocol": { "description": "Protocol type. tcp: Forwards TCP protocol packets. udp: Forwards UDP protocol packets.\n", "type": "string" }, "status": { "description": "Status of the DNAT rule. Creating: Creating. Deleting: Deleting. Available: Available.\n", "type": "string" } }, "required": [ "dnatEntryId", "dnatEntryName", "externalIp", "externalPort", "id", "internalIp", "internalPort", "natGatewayId", "portType", "protocol", "status" ], "type": "object" } }, "volcenginecc:natgateway/getNatIp:getNatIp": { "description": "Data Source schema for Volcengine::NatGateway::NatIp\n", "inputs": { "description": "A collection of arguments for invoking getNatIp.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNatIp.\n", "properties": { "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "isDefault": { "description": "Whether this is the default transit IP. true: Yes. false: No.\n", "type": "boolean" }, "natGatewayId": { "description": "Private NAT gateway ID.\n", "type": "string" }, "natIp": { "description": "Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.\n", "type": "string" }, "natIpDescription": { "description": "Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n", "type": "string" }, "natIpId": { "description": "Transit IP ID.\n", "type": "string" }, "natIpName": { "description": "Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.\n", "type": "string" }, "status": { "description": "Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.\n", "type": "string" }, "usingStatus": { "description": "Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.\n", "type": "string" } }, "required": [ "id", "isDefault", "natGatewayId", "natIp", "natIpDescription", "natIpId", "natIpName", "status", "usingStatus" ], "type": "object" } }, "volcenginecc:natgateway/getNatIps:getNatIps": { "description": "Plural Data Source schema for Volcengine::NatGateway::NatIp\n", "outputs": { "description": "A collection of values returned by getNatIps.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:natgateway/getNgw:getNgw": { "description": "Data Source schema for Volcengine::NatGateway::NGW\n", "inputs": { "description": "A collection of arguments for invoking getNgw.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNgw.\n", "properties": { "billingType": { "description": "NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.\n", "type": "integer" }, "businessStatus": { "description": "Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.\n", "type": "string" }, "createdTime": { "description": "Creation time\n", "type": "string" }, "deletedTime": { "description": "Deletion time\n", "type": "string" }, "description": { "description": "Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "directMode": { "description": "Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.\n", "type": "boolean" }, "dnatEntryIds": { "description": "DNAT rule ID list.\n", "items": { "type": "string" }, "type": "array" }, "eipAddresses": { "description": "Information about the public IP bound to the NAT Gateway\n", "items": { "$ref": "#/types/volcenginecc:natgateway/getNgwEipAddress:getNgwEipAddress" }, "type": "array" }, "expiredTime": { "description": "Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lockReason": { "description": "Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.\n", "type": "string" }, "natGatewayId": { "description": "NAT gateway ID.\n", "type": "string" }, "natGatewayName": { "description": "Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.\n", "type": "string" }, "natIpAddresses": { "description": "Transit IP list for private NAT instance\n", "items": { "$ref": "#/types/volcenginecc:natgateway/getNgwNatIpAddress:getNgwNatIpAddress" }, "type": "array" }, "networkInterfaceId": { "description": "Network interface ID occupied by the NAT gateway.\n", "type": "string" }, "networkType": { "description": "NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.\n", "type": "string" }, "overdueTime": { "description": "Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.\n", "type": "string" }, "period": { "description": "Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.\n", "type": "integer" }, "periodUnit": { "description": "Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.\n", "type": "string" }, "projectName": { "description": "Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.\n", "type": "string" }, "smartScheduleEnabled": { "description": "Whether to enable intelligent scheduling\n", "type": "boolean" }, "smartScheduleRule": { "description": "Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.\n", "type": "string" }, "snatEntryIds": { "description": "SNAT rule ID list\n", "items": { "type": "string" }, "type": "array" }, "spec": { "description": "NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. Extra*Large*1: Extra Large 1. Extra*Large*2: Extra Large 2.\n", "type": "string" }, "status": { "description": "Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.\n", "type": "string" }, "subnetId": { "description": "ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.\n", "type": "string" }, "tags": { "description": "Tag list\n", "items": { "$ref": "#/types/volcenginecc:natgateway/getNgwTag:getNgwTag" }, "type": "array" }, "updatedTime": { "description": "Last operation time of the NAT Gateway\n", "type": "string" }, "vpcId": { "description": "ID of the private network where the NAT Gateway is located\n", "type": "string" }, "zoneId": { "description": "ID of the primary availability zone the NAT Gateway belongs to\n", "type": "string" } }, "required": [ "billingType", "businessStatus", "createdTime", "deletedTime", "description", "directMode", "dnatEntryIds", "eipAddresses", "expiredTime", "id", "lockReason", "natGatewayId", "natGatewayName", "natIpAddresses", "networkInterfaceId", "networkType", "overdueTime", "period", "periodUnit", "projectName", "smartScheduleEnabled", "smartScheduleRule", "snatEntryIds", "spec", "status", "subnetId", "tags", "updatedTime", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:natgateway/getNgws:getNgws": { "description": "Plural Data Source schema for Volcengine::NatGateway::NGW\n", "outputs": { "description": "A collection of values returned by getNgws.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:natgateway/getSnatentries:getSnatentries": { "description": "Plural Data Source schema for Volcengine::NatGateway::Snatentry\n", "outputs": { "description": "A collection of values returned by getSnatentries.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:natgateway/getSnatentry:getSnatentry": { "description": "Data Source schema for Volcengine::NatGateway::Snatentry\n", "inputs": { "description": "A collection of arguments for invoking getSnatentry.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSnatentry.\n", "properties": { "eipAddress": { "description": "IP address of the public IP associated with the SNAT rule. Returns the IP address for a single public IP. Returns IP addresses for multiple public IPs.\n", "type": "string" }, "eipId": { "description": "ID of the public IP associated with the SNAT rule. Returns the ID for a single public IP. Returns IDs for multiple public IPs.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "natGatewayId": { "description": "ID of the NAT gateway associated with the SNAT rule\n", "type": "string" }, "natIpId": { "description": "ID of the transit IP for the private NAT gateway\n", "type": "string" }, "snatEntryId": { "description": "ID of the SNAT rule\n", "type": "string" }, "snatEntryName": { "description": "Name of the SNAT rule\n", "type": "string" }, "sourceCidr": { "description": "Network segment corresponding to the SNAT rule\n", "type": "string" }, "status": { "description": "Status of the SNAT rule. Creating: being created. Deleting: being deleted. Available: available.\n", "type": "string" }, "subnetId": { "description": "ID of the subnet associated with the SNAT rule\n", "type": "string" } }, "required": [ "eipAddress", "eipId", "id", "natGatewayId", "natIpId", "snatEntryId", "snatEntryName", "sourceCidr", "status", "subnetId" ], "type": "object" } }, "volcenginecc:organization/getAccount:getAccount": { "description": "Data Source schema for Volcengine::Organization::Account\n", "inputs": { "description": "A collection of arguments for invoking getAccount.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAccount.\n", "properties": { "accountId": { "description": "Volcano account ID\n", "type": "string" }, "accountName": { "description": "Account name. 5–20 characters\n", "type": "string" }, "allowConsole": { "description": "Allow console access: 1. Allowed, 2. Not allowed\n", "type": "integer" }, "allowExit": { "description": "Allow exit: 1. Allowed, 2. Not allowed\n", "type": "integer" }, "createdTime": { "description": "Creation time\n", "type": "string" }, "deleteUk": { "description": "Deletion flag\n", "type": "string" }, "deletedTime": { "description": "Deletion time\n", "type": "string" }, "description": { "description": "Description\n", "type": "string" }, "iamRole": { "description": "IAM role name\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "isOwner": { "description": "Administrator status: 0. Non-administrator, 1. Administrator\n", "type": "integer" }, "joinType": { "description": "Join type: 1. Create, 2. Invite\n", "type": "integer" }, "mainName": { "description": "Subject name\n", "type": "string" }, "memberAccountId": { "description": "Organization member account ID\n", "type": "string" }, "orgId": { "description": "Organization ID\n", "type": "string" }, "orgType": { "description": "Organization type: 1. Enterprise organization\n", "type": "integer" }, "orgUnitId": { "description": "Organizational unit ID. Enter 0 to join the root unit\n", "type": "string" }, "orgUnitName": { "description": "Organizational unit name\n", "type": "string" }, "orgVerificationId": { "description": "Authentication subject ID\n", "type": "string" }, "owner": { "description": "Administrator ID\n", "type": "string" }, "password": { "description": "Account password\n", "type": "string" }, "secureContactInfo": { "$ref": "#/types/volcenginecc:organization/getAccountSecureContactInfo:getAccountSecureContactInfo", "description": "Security contact information\n" }, "showName": { "description": "Display name\n", "type": "string" }, "tags": { "description": "Tag list\n", "items": { "$ref": "#/types/volcenginecc:organization/getAccountTag:getAccountTag" }, "type": "array" }, "updatedTime": { "description": "Update time\n", "type": "string" }, "verificationRelationId": { "description": "Inherited authentication subject account ID, required when creating an account for a non-administrator authentication subject. The account must have joined the enterprise organization. If not specified, the authentication subject of the enterprise organization administrator is inherited by default\n", "type": "string" } }, "required": [ "accountId", "accountName", "allowConsole", "allowExit", "createdTime", "deleteUk", "deletedTime", "description", "iamRole", "id", "isOwner", "joinType", "mainName", "memberAccountId", "orgId", "orgType", "orgUnitId", "orgUnitName", "orgVerificationId", "owner", "password", "secureContactInfo", "showName", "tags", "updatedTime", "verificationRelationId" ], "type": "object" } }, "volcenginecc:organization/getAccounts:getAccounts": { "description": "Plural Data Source schema for Volcengine::Organization::Account\n", "outputs": { "description": "A collection of values returned by getAccounts.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:organization/getOrganization:getOrganization": { "description": "Data Source schema for Volcengine::Organization::Organization\n", "inputs": { "description": "A collection of arguments for invoking getOrganization.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getOrganization.\n", "properties": { "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "organization": { "$ref": "#/types/volcenginecc:organization/getOrganizationOrganization:getOrganizationOrganization", "description": "Organization Details\n" }, "organizationId": { "description": "Organization ID\n", "type": "string" }, "owner": { "$ref": "#/types/volcenginecc:organization/getOrganizationOwner:getOrganizationOwner", "description": "Administrator Details\n" } }, "required": [ "id", "organization", "organizationId", "owner" ], "type": "object" } }, "volcenginecc:organization/getOrganizations:getOrganizations": { "description": "Plural Data Source schema for Volcengine::Organization::Organization\n", "outputs": { "description": "A collection of values returned by getOrganizations.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:organization/getServiceControlPolicies:getServiceControlPolicies": { "description": "Plural Data Source schema for Volcengine::Organization::ServiceControlPolicy\n", "outputs": { "description": "A collection of values returned by getServiceControlPolicies.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:organization/getServiceControlPolicy:getServiceControlPolicy": { "description": "Data Source schema for Volcengine::Organization::ServiceControlPolicy\n", "inputs": { "description": "A collection of arguments for invoking getServiceControlPolicy.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getServiceControlPolicy.\n", "properties": { "createDate": { "description": "Creation time.\n", "type": "string" }, "description": { "description": "Description.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "policyId": { "description": "Policy ID.\n", "type": "string" }, "policyName": { "description": "Policy name.\n", "type": "string" }, "policyType": { "description": "Policy type.\n", "type": "string" }, "statement": { "description": "Policy expression.\n", "type": "string" }, "targets": { "description": "List of bound target objects.\n", "items": { "$ref": "#/types/volcenginecc:organization/getServiceControlPolicyTarget:getServiceControlPolicyTarget" }, "type": "array" }, "updateDate": { "description": "Update time.\n", "type": "string" } }, "required": [ "createDate", "description", "id", "policyId", "policyName", "policyType", "statement", "targets", "updateDate" ], "type": "object" } }, "volcenginecc:organization/getUnit:getUnit": { "description": "Data Source schema for Volcengine::Organization::Unit\n", "inputs": { "description": "A collection of arguments for invoking getUnit.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getUnit.\n", "properties": { "createdTime": { "description": "Creation time.\n", "type": "string" }, "deleteUk": { "description": "Deletion flag.\n", "type": "string" }, "deletedTime": { "description": "Deletion time.\n", "type": "string" }, "depth": { "description": "Depth.\n", "type": "integer" }, "description": { "description": "Description.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "name": { "description": "Organizational unit name.\n", "type": "string" }, "orgId": { "description": "Organization ID.\n", "type": "string" }, "orgType": { "description": "Organization type. Enterprise organization: 1\n", "type": "integer" }, "orgUnitId": { "description": "Organizational unit ID.\n", "type": "string" }, "owner": { "description": "Administrator ID.\n", "type": "string" }, "parentId": { "description": "Parent unit ID.\n", "type": "string" }, "updatedTime": { "description": "Update time.\n", "type": "string" } }, "required": [ "createdTime", "deleteUk", "deletedTime", "depth", "description", "id", "name", "orgId", "orgType", "orgUnitId", "owner", "parentId", "updatedTime" ], "type": "object" } }, "volcenginecc:organization/getUnits:getUnits": { "description": "Plural Data Source schema for Volcengine::Organization::Unit\n", "outputs": { "description": "A collection of values returned by getUnits.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:privatelink/getEndpointService:getEndpointService": { "description": "Data Source schema for Volcengine::PrivateLink::EndpointService\n", "inputs": { "description": "A collection of arguments for invoking getEndpointService.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getEndpointService.\n", "properties": { "autoAcceptEnabled": { "description": "Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.\n", "type": "boolean" }, "billingType": { "description": "Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.\n", "type": "integer" }, "businessStatus": { "description": "Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.\n", "type": "string" }, "createTime": { "description": "Creation time of the endpoint service.\n", "type": "string" }, "description": { "description": "Description of the endpoint service.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAddressVersions": { "description": "IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.\n", "items": { "type": "string" }, "type": "array" }, "payer": { "description": "Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.\n", "type": "string" }, "permitAccountIds": { "description": "Details of authorized allowlist accounts.\n", "items": { "type": "string" }, "type": "array" }, "privateDnsEnabled": { "description": "Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.\n", "type": "boolean" }, "privateDnsName": { "description": "Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.\n", "type": "string" }, "privateDnsNameConfiguration": { "$ref": "#/types/volcenginecc:privatelink/getEndpointServicePrivateDnsNameConfiguration:getEndpointServicePrivateDnsNameConfiguration", "description": "Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.\n" }, "privateDnsType": { "description": "Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.\n", "type": "string" }, "projectName": { "description": "Project name to which the endpoint service belongs.\n", "type": "string" }, "resources": { "description": "Resources provided by the endpoint service.\n", "items": { "$ref": "#/types/volcenginecc:privatelink/getEndpointServiceResource:getEndpointServiceResource" }, "type": "array" }, "serviceDomain": { "description": "Service domain name of the endpoint service.\n", "type": "string" }, "serviceId": { "description": "Endpoint service ID.\n", "type": "string" }, "serviceName": { "description": "Name of the endpoint service.\n", "type": "string" }, "serviceNameManaged": { "description": "Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.\n", "type": "string" }, "serviceNameSuffix": { "description": "Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.\n", "type": "string" }, "serviceOwner": { "description": "Current service principal.\n", "type": "string" }, "serviceResourceType": { "description": "Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.\n", "type": "string" }, "serviceType": { "description": "Type of the endpoint service. Interface: Interface endpoint service.\n", "type": "string" }, "status": { "description": "Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.\n", "type": "string" }, "tags": { "description": "Tag information of the endpoint service.\n", "items": { "$ref": "#/types/volcenginecc:privatelink/getEndpointServiceTag:getEndpointServiceTag" }, "type": "array" }, "updateTime": { "description": "Most recent operation time of the endpoint service.\n", "type": "string" }, "wildcardDomainEnabled": { "description": "Whether to enable wildcard domain name. true: Enabled. false: Not enabled.\n", "type": "boolean" }, "zoneIds": { "description": "Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "autoAcceptEnabled", "billingType", "businessStatus", "createTime", "description", "id", "ipAddressVersions", "payer", "permitAccountIds", "privateDnsEnabled", "privateDnsName", "privateDnsNameConfiguration", "privateDnsType", "projectName", "resources", "serviceDomain", "serviceId", "serviceName", "serviceNameManaged", "serviceNameSuffix", "serviceOwner", "serviceResourceType", "serviceType", "status", "tags", "updateTime", "wildcardDomainEnabled", "zoneIds" ], "type": "object" } }, "volcenginecc:privatelink/getEndpointServices:getEndpointServices": { "description": "Plural Data Source schema for Volcengine::PrivateLink::EndpointService\n", "outputs": { "description": "A collection of values returned by getEndpointServices.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:privatelink/getVpcEndpoint:getVpcEndpoint": { "description": "Data Source schema for Volcengine::PrivateLink::VpcEndpoint\n", "inputs": { "description": "A collection of arguments for invoking getVpcEndpoint.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getVpcEndpoint.\n", "properties": { "bps": { "description": "Maximum bandwidth limit for the endpoint node connection, in Mbps.\n", "type": "integer" }, "businessStatus": { "description": "Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.\n", "type": "string" }, "connectionStatus": { "description": "Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.\n", "type": "string" }, "creationTime": { "description": "Creation time of the endpoint.\n", "type": "string" }, "deletedTime": { "description": "Deletion time of the endpoint.\n", "type": "string" }, "description": { "description": "Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.\n", "type": "string" }, "endpointDomain": { "description": "Domain name of the endpoint.\n", "type": "string" }, "endpointId": { "description": "ID of the endpoint node.\n", "type": "string" }, "endpointIndex": { "description": "Endpoint index\n", "type": "integer" }, "endpointName": { "description": "Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.\n", "type": "string" }, "endpointType": { "description": "Type of the endpoint node. Interface: interface endpoint node.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAddressVersions": { "description": "IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 \u0026 ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use \u0026 to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.\n", "items": { "type": "string" }, "type": "array" }, "payer": { "description": "Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.\n", "type": "string" }, "privateDnsEnabled": { "description": "Enable private DNS name. false (default): disabled. true: enabled.\n", "type": "boolean" }, "privateDnsName": { "description": "The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the endpoint node belongs.\n", "type": "string" }, "securityGroupIds": { "description": "ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with \u0026.\n", "items": { "type": "string" }, "type": "array" }, "serviceId": { "description": "ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.\n", "type": "string" }, "serviceManaged": { "description": "Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.\n", "type": "boolean" }, "serviceName": { "description": "Name of the endpoint service to be associated.\n", "type": "string" }, "status": { "description": "Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.\n", "type": "string" }, "tags": { "description": "Endpoint user tag.\n", "items": { "$ref": "#/types/volcenginecc:privatelink/getVpcEndpointTag:getVpcEndpointTag" }, "type": "array" }, "updateTime": { "description": "Most recent operation time of the endpoint.\n", "type": "string" }, "vpcId": { "description": "ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.\n", "type": "string" }, "zones": { "description": "Availability zone of the endpoint node.\n", "items": { "$ref": "#/types/volcenginecc:privatelink/getVpcEndpointZone:getVpcEndpointZone" }, "type": "array" } }, "required": [ "bps", "businessStatus", "connectionStatus", "creationTime", "deletedTime", "description", "endpointDomain", "endpointId", "endpointIndex", "endpointName", "endpointType", "id", "ipAddressVersions", "payer", "privateDnsEnabled", "privateDnsName", "projectName", "securityGroupIds", "serviceId", "serviceManaged", "serviceName", "status", "tags", "updateTime", "vpcId", "zones" ], "type": "object" } }, "volcenginecc:privatelink/getVpcEndpointConnection:getVpcEndpointConnection": { "description": "Data Source schema for Volcengine::PrivateLink::VpcEndpointConnection\n", "inputs": { "description": "A collection of arguments for invoking getVpcEndpointConnection.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getVpcEndpointConnection.\n", "properties": { "bps": { "description": "Maximum bandwidth for the endpoint connection, range 100–20000 Mbps\n", "type": "integer" }, "connectionStatus": { "description": "Status of the endpoint connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted\n", "type": "string" }, "creationTime": { "description": "Creation time of the endpoint connection\n", "type": "string" }, "endpointId": { "description": "Endpoint ID\n", "type": "string" }, "endpointOwnerAccountId": { "description": "Account ID to which the endpoint belongs\n", "type": "string" }, "endpointVpcId": { "description": "ID of the VPC to which the endpoint network interface belongs\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "replaceResourceId": { "description": "New service resource ID\n", "type": "string" }, "replacingResource": { "description": "Whether to operate the endpoint connection for seamless service resource replacement. true: yes, disconnect the old service resource for the seamless replacement endpoint connection. false: no, reject the specified endpoint connection. If this parameter is empty, the specified endpoint connection is rejected\n", "type": "string" }, "resourcesAllocates": { "description": "Specified service resource\n", "items": { "$ref": "#/types/volcenginecc:privatelink/getVpcEndpointConnectionResourcesAllocate:getVpcEndpointConnectionResourcesAllocate" }, "type": "array" }, "serviceId": { "description": "Endpoint service ID\n", "type": "string" }, "updateTime": { "description": "Most recent operation time of the endpoint connection\n", "type": "string" }, "zoneId": { "description": "Endpoint zone ID\n", "type": "string" }, "zones": { "description": "Details of the endpoint zone\n", "items": { "$ref": "#/types/volcenginecc:privatelink/getVpcEndpointConnectionZone:getVpcEndpointConnectionZone" }, "type": "array" } }, "required": [ "bps", "connectionStatus", "creationTime", "endpointId", "endpointOwnerAccountId", "endpointVpcId", "id", "replaceResourceId", "replacingResource", "resourcesAllocates", "serviceId", "updateTime", "zoneId", "zones" ], "type": "object" } }, "volcenginecc:privatelink/getVpcEndpointConnections:getVpcEndpointConnections": { "description": "Plural Data Source schema for Volcengine::PrivateLink::VpcEndpointConnection\n", "outputs": { "description": "A collection of values returned by getVpcEndpointConnections.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:privatelink/getVpcEndpoints:getVpcEndpoints": { "description": "Plural Data Source schema for Volcengine::PrivateLink::VpcEndpoint\n", "outputs": { "description": "A collection of values returned by getVpcEndpoints.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:privatezone/getRecord:getRecord": { "description": "Data Source schema for Volcengine::PrivateZone::Record\n", "inputs": { "description": "A collection of arguments for invoking getRecord.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRecord.\n", "properties": { "createdAt": { "description": "Creation time of the DNS record.\n", "type": "string" }, "enable": { "description": "Indicates whether the DNS record is enabled.\n", "type": "boolean" }, "host": { "description": "Domain prefix for the subdomain.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lastOperator": { "description": "Account ID of the most recent update to the DNS record.\n", "type": "string" }, "line": { "description": "DNS record route, only the default route 'default' is supported.\n", "type": "string" }, "recordId": { "description": "DNS record ID.\n", "type": "string" }, "remark": { "description": "Remarks. Supports UTF-8 characters. Maximum 16 characters. Default is an empty string.\n", "type": "string" }, "ttl": { "description": "DNS record TTL (time to live), in seconds. Default is 600.\n", "type": "integer" }, "type": { "description": "DNS record type. Valid values are: A: A record. AAAA: AAAA record. CNAME: CNAME record. TXT: TXT record. MX: MX record. PTR: PTR record. A: A record. AAAA: AAAA record. CNAME: CNAME record. TXT: TXT record. MX: MX record. PTR: PTR record.\n", "type": "string" }, "updatedAt": { "description": "Last update time of the DNS record.\n", "type": "string" }, "value": { "description": "Record value.\n", "type": "string" }, "weight": { "description": "Record weight. The weight takes effect only when load balancing is enabled for the domain name.\n", "type": "integer" }, "weightEnabled": { "description": "Indicates whether load balancing is enabled for this record set.\n", "type": "boolean" }, "zid": { "description": "Domain name ID.\n", "type": "integer" } }, "required": [ "createdAt", "enable", "host", "id", "lastOperator", "line", "recordId", "remark", "ttl", "type", "updatedAt", "value", "weight", "weightEnabled", "zid" ], "type": "object" } }, "volcenginecc:privatezone/getRecords:getRecords": { "description": "Plural Data Source schema for Volcengine::PrivateZone::Record\n", "outputs": { "description": "A collection of values returned by getRecords.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:privatezone/getResolverEndpoint:getResolverEndpoint": { "description": "Data Source schema for Volcengine::PrivateZone::ResolverEndpoint\n", "inputs": { "description": "A collection of arguments for invoking getResolverEndpoint.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getResolverEndpoint.\n", "properties": { "createdTime": { "description": "Creation time\n", "type": "string" }, "direction": { "description": "DNS request forwarding direction for the endpoint. OUTBOUND (default): outbound endpoint forwards DNS queries from within the VPC to external DNS servers. INBOUND: inbound endpoint forwards DNS queries from external sources to the resolver\n", "type": "string" }, "endpointId": { "description": "Endpoint ID\n", "type": "string" }, "endpointType": { "description": "Endpoint type. IPv4: IPv4 endpoint. DualStack: dual-stack endpoint\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipConfigs": { "description": "Availability zone, subnet, and IP configuration for the endpoint\n", "items": { "$ref": "#/types/volcenginecc:privatezone/getResolverEndpointIpConfig:getResolverEndpointIpConfig" }, "type": "array" }, "name": { "description": "Endpoint name. Supports UTF-8 format\n", "type": "string" }, "projectName": { "description": "Project name to which the endpoint belongs. Default is default\n", "type": "string" }, "securityGroupId": { "description": "Security group ID for the endpoint IP address. The endpoint uses a default security group: For outbound endpoints, inbound traffic is denied; outbound traffic allows TCP port 53 and UDP port 53 to 0.0.0.0/0. For inbound endpoints, inbound traffic allows TCP port 53 and UDP port 53 to 0.0.0.0/0; outbound traffic is denied\n", "type": "string" }, "status": { "description": "Endpoint status. Creating: creating. Running: running. Updating: updating. Error: abnormal operation\n", "type": "string" }, "tags": { "description": "Tag list\n", "items": { "$ref": "#/types/volcenginecc:privatezone/getResolverEndpointTag:getResolverEndpointTag" }, "type": "array" }, "updatedTime": { "description": "Update time\n", "type": "string" }, "vpcId": { "description": "VPC ID where the endpoint is located\n", "type": "string" }, "vpcRegion": { "description": "Region of the VPC where the endpoint is located\n", "type": "string" } }, "required": [ "createdTime", "direction", "endpointId", "endpointType", "id", "ipConfigs", "name", "projectName", "securityGroupId", "status", "tags", "updatedTime", "vpcId", "vpcRegion" ], "type": "object" } }, "volcenginecc:privatezone/getResolverEndpoints:getResolverEndpoints": { "description": "Plural Data Source schema for Volcengine::PrivateZone::ResolverEndpoint\n", "outputs": { "description": "A collection of values returned by getResolverEndpoints.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:privatezone/getResolverRule:getResolverRule": { "description": "Data Source schema for Volcengine::PrivateZone::ResolverRule\n", "inputs": { "description": "A collection of arguments for invoking getResolverRule.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getResolverRule.\n", "properties": { "createdTime": { "description": "Creation time of the forwarding rule\n", "type": "string" }, "enable": { "description": "Whether the forwarding rule is enabled. true: enabled. false: disabled\n", "type": "boolean" }, "endpointId": { "description": "Endpoint ID. This parameter is only valid and required when the Type parameter is OUTBOUND\n", "type": "integer" }, "forwardIPs": { "description": "IP address and port of the external DNS server. You can add up to 10 IP addresses. This parameter is only valid and required when the Type parameter is OUTBOUND\n", "items": { "$ref": "#/types/volcenginecc:privatezone/getResolverRuleForwardIP:getResolverRuleForwardIP" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lastOperator": { "description": "Account ID of the last update to the forwarding rule\n", "type": "string" }, "line": { "description": "Carrier for the outbound IP address of the recursive DNS server. This parameter is only valid when the Type parameter is LINE. Supported values: Mobile: China Mobile, Telecom: China Telecom, Unicom: China Unicom\n", "type": "string" }, "name": { "description": "Name of the forwarding rule. Supports UTF-8 format\n", "type": "string" }, "projectName": { "description": "Project name associated with the forwarding rule. Default is default\n", "type": "string" }, "ruleId": { "description": "Forwarding rule ID\n", "type": "string" }, "tags": { "description": "One or more tags associated with the forwarding rule\n", "items": { "$ref": "#/types/volcenginecc:privatezone/getResolverRuleTag:getResolverRuleTag" }, "type": "array" }, "type": { "description": "Forwarding rule type. OUTBOUND: Forward to external DNS server. LINE: Carrier for the outbound IP address of the custom public recursive DNS server\n", "type": "string" }, "updatedTime": { "description": "Update time of the forwarding rule\n", "type": "string" }, "vpCs": { "description": "VPC associated with the forwarding rule. The forwarding rule takes effect in the associated VPC. When the Type parameter is OUTBOUND, the VPC region must match the region of the endpoint\n", "items": { "$ref": "#/types/volcenginecc:privatezone/getResolverRuleVpC:getResolverRuleVpC" }, "type": "array" }, "zoneName": { "description": "Domain name(s) associated with the forwarding rule. You can enter one or more domain names. Separate multiple domain names with English commas. Up to 500 domain names are supported. This parameter is only valid and required when the Type parameter is OUTBOUND. If you set this parameter to *, the forwarding rule applies to all domain names associated with the VPC\n", "type": "string" } }, "required": [ "createdTime", "enable", "endpointId", "forwardIPs", "id", "lastOperator", "line", "name", "projectName", "ruleId", "tags", "type", "updatedTime", "vpCs", "zoneName" ], "type": "object" } }, "volcenginecc:privatezone/getResolverRules:getResolverRules": { "description": "Plural Data Source schema for Volcengine::PrivateZone::ResolverRule\n", "outputs": { "description": "A collection of values returned by getResolverRules.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:privatezone/getUserVpcAuthorization:getUserVpcAuthorization": { "description": "Data Source schema for Volcengine::PrivateZone::UserVPCAuthorization\n", "inputs": { "description": "A collection of arguments for invoking getUserVpcAuthorization.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getUserVpcAuthorization.\n", "properties": { "accountId": { "description": "Account.\n", "type": "string" }, "authType": { "description": "Verification method. 0: Use enterprise organization verification. 1: Use verification code.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "status": { "description": "Account status. Normal: The account is in the enterprise organization. Exited: The account has exited the enterprise organization.\n", "type": "string" }, "verifyCode": { "description": "Verification code. This parameter is required when AuthType is set to 1.\n", "type": "string" } }, "required": [ "accountId", "authType", "id", "status", "verifyCode" ], "type": "object" } }, "volcenginecc:privatezone/getUserVpcAuthorizations:getUserVpcAuthorizations": { "description": "Plural Data Source schema for Volcengine::PrivateZone::UserVPCAuthorization\n", "outputs": { "description": "A collection of values returned by getUserVpcAuthorizations.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rabbitmq/getAllowList:getAllowList": { "description": "Data Source schema for Volcengine::RabbitMQ::AllowList\n", "inputs": { "description": "A collection of arguments for invoking getAllowList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAllowList.\n", "properties": { "allowList": { "description": "IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed\n", "type": "string" }, "allowListDesc": { "description": "Allowlist Description\n", "type": "string" }, "allowListId": { "description": "Allowlist ID\n", "type": "string" }, "allowListIpNum": { "description": "Total number of IP addresses (or address ranges) in the allowlist\n", "type": "integer" }, "allowListName": { "description": "Allowlist Name\n", "type": "string" }, "allowListType": { "description": "IP address type in the allowlist. Only IPv4 is currently supported\n", "type": "string" }, "associatedInstanceNum": { "description": "Total number of instances bound to the allowlist\n", "type": "integer" }, "associatedInstances": { "description": "List of bound instances\n", "items": { "$ref": "#/types/volcenginecc:rabbitmq/getAllowListAssociatedInstance:getAllowListAssociatedInstance" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "modifyMode": { "description": "Allowlist modification method. Default is Cover\n", "type": "string" } }, "required": [ "allowList", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "id", "modifyMode" ], "type": "object" } }, "volcenginecc:rabbitmq/getAllowLists:getAllowLists": { "description": "Plural Data Source schema for Volcengine::RabbitMQ::AllowList\n", "outputs": { "description": "A collection of values returned by getAllowLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rabbitmq/getInstance:getInstance": { "description": "Data Source schema for Volcengine::RabbitMQ::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "accountId": { "description": "Main account ID used to create the instance.\n", "type": "string" }, "applyPrivateDnsToPublic": { "description": "Whether public DNS resolution is enabled. true: enabled, false: disabled.\n", "type": "boolean" }, "archType": { "description": "Instance type, either cluster or standalone.\n", "type": "string" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rabbitmq/getInstanceChargeDetail:getInstanceChargeDetail", "description": "Instance billing method and related billing information.\n" }, "computeSpec": { "description": "Compute specification of the RabbitMQ instance.\n", "type": "string" }, "createdTime": { "description": "Instance creation time.\n", "type": "string" }, "eipId": { "description": "EIP ID.\n", "type": "string" }, "endpoints": { "description": "Instance connection information.\n", "items": { "$ref": "#/types/volcenginecc:rabbitmq/getInstanceEndpoint:getInstanceEndpoint" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceDescription": { "description": "Brief description of the instance.\n", "type": "string" }, "instanceId": { "description": "RabbitMQ instance ID.\n", "type": "string" }, "instanceName": { "description": "RabbitMQ instance name.\n", "type": "string" }, "instanceStatus": { "description": "Instance status.\n", "type": "string" }, "isEncrypted": { "description": "Whether cloud disk encryption is enabled.\n", "type": "boolean" }, "projectName": { "description": "IAM project to which the instance belongs.\n", "type": "string" }, "storageSpace": { "description": "Total storage space of the instance, measured in GiB.\n", "type": "integer" }, "subnetId": { "description": "VPC subnet ID.\n", "type": "string" }, "tags": { "description": "Tags bound to the instance.\n", "items": { "$ref": "#/types/volcenginecc:rabbitmq/getInstanceTag:getInstanceTag" }, "type": "array" }, "usedStorageSpace": { "description": "Used storage space of the instance, measured in GiB.\n", "type": "integer" }, "userName": { "description": "RabbitMQ WebUI administrator account name.\n", "type": "string" }, "userPassword": { "description": "RabbitMQ WebUI administrator password.\n", "type": "string" }, "version": { "description": "Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.\n", "type": "string" }, "vpcId": { "description": "Private network (VPC) ID.\n", "type": "string" }, "zoneDescription": { "description": "Description of the availability zone.\n", "type": "string" }, "zoneId": { "description": "Availability zone ID where the instance is located. For high-availability instances across AZs, multiple availability zone IDs are returned.\n", "type": "string" } }, "required": [ "accountId", "applyPrivateDnsToPublic", "archType", "chargeDetail", "computeSpec", "createdTime", "eipId", "endpoints", "id", "instanceDescription", "instanceId", "instanceName", "instanceStatus", "isEncrypted", "projectName", "storageSpace", "subnetId", "tags", "usedStorageSpace", "userName", "userPassword", "version", "vpcId", "zoneDescription", "zoneId" ], "type": "object" } }, "volcenginecc:rabbitmq/getInstancePlugin:getInstancePlugin": { "description": "Data Source schema for Volcengine::RabbitMQ::InstancePlugin\n", "inputs": { "description": "A collection of arguments for invoking getInstancePlugin.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstancePlugin.\n", "properties": { "description": { "description": "Plugin description\n", "type": "string" }, "disablePrompt": { "description": "Notes for disabling this plugin\n", "type": "string" }, "enablePrompt": { "description": "Notes for enabling this plugin\n", "type": "string" }, "enabled": { "description": "Whether the plugin is enabled. true: The plugin is enabled. false: The plugin is disabled\n", "type": "boolean" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "needRebootOnChange": { "description": "Whether enabling or disabling the plugin will cause a RabbitMQ instance restart. true: The instance will restart. false: The instance will not restart\n", "type": "boolean" }, "pluginName": { "description": "Plugin name\n", "type": "string" }, "port": { "description": "Plugin listening port\n", "type": "integer" }, "version": { "description": "Plugin version\n", "type": "string" } }, "required": [ "description", "disablePrompt", "enablePrompt", "enabled", "id", "instanceId", "needRebootOnChange", "pluginName", "port", "version" ], "type": "object" } }, "volcenginecc:rabbitmq/getInstancePlugins:getInstancePlugins": { "description": "Plural Data Source schema for Volcengine::RabbitMQ::InstancePlugin\n", "outputs": { "description": "A collection of values returned by getInstancePlugins.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rabbitmq/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::RabbitMQ::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rabbitmq/getPublicAddress:getPublicAddress": { "description": "Data Source schema for Volcengine::RabbitMQ::PublicAddress\n", "inputs": { "description": "A collection of arguments for invoking getPublicAddress.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getPublicAddress.\n", "properties": { "accountId": { "description": "Main account ID that created the instance.\n", "type": "string" }, "applyPrivateDnsToPublic": { "description": "Whether public DNS resolution is enabled. true: enabled, false: disabled.\n", "type": "boolean" }, "archType": { "description": "Instance type: cluster or standalone.\n", "type": "string" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rabbitmq/getPublicAddressChargeDetail:getPublicAddressChargeDetail", "description": "Instance billing method and related billing information.\n" }, "computeSpec": { "description": "RabbitMQ instance compute specification.\n", "type": "string" }, "createdTime": { "description": "Instance creation time.\n", "type": "string" }, "eipId": { "description": "EIP ID.\n", "type": "string" }, "endpoints": { "description": "Instance connection information.\n", "items": { "$ref": "#/types/volcenginecc:rabbitmq/getPublicAddressEndpoint:getPublicAddressEndpoint" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceDescription": { "description": "Brief description of the instance.\n", "type": "string" }, "instanceId": { "description": "RabbitMQ instance ID.\n", "type": "string" }, "instanceName": { "description": "RabbitMQ instance name.\n", "type": "string" }, "instanceStatus": { "description": "Instance status.\n", "type": "string" }, "isEncrypted": { "description": "Whether cloud disk encryption is enabled.\n", "type": "boolean" }, "projectName": { "description": "IAM project the instance belongs to.\n", "type": "string" }, "storageSpace": { "description": "Total storage space of the instance, in GiB.\n", "type": "integer" }, "subnetId": { "description": "VPC subnet ID.\n", "type": "string" }, "tags": { "description": "Tags bound to the instance.\n", "items": { "$ref": "#/types/volcenginecc:rabbitmq/getPublicAddressTag:getPublicAddressTag" }, "type": "array" }, "usedStorageSpace": { "description": "Used storage space of the instance, in GiB.\n", "type": "integer" }, "userName": { "description": "RabbitMQ WebUI administrator account name.\n", "type": "string" }, "version": { "description": "Supported RabbitMQ versions. Currently supported versions include: 3.8.18: RabbitMQ version 3.8.18.\n", "type": "string" }, "vpcId": { "description": "Private network (VPC) ID.\n", "type": "string" }, "zoneDescription": { "description": "Description of the availability zone.\n", "type": "string" }, "zoneId": { "description": "Availability zone ID where the instance is located. For high availability instances across AZs, multiple availability zone IDs are returned.\n", "type": "string" } }, "required": [ "accountId", "applyPrivateDnsToPublic", "archType", "chargeDetail", "computeSpec", "createdTime", "eipId", "endpoints", "id", "instanceDescription", "instanceId", "instanceName", "instanceStatus", "isEncrypted", "projectName", "storageSpace", "subnetId", "tags", "usedStorageSpace", "userName", "version", "vpcId", "zoneDescription", "zoneId" ], "type": "object" } }, "volcenginecc:rabbitmq/getPublicAddresses:getPublicAddresses": { "description": "Plural Data Source schema for Volcengine::RabbitMQ::PublicAddress\n", "outputs": { "description": "A collection of values returned by getPublicAddresses.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdsmssql/getAllowList:getAllowList": { "description": "Data Source schema for Volcengine::RDSMsSQL::AllowList\n", "inputs": { "description": "A collection of arguments for invoking getAllowList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAllowList.\n", "properties": { "allowList": { "description": "IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed\n", "type": "string" }, "allowListCategory": { "description": "Allowlist category\n", "type": "string" }, "allowListDesc": { "description": "Allowlist description\n", "type": "string" }, "allowListId": { "description": "Allowlist ID\n", "type": "string" }, "allowListIpNum": { "description": "Allowlist IP count\n", "type": "integer" }, "allowListName": { "description": "Allowlist name\n", "type": "string" }, "allowListType": { "description": "IP address type in the allowlist. Only IPv4 is supported\n", "type": "string" }, "associatedInstanceNum": { "description": "Number of bound instances. Required when unbinding an instance from the allowlist\n", "type": "integer" }, "associatedInstances": { "description": "Bound instance list\n", "items": { "$ref": "#/types/volcenginecc:rdsmssql/getAllowListAssociatedInstance:getAllowListAssociatedInstance" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "projectName": { "description": "Project name\n", "type": "string" }, "userAllowList": { "description": "IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence\n", "type": "string" } }, "required": [ "allowList", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "id", "instanceId", "projectName", "userAllowList" ], "type": "object" } }, "volcenginecc:rdsmssql/getAllowLists:getAllowLists": { "description": "Plural Data Source schema for Volcengine::RDSMsSQL::AllowList\n", "outputs": { "description": "A collection of values returned by getAllowLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdsmssql/getInstance:getInstance": { "description": "Data Source schema for Volcengine::RDSMsSQL::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "advancedFeatures": { "description": "Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {\"Key\":\"Value\"}\n", "type": "string" }, "allowListIds": { "description": "Allowlist ID list permitted for access.\n", "items": { "type": "string" }, "type": "array" }, "backupUse": { "description": "Used backup space for the instance, in GiB.\n", "type": "number" }, "chargeInfo": { "$ref": "#/types/volcenginecc:rdsmssql/getInstanceChargeInfo:getInstanceChargeInfo", "description": "Payment method.\n" }, "connectionInfos": { "description": "Connection information.\n", "items": { "$ref": "#/types/volcenginecc:rdsmssql/getInstanceConnectionInfo:getInstanceConnectionInfo" }, "type": "array" }, "createdTime": { "description": "Creation time.\n", "type": "string" }, "dbEngineVersion": { "description": "Compatible version. Values: SQLServer*2019*Std: SQL Server 2019 Standard Edition. SQLServer*2019*Ent: SQL Server 2019 Enterprise Edition. SQLServer*2019*Web: SQL Server 2019 Web Edition. SQLServer*2022*Std: SQL Server 2022 Standard Edition. SQLServer*2022*Ent: SQL Server 2022 Enterprise Edition. SQLServer*2022*Web: SQL Server 2022 Web Edition.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "innerVersion": { "description": "Kernel version number.\n", "type": "string" }, "instanceCategory": { "description": "Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "instanceName": { "description": "Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.\n", "type": "string" }, "instanceStatus": { "description": "Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.\n", "type": "string" }, "instanceType": { "description": "Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.\n", "type": "string" }, "maintenanceTime": { "description": "Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.\n", "type": "string" }, "masterNodeId": { "description": "Primary node ID. This parameter is required when manually switching master and standby nodes.\n", "type": "string" }, "memory": { "description": "Memory size, in GiB.\n", "type": "integer" }, "nodeDetailInfos": { "description": "Instance node information.\n", "items": { "$ref": "#/types/volcenginecc:rdsmssql/getInstanceNodeDetailInfo:getInstanceNodeDetailInfo" }, "type": "array" }, "nodeSpec": { "description": "Instance specification code.\n", "type": "string" }, "port": { "description": "Port.\n", "type": "string" }, "primaryInstanceId": { "description": "Primary instance ID. If this field is empty, this instance is the primary instance.\n", "type": "string" }, "projectName": { "description": "Project.\n", "type": "string" }, "readOnlyNumber": { "description": "Number of read-only instances.\n", "type": "integer" }, "serverCollation": { "description": "Instance collation. Default: Chinese*PRC*CI*AS. Most native collations are supported. Available values: Latin1*General*CI*AS, Latin1*General*CS*AS, SQL*Latin1*General*CP1*CI*AS, SQL*Latin1*General*CP1*CS*AS, Chinese*PRC*CI*AS, Chinese*PRC*CS*AS, Chinese*PRC*BIN, Japanese*CI*AS, Japanese*CS*AS, Chinese*Taiwan*Stroke*CI*AS, Chinese*Taiwan*Stroke*CS*AS, Thai*CI*AS, Chinese*PRC*CI*AI, Chinese*PRC*BIN2, Cyrillic*General*CI_AS.\n", "type": "string" }, "slowQueryEnable": { "description": "Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.\n", "type": "boolean" }, "slowQueryTime": { "description": "Slow log threshold. Range: [1~10], unit: seconds (s).\n", "type": "string" }, "storageSpace": { "description": "Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.\n", "type": "integer" }, "storageType": { "description": "Instance storage type.\n", "type": "string" }, "storageUse": { "description": "Used storage space for the instance. Unit: GiB.\n", "type": "number" }, "subnetId": { "description": "Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.\n", "type": "string" }, "superAccountPassword": { "description": "Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^\u0026*()_+-=.\n", "type": "string" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:rdsmssql/getInstanceTag:getInstanceTag" }, "type": "array" }, "timeZone": { "description": "Time zone.\n", "type": "string" }, "updatedTime": { "description": "Update time.\n", "type": "string" }, "vcpu": { "description": "CPU size. For example: 1 means 1 core.\n", "type": "integer" }, "vpcId": { "description": "VPC ID\n", "type": "string" }, "zoneId": { "description": "Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.\n", "type": "string" } }, "required": [ "advancedFeatures", "allowListIds", "backupUse", "chargeInfo", "connectionInfos", "createdTime", "dbEngineVersion", "id", "innerVersion", "instanceCategory", "instanceId", "instanceName", "instanceStatus", "instanceType", "maintenanceTime", "masterNodeId", "memory", "nodeDetailInfos", "nodeSpec", "port", "primaryInstanceId", "projectName", "readOnlyNumber", "serverCollation", "slowQueryEnable", "slowQueryTime", "storageSpace", "storageType", "storageUse", "subnetId", "superAccountPassword", "tags", "timeZone", "updatedTime", "vcpu", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:rdsmssql/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::RDSMsSQL::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdsmysql/getAllowList:getAllowList": { "description": "Data Source schema for Volcengine::RDSMySQL::AllowList\n", "inputs": { "description": "A collection of arguments for invoking getAllowList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAllowList.\n", "properties": { "allowListCategory": { "description": "Allowlist category. Values: Ordinary: Ordinary allowlist. Default: Default allowlist. Note: When used as a request parameter, the default value is Ordinary.\n", "type": "string" }, "allowListDesc": { "description": "Allowlist remarks.\n", "type": "string" }, "allowListId": { "description": "Allowlist ID.\n", "type": "string" }, "allowListIpNum": { "description": "Total number of IP addresses (or ranges) in the allowlist.\n", "type": "integer" }, "allowListName": { "description": "Allowlist name.\n", "type": "string" }, "allowListType": { "description": "IP address types in the allowlist. Only IPv4 addresses are currently supported.\n", "type": "string" }, "allowLists": { "description": "IP address list in the allowlist\n", "items": { "type": "string" }, "type": "array" }, "associatedInstanceNum": { "description": "Total number of instances bound to the allowlist.\n", "type": "integer" }, "associatedInstances": { "description": "Instance information bound to the current allowlist.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getAllowListAssociatedInstance:getAllowListAssociatedInstance" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ignoreInstanceStatus": { "description": "Ignore instance status check. Values: true: Yes. false: No. Default value.\n", "type": "boolean" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "ipLists": { "description": "List of IP addresses and IP ranges included in the allowlist. Returned when the WithIpList request parameter is set to true; returns null when set to false or not specified.\n", "items": { "type": "string" }, "type": "array" }, "modifyMode": { "description": "Modification method. Available values: Cover (default): Overwrite the original allowlist with the values from the AllowList parameter. Append: Add the IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove the IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain.\n", "type": "string" }, "projectName": { "description": "Project. Note: If the AK/SK used to call the API belongs to a sub-account that only has permission for a specific project, you need to provide this request parameter.\n", "type": "string" }, "securityGroupBindInfos": { "description": "Information about the security group associated with the allowlist. Note: This field cannot be used together with SecurityGroupIds.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getAllowListSecurityGroupBindInfo:getAllowListSecurityGroupBindInfo" }, "type": "array" }, "securityGroupIds": { "description": "List of security group IDs to associate. Note: You can call the DescribeSecurityGroups API to query security group information, including security group IDs. A single allowlist can add up to 10 security groups at a time. This field cannot be used together with SecurityGroupBindInfos.\n", "items": { "type": "string" }, "type": "array" }, "updateSecurityGroup": { "description": "Whether to update the security group bound to the allowlist. true: update. false: do not update. Default value. This field is effective only when the allowlist is already bound to a security group. You can call the DescribeAllowLists API to check if the allowlist is bound to a security group.\n", "type": "boolean" }, "userAllowLists": { "description": "IP addresses entered by the user in this list. The IPs in the AllowList field are the union of IPs included in UserAllowList and SecurityGroupBindInfos.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "allowLists", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "id", "ignoreInstanceStatus", "instanceId", "ipLists", "modifyMode", "projectName", "securityGroupBindInfos", "securityGroupIds", "updateSecurityGroup", "userAllowLists" ], "type": "object" } }, "volcenginecc:rdsmysql/getAllowLists:getAllowLists": { "description": "Plural Data Source schema for Volcengine::RDSMySQL::AllowList\n", "outputs": { "description": "A collection of values returned by getAllowLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdsmysql/getBackup:getBackup": { "description": "Data Source schema for Volcengine::RDSMySQL::Backup\n", "inputs": { "description": "A collection of arguments for invoking getBackup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBackup.\n", "properties": { "backupEndTime": { "description": "Backup creation end time (UTC)\n", "type": "string" }, "backupFileName": { "description": "Backup file name\n", "type": "string" }, "backupFileSize": { "description": "Backup file size (bytes)\n", "type": "integer" }, "backupId": { "description": "Backup ID\n", "type": "string" }, "backupMetas": { "description": "When creating a logical backup of database tables, this is used to specify the database and table information to be backed up\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getBackupBackupMeta:getBackupBackupMeta" }, "type": "array" }, "backupMethod": { "description": "Backup type. Values: Physical (physical backup), Logical (logical backup), Snapshot (snapshot backup)\n", "type": "string" }, "backupName": { "description": "Backup name\n", "type": "string" }, "backupRegion": { "description": "Backup region\n", "type": "string" }, "backupStartTime": { "description": "Backup creation start time (UTC)\n", "type": "string" }, "backupStatus": { "description": "Backup status. Values: Success, Failed, Running\n", "type": "string" }, "backupType": { "description": "Backup method. Values: Full (full/database table backup), Increment (incremental backup), DumpAll (full database backup)\n", "type": "string" }, "consistentTime": { "description": "Consistency time point\n", "type": "string" }, "createType": { "description": "Backup creator. Values: System (system), User (user)\n", "type": "string" }, "dbEngineVersion": { "description": "Compatible version. Values: MySQL*5*7: MySQL 5.7 version; MySQL*8*0: MySQL 8.0 version\n", "type": "string" }, "dbTableInfos": { "description": "Database and table information list\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getBackupDbTableInfo:getBackupDbTableInfo" }, "type": "array" }, "downloadStatus": { "description": "Download status\n", "type": "string" }, "engineType": { "description": "Database engine type. Values: InnoDB: InnoDB engine; RocksDB: RocksDB engine\n", "type": "string" }, "errorMessage": { "description": "Error message for backup failure\n", "type": "string" }, "expiredTime": { "description": "Backup expiration time (UTC)\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "isEncrypted": { "description": "Whether encrypted\n", "type": "boolean" }, "isExpired": { "description": "Whether expired\n", "type": "boolean" } }, "required": [ "backupEndTime", "backupFileName", "backupFileSize", "backupId", "backupMetas", "backupMethod", "backupName", "backupRegion", "backupStartTime", "backupStatus", "backupType", "consistentTime", "createType", "dbEngineVersion", "dbTableInfos", "downloadStatus", "engineType", "errorMessage", "expiredTime", "id", "instanceId", "isEncrypted", "isExpired" ], "type": "object" } }, "volcenginecc:rdsmysql/getBackups:getBackups": { "description": "Plural Data Source schema for Volcengine::RDSMySQL::Backup\n", "outputs": { "description": "A collection of values returned by getBackups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdsmysql/getDatabase:getDatabase": { "description": "Data Source schema for Volcengine::RDSMySQL::Database\n", "inputs": { "description": "A collection of arguments for invoking getDatabase.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDatabase.\n", "properties": { "characterSetName": { "description": "Database character set. Supported character sets: utf8, utf8mb4 (default), latin1, ascii.\n", "type": "string" }, "databasePrivileges": { "description": "Database privilege authorization information.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getDatabaseDatabasePrivilege:getDatabaseDatabasePrivilege" }, "type": "array" }, "description": { "description": "Database description, up to 256 characters. This field is optional. If not set, or if set with a description length of 0, the description will be empty.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Database instance ID.\n", "type": "string" }, "name": { "description": "Database name. Naming rules: must be unique; length must be 2–64 characters; must start with a letter and end with a letter or number; can contain letters, numbers, underscores (_), or hyphens (-); certain reserved words, such as root and admin, cannot be used.\n", "type": "string" }, "status": { "description": "Database status. Values: Unavailable (not available), Available (available).\n", "type": "string" } }, "required": [ "characterSetName", "databasePrivileges", "description", "id", "instanceId", "name", "status" ], "type": "object" } }, "volcenginecc:rdsmysql/getDatabases:getDatabases": { "description": "Plural Data Source schema for Volcengine::RDSMySQL::Database\n", "outputs": { "description": "A collection of values returned by getDatabases.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdsmysql/getDbAccount:getDbAccount": { "description": "Data Source schema for Volcengine::RDSMySQL::DBAccount\n", "inputs": { "description": "A collection of arguments for invoking getDbAccount.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDbAccount.\n", "properties": { "accountDesc": { "description": "Account information description, maximum length 256 characters.\n", "type": "string" }, "accountName": { "description": "Database account name. Naming rules: Must be 2–32 characters long. Must start with a letter and end with a letter or number. Can contain letters, numbers, underscores (_), and hyphens (-). The account name must be unique within the instance. Certain reserved words cannot be used; for disabled reserved words, see the disabled word list. Note: The keywords root and admin can be used in high-privilege account names.\n", "type": "string" }, "accountPassword": { "description": "Database account password. Rules: Length must be 8–32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^\u0026*()_+-=,.\u0026?|/.\n", "type": "string" }, "accountPrivileges": { "description": "Specified database privilege information for the account. Note: When AccountType is set to Super, AccountPrivileges does not need to be specified.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getDbAccountAccountPrivilege:getDbAccountAccountPrivilege" }, "type": "array" }, "accountPrivilegesSqls": { "description": "SQL statement for the account's specified database permission information.\n", "items": { "type": "string" }, "type": "array" }, "accountStatus": { "description": "Account status. Values: Unavailable: unavailable. Available: available.\n", "type": "string" }, "accountType": { "description": "Account type. Value options: Super: high-privilege account. Normal: regular account.\n", "type": "string" }, "hasTableColumnPrivilegeDbNames": { "description": "The database to which the account's table/column privileges belong. Note: If the account does not have table/column privileges, this field will not be returned.\n", "items": { "type": "string" }, "type": "array" }, "host": { "description": "IP address from which the specified database account can access the database.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "tableColumnPrivileges": { "description": "Account table column permission settings.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getDbAccountTableColumnPrivilege:getDbAccountTableColumnPrivilege" }, "type": "array" } }, "required": [ "accountDesc", "accountName", "accountPassword", "accountPrivileges", "accountPrivilegesSqls", "accountStatus", "accountType", "hasTableColumnPrivilegeDbNames", "host", "id", "instanceId", "tableColumnPrivileges" ], "type": "object" } }, "volcenginecc:rdsmysql/getDbAccounts:getDbAccounts": { "description": "Plural Data Source schema for Volcengine::RDSMySQL::DBAccount\n", "outputs": { "description": "A collection of values returned by getDbAccounts.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdsmysql/getEndpoint:getEndpoint": { "description": "Data Source schema for Volcengine::RDSMySQL::Endpoint\n", "inputs": { "description": "A collection of arguments for invoking getEndpoint.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getEndpoint.\n", "properties": { "addresses": { "description": "Endpoint address list.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getEndpointAddress:getEndpointAddress" }, "type": "array" }, "autoAddNewNodes": { "description": "When the endpoint type is read/write or read-only, you can set whether new nodes are automatically added. Values: true: automatically added. false: not automatically added (default).\n", "type": "boolean" }, "connectAllSlaveNodes": { "description": "Associate all replica nodes. Values: true: enabled (default). false: disabled. Note: Only read-only endpoints of multi-node instances support this configuration. This feature can be disabled only if the instance has two or more replica nodes.\n", "type": "boolean" }, "connectionInfoTags": { "description": "Connection endpoint tags.\n", "items": { "type": "string" }, "type": "array" }, "connectionMode": { "description": "Endpoint type. Options: Proxy: proxy endpoint. Direct: direct endpoint. Note: If the database proxy feature is enabled for the instance, you can select Proxy or Direct. If the database proxy feature is not enabled, only Direct is available. You can call the DescribeDBInstanceDetail API to check the status of the database proxy feature for the instance.\n", "type": "string" }, "connectionPoolType": { "description": "Connection pool type for proxy endpoints. Options: Transaction: transaction-level connection pool (default). Direct: direct mode. Note: Single-node instances do not support this feature.\n", "type": "string" }, "customRouteStrategy": { "$ref": "#/types/volcenginecc:rdsmysql/getEndpointCustomRouteStrategy:getEndpointCustomRouteStrategy", "description": "SQL forwarding rules for the connection endpoint.\n" }, "description": { "description": "Remarks.\n", "type": "string" }, "enableConnectionPersistent": { "description": "Enable connection keep-alive for the endpoint. Values: true: enabled. false: disabled. Note: Only proxy endpoints support this setting.\n", "type": "boolean" }, "enableReadOnly": { "description": "Enable global read-only. Values: Enable: enabled. Disable: not enabled.\n", "type": "string" }, "endpointId": { "description": "Instance connection endpoint ID.\n", "type": "string" }, "endpointName": { "description": "Instance connection endpoint name.\n", "type": "string" }, "endpointType": { "description": "Endpoint type. Value: Custom (custom endpoint).\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "idleConnectionReclaim": { "description": "Enable idle connection recycling. true: enabled. false: not enabled. Note: This field is returned only for proxy endpoints.\n", "type": "boolean" }, "implicitTransSplit": { "description": "Enable transaction separation. Options: true: yes. false: no. Note: Only proxy endpoints return this field.\n", "type": "boolean" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "masterNodeRouting": { "description": "Enable primary node routing. Values: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints.\n", "type": "boolean" }, "masterProtectorTimeout": { "description": "Overload protection timeout. Value range: integer between 60~7200. Unit: seconds. Note: This field is returned only for proxy endpoints.\n", "type": "integer" }, "multiStatementsMode": { "description": "Multi-Statements mode for proxy endpoints. Options: Strict: strict mode (default). Loose: loose mode.\n", "type": "string" }, "nodes": { "description": "List of node IDs configured for the connection endpoint. Required when EndpointType is Custom. Note: To add the primary node to the endpoint, do not enter the primary node ID; just enter Primary. Separate multiple node IDs with commas (,).\n", "type": "string" }, "overloadProtection": { "description": "Enable overload protection. Options: true: enabled. false: disabled. Note: This field is returned only for proxy endpoints.\n", "type": "boolean" }, "readOnlyNodeDistributionType": { "description": "Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, the value range is: LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, the value range is: Default: automatic allocation based on specification weight. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weight round-robin scheduling. RoundRobinAuto: automatic weight allocation round-robin scheduling.\n", "type": "string" }, "readOnlyNodeMaxDelayTime": { "description": "Read-only node latency threshold. Value range: 1~3600. Default: 30. Unit: seconds.\n", "type": "integer" }, "readOnlyNodeWeights": { "description": "List of nodes configured for the connection endpoint and their corresponding read-only weights.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getEndpointReadOnlyNodeWeight:getEndpointReadOnlyNodeWeight" }, "type": "array" }, "readWriteMode": { "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only.\n", "type": "string" }, "readWriteSpliting": { "description": "Enable read/write splitting. Values: true: enabled (default). false: disabled.\n", "type": "boolean" } }, "required": [ "addresses", "autoAddNewNodes", "connectAllSlaveNodes", "connectionInfoTags", "connectionMode", "connectionPoolType", "customRouteStrategy", "description", "enableConnectionPersistent", "enableReadOnly", "endpointId", "endpointName", "endpointType", "id", "idleConnectionReclaim", "implicitTransSplit", "instanceId", "masterNodeRouting", "masterProtectorTimeout", "multiStatementsMode", "nodes", "overloadProtection", "readOnlyNodeDistributionType", "readOnlyNodeMaxDelayTime", "readOnlyNodeWeights", "readWriteMode", "readWriteSpliting" ], "type": "object" } }, "volcenginecc:rdsmysql/getEndpoints:getEndpoints": { "description": "Plural Data Source schema for Volcengine::RDSMySQL::Endpoint\n", "outputs": { "description": "A collection of values returned by getEndpoints.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdsmysql/getInstance:getInstance": { "description": "Data Source schema for Volcengine::RDSMySQL::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "addressObjects": { "description": "Connection information for the default endpoint\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceAddressObject:getInstanceAddressObject" }, "type": "array" }, "allowListIds": { "description": "Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists\n", "items": { "type": "string" }, "type": "array" }, "allowListVersion": { "description": "Allowlist version\n", "type": "string" }, "autoStorageScalingConfig": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceAutoStorageScalingConfig:getInstanceAutoStorageScalingConfig", "description": "Auto scaling configuration\n" }, "autoUpgradeMinorVersion": { "description": "Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.\n", "type": "string" }, "backupAuditLogSize": { "description": "Space used by audit logs in backup.\n", "type": "integer" }, "backupBinLogSize": { "description": "Space used by binlog logs in backup.\n", "type": "integer" }, "backupDataSize": { "description": "Space used by data in backup.\n", "type": "integer" }, "backupErrorLogSize": { "description": "Space used by error logs in backups.\n", "type": "integer" }, "backupFreeQuotaSize": { "description": "Free backup storage space, in GB\n", "type": "integer" }, "backupLogSize": { "description": "Space used by logs in backups.\n", "type": "integer" }, "backupSlowLogSize": { "description": "Space used by slow logs in backups.\n", "type": "integer" }, "backupUse": { "description": "Backup space used by the instance, in GB\n", "type": "number" }, "basicBackupBinlogSize": { "description": "Space used by Binlog logs in basic backups.\n", "type": "integer" }, "basicBackupDataSize": { "description": "Space used by data in the base backup\n", "type": "integer" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceChargeDetail:getInstanceChargeDetail", "description": "Billing method\n" }, "cpuNum": { "description": "Number of CPU cores for the database proxy service of the instance\n", "type": "integer" }, "createdTime": { "description": "Instance creation local time.\n", "type": "string" }, "currentKernelVersion": { "description": "Instance kernel minor version.\n", "type": "string" }, "dbEngineVersion": { "description": "Compatible versions. Values: MySQL*5*7: MySQL 5.7 version. MySQL*8*0: MySQL 8.0 version\n", "type": "string" }, "dbParamGroupId": { "description": "Parameter template ID. Default value is the default parameter template for the database engine version\n", "type": "string" }, "dbTimeZone": { "description": "Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.\n", "type": "string" }, "deletionProtection": { "description": "Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.\n", "type": "string" }, "disasterRecoveryInstances": { "description": "Disaster recovery instance information for the instance.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceDisasterRecoveryInstance:getInstanceDisasterRecoveryInstance" }, "type": "array" }, "drDtsTaskId": { "description": "ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.\n", "type": "string" }, "drDtsTaskName": { "description": "Name of synchronization tasks between primary and disaster recovery instances.\n", "type": "string" }, "drDtsTaskStatus": { "description": "Status of synchronization tasks between primary and disaster recovery instances.\n", "type": "string" }, "drSecondsBehindMaster": { "description": "Latency between the disaster recovery instance and the primary instance.\n", "type": "integer" }, "endpoints": { "description": "Instance connection information.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceEndpoint:getInstanceEndpoint" }, "type": "array" }, "globalReadOnly": { "description": "Enable global read-only mode. Values: true: enabled. false: disabled (default is false)\n", "type": "boolean" }, "hasDisasterRecoveryInstances": { "description": "Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.\n", "type": "boolean" }, "hasGreenInstance": { "description": "Is the instance in blue-green deployment? Values: true: yes. false: no.\n", "type": "boolean" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "instanceName": { "description": "Instance name.\n", "type": "string" }, "instanceStatus": { "description": "Instance status.\n", "type": "string" }, "instanceType": { "description": "Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type\n", "type": "string" }, "lowerCaseTableNames": { "description": "Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.\n", "type": "string" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceMaintenanceWindow:getInstanceMaintenanceWindow", "description": "Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).\n" }, "masterInstanceId": { "description": "Primary instance ID\n", "type": "string" }, "masterInstanceName": { "description": "Primary instance name.\n", "type": "string" }, "memory": { "description": "Memory size. Unit: GB.\n", "type": "integer" }, "nodeCpuUsedPercentage": { "description": "Average CPU usage of the primary node in the instance over the past minute.\n", "type": "number" }, "nodeMemoryUsedPercentage": { "description": "Average memory usage of the primary node over the past minute\n", "type": "number" }, "nodeNumber": { "description": "Number of nodes.\n", "type": "string" }, "nodeSpaceUsedPercentage": { "description": "Average disk usage of the primary node over the past minute\n", "type": "number" }, "nodeSpec": { "description": "Node specifications.\n", "type": "string" }, "nodes": { "description": "Instance node information.\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceNode:getInstanceNode" }, "type": "array" }, "port": { "description": "Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.\n", "type": "integer" }, "projectName": { "description": "Project.\n", "type": "string" }, "proxyDetail": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceProxyDetail:getInstanceProxyDetail", "description": "proxy information\n" }, "storageAuditLogSize": { "description": "Space used by audit logs in instance storage\n", "type": "integer" }, "storageBinLogSize": { "description": "Binlog space usage in the instance storage\n", "type": "integer" }, "storageDataSize": { "description": "Space used by data in instance storage.\n", "type": "integer" }, "storageErrorLogSize": { "description": "Space used by error logs in instance storage.\n", "type": "integer" }, "storageLogSize": { "description": "Space used by logs in the instance storage\n", "type": "integer" }, "storageSlowLogSize": { "description": "Space used by slow logs in instance storage\n", "type": "integer" }, "storageSpace": { "description": "Total storage space of the instance, in GB\n", "type": "integer" }, "storageType": { "description": "Instance storage type. Value range: LocalSSD: local disk. CloudESSD*FlexPL: FlexPL cloud disk. CloudESSD*PL0: PL0 cloud disk.\n", "type": "string" }, "storageUse": { "description": "Storage space used by the instance, in GB\n", "type": "number" }, "subnetId": { "description": "Subnet ID.\n", "type": "string" }, "superAccountName": { "description": "High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.\n", "type": "string" }, "superAccountPassword": { "description": "Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^\u0026*()_+-=,.\u0026?|/.\n", "type": "string" }, "syncMode": { "description": "Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous\n", "type": "string" }, "tags": { "description": "RDS MySQL instance tag information\n", "items": { "$ref": "#/types/volcenginecc:rdsmysql/getInstanceTag:getInstanceTag" }, "type": "array" }, "timeZone": { "description": "Time zone\n", "type": "string" }, "updatedTime": { "description": "Instance updates local time.\n", "type": "string" }, "vcpu": { "description": "CPU size. For example: 1 means 1U.\n", "type": "integer" }, "vpcId": { "description": "VPC (Virtual Private Cloud) ID.\n", "type": "string" }, "zoneId": { "description": "Availability zone of the instance's primary node.\n", "type": "string" }, "zoneIds": { "description": "List of availability zones for each node in the instance.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "addressObjects", "allowListIds", "allowListVersion", "autoStorageScalingConfig", "autoUpgradeMinorVersion", "backupAuditLogSize", "backupBinLogSize", "backupDataSize", "backupErrorLogSize", "backupFreeQuotaSize", "backupLogSize", "backupSlowLogSize", "backupUse", "basicBackupBinlogSize", "basicBackupDataSize", "chargeDetail", "cpuNum", "createdTime", "currentKernelVersion", "dbEngineVersion", "dbParamGroupId", "dbTimeZone", "deletionProtection", "disasterRecoveryInstances", "drDtsTaskId", "drDtsTaskName", "drDtsTaskStatus", "drSecondsBehindMaster", "endpoints", "globalReadOnly", "hasDisasterRecoveryInstances", "hasGreenInstance", "id", "instanceId", "instanceName", "instanceStatus", "instanceType", "lowerCaseTableNames", "maintenanceWindow", "masterInstanceId", "masterInstanceName", "memory", "nodeCpuUsedPercentage", "nodeMemoryUsedPercentage", "nodeNumber", "nodeSpaceUsedPercentage", "nodeSpec", "nodes", "port", "projectName", "proxyDetail", "storageAuditLogSize", "storageBinLogSize", "storageDataSize", "storageErrorLogSize", "storageLogSize", "storageSlowLogSize", "storageSpace", "storageType", "storageUse", "subnetId", "superAccountName", "superAccountPassword", "syncMode", "tags", "timeZone", "updatedTime", "vcpu", "vpcId", "zoneId", "zoneIds" ], "type": "object" } }, "volcenginecc:rdsmysql/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::RDSMySQL::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdspostgresql/getAllowList:getAllowList": { "description": "Data Source schema for Volcengine::RDSPostgreSQL::AllowList\n", "inputs": { "description": "A collection of arguments for invoking getAllowList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAllowList.\n", "properties": { "allowListCategory": { "description": "Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.\n", "type": "string" }, "allowListDesc": { "description": "Description of the allowlist. Up to 200 characters. Default value is an empty string.\n", "type": "string" }, "allowListId": { "description": "Allowlist ID.\n", "type": "string" }, "allowListIpNum": { "description": "Number of IP addresses or IP segments in the allowlist.\n", "type": "integer" }, "allowListName": { "description": "Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (*). It can only contain Chinese characters, letters, numbers, underscores (*), and hyphens (-). Length must be 1–128 characters.\n", "type": "string" }, "allowListType": { "description": "Network protocol type used by the allowlist. Value: IPv4 (default).\n", "type": "string" }, "allowLists": { "description": "IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.\n", "items": { "type": "string" }, "type": "array" }, "associatedInstanceNum": { "description": "Number of instances bound to this allowlist.\n", "type": "integer" }, "associatedInstances": { "description": "List of instances bound to this allowlist, including instance ID and instance name.\n", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getAllowListAssociatedInstance:getAllowListAssociatedInstance" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAddress": { "description": "Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.\n", "type": "string" }, "modifyMode": { "description": "Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.\n", "type": "string" }, "securityGroupBindInfos": { "description": "List of security groups bound to this allowlist.\n", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getAllowListSecurityGroupBindInfo:getAllowListSecurityGroupBindInfo" }, "type": "array" }, "updateSecurityGroup": { "description": "Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.\n", "type": "boolean" }, "userAllowList": { "description": "IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.\n", "type": "string" } }, "required": [ "allowLists", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "id", "ipAddress", "modifyMode", "securityGroupBindInfos", "updateSecurityGroup", "userAllowList" ], "type": "object" } }, "volcenginecc:rdspostgresql/getAllowLists:getAllowLists": { "description": "Plural Data Source schema for Volcengine::RDSPostgreSQL::AllowList\n", "outputs": { "description": "A collection of values returned by getAllowLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdspostgresql/getDatabase:getDatabase": { "description": "Data Source schema for Volcengine::RDSPostgreSQL::Database\n", "inputs": { "description": "A collection of arguments for invoking getDatabase.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDatabase.\n", "properties": { "cType": { "description": "Character classification. Supported values: C (default), C.UTF-8, en*US.utf8, zh*CN.utf8, and POSIX\n", "type": "string" }, "characterSetName": { "description": "Database character set. Supported character sets: utf8 (default), latin1, ascii\n", "type": "string" }, "collate": { "description": "Collation. Supported values: C (default), C.UTF-8, en*US.utf8, zh*CN.utf8, and POSIX\n", "type": "string" }, "dbName": { "description": "Database name. Naming rules: Length must be 2–63 characters. Can contain letters, numbers, underscores, or hyphens. Must start with a letter and end with a letter or number. Reserved keywords are not allowed. For a list of all disabled keywords, see Disabled Keywords.\n", "type": "string" }, "dbStatus": { "description": "Database status: Unavailable: Not available. Available: Available.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "owner": { "description": "Database owner. Note: Read-only instance accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the database owner. If no value is provided or the value is empty, this field defaults to rds superuser\n", "type": "string" } }, "required": [ "cType", "characterSetName", "collate", "dbName", "dbStatus", "id", "instanceId", "owner" ], "type": "object" } }, "volcenginecc:rdspostgresql/getDatabases:getDatabases": { "description": "Plural Data Source schema for Volcengine::RDSPostgreSQL::Database\n", "outputs": { "description": "A collection of values returned by getDatabases.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdspostgresql/getDbAccount:getDbAccount": { "description": "Data Source schema for Volcengine::RDSPostgreSQL::DBAccount\n", "inputs": { "description": "A collection of arguments for invoking getDbAccount.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDbAccount.\n", "properties": { "accountName": { "description": "Database account name. The account name rules are as follows: Length must be 2–63 characters. Can contain letters, numbers, underscores (*), or hyphens (-). Must start with a letter and end with a letter or number. Cannot start with pg*. Reserved keywords cannot be used. For all disabled keywords, see Disabled Keywords.\n", "type": "string" }, "accountPassword": { "description": "Database account password. The password rules are as follows: Length must be 8–32 characters. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters. Supported special characters: !@#$%^*()\u0026_+-=.\n", "type": "string" }, "accountPrivileges": { "description": "Account permission information. Separate multiple permissions with commas (,). Valid values: Login: Login permission. Inherit: Inherit permission. CreateRole: Create role permission. CreateDB: Create database permission. Note: If the account type is high privilege, you do not need to provide this parameter; all permissions are supported by default. If the account type is normal, you can provide this parameter; the default values are Login and Inherit. If the account type is instance read-only, that is, AccountType is set to InstanceReadOnly, this parameter is not supported.\n", "type": "string" }, "accountType": { "description": "Database account type. Valid values: Super: High privilege account. Normal: Normal account. InstanceReadOnly: Instance read-only account.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "notAllowPrivileges": { "description": "Permissions disabled for the account. Currently, only DDL is supported. Note: This field can only be provided for high privilege or normal accounts, that is, when AccountType is set to Super or Normal.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "accountName", "accountPassword", "accountPrivileges", "accountType", "id", "instanceId", "notAllowPrivileges" ], "type": "object" } }, "volcenginecc:rdspostgresql/getDbAccounts:getDbAccounts": { "description": "Plural Data Source schema for Volcengine::RDSPostgreSQL::DBAccount\n", "outputs": { "description": "A collection of values returned by getDbAccounts.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdspostgresql/getDbEndpoint:getDbEndpoint": { "description": "Data Source schema for Volcengine::RDSPostgreSQL::DBEndpoint\n", "inputs": { "description": "A collection of arguments for invoking getDbEndpoint.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDbEndpoint.\n", "properties": { "addresses": { "description": "Address list.\n", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getDbEndpointAddress:getDbEndpointAddress" }, "type": "array" }, "autoAddNewNodes": { "description": "When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).\n", "type": "string" }, "description": { "description": "Address description\n", "type": "string" }, "enableReadOnly": { "description": "Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.\n", "type": "string" }, "enableReadWriteSplitting": { "description": "Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.\n", "type": "string" }, "endpointId": { "description": "Instance connection endpoint ID.\n", "type": "string" }, "endpointName": { "description": "Instance connection endpoint name.\n", "type": "string" }, "endpointType": { "description": "Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "nodes": { "description": "List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.\n", "type": "string" }, "readOnlyNodeDistributionType": { "description": "Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.\n", "type": "string" }, "readOnlyNodeMaxDelayTime": { "description": "Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.\n", "type": "integer" }, "readOnlyNodeWeights": { "description": "List of nodes configured for the connection endpoint and their corresponding read-only weights.\n", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getDbEndpointReadOnlyNodeWeight:getDbEndpointReadOnlyNodeWeight" }, "type": "array" }, "readWriteMode": { "description": "Read/write mode: ReadWrite: read/write. ReadOnly: read-only.\n", "type": "string" }, "readWriteProxyConnection": { "description": "After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.\n", "type": "integer" }, "writeNodeHaltWriting": { "description": "Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.\n", "type": "boolean" } }, "required": [ "addresses", "autoAddNewNodes", "description", "enableReadOnly", "enableReadWriteSplitting", "endpointId", "endpointName", "endpointType", "id", "instanceId", "nodes", "readOnlyNodeDistributionType", "readOnlyNodeMaxDelayTime", "readOnlyNodeWeights", "readWriteMode", "readWriteProxyConnection", "writeNodeHaltWriting" ], "type": "object" } }, "volcenginecc:rdspostgresql/getDbEndpoints:getDbEndpoints": { "description": "Plural Data Source schema for Volcengine::RDSPostgreSQL::DBEndpoint\n", "outputs": { "description": "A collection of values returned by getDbEndpoints.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdspostgresql/getInstance:getInstance": { "description": "Data Source schema for Volcengine::RDSPostgreSQL::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "allowListIds": { "description": "Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). An instance can bind up to 100 allowlists.\n", "items": { "type": "string" }, "type": "array" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rdspostgresql/getInstanceChargeDetail:getInstanceChargeDetail", "description": "Payment method\n" }, "createTime": { "description": "Instance creation time\n", "type": "string" }, "dataSyncMode": { "description": "Synchronization mode. Value: Async (asynchronous synchronization)\n", "type": "string" }, "dbEngineVersion": { "description": "Compatible version\n", "type": "string" }, "endpoints": { "description": "Instance connection information\n", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getInstanceEndpoint:getInstanceEndpoint" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "instanceName": { "description": "Instance name\n", "type": "string" }, "instanceStatus": { "description": "Instance status\n", "type": "string" }, "instanceType": { "description": "Instance type. Value: HA (high availability edition)\n", "type": "string" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:rdspostgresql/getInstanceMaintenanceWindow:getInstanceMaintenanceWindow", "description": "Instance maintenance window\n" }, "memory": { "description": "Memory size, unit: GB\n", "type": "number" }, "nodeInfos": { "description": "Instance specification configuration\n", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getInstanceNodeInfo:getInstanceNodeInfo" }, "type": "array" }, "nodeNumber": { "description": "Number of nodes\n", "type": "number" }, "nodeSpec": { "description": "Primary node specification\n", "type": "string" }, "projectName": { "description": "Project. Default value: default project\n", "type": "string" }, "storageDataUse": { "description": "Data file space used by the primary node. Unit: Byte\n", "type": "number" }, "storageLogUse": { "description": "Log file space used by the primary node. Unit: Byte\n", "type": "number" }, "storageSpace": { "description": "Instance storage space. Value range: [20, 3000], unit: GB, increment: 10GB. Default value is 100\n", "type": "number" }, "storageTempUse": { "description": "Temporary file space used by the primary node. Unit: Byte\n", "type": "number" }, "storageType": { "description": "Instance storage type, fixed value LocalSSD (local SSD disk)\n", "type": "string" }, "storageUse": { "description": "Used storage space of the instance. Unit: Byte\n", "type": "number" }, "storageWalUse": { "description": "Used WAL file space of the instance's primary node. Unit: Byte\n", "type": "number" }, "subnetId": { "description": "Subnet ID\n", "type": "string" }, "tags": { "description": "Tag information of the cloud disk\n", "items": { "$ref": "#/types/volcenginecc:rdspostgresql/getInstanceTag:getInstanceTag" }, "type": "array" }, "updateTime": { "description": "Instance update time\n", "type": "string" }, "vcpu": { "description": "CPU size. For example: 1 means 1U\n", "type": "number" }, "vpcId": { "description": "Use this parameter to specify the private network for the instance\n", "type": "string" }, "zoneId": { "description": "Availability zone ID\n", "type": "string" } }, "required": [ "allowListIds", "chargeDetail", "createTime", "dataSyncMode", "dbEngineVersion", "endpoints", "id", "instanceId", "instanceName", "instanceStatus", "instanceType", "maintenanceWindow", "memory", "nodeInfos", "nodeNumber", "nodeSpec", "projectName", "storageDataUse", "storageLogUse", "storageSpace", "storageTempUse", "storageType", "storageUse", "storageWalUse", "subnetId", "tags", "updateTime", "vcpu", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:rdspostgresql/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::RDSPostgreSQL::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rdspostgresql/getSchema:getSchema": { "description": "Data Source schema for Volcengine::RDSPostgreSQL::Schema\n", "inputs": { "description": "A collection of arguments for invoking getSchema.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSchema.\n", "properties": { "dbName": { "description": "Database name\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "owner": { "description": "Schema owner. Note that instance read-only accounts, high-privilege accounts with DDL permissions disabled, or regular accounts with DDL permissions disabled cannot be set as the Schema owner.\n", "type": "string" }, "schemaName": { "description": "Schema name. Length: 2–63 characters. Can contain letters, numbers, underscores (*), or hyphens (-). Must start with a letter and end with a letter or number. Reserved keywords are not allowed; for all disabled keywords, see Disabled Keywords. Cannot start with pg*\n", "type": "string" } }, "required": [ "dbName", "id", "instanceId", "owner", "schemaName" ], "type": "object" } }, "volcenginecc:rdspostgresql/getSchemas:getSchemas": { "description": "Plural Data Source schema for Volcengine::RDSPostgreSQL::Schema\n", "outputs": { "description": "A collection of values returned by getSchemas.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:redis/getAccount:getAccount": { "description": "Data Source schema for Volcengine::Redis::Account\n", "inputs": { "description": "A collection of arguments for invoking getAccount.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAccount.\n", "properties": { "accountName": { "description": "Account name. The name must meet the following requirements: It must start with a lowercase letter. It must end with a lowercase letter or number. The length must be 2–16 characters. It can only contain lowercase letters, numbers, and underscores (_).\n", "type": "string" }, "accountStatus": { "description": "Account status. The value range is as follows: Available: Available. Unavailable: Unavailable.\n", "type": "string" }, "description": { "description": "Account description, up to 256 characters. Note: If this parameter is empty, no account description is set.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "password": { "description": "Account password. The password must meet the following requirements: Length of 8–32 characters. Must include at least two of the following: uppercase letters, lowercase letters, numbers, or special characters. Supported special characters: ()`~!@#$%^\u0026*-+=_|{}[];\u003c\u003e,.?\n", "type": "string" }, "roleName": { "description": "Account role. The following default roles are supported: Administrator: Allows all Redis instance-supported commands on all Keys. ReadWrite: Allows all commands except admin class commands on all Keys. ReadOnly: Allows all read class commands on all Keys. NotDangerous: Allows all commands except dangerous class commands on all Keys. Note: For details on the specific commands supported by each role's ACL rules, see ACL syntax.\n", "type": "string" } }, "required": [ "accountName", "accountStatus", "description", "id", "instanceId", "password", "roleName" ], "type": "object" } }, "volcenginecc:redis/getAccounts:getAccounts": { "description": "Plural Data Source schema for Volcengine::Redis::Account\n", "outputs": { "description": "A collection of values returned by getAccounts.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:redis/getAllowList:getAllowList": { "description": "Data Source schema for Volcengine::Redis::AllowList\n", "inputs": { "description": "A collection of arguments for invoking getAllowList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAllowList.\n", "properties": { "allowList": { "description": "Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.\n", "type": "string" }, "allowListCategory": { "description": "Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations\n", "type": "string" }, "allowListDesc": { "description": "Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default\n", "type": "string" }, "allowListId": { "description": "Allowlist ID.\n", "type": "string" }, "allowListIpNum": { "description": "Number of IP addresses in the allowlist\n", "type": "integer" }, "allowListName": { "description": "Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters\n", "type": "string" }, "associatedInstanceNum": { "description": "Total number of instances bound to the allowlist\n", "type": "integer" }, "associatedInstances": { "description": "List of instances currently bound to this allowlist.\n", "items": { "$ref": "#/types/volcenginecc:redis/getAllowListAssociatedInstance:getAllowListAssociatedInstance" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceIds": { "description": "List of instance IDs bound to the current allowlist\n", "items": { "type": "string" }, "type": "array" }, "projectName": { "description": "Project name associated with the allowlist\n", "type": "string" }, "securityGroupBindInfos": { "description": "Information about the security groups associated with the allowlist. Note: This parameter is returned only if the allowlist contains associated security groups.\n", "items": { "$ref": "#/types/volcenginecc:redis/getAllowListSecurityGroupBindInfo:getAllowListSecurityGroupBindInfo" }, "type": "array" } }, "required": [ "allowList", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "associatedInstanceNum", "associatedInstances", "id", "instanceIds", "projectName", "securityGroupBindInfos" ], "type": "object" } }, "volcenginecc:redis/getAllowLists:getAllowLists": { "description": "Plural Data Source schema for Volcengine::Redis::AllowList\n", "outputs": { "description": "A collection of values returned by getAllowLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:redis/getEndpointPublicAddress:getEndpointPublicAddress": { "description": "Data Source schema for Volcengine::Redis::EndpointPublicAddress\n", "inputs": { "description": "A collection of arguments for invoking getEndpointPublicAddress.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getEndpointPublicAddress.\n", "properties": { "addrType": { "description": "Connection address type. Valid values: Private: Private network connection address. Public: Public network connection address. DirectLink: Direct connection address. Note: Direct connection address information is returned only when a sharded Redis cluster instance has applied for a direct connection address. For more information about connection address types, see Connection Address Types.\n", "type": "string" }, "address": { "description": "IP address or domain name\n", "type": "string" }, "eipId": { "description": "ID of the Elastic Public IP\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "newAddressPrefix": { "description": "Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.\n", "type": "string" }, "port": { "description": "Port number\n", "type": "integer" }, "upgradeRegionDomain": { "description": "Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.\n", "type": "boolean" }, "viPv6": { "description": "IPv6 address corresponding to the connection address. Note: This parameter is returned only if the instance uses an IPv6 address. Only private network addresses and direct connection addresses support IPv6; public network addresses do not. Therefore, when the connection address type is Public (i.e., AddrType is Public), this parameter is always empty.\n", "type": "string" }, "vip": { "description": "IPv4 address corresponding to the connection address\n", "type": "string" } }, "required": [ "addrType", "address", "eipId", "id", "instanceId", "newAddressPrefix", "port", "upgradeRegionDomain", "viPv6", "vip" ], "type": "object" } }, "volcenginecc:redis/getEndpointPublicAddresses:getEndpointPublicAddresses": { "description": "Plural Data Source schema for Volcengine::Redis::EndpointPublicAddress\n", "outputs": { "description": "A collection of values returned by getEndpointPublicAddresses.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:redis/getInstance:getInstance": { "description": "Data Source schema for Volcengine::Redis::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "allowListIds": { "description": "Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.\n", "items": { "type": "string" }, "type": "array" }, "autoRenew": { "description": "Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.\n", "type": "boolean" }, "backupPointName": { "description": "Set a backup name for the full backup created before changes.\n", "type": "string" }, "blueGreenRole": { "description": "Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.\n", "type": "string" }, "capacity": { "$ref": "#/types/volcenginecc:redis/getInstanceCapacity:getInstanceCapacity", "description": "Capacity information of the instance.\n" }, "chargeType": { "description": "Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).\n", "type": "string" }, "configureNodes": { "description": "Set the list of availability zones to which the node belongs.\n", "items": { "$ref": "#/types/volcenginecc:redis/getInstanceConfigureNode:getInstanceConfigureNode" }, "type": "array" }, "createBackup": { "description": "Whether to create a backup before making changes.\n", "type": "boolean" }, "createTime": { "description": "Creation time of the instance.\n", "type": "string" }, "dataLayout": { "description": "Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.\n", "type": "string" }, "deletionProtection": { "description": "Enable or disable instance deletion protection.\n", "type": "string" }, "engineVersion": { "description": "Database version number.\n", "type": "string" }, "expiredTime": { "description": "Instance expiration time.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceClass": { "description": "Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "instanceName": { "description": "Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.\n", "type": "string" }, "instanceShards": { "description": "Detailed list of all shards in the instance.\n", "items": { "$ref": "#/types/volcenginecc:redis/getInstanceInstanceShard:getInstanceInstanceShard" }, "type": "array" }, "maintenanceTime": { "description": "Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).\n", "type": "string" }, "maxConnections": { "description": "Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.\n", "type": "integer" }, "multiAz": { "description": "Set the deployment scheme for the instance's availability zone.\n", "type": "string" }, "noAuthMode": { "description": "Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.\n", "type": "string" }, "nodeIds": { "description": "List of Proxy and Server node IDs.\n", "items": { "type": "string" }, "type": "array" }, "nodeNumber": { "description": "Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.\n", "type": "integer" }, "parameterGroupId": { "description": "The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.\n", "type": "string" }, "password": { "description": "Set the password for the default account of the default database.\n", "type": "string" }, "port": { "description": "Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.\n", "type": "integer" }, "privateAddress": { "description": "The domain name for the instance's private network connection address.\n", "type": "string" }, "privatePort": { "description": "Port number for the instance's private network connection address.\n", "type": "string" }, "projectName": { "description": "Project to which the instance belongs.\n", "type": "string" }, "purchaseMonths": { "description": "Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.\n", "type": "integer" }, "reserveAdditionalBandwidth": { "description": "Set whether to reserve additional bandwidth\n", "type": "boolean" }, "serviceType": { "description": "Service type of the instance\n", "type": "string" }, "shardCapacity": { "description": "Memory capacity of each shard in the instance. Unit: MiB.\n", "type": "integer" }, "shardNumber": { "description": "Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).\n", "type": "integer" }, "shardedCluster": { "description": "Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.\n", "type": "integer" }, "status": { "description": "Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.\n", "type": "string" }, "subnetId": { "description": "Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.\n", "type": "string" }, "tags": { "description": "Set the tag list for the instance.\n", "items": { "$ref": "#/types/volcenginecc:redis/getInstanceTag:getInstanceTag" }, "type": "array" }, "viPv6": { "description": "The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.\n", "type": "string" }, "vip": { "description": "IPv4 address corresponding to the instance's private network connection address.\n", "type": "string" }, "visitAddrs": { "description": "Connection address information.\n", "items": { "$ref": "#/types/volcenginecc:redis/getInstanceVisitAddr:getInstanceVisitAddr" }, "type": "array" }, "vpcAuthMode": { "description": "Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.\n", "type": "string" }, "vpcId": { "description": "Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.\n", "type": "string" }, "zoneIds": { "description": "List of available zones where the instance is located.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "allowListIds", "autoRenew", "backupPointName", "blueGreenRole", "capacity", "chargeType", "configureNodes", "createBackup", "createTime", "dataLayout", "deletionProtection", "engineVersion", "expiredTime", "id", "instanceClass", "instanceId", "instanceName", "instanceShards", "maintenanceTime", "maxConnections", "multiAz", "noAuthMode", "nodeIds", "nodeNumber", "parameterGroupId", "password", "port", "privateAddress", "privatePort", "projectName", "purchaseMonths", "reserveAdditionalBandwidth", "serviceType", "shardCapacity", "shardNumber", "shardedCluster", "status", "subnetId", "tags", "viPv6", "vip", "visitAddrs", "vpcAuthMode", "vpcId", "zoneIds" ], "type": "object" } }, "volcenginecc:redis/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::Redis::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rocketmq/getAllowList:getAllowList": { "description": "Data Source schema for Volcengine::RocketMQ::AllowList\n", "inputs": { "description": "A collection of arguments for invoking getAllowList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAllowList.\n", "properties": { "allowList": { "description": "IP allowlist. Separate multiple IP addresses with commas (,) and do not repeat addresses\n", "type": "string" }, "allowListCategory": { "description": "Allowlist Category\n", "type": "string" }, "allowListDesc": { "description": "Allowlist Description\n", "type": "string" }, "allowListId": { "description": "Allowlist ID\n", "type": "string" }, "allowListIpNum": { "description": "Total number of IP addresses (or address ranges) in the allowlist\n", "type": "integer" }, "allowListName": { "description": "Allowlist Name\n", "type": "string" }, "allowListType": { "description": "IP address type in the allowlist. Only IPv4 is supported\n", "type": "string" }, "associatedInstanceNum": { "description": "Total number of instances bound to the allowlist\n", "type": "integer" }, "associatedInstances": { "description": "Bound Instance List\n", "items": { "$ref": "#/types/volcenginecc:rocketmq/getAllowListAssociatedInstance:getAllowListAssociatedInstance" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" } }, "required": [ "allowList", "allowListCategory", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "id", "instanceId" ], "type": "object" } }, "volcenginecc:rocketmq/getAllowLists:getAllowLists": { "description": "Plural Data Source schema for Volcengine::RocketMQ::AllowList\n", "outputs": { "description": "A collection of values returned by getAllowLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rocketmq/getGroup:getGroup": { "description": "Data Source schema for Volcengine::RocketMQ::Group\n", "inputs": { "description": "A collection of arguments for invoking getGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getGroup.\n", "properties": { "consumeMessageOrderly": { "description": "Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.\n", "type": "boolean" }, "consumedClients": { "description": "Consumer client list.\n", "items": { "$ref": "#/types/volcenginecc:rocketmq/getGroupConsumedClient:getGroupConsumedClient" }, "type": "array" }, "consumedTopics": { "description": "Topic information subscribed by consumer instance groups under this Group.\n", "items": { "$ref": "#/types/volcenginecc:rocketmq/getGroupConsumedTopic:getGroupConsumedTopic" }, "type": "array" }, "createdTime": { "description": "Group creation time.\n", "type": "string" }, "description": { "description": "Brief description of the Group.\n", "type": "string" }, "groupId": { "description": "Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (*). It is recommended to start with GID - or GID*. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.\n", "type": "string" }, "groupType": { "description": "Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "isSubSame": { "description": "Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.\n", "type": "boolean" }, "lastUpdateTimestamp": { "description": "Whether consumption is sequential.\n", "type": "string" }, "messageDelayTime": { "description": "Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.\n", "type": "string" }, "messageModel": { "description": "Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.\n", "type": "string" }, "retryMaxTimes": { "description": "Maximum number of consumption retries.\n", "type": "integer" }, "rocketmqVersion": { "description": "RocketMQ version.\n", "type": "string" }, "serviceStatus": { "description": "Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.\n", "type": "string" }, "status": { "description": "Consumer group status. Online: Consuming, Offline: Not consuming.\n", "type": "string" }, "totalConsumedRate": { "description": "Total TPS of consumer instance groups under this Group, measured in messages per second.\n", "type": "string" }, "totalDiff": { "description": "Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.\n", "type": "integer" } }, "required": [ "consumeMessageOrderly", "consumedClients", "consumedTopics", "createdTime", "description", "groupId", "groupType", "id", "instanceId", "isSubSame", "lastUpdateTimestamp", "messageDelayTime", "messageModel", "retryMaxTimes", "rocketmqVersion", "serviceStatus", "status", "totalConsumedRate", "totalDiff" ], "type": "object" } }, "volcenginecc:rocketmq/getGroups:getGroups": { "description": "Plural Data Source schema for Volcengine::RocketMQ::Group\n", "outputs": { "description": "A collection of values returned by getGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rocketmq/getInstance:getInstance": { "description": "Data Source schema for Volcengine::RocketMQ::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "accountId": { "description": "Account ID to which the instance belongs.\n", "type": "string" }, "allowListIds": { "description": "List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.\n", "items": { "type": "string" }, "type": "array" }, "applyPrivateDnsToPublic": { "description": "Whether private network domain name supports public resolution. true: enabled false: disabled\n", "type": "boolean" }, "autoScaleQueue": { "description": "Whether to automatically create queues when the instance specification changes.\n", "type": "boolean" }, "availableQueueNumber": { "description": "Remaining number of partitions that can be created.\n", "type": "integer" }, "chargeDetail": { "$ref": "#/types/volcenginecc:rocketmq/getInstanceChargeDetail:getInstanceChargeDetail", "description": "Billing method and related billing information for the instance.\n" }, "computeSpec": { "description": "Instance compute specification. You can view the currently available compute specifications in the product specifications list.\n", "type": "string" }, "connectionInfos": { "description": "Instance connection information.\n", "items": { "$ref": "#/types/volcenginecc:rocketmq/getInstanceConnectionInfo:getInstanceConnectionInfo" }, "type": "array" }, "createTime": { "description": "Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.\n", "type": "string" }, "eipId": { "description": "EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.\n", "type": "string" }, "enableSsl": { "description": "Whether to use SSL encryption.\n", "type": "boolean" }, "fileReservedTime": { "description": "Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceDescription": { "description": "Brief description of the instance. Length range: 1–128 characters.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "instanceName": { "description": "Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.\n", "type": "string" }, "instanceStatus": { "description": "Instance status.\n", "type": "string" }, "ipVersionType": { "description": "IP version. Options are IPv4 or DualStack.\n", "type": "string" }, "networkTypes": { "description": "Instance network type, fixed as PrivateNetwork.\n", "type": "string" }, "productInfo": { "$ref": "#/types/volcenginecc:rocketmq/getInstanceProductInfo:getInstanceProductInfo", "description": "Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.\n" }, "projectName": { "description": "The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.\n", "type": "string" }, "regionId": { "description": "Region ID where the instance is located.\n", "type": "string" }, "sslMode": { "description": "The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.\n", "type": "string" }, "storageSpace": { "description": "Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.\n", "type": "integer" }, "subnetId": { "description": "VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.\n", "type": "string" }, "tags": { "description": "Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation. For details, see Tag Overview.\n", "items": { "$ref": "#/types/volcenginecc:rocketmq/getInstanceTag:getInstanceTag" }, "type": "array" }, "usedGroupNumber": { "description": "Number of consumer groups (Group) currently created for the instance.\n", "type": "integer" }, "usedQueueNumber": { "description": "Number of queues already used by the instance.\n", "type": "integer" }, "usedStorageSpace": { "description": "Used storage space for the instance, in GiB.\n", "type": "integer" }, "usedTopicNumber": { "description": "Number of topics created in the current instance.\n", "type": "integer" }, "version": { "description": "Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.\n", "type": "string" }, "vpcId": { "description": "VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.\n", "type": "string" }, "zoneId": { "description": "Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.\n", "type": "string" } }, "required": [ "accountId", "allowListIds", "applyPrivateDnsToPublic", "autoScaleQueue", "availableQueueNumber", "chargeDetail", "computeSpec", "connectionInfos", "createTime", "eipId", "enableSsl", "fileReservedTime", "id", "instanceDescription", "instanceId", "instanceName", "instanceStatus", "ipVersionType", "networkTypes", "productInfo", "projectName", "regionId", "sslMode", "storageSpace", "subnetId", "tags", "usedGroupNumber", "usedQueueNumber", "usedStorageSpace", "usedTopicNumber", "version", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:rocketmq/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::RocketMQ::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:rocketmq/getTopic:getTopic": { "description": "Data Source schema for Volcengine::RocketMQ::Topic\n", "inputs": { "description": "A collection of arguments for invoking getTopic.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTopic.\n", "properties": { "accessPolicies": { "description": "Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic.\n", "items": { "$ref": "#/types/volcenginecc:rocketmq/getTopicAccessPolicy:getTopicAccessPolicy" }, "type": "array" }, "createdTime": { "description": "Topic creation time.\n", "type": "string" }, "description": { "description": "Topic description, length: 0–128 characters.\n", "type": "string" }, "groupsInfos": { "description": "Consumer group information list.\n", "items": { "$ref": "#/types/volcenginecc:rocketmq/getTopicGroupsInfo:getTopicGroupsInfo" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "instanceName": { "description": "Instance name.\n", "type": "string" }, "messageType": { "description": "Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.\n", "type": "integer" }, "queueNumber": { "description": "Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.\n", "type": "integer" }, "queuesInfos": { "description": "Queue information list.\n", "items": { "$ref": "#/types/volcenginecc:rocketmq/getTopicQueuesInfo:getTopicQueuesInfo" }, "type": "array" }, "readAccessPolicies": { "description": "Permissions for each RocketMQ key on the current Topic, permission field\n", "items": { "$ref": "#/types/volcenginecc:rocketmq/getTopicReadAccessPolicy:getTopicReadAccessPolicy" }, "type": "array" }, "serviceStatus": { "description": "Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.\n", "type": "string" }, "topicName": { "description": "Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores (*) are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQ*SYS*TRANS*OP*HALF*TOPIC, BenchmarkTest, TBW102, OFFSET*MOVED*EVENT, SELF*TEST*TOPIC, RMQ*SYS*TRANS*HALF*TOPIC, SCHEDULE*TOPIC*XXXX, RMQ*SYS*TRACE*TOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmq*sys_, %DLQ%.\n", "type": "string" } }, "required": [ "accessPolicies", "createdTime", "description", "groupsInfos", "id", "instanceId", "instanceName", "messageType", "queueNumber", "queuesInfos", "readAccessPolicies", "serviceStatus", "topicName" ], "type": "object" } }, "volcenginecc:rocketmq/getTopics:getTopics": { "description": "Plural Data Source schema for Volcengine::RocketMQ::Topic\n", "outputs": { "description": "A collection of values returned by getTopics.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:storageebs/getSnapshot:getSnapshot": { "description": "Data Source schema for Volcengine::StorageEBS::Snapshot\n", "inputs": { "description": "A collection of arguments for invoking getSnapshot.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSnapshot.\n", "properties": { "creationTime": { "description": "Snapshot creation time.\n", "type": "string" }, "description": { "description": "Snapshot description. Default is empty. Length must be between 0 and 255 characters.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "imageId": { "description": "Image ID\n", "type": "string" }, "instantAccess": { "description": "Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.\n", "type": "boolean" }, "progress": { "description": "Snapshot dump progress.\n", "type": "integer" }, "projectName": { "description": "Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.\n", "type": "string" }, "retentionDays": { "description": "Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.\n", "type": "integer" }, "shared": { "description": "Whether the snapshot is shared.\n", "type": "boolean" }, "snapshotGroupId": { "description": "Snapshot consistency group ID.\n", "type": "string" }, "snapshotId": { "description": "Snapshot ID.\n", "type": "string" }, "snapshotName": { "description": "Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.\n", "type": "string" }, "snapshotType": { "description": "Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.\n", "type": "string" }, "status": { "description": "Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.\n", "type": "string" }, "tags": { "description": "Snapshot tag information.\n", "items": { "$ref": "#/types/volcenginecc:storageebs/getSnapshotTag:getSnapshotTag" }, "type": "array" }, "volumeId": { "description": "Cloud disk ID associated with the snapshot.\n", "type": "string" }, "volumeKind": { "description": "Cloud disk category. Value options: system: system disk. data: data disk.\n", "type": "string" }, "volumeName": { "description": "Cloud disk name.\n", "type": "string" }, "volumeSize": { "description": "Cloud disk size, in GiB.\n", "type": "integer" }, "volumeStatus": { "description": "Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, \"\": cloud disk deleted.\n", "type": "string" }, "volumeType": { "description": "Cloud disk type. Value options: ESSD*PL0: Ultra-fast SSD cloud disk, PL0 specification. ESSD*FlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk\n", "type": "string" }, "zoneId": { "description": "Availability zone ID where the snapshot is located.\n", "type": "string" } }, "required": [ "creationTime", "description", "id", "imageId", "instantAccess", "progress", "projectName", "retentionDays", "shared", "snapshotGroupId", "snapshotId", "snapshotName", "snapshotType", "status", "tags", "volumeId", "volumeKind", "volumeName", "volumeSize", "volumeStatus", "volumeType", "zoneId" ], "type": "object" } }, "volcenginecc:storageebs/getSnapshotGroup:getSnapshotGroup": { "description": "Data Source schema for Volcengine::StorageEBS::SnapshotGroup\n", "inputs": { "description": "A collection of arguments for invoking getSnapshotGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSnapshotGroup.\n", "properties": { "creationTime": { "description": "Snapshot consistency group creation time\n", "type": "string" }, "description": { "description": "Snapshot consistency group description\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "imageId": { "description": "Image ID of the snapshot consistency group\n", "type": "string" }, "instanceId": { "description": "ECS instance ID of the snapshot consistency group\n", "type": "string" }, "name": { "description": "Snapshot consistency group name\n", "type": "string" }, "projectName": { "description": "Project name\n", "type": "string" }, "snapshotGroupId": { "description": "Snapshot consistency group ID\n", "type": "string" }, "snapshots": { "description": "Snapshot details\n", "items": { "$ref": "#/types/volcenginecc:storageebs/getSnapshotGroupSnapshot:getSnapshotGroupSnapshot" }, "type": "array" }, "status": { "description": "Snapshot consistency group status\n", "type": "string" }, "tags": { "description": "Tags of the snapshot consistency group\n", "items": { "$ref": "#/types/volcenginecc:storageebs/getSnapshotGroupTag:getSnapshotGroupTag" }, "type": "array" }, "volumeIds": { "description": "Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "creationTime", "description", "id", "imageId", "instanceId", "name", "projectName", "snapshotGroupId", "snapshots", "status", "tags", "volumeIds" ], "type": "object" } }, "volcenginecc:storageebs/getSnapshotGroups:getSnapshotGroups": { "description": "Plural Data Source schema for Volcengine::StorageEBS::SnapshotGroup\n", "outputs": { "description": "A collection of values returned by getSnapshotGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:storageebs/getSnapshots:getSnapshots": { "description": "Plural Data Source schema for Volcengine::StorageEBS::Snapshot\n", "outputs": { "description": "A collection of values returned by getSnapshots.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:storageebs/getVolume:getVolume": { "description": "Data Source schema for Volcengine::StorageEBS::Volume\n", "inputs": { "description": "A collection of arguments for invoking getVolume.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getVolume.\n", "properties": { "autoSnapshotPolicyId": { "description": "Automatic snapshot policy ID.\n", "type": "string" }, "autoSnapshotPolicyName": { "description": "Automatic snapshot policy name.\n", "type": "string" }, "baselinePerformance": { "$ref": "#/types/volcenginecc:storageebs/getVolumeBaselinePerformance:getVolumeBaselinePerformance", "description": "Baseline performance.\n" }, "createdAt": { "description": "Disk creation time.\n", "type": "string" }, "deleteWithInstance": { "description": "When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.\n", "type": "boolean" }, "description": { "description": "Disk description. Default is empty. Length must be between 1 and 255 characters.\n", "type": "string" }, "deviceName": { "description": "Device name\n", "type": "string" }, "errorDetail": { "description": "Specific error\n", "type": "string" }, "expiredTime": { "description": "Expiration time for yearly/monthly subscription.\n", "type": "string" }, "extraPerformance": { "$ref": "#/types/volcenginecc:storageebs/getVolumeExtraPerformance:getVolumeExtraPerformance", "description": "Extra performance.\n" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "imageId": { "description": "Image ID in the disk.\n", "type": "string" }, "instanceId": { "description": "ECS instance ID mounted when creating the cloud disk.\n", "type": "string" }, "kind": { "description": "Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.\n", "type": "string" }, "overdueReclaimTime": { "description": "Disk overdue reclamation time.\n", "type": "string" }, "overdueTime": { "description": "Disk overdue shutdown time.\n", "type": "string" }, "payType": { "description": "Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).\n", "type": "string" }, "projectName": { "description": "Project name to which the disk will be added.\n", "type": "string" }, "renewType": { "description": "Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.\n", "type": "number" }, "size": { "description": "Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSD*PL0: 10~65536 GiB; ESSD*FlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB\n", "type": "number" }, "snapshotCount": { "description": "Snapshot count.\n", "type": "number" }, "sourceSnapshotId": { "description": "Source snapshot.\n", "type": "string" }, "status": { "description": "Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.\n", "type": "string" }, "tags": { "description": "Disk tag information.\n", "items": { "$ref": "#/types/volcenginecc:storageebs/getVolumeTag:getVolumeTag" }, "type": "array" }, "totalPerformance": { "$ref": "#/types/volcenginecc:storageebs/getVolumeTotalPerformance:getVolumeTotalPerformance", "description": "Total performance.\n" }, "tradeStatus": { "description": "Transaction status 0: Creating 1: Running 2: Creation failed\n", "type": "number" }, "updatedAt": { "description": "Disk update time.\n", "type": "string" }, "volumeId": { "description": "Disk ID.\n", "type": "string" }, "volumeName": { "description": "Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (*). Can contain Chinese characters, letters, numbers, underscores (*), or hyphens (-). Length must be between 1 and 128 characters.\n", "type": "string" }, "volumeType": { "description": "Disk type. Value description: ESSD*PL0: Ultra-fast SSD disk, PL0 specification. ESSD*FlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.\n", "type": "string" }, "zoneId": { "description": "Availability zone ID.\n", "type": "string" } }, "required": [ "autoSnapshotPolicyId", "autoSnapshotPolicyName", "baselinePerformance", "createdAt", "deleteWithInstance", "description", "deviceName", "errorDetail", "expiredTime", "extraPerformance", "id", "imageId", "instanceId", "kind", "overdueReclaimTime", "overdueTime", "payType", "projectName", "renewType", "size", "snapshotCount", "sourceSnapshotId", "status", "tags", "totalPerformance", "tradeStatus", "updatedAt", "volumeId", "volumeName", "volumeType", "zoneId" ], "type": "object" } }, "volcenginecc:storageebs/getVolumes:getVolumes": { "description": "Plural Data Source schema for Volcengine::StorageEBS::Volume\n", "outputs": { "description": "A collection of values returned by getVolumes.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tls/getAlarmNotifyGroup:getAlarmNotifyGroup": { "description": "Data Source schema for Volcengine::TLS::AlarmNotifyGroup\n", "inputs": { "description": "A collection of arguments for invoking getAlarmNotifyGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAlarmNotifyGroup.\n", "properties": { "alarmNotifyGroupId": { "description": "Alarm notification group ID.\n", "type": "string" }, "alarmNotifyGroupName": { "description": "Alarm notification group name. Refer to the resource naming rules.\n", "type": "string" }, "createdTime": { "description": "Time when the alarm notification group was created.\n", "type": "string" }, "iamProjectName": { "description": "Name of the IAM project to which the alarm group belongs. If not specified, the logging service adds the alarm group to the IAM project named default.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "noticeRules": { "description": "Alarm notification group configuration. Note: If the NoticeRules parameter is configured, leave the NotifyType and Receivers parameters empty. If NoticeRules is empty, you must configure the NotifyType and Receivers parameters. When modifying, do not change NoticeRules, NotifyType, and Receivers at the same time, as some fields may not take effect.\n", "items": { "$ref": "#/types/volcenginecc:tls/getAlarmNotifyGroupNoticeRule:getAlarmNotifyGroupNoticeRule" }, "type": "array" }, "notifyTypes": { "description": "Type of alarm notification. Trigger: alarm triggered. Recovery: alarm recovered.\n", "items": { "type": "string" }, "type": "array" }, "receivers": { "description": "IAM user list to receive alarms. You can set 1–10 IAM users.\n", "items": { "$ref": "#/types/volcenginecc:tls/getAlarmNotifyGroupReceiver:getAlarmNotifyGroupReceiver" }, "type": "array" }, "updatedTime": { "description": "Time when the alarm notification group was modified.\n", "type": "string" } }, "required": [ "alarmNotifyGroupId", "alarmNotifyGroupName", "createdTime", "iamProjectName", "id", "noticeRules", "notifyTypes", "receivers", "updatedTime" ], "type": "object" } }, "volcenginecc:tls/getAlarmNotifyGroups:getAlarmNotifyGroups": { "description": "Plural Data Source schema for Volcengine::TLS::AlarmNotifyGroup\n", "outputs": { "description": "A collection of values returned by getAlarmNotifyGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tls/getConsumerGroup:getConsumerGroup": { "description": "Data Source schema for Volcengine::TLS::ConsumerGroup\n", "inputs": { "description": "A collection of arguments for invoking getConsumerGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getConsumerGroup.\n", "properties": { "consumerGroupName": { "description": "Consumer group name.\n", "type": "string" }, "heartbeatTtl": { "description": "Heartbeat timeout in seconds. Value range: 1~300.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "orderedConsume": { "description": "Whether to consume in order. true: Consume in order within the Shard. After a Shard splits, finish consuming data from the original Shard first, then consume data from the new Shards created by the split in parallel. After a Shard merges, finish consuming data from the original Shard first, then consume data from the new Shard created by the merge. false: Do not consume in order. All Shards are consumed simultaneously, and any new Shards created by splitting or merging are also consumed immediately.\n", "type": "boolean" }, "projectId": { "description": "ID of the log project to which the consumer group belongs.\n", "type": "string" }, "projectName": { "description": "Name of the log project to which the consumer group belongs.\n", "type": "string" }, "topicIdLists": { "description": "List of log topic IDs to be consumed by the consumer group.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "consumerGroupName", "heartbeatTtl", "id", "orderedConsume", "projectId", "projectName", "topicIdLists" ], "type": "object" } }, "volcenginecc:tls/getConsumerGroups:getConsumerGroups": { "description": "Plural Data Source schema for Volcengine::TLS::ConsumerGroup\n", "outputs": { "description": "A collection of values returned by getConsumerGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tls/getImportTask:getImportTask": { "description": "Data Source schema for Volcengine::TLS::ImportTask\n", "inputs": { "description": "A collection of arguments for invoking getImportTask.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getImportTask.\n", "properties": { "createTime": { "description": "Creation time.\n", "type": "string" }, "description": { "description": "Task description.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "importSourceInfo": { "$ref": "#/types/volcenginecc:tls/getImportTaskImportSourceInfo:getImportTaskImportSourceInfo", "description": "Import data source information\n" }, "projectId": { "description": "Log project ID for storing data.\n", "type": "string" }, "projectName": { "description": "Log project name.\n", "type": "string" }, "sourceType": { "description": "Data source type. Options: tos, kafka.\n", "type": "string" }, "status": { "description": "Status of the data import task. 0: Importing. 1: Import completed. 2: Import error. 3: Stopping. 4: Stopped. 5: Restarting\n", "type": "integer" }, "targetInfo": { "$ref": "#/types/volcenginecc:tls/getImportTaskTargetInfo:getImportTaskTargetInfo", "description": "Output information for the data import task.\n" }, "taskId": { "description": "Import task ID.\n", "type": "string" }, "taskName": { "description": "Import task name\n", "type": "string" }, "taskStatistics": { "$ref": "#/types/volcenginecc:tls/getImportTaskTaskStatistics:getImportTaskTaskStatistics", "description": "Progress of the data import task.\n" }, "topicId": { "description": "Log topic ID used to store data\n", "type": "string" }, "topicName": { "description": "Log topic name.\n", "type": "string" } }, "required": [ "createTime", "description", "id", "importSourceInfo", "projectId", "projectName", "sourceType", "status", "targetInfo", "taskId", "taskName", "taskStatistics", "topicId", "topicName" ], "type": "object" } }, "volcenginecc:tls/getImportTasks:getImportTasks": { "description": "Plural Data Source schema for Volcengine::TLS::ImportTask\n", "outputs": { "description": "A collection of values returned by getImportTasks.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tls/getIndex:getIndex": { "description": "Data Source schema for Volcengine::TLS::Index\n", "inputs": { "description": "A collection of arguments for invoking getIndex.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getIndex.\n", "properties": { "createTime": { "description": "Index creation time.\n", "type": "string" }, "enableAutoIndex": { "description": "Enable automatic index updates? When enabled, the system will automatically add newly detected fields to the key-value index. true: Enable automatic updates. false: Do not enable automatic updates.\n", "type": "boolean" }, "fullText": { "$ref": "#/types/volcenginecc:tls/getIndexFullText:getIndexFullText", "description": "Full-text index configuration. If this field is null or not configured, full-text indexing is disabled. At least one of full-text index or key-value index must be configured; that is, at least one parameter between FullText and KeyValue must be specified.\n" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "keyValues": { "description": "Key-value index configuration. If the length of this field array is 0 or not configured, key-value indexing is disabled. At least one of full-text index configuration or key-value index configuration must be set; that is, you must specify at least one parameter between FullText and KeyValue.\n", "items": { "$ref": "#/types/volcenginecc:tls/getIndexKeyValue:getIndexKeyValue" }, "type": "array" }, "maxTextLen": { "description": "Set the maximum length for field values. The default is 2048. The valid range is 64–16384 bytes. If a single field value exceeds the specified maximum length, the excess part will be truncated and excluded from analysis. After updating the maximum field length, only incremental data is affected.\n", "type": "integer" }, "modifyTime": { "description": "Last modified time of the index.\n", "type": "string" }, "topicId": { "description": "Log topic ID.\n", "type": "string" }, "userInnerKeyValues": { "description": "Reserved field index configuration. If the array length of this field is 0 or not configured, reserved field indexing is disabled. You cannot enable both full-text indexing and key-value indexing for the reserved field **content** at the same time. If you set the **content** index via the UserInnerKeyValue parameter, you cannot also set the FullText parameter. Among reserved fields, only manual indexing for **content** is currently supported. For other reserved field index settings, refer to reserved fields.\n", "items": { "$ref": "#/types/volcenginecc:tls/getIndexUserInnerKeyValue:getIndexUserInnerKeyValue" }, "type": "array" } }, "required": [ "createTime", "enableAutoIndex", "fullText", "id", "keyValues", "maxTextLen", "modifyTime", "topicId", "userInnerKeyValues" ], "type": "object" } }, "volcenginecc:tls/getIndices:getIndices": { "description": "Plural Data Source schema for Volcengine::TLS::Index\n", "outputs": { "description": "A collection of values returned by getIndices.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tls/getProject:getProject": { "description": "Data Source schema for Volcengine::TLS::Project\n", "inputs": { "description": "A collection of arguments for invoking getProject.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getProject.\n", "properties": { "createdTime": { "description": "Log project creation time\n", "type": "string" }, "description": { "description": "Brief description of the log project\n", "type": "string" }, "iamProjectName": { "description": "The IAM project associated with the log project\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "innerNetDomain": { "description": "Private network connection domain name\n", "type": "string" }, "projectId": { "description": "Log project ID\n", "type": "string" }, "projectName": { "description": "Log project name\n", "type": "string" }, "tags": { "description": "Tag information\n", "items": { "$ref": "#/types/volcenginecc:tls/getProjectTag:getProjectTag" }, "type": "array" }, "topicCount": { "description": "Number of log topics in the current log project\n", "type": "integer" } }, "required": [ "createdTime", "description", "iamProjectName", "id", "innerNetDomain", "projectId", "projectName", "tags", "topicCount" ], "type": "object" } }, "volcenginecc:tls/getProjects:getProjects": { "description": "Plural Data Source schema for Volcengine::TLS::Project\n", "outputs": { "description": "A collection of values returned by getProjects.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tls/getRule:getRule": { "description": "Data Source schema for Volcengine::TLS::Rule\n", "inputs": { "description": "A collection of arguments for invoking getRule.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRule.\n", "properties": { "containerRule": { "$ref": "#/types/volcenginecc:tls/getRuleContainerRule:getRuleContainerRule", "description": "Container log collection rules.\n" }, "createTime": { "description": "Time when the collection configuration was created.\n", "type": "string" }, "excludePaths": { "description": "Denylist entries for collection. You can create up to 10 denylist entries. When InputType=0 or InputType=2: If Type is Path, Value represents a directory. Supports exact match and wildcard pattern matching. Wildcards supported: *, ?. The ** wildcard is not supported. If Type is File, Value represents a file name. Supports exact match and wildcard pattern matching. Wildcards supported: **, *, ?. Only one ** wildcard can be configured at most. When InputType=1: Configuring a denylist is not allowed.\n", "items": { "$ref": "#/types/volcenginecc:tls/getRuleExcludePath:getRuleExcludePath" }, "type": "array" }, "extractRule": { "$ref": "#/types/volcenginecc:tls/getRuleExtractRule:getRuleExtractRule", "description": "Log extraction rules. Note: This parameter is required if LogType is set to any type other than minimalist*log or json*log.\n" }, "hostGroupInfos": { "description": "Machine group information list.\n", "items": { "$ref": "#/types/volcenginecc:tls/getRuleHostGroupInfo:getRuleHostGroupInfo" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "inputType": { "description": "Collection type. 0: (Default) Host log file. 1: K8s container stdout. 2: K8s container internal log file.\n", "type": "integer" }, "logSample": { "description": "Log sample. Maximum length is 3000 characters. Log sample content must match the collection mode. Single-line full-text mode and JSON mode do not require a log sample. Other modes require a log sample, and the content must match the collection mode.\n", "type": "string" }, "logType": { "description": "Collection mode. minimalist*log: (Default) Single-line full-text mode. json*log: JSON mode. delimiter*log: Delimiter mode. multiline*log: Multi-line full-text mode. fullregex_log: Full regex mode.\n", "type": "string" }, "modifyTime": { "description": "Collection configuration modification time.\n", "type": "string" }, "paths": { "description": "Collection path list. You can create up to 10 collection paths. Collection paths must be specified as absolute paths; relative paths are not supported. When InputType=0 or InputType=2, collection paths support exact match and wildcard mode. Wildcards only support **, *, and ?, but you can configure at most one ** wildcard. When InputType=1, you do not need to configure the collection path list.\n", "items": { "type": "string" }, "type": "array" }, "pause": { "description": "Collection configuration status. 0: Running. 1: Paused.\n", "type": "integer" }, "projectId": { "description": "ID of the project to which the collection configuration belongs.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the collection configuration belongs\n", "type": "string" }, "ruleId": { "description": "Collection configuration ID.\n", "type": "string" }, "ruleName": { "description": "Collection configuration name. Please refer to the resource naming rules. Must be unique within a log topic.\n", "type": "string" }, "topicId": { "description": "Log topic ID to which the collection configuration belongs.\n", "type": "string" }, "topicName": { "description": "Name of the log topic to which the collection configuration belongs.\n", "type": "string" }, "userDefineRule": { "$ref": "#/types/volcenginecc:tls/getRuleUserDefineRule:getRuleUserDefineRule", "description": "User-defined collection rules.\n" } }, "required": [ "containerRule", "createTime", "excludePaths", "extractRule", "hostGroupInfos", "id", "inputType", "logSample", "logType", "modifyTime", "paths", "pause", "projectId", "projectName", "ruleId", "ruleName", "topicId", "topicName", "userDefineRule" ], "type": "object" } }, "volcenginecc:tls/getRules:getRules": { "description": "Plural Data Source schema for Volcengine::TLS::Rule\n", "outputs": { "description": "A collection of values returned by getRules.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tls/getScheduleSqlTask:getScheduleSqlTask": { "description": "Data Source schema for Volcengine::TLS::ScheduleSqlTask\n", "inputs": { "description": "A collection of arguments for invoking getScheduleSqlTask.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getScheduleSqlTask.\n", "properties": { "createdTime": { "description": "Creation time (seconds-level Unix timestamp).\n", "type": "integer" }, "description": { "description": "Brief description of the scheduled SQL analysis task. Characters \u003c\u003e, ', \\, and \\ are not supported. Length: 0–64 characters.\n", "type": "string" }, "destProjectId": { "description": "Target log project ID.\n", "type": "string" }, "destRegion": { "description": "Region of the target log topic. The default is the current region.\n", "type": "string" }, "destTopicId": { "description": "Target log topic ID for storing scheduled SQL analysis result data.\n", "type": "string" }, "destTopicName": { "description": "Target log topic name.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "processEndTime": { "description": "End time for scheduling the scheduled SQL analysis task, in seconds-level timestamp format. If not configured, the scheduled SQL analysis task runs continuously. After the end time is reached, the log service will no longer create instances or execute scheduled SQL analysis, but the task status remains running until manually paused.\n", "type": "integer" }, "processSqlDelay": { "description": "Delay time for each schedule. Range: 0–120 seconds. If not configured, defaults to 0, meaning no delay.\n", "type": "integer" }, "processStartTime": { "description": "Start time for scheduling the scheduled SQL analysis task, which is the time the first instance is created. Format: seconds-level timestamp.\n", "type": "integer" }, "processTimeWindow": { "description": "SQL time window, which is the time range for log retrieval and analysis when scheduled SQL analysis tasks run, in left-closed, right-open format. Maximum is 24 hours, minimum is 1 minute.\n", "type": "string" }, "query": { "description": "The scheduled SQL analysis task periodically executes retrieval and analysis statements, which must comply with the log service's retrieval and analysis syntax.\n", "type": "string" }, "requestCycle": { "$ref": "#/types/volcenginecc:tls/getScheduleSqlTaskRequestCycle:getScheduleSqlTaskRequestCycle", "description": "Scheduling period for the scheduled SQL analysis task. The scheduling period determines the scheduling time for each instance. It is recommended that the scheduling period is not less than the SQL time window.\n" }, "sourceProjectId": { "description": "Source log project ID.\n", "type": "string" }, "sourceProjectName": { "description": "Source log project name.\n", "type": "string" }, "sourceTopicId": { "description": "ID of the log topic containing the original logs for scheduled SQL analysis. Only log topics in the current region are supported.\n", "type": "string" }, "sourceTopicName": { "description": "Source log topic name.\n", "type": "string" }, "status": { "description": "Whether to start the scheduled SQL analysis task immediately after completing task configuration. Options: 0 Off; 1 Start immediately.\n", "type": "integer" }, "taskId": { "description": "Task ID.\n", "type": "string" }, "taskName": { "description": "Name of the scheduled SQL analysis task. Refer to the resource naming rules for naming conventions.\n", "type": "string" }, "taskType": { "description": "Task type: 0 means log to log; 1 means log to metric.\n", "type": "integer" }, "updatedTime": { "description": "Modification time (seconds-level Unix timestamp).\n", "type": "integer" } }, "required": [ "createdTime", "description", "destProjectId", "destRegion", "destTopicId", "destTopicName", "id", "processEndTime", "processSqlDelay", "processStartTime", "processTimeWindow", "query", "requestCycle", "sourceProjectId", "sourceProjectName", "sourceTopicId", "sourceTopicName", "status", "taskId", "taskName", "taskType", "updatedTime" ], "type": "object" } }, "volcenginecc:tls/getScheduleSqlTasks:getScheduleSqlTasks": { "description": "Plural Data Source schema for Volcengine::TLS::ScheduleSqlTask\n", "outputs": { "description": "A collection of values returned by getScheduleSqlTasks.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tls/getShipper:getShipper": { "description": "Data Source schema for Volcengine::TLS::Shipper\n", "inputs": { "description": "A collection of arguments for invoking getShipper.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getShipper.\n", "properties": { "contentInfo": { "$ref": "#/types/volcenginecc:tls/getShipperContentInfo:getShipperContentInfo", "description": "Log content delivery format configuration.\n" }, "createdTime": { "description": "Creation time.\n", "type": "string" }, "dashboardId": { "description": "Default built-in dashboard ID for delivery.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "kafkaShipperInfo": { "$ref": "#/types/volcenginecc:tls/getShipperKafkaShipperInfo:getShipperKafkaShipperInfo", "description": "Kafka delivery configuration.\n" }, "projectId": { "description": "Log project ID.\n", "type": "string" }, "projectName": { "description": "Log project name.\n", "type": "string" }, "shipperEndTime": { "description": "Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n", "type": "integer" }, "shipperId": { "description": "Delivery configuration ID.\n", "type": "string" }, "shipperName": { "description": "Delivery configuration name, unique within a log project.\n", "type": "string" }, "shipperStartTime": { "description": "Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.\n", "type": "integer" }, "shipperType": { "description": "Type of data source for delivery. Options: tos, kafka. Default is tos.\n", "type": "string" }, "status": { "description": "Whether to enable delivery configuration. Default is true.\n", "type": "boolean" }, "topicId": { "description": "Log topic ID.\n", "type": "string" }, "topicName": { "description": "Log topic name.\n", "type": "string" }, "tosShipperInfo": { "$ref": "#/types/volcenginecc:tls/getShipperTosShipperInfo:getShipperTosShipperInfo", "description": "Information related to delivery to TOS object storage.\n" }, "updatedTime": { "description": "Update time.\n", "type": "string" } }, "required": [ "contentInfo", "createdTime", "dashboardId", "id", "kafkaShipperInfo", "projectId", "projectName", "shipperEndTime", "shipperId", "shipperName", "shipperStartTime", "shipperType", "status", "topicId", "topicName", "tosShipperInfo", "updatedTime" ], "type": "object" } }, "volcenginecc:tls/getShippers:getShippers": { "description": "Plural Data Source schema for Volcengine::TLS::Shipper\n", "outputs": { "description": "A collection of values returned by getShippers.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tls/getTopic:getTopic": { "description": "Data Source schema for Volcengine::TLS::Topic\n", "inputs": { "description": "A collection of arguments for invoking getTopic.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTopic.\n", "properties": { "allowConsume": { "description": "Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.\n", "type": "boolean" }, "archiveTtl": { "description": "Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.\n", "type": "integer" }, "autoSplit": { "description": "Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.\n", "type": "boolean" }, "coldTtl": { "description": "Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.\n", "type": "integer" }, "consumeTopic": { "description": "Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.\n", "type": "string" }, "createdTime": { "description": "Log topic creation time.\n", "type": "string" }, "description": { "description": "Log topic description. Does not support \u003c\u003e, ', \\, \\, or any emoji symbols. Length: 0–64 characters.\n", "type": "string" }, "enableHotTtl": { "description": "Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.\n", "type": "boolean" }, "enableTracking": { "description": "Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.\n", "type": "boolean" }, "hotTtl": { "description": "Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "logPublicIp": { "description": "Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: **tag****client_ip**: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. **tag****receive_time**: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.\n", "type": "boolean" }, "maxSplitShard": { "description": "Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.\n", "type": "integer" }, "projectId": { "description": "Log project ID to which the log topic belongs.\n", "type": "string" }, "shardCount": { "description": "Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.\n", "type": "integer" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:tls/getTopicTag:getTopicTag" }, "type": "array" }, "timeFormat": { "description": "Time format\n", "type": "string" }, "timeKey": { "description": "Time field name\n", "type": "string" }, "topicId": { "description": "Log topic ID.\n", "type": "string" }, "topicName": { "description": "Log topic name.\n", "type": "string" }, "ttl": { "description": "Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.\n", "type": "integer" }, "updatedTime": { "description": "Log topic modification time.\n", "type": "string" } }, "required": [ "allowConsume", "archiveTtl", "autoSplit", "coldTtl", "consumeTopic", "createdTime", "description", "enableHotTtl", "enableTracking", "hotTtl", "id", "logPublicIp", "maxSplitShard", "projectId", "shardCount", "tags", "timeFormat", "timeKey", "topicId", "topicName", "ttl", "updatedTime" ], "type": "object" } }, "volcenginecc:tls/getTopics:getTopics": { "description": "Plural Data Source schema for Volcengine::TLS::Topic\n", "outputs": { "description": "A collection of values returned by getTopics.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tos/getBucket:getBucket": { "description": "Data Source schema for Volcengine::TOS::Bucket\n", "inputs": { "description": "A collection of arguments for invoking getBucket.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBucket.\n", "properties": { "acl": { "$ref": "#/types/volcenginecc:tos/getBucketAcl:getBucketAcl", "description": "Bucket access control permissions\n" }, "aclGrant": { "$ref": "#/types/volcenginecc:tos/getBucketAclGrant:getBucketAclGrant" }, "azRedundancy": { "description": "Bucket availability zone redundancy type. Includes single-az: single availability zone redundancy, multi-az: multi availability zone redundancy\n", "type": "string" }, "bucketType": { "description": "Bucket type. Includes hns: hierarchical bucket type, fns: flat bucket type\n", "type": "string" }, "creationDate": { "description": "Bucket creation time\n", "type": "string" }, "enableVersionStatus": { "description": "Bucket versioning status. Enabled: Enable versioning. Suspended: Suspend versioning\n", "type": "string" }, "extranetEndpoint": { "description": "TOS protocol public access domain name for the bucket\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "intranetEndpoint": { "description": "Private network access domain name for the bucket's TOS protocol\n", "type": "string" }, "lifecycleConfigs": { "description": "Bucket lifecycle\n", "items": { "$ref": "#/types/volcenginecc:tos/getBucketLifecycleConfig:getBucketLifecycleConfig" }, "type": "array" }, "location": { "description": "Bucket region\n", "type": "string" }, "name": { "description": "Bucket name\n", "type": "string" }, "policy": { "description": "String in JSON format containing bucket policy information. The total size of all bucket policy JSONs for a single bucket must not exceed 20KB\n", "type": "string" }, "projectName": { "description": "Project associated with the bucket\n", "type": "string" }, "storageClass": { "description": "Default storage class for the bucket. Includes STANDARD: Standard storage. IA: Infrequent access storage. INTELLIGENT*TIERING: Intelligent tiering storage. ARCHIVE*FR: Archive flashback storage. ARCHIVE: Archive storage. COLD*ARCHIVE: Cold archive storage. DEEP*COLD_ARCHIVE: Deep cold archive storage\n", "type": "string" }, "tags": { "description": "Bucket tag information\n", "items": { "$ref": "#/types/volcenginecc:tos/getBucketTag:getBucketTag" }, "type": "array" } }, "required": [ "acl", "aclGrant", "azRedundancy", "bucketType", "creationDate", "enableVersionStatus", "extranetEndpoint", "id", "intranetEndpoint", "lifecycleConfigs", "location", "name", "policy", "projectName", "storageClass", "tags" ], "type": "object" } }, "volcenginecc:tos/getBucketEncryption:getBucketEncryption": { "description": "Data Source schema for Volcengine::TOS::BucketEncryption\n", "inputs": { "description": "A collection of arguments for invoking getBucketEncryption.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBucketEncryption.\n", "properties": { "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "kmsMasterKeyId": { "description": "The master key used for SSE-KMS encryption\n", "type": "string" }, "name": { "description": "Bucket name\n", "type": "string" }, "sseAlgorithm": { "description": "Default server-side encryption method. The values are explained as follows: kms: uses SSE-KMS encryption. AES256: uses SSE-TOS encryption with the AES256 algorithm. SM4: uses SSE-TOS encryption with the SM4 algorithm\n", "type": "string" } }, "required": [ "id", "kmsMasterKeyId", "name", "sseAlgorithm" ], "type": "object" } }, "volcenginecc:tos/getBucketEncryptions:getBucketEncryptions": { "description": "Plural Data Source schema for Volcengine::TOS::BucketEncryption\n", "outputs": { "description": "A collection of values returned by getBucketEncryptions.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tos/getBucketInventories:getBucketInventories": { "description": "Plural Data Source schema for Volcengine::TOS::BucketInventory\n", "outputs": { "description": "A collection of values returned by getBucketInventories.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:tos/getBucketInventory:getBucketInventory": { "description": "Data Source schema for Volcengine::TOS::BucketInventory\n", "inputs": { "description": "A collection of arguments for invoking getBucketInventory.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBucketInventory.\n", "properties": { "bucketName": { "description": "Bucket name.\n", "type": "string" }, "destination": { "$ref": "#/types/volcenginecc:tos/getBucketInventoryDestination:getBucketInventoryDestination", "description": "Information related to inventory files.\n" }, "filter": { "$ref": "#/types/volcenginecc:tos/getBucketInventoryFilter:getBucketInventoryFilter", "description": "Prefix for filtering bucket inventory.\n" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "includedObjectVersions": { "description": "Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.\n", "type": "string" }, "inventoryId": { "description": "Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.\n", "type": "string" }, "isEnabled": { "description": "Whether to enable the bucket inventory feature. Options: true: enable; false: disable.\n", "type": "boolean" }, "isUnCompressed": { "description": "Whether it is uncompressed.\n", "type": "boolean" }, "optionalFields": { "$ref": "#/types/volcenginecc:tos/getBucketInventoryOptionalFields:getBucketInventoryOptionalFields", "description": "Information about exported inventory files.\n" }, "schedule": { "$ref": "#/types/volcenginecc:tos/getBucketInventorySchedule:getBucketInventorySchedule", "description": "Bucket inventory export frequency information.\n" } }, "required": [ "bucketName", "destination", "filter", "id", "includedObjectVersions", "inventoryId", "isEnabled", "isUnCompressed", "optionalFields", "schedule" ], "type": "object" } }, "volcenginecc:tos/getBuckets:getBuckets": { "description": "Plural Data Source schema for Volcengine::TOS::Bucket\n", "outputs": { "description": "A collection of values returned by getBuckets.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:transitrouter/getPeerAttachment:getPeerAttachment": { "description": "Data Source schema for Volcengine::TransitRouter::PeerAttachment\n", "inputs": { "description": "A collection of arguments for invoking getPeerAttachment.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getPeerAttachment.\n", "properties": { "autoPublishRouteEnabled": { "description": "Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.\n", "type": "boolean" }, "bandwidth": { "description": "Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.\n", "type": "integer" }, "creationTime": { "description": "Creation time of the cross-region connection.\n", "type": "string" }, "description": { "description": "Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipv6Enabled": { "description": "Enable IPv6. true: Yes. false: No.\n", "type": "boolean" }, "peerTransitRouterId": { "description": "ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.\n", "type": "string" }, "peerTransitRouterRegionId": { "description": "Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.\n", "type": "string" }, "status": { "description": "Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.\n", "type": "string" }, "tags": { "description": "Tag list for the cross-region connection.\n", "items": { "$ref": "#/types/volcenginecc:transitrouter/getPeerAttachmentTag:getPeerAttachmentTag" }, "type": "array" }, "transitRouterAttachmentId": { "description": "ID of the cross-region connection.\n", "type": "string" }, "transitRouterAttachmentName": { "description": "Name of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.\n", "type": "string" }, "transitRouterBandwidthPackageId": { "description": "ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.\n", "type": "string" }, "transitRouterForwardPolicyTableId": { "description": "ID of the forwarding policy associated with the cross-region connection.\n", "type": "string" }, "transitRouterId": { "description": "ID of the local transit router instance.\n", "type": "string" }, "transitRouterRouteTableId": { "description": "Associated forwarding route table for the cross-region connection.\n", "type": "string" }, "transitRouterTrafficQosMarkingPolicyId": { "description": "ID of the traffic marking policy associated with the cross-region connection.\n", "type": "string" }, "transitRouterTrafficQosQueuePolicyId": { "description": "ID of the flow queue policy associated with the cross-region connection.\n", "type": "string" }, "updateTime": { "description": "Last operation time of the cross-region connection.\n", "type": "string" } }, "required": [ "autoPublishRouteEnabled", "bandwidth", "creationTime", "description", "id", "ipv6Enabled", "peerTransitRouterId", "peerTransitRouterRegionId", "status", "tags", "transitRouterAttachmentId", "transitRouterAttachmentName", "transitRouterBandwidthPackageId", "transitRouterForwardPolicyTableId", "transitRouterId", "transitRouterRouteTableId", "transitRouterTrafficQosMarkingPolicyId", "transitRouterTrafficQosQueuePolicyId", "updateTime" ], "type": "object" } }, "volcenginecc:transitrouter/getPeerAttachments:getPeerAttachments": { "description": "Plural Data Source schema for Volcengine::TransitRouter::PeerAttachment\n", "outputs": { "description": "A collection of values returned by getPeerAttachments.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:transitrouter/getTransitRouter:getTransitRouter": { "description": "Data Source schema for Volcengine::TransitRouter::TransitRouter\n", "inputs": { "description": "A collection of arguments for invoking getTransitRouter.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTransitRouter.\n", "properties": { "asn": { "description": "ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512\n", "type": "integer" }, "attachments": { "description": "Detailed information of the network instance connection\n", "items": { "$ref": "#/types/volcenginecc:transitrouter/getTransitRouterAttachment:getTransitRouterAttachment" }, "type": "array" }, "businessStatus": { "description": "Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.\n", "type": "string" }, "creationTime": { "description": "Creation time of the network instance connection.\n", "type": "string" }, "deletedTime": { "description": "Deletion time of the network instance connection.\n", "type": "string" }, "description": { "description": "Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string\n", "type": "string" }, "grantSourceType": { "description": "Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing\n", "type": "string" }, "grantStatus": { "description": "Instance sharing status. Accepted: Received. Initial: Pending acceptance.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "multicastEnabled": { "description": "Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled\n", "type": "boolean" }, "overdueTime": { "description": "Shutdown time due to overdue payment for the transit router instance\n", "type": "string" }, "projectName": { "description": "Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'\n", "type": "string" }, "status": { "description": "Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n", "type": "string" }, "tags": { "description": "Tag list\n", "items": { "$ref": "#/types/volcenginecc:transitrouter/getTransitRouterTag:getTransitRouterTag" }, "type": "array" }, "transitRouterId": { "description": "Transit router instance ID.\n", "type": "string" }, "transitRouterName": { "description": "Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.\n", "type": "string" }, "updateTime": { "description": "Last operation time of the transit router instance\n", "type": "string" } }, "required": [ "asn", "attachments", "businessStatus", "creationTime", "deletedTime", "description", "grantSourceType", "grantStatus", "id", "multicastEnabled", "overdueTime", "projectName", "status", "tags", "transitRouterId", "transitRouterName", "updateTime" ], "type": "object" } }, "volcenginecc:transitrouter/getTransitRouterRouteEntries:getTransitRouterRouteEntries": { "description": "Plural Data Source schema for Volcengine::TransitRouter::TransitRouterRouteEntry\n", "outputs": { "description": "A collection of values returned by getTransitRouterRouteEntries.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:transitrouter/getTransitRouterRouteEntry:getTransitRouterRouteEntry": { "description": "Data Source schema for Volcengine::TransitRouter::TransitRouterRouteEntry\n", "inputs": { "description": "A collection of arguments for invoking getTransitRouterRouteEntry.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTransitRouterRouteEntry.\n", "properties": { "asPaths": { "description": "AS path of the route entry\n", "items": { "type": "string" }, "type": "array" }, "createdTime": { "description": "Creation time of the route entry\n", "type": "string" }, "description": { "description": "Description of the TR route table entry. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If this parameter is not provided or no value is specified, the default is an empty string\n", "type": "string" }, "destinationCidrBlock": { "description": "Destination CIDR block of the route entry\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "status": { "description": "Status of the route entry. Available: Available. Creating: Creating. Pending: Configuring. Deleting: Deleting. Conflicted: Inactive\n", "type": "string" }, "transitRouterRouteEntryId": { "description": "ID of the TR route entry\n", "type": "string" }, "transitRouterRouteEntryName": { "description": "Name of the route entry\n", "type": "string" }, "transitRouterRouteEntryNextHopId": { "description": "Next hop ID of the route entry\n", "type": "string" }, "transitRouterRouteEntryNextHopResourceId": { "description": "Next hop network instance ID of the route entry\n", "type": "string" }, "transitRouterRouteEntryNextHopResourceType": { "description": "Type of the next hop network instance for the route entry. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router\n", "type": "string" }, "transitRouterRouteEntryNextHopType": { "description": "Next hop type of the route entry. Valid values: Attachment: Network instance. Traffic matching this route entry will be forwarded to the specified network instance. BlackHole: Black hole. Traffic matching this route entry will be dropped\n", "type": "string" }, "transitRouterRouteEntryType": { "description": "Type of the route entry. Static: Static route. Propagated: Learned route\n", "type": "string" }, "transitRouterRouteTableId": { "description": "ID of the route table associated with the transit router instance\n", "type": "string" }, "updatedTime": { "description": "Last updated time of the route entry\n", "type": "string" } }, "required": [ "asPaths", "createdTime", "description", "destinationCidrBlock", "id", "status", "transitRouterRouteEntryId", "transitRouterRouteEntryName", "transitRouterRouteEntryNextHopId", "transitRouterRouteEntryNextHopResourceId", "transitRouterRouteEntryNextHopResourceType", "transitRouterRouteEntryNextHopType", "transitRouterRouteEntryType", "transitRouterRouteTableId", "updatedTime" ], "type": "object" } }, "volcenginecc:transitrouter/getTransitRouterRouteTable:getTransitRouterRouteTable": { "description": "Data Source schema for Volcengine::TransitRouter::TransitRouterRouteTable\n", "inputs": { "description": "A collection of arguments for invoking getTransitRouterRouteTable.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTransitRouterRouteTable.\n", "properties": { "createdTime": { "description": "Creation time of the TR routing table\n", "type": "string" }, "description": { "description": "Description of the TR routing table. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "inRoutePolicyTableId": { "description": "ID of the inbound routing policy associated with the TR routing table\n", "type": "string" }, "outRoutePolicyTableId": { "description": "ID of the outbound routing policy associated with the TR routing table\n", "type": "string" }, "status": { "description": "Status of the TR routing table. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n", "type": "string" }, "tags": { "description": "Tag information for the TR routing table\n", "items": { "$ref": "#/types/volcenginecc:transitrouter/getTransitRouterRouteTableTag:getTransitRouterRouteTableTag" }, "type": "array" }, "transitRouterId": { "description": "Transit Router instance ID\n", "type": "string" }, "transitRouterRouteTableId": { "description": "TR routing table ID\n", "type": "string" }, "transitRouterRouteTableName": { "description": "Name of the TR routing table. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the TR routing table ID\n", "type": "string" }, "transitRouterRouteTableType": { "description": "Type of TR routing table. System: system routing table. Custom: custom routing table.\n", "type": "string" }, "updatedTime": { "description": "Last operation time of the TR routing table\n", "type": "string" } }, "required": [ "createdTime", "description", "id", "inRoutePolicyTableId", "outRoutePolicyTableId", "status", "tags", "transitRouterId", "transitRouterRouteTableId", "transitRouterRouteTableName", "transitRouterRouteTableType", "updatedTime" ], "type": "object" } }, "volcenginecc:transitrouter/getTransitRouterRouteTables:getTransitRouterRouteTables": { "description": "Plural Data Source schema for Volcengine::TransitRouter::TransitRouterRouteTable\n", "outputs": { "description": "A collection of values returned by getTransitRouterRouteTables.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:transitrouter/getTransitRouters:getTransitRouters": { "description": "Plural Data Source schema for Volcengine::TransitRouter::TransitRouter\n", "outputs": { "description": "A collection of values returned by getTransitRouters.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:transitrouter/getVpcAttachment:getVpcAttachment": { "description": "Data Source schema for Volcengine::TransitRouter::VpcAttachment\n", "inputs": { "description": "A collection of arguments for invoking getVpcAttachment.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getVpcAttachment.\n", "properties": { "applianceModeEnabled": { "description": "Whether to enable path consistency mode. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. When enabled, TR forwarding traffic to this VPC connection will select the same availability zone connection point for both request and return traffic. false: No.\n", "type": "boolean" }, "attachPoints": { "description": "Network instance connection list.\n", "items": { "$ref": "#/types/volcenginecc:transitrouter/getVpcAttachmentAttachPoint:getVpcAttachmentAttachPoint" }, "type": "array" }, "autoPublishRouteEnabled": { "description": "Whether to automatically synchronize TR routes to the network instance route table. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. The system will automatically synchronize route entries from the TR route table associated with this network instance connection to the network instance's route table. The system will only synchronize TR routes if this parameter is set to true and there are route entries in the associated TR route table. false (default): No.\n", "type": "boolean" }, "bandwidth": { "description": "Maximum bandwidth for the network instance connection, in Gbps.\n", "type": "integer" }, "createdTime": { "description": "Creation time.\n", "type": "string" }, "description": { "description": "Description of the network instance connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipv6Enabled": { "description": "Whether to enable IPv6. Enter the following enumerated values exactly as shown; do not use other values. true: Yes. false: No.\n", "type": "boolean" }, "status": { "description": "Network instance connection status. Creating: Creating. Deleting: Deleting. Pending: Configuring. Available: Available.\n", "type": "string" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:transitrouter/getVpcAttachmentTag:getVpcAttachmentTag" }, "type": "array" }, "transitRouterAttachmentId": { "description": "Network instance connection ID.\n", "type": "string" }, "transitRouterAttachmentName": { "description": "Name of the network instance connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the network instance connection ID.\n", "type": "string" }, "transitRouterId": { "description": "Transit router instance ID.\n", "type": "string" }, "updatedTime": { "description": "Update time.\n", "type": "string" }, "vpcId": { "description": "Private network instance ID.\n", "type": "string" } }, "required": [ "applianceModeEnabled", "attachPoints", "autoPublishRouteEnabled", "bandwidth", "createdTime", "description", "id", "ipv6Enabled", "status", "tags", "transitRouterAttachmentId", "transitRouterAttachmentName", "transitRouterId", "updatedTime", "vpcId" ], "type": "object" } }, "volcenginecc:transitrouter/getVpcAttachments:getVpcAttachments": { "description": "Plural Data Source schema for Volcengine::TransitRouter::VpcAttachment\n", "outputs": { "description": "A collection of values returned by getVpcAttachments.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:transitrouter/getVpnAttachment:getVpnAttachment": { "description": "Data Source schema for Volcengine::TransitRouter::VpnAttachment\n", "inputs": { "description": "A collection of arguments for invoking getVpnAttachment.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getVpnAttachment.\n", "properties": { "autoPublishRouteEnabled": { "description": "Whether to automatically sync TR routes to the network instance route table.\n", "type": "boolean" }, "createdTime": { "description": "Creation time.\n", "type": "string" }, "description": { "description": "Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.\n", "type": "string" }, "healthCheckRevokeRouteEnabled": { "description": "Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.\n", "type": "boolean" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipv6Enabled": { "description": "Whether to enable IPv6.\n", "type": "boolean" }, "status": { "description": "Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.\n", "type": "string" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:transitrouter/getVpnAttachmentTag:getVpnAttachmentTag" }, "type": "array" }, "transitRouterAttachmentId": { "description": "Network instance connection ID.\n", "type": "string" }, "transitRouterAttachmentName": { "description": "Network instance connection name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the network instance connection ID.\n", "type": "string" }, "transitRouterId": { "description": "Transit router instance ID.\n", "type": "string" }, "transitRouterRouteTableId": { "description": "Associated TR route table ID.\n", "type": "string" }, "updatedTime": { "description": "Update time.\n", "type": "string" }, "vpnConnectionId": { "description": "IPsec connection ID.\n", "type": "string" }, "zoneId": { "description": "ID of the availability zone to which the IPsec connection belongs.\n", "type": "string" } }, "required": [ "autoPublishRouteEnabled", "createdTime", "description", "healthCheckRevokeRouteEnabled", "id", "ipv6Enabled", "status", "tags", "transitRouterAttachmentId", "transitRouterAttachmentName", "transitRouterId", "transitRouterRouteTableId", "updatedTime", "vpnConnectionId", "zoneId" ], "type": "object" } }, "volcenginecc:transitrouter/getVpnAttachments:getVpnAttachments": { "description": "Plural Data Source schema for Volcengine::TransitRouter::VpnAttachment\n", "outputs": { "description": "A collection of values returned by getVpnAttachments.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vedbm/getAccount:getAccount": { "description": "Data Source schema for Volcengine::VEDBM::Account\n", "inputs": { "description": "A collection of arguments for invoking getAccount.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAccount.\n", "properties": { "accountDesc": { "description": "Account Description\n", "type": "string" }, "accountName": { "description": "Account Name\n", "type": "string" }, "accountPassword": { "description": "Database Account Password\n", "type": "string" }, "accountType": { "description": "Account Type\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "resetPrivilege": { "description": "Reset high-privilege account permissions. Only applicable to Super accounts. If users modify high-privilege account permissions via SQL on the backend, subsequent features may become unavailable. Therefore, this function is provided to restore all permissions with one click.\n", "type": "boolean" } }, "required": [ "accountDesc", "accountName", "accountPassword", "accountType", "id", "instanceId", "resetPrivilege" ], "type": "object" } }, "volcenginecc:vedbm/getAccounts:getAccounts": { "description": "Plural Data Source schema for Volcengine::VEDBM::Account\n", "outputs": { "description": "A collection of values returned by getAccounts.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vedbm/getAllowList:getAllowList": { "description": "Data Source schema for Volcengine::VEDBM::AllowList\n", "inputs": { "description": "A collection of arguments for invoking getAllowList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAllowList.\n", "properties": { "allowList": { "description": "IP allowlist. Separate multiple IP addresses with commas (,). Duplicate entries are not allowed.\n", "type": "string" }, "allowListDesc": { "description": "Allowlist description.\n", "type": "string" }, "allowListId": { "description": "Allowlist ID.\n", "type": "string" }, "allowListIpNum": { "description": "Total number of IP addresses (or address ranges) in the allowlist.\n", "type": "integer" }, "allowListName": { "description": "Allowlist name.\n", "type": "string" }, "allowListType": { "description": "IP address type in the allowlist. Only IPv4 is currently supported.\n", "type": "string" }, "associatedInstanceNum": { "description": "Total number of instances bound to the allowlist.\n", "type": "integer" }, "associatedInstances": { "description": "List of bound instances.\n", "items": { "$ref": "#/types/volcenginecc:vedbm/getAllowListAssociatedInstance:getAllowListAssociatedInstance" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "modifyMode": { "description": "How to modify the allowlist. Supported settings: Cover (default): Overwrite the original allowlist with the values in the AllowList parameter. Append: Add IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain.\n", "type": "string" }, "projectName": { "description": "Project name associated with the allowlist. If left blank, the new allowlist will be added to the default project.\n", "type": "string" } }, "required": [ "allowList", "allowListDesc", "allowListId", "allowListIpNum", "allowListName", "allowListType", "associatedInstanceNum", "associatedInstances", "id", "modifyMode", "projectName" ], "type": "object" } }, "volcenginecc:vedbm/getAllowLists:getAllowLists": { "description": "Plural Data Source schema for Volcengine::VEDBM::AllowList\n", "outputs": { "description": "A collection of values returned by getAllowLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vedbm/getBackup:getBackup": { "description": "Data Source schema for Volcengine::VEDBM::Backup\n", "inputs": { "description": "A collection of arguments for invoking getBackup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBackup.\n", "properties": { "backupEndTime": { "description": "Backup end time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n", "type": "string" }, "backupFileSize": { "description": "Backup file size, unit: KiB\n", "type": "integer" }, "backupId": { "description": "Backup ID\n", "type": "string" }, "backupMethod": { "description": "Backup method, currently only physical backup is supported\n", "type": "string" }, "backupRetentionPeriod": { "description": "Data backup retention days\n", "type": "integer" }, "backupStartTime": { "description": "Backup start time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n", "type": "string" }, "backupStatus": { "description": "Backup status\n", "type": "string" }, "backupTime": { "description": "Backup task execution time, interval window is two hours. Format: HH:mmZ-HH:mmZ (UTC time)\n", "type": "string" }, "backupType": { "description": "Backup type, currently only full backup is supported\n", "type": "string" }, "consistentTime": { "description": "Consistency backup timestamp, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)\n", "type": "string" }, "continueBackup": { "description": "Enable continuous backup, value is always true\n", "type": "boolean" }, "createType": { "description": "Creation type\n", "type": "string" }, "fullBackupPeriod": { "description": "Full backup cycle, use commas (,) to separate multiple values\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" } }, "required": [ "backupEndTime", "backupFileSize", "backupId", "backupMethod", "backupRetentionPeriod", "backupStartTime", "backupStatus", "backupTime", "backupType", "consistentTime", "continueBackup", "createType", "fullBackupPeriod", "id", "instanceId" ], "type": "object" } }, "volcenginecc:vedbm/getBackups:getBackups": { "description": "Plural Data Source schema for Volcengine::VEDBM::Backup\n", "outputs": { "description": "A collection of values returned by getBackups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vedbm/getDatabase:getDatabase": { "description": "Data Source schema for Volcengine::VEDBM::Database\n", "inputs": { "description": "A collection of arguments for invoking getDatabase.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDatabase.\n", "properties": { "characterSetName": { "description": "Database character set. Options: utf8mb4 (default), utf8, latin1, ascii\n", "type": "string" }, "databasesPrivileges": { "description": "Database permission information\n", "items": { "$ref": "#/types/volcenginecc:vedbm/getDatabaseDatabasesPrivilege:getDatabaseDatabasesPrivilege" }, "type": "array" }, "dbDesc": { "description": "Database description, length 0–256 characters; can include numbers, Chinese and English characters, underscores (_), and hyphens (-)\n", "type": "string" }, "dbName": { "description": "Database name. Naming rules: Must be unique within the current instance; length 2–64 characters; starts with a letter, ends with a letter or number; can contain letters, numbers, underscores (_), and hyphens (-); reserved words are not allowed\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" } }, "required": [ "characterSetName", "databasesPrivileges", "dbDesc", "dbName", "id", "instanceId" ], "type": "object" } }, "volcenginecc:vedbm/getDatabases:getDatabases": { "description": "Plural Data Source schema for Volcengine::VEDBM::Database\n", "outputs": { "description": "A collection of values returned by getDatabases.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vedbm/getEndpoint:getEndpoint": { "description": "Data Source schema for Volcengine::VEDBM::Endpoint\n", "inputs": { "description": "A collection of arguments for invoking getEndpoint.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getEndpoint.\n", "properties": { "autoAddNewNodes": { "description": "Whether new read-only nodes are automatically added to this terminal\n", "type": "boolean" }, "consistLevel": { "description": "Consistency level\n", "type": "string" }, "consistTimeout": { "description": "Data synchronization timeout\n", "type": "integer" }, "consistTimeoutAction": { "description": "Policy after synchronization timeout\n", "type": "string" }, "description": { "description": "Description of the connection terminal\n", "type": "string" }, "distributedTransaction": { "description": "Enable transaction splitting\n", "type": "boolean" }, "domainPrefix": { "description": "New private network address prefix\n", "type": "string" }, "endpointId": { "description": "ID of the created connection terminal\n", "type": "string" }, "endpointName": { "description": "Connection terminal name\n", "type": "string" }, "endpointType": { "description": "Connection terminal type, fixed as Custom\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID\n", "type": "string" }, "masterAcceptReadRequests": { "description": "Whether the primary node accepts read requests\n", "type": "boolean" }, "nodeIds": { "description": "Node list configured for the connection terminal\n", "items": { "type": "string" }, "type": "array" }, "port": { "description": "Instance access port\n", "type": "string" }, "privateAddresses": { "$ref": "#/types/volcenginecc:vedbm/getEndpointPrivateAddresses:getEndpointPrivateAddresses", "description": "Private address information\n" }, "publicAddresses": { "$ref": "#/types/volcenginecc:vedbm/getEndpointPublicAddresses:getEndpointPublicAddresses", "description": "Public address information\n" }, "readWriteMode": { "description": "Terminal read/write mode\n", "type": "string" } }, "required": [ "autoAddNewNodes", "consistLevel", "consistTimeout", "consistTimeoutAction", "description", "distributedTransaction", "domainPrefix", "endpointId", "endpointName", "endpointType", "id", "instanceId", "masterAcceptReadRequests", "nodeIds", "port", "privateAddresses", "publicAddresses", "readWriteMode" ], "type": "object" } }, "volcenginecc:vedbm/getEndpoints:getEndpoints": { "description": "Plural Data Source schema for Volcengine::VEDBM::Endpoint\n", "outputs": { "description": "A collection of values returned by getEndpoints.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vedbm/getInstance:getInstance": { "description": "Data Source schema for Volcengine::VEDBM::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "chargeDetail": { "$ref": "#/types/volcenginecc:vedbm/getInstanceChargeDetail:getInstanceChargeDetail", "description": "Billing details.\n" }, "createdTime": { "description": "Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)\n", "type": "string" }, "dbEngineVersion": { "description": "Instance compatible version. Options: MySQL*8*0: Compatible with community MySQL 8.0. MySQL*5*7: Compatible with community MySQL 5.7\n", "type": "string" }, "dbMinorVersion": { "description": "Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL*5*7, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL*8*0, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.\n", "type": "string" }, "dbRevisionVersion": { "description": "Instance kernel version.\n", "type": "string" }, "deletionProtection": { "description": "Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.\n", "type": "string" }, "endpoints": { "description": "Endpoint details\n", "items": { "$ref": "#/types/volcenginecc:vedbm/getInstanceEndpoint:getInstanceEndpoint" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID.\n", "type": "string" }, "instanceName": { "description": "Instance name. Naming rules: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be between 1 and 128 characters.\n", "type": "string" }, "instanceStatus": { "description": "Instance status.\n", "type": "string" }, "lowerCaseTableNames": { "description": "Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.\n", "type": "string" }, "maintenanceWindow": { "$ref": "#/types/volcenginecc:vedbm/getInstanceMaintenanceWindow:getInstanceMaintenanceWindow", "description": "Instance maintenance window information\n" }, "nodeNumber": { "description": "Number of instance nodes. Value range: 2–16.\n", "type": "integer" }, "nodeSpec": { "description": "Instance node specification code.\n", "type": "string" }, "nodes": { "description": "Instance node details\n", "items": { "$ref": "#/types/volcenginecc:vedbm/getInstanceNode:getInstanceNode" }, "type": "array" }, "number": { "description": "Number of instances to create. Range: 1~50. Default: 1\n", "type": "integer" }, "port": { "description": "Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.\n", "type": "integer" }, "prePaidStorageInGb": { "description": "Total prepaid storage capacity, in GiB\n", "type": "integer" }, "projectName": { "description": "Project name to which the instance belongs.\n", "type": "string" }, "specFamily": { "description": "Instance specification type. Values: General: general purpose. Exclusive: dedicated.\n", "type": "string" }, "storageChargeType": { "description": "Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).\n", "type": "string" }, "storageUsedGiB": { "description": "Used storage space, in GiB\n", "type": "number" }, "subnetId": { "description": "Subnet ID. The subnet must belong to the selected availability zone.\n", "type": "string" }, "superAccountName": { "description": "Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords\n", "type": "string" }, "superAccountPassword": { "description": "Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^\u0026*_-+=`|(){}[]:;'\u003c\u003e,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.\n", "type": "string" }, "tags": { "description": "Array object of tag keys and tag values bound to the instance.\n", "items": { "$ref": "#/types/volcenginecc:vedbm/getInstanceTag:getInstanceTag" }, "type": "array" }, "templateId": { "description": "Parameter template ID\n", "type": "string" }, "timeZone": { "description": "Instance time zone. The default time zone for all regions in China is UTC +08:00.\n", "type": "string" }, "vpcId": { "description": "Private network (VPC) ID.\n", "type": "string" }, "zoneIds": { "description": "Availability zone ID\n", "type": "string" } }, "required": [ "chargeDetail", "createdTime", "dbEngineVersion", "dbMinorVersion", "dbRevisionVersion", "deletionProtection", "endpoints", "id", "instanceId", "instanceName", "instanceStatus", "lowerCaseTableNames", "maintenanceWindow", "nodeNumber", "nodeSpec", "nodes", "number", "port", "prePaidStorageInGb", "projectName", "specFamily", "storageChargeType", "storageUsedGiB", "subnetId", "superAccountName", "superAccountPassword", "tags", "templateId", "timeZone", "vpcId", "zoneIds" ], "type": "object" } }, "volcenginecc:vedbm/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::VEDBM::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vefaas/getFunction:getFunction": { "description": "Data Source schema for Volcengine::VEFAAS::Function\n", "inputs": { "description": "A collection of arguments for invoking getFunction.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getFunction.\n", "properties": { "asyncTaskConfig": { "$ref": "#/types/volcenginecc:vefaas/getFunctionAsyncTaskConfig:getFunctionAsyncTaskConfig", "description": "Asynchronous task configuration\n" }, "codeSize": { "description": "Code package size (MB).\n", "type": "integer" }, "codeSizeLimit": { "description": "Code package size limit. SourceType=zip, CodeSizeLimit=15MB. SourceType=tos, CodeSizeLimit=256MB.\n", "type": "integer" }, "command": { "description": "Custom startup command for the instance (currently only supported in native/v1 runtime)\n", "type": "string" }, "cpuStrategy": { "description": "Function CPU billing policy. When creating a microservice application type function, this field must be set to always, meaning at least one instance is running. Other function types do not support this field\n", "type": "string" }, "creationTime": { "description": "Function creation time\n", "type": "string" }, "description": { "description": "Function description. Up to 1000 Unicode characters\n", "type": "string" }, "enableApmplus": { "description": "Whether to enable application monitoring\n", "type": "boolean" }, "envs": { "description": "Environment variables.\n", "items": { "$ref": "#/types/volcenginecc:vefaas/getFunctionEnv:getFunctionEnv" }, "type": "array" }, "exclusiveMode": { "description": "Exclusive mode switch. true: disables multi-concurrency per instance, i.e., exclusive mode where a single instance can only handle one request at a time. false (default): enables multi-concurrency per instance, i.e., non-exclusive mode where a single instance can handle multiple requests at the same time. You can set the maximum concurrent requests per instance using MaxConcurrency.\n", "type": "boolean" }, "functionId": { "description": "Function ID\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "initializerSec": { "description": "Function initialization timeout configuration\n", "type": "integer" }, "instanceType": { "description": "Instance type of the function instance. Null value: CPU instance. Non-null value: GPU instance.\n", "type": "string" }, "lastUpdateTime": { "description": "Function update time.\n", "type": "string" }, "maxConcurrency": { "description": "Maximum concurrency per instance. Effective when ExclusiveMode = false. Range: 1–1000\n", "type": "integer" }, "memoryMb": { "description": "Maximum memory per instance, unit: MiB. Range: 512–4096, in increments of 512. Default: 1024\n", "type": "integer" }, "name": { "description": "Function name. Function names must be unique within the same account. Function names support uppercase and lowercase English letters, numbers, hyphens (-), and underscores (_), with a length limit of 4–64 characters.\n", "type": "string" }, "nasStorage": { "$ref": "#/types/volcenginecc:vefaas/getFunctionNasStorage:getFunctionNasStorage", "description": "NAS file storage mount configuration\n" }, "owner": { "description": "Function owner (Account Id).\n", "type": "string" }, "port": { "description": "Custom listening port for the instance (currently only supported in native/v1 runtime)\n", "type": "integer" }, "projectName": { "description": "Project name associated with the function\n", "type": "string" }, "requestTimeout": { "description": "Request timeout. Unit: seconds. Range: 1–900. Default: 30.\n", "type": "integer" }, "role": { "description": "IAM role bound to the function instance\n", "type": "string" }, "runtime": { "description": "Function runtime. Values: golang/v1, native/v1, nativejava8/v1, node14/v1, node20/v1, nodeprime14/v1, python3.12/v1, python3.8/v1, python3.9/v1.\n", "type": "string" }, "source": { "description": "Code source. Values: zip: Base64-encoded binary ZIP file; tos: string in the format bucket*name:object*key; image: image address in the format host/namespace/repo:tag\n", "type": "string" }, "sourceAccessConfig": { "$ref": "#/types/volcenginecc:vefaas/getFunctionSourceAccessConfig:getFunctionSourceAccessConfig", "description": "Image repository access configuration.\n" }, "sourceType": { "description": "Code source type. Values: tos: object storage (TOS); zip: local compressed file; image: image repository (CR), supports Basic and Enterprise editions\n", "type": "string" }, "tags": { "description": "Function tags\n", "items": { "$ref": "#/types/volcenginecc:vefaas/getFunctionTag:getFunctionTag" }, "type": "array" }, "tlsConfig": { "$ref": "#/types/volcenginecc:vefaas/getFunctionTlsConfig:getFunctionTlsConfig", "description": "TLS configuration for Log Service\n" }, "tosMountConfig": { "$ref": "#/types/volcenginecc:vefaas/getFunctionTosMountConfig:getFunctionTosMountConfig", "description": "TOS object storage mount configuration\n" }, "triggersCount": { "description": "Number of triggers for this function.\n", "type": "integer" }, "vpcConfig": { "$ref": "#/types/volcenginecc:vefaas/getFunctionVpcConfig:getFunctionVpcConfig", "description": "Private network VPC configuration.\n" } }, "required": [ "asyncTaskConfig", "codeSize", "codeSizeLimit", "command", "cpuStrategy", "creationTime", "description", "enableApmplus", "envs", "exclusiveMode", "functionId", "id", "initializerSec", "instanceType", "lastUpdateTime", "maxConcurrency", "memoryMb", "name", "nasStorage", "owner", "port", "projectName", "requestTimeout", "role", "runtime", "source", "sourceAccessConfig", "sourceType", "tags", "tlsConfig", "tosMountConfig", "triggersCount", "vpcConfig" ], "type": "object" } }, "volcenginecc:vefaas/getFunctions:getFunctions": { "description": "Plural Data Source schema for Volcengine::VEFAAS::Function\n", "outputs": { "description": "A collection of values returned by getFunctions.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vefaas/getKafkaTrigger:getKafkaTrigger": { "description": "Data Source schema for Volcengine::VEFAAS::KafkaTrigger\n", "inputs": { "description": "A collection of arguments for invoking getKafkaTrigger.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getKafkaTrigger.\n", "properties": { "batchFlushDurationMilliseconds": { "description": "Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.\n", "type": "integer" }, "batchSize": { "description": "Number of messages per batch for trigger batch consumption.\n", "type": "integer" }, "consumerGroup": { "description": "Consumer group name of the Kafka message queue instance.\n", "type": "string" }, "createdTime": { "description": "Kafka trigger creation time.\n", "type": "string" }, "description": { "description": "Description of the Kafka trigger. Limited to 200 characters.\n", "type": "string" }, "enabled": { "description": "Enable the trigger when creating it. Options: true—enable. false—disable.\n", "type": "boolean" }, "functionId": { "description": "Function ID.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "kafkaCredentials": { "$ref": "#/types/volcenginecc:vefaas/getKafkaTriggerKafkaCredentials:getKafkaTriggerKafkaCredentials", "description": "Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.\n" }, "kafkaTriggerId": { "description": "Kafka trigger ID.\n", "type": "string" }, "maximumRetryAttempts": { "description": "Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.\n", "type": "integer" }, "mqInstanceId": { "description": "Kafka message queue instance ID.\n", "type": "string" }, "name": { "description": "Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.\n", "type": "string" }, "startingPosition": { "description": "Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.\n", "type": "string" }, "status": { "description": "Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.\n", "type": "string" }, "topicName": { "description": "Topic name of the Kafka message queue instance.\n", "type": "string" }, "updatedTime": { "description": "Last update time of the Kafka trigger.\n", "type": "string" } }, "required": [ "batchFlushDurationMilliseconds", "batchSize", "consumerGroup", "createdTime", "description", "enabled", "functionId", "id", "kafkaCredentials", "kafkaTriggerId", "maximumRetryAttempts", "mqInstanceId", "name", "startingPosition", "status", "topicName", "updatedTime" ], "type": "object" } }, "volcenginecc:vefaas/getKafkaTriggers:getKafkaTriggers": { "description": "Plural Data Source schema for Volcengine::VEFAAS::KafkaTrigger\n", "outputs": { "description": "A collection of values returned by getKafkaTriggers.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vefaas/getRelease:getRelease": { "description": "Data Source schema for Volcengine::VEFAAS::Release\n", "inputs": { "description": "A collection of arguments for invoking getRelease.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRelease.\n", "properties": { "creationTime": { "description": "Creation time\n", "type": "string" }, "currentTrafficWeight": { "description": "Current release traffic percentage. Valid values: 1–100, indicates the proportion of traffic assigned to the currently releasing version. Returned only when status is inprogress or failed\n", "type": "integer" }, "description": { "description": "Description for this release\n", "type": "string" }, "errorCode": { "description": "Error codes for release failures: function*start*failed: function startup failed function*start*timeout: function startup timed out function*health*check*failed: function health check failed system*internal_error: internal system error\n", "type": "string" }, "failedInstanceLogs": { "description": "Download link for logs of failed release instances\n", "type": "string" }, "finishTime": { "description": "Completion time\n", "type": "string" }, "functionId": { "description": "Function ID\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lastUpdateTime": { "description": "Update time\n", "type": "string" }, "maxInstance": { "description": "Maximum number of function instances. Valid range: [0 ~ remaining available account resources/single instance maximum memory]\n", "type": "integer" }, "newRevisionNumber": { "description": "Version number of the new version being released. Not returned when status is pending; returned when status is inprogress, failed, or done\n", "type": "integer" }, "oldRevisionNumber": { "description": "Version number of the old version. Not returned when status is pending; returned when status is inprogress, failed, or done\n", "type": "integer" }, "releaseRecordId": { "description": "Release record ID\n", "type": "string" }, "revisionNumber": { "description": "Version number to release. When RevisionNumber = 0, the latest code (Latest) is released and a new version is created\n", "type": "integer" }, "rollingStep": { "description": "Canary step percentage. Valid values: 1–100, default: 10\n", "type": "integer" }, "sourceRevisionNumber": { "description": "Released historical version number\n", "type": "integer" }, "stableRevisionNumber": { "description": "Version number currently running stably online. Generated after the first successful release. Before the first release (status == pending), StableRevisionNumber is -1\n", "type": "integer" }, "startTime": { "description": "Start time of the current release. Not returned when status is pending; returned when status is inprogress, failed, or done\n", "type": "string" }, "status": { "description": "Function release status: pending: never released, inprogress: releasing, done: release successful, failed: release failed\n", "type": "string" }, "statusMessage": { "description": "Detailed function release status. Supplementary information for release status\n", "type": "string" }, "targetRevisionNumber": { "description": "Target version number for release\n", "type": "integer" }, "targetTrafficWeight": { "description": "Target release traffic percentage. Valid range: [0, 100], indicates the proportion of traffic assigned to the released version. 100 means full release\n", "type": "integer" } }, "required": [ "creationTime", "currentTrafficWeight", "description", "errorCode", "failedInstanceLogs", "finishTime", "functionId", "id", "lastUpdateTime", "maxInstance", "newRevisionNumber", "oldRevisionNumber", "releaseRecordId", "revisionNumber", "rollingStep", "sourceRevisionNumber", "stableRevisionNumber", "startTime", "status", "statusMessage", "targetRevisionNumber", "targetTrafficWeight" ], "type": "object" } }, "volcenginecc:vefaas/getReleases:getReleases": { "description": "Plural Data Source schema for Volcengine::VEFAAS::Release\n", "outputs": { "description": "A collection of values returned by getReleases.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vefaas/getSandbox:getSandbox": { "description": "Data Source schema for Volcengine::VEFAAS::Sandbox\n", "inputs": { "description": "A collection of arguments for invoking getSandbox.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSandbox.\n", "properties": { "availabilityZone": { "description": "Availability zone ID of the sandbox instance\n", "type": "string" }, "cpuMilli": { "description": "Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000\n", "type": "integer" }, "createdTime": { "description": "Sandbox instance creation time.\n", "type": "string" }, "envs": { "description": "Sandbox instance environment variables\n", "items": { "$ref": "#/types/volcenginecc:vefaas/getSandboxEnv:getSandboxEnv" }, "type": "array" }, "errorCode": { "description": "Sandbox instance startup failure error code. Parameter description: internal*load*request*error: internal system error, function*initialize*failed: business process initialization error, function*health*check*failed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally\n", "type": "string" }, "errorMessage": { "description": "Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.\n", "type": "string" }, "expireAt": { "description": "Sandbox instance uptime.\n", "type": "string" }, "functionId": { "description": "Sandbox application ID to which the sandbox instance belongs\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceImageInfo": { "$ref": "#/types/volcenginecc:vefaas/getSandboxInstanceImageInfo:getSandboxInstanceImageInfo", "description": "Sandbox instance image information, including image address, startup command, and listening port.\n" }, "instanceTosMountConfig": { "$ref": "#/types/volcenginecc:vefaas/getSandboxInstanceTosMountConfig:getSandboxInstanceTosMountConfig", "description": "Instance-level object storage (TOS) mount configuration for the sandbox instance\n" }, "instanceType": { "description": "Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance\n", "type": "string" }, "maxConcurrency": { "description": "Maximum concurrent requests per instance: range: 10~1000, default: 100\n", "type": "integer" }, "memoryMb": { "description": "Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048\n", "type": "integer" }, "metadatas": { "description": "Sandbox instance label metadata used to tag and filter instances. Format: \u003c\"key\":\"value\"\u003e\n", "items": { "$ref": "#/types/volcenginecc:vefaas/getSandboxMetadata:getSandboxMetadata" }, "type": "array" }, "pending": { "description": "Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no\n", "type": "boolean" }, "requestTimeout": { "description": "Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30\n", "type": "integer" }, "revisionNumber": { "description": "Function instance version number\n", "type": "integer" }, "sandboxId": { "description": "Sandbox instance ID\n", "type": "string" }, "status": { "description": "Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating\n", "type": "string" }, "timeout": { "description": "Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60\n", "type": "integer" } }, "required": [ "availabilityZone", "cpuMilli", "createdTime", "envs", "errorCode", "errorMessage", "expireAt", "functionId", "id", "instanceImageInfo", "instanceTosMountConfig", "instanceType", "maxConcurrency", "memoryMb", "metadatas", "pending", "requestTimeout", "revisionNumber", "sandboxId", "status", "timeout" ], "type": "object" } }, "volcenginecc:vefaas/getSandboxes:getSandboxes": { "description": "Plural Data Source schema for Volcengine::VEFAAS::Sandbox\n", "outputs": { "description": "A collection of values returned by getSandboxes.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vefaas/getTimer:getTimer": { "description": "Data Source schema for Volcengine::VEFAAS::Timer\n", "inputs": { "description": "A collection of arguments for invoking getTimer.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTimer.\n", "properties": { "creationTime": { "description": "Timer trigger creation time\n", "type": "string" }, "crontab": { "description": "Timer trigger time, formatted as a crontab expression\n", "type": "string" }, "description": { "description": "Timer trigger remarks\n", "type": "string" }, "enableConcurrency": { "description": "Allow timer trigger concurrency; true means concurrency is allowed\n", "type": "boolean" }, "enabled": { "description": "Timer trigger enabled; true means enabled\n", "type": "boolean" }, "functionId": { "description": "Function ID\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lastUpdateTime": { "description": "Timer trigger update time\n", "type": "string" }, "name": { "description": "Timer trigger name\n", "type": "string" }, "payload": { "description": "Payload sent by timer trigger, that is, the trigger message\n", "type": "string" }, "retries": { "description": "Timer trigger retry count\n", "type": "integer" }, "timerId": { "description": "Timer trigger ID\n", "type": "string" } }, "required": [ "creationTime", "crontab", "description", "enableConcurrency", "enabled", "functionId", "id", "lastUpdateTime", "name", "payload", "retries", "timerId" ], "type": "object" } }, "volcenginecc:vefaas/getTimers:getTimers": { "description": "Plural Data Source schema for Volcengine::VEFAAS::Timer\n", "outputs": { "description": "A collection of values returned by getTimers.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vepfs/getInstance:getInstance": { "description": "Data Source schema for Volcengine::VEPFS::Instance\n", "inputs": { "description": "A collection of arguments for invoking getInstance.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getInstance.\n", "properties": { "accountId": { "description": "Account ID.\n", "type": "string" }, "bandwidth": { "description": "VePFS file system throughput limit.\n", "type": "integer" }, "capacity": { "description": "File system capacity, unit: TiB.\n", "type": "integer" }, "capacityInfo": { "$ref": "#/types/volcenginecc:vepfs/getInstanceCapacityInfo:getInstanceCapacityInfo", "description": "Capacity information.\n" }, "chargeStatus": { "description": "Billing status. Default is Normal, indicating standard billing.\n", "type": "string" }, "chargeType": { "description": "Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.\n", "type": "string" }, "createdTime": { "description": "Creation time.\n", "type": "string" }, "description": { "description": "File system description.\n", "type": "string" }, "enableRestripe": { "description": "Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.\n", "type": "boolean" }, "expireTime": { "description": "Expiration time.\n", "type": "string" }, "fileSystemId": { "description": "File system ID.\n", "type": "string" }, "fileSystemName": { "description": "File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.\n", "type": "string" }, "fileSystemType": { "description": "File system type. Default is VePFS.\n", "type": "string" }, "freeTime": { "description": "File system release time.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "projectName": { "description": "Project to which the file system belongs. Default is default.\n", "type": "string" }, "protocolType": { "description": "Protocol type. Default is VePFS.\n", "type": "string" }, "readBandwidth": { "description": "Read bandwidth value, unit: MB/s.\n", "type": "integer" }, "securityGroupId": { "description": "Security group ID for the generated auxiliary NIC.\n", "type": "string" }, "status": { "description": "File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.\n", "type": "string" }, "stopServiceTime": { "description": "File system shutdown time.\n", "type": "string" }, "storeType": { "description": "File system specification. Value descriptions are as follows: Advance*100: 100MB/s/TiB. Performance: Performance. Intelligent*Computing: Intelligent Computing.\n", "type": "string" }, "storeTypeCn": { "description": "File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.\n", "type": "string" }, "storeTypeEn": { "description": "Storage type English name.\n", "type": "string" }, "subnetId": { "description": "Subnet ID. The subnet must belong to the selected availability zone.\n", "type": "string" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:vepfs/getInstanceTag:getInstanceTag" }, "type": "array" }, "updatedTime": { "description": "File system update time.\n", "type": "string" }, "versionNumber": { "description": "File system version number.\n", "type": "string" }, "vpcId": { "description": "Private network ID.\n", "type": "string" }, "writeBandwidth": { "description": "Write bandwidth value, measured in MB/s.\n", "type": "integer" }, "zoneId": { "description": "Availability zone ID.\n", "type": "string" }, "zoneName": { "description": "Availability zone name.\n", "type": "string" } }, "required": [ "accountId", "bandwidth", "capacity", "capacityInfo", "chargeStatus", "chargeType", "createdTime", "description", "enableRestripe", "expireTime", "fileSystemId", "fileSystemName", "fileSystemType", "freeTime", "id", "projectName", "protocolType", "readBandwidth", "securityGroupId", "status", "stopServiceTime", "storeType", "storeTypeCn", "storeTypeEn", "subnetId", "tags", "updatedTime", "versionNumber", "vpcId", "writeBandwidth", "zoneId", "zoneName" ], "type": "object" } }, "volcenginecc:vepfs/getInstances:getInstances": { "description": "Plural Data Source schema for Volcengine::VEPFS::Instance\n", "outputs": { "description": "A collection of values returned by getInstances.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vepfs/getMountService:getMountService": { "description": "Data Source schema for Volcengine::VEPFS::MountService\n", "inputs": { "description": "A collection of arguments for invoking getMountService.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getMountService.\n", "properties": { "attachFileSystems": { "description": "Mount instance information.\n", "items": { "$ref": "#/types/volcenginecc:vepfs/getMountServiceAttachFileSystem:getMountServiceAttachFileSystem" }, "type": "array" }, "createTime": { "description": "Creation time.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "mountServiceId": { "description": "Mount service ID.\n", "type": "string" }, "mountServiceName": { "description": "Mount service name. Naming rules: Must start with a Chinese or English character. Only Chinese characters, letters, numbers, periods (.), underscores (_), or hyphens (-) are allowed. Length must be between 1 and 128 characters. The mount service name must be unique within each region and account; duplicates are not allowed.\n", "type": "string" }, "nodeType": { "description": "Client management node type.\n", "type": "string" }, "nodes": { "description": "Client management node list.\n", "items": { "$ref": "#/types/volcenginecc:vepfs/getMountServiceNode:getMountServiceNode" }, "type": "array" }, "project": { "description": "Project.\n", "type": "string" }, "securityGroupId": { "description": "Client NIC security group ID.\n", "type": "string" }, "status": { "description": "Mount service status. Details: Creating: Creating. CreateError: Creation failed. Running: Running. Updating: Updating. UpdateError: Update failed. Deleting: Deleting. DeleteError: Deletion failed. Deleted: Deleted. Attaching: Attaching. AttachError: Attachment failed. Detaching: Detaching. DetachError: Detachment failed. Stopped: Stopped. Error: Error.\n", "type": "string" }, "subnetId": { "description": "Subnet ID.\n", "type": "string" }, "versionNumber": { "description": "Mount service version.\n", "type": "string" }, "vpcId": { "description": "Private network ID.\n", "type": "string" }, "zoneId": { "description": "Availability zone ID.\n", "type": "string" }, "zoneName": { "description": "Availability zone name.\n", "type": "string" } }, "required": [ "attachFileSystems", "createTime", "id", "mountServiceId", "mountServiceName", "nodeType", "nodes", "project", "securityGroupId", "status", "subnetId", "versionNumber", "vpcId", "zoneId", "zoneName" ], "type": "object" } }, "volcenginecc:vepfs/getMountServices:getMountServices": { "description": "Plural Data Source schema for Volcengine::VEPFS::MountService\n", "outputs": { "description": "A collection of values returned by getMountServices.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vke/getAddon:getAddon": { "description": "Data Source schema for Volcengine::VKE::Addon\n", "inputs": { "description": "A collection of arguments for invoking getAddon.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAddon.\n", "properties": { "clusterId": { "description": "Cluster ID where the component is located.\n", "type": "string" }, "config": { "description": "Component configuration.\n", "type": "string" }, "createdTime": { "description": "Component installation time. Standard RFC3339 format, UTC+0 time.\n", "type": "string" }, "deployMode": { "description": "Component deployment mode. Values: Unmanaged: deployed in unmanaged mode. Managed: deployed in managed mode.\n", "type": "string" }, "deployNodeType": { "description": "Type of deployment node. This parameter needs to be specified only when DeployModes=Unmanaged. Values: Node: deployed as a node. VirtualNode: deployed as a virtual node.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "name": { "description": "Component name.\n", "type": "string" }, "status": { "$ref": "#/types/volcenginecc:vke/getAddonStatus:getAddonStatus", "description": "Component status.\n" }, "updatedTime": { "description": "Component update time. Standard RFC3339 format, UTC+0 time.\n", "type": "string" }, "version": { "description": "Component version.\n", "type": "string" } }, "required": [ "clusterId", "config", "createdTime", "deployMode", "deployNodeType", "id", "name", "status", "updatedTime", "version" ], "type": "object" } }, "volcenginecc:vke/getAddons:getAddons": { "description": "Plural Data Source schema for Volcengine::VKE::Addon\n", "outputs": { "description": "A collection of values returned by getAddons.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vke/getCluster:getCluster": { "description": "Data Source schema for Volcengine::VKE::Cluster\n", "inputs": { "description": "A collection of arguments for invoking getCluster.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getCluster.\n", "properties": { "clusterConfig": { "$ref": "#/types/volcenginecc:vke/getClusterClusterConfig:getClusterClusterConfig", "description": "Network configuration for the cluster control plane and some nodes.\n" }, "clusterId": { "description": "Cluster ID.\n", "type": "string" }, "createdTime": { "description": "Cluster creation time. Standard RFC3339 format, UTC+0.\n", "type": "string" }, "deleteProtectionEnabled": { "description": "Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.\n", "type": "boolean" }, "description": { "description": "Cluster description. Maximum length is 300 characters.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "irsaConfig": { "$ref": "#/types/volcenginecc:vke/getClusterIrsaConfig:getClusterIrsaConfig", "description": "IRSA (IAM Role for Service Account) capability parameter configuration\n" }, "kubernetesVersion": { "description": "Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)\n", "type": "string" }, "kubernetesVersionCreate": { "description": "Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)\n", "type": "string" }, "loggingConfig": { "$ref": "#/types/volcenginecc:vke/getClusterLoggingConfig:getClusterLoggingConfig", "description": "Cluster log configuration information.\n" }, "message": { "description": "Cluster status description.\n", "type": "string" }, "monitoringConfig": { "$ref": "#/types/volcenginecc:vke/getClusterMonitoringConfig:getClusterMonitoringConfig", "description": "Monitoring configuration information.\n" }, "name": { "description": "Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.\n", "type": "string" }, "nodeStatistics": { "$ref": "#/types/volcenginecc:vke/getClusterNodeStatistics:getClusterNodeStatistics", "description": "Statistics of node counts for each main status in the cluster.\n" }, "podsConfig": { "$ref": "#/types/volcenginecc:vke/getClusterPodsConfig:getClusterPodsConfig", "description": "Pod network configuration.\n" }, "projectName": { "description": "Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.\n", "type": "string" }, "servicesConfig": { "$ref": "#/types/volcenginecc:vke/getClusterServicesConfig:getClusterServicesConfig", "description": "Network configuration for the service.\n" }, "sourceRegion": { "description": "Cluster source region\n", "type": "string" }, "status": { "$ref": "#/types/volcenginecc:vke/getClusterStatus:getClusterStatus", "description": "Cluster status.\n" }, "tags": { "description": "Cluster tags.\n", "items": { "$ref": "#/types/volcenginecc:vke/getClusterTag:getClusterTag" }, "type": "array" }, "type": { "description": "Cluster type.\n", "type": "string" }, "updatedTime": { "description": "Last update time of the cluster. Standard RFC3339 format, UTC+0.\n", "type": "string" } }, "required": [ "clusterConfig", "clusterId", "createdTime", "deleteProtectionEnabled", "description", "id", "irsaConfig", "kubernetesVersion", "kubernetesVersionCreate", "loggingConfig", "message", "monitoringConfig", "name", "nodeStatistics", "podsConfig", "projectName", "servicesConfig", "sourceRegion", "status", "tags", "type", "updatedTime" ], "type": "object" } }, "volcenginecc:vke/getClusters:getClusters": { "description": "Plural Data Source schema for Volcengine::VKE::Cluster\n", "outputs": { "description": "A collection of values returned by getClusters.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vke/getDefaultNodePool:getDefaultNodePool": { "description": "Data Source schema for Volcengine::VKE::DefaultNodePool\n", "inputs": { "description": "A collection of arguments for invoking getDefaultNodePool.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDefaultNodePool.\n", "properties": { "autoScaling": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolAutoScaling:getDefaultNodePoolAutoScaling", "description": "Node pool scaling policy configuration\n" }, "clusterId": { "description": "Cluster ID where the node pool is located\n", "type": "string" }, "createdTime": { "description": "Node pool creation time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolKubernetesConfig:getDefaultNodePoolKubernetesConfig", "description": "Kubernetes-related configuration for the node pool\n" }, "management": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolManagement:getDefaultNodePoolManagement", "description": "Managed node pool configuration\n" }, "name": { "description": "Node pool name. Must be unique within the same cluster. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length: 2–64 characters\n", "type": "string" }, "nodeConfig": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolNodeConfig:getDefaultNodePoolNodeConfig", "description": "Cloud server (ECS) instance configuration in the node pool\n" }, "nodePoolId": { "description": "Node pool ID\n", "type": "string" }, "nodeStatistics": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolNodeStatistics:getDefaultNodePoolNodeStatistics", "description": "Node statistics in the node pool.\n" }, "status": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolStatus:getDefaultNodePoolStatus", "description": "Node pool status\n" }, "tags": { "description": "Node pool tag information\n", "items": { "$ref": "#/types/volcenginecc:vke/getDefaultNodePoolTag:getDefaultNodePoolTag" }, "type": "array" }, "updatedTime": { "description": "Time when the node pool was updated\n", "type": "string" } }, "required": [ "autoScaling", "clusterId", "createdTime", "id", "kubernetesConfig", "management", "name", "nodeConfig", "nodePoolId", "nodeStatistics", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:vke/getDefaultNodePools:getDefaultNodePools": { "description": "Plural Data Source schema for Volcengine::VKE::DefaultNodePool\n", "outputs": { "description": "A collection of values returned by getDefaultNodePools.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vke/getKubeconfig:getKubeconfig": { "description": "Data Source schema for Volcengine::VKE::Kubeconfig\n", "inputs": { "description": "A collection of arguments for invoking getKubeconfig.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getKubeconfig.\n", "properties": { "clusterId": { "description": "Cluster ID\n", "type": "string" }, "createTime": { "description": "Kubeconfig Creation Time\n", "type": "string" }, "expireTime": { "description": "Kubeconfig Expiration Time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "kubeconfig": { "description": "Kubeconfig Text\n", "type": "string" }, "kubeconfigId": { "description": "KubeconfigID。\n", "type": "string" }, "roleId": { "description": "Role ID\n", "type": "integer" }, "type": { "description": "Cluster Kubeconfig File Type\n", "type": "string" }, "userId": { "description": "User ID\n", "type": "integer" }, "validDuration": { "description": "Kubeconfig File Validity Period\n", "type": "integer" } }, "required": [ "clusterId", "createTime", "expireTime", "id", "kubeconfig", "kubeconfigId", "roleId", "type", "userId", "validDuration" ], "type": "object" } }, "volcenginecc:vke/getKubeconfigs:getKubeconfigs": { "description": "Plural Data Source schema for Volcengine::VKE::Kubeconfig\n", "outputs": { "description": "A collection of values returned by getKubeconfigs.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vke/getNode:getNode": { "description": "Data Source schema for Volcengine::VKE::Node\n", "inputs": { "description": "A collection of arguments for invoking getNode.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNode.\n", "properties": { "additionalContainerStorageEnabled": { "description": "Select the data disk for the node, format and mount it as the storage directory for container images and logs. Values: false (default): Disabled. Default node pool: indicates no data disk is mounted. Custom node pool: mounts according to the node pool's data disk configuration. ECS instance data disks added to the node pool must include the data disk specified for mounting by the target node pool (including local disks), and the disk type and size must match exactly. true: Enabled. You must also configure the ContainerStoragePath parameter. The node mounts according to the configuration in the ContainerStoragePath parameter and ignores the node pool's data disk configuration. There are no special requirements for ECS instance data disks added to the node pool.\n", "type": "boolean" }, "clusterId": { "description": "Cluster ID.\n", "type": "string" }, "containerStoragePath": { "description": "Use this data disk device to mount the container and image storage directory /var/lib/containerd.\nValid only when AdditionalContainerStorageEnabled=true and cannot be empty. The following conditions must be met, otherwise initialization will fail: Only ECS instances with mounted data disks are supported. When specifying a data disk device name, ensure the device exists, otherwise initialization will fail. When specifying a data disk partition or logical volume name, ensure the partition or logical volume exists and uses the ext4 file system.\n", "type": "string" }, "createdTime": { "description": "Creation time.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "imageId": { "description": "Image ID used by the ECS instance corresponding to the node.\n", "type": "string" }, "initializeScript": { "description": "Script executed after creating ECS nodes and deploying Kubernetes components. Supports Shell format. Base64-encoded length must not exceed 1 KB. If left empty, the node inherits the default node pool initialization script NodeConfig.InitializeScript. If you enter a custom script, the custom script will be used and the default node pool initialization script will be ignored.\n", "type": "string" }, "instanceId": { "description": "Cloud server instance ID corresponding to the node.\n", "type": "string" }, "isVirtual": { "description": "Is it a virtual node? Parameter value description: false: No, true: Yes.\n", "type": "boolean" }, "keepInstanceName": { "description": "Whether to retain the original ECS instance name. Options: false (default): do not retain the original ECS instance name; Container Service automatically assigns a name. true: retain the original ECS instance name.\n", "type": "boolean" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/getNodeKubernetesConfig:getNodeKubernetesConfig", "description": "Kubernetes-related configuration for the node. If empty, the node inherits the default node pool's Kubernetes configuration: KubernetesConfig.Labels/Taints/Cordon. If custom configuration is provided, the node uses the custom configuration and ignores the default node pool's Kubernetes configuration.\n" }, "name": { "description": "Node name.\n", "type": "string" }, "nodeId": { "description": "Node ID.\n", "type": "string" }, "nodePoolId": { "description": "Node pool ID. If no parameter value is provided: add existing ECS instances to the default node pool. If a parameter value is provided: add existing ECS instances to a custom node pool.\n", "type": "string" }, "roles": { "description": "Node role. Parameter value description: Worker: Worker node.\n", "items": { "type": "string" }, "type": "array" }, "status": { "$ref": "#/types/volcenginecc:vke/getNodeStatus:getNodeStatus", "description": "Node status.\n" }, "updatedTime": { "description": "Update time.\n", "type": "string" }, "zoneId": { "description": "Availability zone ID.\n", "type": "string" } }, "required": [ "additionalContainerStorageEnabled", "clusterId", "containerStoragePath", "createdTime", "id", "imageId", "initializeScript", "instanceId", "isVirtual", "keepInstanceName", "kubernetesConfig", "name", "nodeId", "nodePoolId", "roles", "status", "updatedTime", "zoneId" ], "type": "object" } }, "volcenginecc:vke/getNodePool:getNodePool": { "description": "Data Source schema for Volcengine::VKE::NodePool\n", "inputs": { "description": "A collection of arguments for invoking getNodePool.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNodePool.\n", "properties": { "autoScaling": { "$ref": "#/types/volcenginecc:vke/getNodePoolAutoScaling:getNodePoolAutoScaling", "description": "Node pool scaling policy configuration.\n" }, "clusterId": { "description": "ID of the cluster where the node pool is located\n", "type": "string" }, "createdTime": { "description": "Node pool creation time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "kubernetesConfig": { "$ref": "#/types/volcenginecc:vke/getNodePoolKubernetesConfig:getNodePoolKubernetesConfig", "description": "Kubernetes-related configuration for the node pool\n" }, "management": { "$ref": "#/types/volcenginecc:vke/getNodePoolManagement:getNodePoolManagement", "description": "Managed node pool configuration\n" }, "name": { "description": "Node pool name. The node pool name must be unique within the same cluster. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length limit: 2–64 characters.\n", "type": "string" }, "nodeConfig": { "$ref": "#/types/volcenginecc:vke/getNodePoolNodeConfig:getNodePoolNodeConfig", "description": "Cloud server (ECS) instance configuration in the node pool\n" }, "nodePoolId": { "description": "Node pool ID\n", "type": "string" }, "nodeStatistics": { "$ref": "#/types/volcenginecc:vke/getNodePoolNodeStatistics:getNodePoolNodeStatistics", "description": "Node statistics in the node pool.\n" }, "retainResources": { "description": "When deleting a node pool, specify related resources to retain. Values: Empty value (default): delete associated resources Ecs: when deleting the node pool, retain ECS instances in the node pool. If the node pool contains prepaid ECS instances and retaining ECS is not selected, this API only removes the ECS instance from the node pool and does not delete it. You can query the instance via the ECS console or ECS API and perform subsequent operations as needed.\n", "items": { "type": "string" }, "type": "array" }, "status": { "$ref": "#/types/volcenginecc:vke/getNodePoolStatus:getNodePoolStatus", "description": "Node pool status\n" }, "tags": { "description": "Node pool tag information\n", "items": { "$ref": "#/types/volcenginecc:vke/getNodePoolTag:getNodePoolTag" }, "type": "array" }, "updatedTime": { "description": "Node pool update time\n", "type": "string" } }, "required": [ "autoScaling", "clusterId", "createdTime", "id", "kubernetesConfig", "management", "name", "nodeConfig", "nodePoolId", "nodeStatistics", "retainResources", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:vke/getNodePools:getNodePools": { "description": "Plural Data Source schema for Volcengine::VKE::NodePool\n", "outputs": { "description": "A collection of values returned by getNodePools.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vke/getNodes:getNodes": { "description": "Plural Data Source schema for Volcengine::VKE::Node\n", "outputs": { "description": "A collection of values returned by getNodes.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vke/getPermission:getPermission": { "description": "Data Source schema for Volcengine::VKE::Permission\n", "inputs": { "description": "A collection of arguments for invoking getPermission.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getPermission.\n", "properties": { "authorizedAt": { "description": "Time when the RBAC policy resource was authorized.\n", "type": "string" }, "authorizerId": { "description": "Grantor ID. Can be an IAM user ID or an IAM role ID.\n", "type": "integer" }, "authorizerName": { "description": "Grantor name\n", "type": "string" }, "authorizerType": { "description": "Type of grantor. Possible values: User: IAM user. Role: IAM role. Account: account.\n", "type": "string" }, "clusterId": { "description": "Cluster ID to be authorized for the IAM user or role. This parameter is required when roleDomain is namespace or cluster.\n", "type": "string" }, "createdTime": { "description": "Time when the RBAC policy resource was created.\n", "type": "string" }, "granteeId": { "description": "Grantee ID. Can be an IAM user ID or an IAM role ID.\n", "type": "integer" }, "granteeType": { "description": "Type of grantee. Possible values: User: IAM user. Role: IAM role. Account: account.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "isCustomRole": { "description": "Whether the RBAC role granted to the grantee is a custom role. Possible values: true: custom role. false (default): system predefined role.\n", "type": "boolean" }, "kubeRoleBindingName": { "description": "The object name of the RBAC policy resource in Kubernetes.\n", "type": "string" }, "message": { "description": "Authorization details message.\n", "type": "string" }, "namespace": { "description": "Namespace name to be authorized for the IAM user or role. This parameter is required when roleDomain equals namespace. If roleDomain does not equal namespace, this parameter is not effective.\n", "type": "string" }, "permissionId": { "description": "RBAC policy resource ID.\n", "type": "string" }, "projectSelector": { "description": "Project selector\n", "type": "string" }, "revokedAt": { "description": "Time when authorization is revoked.\n", "type": "string" }, "roleDomain": { "description": "The permission type granted to an IAM user or role. Possible values: namespace: grants permissions at the namespace level. cluster: grants permissions at the cluster level. all_clusters: grants permissions at the cluster level for all clusters under the current account.\n", "type": "string" }, "roleName": { "description": "Name of the RBAC role granted to the grantee. This parameter must be specified. When roleDomain is all_clusters, custom role names are not allowed.\n", "type": "string" }, "status": { "description": "Status of the RBAC access policy resource. Possible values: Success: authorization succeeded. Failed: authorization failed. Pending: authorization in progress. PartialSuccess: partial authorization succeeded.\n", "type": "string" } }, "required": [ "authorizedAt", "authorizerId", "authorizerName", "authorizerType", "clusterId", "createdTime", "granteeId", "granteeType", "id", "isCustomRole", "kubeRoleBindingName", "message", "namespace", "permissionId", "projectSelector", "revokedAt", "roleDomain", "roleName", "status" ], "type": "object" } }, "volcenginecc:vke/getPermissions:getPermissions": { "description": "Plural Data Source schema for Volcengine::VKE::Permission\n", "outputs": { "description": "A collection of values returned by getPermissions.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vmp/getAlertingRule:getAlertingRule": { "description": "Data Source schema for Volcengine::VMP::AlertingRule\n", "inputs": { "description": "A collection of arguments for invoking getAlertingRule.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getAlertingRule.\n", "properties": { "alertingRuleId": { "description": "Alert rule ID\n", "type": "string" }, "annotations": { "description": "Annotation attached to the alert\n", "items": { "$ref": "#/types/volcenginecc:vmp/getAlertingRuleAnnotation:getAlertingRuleAnnotation" }, "type": "array" }, "createTime": { "description": "Alert rule creation time\n", "type": "string" }, "description": { "description": "Alert rule description\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "labels": { "description": "Tags attached to the alert\n", "items": { "$ref": "#/types/volcenginecc:vmp/getAlertingRuleLabel:getAlertingRuleLabel" }, "type": "array" }, "levels": { "description": "Alert severity\n", "items": { "$ref": "#/types/volcenginecc:vmp/getAlertingRuleLevel:getAlertingRuleLevel" }, "type": "array" }, "name": { "description": "Alert rule name\n", "type": "string" }, "notifyGroupPolicyId": { "description": "Alert aggregation policy ID\n", "type": "string" }, "notifyPolicyId": { "description": "Alert notification policy ID\n", "type": "string" }, "query": { "$ref": "#/types/volcenginecc:vmp/getAlertingRuleQuery:getAlertingRuleQuery", "description": "Alert configuration\n" }, "status": { "description": "Alert rule status: Running (monitoring), Disabled (disabled)\n", "type": "string" }, "tags": { "description": "Tag\n", "items": { "$ref": "#/types/volcenginecc:vmp/getAlertingRuleTag:getAlertingRuleTag" }, "type": "array" }, "type": { "description": "Alert rule type. Allowed values: vmp/PromQL\n", "type": "string" }, "updateTime": { "description": "Alert rule update time\n", "type": "string" } }, "required": [ "alertingRuleId", "annotations", "createTime", "description", "id", "labels", "levels", "name", "notifyGroupPolicyId", "notifyPolicyId", "query", "status", "tags", "type", "updateTime" ], "type": "object" } }, "volcenginecc:vmp/getAlertingRules:getAlertingRules": { "description": "Plural Data Source schema for Volcengine::VMP::AlertingRule\n", "outputs": { "description": "A collection of values returned by getAlertingRules.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vmp/getWorkspace:getWorkspace": { "description": "Data Source schema for Volcengine::VMP::Workspace\n", "inputs": { "description": "A collection of arguments for invoking getWorkspace.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getWorkspace.\n", "properties": { "authType": { "description": "Workspace authentication type. Options: BasicAuth: Basic authentication, requires Username and Password for authentication. BearerToken: Token authentication, requires BearerToken for authentication. None: No custom authentication required. Note: When the authentication type is set to None, AK/SK authentication is used by default.\n", "type": "string" }, "bearerToken": { "description": "Workspace Bearer Token. Note: Configure this parameter only when the AuthType parameter is set to BearerToken.\n", "type": "string" }, "createTime": { "description": "Workspace creation time, RFC3339 format\n", "type": "string" }, "deleteProtectionEnabled": { "description": "Enable workspace deletion protection: true for enabled, false for disabled\n", "type": "boolean" }, "description": { "description": "Workspace description, string, length limit 0–200\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceType": { "$ref": "#/types/volcenginecc:vmp/getWorkspaceInstanceType:getWorkspaceInstanceType", "description": "Workspace specification details\n" }, "instanceTypeId": { "description": "Workspace specifications: vmp.standard.15d: workspace with 15 days storage duration. vmp.standard.30d: workspace with 30 days storage duration. vmp.standard.90d: workspace with 90 days storage duration. vmp.standard.180d: workspace with 180 days storage duration. vmp.standard.1y: workspace with 1 year storage duration\n", "type": "string" }, "name": { "description": "Workspace name, string, length limit 1–100\n", "type": "string" }, "overdueReclaimTime": { "description": "Workspace expected overdue recovery time, RFC3339 format\n", "type": "string" }, "password": { "description": "Workspace BasicAuth password\n", "type": "string" }, "projectName": { "description": "Project name\n", "type": "string" }, "prometheusPushEndpoint": { "description": "Workspace public Push Gateway URL address.\n", "type": "string" }, "prometheusPushIntranetEndpoint": { "description": "Workspace Push Gateway URL address\n", "type": "string" }, "prometheusQueryEndpoint": { "description": "Workspace public Query URL address.\n", "type": "string" }, "prometheusQueryIntranetEndpoint": { "description": "Workspace Query URL address\n", "type": "string" }, "prometheusWriteEndpoint": { "description": "Workspace public RemoteWrite URL address.\n", "type": "string" }, "prometheusWriteIntranetEndpoint": { "description": "Workspace RemoteWrite URL address\n", "type": "string" }, "publicAccessEnabled": { "description": "Whether to enable workspace public access capability. true: enabled, false: disabled.\n", "type": "boolean" }, "publicQueryBandwidth": { "description": "Workspace public Query bandwidth (Mbps).\n", "type": "integer" }, "publicWriteBandwidth": { "description": "Workspace public RemoteWrite bandwidth (Mbps).\n", "type": "integer" }, "quota": { "$ref": "#/types/volcenginecc:vmp/getWorkspaceQuota:getWorkspaceQuota", "description": "Workspace quota details\n" }, "searchLatencyOffset": { "description": "Workspace public Query search latency offset.\n", "type": "string" }, "status": { "description": "Workspace status. Values: Creating: creating Active: active Updating: updating Deleting: deleting OverdueShutted: overdue shutdown Resuming: resuming Error: error\n", "type": "string" }, "tags": { "description": "Workspace tags\n", "items": { "$ref": "#/types/volcenginecc:vmp/getWorkspaceTag:getWorkspaceTag" }, "type": "array" }, "usage": { "$ref": "#/types/volcenginecc:vmp/getWorkspaceUsage:getWorkspaceUsage", "description": "Workspace usage\n" }, "username": { "description": "Workspace BasicAuth username\n", "type": "string" }, "workspaceId": { "description": "Workspace ID\n", "type": "string" } }, "required": [ "authType", "bearerToken", "createTime", "deleteProtectionEnabled", "description", "id", "instanceType", "instanceTypeId", "name", "overdueReclaimTime", "password", "projectName", "prometheusPushEndpoint", "prometheusPushIntranetEndpoint", "prometheusQueryEndpoint", "prometheusQueryIntranetEndpoint", "prometheusWriteEndpoint", "prometheusWriteIntranetEndpoint", "publicAccessEnabled", "publicQueryBandwidth", "publicWriteBandwidth", "quota", "searchLatencyOffset", "status", "tags", "usage", "username", "workspaceId" ], "type": "object" } }, "volcenginecc:vmp/getWorkspaces:getWorkspaces": { "description": "Plural Data Source schema for Volcengine::VMP::Workspace\n", "outputs": { "description": "A collection of values returned by getWorkspaces.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getBandwidthPackage:getBandwidthPackage": { "description": "Data Source schema for Volcengine::VPC::BandwidthPackage\n", "inputs": { "description": "A collection of arguments for invoking getBandwidthPackage.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getBandwidthPackage.\n", "properties": { "bandwidth": { "description": "Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.\n", "type": "integer" }, "bandwidthPackageId": { "description": "Bandwidth package ID\n", "type": "string" }, "bandwidthPackageName": { "description": "Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).\n", "type": "string" }, "billingType": { "description": "Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).\n", "type": "integer" }, "businessStatus": { "description": "Billing status\n", "type": "string" }, "createdTime": { "description": "Creation time\n", "type": "string" }, "deletedTime": { "description": "Deletion time\n", "type": "string" }, "description": { "description": "Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n", "type": "string" }, "eipAddresses": { "description": "List of public IP information added to the shared bandwidth package. All of the following conditions must be met: 1. All IPs have the same line type. 2. All IPs have the same security protection type. 3. All IPs are in the same region. 4. Public IP or IPv6 public bandwidth is billed by usage.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getBandwidthPackageEipAddress:getBandwidthPackageEipAddress" }, "type": "array" }, "enableDualStack": { "description": "Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.\n", "type": "boolean" }, "expiredTime": { "description": "Expiration time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "isp": { "description": "Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLine*BGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use Premium*BGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use Fusion*BGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobile*Value: China Mobile economical static single line. 5.2, ChinaUnicom*Value: China Unicom economical static single line. 5.3, ChinaTelecom*Value: China Telecom economical static single line.\n", "type": "string" }, "overdueTime": { "description": "Overdue time\n", "type": "string" }, "period": { "description": "Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.\n", "type": "integer" }, "periodUnit": { "description": "Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.\n", "type": "integer" }, "projectName": { "description": "Project name. If not specified, added to the default project.\n", "type": "string" }, "protocol": { "description": "IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.\n", "type": "string" }, "ratio": { "description": "95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.\n", "type": "integer" }, "securityProtectionTypes": { "description": "Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.\n", "items": { "type": "string" }, "type": "array" }, "status": { "description": "Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.\n", "type": "string" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getBandwidthPackageTag:getBandwidthPackageTag" }, "type": "array" }, "updatedTime": { "description": "Update time\n", "type": "string" } }, "required": [ "bandwidth", "bandwidthPackageId", "bandwidthPackageName", "billingType", "businessStatus", "createdTime", "deletedTime", "description", "eipAddresses", "enableDualStack", "expiredTime", "id", "isp", "overdueTime", "period", "periodUnit", "projectName", "protocol", "ratio", "securityProtectionTypes", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:vpc/getBandwidthPackages:getBandwidthPackages": { "description": "Plural Data Source schema for Volcengine::VPC::BandwidthPackage\n", "outputs": { "description": "A collection of values returned by getBandwidthPackages.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getEip:getEip": { "description": "Data Source schema for Volcengine::VPC::EIP\n", "inputs": { "description": "A collection of arguments for invoking getEip.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getEip.\n", "properties": { "allocationId": { "description": "Public IP ID.\n", "type": "string" }, "bandwidth": { "description": "Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.\n", "type": "integer" }, "bandwidthPackageId": { "description": "Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.\n", "type": "string" }, "billingType": { "description": "Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.\n", "type": "integer" }, "businessStatus": { "description": "Whether the public IP is locked. Normal: normal. FinancialLocked: locked.\n", "type": "string" }, "createdTime": { "description": "Creation time of the public IP.\n", "type": "string" }, "deletedTime": { "description": "Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.\n", "type": "string" }, "description": { "description": "Description of the public IP.\n", "type": "string" }, "directMode": { "description": "Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.\n", "type": "boolean" }, "eipAddress": { "description": "Public IP address.\n", "type": "string" }, "expiredTime": { "description": "Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Currently bound instance ID.\n", "type": "string" }, "instanceType": { "description": "Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.\n", "type": "string" }, "ipAddress": { "description": "Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address\n", "type": "string" }, "ipAddressPoolId": { "description": "IP address pool ID.\n", "type": "string" }, "isBlocked": { "description": "Whether it is blocked. true: yes. false: no.\n", "type": "boolean" }, "isp": { "description": "Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLine*BGP: BGP single line. Fusion*BGP: Fusion BGP. ChinaMobile*Value: China Mobile Value static single line. ChinaUnicom*Value: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.\n", "type": "string" }, "lockReason": { "description": "Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.\n", "type": "string" }, "name": { "description": "Name of the public IP.\n", "type": "string" }, "overdueTime": { "description": "Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.\n", "type": "string" }, "period": { "description": "When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.\n", "type": "integer" }, "periodUnit": { "description": "Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.\n", "type": "integer" }, "privateIpAddress": { "description": "Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the public IP belongs.\n", "type": "string" }, "releaseWithInstance": { "description": "Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.\n", "type": "boolean" }, "renewPeriodTimes": { "description": "Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.\n", "type": "integer" }, "renewType": { "description": "Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.\n", "type": "integer" }, "securityProtectionInstanceId": { "description": "DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.\n", "type": "integer" }, "securityProtectionTypes": { "description": "Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.\n", "items": { "type": "string" }, "type": "array" }, "serviceManaged": { "description": "Managed by service\n", "type": "boolean" }, "status": { "description": "Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.\n", "type": "string" }, "tags": { "description": "Tag information of the public IP\n", "items": { "$ref": "#/types/volcenginecc:vpc/getEipTag:getEipTag" }, "type": "array" }, "updatedTime": { "description": "Time when the public IP was updated.\n", "type": "string" } }, "required": [ "allocationId", "bandwidth", "bandwidthPackageId", "billingType", "businessStatus", "createdTime", "deletedTime", "description", "directMode", "eipAddress", "expiredTime", "id", "instanceId", "instanceType", "ipAddress", "ipAddressPoolId", "isBlocked", "isp", "lockReason", "name", "overdueTime", "period", "periodUnit", "privateIpAddress", "projectName", "releaseWithInstance", "renewPeriodTimes", "renewType", "securityProtectionInstanceId", "securityProtectionTypes", "serviceManaged", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:vpc/getEips:getEips": { "description": "Plural Data Source schema for Volcengine::VPC::EIP\n", "outputs": { "description": "A collection of values returned by getEips.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getEni:getEni": { "description": "Data Source schema for Volcengine::VPC::ENI\n", "inputs": { "description": "A collection of arguments for invoking getEni.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getEni.\n", "properties": { "accountId": { "description": "NIC owner ID\n", "type": "string" }, "createdTime": { "description": "NIC creation time\n", "type": "string" }, "deleteOnTermination": { "description": "Enable release with cloud server instance deletion. true to enable, false to disable\n", "type": "boolean" }, "description": { "description": "Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). If not specified, defaults to an empty string.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty\n", "type": "string" }, "ipv6AddressCount": { "description": "Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.\n", "type": "integer" }, "ipv6Sets": { "description": "IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].\n", "items": { "type": "string" }, "type": "array" }, "macAddress": { "description": "MAC address of the network interface.\n", "type": "string" }, "networkInterfaceId": { "description": "Network interface ID.\n", "type": "string" }, "networkInterfaceName": { "description": "NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC\n", "type": "string" }, "portSecurityEnabled": { "description": "Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)\n", "type": "boolean" }, "primaryIpAddress": { "$ref": "#/types/volcenginecc:vpc/getEniPrimaryIpAddress:getEniPrimaryIpAddress", "description": "Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.\n" }, "privateIpSets": { "description": "List of private IPv4 addresses for the network interface.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getEniPrivateIpSet:getEniPrivateIpSet" }, "type": "array" }, "projectName": { "description": "Name of the project to which the NIC belongs\n", "type": "string" }, "secondaryPrivateIpAddressCount": { "description": "Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.\n", "type": "integer" }, "securityGroupIds": { "description": "ID of one or more security groups joined by the auxiliary network interface.\n", "items": { "type": "string" }, "type": "array" }, "serviceManaged": { "description": "Indicates whether this is an official service network interface. true for yes, false for no.\n", "type": "boolean" }, "status": { "description": "Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.\n", "type": "string" }, "subnetId": { "description": "ID of the subnet where the auxiliary network interface resides.\n", "type": "string" }, "tags": { "description": "Tags.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getEniTag:getEniTag" }, "type": "array" }, "type": { "description": "NIC type. primary: primary NIC, secondary: secondary NIC\n", "type": "string" }, "updatedTime": { "description": "NIC update time\n", "type": "string" }, "vpcId": { "description": "ID of the VPC to which the network interface belongs.\n", "type": "string" }, "vpcName": { "description": "Name of the VPC to which the NIC belongs\n", "type": "string" }, "zoneId": { "description": "ID of the availability zone to which the network interface belongs.\n", "type": "string" } }, "required": [ "accountId", "createdTime", "deleteOnTermination", "description", "id", "instanceId", "ipv6AddressCount", "ipv6Sets", "macAddress", "networkInterfaceId", "networkInterfaceName", "portSecurityEnabled", "primaryIpAddress", "privateIpSets", "projectName", "secondaryPrivateIpAddressCount", "securityGroupIds", "serviceManaged", "status", "subnetId", "tags", "type", "updatedTime", "vpcId", "vpcName", "zoneId" ], "type": "object" } }, "volcenginecc:vpc/getEnis:getEnis": { "description": "Plural Data Source schema for Volcengine::VPC::ENI\n", "outputs": { "description": "A collection of values returned by getEnis.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getFlowLog:getFlowLog": { "description": "Data Source schema for Volcengine::VPC::FlowLog\n", "inputs": { "description": "A collection of arguments for invoking getFlowLog.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getFlowLog.\n", "properties": { "aggregationInterval": { "description": "Stream log sampling interval. Options: 1: 1 minute. 5: 5 minutes. 10 (default): 10 minutes.\n", "type": "integer" }, "businessStatus": { "description": "Whether the flow log is locked. Normal: normal. FinancialLocked: locked.\n", "type": "string" }, "createdAt": { "description": "Creation time of the flow log.\n", "type": "string" }, "description": { "description": "Description of the stream log. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).\n", "type": "string" }, "enableIndex": { "description": "Whether to automatically configure indexes. Indexes are used for retrieving and analyzing data. Stream logs must have indexes configured before retrieval and analysis. true: Yes. false (default): No.\n", "type": "boolean" }, "flowLogId": { "description": "Stream log ID.\n", "type": "string" }, "flowLogName": { "description": "Name of the flow log. Length must be 1–128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the flow log instance ID.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lockReason": { "description": "Reason for stream log lock. financial: Locked due to overdue payment. unlock: In the process of restoring after payment following suspension due to overdue payment. Empty value: Not locked.\n", "type": "string" }, "logProjectId": { "description": "Flow log project ID.\n", "type": "string" }, "logProjectName": { "description": "Name of the flow log project. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number. The name must be 3–63 characters long.\n", "type": "string" }, "logTopicId": { "description": "Flow log topic ID.\n", "type": "string" }, "logTopicName": { "description": "Name of the flow log project. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number. The name must be 3–63 characters long.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the flow log belongs.\n", "type": "string" }, "resourceId": { "description": "Resource ID for traffic capture.\n", "type": "string" }, "resourceType": { "description": "Resource type for traffic collection. Values: vpc: Virtual Private Cloud. subnet: subnet. eni: network interface.\n", "type": "string" }, "status": { "description": "Status of the flow log. Values: Active: active. Pending: pending. Inactive: inactive. Creating: creating. Deleting: deleting.\n", "type": "string" }, "tags": { "description": "Tag information for the flow log.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getFlowLogTag:getFlowLogTag" }, "type": "array" }, "trafficType": { "description": "Type of traffic collected. Values: All: all traffic. Allow: traffic allowed by network ACLs and security groups. Drop: traffic denied by network ACLs and security groups.\n", "type": "string" }, "updatedAt": { "description": "Time when the stream log was updated.\n", "type": "string" }, "vpcId": { "description": "VPC ID for the flow log.\n", "type": "string" } }, "required": [ "aggregationInterval", "businessStatus", "createdAt", "description", "enableIndex", "flowLogId", "flowLogName", "id", "lockReason", "logProjectId", "logProjectName", "logTopicId", "logTopicName", "projectName", "resourceId", "resourceType", "status", "tags", "trafficType", "updatedAt", "vpcId" ], "type": "object" } }, "volcenginecc:vpc/getFlowLogs:getFlowLogs": { "description": "Plural Data Source schema for Volcengine::VPC::FlowLog\n", "outputs": { "description": "A collection of values returned by getFlowLogs.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getHaVip:getHaVip": { "description": "Data Source schema for Volcengine::VPC::HAVIP\n", "inputs": { "description": "A collection of arguments for invoking getHaVip.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getHaVip.\n", "properties": { "associatedEipAddress": { "description": "IP address of the public IP bound to the HAVIP\n", "type": "string" }, "associatedEipId": { "description": "ID of the public IP bound to the HAVIP\n", "type": "string" }, "associatedInstanceIds": { "description": "List of instance IDs bound to the HAVIP\n", "items": { "type": "string" }, "type": "array" }, "associatedInstanceType": { "description": "Instance type bound to the HAVIP. EcsInstance: cloud server instance. NetworkInterface: elastic network interface\n", "type": "string" }, "createdAt": { "description": "Creation time of the HAVIP\n", "type": "string" }, "description": { "description": "Description of the HAVIP. Length limit: 0–255 characters\n", "type": "string" }, "haVipId": { "description": "ID of the HAVIP\n", "type": "string" }, "haVipName": { "description": "Name of the HAVIP. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 0–128 characters\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAddress": { "description": "IP address of the HAVIP\n", "type": "string" }, "masterInstanceId": { "description": "ID of the primary instance bound to the HAVIP\n", "type": "string" }, "projectName": { "description": "Project name of the HAVIP\n", "type": "string" }, "status": { "description": "Status of the HAVIP. Available: available. Creating: creating. InUse: in use. Deleting: deleting\n", "type": "string" }, "subnetId": { "description": "Subnet ID to which the HAVIP belongs\n", "type": "string" }, "tags": { "description": "Tags associated with the HAVIP\n", "items": { "$ref": "#/types/volcenginecc:vpc/getHaVipTag:getHaVipTag" }, "type": "array" }, "updatedAt": { "description": "Last modification time of the HAVIP\n", "type": "string" }, "vpcId": { "description": "VPC ID to which the HAVIP belongs\n", "type": "string" } }, "required": [ "associatedEipAddress", "associatedEipId", "associatedInstanceIds", "associatedInstanceType", "createdAt", "description", "haVipId", "haVipName", "id", "ipAddress", "masterInstanceId", "projectName", "status", "subnetId", "tags", "updatedAt", "vpcId" ], "type": "object" } }, "volcenginecc:vpc/getHaVips:getHaVips": { "description": "Plural Data Source schema for Volcengine::VPC::HAVIP\n", "outputs": { "description": "A collection of values returned by getHaVips.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getIpv6AddressBandwidth:getIpv6AddressBandwidth": { "description": "Data Source schema for Volcengine::VPC::Ipv6AddressBandwidth\n", "inputs": { "description": "A collection of arguments for invoking getIpv6AddressBandwidth.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getIpv6AddressBandwidth.\n", "properties": { "allocationId": { "description": "IPv6 public bandwidth ID\n", "type": "string" }, "bandwidth": { "description": "IPv6 public bandwidth cap\n", "type": "integer" }, "bandwidthPackageId": { "description": "IPv6 shared bandwidth package ID\n", "type": "string" }, "billingType": { "description": "IPv6 public bandwidth billing type. 2: Pay-as-you-go - billed by bandwidth cap. 3: Pay-as-you-go - billed by actual traffic.\n", "type": "integer" }, "businessStatus": { "description": "Whether IPv6 public bandwidth is locked. Normal: Normal. FinancialLocked: Locked.\n", "type": "string" }, "createdTime": { "description": "IPv6 public bandwidth activation time\n", "type": "string" }, "deletedTime": { "description": "IPv6 public bandwidth deletion time\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Instance ID associated with IPv6 public bandwidth\n", "type": "string" }, "instanceType": { "description": "Instance type associated with IPv6 public bandwidth. EcsInstance: Cloud server instance. ClbInstance: Load balancer.\n", "type": "string" }, "ipv6Address": { "description": "IPv6 address\n", "type": "string" }, "ipv6GatewayId": { "description": "IPv6 gateway ID\n", "type": "string" }, "isp": { "description": "IPv6 public bandwidth line type. BGP: BGP (multi-line).\n", "type": "string" }, "lockReason": { "description": "Reason for IPv6 public bandwidth lock. This parameter is returned only when IPv6 public bandwidth is in FinancialLocked status. Financial: Locked due to overdue payment. Security: Locked due to security reasons.\n", "type": "string" }, "networkType": { "description": "IPv6 address communication type. Private: Private network communication type. Public: Public network communication type.\n", "type": "string" }, "overdueTime": { "description": "IPv6 public bandwidth deactivation time due to overdue payment\n", "type": "string" }, "projectName": { "description": "IPv6 public bandwidth project\n", "type": "string" }, "serviceManaged": { "description": "Service hosting status\n", "type": "boolean" }, "status": { "description": "IPv6 public bandwidth status. Creating: Creating. Available: Available.\n", "type": "string" }, "tags": { "description": "Tag information\n", "items": { "$ref": "#/types/volcenginecc:vpc/getIpv6AddressBandwidthTag:getIpv6AddressBandwidthTag" }, "type": "array" }, "updatedTime": { "description": "IPv6 public bandwidth last operation time\n", "type": "string" } }, "required": [ "allocationId", "bandwidth", "bandwidthPackageId", "billingType", "businessStatus", "createdTime", "deletedTime", "id", "instanceId", "instanceType", "ipv6Address", "ipv6GatewayId", "isp", "lockReason", "networkType", "overdueTime", "projectName", "serviceManaged", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:vpc/getIpv6AddressBandwidths:getIpv6AddressBandwidths": { "description": "Plural Data Source schema for Volcengine::VPC::Ipv6AddressBandwidth\n", "outputs": { "description": "A collection of values returned by getIpv6AddressBandwidths.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getIpv6Gateway:getIpv6Gateway": { "description": "Data Source schema for Volcengine::VPC::Ipv6Gateway\n", "inputs": { "description": "A collection of arguments for invoking getIpv6Gateway.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getIpv6Gateway.\n", "properties": { "createdTime": { "description": "Creation time of the IPv6 gateway instance\n", "type": "string" }, "description": { "description": "Description of the IPv6 gateway instance. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。)\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipv6GatewayId": { "description": "IPv6 gateway instance ID\n", "type": "string" }, "name": { "description": "Name of the IPv6 gateway instance. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the IPv6 gateway ID\n", "type": "string" }, "projectName": { "description": "Name of the project to which the IPv6 gateway belongs\n", "type": "string" }, "routeTableId": { "description": "Route table ID associated with the IPv6 gateway instance\n", "type": "string" }, "status": { "description": "Operating status of the IPv6 gateway instance. Possible values: Creating: Creating. Deleting: Deleting. Available: Available\n", "type": "string" }, "tags": { "description": "Tag information\n", "items": { "$ref": "#/types/volcenginecc:vpc/getIpv6GatewayTag:getIpv6GatewayTag" }, "type": "array" }, "updatedTime": { "description": "Modification time of the IPv6 gateway instance\n", "type": "string" }, "vpcId": { "description": "VPC ID to be associated with the IPv6 gateway instance. Each VPC can only be associated with one IPv6 gateway instance. Ensure the VPC to be associated is not linked to another IPv6 gateway instance\n", "type": "string" } }, "required": [ "createdTime", "description", "id", "ipv6GatewayId", "name", "projectName", "routeTableId", "status", "tags", "updatedTime", "vpcId" ], "type": "object" } }, "volcenginecc:vpc/getIpv6Gateways:getIpv6Gateways": { "description": "Plural Data Source schema for Volcengine::VPC::Ipv6Gateway\n", "outputs": { "description": "A collection of values returned by getIpv6Gateways.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getNetworkAcl:getNetworkAcl": { "description": "Data Source schema for Volcengine::VPC::NetworkAcl\n", "inputs": { "description": "A collection of arguments for invoking getNetworkAcl.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getNetworkAcl.\n", "properties": { "createdTime": { "description": "Creation time of the network ACL.\n", "type": "string" }, "defaultEgressAclEntries": { "description": "Default outbound ACL rule list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getNetworkAclDefaultEgressAclEntry:getNetworkAclDefaultEgressAclEntry" }, "type": "array" }, "defaultIngressAclEntries": { "description": "Default inbound ACL rule list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getNetworkAclDefaultIngressAclEntry:getNetworkAclDefaultIngressAclEntry" }, "type": "array" }, "description": { "description": "Network ACL description. Length must be 0–255 characters. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).\n", "type": "string" }, "egressAclEntries": { "description": "Outbound ACL rule list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getNetworkAclEgressAclEntry:getNetworkAclEgressAclEntry" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ingressAclEntries": { "description": "Inbound ACL rule list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getNetworkAclIngressAclEntry:getNetworkAclIngressAclEntry" }, "type": "array" }, "networkAclId": { "description": "Network ACL ID.\n", "type": "string" }, "networkAclName": { "description": "Network ACL name. Length must be 1–128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-).\n", "type": "string" }, "projectName": { "description": "Name of the project associated with the network ACL. If not specified, added to the default project.\n", "type": "string" }, "resources": { "description": "Associated resource list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getNetworkAclResource:getNetworkAclResource" }, "type": "array" }, "status": { "description": "Status of the network ACL. Available: Available. Creating: Creating.\n", "type": "string" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getNetworkAclTag:getNetworkAclTag" }, "type": "array" }, "updatedTime": { "description": "Last updated time of the network ACL.\n", "type": "string" }, "vpcId": { "description": "ID of the VPC associated with the network ACL.\n", "type": "string" } }, "required": [ "createdTime", "defaultEgressAclEntries", "defaultIngressAclEntries", "description", "egressAclEntries", "id", "ingressAclEntries", "networkAclId", "networkAclName", "projectName", "resources", "status", "tags", "updatedTime", "vpcId" ], "type": "object" } }, "volcenginecc:vpc/getNetworkAcls:getNetworkAcls": { "description": "Plural Data Source schema for Volcengine::VPC::NetworkAcl\n", "outputs": { "description": "A collection of values returned by getNetworkAcls.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getPrefixList:getPrefixList": { "description": "Data Source schema for Volcengine::VPC::PrefixList\n", "inputs": { "description": "A collection of arguments for invoking getPrefixList.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getPrefixList.\n", "properties": { "associationCount": { "description": "Number of resources associated with the prefix list.\n", "type": "integer" }, "associationsRouteTables": { "description": "Route table information associated with the prefix list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getPrefixListAssociationsRouteTable:getPrefixListAssociationsRouteTable" }, "type": "array" }, "associationsSecurityGroups": { "description": "Security group information associated with the prefix list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getPrefixListAssociationsSecurityGroup:getPrefixListAssociationsSecurityGroup" }, "type": "array" }, "createdTime": { "description": "Creation time of the prefix list.\n", "type": "string" }, "description": { "description": "Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipVersion": { "description": "IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.\n", "type": "string" }, "maxEntries": { "description": "Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.\n", "type": "integer" }, "prefixListEntries": { "description": "CIDR of the prefix list entry.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getPrefixListPrefixListEntry:getPrefixListPrefixListEntry" }, "type": "array" }, "prefixListId": { "description": "Prefix list ID.\n", "type": "string" }, "prefixListName": { "description": "Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).\n", "type": "string" }, "projectName": { "description": "Name of the project to which the prefix list belongs. If not specified, it is added to the default project.\n", "type": "string" }, "status": { "description": "Status of the prefix list. Values: Available: available; Creating: creating; Deleting: deleting; Pending: modifying.\n", "type": "string" }, "tags": { "description": "Tag list.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getPrefixListTag:getPrefixListTag" }, "type": "array" }, "updatedTime": { "description": "Last modification time of the prefix list.\n", "type": "string" } }, "required": [ "associationCount", "associationsRouteTables", "associationsSecurityGroups", "createdTime", "description", "id", "ipVersion", "maxEntries", "prefixListEntries", "prefixListId", "prefixListName", "projectName", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:vpc/getPrefixLists:getPrefixLists": { "description": "Plural Data Source schema for Volcengine::VPC::PrefixList\n", "outputs": { "description": "A collection of values returned by getPrefixLists.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getRouteTable:getRouteTable": { "description": "Data Source schema for Volcengine::VPC::RouteTable\n", "inputs": { "description": "A collection of arguments for invoking getRouteTable.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getRouteTable.\n", "properties": { "accountId": { "description": "Account ID owning the route table\n", "type": "string" }, "associateType": { "description": "Association type for route table creation input. 1. Subnet: Subnet association 2. Gateway: Gateway association\n", "type": "string" }, "createdTime": { "description": "Route Table Creation Time\n", "type": "string" }, "customRouteEntries": { "description": "List of custom route entries associated with the route table\n", "items": { "$ref": "#/types/volcenginecc:vpc/getRouteTableCustomRouteEntry:getRouteTableCustomRouteEntry" }, "type": "array" }, "description": { "description": "Route Table Description\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipv4GatewayId": { "description": "IPv4 Gateway ID associated with the route table\n", "type": "string" }, "ipv6GatewayId": { "description": "IPv6 Gateway ID associated with the route table\n", "type": "string" }, "projectName": { "description": "Name of the project owning the route table\n", "type": "string" }, "routeTableId": { "description": "Route Table ID\n", "type": "string" }, "routeTableName": { "description": "Route Table Name\n", "type": "string" }, "routeTableType": { "description": "Route table type. 1. Custom: Custom route table 2. System: System route table\n", "type": "string" }, "subnetIds": { "description": "List of associated subnet IDs\n", "items": { "type": "string" }, "type": "array" }, "systemRouteEntries": { "description": "List of system default route entries associated with the route table\n", "items": { "$ref": "#/types/volcenginecc:vpc/getRouteTableSystemRouteEntry:getRouteTableSystemRouteEntry" }, "type": "array" }, "tags": { "description": "Tag List\n", "items": { "$ref": "#/types/volcenginecc:vpc/getRouteTableTag:getRouteTableTag" }, "type": "array" }, "updatedTime": { "description": "Route Table Last Updated Time\n", "type": "string" }, "vpcId": { "description": "ID of the VPC owning the route table\n", "type": "string" }, "vpcName": { "description": "VPC Name\n", "type": "string" } }, "required": [ "accountId", "associateType", "createdTime", "customRouteEntries", "description", "id", "ipv4GatewayId", "ipv6GatewayId", "projectName", "routeTableId", "routeTableName", "routeTableType", "subnetIds", "systemRouteEntries", "tags", "updatedTime", "vpcId", "vpcName" ], "type": "object" } }, "volcenginecc:vpc/getRouteTables:getRouteTables": { "description": "Plural Data Source schema for Volcengine::VPC::RouteTable\n", "outputs": { "description": "A collection of values returned by getRouteTables.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getSecurityGroup:getSecurityGroup": { "description": "Data Source schema for Volcengine::VPC::SecurityGroup\n", "inputs": { "description": "A collection of arguments for invoking getSecurityGroup.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSecurityGroup.\n", "properties": { "creationTime": { "description": "Security group creation time\n", "type": "string" }, "description": { "description": "Description of the security group. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). If not specified, defaults to an empty string\n", "type": "string" }, "egressPermissions": { "description": "Description for outbound security group rule. Unchanged information is returned as original; unfilled or changed content is considered modified. Please fill in as needed\n", "items": { "$ref": "#/types/volcenginecc:vpc/getSecurityGroupEgressPermission:getSecurityGroupEgressPermission" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ingressPermissions": { "description": "Description for inbound security group rule. Unchanged information is returned as original; unfilled or changed content is considered modified. Please fill in as needed\n", "items": { "$ref": "#/types/volcenginecc:vpc/getSecurityGroupIngressPermission:getSecurityGroupIngressPermission" }, "type": "array" }, "projectName": { "description": "Project name to which the security group belongs. Default project is 'default' if not specified\n", "type": "string" }, "securityGroupId": { "description": "Security group ID\n", "type": "string" }, "securityGroupName": { "description": "Security group name. Length: 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Default is security group ID if not specified\n", "type": "string" }, "serviceManaged": { "description": "Indicates whether the security group is managed. true means managed security group, false means unmanaged security group\n", "type": "boolean" }, "status": { "description": "Security group status. Available means available for use, Creating means being created\n", "type": "string" }, "tags": { "description": "Tag list\n", "items": { "$ref": "#/types/volcenginecc:vpc/getSecurityGroupTag:getSecurityGroupTag" }, "type": "array" }, "type": { "description": "Security group type. 1. default: default security group. 2. normal: custom security group. 3. VpnGW: VPN gateway security group. 4. NatGW: NAT gateway security group. 5. cidr_only: CIDR-Only security group\n", "type": "string" }, "vpcId": { "description": "VPC ID to which the security group belongs\n", "type": "string" } }, "required": [ "creationTime", "description", "egressPermissions", "id", "ingressPermissions", "projectName", "securityGroupId", "securityGroupName", "serviceManaged", "status", "tags", "type", "vpcId" ], "type": "object" } }, "volcenginecc:vpc/getSecurityGroups:getSecurityGroups": { "description": "Plural Data Source schema for Volcengine::VPC::SecurityGroup\n", "outputs": { "description": "A collection of values returned by getSecurityGroups.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getSubnet:getSubnet": { "description": "Data Source schema for Volcengine::VPC::Subnet\n", "inputs": { "description": "A collection of arguments for invoking getSubnet.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSubnet.\n", "properties": { "accountId": { "description": "ID of the account to which the subnet belongs\n", "type": "string" }, "availableIpAddressCount": { "description": "Number of available IP addresses in the subnet\n", "type": "integer" }, "cidrBlock": { "description": "Subnet IPv4 CIDR block\n", "type": "string" }, "createdTime": { "description": "Subnet creation time\n", "type": "string" }, "description": { "description": "Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Cannot start with http:// or https://\n", "type": "string" }, "enableIpv6": { "description": "Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses\n", "type": "boolean" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipv6CidrBlock": { "description": "Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64\n", "type": "string" }, "isDefault": { "description": "Whether the subnet is a default subnet. 1. true: Default subnet, created automatically when an ECS instance is created. 2. false: Non-default subnet, created manually by the user\n", "type": "boolean" }, "networkAclId": { "description": "ID of the network ACL associated with the subnet\n", "type": "string" }, "projectName": { "description": "Name of the project associated with the VPC instance where the subnet resides\n", "type": "string" }, "readIpv6CidrBlock": { "description": "Read-only field, subnet IPv6 CIDR block\n", "type": "string" }, "routeTable": { "$ref": "#/types/volcenginecc:vpc/getSubnetRouteTable:getSubnetRouteTable", "description": "Route table information\n" }, "status": { "description": "Subnet status. 1. Pending: Configuring. 2. Available: Available\n", "type": "string" }, "subnetId": { "description": "ID of the subnet whose information is to be modified\n", "type": "string" }, "subnetName": { "description": "Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID\n", "type": "string" }, "tags": { "description": "Subnet tag information\n", "items": { "$ref": "#/types/volcenginecc:vpc/getSubnetTag:getSubnetTag" }, "type": "array" }, "totalIpv4Count": { "description": "Total number of available IPs in the subnet\n", "type": "integer" }, "updatedTime": { "description": "Subnet update time\n", "type": "string" }, "vpcId": { "description": "ID of the VPC to which the subnet belongs\n", "type": "string" }, "zoneId": { "description": "Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones\n", "type": "string" } }, "required": [ "accountId", "availableIpAddressCount", "cidrBlock", "createdTime", "description", "enableIpv6", "id", "ipv6CidrBlock", "isDefault", "networkAclId", "projectName", "readIpv6CidrBlock", "routeTable", "status", "subnetId", "subnetName", "tags", "totalIpv4Count", "updatedTime", "vpcId", "zoneId" ], "type": "object" } }, "volcenginecc:vpc/getSubnets:getSubnets": { "description": "Plural Data Source schema for Volcengine::VPC::Subnet\n", "outputs": { "description": "A collection of values returned by getSubnets.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getTrafficMirrorFilter:getTrafficMirrorFilter": { "description": "Data Source schema for Volcengine::VPC::TrafficMirrorFilter\n", "inputs": { "description": "A collection of arguments for invoking getTrafficMirrorFilter.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTrafficMirrorFilter.\n", "properties": { "createdTime": { "description": "Filter condition creation time\n", "type": "string" }, "description": { "description": "Filter condition instance description\n", "type": "string" }, "egressFilterRules": { "description": "Outbound filter rule details\n", "items": { "$ref": "#/types/volcenginecc:vpc/getTrafficMirrorFilterEgressFilterRule:getTrafficMirrorFilterEgressFilterRule" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ingressFilterRules": { "description": "Inbound filter rule details\n", "items": { "$ref": "#/types/volcenginecc:vpc/getTrafficMirrorFilterIngressFilterRule:getTrafficMirrorFilterIngressFilterRule" }, "type": "array" }, "projectName": { "description": "Project name of the filter condition\n", "type": "string" }, "status": { "description": "Filter condition status\n", "type": "string" }, "tags": { "description": "Tag information\n", "items": { "$ref": "#/types/volcenginecc:vpc/getTrafficMirrorFilterTag:getTrafficMirrorFilterTag" }, "type": "array" }, "trafficMirrorFilterId": { "description": "Filter condition instance ID\n", "type": "string" }, "trafficMirrorFilterName": { "description": "Filter condition name\n", "type": "string" } }, "required": [ "createdTime", "description", "egressFilterRules", "id", "ingressFilterRules", "projectName", "status", "tags", "trafficMirrorFilterId", "trafficMirrorFilterName" ], "type": "object" } }, "volcenginecc:vpc/getTrafficMirrorFilterRule:getTrafficMirrorFilterRule": { "description": "Data Source schema for Volcengine::VPC::TrafficMirrorFilterRule\n", "inputs": { "description": "A collection of arguments for invoking getTrafficMirrorFilterRule.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTrafficMirrorFilterRule.\n", "properties": { "description": { "description": "Description of the filtering rule.\n", "type": "string" }, "destinationCidrBlock": { "description": "Destination network segment.\n", "type": "string" }, "destinationPortRange": { "description": "Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "policy": { "description": "Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.\n", "type": "string" }, "priority": { "description": "Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.\n", "type": "integer" }, "protocol": { "description": "Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.\n", "type": "string" }, "sourceCidrBlock": { "description": "Source network segment.\n", "type": "string" }, "sourcePortRange": { "description": "Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.\n", "type": "string" }, "status": { "description": "Status of the filtering rule. Available: available. Deleting: deleting. Creating: creating. Pending: modifying.\n", "type": "string" }, "trafficDirection": { "description": "Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.\n", "type": "string" }, "trafficMirrorFilterId": { "description": "Filtering condition ID.\n", "type": "string" }, "trafficMirrorFilterRuleId": { "description": "Filtering rule ID.\n", "type": "string" } }, "required": [ "description", "destinationCidrBlock", "destinationPortRange", "id", "policy", "priority", "protocol", "sourceCidrBlock", "sourcePortRange", "status", "trafficDirection", "trafficMirrorFilterId", "trafficMirrorFilterRuleId" ], "type": "object" } }, "volcenginecc:vpc/getTrafficMirrorFilterRules:getTrafficMirrorFilterRules": { "description": "Plural Data Source schema for Volcengine::VPC::TrafficMirrorFilterRule\n", "outputs": { "description": "A collection of values returned by getTrafficMirrorFilterRules.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getTrafficMirrorFilters:getTrafficMirrorFilters": { "description": "Plural Data Source schema for Volcengine::VPC::TrafficMirrorFilter\n", "outputs": { "description": "A collection of values returned by getTrafficMirrorFilters.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getTrafficMirrorSession:getTrafficMirrorSession": { "description": "Data Source schema for Volcengine::VPC::TrafficMirrorSession\n", "inputs": { "description": "A collection of arguments for invoking getTrafficMirrorSession.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTrafficMirrorSession.\n", "properties": { "businessStatus": { "description": "Session billing status. Normal: Billing in progress. - FinancialLocked: Locked due to overdue payment\n", "type": "string" }, "createdTime": { "description": "Creation time\n", "type": "string" }, "description": { "description": "Mirror session instance description\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "lockReason": { "description": "Lock reason\n", "type": "string" }, "networkInterfaceId": { "description": "Mirror source instance ID. Currently, only ECS primary and secondary network interfaces are supported\n", "type": "string" }, "packetLength": { "description": "Mirror session MTU. Values exceeding this will be truncated. Range: 64–9600\n", "type": "integer" }, "priority": { "description": "Mirror session priority. Range: 1–32766. Priority values must be unique within the same account\n", "type": "integer" }, "projectName": { "description": "Name of the associated project\n", "type": "string" }, "status": { "description": "Session status\n", "type": "string" }, "tags": { "description": "Tag information\n", "items": { "$ref": "#/types/volcenginecc:vpc/getTrafficMirrorSessionTag:getTrafficMirrorSessionTag" }, "type": "array" }, "trafficMirrorFilterId": { "description": "Filter condition instance ID\n", "type": "string" }, "trafficMirrorSessionId": { "description": "Mirror session instance ID\n", "type": "string" }, "trafficMirrorSessionName": { "description": "Mirror session name\n", "type": "string" }, "trafficMirrorSourceIds": { "description": "Mirror source instance list\n", "items": { "type": "string" }, "type": "array" }, "trafficMirrorTargetId": { "description": "Mirror destination instance ID\n", "type": "string" }, "virtualNetworkId": { "description": "Mirror session VNI. Range: 1–16777215\n", "type": "integer" } }, "required": [ "businessStatus", "createdTime", "description", "id", "lockReason", "networkInterfaceId", "packetLength", "priority", "projectName", "status", "tags", "trafficMirrorFilterId", "trafficMirrorSessionId", "trafficMirrorSessionName", "trafficMirrorSourceIds", "trafficMirrorTargetId", "virtualNetworkId" ], "type": "object" } }, "volcenginecc:vpc/getTrafficMirrorSessions:getTrafficMirrorSessions": { "description": "Plural Data Source schema for Volcengine::VPC::TrafficMirrorSession\n", "outputs": { "description": "A collection of values returned by getTrafficMirrorSessions.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getTrafficMirrorTarget:getTrafficMirrorTarget": { "description": "Data Source schema for Volcengine::VPC::TrafficMirrorTarget\n", "inputs": { "description": "A collection of arguments for invoking getTrafficMirrorTarget.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getTrafficMirrorTarget.\n", "properties": { "createdAt": { "description": "Creation time of the mirror session.\n", "type": "string" }, "description": { "description": "Listener description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, the default value is an empty string.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "instanceId": { "description": "Resource ID of the mirror target.\n", "type": "string" }, "instanceType": { "description": "Resource type of the mirror target. NetworkInterface: Elastic network interface. ClbInstance: Classic load balancer.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the mirror target belongs. If not specified, it will be added to the default project.\n", "type": "string" }, "status": { "description": "Status of the mirror target. Available: Available. Creating: Creating.\n", "type": "string" }, "tags": { "description": "Tag information of the mirror target.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getTrafficMirrorTargetTag:getTrafficMirrorTargetTag" }, "type": "array" }, "trafficMirrorTargetId": { "description": "ID of the mirror target.\n", "type": "string" }, "trafficMirrorTargetName": { "description": "Listener name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, the default is 'protocol-port' as the listener name.\n", "type": "string" }, "updatedAt": { "description": "Update time of the mirror session.\n", "type": "string" } }, "required": [ "createdAt", "description", "id", "instanceId", "instanceType", "projectName", "status", "tags", "trafficMirrorTargetId", "trafficMirrorTargetName", "updatedAt" ], "type": "object" } }, "volcenginecc:vpc/getTrafficMirrorTargets:getTrafficMirrorTargets": { "description": "Plural Data Source schema for Volcengine::VPC::TrafficMirrorTarget\n", "outputs": { "description": "A collection of values returned by getTrafficMirrorTargets.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpc/getVpc:getVpc": { "description": "Data Source schema for Volcengine::VPC::VPC\n", "inputs": { "description": "A collection of arguments for invoking getVpc.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getVpc.\n", "properties": { "accountId": { "description": "ID of the account to which the VPC belongs.\n", "type": "string" }, "associateCens": { "description": "CEN information associated with the VPC.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getVpcAssociateCen:getVpcAssociateCen" }, "type": "array" }, "cidrBlock": { "description": "IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.\n", "type": "string" }, "creationTime": { "description": "Time when the VPC was created.\n", "type": "string" }, "description": { "description": "Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.\n", "type": "string" }, "dnsServers": { "description": "DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use \u0026 to separate multiple IPs. If not specified, defaults to the system DNS server addresses.\n", "items": { "type": "string" }, "type": "array" }, "enableIpv6": { "description": "Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.\n", "type": "boolean" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipv4GatewayId": { "description": "ID of the IPv4 gateway bound to the VPC.\n", "type": "string" }, "ipv6CidrBlock": { "description": "IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.\n", "type": "string" }, "isDefault": { "description": "Whether this VPC is the default VPC. true: default VPC, meaning the VPC was automatically created by the system when creating an ECS instance. false: non-default VPC, meaning the VPC was manually created by the user.\n", "type": "boolean" }, "natGatewayIds": { "description": "ID of the NAT gateway created in the VPC.\n", "items": { "type": "string" }, "type": "array" }, "networkAclNum": { "description": "Number of network ACLs in the VPC.\n", "type": "string" }, "projectName": { "description": "Name of the project to which the VPC belongs. If not specified, it is added to the default project.\n", "type": "string" }, "routeTableIds": { "description": "ID of the route table associated with the VPC.\n", "items": { "type": "string" }, "type": "array" }, "secondaryCidrBlocks": { "description": "Secondary CIDR block of the VPC.\n", "items": { "type": "string" }, "type": "array" }, "securityGroupIds": { "description": "List of security groups in the VPC.\n", "items": { "type": "string" }, "type": "array" }, "status": { "description": "Status of the VPC. Creating: being created. Created: created. Available: available.\n", "type": "string" }, "subnetIds": { "description": "List of subnets in the VPC.\n", "items": { "type": "string" }, "type": "array" }, "supportIpv4Gateway": { "description": "Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.\n", "type": "boolean" }, "tags": { "description": "Tags bound to the private network.\n", "items": { "$ref": "#/types/volcenginecc:vpc/getVpcTag:getVpcTag" }, "type": "array" }, "updateTime": { "description": "Time when the VPC was updated.\n", "type": "string" }, "userCidrBlocks": { "description": "User CIDR block of the VPC.\n", "items": { "type": "string" }, "type": "array" }, "vpcId": { "description": "ID of the VPC.\n", "type": "string" }, "vpcName": { "description": "Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.\n", "type": "string" } }, "required": [ "accountId", "associateCens", "cidrBlock", "creationTime", "description", "dnsServers", "enableIpv6", "id", "ipv4GatewayId", "ipv6CidrBlock", "isDefault", "natGatewayIds", "networkAclNum", "projectName", "routeTableIds", "secondaryCidrBlocks", "securityGroupIds", "status", "subnetIds", "supportIpv4Gateway", "tags", "updateTime", "userCidrBlocks", "vpcId", "vpcName" ], "type": "object" } }, "volcenginecc:vpc/getVpcs:getVpcs": { "description": "Plural Data Source schema for Volcengine::VPC::VPC\n", "outputs": { "description": "A collection of values returned by getVpcs.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpn/getCustomerGateway:getCustomerGateway": { "description": "Data Source schema for Volcengine::VPN::CustomerGateway\n", "inputs": { "description": "A collection of arguments for invoking getCustomerGateway.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getCustomerGateway.\n", "properties": { "accountId": { "description": "ID of the account to which the user gateway belongs\n", "type": "string" }, "asn": { "description": "User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)\n", "type": "integer" }, "connectionCount": { "description": "Number of IPsec connections associated with the user gateway\n", "type": "integer" }, "createdTime": { "description": "Time when the user gateway was created\n", "type": "string" }, "customerGatewayId": { "description": "Gateway ID\n", "type": "string" }, "customerGatewayName": { "description": "User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID\n", "type": "string" }, "description": { "description": "Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAddress": { "description": "Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here\n", "type": "string" }, "ipVersion": { "description": "IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6\n", "type": "string" }, "projectName": { "description": "Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project\n", "type": "string" }, "status": { "description": "Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available\n", "type": "string" }, "tags": { "description": "Tag list\n", "items": { "$ref": "#/types/volcenginecc:vpn/getCustomerGatewayTag:getCustomerGatewayTag" }, "type": "array" }, "updatedTime": { "description": "Time when the user gateway was updated\n", "type": "string" } }, "required": [ "accountId", "asn", "connectionCount", "createdTime", "customerGatewayId", "customerGatewayName", "description", "id", "ipAddress", "ipVersion", "projectName", "status", "tags", "updatedTime" ], "type": "object" } }, "volcenginecc:vpn/getCustomerGateways:getCustomerGateways": { "description": "Plural Data Source schema for Volcengine::VPN::CustomerGateway\n", "outputs": { "description": "A collection of values returned by getCustomerGateways.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpn/getSslVpnClientCert:getSslVpnClientCert": { "description": "Data Source schema for Volcengine::VPN::SslVpnClientCert\n", "inputs": { "description": "A collection of arguments for invoking getSslVpnClientCert.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getSslVpnClientCert.\n", "properties": { "caCertificate": { "description": "CA certificate information.\n", "type": "string" }, "certificateStatus": { "description": "SSL client certificate status. Available: available; Expiring: expiring, displays this status when the expiration time is less than or equal to one week; Expired: expired.\n", "type": "string" }, "clientCertificate": { "description": "Client certificate information.\n", "type": "string" }, "clientKey": { "description": "Client key information.\n", "type": "string" }, "creationTime": { "description": "Creation time of the SSL client certificate.\n", "type": "string" }, "description": { "description": "Description of the SSL client certificate. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0–255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "expiredTime": { "description": "Expiration time of the SSL client certificate.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "openVpnClientConfig": { "description": "OpenVPN client configuration.\n", "type": "string" }, "sslVpnClientCertId": { "description": "SSL client certificate ID.\n", "type": "string" }, "sslVpnClientCertName": { "description": "Name of the SSL client certificate. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1–128 characters. If not specified, defaults to the SSL client certificate ID.\n", "type": "string" }, "sslVpnServerId": { "description": "ID of the SSL server used to create the SSL client certificate. You can call DescribeSslVpnServers to query the SSL server ID information.\n", "type": "string" }, "status": { "description": "SSL client status. Creating: being created; Deleting: being deleted; Pending: being configured; Available: available.\n", "type": "string" }, "tags": { "description": "SSL client certificate tags.\n", "items": { "$ref": "#/types/volcenginecc:vpn/getSslVpnClientCertTag:getSslVpnClientCertTag" }, "type": "array" }, "updateTime": { "description": "Modification time of the SSL client certificate.\n", "type": "string" } }, "required": [ "caCertificate", "certificateStatus", "clientCertificate", "clientKey", "creationTime", "description", "expiredTime", "id", "openVpnClientConfig", "sslVpnClientCertId", "sslVpnClientCertName", "sslVpnServerId", "status", "tags", "updateTime" ], "type": "object" } }, "volcenginecc:vpn/getSslVpnClientCerts:getSslVpnClientCerts": { "description": "Plural Data Source schema for Volcengine::VPN::SslVpnClientCert\n", "outputs": { "description": "A collection of values returned by getSslVpnClientCerts.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpn/getVpnConnection:getVpnConnection": { "description": "Data Source schema for Volcengine::VPN::VPNConnection\n", "inputs": { "description": "A collection of arguments for invoking getVpnConnection.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getVpnConnection.\n", "properties": { "accountId": { "description": "ID of the account to which the IPsec connection belongs.\n", "type": "string" }, "attachStatus": { "description": "IPsec connection status, VpnGateway: Attached: Bound; TransitRouter: Attached: Bound; Attaching: Binding; Detached: Unbound; Detaching: Unbinding.\n", "type": "string" }, "attachType": { "description": "Type of gateway associated with the IPsec connection. VpnGateway: VPN gateway; TransitRouter: transit router.\n", "type": "string" }, "bgpInfo": { "$ref": "#/types/volcenginecc:vpn/getVpnConnectionBgpInfo:getVpnConnectionBgpInfo", "description": "BGP information for the IPsec connection.\n" }, "businessStatus": { "description": "Billing status of the IPsec connection. This parameter is returned only when AttachType is 'TransitRouter'. Normal: Normal. FinancialLocked: Financially locked.\n", "type": "string" }, "connectStatus": { "description": "Status of the tunnel connection. ike*sa*negotiation*failed: Phase 1 negotiation failed. ike*sa*negotiation*completed: Phase 1 negotiation succeeded. ipsec*sa*negotiation*failed: Phase 2 negotiation failed. ipsec*sa*negotiation*completed: Phase 2 negotiation succeeded.\n", "type": "string" }, "creationTime": { "description": "Time when the IPsec connection was created.\n", "type": "string" }, "customerGatewayId": { "description": "ID of the customer gateway associated with the IPsec connection. This parameter is required when creating a single-tunnel IPsec connection. If the customer gateway IP address is 0.0.0.0, NegotiateInstantly can only be set to false, IkeConfig.Version can only be set to ikev1, and IkeConfig.Mode can only be set to aggressive in IkeConfig.\n", "type": "string" }, "deletedTime": { "description": "Expected resource forced reclamation time. This parameter is returned only when AttachType is 'TransitRouter', and only when the resource is frozen due to overdue payment. Otherwise, the value is empty.\n", "type": "string" }, "description": { "description": "Description of the IPsec connection. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.\n", "type": "string" }, "dpdAction": { "description": "Status of the DPD feature. none: DPD feature disabled. clear (default): DPD feature enabled; IKE SA is cleared after DPD timeout. hold: DPD feature enabled; current state is maintained after DPD timeout; the connection is re-established when new traffic is detected. restart: DPD feature enabled; reconnect immediately after DPD timeout.\n", "type": "string" }, "dualTunnelEnabled": { "description": "Enable dual tunnel feature. true: Enabled. false: Not enabled.\n", "type": "boolean" }, "enableTunnelsBgp": { "description": "Whether to enable BGP. Valid values: false (default): No, use static routing mode. true: Yes, use BGP routing mode.\n", "type": "boolean" }, "healthCheckers": { "description": "Health check information for the IPsec connection\n", "items": { "$ref": "#/types/volcenginecc:vpn/getVpnConnectionHealthChecker:getVpnConnectionHealthChecker" }, "type": "array" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ikeConfig": { "$ref": "#/types/volcenginecc:vpn/getVpnConnectionIkeConfig:getVpnConnectionIkeConfig", "description": "IKE configuration information for the IPsec connection\n" }, "ipAddress": { "description": "Public IP address of the transit router. This parameter is returned only when AttachType is 'TransitRouter'.\n", "type": "string" }, "ipsecConfig": { "$ref": "#/types/volcenginecc:vpn/getVpnConnectionIpsecConfig:getVpnConnectionIpsecConfig", "description": "IPsec configuration information for the IPsec connection.\n" }, "isBlocked": { "description": "Whether the current resource is blocked. true: Blocked; false: Not blocked\n", "type": "boolean" }, "localSubnets": { "description": "Local network segment of the IPsec connection.\n", "items": { "type": "string" }, "type": "array" }, "logEnabled": { "description": "Enable connection logs. After connection logs are enabled, you can view and download IPsec connection logs and troubleshoot IPsec connection issues using the log information. true: Enabled. false: Not enabled.\n", "type": "boolean" }, "natTraversal": { "description": "Enable NAT traversal. true: Enabled. When NAT traversal is enabled, IKE negotiation does not verify UDP port numbers and can detect NAT gateway devices in the VPN connection tunnel. false (default): Not enabled.\n", "type": "boolean" }, "negotiateInstantly": { "description": "Whether to initiate negotiation mode immediately. true: The system actively initiates negotiation after the IPsec connection is configured. false (default): The system does not actively initiate negotiation after configuration; negotiation is initiated passively when traffic passes through.\n", "type": "boolean" }, "overdueTime": { "description": "Resource freeze time. This parameter is returned only when AttachType is 'TransitRouter', and only when the resource is frozen due to overdue payment. Otherwise, this parameter is empty.\n", "type": "string" }, "projectName": { "description": "Project to which the IPsec connection belongs.\n", "type": "string" }, "remoteSubnets": { "description": "Peer CIDR block of the IPsec connection\n", "items": { "type": "string" }, "type": "array" }, "spec": { "description": "IPsec connection instance specification. Only effective for IPsec associated with TR instances; ineffective for IPsec associated with VPN gateway instances. This parameter takes effect only when AttachType is set to TransitRouter. default (default): Default specification, bandwidth limit is 200 Mbps. large: Large specification, bandwidth limit is 1 Gbps. xlarge: Extra large specification, bandwidth limit is 3 Gbps.\n", "type": "string" }, "status": { "description": "Status of the IPsec connection. Creating: Creating. Deleting: Deleting. Pending: Configuring. Available: Available.\n", "type": "string" }, "tags": { "description": "All tag information added to the IPsec connection.\n", "items": { "$ref": "#/types/volcenginecc:vpn/getVpnConnectionTag:getVpnConnectionTag" }, "type": "array" }, "transitRouterId": { "description": "The ID of the transit router. This parameter is returned only when AttachType is 'TransitRouter'.\n", "type": "string" }, "tunnelOptions": { "description": "Tunnel configuration information for the IPsec connection.\n", "items": { "$ref": "#/types/volcenginecc:vpn/getVpnConnectionTunnelOption:getVpnConnectionTunnelOption" }, "type": "array" }, "updateTime": { "description": "The time when the IPsec connection was updated.\n", "type": "string" }, "vpnConnectionId": { "description": "ID of the IPsec connection\n", "type": "string" }, "vpnConnectionName": { "description": "Name of the IPsec connection. Must start with a Chinese character, English letter, or number, and can only contain Chinese characters, English letters, numbers, dot (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the IPsec connection ID.\n", "type": "string" }, "vpnGatewayId": { "description": "The ID of the VPN gateway associated with the IPsec connection. If AttachType is not specified or set to VpnGateway, this parameter must be provided. If AttachType is set to TransitRouter, this parameter is not required.\n", "type": "string" }, "zoneId": { "description": "Availability zone of the transit router attachment point. This parameter is returned only when AttachType is 'TransitRouter'.\n", "type": "string" } }, "required": [ "accountId", "attachStatus", "attachType", "bgpInfo", "businessStatus", "connectStatus", "creationTime", "customerGatewayId", "deletedTime", "description", "dpdAction", "dualTunnelEnabled", "enableTunnelsBgp", "healthCheckers", "id", "ikeConfig", "ipAddress", "ipsecConfig", "isBlocked", "localSubnets", "logEnabled", "natTraversal", "negotiateInstantly", "overdueTime", "projectName", "remoteSubnets", "spec", "status", "tags", "transitRouterId", "tunnelOptions", "updateTime", "vpnConnectionId", "vpnConnectionName", "vpnGatewayId", "zoneId" ], "type": "object" } }, "volcenginecc:vpn/getVpnConnections:getVpnConnections": { "description": "Plural Data Source schema for Volcengine::VPN::VPNConnection\n", "outputs": { "description": "A collection of values returned by getVpnConnections.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:vpn/getVpnGateway:getVpnGateway": { "description": "Data Source schema for Volcengine::VPN::VPNGateway\n", "inputs": { "description": "A collection of arguments for invoking getVpnGateway.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getVpnGateway.\n", "properties": { "asn": { "description": "ASN of the VPN gateway.\n", "type": "integer" }, "bandwidth": { "description": "VPN gateway bandwidth specification.\n", "type": "integer" }, "billingType": { "description": "VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)\n", "type": "integer" }, "businessStatus": { "description": "VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.\n", "type": "string" }, "connectionCount": { "description": "Number of IPsec connections associated with the VPN gateway.\n", "type": "integer" }, "createTime": { "description": "Time when the VPN gateway was created.\n", "type": "string" }, "deletedTime": { "description": "Expected resource forced reclaim time.\n", "type": "string" }, "description": { "description": "Description of the VPN gateway.\n", "type": "string" }, "dualTunnelEnabled": { "description": "Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled\n", "type": "boolean" }, "expiredTime": { "description": "VPN gateway expiration time.\n", "type": "string" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "ipAddress": { "description": "VPN gateway public IP address.\n", "type": "string" }, "ipStackType": { "description": "VPN gateway protocol type. ipv4*only: IPv4 protocol type. ipv6*only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.\n", "type": "string" }, "ipVersion": { "description": "IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.\n", "type": "string" }, "ipsecEnabled": { "description": "Enable IPSec feature. true: enabled false: disabled\n", "type": "boolean" }, "isBlocked": { "description": "Whether the current resource is banned. true: Banned false: Not banned.\n", "type": "boolean" }, "lockReason": { "description": "VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.\n", "type": "string" }, "overdueTime": { "description": "Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.\n", "type": "string" }, "period": { "description": "Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.\n", "type": "integer" }, "periodUnit": { "description": "Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year\n", "type": "string" }, "projectName": { "description": "Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.\n", "type": "string" }, "routeCount": { "description": "Number of route entries for the VPN gateway.\n", "type": "integer" }, "secondaryIpAddress": { "description": "Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.\n", "type": "string" }, "secondarySubnetId": { "description": "ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.\n", "type": "string" }, "sslEnabled": { "description": "Enable SSL VPN feature. true: enabled false: disabled\n", "type": "boolean" }, "sslMaxConnections": { "description": "Maximum SSL connections for the VPN gateway.\n", "type": "integer" }, "status": { "description": "Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available\n", "type": "string" }, "subnetId": { "description": "ID of the subnet to which the port used by the VPN gateway belongs.\n", "type": "string" }, "tags": { "description": "All tag information added to the VPN gateway.\n", "items": { "$ref": "#/types/volcenginecc:vpn/getVpnGatewayTag:getVpnGatewayTag" }, "type": "array" }, "updateTime": { "description": "VPN gateway update time.\n", "type": "string" }, "vpcId": { "description": "VPC ID where the VPN gateway is located.\n", "type": "string" }, "vpnGatewayId": { "description": "ID of the VPN gateway.\n", "type": "string" }, "vpnGatewayName": { "description": "Name of the VPN gateway.\n", "type": "string" } }, "required": [ "asn", "bandwidth", "billingType", "businessStatus", "connectionCount", "createTime", "deletedTime", "description", "dualTunnelEnabled", "expiredTime", "id", "ipAddress", "ipStackType", "ipVersion", "ipsecEnabled", "isBlocked", "lockReason", "overdueTime", "period", "periodUnit", "projectName", "routeCount", "secondaryIpAddress", "secondarySubnetId", "sslEnabled", "sslMaxConnections", "status", "subnetId", "tags", "updateTime", "vpcId", "vpnGatewayId", "vpnGatewayName" ], "type": "object" } }, "volcenginecc:vpn/getVpnGateways:getVpnGateways": { "description": "Plural Data Source schema for Volcengine::VPN::VPNGateway\n", "outputs": { "description": "A collection of values returned by getVpnGateways.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } }, "volcenginecc:waf/getDomain:getDomain": { "description": "Data Source schema for Volcengine::WAF::Domain\n", "inputs": { "description": "A collection of arguments for invoking getDomain.\n", "properties": { "id": { "type": "string", "description": "Uniquely identifies the resource.\n" } }, "type": "object", "required": [ "id" ] }, "outputs": { "description": "A collection of values returned by getDomain.\n", "properties": { "accessMode": { "description": "Access mode. 10: CNAME access, 11: Layer 7 load balancing (CLB) access.\n", "type": "integer" }, "advancedDefenseIp": { "description": "High defense instance IP. Displayed for high-defense WAF access; otherwise blank.\n", "type": "string" }, "advancedDefenseIpv6": { "description": "High defense instance IPv6. Displayed for high-defense WAF access; otherwise blank.\n", "type": "string" }, "apiEnable": { "description": "API protection policy enabled. 0: Off, 1: On\n", "type": "integer" }, "attackStatus": { "description": "Attack status. 0: No attack detected, 1: Attack detected.\n", "type": "integer" }, "autoCcEnable": { "description": "Whether to enable intelligent CC protection policy. 0: Disabled, 1: Enabled.\n", "type": "integer" }, "automaticBlackEnable": { "description": "Whether to enable automatic blocking. 0: Disabled, 1: Enabled.\n", "type": "integer" }, "backendGroups": { "description": "Origin configuration.\n", "items": { "$ref": "#/types/volcenginecc:waf/getDomainBackendGroup:getDomainBackendGroup" }, "type": "array" }, "blackIpEnable": { "description": "Denylist policy enabled. 0: Off, 1: On\n", "type": "integer" }, "blackLctEnable": { "description": "Whether to enable regional blocking policy. 0: Disabled; 1: Enabled.\n", "type": "integer" }, "botDytokenEnable": { "description": "Dynamic token protection enabled\n", "type": "integer" }, "botFrequencyEnable": { "description": "Bot rate limit policy enabled.\n0: Off\n1: On\n", "type": "integer" }, "botRepeatEnable": { "description": "Bot statistics protection policy enabled.\n0: Off\n1: On\n", "type": "integer" }, "botSequenceDefaultAction": { "description": "Set the default action for the bot behavior map policy. Effective when BotSequenceEnable = 1 is enabled. Default is 0 (Observe).\n0: Observe\n2: Intercept\n6: JS Challenge\n7: CAPTCHA.\n", "type": "integer" }, "botSequenceEnable": { "description": "Whether to enable bot behavior map.\n0: Off\n1: On.\n", "type": "integer" }, "ccEnable": { "description": "Whether to enable CC protection policy.\n0: Disabled\n1: Enabled.\n", "type": "integer" }, "certificateId": { "description": "Certificate ID managed in Certificate Center\n", "type": "string" }, "certificateName": { "description": "Certificate name. Displayed when protocol type includes HTTPS.\n", "type": "string" }, "certificatePlatform": { "description": "Certificate hosting platform: waf/certificate_service.\n", "type": "string" }, "clbInstanceIds": { "description": "CLB instance ID.\n", "type": "string" }, "clbListenerId": { "description": "CLB listener ID.\n", "type": "string" }, "clbPoolId": { "description": "CLB backend server group ID.\n", "type": "string" }, "clbServerId": { "description": "CLB backend server ID\n", "type": "string" }, "clientIpLocation": { "description": "Client IP acquisition method. 0: Custom header field, 1: Use the first public IP address in the X-Forwarded-For (XFF) field as the real client IP address.\n", "type": "integer" }, "clientMaxBodySize": { "description": "Maximum client request body size (MB).\n", "type": "integer" }, "cloudAccessConfigs": { "description": "LB access parameters.\n", "items": { "$ref": "#/types/volcenginecc:waf/getDomainCloudAccessConfig:getDomainCloudAccessConfig" }, "type": "array" }, "cname": { "description": "CNAME record.\n", "type": "string" }, "customBotEnable": { "description": "Whether to enable custom bot protection.\n", "type": "integer" }, "customHeaders": { "description": "Custom header.\n", "items": { "type": "string" }, "type": "array" }, "customRspEnable": { "description": "Whether to enable custom response.\n", "type": "integer" }, "customSni": { "description": "Custom SNI.\n", "type": "string" }, "defenceMode": { "description": "Set protection mode for exception ALB instances.\n1: Enable protection. The configured protection policies take effect.\n2: Pause protection. Only forwarding is performed without inspection; the configured protection policies do not take effect.\n3: Origin mode. Requests are sent directly to the origin server and are no longer forwarded to the WAF instance.\nAfter configuring exception protection instances, the domain may also have the following protection statuses:\n5: Partially enabled. The default protection mode is enabled, but some exception instances are in paused protection or origin mode.\n6: Partially paused. The default protection mode is paused, but some exception instances are in enabled protection or origin mode.\n7: Partially origin. The default protection mode is origin mode, but some exception instances are in enabled protection or paused protection.\n", "type": "integer" }, "dlpEnable": { "description": "Data leakage protection enabled\n", "type": "integer" }, "domain": { "description": "Protected domain information. Supports wildcard and exact domains\n", "type": "string" }, "enableCustomRedirect": { "description": "User-defined redirection enabled. 0: Off, 1: On\n", "type": "integer" }, "enableHttp2": { "description": "Whether to enable HTTP/2.0. 0: Disabled, 1: Enabled.\n", "type": "integer" }, "enableIpv6": { "description": "IPv6 request protection supported. 0: Off, 1: On\n", "type": "integer" }, "enableSni": { "description": "Whether to enable SNI configuration. 0: Off, 1: On.\n", "type": "integer" }, "id": { "description": "Uniquely identifies the resource.\n", "type": "string" }, "keepAliveRequest": { "description": "Persistent connection reuse count\n", "type": "integer" }, "keepAliveTimeout": { "description": "Persistent connection keep-alive time (seconds)\n", "type": "integer" }, "lbAlgorithm": { "description": "Load balancing algorithm type. wrr: Weighted round robin, wlc: Weighted least connections, sh: Source address hash.\n", "type": "string" }, "port": { "description": "Port number\n", "type": "integer" }, "projectName": { "description": "Project name.\n", "type": "string" }, "protocolFollow": { "description": "Protocol following enabled. 0: Off, 1: On\n", "type": "integer" }, "protocolPorts": { "$ref": "#/types/volcenginecc:waf/getDomainProtocolPorts:getDomainProtocolPorts", "description": "Access port information\n" }, "protocols": { "description": "Access protocol type: supports HTTP/HTTPS\n", "items": { "type": "string" }, "type": "array" }, "proxyConfig": { "description": "Proxy configuration enabled. 0: Off, 1: On\n", "type": "integer" }, "proxyConnectTimeout": { "description": "Connection timeout between WAF and backend server (seconds).\n", "type": "integer" }, "proxyKeepAlive": { "description": "Number of reusable WAF origin persistent connections.\n", "type": "integer" }, "proxyKeepAliveTimeout": { "description": "Idle persistent connection timeout (seconds)\n", "type": "integer" }, "proxyReadTimeout": { "description": "Timeout for WAF to read response from backend server (seconds).\n", "type": "integer" }, "proxyRetry": { "description": "WAF origin retry count.\n", "type": "integer" }, "proxyWriteTimeout": { "description": "Timeout for WAF to transmit request to backend server (seconds).\n", "type": "integer" }, "publicRealServer": { "description": "CNAME access origin method. 0: Private network origin, 1: Public network origin.\n", "type": "integer" }, "rspAbnormalEnable": { "description": "Whether to enable abnormal response protection.\n", "type": "integer" }, "serverIps": { "description": "Service IP\n", "type": "string" }, "srcIps": { "description": "WAF origin IP.\n", "type": "string" }, "srcProtocol": { "description": "Origin protocol.\n", "type": "string" }, "sslCiphers": { "description": "Cipher suite\n", "items": { "type": "string" }, "type": "array" }, "sslProtocols": { "description": "TLS protocol version. For example: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3\n", "items": { "type": "string" }, "type": "array" }, "status": { "description": "Access status. 0: Normal, 1: DNS not resolved, 2: Configuring, 3: Configuration failed, 4: Configuration not effective, 5: Updating, 6: Instance deleted.\n", "type": "integer" }, "systemBotEnable": { "description": "Whether to enable managed bot protection.\n", "type": "integer" }, "tamperProofEnable": { "description": "Whether to enable anti-tampering.\n", "type": "integer" }, "tcpListenerConfigs": { "description": "TCP listener configuration.\n", "items": { "$ref": "#/types/volcenginecc:waf/getDomainTcpListenerConfig:getDomainTcpListenerConfig" }, "type": "array" }, "tlsEnable": { "description": "Log service enabled. 0: Off, 1: On\n", "type": "integer" }, "tlsFieldsConfig": { "$ref": "#/types/volcenginecc:waf/getDomainTlsFieldsConfig:getDomainTlsFieldsConfig", "description": "Log field configuration details\n" }, "updateTime": { "description": "Update time\n", "type": "string" }, "vpcId": { "description": "VPC ID。\n", "type": "string" }, "wafEnable": { "description": "WAF protection enabled\n", "type": "integer" }, "wafWhiteReqEnable": { "description": "Allowlist request protection enabled\n", "type": "integer" }, "whiteEnable": { "description": "Whether to enable allowlist protection.\n", "type": "integer" }, "whiteFieldEnable": { "description": "Field allowlist protection enabled\n", "type": "integer" } }, "required": [ "accessMode", "advancedDefenseIp", "advancedDefenseIpv6", "apiEnable", "attackStatus", "autoCcEnable", "automaticBlackEnable", "backendGroups", "blackIpEnable", "blackLctEnable", "botDytokenEnable", "botFrequencyEnable", "botRepeatEnable", "botSequenceDefaultAction", "botSequenceEnable", "ccEnable", "certificateId", "certificateName", "certificatePlatform", "clbInstanceIds", "clbListenerId", "clbPoolId", "clbServerId", "clientIpLocation", "clientMaxBodySize", "cloudAccessConfigs", "cname", "customBotEnable", "customHeaders", "customRspEnable", "customSni", "defenceMode", "dlpEnable", "domain", "enableCustomRedirect", "enableHttp2", "enableIpv6", "enableSni", "id", "keepAliveRequest", "keepAliveTimeout", "lbAlgorithm", "port", "projectName", "protocolFollow", "protocolPorts", "protocols", "proxyConfig", "proxyConnectTimeout", "proxyKeepAlive", "proxyKeepAliveTimeout", "proxyReadTimeout", "proxyRetry", "proxyWriteTimeout", "publicRealServer", "rspAbnormalEnable", "serverIps", "srcIps", "srcProtocol", "sslCiphers", "sslProtocols", "status", "systemBotEnable", "tamperProofEnable", "tcpListenerConfigs", "tlsEnable", "tlsFieldsConfig", "updateTime", "vpcId", "wafEnable", "wafWhiteReqEnable", "whiteEnable", "whiteFieldEnable" ], "type": "object" } }, "volcenginecc:waf/getDomains:getDomains": { "description": "Plural Data Source schema for Volcengine::WAF::Domain\n", "outputs": { "description": "A collection of values returned by getDomains.\n", "properties": { "id": { "description": "Uniquely identifies the data source.\n", "type": "string" }, "ids": { "description": "Set of Resource Identifiers.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "ids" ], "type": "object" } } } }