{
"name": "flexibleengine",
"version": "1.46.0",
"description": "A Pulumi provider dynamically bridged from flexibleengine.",
"attribution": "This Pulumi package is based on the [`flexibleengine` Terraform Provider](https://github.com/flexibleenginecloud/terraform-provider-flexibleengine).",
"repository": "https://github.com/flexibleenginecloud/terraform-provider-flexibleengine",
"publisher": "flexibleenginecloud",
"meta": {
"moduleFormat": "(.*)(?:/[^/]*)"
},
"language": {
"csharp": {
"compatibility": "tfbridge20",
"liftSingleValueMethodReturns": true,
"respectSchemaVersion": true
},
"go": {
"importBasePath": "github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine",
"rootPackageName": "flexibleengine",
"liftSingleValueMethodReturns": true,
"generateExtraInputTypes": true,
"respectSchemaVersion": true
},
"java": {
"basePackage": "",
"buildFiles": "",
"gradleNexusPublishPluginVersion": "",
"gradleTest": ""
},
"nodejs": {
"packageDescription": "A Pulumi provider dynamically bridged from flexibleengine.",
"readme": "> This provider is a derived work of the [Terraform Provider](https://github.com/flexibleenginecloud/terraform-provider-flexibleengine)\n> distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n> please consult the source [`terraform-provider-flexibleengine` repo](https://github.com/flexibleenginecloud/terraform-provider-flexibleengine/issues).",
"compatibility": "tfbridge20",
"disableUnionOutputTypes": true,
"liftSingleValueMethodReturns": true,
"respectSchemaVersion": true
},
"python": {
"readme": "> This provider is a derived work of the [Terraform Provider](https://github.com/flexibleenginecloud/terraform-provider-flexibleengine)\n> distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n> please consult the source [`terraform-provider-flexibleengine` repo](https://github.com/flexibleenginecloud/terraform-provider-flexibleengine/issues).",
"compatibility": "tfbridge20",
"respectSchemaVersion": true,
"pyproject": {
"enabled": true
}
}
},
"config": {
"variables": {
"accessKey": {
"type": "string",
"description": "The access key of the FlexibleEngine cloud to use.\n"
},
"authUrl": {
"type": "string",
"description": "The Identity authentication URL.\n"
},
"cacertFile": {
"type": "string",
"description": "A Custom CA certificate.\n"
},
"cert": {
"type": "string",
"description": "A client certificate to authenticate with.\n"
},
"cloud": {
"type": "string",
"description": "The endpoint of cloud provider, defaults to prod-cloud-ocb.orange-business.com\n"
},
"domainId": {
"type": "string",
"description": "The ID of the Domain to scope to (Identity v3).\n"
},
"domainName": {
"type": "string",
"description": "The name of the Domain to scope to (Identity v3).\n"
},
"endpoints": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Experimental Feature: the custom endpoints used to override the default endpoint URL\n"
},
"insecure": {
"type": "boolean",
"description": "Trust self-signed certificates.\n"
},
"key": {
"type": "string",
"description": "A client private key to authenticate with.\n"
},
"maxRetries": {
"type": "number",
"description": "How many times HTTP connection should be retried until giving up.\n"
},
"password": {
"type": "string",
"description": "Password to login with.\n",
"secret": true
},
"region": {
"type": "string",
"description": "The FlexibleEngine region to connect to.\n"
},
"secretKey": {
"type": "string",
"description": "The secret key of the FlexibleEngine cloud to use.\n"
},
"securityToken": {
"type": "string",
"description": "The security token to authenticate with a temporary security credential.\n"
},
"tenantId": {
"type": "string",
"description": "The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.\n"
},
"tenantName": {
"type": "string",
"description": "The name of the Tenant (Identity v2) or Project (Identity v3) to login with.\n"
},
"token": {
"type": "string",
"description": "Authentication token to use as an alternative to username/password.\n"
},
"userId": {
"type": "string",
"description": "User ID to login with.\n"
},
"userName": {
"type": "string",
"description": "Username to login with.\n"
}
},
"defaults": [
"region"
]
},
"types": {
"flexibleengine:index/AntiddosV1Timeouts:AntiddosV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/AomServiceDiscoveryRuleDiscoveryRule:AomServiceDiscoveryRuleDiscoveryRule": {
"properties": {
"checkContents": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the matched value. This is a list of strings.\n"
},
"checkMode": {
"type": "string",
"description": "Specifies the match condition. The values can be **contain** and **equals**.\n"
},
"checkType": {
"type": "string",
"description": "Specifies the match type. The values can be **cmdLine**, **env** and **scope**.\n"
}
},
"type": "object",
"required": [
"checkContents",
"checkMode",
"checkType"
]
},
"flexibleengine:index/AomServiceDiscoveryRuleLogPathRule:AomServiceDiscoveryRuleLogPathRule": {
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the command. This is a list of strings.\n"
},
"nameType": {
"type": "string",
"description": "Specifies the value type, which can be **cmdLineHash**.\n"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the log path. This is a list of strings.\n\n\nThe `name_rules` block supports:\n"
}
},
"type": "object",
"required": [
"args",
"nameType",
"values"
]
},
"flexibleengine:index/AomServiceDiscoveryRuleNameRules:AomServiceDiscoveryRuleNameRules": {
"properties": {
"applicationNameRules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleNameRulesApplicationNameRule:AomServiceDiscoveryRuleNameRulesApplicationNameRule"
},
"description": "Specifies the application name rule. If the value of `name_type` is\n**cmdLine**, `args` is in the format of [\"start\", \"end\"], indicating that the characters between start and end in\nthe command are extracted. If the value of `name_type` is **env**, `args` is in the format of [\"aa\"], indicating that\nthe environment variable named aa is extracted. If the value of `name_type` is **str**, `args` is in the format of\n[\"fix\"], indicating that the application name is suffixed with fix. If the value of `name_type` is **cmdLineHash**,\n`args` is in the format of [\"0001\"] and `value` is in the format of [\"ser\"], indicating that the application name is\nser when the startup command is 0001. The object structure is documented below.\n\n\nThe `service_name_rule` block and `application_name_rule` block support:\n"
},
"serviceNameRules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleNameRulesServiceNameRule:AomServiceDiscoveryRuleNameRulesServiceNameRule"
},
"description": "Specifies the service name rule. If there are multiple objects in the array,\nthe character strings extracted from these objects constitute the service name. If the value of `name_type` is\n**cmdLine**, `args` is in the format of [\"start\", \"end\"], indicating that the characters between start and end\nin the command are extracted. If the value of `name_type` is **env**, `args` is in the format of [\"aa\"],\nindicating that the environment variable named aa is extracted. If the value of `name_type` is **str**, `args` is in the\nformat of [\"fix\"], indicating that the service name is suffixed with fix. If the value of `name_type` is\n**cmdLineHash**, `args` is in the format of [\"0001\"] and `value` is in the format of [\"ser\"], indicating that the\nservice name is ser when the startup command is 0001. The object structure is\ndocumented below.\n"
}
},
"type": "object",
"required": [
"applicationNameRules",
"serviceNameRules"
]
},
"flexibleengine:index/AomServiceDiscoveryRuleNameRulesApplicationNameRule:AomServiceDiscoveryRuleNameRulesApplicationNameRule": {
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the input value.\n"
},
"nameType": {
"type": "string",
"description": "Specifies the value type. The value can be **cmdLineHash**, **cmdLine**, **env**\nand **str**.\n"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the application name, which is mandatory only when the value of\n`name_type` is **cmdLineHash**.\n"
}
},
"type": "object",
"required": [
"args",
"nameType"
]
},
"flexibleengine:index/AomServiceDiscoveryRuleNameRulesServiceNameRule:AomServiceDiscoveryRuleNameRulesServiceNameRule": {
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the input value.\n"
},
"nameType": {
"type": "string",
"description": "Specifies the value type. The value can be **cmdLineHash**, **cmdLine**, **env**\nand **str**.\n"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the application name, which is mandatory only when the value of\n`name_type` is **cmdLineHash**.\n"
}
},
"type": "object",
"required": [
"args",
"nameType"
]
},
"flexibleengine:index/AomServiceDiscoveryRuleTimeouts:AomServiceDiscoveryRuleTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ApiGatewayApiBackendParameter:ApiGatewayApiBackendParameter": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the parameter. The description cannot exceed 255\ncharacters.\n"
},
"location": {
"type": "string",
"description": "Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.\n"
},
"name": {
"type": "string",
"description": "Specifies the parameter name. A parameter name consists of 1–32 characters, starting with\na letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.\n"
},
"type": {
"type": "string",
"description": "Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.\n"
},
"value": {
"type": "string",
"description": "Specifies the parameter value, which is a string of not more than 255 characters. The\nvalue varies depending on the parameter type:\n+ 'REQUEST': parameter name in `request_parameter`\n+ 'CONSTANT': real value of the parameter\n+ 'SYSTEM': gateway parameter name\n"
}
},
"type": "object",
"required": [
"location",
"name",
"value"
]
},
"flexibleengine:index/ApiGatewayApiFunctionBackend:ApiGatewayApiFunctionBackend": {
"properties": {
"functionUrn": {
"type": "string",
"description": "Specifies the function URN.\n"
},
"invocationType": {
"type": "string",
"description": "Specifies the invocation mode, which can be 'async' or 'sync'.\n"
},
"timeout": {
"type": "number",
"description": "Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.\n"
},
"version": {
"type": "string",
"description": "Specifies the function version.\n"
}
},
"type": "object",
"required": [
"functionUrn",
"invocationType",
"version"
]
},
"flexibleengine:index/ApiGatewayApiHttpBackend:ApiGatewayApiHttpBackend": {
"properties": {
"method": {
"type": "string",
"description": "Specifies the backend request method, including 'GET','POST','PUT' and etc..\n"
},
"protocol": {
"type": "string",
"description": "Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.\n"
},
"timeout": {
"type": "number",
"description": "Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to\n50000.\n"
},
"uri": {
"type": "string",
"description": "Specifies the backend request path. The value must comply with URI specifications.\n"
},
"urlDomain": {
"type": "string",
"description": "Specifies the backend service address. An endpoint URL is in the format of\n\"domain name (or IP address):port number\", with up to 255 characters. This parameter and `vpc_channel` are\nalternative.\n"
},
"vpcChannel": {
"type": "string",
"description": "Specifies the VPC channel ID. This parameter and `url_domain` are alternative.\n"
}
},
"type": "object",
"required": [
"method",
"protocol",
"uri"
]
},
"flexibleengine:index/ApiGatewayApiMockBackend:ApiGatewayApiMockBackend": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the Mock backend. The description cannot exceed 255\ncharacters.\n"
},
"resultContent": {
"type": "string",
"description": "Specifies the return result.\n"
},
"version": {
"type": "string",
"description": "Specifies the version of the Mock backend.\n"
}
},
"type": "object"
},
"flexibleengine:index/ApiGatewayApiRequestParameter:ApiGatewayApiRequestParameter": {
"properties": {
"default": {
"type": "string",
"description": "Specifies the default value when the parameter is optional.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the parameter. The description cannot exceed 255\ncharacters.\n"
},
"location": {
"type": "string",
"description": "Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.\n"
},
"name": {
"type": "string",
"description": "Specifies the input parameter name. A parameter name consists of 1–32 characters, starting\nwith a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.\n"
},
"required": {
"type": "boolean",
"description": "Specifies whether the parameter is mandatory or not.\n"
},
"type": {
"type": "string",
"description": "Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.\n"
}
},
"type": "object",
"required": [
"location",
"name",
"required",
"type"
]
},
"flexibleengine:index/ApiGatewayApiTimeouts:ApiGatewayApiTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ApiGatewayGroupTimeouts:ApiGatewayGroupTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ApigApiBackendParam:ApigApiBackendParam": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the constant or system parameter, which contain a\nmaximum of 255 characters, and the angle brackets (< and >) are not allowed.\n"
},
"location": {
"type": "string",
"description": "Specifies the location of the backend parameter. The valid values are **PATH**,\n**QUERY** and **HEADER**.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"systemParamType": {
"type": "string",
"description": "Specifies the type of the system parameter. \nThe valid values are **frontend**, **backend** and **internal**, defaults to **internal**.\n\n\nThe `mock` block supports:\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"value": {
"type": "string",
"description": "Specifies the condition type. For a condition with the input parameter source:\n+ If the condition type is **Enumerated**, separate condition values with commas.\n+ If the condition type is **Matching**, enter a regular expression compatible with PERL.\n\nFor a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR\naddress format is supported.\n"
}
},
"type": "object",
"required": [
"location",
"name",
"type",
"value"
]
},
"flexibleengine:index/ApigApiFuncGraph:ApigApiFuncGraph": {
"properties": {
"authorizerId": {
"type": "string",
"description": "Specifies the ID of the backend custom authorization.\n\n\nThe `conditions` block supports:\n"
},
"functionUrn": {
"type": "string",
"description": "Specifies the URN of the function graph.\n"
},
"invocationType": {
"type": "string",
"description": "Specifies the invocation mode. The valid values are **async** and **sync**,\ndefault to **sync**.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the timeout, in ms, which allowed for APIG to request the backend service. The\nvalid value is range from 1 to 600,000, default to 5,000.\n"
},
"version": {
"type": "string",
"description": "Specifies the version of the function graph.\n"
}
},
"type": "object",
"required": [
"functionUrn"
]
},
"flexibleengine:index/ApigApiFuncGraphPolicy:ApigApiFuncGraphPolicy": {
"properties": {
"authorizerId": {
"type": "string",
"description": "Specifies the ID of the backend custom authorization.\n\n\nThe `conditions` block supports:\n"
},
"backendParams": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiFuncGraphPolicyBackendParam:ApigApiFuncGraphPolicyBackendParam"
},
"description": "Specifies an array of one or more backend parameters. The maximum of request\nparameters is 50. The object structure is documented above.\n"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiFuncGraphPolicyCondition:ApigApiFuncGraphPolicyCondition"
},
"description": "Specifies an array of one or more policy conditions. Up to five conditions can be set.\nThe object structure is documented below.\n"
},
"effectiveMode": {
"type": "string",
"description": "Specifies the effective mode of the backend policy. The valid values are **ALL**\nand **ANY**, default to **ANY**.\n"
},
"functionUrn": {
"type": "string",
"description": "Specifies the URN of the function graph.\n"
},
"invocationMode": {
"type": "string",
"description": "Specifies the invocation mode of the function graph. The valid values are\n**async** and **sync**, default to **sync**.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the timeout, in ms, which allowed for APIG to request the backend service. The\nvalid value is range from 1 to 600,000, default to 5,000.\n"
},
"version": {
"type": "string",
"description": "Specifies the version of the function graph.\n"
}
},
"type": "object",
"required": [
"conditions",
"functionUrn",
"name"
]
},
"flexibleengine:index/ApigApiFuncGraphPolicyBackendParam:ApigApiFuncGraphPolicyBackendParam": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the constant or system parameter, which contain a\nmaximum of 255 characters, and the angle brackets (< and >) are not allowed.\n"
},
"location": {
"type": "string",
"description": "Specifies the location of the backend parameter. The valid values are **PATH**,\n**QUERY** and **HEADER**.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"systemParamType": {
"type": "string",
"description": "Specifies the type of the system parameter. \nThe valid values are **frontend**, **backend** and **internal**, defaults to **internal**.\n\n\nThe `mock` block supports:\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"value": {
"type": "string",
"description": "Specifies the condition type. For a condition with the input parameter source:\n+ If the condition type is **Enumerated**, separate condition values with commas.\n+ If the condition type is **Matching**, enter a regular expression compatible with PERL.\n\nFor a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR\naddress format is supported.\n"
}
},
"type": "object",
"required": [
"location",
"name",
"type",
"value"
]
},
"flexibleengine:index/ApigApiFuncGraphPolicyCondition:ApigApiFuncGraphPolicyCondition": {
"properties": {
"paramName": {
"type": "string",
"description": "Specifies the request parameter name. This parameter is required if the policy type\nis param.\n"
},
"source": {
"type": "string",
"description": "Specifies the policy type. The valid values are **param** and **source**, default to\n**source**.\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"value": {
"type": "string",
"description": "Specifies the condition type. For a condition with the input parameter source:\n+ If the condition type is **Enumerated**, separate condition values with commas.\n+ If the condition type is **Matching**, enter a regular expression compatible with PERL.\n\nFor a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR\naddress format is supported.\n"
}
},
"type": "object",
"required": [
"value"
]
},
"flexibleengine:index/ApigApiMock:ApigApiMock": {
"properties": {
"authorizerId": {
"type": "string",
"description": "Specifies the ID of the backend custom authorization.\n\n\nThe `conditions` block supports:\n"
},
"response": {
"type": "string",
"description": "Specifies the response of the backend policy, which contain a maximum of 2,048\ncharacters, and the angle brackets (< and >) are not allowed.\n"
}
},
"type": "object"
},
"flexibleengine:index/ApigApiMockPolicy:ApigApiMockPolicy": {
"properties": {
"authorizerId": {
"type": "string",
"description": "Specifies the ID of the backend custom authorization.\n\n\nThe `conditions` block supports:\n"
},
"backendParams": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiMockPolicyBackendParam:ApigApiMockPolicyBackendParam"
},
"description": "Specifies an array of one or more backend parameters. The maximum of request\nparameters is 50. The object structure is documented above.\n"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiMockPolicyCondition:ApigApiMockPolicyCondition"
},
"description": "Specifies an array of one or more policy conditions. Up to five conditions can be set.\nThe object structure is documented below.\n"
},
"effectiveMode": {
"type": "string",
"description": "Specifies the effective mode of the backend policy. The valid values are **ALL**\nand **ANY**, default to **ANY**.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"response": {
"type": "string",
"description": "Specifies the response of the backend policy, which contain a maximum of 2,048\ncharacters, and the angle brackets (< and >) are not allowed.\n"
}
},
"type": "object",
"required": [
"conditions",
"name"
]
},
"flexibleengine:index/ApigApiMockPolicyBackendParam:ApigApiMockPolicyBackendParam": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the constant or system parameter, which contain a\nmaximum of 255 characters, and the angle brackets (< and >) are not allowed.\n"
},
"location": {
"type": "string",
"description": "Specifies the location of the backend parameter. The valid values are **PATH**,\n**QUERY** and **HEADER**.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"systemParamType": {
"type": "string",
"description": "Specifies the type of the system parameter. \nThe valid values are **frontend**, **backend** and **internal**, defaults to **internal**.\n\n\nThe `mock` block supports:\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"value": {
"type": "string",
"description": "Specifies the condition type. For a condition with the input parameter source:\n+ If the condition type is **Enumerated**, separate condition values with commas.\n+ If the condition type is **Matching**, enter a regular expression compatible with PERL.\n\nFor a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR\naddress format is supported.\n"
}
},
"type": "object",
"required": [
"location",
"name",
"type",
"value"
]
},
"flexibleengine:index/ApigApiMockPolicyCondition:ApigApiMockPolicyCondition": {
"properties": {
"paramName": {
"type": "string",
"description": "Specifies the request parameter name. This parameter is required if the policy type\nis param.\n"
},
"source": {
"type": "string",
"description": "Specifies the policy type. The valid values are **param** and **source**, default to\n**source**.\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"value": {
"type": "string",
"description": "Specifies the condition type. For a condition with the input parameter source:\n+ If the condition type is **Enumerated**, separate condition values with commas.\n+ If the condition type is **Matching**, enter a regular expression compatible with PERL.\n\nFor a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR\naddress format is supported.\n"
}
},
"type": "object",
"required": [
"value"
]
},
"flexibleengine:index/ApigApiPublishmentHistory:ApigApiPublishmentHistory": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the current publishment.\n"
},
"versionId": {
"type": "string",
"description": "Specifies the version ID of the current publishment.\n"
}
},
"type": "object",
"required": [
"description",
"versionId"
]
},
"flexibleengine:index/ApigApiRequestParam:ApigApiRequestParam": {
"properties": {
"default": {
"type": "string",
"description": "Specifies the default value of the request parameter, which contain a maximum of 255\ncharacters, and the angle brackets (< and >) are not allowed.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the constant or system parameter, which contain a\nmaximum of 255 characters, and the angle brackets (< and >) are not allowed.\n"
},
"enumeration": {
"type": "string",
"description": "The enumerated value.\n"
},
"example": {
"type": "string",
"description": "Specifies the example value of the request parameter, which contain a maximum of 255\ncharacters, and the angle brackets (< and >) are not allowed.\n"
},
"location": {
"type": "string",
"description": "Specifies the location of the backend parameter. The valid values are **PATH**,\n**QUERY** and **HEADER**.\n"
},
"maximum": {
"type": "number",
"description": "Specifies the maximum value or size of the request parameter.\n"
},
"minimum": {
"type": "number",
"description": "Specifies the minimum value or size of the request parameter. For string type,\nThe `maximum` and `minimum` means size. For number type, they means value.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"passthrough": {
"type": "boolean",
"description": "Whether to transparently transfer the parameter.\n"
},
"required": {
"type": "boolean",
"description": "Specifies whether the request parameter is required.\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
}
},
"type": "object",
"required": [
"name"
],
"language": {
"nodejs": {
"requiredOutputs": [
"enumeration",
"name"
]
}
}
},
"flexibleengine:index/ApigApiWeb:ApigApiWeb": {
"properties": {
"authorizerId": {
"type": "string",
"description": "Specifies the ID of the backend custom authorization.\n\n\nThe `conditions` block supports:\n"
},
"backendAddress": {
"type": "string",
"description": "Specifies the backend service address, which consists of a domain name or IP\naddress, and a port number, with not more than 255 characters. The backend service address must be in the format \"Host\nname:Port number\", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443\nor the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with\na letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.\n"
},
"hostHeader": {
"type": "string",
"description": "Specifies the proxy host header. The host header can be customized for requests to\nbe forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.\n"
},
"path": {
"type": "string",
"description": "Specifies the backend request address, which can contain a maximum of 512 characters and\nmust comply with URI specifications.\n+ The request address can contain request parameters enclosed with brackets ({}).\n+ The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and\nunderscores (_) and must comply with URI specifications.\n+ The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters.\nOnly letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.\n"
},
"requestMethod": {
"type": "string",
"description": "Specifies the backend request method of the API. The valid types are **GET**,\n**POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.\n"
},
"requestProtocol": {
"type": "string",
"description": "Specifies the backend request protocol. The valid values are **HTTP** and\n**HTTPS**, default to **HTTPS**.\n"
},
"retryCount": {
"type": "number",
"description": "The number of retry attempts to request the backend service.\n"
},
"sslEnable": {
"type": "boolean",
"description": "Specifies the indicates whether to enable two-way authentication, default to false.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the timeout, in ms, which allowed for APIG to request the backend service. The\nvalid value is range from 1 to 600,000, default to 5,000.\n"
},
"vpcChannelId": {
"type": "string",
"description": "Specifies the VPC channel ID. This parameter and `backend_address` are\nalternative.\n"
}
},
"type": "object",
"required": [
"path"
]
},
"flexibleengine:index/ApigApiWebPolicy:ApigApiWebPolicy": {
"properties": {
"authorizerId": {
"type": "string",
"description": "Specifies the ID of the backend custom authorization.\n\n\nThe `conditions` block supports:\n"
},
"backendAddress": {
"type": "string",
"description": "Specifies the backend service address, which consists of a domain name or IP\naddress, and a port number, with not more than 255 characters. The backend service address must be in the format \"Host\nname:Port number\", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443\nor the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with\na letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.\n"
},
"backendParams": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiWebPolicyBackendParam:ApigApiWebPolicyBackendParam"
},
"description": "Specifies an array of one or more backend parameters. The maximum of request\nparameters is 50. The object structure is documented above.\n"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiWebPolicyCondition:ApigApiWebPolicyCondition"
},
"description": "Specifies an array of one or more policy conditions. Up to five conditions can be set.\nThe object structure is documented below.\n"
},
"effectiveMode": {
"type": "string",
"description": "Specifies the effective mode of the backend policy. The valid values are **ALL**\nand **ANY**, default to **ANY**.\n"
},
"hostHeader": {
"type": "string",
"description": "Specifies the proxy host header. The host header can be customized for requests to\nbe forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"path": {
"type": "string",
"description": "Specifies the backend request address, which can contain a maximum of 512 characters and\nmust comply with URI specifications.\n+ The request address can contain request parameters enclosed with brackets ({}).\n+ The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and\nunderscores (_) and must comply with URI specifications.\n+ The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters.\nOnly letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.\n"
},
"requestMethod": {
"type": "string",
"description": "Specifies the backend request method of the API. The valid types are **GET**,\n**POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.\n"
},
"requestProtocol": {
"type": "string",
"description": "Specifies the backend request protocol. The valid values are **HTTP** and\n**HTTPS**, default to **HTTPS**.\n"
},
"retryCount": {
"type": "number",
"description": "The number of retry attempts to request the backend service.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the timeout, in ms, which allowed for APIG to request the backend service. The\nvalid value is range from 1 to 600,000, default to 5,000.\n"
},
"vpcChannelId": {
"type": "string",
"description": "Specifies the VPC channel ID. This parameter and `backend_address` are\nalternative.\n"
}
},
"type": "object",
"required": [
"conditions",
"name",
"path",
"requestMethod"
]
},
"flexibleengine:index/ApigApiWebPolicyBackendParam:ApigApiWebPolicyBackendParam": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the constant or system parameter, which contain a\nmaximum of 255 characters, and the angle brackets (< and >) are not allowed.\n"
},
"location": {
"type": "string",
"description": "Specifies the location of the backend parameter. The valid values are **PATH**,\n**QUERY** and **HEADER**.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"systemParamType": {
"type": "string",
"description": "Specifies the type of the system parameter. \nThe valid values are **frontend**, **backend** and **internal**, defaults to **internal**.\n\n\nThe `mock` block supports:\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"value": {
"type": "string",
"description": "Specifies the condition type. For a condition with the input parameter source:\n+ If the condition type is **Enumerated**, separate condition values with commas.\n+ If the condition type is **Matching**, enter a regular expression compatible with PERL.\n\nFor a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR\naddress format is supported.\n"
}
},
"type": "object",
"required": [
"location",
"name",
"type",
"value"
]
},
"flexibleengine:index/ApigApiWebPolicyCondition:ApigApiWebPolicyCondition": {
"properties": {
"paramName": {
"type": "string",
"description": "Specifies the request parameter name. This parameter is required if the policy type\nis param.\n"
},
"source": {
"type": "string",
"description": "Specifies the policy type. The valid values are **param** and **source**, default to\n**source**.\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"value": {
"type": "string",
"description": "Specifies the condition type. For a condition with the input parameter source:\n+ If the condition type is **Enumerated**, separate condition values with commas.\n+ If the condition type is **Matching**, enter a regular expression compatible with PERL.\n\nFor a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR\naddress format is supported.\n"
}
},
"type": "object",
"required": [
"value"
]
},
"flexibleengine:index/ApigApplicationAuthorizationTimeouts:ApigApplicationAuthorizationTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ApigChannelHealthCheck:ApigChannelHealthCheck": {
"properties": {
"enableClientSsl": {
"type": "boolean",
"description": "Specifies whether to enable two-way authentication. \nDefaults to **false**.\n"
},
"httpCodes": {
"type": "string",
"description": "Specifies the response codes for determining a successful HTTP response. \nThe valid value ranges from `100` to `599` and the valid formats are as follows:\n+ The multiple values, for example, **200,201,202**.\n+ The range, for example, **200-299**.\n+ Both multiple values and ranges, for example, **201,202,210-299**.\n"
},
"interval": {
"type": "number",
"description": "Specifies the interval between consecutive checks, in second. \nThe valid value ranges from `1` to `300`.\n"
},
"method": {
"type": "string",
"description": "Specifies the request method for health check. \nThe valid values are **GET** and **HEAD**.\n"
},
"path": {
"type": "string",
"description": "Specifies the destination path for health checks. \nRequired if the `protocol` is **HTTP** or **HTTPS**.\n"
},
"port": {
"type": "number",
"description": "Specifies the destination host port for health check. \nThe valid value ranges from `0` to `65535`.\n"
},
"protocol": {
"type": "string",
"description": "Specifies the microservice for performing health check on backend servers. \nThe valid values are **TCP**, **HTTP** and **HTTPS**, defaults to **TCP**.\n"
},
"status": {
"type": "number",
"description": "Specifies the status of health check. \nThe valid values are as follows:\n+ **1**: Normal.\n+ **2**: Abnormal.\n\nDefaults to **1** (normal).\n\n\nThe `microservice` block supports:\n"
},
"thresholdAbnormal": {
"type": "number",
"description": "Specifies the unhealthy threshold, which refers to the number of consecutive\nfailed checks required for a backend server to be considered unhealthy.\nThe valid value ranges from `1` to `10`.\n"
},
"thresholdNormal": {
"type": "number",
"description": "Specifies the the healthy threshold, which refers to the number of consecutive\nsuccessful checks required for a backend server to be considered healthy.\nThe valid value ranges from `1` to `10`.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the timeout for determining whether a health check fails, in second. \nThe value must be less than the value of the time `interval`.\nThe valid value ranges from `1` to `30`.\n"
}
},
"type": "object",
"required": [
"interval",
"protocol",
"thresholdAbnormal",
"thresholdNormal",
"timeout"
],
"language": {
"nodejs": {
"requiredOutputs": [
"enableClientSsl",
"httpCodes",
"interval",
"method",
"path",
"port",
"protocol",
"status",
"thresholdAbnormal",
"thresholdNormal",
"timeout"
]
}
}
},
"flexibleengine:index/ApigChannelMember:ApigChannelMember": {
"properties": {
"groupName": {
"type": "string",
"description": "Specifies the IP address each backend servers.\nIf omitted, means that all backend servers are both in one group.\n"
},
"host": {
"type": "string",
"description": "Specifies the IP address each backend servers. \nRequired if the `member_type` is **ecs**.\nThis parameter and `member.id` are alternative.\n"
},
"id": {
"type": "string",
"description": "Specifies the ECS ID for each backend servers. \nRequired if the `member_type` is **ecs**.\nThis parameter and `member.host` are alternative.\n"
},
"isBackup": {
"type": "boolean",
"description": "Specifies whether this member is the backup member. \nDefaults to **false**.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the backend server. \nRequired if the `member.id` is set.\nThis parameter and `member.host` are alternative.\n"
},
"port": {
"type": "number",
"description": "Specifies the destination host port for health check. \nThe valid value ranges from `0` to `65535`.\n"
},
"status": {
"type": "number",
"description": "Specifies the status of health check. \nThe valid values are as follows:\n+ **1**: Normal.\n+ **2**: Abnormal.\n\nDefaults to **1** (normal).\n\n\nThe `microservice` block supports:\n"
},
"weight": {
"type": "number",
"description": "Specifies the weight of current backend server. \nThe valid value ranges from `0` to `10000`, defaults to `0`.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"groupName",
"host",
"id",
"isBackup",
"name",
"port",
"status",
"weight"
]
}
}
},
"flexibleengine:index/ApigChannelMemberGroup:ApigChannelMemberGroup": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the member group.\n"
},
"microserviceLabels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the microservice tags of the backend server group.\n\n\nThe `member` block supports:\n"
},
"microservicePort": {
"type": "number",
"description": "Specifies the microservice port of the backend server group. \nThe valid value ranges from `0` to `65535`.\n"
},
"microserviceVersion": {
"type": "string",
"description": "Specifies the microservice version of the backend server group.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the backend server. \nRequired if the `member.id` is set.\nThis parameter and `member.host` are alternative.\n"
},
"weight": {
"type": "number",
"description": "Specifies the weight of current backend server. \nThe valid value ranges from `0` to `10000`, defaults to `0`.\n"
}
},
"type": "object",
"required": [
"name"
],
"language": {
"nodejs": {
"requiredOutputs": [
"description",
"microserviceLabels",
"microservicePort",
"microserviceVersion",
"name",
"weight"
]
}
}
},
"flexibleengine:index/ApigChannelMicroservice:ApigChannelMicroservice": {
"properties": {
"cceConfig": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMicroserviceCceConfig:ApigChannelMicroserviceCceConfig",
"description": "Specifies the CCE microservice details. \nThe cce_config structure is documented below.\n\n\nThe `cce_config` block supports:\n"
},
"cseConfig": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMicroserviceCseConfig:ApigChannelMicroserviceCseConfig",
"description": "schema:Internal; The CSE microservice details.\n"
}
},
"type": "object"
},
"flexibleengine:index/ApigChannelMicroserviceCceConfig:ApigChannelMicroserviceCceConfig": {
"properties": {
"clusterId": {
"type": "string",
"description": "Specifies the CCE cluster ID.\n"
},
"labelKey": {
"type": "string",
"description": "The service label key.\n"
},
"labelValue": {
"type": "string",
"description": "The service label value.\n"
},
"namespace": {
"type": "string",
"description": "Specifies the namespace, such as the default namespace for CCE cluster: **default**.\n"
},
"workloadName": {
"type": "string",
"description": "Specifies the workload name.\n"
},
"workloadType": {
"type": "string",
"description": "Specifies the workload type.\n+ **deployment**: Stateless load.\n+ **statefulset**: Stateful load.\n+ **daemonset**: Daemons set.\n"
}
},
"type": "object",
"required": [
"clusterId",
"namespace",
"workloadType"
]
},
"flexibleengine:index/ApigChannelMicroserviceCseConfig:ApigChannelMicroserviceCseConfig": {
"properties": {
"engineId": {
"type": "string",
"description": "schema:Internal; The microservice engine ID.\n"
},
"serviceId": {
"type": "string",
"description": "schema:Internal; The microservice ID.\n"
}
},
"type": "object",
"required": [
"engineId",
"serviceId"
]
},
"flexibleengine:index/ApigCustomAuthorizerIdentity:ApigCustomAuthorizerIdentity": {
"properties": {
"location": {
"type": "string",
"description": "Specifies the parameter location, which support 'HEADER' and 'QUERY'.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the parameter to be verified.\nThe parameter includes front-end and back-end parameters.\n"
},
"validation": {
"type": "string",
"description": "Specifies the parameter verification expression.\nIf omitted, the custom authorizer will not perform verification.\nThe valid value is range form 1 to 2,048.\n"
}
},
"type": "object",
"required": [
"location",
"name"
]
},
"flexibleengine:index/ApigGroupEnvironment:ApigGroupEnvironment": {
"properties": {
"environmentId": {
"type": "string",
"description": "Specifies the APIG environment ID of the associated APIG group.\n"
},
"variables": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigGroupEnvironmentVariable:ApigGroupEnvironmentVariable"
},
"description": "Specifies an array of one or more APIG environment variables. The object structure is\ndocumented below. The environment variables of different groups are isolated in the same environment.\n"
}
},
"type": "object",
"required": [
"environmentId",
"variables"
]
},
"flexibleengine:index/ApigGroupEnvironmentVariable:ApigGroupEnvironmentVariable": {
"properties": {
"id": {
"type": "string",
"description": "The variable ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the variable name, which can contains of 3 to 32 characters, starting with a\nletter. Only letters, digits, hyphens (-), and underscores (_) are allowed. In the definition of an API, `name` (\ncase-sensitive) indicates a variable, such as #Name#. It is replaced by the actual value when the API is published in\nan environment. The variable names are not allowed to be repeated for an API group.\n"
},
"value": {
"type": "string",
"description": "Specifies the environment ariable value, which can contains of 1 to 255 characters. Only\nletters, digits and special characters (_-/.:) are allowed.\n\n> **NOTE:** The variable value will be displayed in plain text on the console.\n"
},
"variableId": {
"type": "string",
"description": "schema: Deprecated; The ID of the variable that the group has.\n",
"deprecationMessage": "Deprecated"
}
},
"type": "object",
"required": [
"name",
"value"
],
"language": {
"nodejs": {
"requiredOutputs": [
"id",
"name",
"value",
"variableId"
]
}
}
},
"flexibleengine:index/ApigInstanceTimeouts:ApigInstanceTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ApigResponseRule:ApigResponseRule": {
"properties": {
"body": {
"type": "string",
"description": "Specifies the body template of the API response rule, e.g.\n`{\\\"code\\\":\\\"$context.authorizer.frontend.code\\\",\\\"message\\\":\\\"$context.authorizer.frontend.message\\\"}`\n"
},
"errorType": {
"type": "string",
"description": "Specifies the type of the API custom response rule.\n+ **AUTH_FAILURE**: Authentication failed.\n+ **AUTH_HEADER_MISSING**: The identity source is missing.\n+ **AUTHORIZER_FAILURE**: Custom authentication failed.\n+ **AUTHORIZER_CONF_FAILURE**: There has been a custom authorizer error.\n+ **AUTHORIZER_IDENTITIES_FAILURE**: The identity source of the custom authorizer is invalid.\n+ **BACKEND_UNAVAILABLE**: The backend service is unavailable.\n+ **BACKEND_TIMEOUT**: Communication with the backend service timed out.\n+ **THROTTLED**: The request was rejected due to request throttling.\n+ **UNAUTHORIZED**: The app you are using has not been authorized to call the API.\n+ **ACCESS_DENIED**: Access denied.\n+ **NOT_FOUND**: No API is found.\n+ **REQUEST_PARAMETERS_FAILURE**: The request parameters are incorrect.\n+ **DEFAULT_4XX**: Another 4XX error occurred.\n+ **DEFAULT_5XX**: Another 5XX error occurred.\n"
},
"statusCode": {
"type": "number",
"description": "Specifies the HTTP status code of the API response rule.\n"
}
},
"type": "object",
"required": [
"body",
"errorType"
],
"language": {
"nodejs": {
"requiredOutputs": [
"body",
"errorType",
"statusCode"
]
}
}
},
"flexibleengine:index/ApigSignatureAssociateTimeouts:ApigSignatureAssociateTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ApigThrottlingPolicyAppThrottle:ApigThrottlingPolicyAppThrottle": {
"properties": {
"id": {
"type": "string",
"description": "ID of the special application throttling policy.\n"
},
"maxApiRequests": {
"type": "number",
"description": "Specifies the maximum number of times an API can be accessed within a specified\nperiod. The value of this parameter cannot exceed the default limit 200 TPS.\n"
},
"throttlingObjectId": {
"type": "string",
"description": "The object ID which the special throttling policy belongs.\n"
},
"throttlingObjectName": {
"type": "string",
"description": "The object name which the special application throttling policy belongs.\n"
}
},
"type": "object",
"required": [
"maxApiRequests",
"throttlingObjectId"
],
"language": {
"nodejs": {
"requiredOutputs": [
"id",
"maxApiRequests",
"throttlingObjectId",
"throttlingObjectName"
]
}
}
},
"flexibleengine:index/ApigThrottlingPolicyUserThrottle:ApigThrottlingPolicyUserThrottle": {
"properties": {
"id": {
"type": "string",
"description": "ID of the special application throttling policy.\n"
},
"maxApiRequests": {
"type": "number",
"description": "Specifies the maximum number of times an API can be accessed within a specified\nperiod.\n"
},
"throttlingObjectId": {
"type": "string",
"description": "Specifies the object ID which the special throttling policy belongs.\n"
},
"throttlingObjectName": {
"type": "string",
"description": "The object name which the special application throttling policy belongs.\n"
}
},
"type": "object",
"required": [
"maxApiRequests",
"throttlingObjectId"
],
"language": {
"nodejs": {
"requiredOutputs": [
"id",
"maxApiRequests",
"throttlingObjectId",
"throttlingObjectName"
]
}
}
},
"flexibleengine:index/ApigVpcChannelMember:ApigVpcChannelMember": {
"properties": {
"id": {
"type": "string",
"description": "Specifies the ECS ID for each backend servers.\nRequired if `member_type` is *ECS*.\nThis parameter and `ip_address` are alternative.\n"
},
"ipAddress": {
"type": "string",
"description": "Specifies the IP address each backend servers.\nRequired if `member_type` is *EIP*.\n"
},
"weight": {
"type": "number",
"description": "Specifies the backend server weight.\nThe valid values are range from 1 to 100, default to 1.\n"
}
},
"type": "object"
},
"flexibleengine:index/AsConfigurationInstanceConfig:AsConfigurationInstanceConfig": {
"properties": {
"disks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationInstanceConfigDisk:AsConfigurationInstanceConfigDisk"
},
"description": "The disk group information. System disks are mandatory and data disks are optional.\nThe dick structure is described below.\n"
},
"flavor": {
"type": "string",
"description": "The flavor ID.\n"
},
"image": {
"type": "string",
"description": "The image ID.\n"
},
"instanceId": {
"type": "string",
"description": "When using the existing instance specifications as the template to\ncreate AS configurations, specify this argument. In this case, flavor, image,\nand disk arguments do not take effect. If the instance_id argument is not specified,\nflavor, image, and disk arguments are mandatory.\n"
},
"keyName": {
"type": "string",
"description": "The name of the SSH key pair used to log in to the instance.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Metadata key/value pairs to make available from\nwithin the instance.\n"
},
"personalities": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationInstanceConfigPersonality:AsConfigurationInstanceConfigPersonality"
},
"description": "Customize the personality of an instance by\ndefining one or more files and their contents. The personality structure\nis described below.\n"
},
"publicIp": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationInstanceConfigPublicIp:AsConfigurationInstanceConfigPublicIp",
"description": "The elastic IP address of the instance. The public_ip structure\nis described below.\n"
},
"userData": {
"type": "string",
"description": "The user data to provide when launching the instance.\nThe file content must be encoded with Base64. Changing this creates a new AS configuration.\n"
}
},
"type": "object",
"required": [
"keyName"
]
},
"flexibleengine:index/AsConfigurationInstanceConfigDisk:AsConfigurationInstanceConfigDisk": {
"properties": {
"diskType": {
"type": "string",
"description": "Whether the disk is a system disk or a data disk. Option `DATA` indicates\na data disk. option `SYS` indicates a system disk.\n"
},
"size": {
"type": "number",
"description": "The disk size. The unit is GB. The system disk size ranges from 1 to 32768,\nand the data disk size ranges from 10 to 32768.\n"
},
"volumeType": {
"type": "string",
"description": "The disk type, which must be the same as the disk type available in the system.\nThe options include `SATA` (common I/O disk type) and `SSD` (ultra-high I/O disk type).\n"
}
},
"type": "object",
"required": [
"diskType",
"size",
"volumeType"
]
},
"flexibleengine:index/AsConfigurationInstanceConfigPersonality:AsConfigurationInstanceConfigPersonality": {
"properties": {
"content": {
"type": "string",
"description": "The content of the injected file, which must be encoded with base64.\n"
},
"path": {
"type": "string",
"description": "The absolute path of the destination file.\n"
}
},
"type": "object",
"required": [
"content",
"path"
]
},
"flexibleengine:index/AsConfigurationInstanceConfigPublicIp:AsConfigurationInstanceConfigPublicIp": {
"properties": {
"eip": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationInstanceConfigPublicIpEip:AsConfigurationInstanceConfigPublicIpEip",
"description": "The configuration parameter for creating an elastic IP address\nthat will be automatically assigned to the instance. The eip structure is described below.\n"
}
},
"type": "object",
"required": [
"eip"
]
},
"flexibleengine:index/AsConfigurationInstanceConfigPublicIpEip:AsConfigurationInstanceConfigPublicIpEip": {
"properties": {
"bandwidth": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationInstanceConfigPublicIpEipBandwidth:AsConfigurationInstanceConfigPublicIpEipBandwidth",
"description": "The bandwidth information. The structure is described below.\n"
},
"ipType": {
"type": "string",
"description": "The IP address type. The system only supports `5_bgp` (indicates dynamic BGP).\n"
}
},
"type": "object",
"required": [
"bandwidth",
"ipType"
]
},
"flexibleengine:index/AsConfigurationInstanceConfigPublicIpEipBandwidth:AsConfigurationInstanceConfigPublicIpEipBandwidth": {
"properties": {
"chargingMode": {
"type": "string",
"description": "The bandwidth charging mode. The system only supports `traffic`.\n"
},
"shareType": {
"type": "string",
"description": "The bandwidth sharing type. The system only supports `PER` (indicates exclusive\nbandwidth).\n"
},
"size": {
"type": "number",
"description": "The bandwidth (Mbit/s). The value range is 1 to 300.\n"
}
},
"type": "object",
"required": [
"chargingMode",
"shareType",
"size"
]
},
"flexibleengine:index/AsConfigurationV1InstanceConfig:AsConfigurationV1InstanceConfig": {
"properties": {
"disks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationV1InstanceConfigDisk:AsConfigurationV1InstanceConfigDisk"
}
},
"flavor": {
"type": "string"
},
"image": {
"type": "string"
},
"instanceId": {
"type": "string"
},
"keyName": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"personalities": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationV1InstanceConfigPersonality:AsConfigurationV1InstanceConfigPersonality"
}
},
"publicIp": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationV1InstanceConfigPublicIp:AsConfigurationV1InstanceConfigPublicIp"
},
"userData": {
"type": "string"
}
},
"type": "object",
"required": [
"keyName"
]
},
"flexibleengine:index/AsConfigurationV1InstanceConfigDisk:AsConfigurationV1InstanceConfigDisk": {
"properties": {
"diskType": {
"type": "string"
},
"size": {
"type": "number"
},
"volumeType": {
"type": "string"
}
},
"type": "object",
"required": [
"diskType",
"size",
"volumeType"
]
},
"flexibleengine:index/AsConfigurationV1InstanceConfigPersonality:AsConfigurationV1InstanceConfigPersonality": {
"properties": {
"content": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object",
"required": [
"content",
"path"
]
},
"flexibleengine:index/AsConfigurationV1InstanceConfigPublicIp:AsConfigurationV1InstanceConfigPublicIp": {
"properties": {
"eip": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationV1InstanceConfigPublicIpEip:AsConfigurationV1InstanceConfigPublicIpEip"
}
},
"type": "object",
"required": [
"eip"
]
},
"flexibleengine:index/AsConfigurationV1InstanceConfigPublicIpEip:AsConfigurationV1InstanceConfigPublicIpEip": {
"properties": {
"bandwidth": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationV1InstanceConfigPublicIpEipBandwidth:AsConfigurationV1InstanceConfigPublicIpEipBandwidth"
},
"ipType": {
"type": "string"
}
},
"type": "object",
"required": [
"bandwidth",
"ipType"
]
},
"flexibleengine:index/AsConfigurationV1InstanceConfigPublicIpEipBandwidth:AsConfigurationV1InstanceConfigPublicIpEipBandwidth": {
"properties": {
"chargingMode": {
"type": "string"
},
"shareType": {
"type": "string"
},
"size": {
"type": "number"
}
},
"type": "object",
"required": [
"chargingMode",
"shareType",
"size"
]
},
"flexibleengine:index/AsGroupLbaasListener:AsGroupLbaasListener": {
"properties": {
"poolId": {
"type": "string",
"description": "Specifies the backend ECS group ID.\n"
},
"protocolPort": {
"type": "number",
"description": "Specifies the backend protocol, which is the port on which\na backend ECS listens for traffic. The number of the port ranges from 1 to 65535.\n"
},
"weight": {
"type": "number",
"description": "Specifies the weight, which determines the portion of requests a\nbackend ECS processes compared to other backend ECSs added to the same listener. The value\nof this parameter ranges from 0 to 100. The default value is 1.\n"
}
},
"type": "object",
"required": [
"poolId",
"protocolPort"
]
},
"flexibleengine:index/AsGroupNetwork:AsGroupNetwork": {
"properties": {
"id": {
"type": "string",
"description": "The network UUID.\n"
}
},
"type": "object",
"required": [
"id"
]
},
"flexibleengine:index/AsGroupSecurityGroup:AsGroupSecurityGroup": {
"properties": {
"id": {
"type": "string",
"description": "The UUID of the security group.\n"
}
},
"type": "object",
"required": [
"id"
]
},
"flexibleengine:index/AsGroupTimeouts:AsGroupTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/AsGroupV1LbaasListener:AsGroupV1LbaasListener": {
"properties": {
"poolId": {
"type": "string"
},
"protocolPort": {
"type": "number"
},
"weight": {
"type": "number"
}
},
"type": "object",
"required": [
"poolId",
"protocolPort"
]
},
"flexibleengine:index/AsGroupV1Network:AsGroupV1Network": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object",
"required": [
"id"
]
},
"flexibleengine:index/AsGroupV1SecurityGroup:AsGroupV1SecurityGroup": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object",
"required": [
"id"
]
},
"flexibleengine:index/AsGroupV1Timeouts:AsGroupV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/AsInstanceAttachTimeouts:AsInstanceAttachTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/AsPolicyV1ScalingPolicyAction:AsPolicyV1ScalingPolicyAction": {
"properties": {
"instanceNumber": {
"type": "number",
"description": "The number of instances to be operated. The default number is 1.\n"
},
"operation": {
"type": "string",
"description": "The operation to be performed. The options include `ADD` (default), `REMOVE`,\nand `SET`.\n"
}
},
"type": "object"
},
"flexibleengine:index/AsPolicyV1ScheduledPolicy:AsPolicyV1ScheduledPolicy": {
"properties": {
"endTime": {
"type": "string",
"description": "The end time of the scaling action triggered periodically.\nThe time format complies with UTC. This argument is mandatory when `scaling_policy_type`\nis set to `RECURRENCE`. The time format is YYYY-MM-DDThh:mmZ.\n"
},
"launchTime": {
"type": "string",
"description": "The time when the scaling action is triggered. If `scaling_policy_type`\nis set to `SCHEDULED`, the time format is YYYY-MM-DDThh:mmZ. If `scaling_policy_type` is set to\n`RECURRENCE`, the time format is hh:mm.\n"
},
"recurrenceType": {
"type": "string",
"description": "The periodic triggering type. This argument is mandatory when\n`scaling_policy_type` is set to `RECURRENCE`. The options include `Daily`, `Weekly`, and `Monthly`.\n"
},
"recurrenceValue": {
"type": "string",
"description": "The frequency at which scaling actions are triggered.\n"
},
"startTime": {
"type": "string",
"description": "The start time of the scaling action triggered periodically.\nThe time format complies with UTC. The current time is used by default. The time\nformat is YYYY-MM-DDThh:mmZ.\n"
}
},
"type": "object",
"required": [
"launchTime"
]
},
"flexibleengine:index/BlockstorageVolumeV2Attachment:BlockstorageVolumeV2Attachment": {
"properties": {
"device": {
"type": "string"
},
"id": {
"type": "string",
"description": "Specifies a resource ID in UUID format.\n"
},
"instanceId": {
"type": "string"
}
},
"type": "object",
"required": [
"device",
"id",
"instanceId"
]
},
"flexibleengine:index/BlockstorageVolumeV2Timeouts:BlockstorageVolumeV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CbrPolicyBackupCycle:CbrPolicyBackupCycle": {
"properties": {
"days": {
"type": "string",
"description": "Specifies the weekly backup day of backup schedule. It supports seven days a week (MO, TU,\nWE, TH, FR, SA, SU) and this parameter is separated by a comma (,) without spaces, between date and date during the\nconfiguration.\n"
},
"executionTimes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the backup time. Automated backups will be triggered at the backup\ntime. The current time is in the UTC format (HH:MM). The minutes in the list must be set to **00** and the hours\ncannot be repeated. In the replication policy, you are advised to set one time point for one day.\n\n\nThe `long_term_retention` block supports:\n"
},
"interval": {
"type": "number",
"description": "Specifies the interval (in days) of backup schedule. The value range is `1` to `30`. This\nparameter and `days` are alternative.\n"
}
},
"type": "object",
"required": [
"executionTimes"
]
},
"flexibleengine:index/CbrPolicyLongTermRetention:CbrPolicyLongTermRetention": {
"properties": {
"daily": {
"type": "number",
"description": "Specifies the latest backup of each day is saved in the long term.\n"
},
"fullBackupInterval": {
"type": "number",
"description": "Specifies how often (after how many incremental backups) a full backup is\nperformed. The valid value ranges from `-1` to `100`.\nIf `-1` is specified, full backup will not be performed.\n"
},
"monthly": {
"type": "number",
"description": "Specifies the latest backup of each month is saved in the long term.\n"
},
"weekly": {
"type": "number",
"description": "Specifies the latest backup of each week is saved in the long term.\n"
},
"yearly": {
"type": "number",
"description": "Specifies the latest backup of each year is saved in the long term.\n\n> A maximum of 10 backups are retained for failed periodic backup tasks. They are retained for one month and can be\nmanually deleted on the web console.\n"
}
},
"type": "object"
},
"flexibleengine:index/CbrVaultPolicy:CbrVaultPolicy": {
"properties": {
"destinationVaultId": {
"type": "string",
"description": "Specifies the ID of destination vault to which the replication policy\nwill associated.\n\n> Only one policy of each type (backup and replication) can be associated.\n\n\nThe `resources` block supports:\n"
},
"id": {
"type": "string",
"description": "Specifies the policy ID.\n"
}
},
"type": "object",
"required": [
"id"
]
},
"flexibleengine:index/CbrVaultResource:CbrVaultResource": {
"properties": {
"excludes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the array of disk IDs which will be excluded in the backup.\nOnly **server** vault support this parameter.\n"
},
"includes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the array of disk or SFS file system IDs which will be included in the backup.\nOnly **disk** and **turbo** vault support this parameter.\n"
},
"serverId": {
"type": "string",
"description": "Specifies the ID of the ECS instance to be backed up.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"excludes",
"includes"
]
}
}
},
"flexibleengine:index/CbrVaultTimeouts:CbrVaultTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CceAddonV3Timeouts:CceAddonV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CceAddonV3Values:CceAddonV3Values": {
"properties": {
"basic": {
"type": "string",
"description": "The basic parameters in json string format.\nChanging this will create a new resource.\n"
},
"custom": {
"type": "string",
"description": "The custom parameters in json string format.\nChanging this will create a new resource.\n"
},
"flavor": {
"type": "string",
"description": "The flavor parameters in json string format.\nChanging this will create a new resource.\n"
}
},
"type": "object",
"required": [
"basic"
]
},
"flexibleengine:index/CceClusterV3CertificateCluster:CceClusterV3CertificateCluster": {
"properties": {
"certificateAuthorityData": {
"type": "string",
"description": "The certificate data.\n"
},
"name": {
"type": "string",
"description": "Cluster name. Changing this parameter will create a new cluster resource.\n"
},
"server": {
"type": "string",
"description": "The server IP address.\n"
}
},
"type": "object",
"required": [
"certificateAuthorityData",
"name",
"server"
]
},
"flexibleengine:index/CceClusterV3CertificateUser:CceClusterV3CertificateUser": {
"properties": {
"clientCertificateData": {
"type": "string",
"description": "The client certificate data.\n"
},
"clientKeyData": {
"type": "string",
"description": "The client key data.\n"
},
"name": {
"type": "string",
"description": "Cluster name. Changing this parameter will create a new cluster resource.\n"
}
},
"type": "object",
"required": [
"clientCertificateData",
"clientKeyData",
"name"
]
},
"flexibleengine:index/CceClusterV3Master:CceClusterV3Master": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "Specifies the availability zone of the master node.\nChanging this creates a new cluster.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"availabilityZone"
]
}
}
},
"flexibleengine:index/CceClusterV3Timeouts:CceClusterV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CceNamespaceTimeouts:CceNamespaceTimeouts": {
"properties": {
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CceNodePoolV3DataVolume:CceNodePoolV3DataVolume": {
"properties": {
"extendParams": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the disk expansion parameters in key/value pair format.\nChanging this will create a new CCE node pool resource.\n"
},
"kmsKeyId": {
"type": "string",
"description": "Specifies the KMS key ID. This is used to encrypt the volume.\nChanging this will create a new CCE node pool resource.\n\n> You need to create an agency (EVSAccessKMS) when disk encryption is used in the current project for the first time ever.\nThe account and permission of the created agency are `op_svc_evs` and **KMS Administrator**, respectively.\n"
},
"size": {
"type": "number",
"description": "Specifies the disk size in GB.\nChanging this will create a new CCE node pool resource.\n"
},
"volumetype": {
"type": "string",
"description": "Specifies the disk type.\nChanging this will create a new CCE node pool resource.\n"
}
},
"type": "object",
"required": [
"size",
"volumetype"
]
},
"flexibleengine:index/CceNodePoolV3RootVolume:CceNodePoolV3RootVolume": {
"properties": {
"extendParams": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the disk expansion parameters in key/value pair format.\nChanging this will create a new CCE node pool resource.\n"
},
"kmsKeyId": {
"type": "string",
"description": "Specifies the KMS key ID. This is used to encrypt the volume.\nChanging this will create a new CCE node pool resource.\n\n> You need to create an agency (EVSAccessKMS) when disk encryption is used in the current project for the first time ever.\nThe account and permission of the created agency are `op_svc_evs` and **KMS Administrator**, respectively.\n"
},
"size": {
"type": "number",
"description": "Specifies the disk size in GB.\nChanging this will create a new CCE node pool resource.\n"
},
"volumetype": {
"type": "string",
"description": "Specifies the disk type.\nChanging this will create a new CCE node pool resource.\n"
}
},
"type": "object",
"required": [
"size",
"volumetype"
]
},
"flexibleengine:index/CceNodePoolV3Taint:CceNodePoolV3Taint": {
"properties": {
"effect": {
"type": "string",
"description": "Available options are *NoSchedule*, *PreferNoSchedule* and *NoExecute*.\n"
},
"key": {
"type": "string",
"description": "A key must contain 1 to 63 characters starting with a letter or digit.\nOnly letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.\nA DNS subdomain name can be used as the prefix of a key.\n"
},
"value": {
"type": "string",
"description": "A value must start with a letter or digit and can contain a maximum of 63 characters,\nincluding letters, digits, hyphens (-), underscores (_), and periods (.).\n"
}
},
"type": "object",
"required": [
"effect",
"key",
"value"
]
},
"flexibleengine:index/CceNodePoolV3Timeouts:CceNodePoolV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CceNodeV3DataVolume:CceNodeV3DataVolume": {
"properties": {
"extendParams": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the disk expansion parameters in key/value pair format.\nChanging this will create a new resource.\n"
},
"kmsKeyId": {
"type": "string",
"description": "Specifies the ID of a KMS key. This is used to encrypt the volume.\nChanging this will create a new resource.\n\n> You need to create an agency (EVSAccessKMS) when disk encryption is used in the current project for the first\ntime ever. The account and permission of the created agency are `op_svc_evs` and **KMS Administrator**, respectively.\n"
},
"size": {
"type": "number",
"description": "Specifies the disk size in GB.Changing this will create a new resource.\n"
},
"volumetype": {
"type": "string",
"description": "Specifies the disk type.Changing this will create a new resource.\n"
}
},
"type": "object",
"required": [
"size",
"volumetype"
]
},
"flexibleengine:index/CceNodeV3RootVolume:CceNodeV3RootVolume": {
"properties": {
"extendParams": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the disk expansion parameters in key/value pair format.\n"
},
"kmsKeyId": {
"type": "string",
"description": "Specifies the ID of a KMS key. This is used to encrypt the volume.\n\n> You need to create an agency (EVSAccessKMS) when disk encryption is used in the current project for the first time ever.\nThe account and permission of the created agency are `op_svc_evs` and **KMS Administrator**, respectively.\n"
},
"size": {
"type": "number",
"description": "Specifies the disk size in GB.\n"
},
"volumetype": {
"type": "string",
"description": "Specifies the disk type.\n"
}
},
"type": "object",
"required": [
"size",
"volumetype"
]
},
"flexibleengine:index/CceNodeV3Taint:CceNodeV3Taint": {
"properties": {
"effect": {
"type": "string",
"description": "Available options are NoSchedule, PreferNoSchedule, and NoExecute.\nChanging this parameter will create a new resource.\n"
},
"key": {
"type": "string",
"description": "A key must contain 1 to 63 characters starting with a letter or digit. Only\nletters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain name can be used as\nthe prefix of a key. Changing this parameter will create a new resource.\n"
},
"value": {
"type": "string",
"description": "A value must start with a letter or digit and can contain a maximum of 63\ncharacters, including letters, digits, hyphens (-), underscores (_), and periods (.).Changing this parameter will\ncreate a new resource.\n"
}
},
"type": "object",
"required": [
"effect",
"key",
"value"
]
},
"flexibleengine:index/CceNodeV3Timeouts:CceNodeV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CcePvcTimeouts:CcePvcTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CesAlarmruleAlarmAction:CesAlarmruleAlarmAction": {
"properties": {
"notificationLists": {
"type": "array",
"items": {
"type": "string"
},
"description": "specifies the list of objects to be notified\nif the alarm status changes, the maximum length is 5.\nif type is set to *notification*, the value of notification_list cannot be empty.\nif type is set to *autoscaling*, the value of notification_list must be **[]**\nand the value of namespace must be *SYS.AS*.\nNote: to enable the autoscaling alarm rules take effect, you must bind scaling\npolicies.\n"
},
"type": {
"type": "string",
"description": "specifies the type of action triggered by an alarm. the\nvalue can be *notification* or *autoscaling*.\n- notification: indicates that a notification will be sent to the user.\n- autoscaling: indicates that a scaling action will be triggered.\n"
}
},
"type": "object",
"required": [
"notificationLists",
"type"
]
},
"flexibleengine:index/CesAlarmruleCondition:CesAlarmruleCondition": {
"properties": {
"comparisonOperator": {
"type": "string",
"description": "Specifies the comparison condition of alarm\nthresholds. The value can be >, =, <, >=, or <=.\n"
},
"count": {
"type": "number",
"description": "Specifies the number of consecutive occurrence times.\nThe value ranges from 1 to 5.\n"
},
"filter": {
"type": "string",
"description": "Specifies the data rollup methods. The value can be\nmax, min, average, sum, and vaiance.\n"
},
"period": {
"type": "number",
"description": "Specifies the alarm checking period in seconds. The\nvalue can be 1, 300, 1200, 3600, 14400, and 86400.\nNote: If period is set to 1, the raw metric data is used to determine\nwhether to generate an alarm.\n"
},
"suppressDuration": {
"type": "number"
},
"unit": {
"type": "string",
"description": "Specifies the data unit.\n"
},
"value": {
"type": "number",
"description": "Specifies the alarm threshold. The value ranges from\n0 to Number of 1.7976931348623157e+308.\n"
}
},
"type": "object",
"required": [
"comparisonOperator",
"count",
"filter",
"period",
"value"
],
"language": {
"nodejs": {
"requiredOutputs": [
"comparisonOperator",
"count",
"filter",
"period",
"suppressDuration",
"value"
]
}
}
},
"flexibleengine:index/CesAlarmruleInsufficientdataAction:CesAlarmruleInsufficientdataAction": {
"properties": {
"notificationLists": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "string"
}
},
"type": "object",
"required": [
"notificationLists",
"type"
]
},
"flexibleengine:index/CesAlarmruleMetric:CesAlarmruleMetric": {
"properties": {
"dimensions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleMetricDimension:CesAlarmruleMetricDimension"
},
"description": "Specifies the list of metric dimensions. Currently,\nthe maximum length of the dimesion list that are supported is 3. The structure\nis described below.\n"
},
"metricName": {
"type": "string",
"description": "Specifies the metric name. The value can be a string\nof 1 to 64 characters that must start with a letter and can consists of uppercase\nletters, lowercase letters, numbers, or underscores (_).\n"
},
"namespace": {
"type": "string",
"description": "Specifies the namespace in **service.item** format.\nservice.item can be a string of 3 to 32 characters that must start with a letter and\ncan consists of uppercase letters, lowercase letters, numbers, or underscores (_).\nFor details, see [Services Interconnected with Cloud Eye](https://docs.prod-cloud-ocb.orange-business.com/en-us/api/ces/ces_03_0059.html).\n"
}
},
"type": "object",
"required": [
"dimensions",
"metricName",
"namespace"
]
},
"flexibleengine:index/CesAlarmruleMetricDimension:CesAlarmruleMetricDimension": {
"properties": {
"name": {
"type": "string",
"description": "Specifies the dimension name. The value can be a string\nof 1 to 32 characters that must start with a letter and can consists of uppercase\nletters, lowercase letters, numbers, underscores (_), or hyphens (-).\n"
},
"value": {
"type": "string",
"description": "Specifies the dimension value. The value can be a string\nof 1 to 64 characters that must start with a letter or a number and can consists\nof uppercase letters, lowercase letters, numbers, underscores (_), or hyphens\n(-).\n"
}
},
"type": "object",
"required": [
"name",
"value"
]
},
"flexibleengine:index/CesAlarmruleOkAction:CesAlarmruleOkAction": {
"properties": {
"notificationLists": {
"type": "array",
"items": {
"type": "string"
},
"description": "specifies the list of objects to be notified\nif the alarm status changes, the maximum length is 5.\n"
},
"type": {
"type": "string",
"description": "specifies the type of action triggered by an alarm. the\nvalue is notification.\nnotification: indicates that a notification will be sent to the user.\n"
}
},
"type": "object",
"required": [
"notificationLists",
"type"
]
},
"flexibleengine:index/CesAlarmruleTimeouts:CesAlarmruleTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ComputeBmsServerV2BlockDevice:ComputeBmsServerV2BlockDevice": {
"properties": {
"bootIndex": {
"type": "number"
},
"deleteOnTermination": {
"type": "boolean"
},
"destinationType": {
"type": "string"
},
"deviceName": {
"type": "string"
},
"guestFormat": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"uuid": {
"type": "string",
"description": "The network UUID to attach to the bms server.\nChanging this creates a new bms server. It is Required unless `port` or `name` is provided\n"
},
"volumeSize": {
"type": "number"
},
"volumeType": {
"type": "string"
}
},
"type": "object",
"required": [
"sourceType"
]
},
"flexibleengine:index/ComputeBmsServerV2Network:ComputeBmsServerV2Network": {
"properties": {
"accessNetwork": {
"type": "boolean",
"description": "Specifies if this network should be used for\nprovisioning access. Accepts true or false. Defaults to false.\n"
},
"fixedIpV4": {
"type": "string",
"description": "Specifies a fixed IPv4 address to be used on this\nnetwork. Changing this creates a new bms server.\n"
},
"fixedIpV6": {
"type": "string",
"description": "Specifies a fixed IPv6 address to be used on this\nnetwork. Changing this creates a new bms server.\n"
},
"mac": {
"type": "string"
},
"name": {
"type": "string",
"description": "The human-readable name of the network. Changing this creates a new bms server.\nIt is Required unless `uuid` or `port` is provided.\n"
},
"port": {
"type": "string",
"description": "The port UUID of a network to attach to the bms server.\nChanging this creates a new server.It is Required unless `uuid` or `name` is provided\n"
},
"uuid": {
"type": "string",
"description": "The network UUID to attach to the bms server.\nChanging this creates a new bms server. It is Required unless `port` or `name` is provided\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"fixedIpV4",
"fixedIpV6",
"mac",
"name",
"port",
"uuid"
]
}
}
},
"flexibleengine:index/ComputeBmsServerV2Timeouts:ComputeBmsServerV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ComputeInstanceV2BlockDevice:ComputeInstanceV2BlockDevice": {
"properties": {
"bootIndex": {
"type": "number",
"description": "The boot index of the volume. It defaults to 0, which\nindicates that it's a system disk. Changing this creates a new server.\n"
},
"deleteOnTermination": {
"type": "boolean",
"description": "Delete the volume / block device upon\ntermination of the instance. Defaults to false. Changing this creates a new server.\n"
},
"destinationType": {
"type": "string",
"description": "The type that gets created. Possible values\nare \"volume\" and \"local\". Changing this creates a new server.\n"
},
"deviceName": {
"type": "string"
},
"deviceType": {
"type": "string"
},
"diskBus": {
"type": "string",
"description": "The low-level disk bus that will be used, for example, *virtio*, *scsi*.\nMost common thing is to leave this empty. Changing this creates a new server.\n\n\nThe `scheduler_hints` block supports:\n"
},
"guestFormat": {
"type": "string"
},
"sourceType": {
"type": "string",
"description": "The source type of the device. Must be one of\n\"blank\", \"image\", \"volume\", or \"snapshot\". Changing this creates a new server.\n"
},
"uuid": {
"type": "string",
"description": "The UUID of the image, volume, or snapshot.\nIt is Required unless `source_type` is set to `\"blank\"`. Changing this creates a new server.\n"
},
"volumeSize": {
"type": "number",
"description": "The size of the volume to create (in gigabytes). Required\nin the following combinations: source=image and destination=volume, source=blank and destination=local,\nand source=blank and destination=volume. Changing this creates a new server.\n"
},
"volumeType": {
"type": "string",
"description": "Currently, the value can be `SSD` (ultra-I/O disk type),\n`SAS` (high I/O disk type), or `SATA` (common I/O disk type). Changing this creates a new server.\n"
}
},
"type": "object",
"required": [
"sourceType"
]
},
"flexibleengine:index/ComputeInstanceV2Network:ComputeInstanceV2Network": {
"properties": {
"accessNetwork": {
"type": "boolean",
"description": "Specifies if this network should be used for\nprovisioning access. Accepts true or false. Defaults to false.\n\n\nThe `block_device` block supports:\n"
},
"fixedIpV4": {
"type": "string",
"description": "Specifies a fixed IPv4 address to be used on this\nnetwork. Changing this creates a new server.\n"
},
"fixedIpV6": {
"type": "string",
"description": "Specifies a fixed IPv6 address to be used on this\nnetwork. Changing this creates a new server.\n"
},
"mac": {
"type": "string",
"description": "The MAC address of the NIC on that network.\n"
},
"name": {
"type": "string",
"description": "A unique name for the resource.\n",
"deprecationMessage": "Deprecated"
},
"port": {
"type": "string",
"description": "The port UUID of a network to attach to the server.\nIt is **Required** unless `uuid` is provided. Changing this creates a new server.\n"
},
"uuid": {
"type": "string",
"description": "The UUID of the image, volume, or snapshot.\nIt is Required unless `source_type` is set to `\"blank\"`. Changing this creates a new server.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"fixedIpV4",
"fixedIpV6",
"mac",
"name",
"port",
"uuid"
]
}
}
},
"flexibleengine:index/ComputeInstanceV2Personality:ComputeInstanceV2Personality": {
"properties": {
"content": {
"type": "string"
},
"file": {
"type": "string"
}
},
"type": "object",
"required": [
"content",
"file"
]
},
"flexibleengine:index/ComputeInstanceV2SchedulerHint:ComputeInstanceV2SchedulerHint": {
"properties": {
"buildNearHostIp": {
"type": "string",
"deprecationMessage": "Deprecated"
},
"dehId": {
"type": "string",
"description": "Specifies the DeH ID.This parameter takes effect only when the value of tenancy\nis dedicated. If you do not specify this parameter, the system will automatically assign a DeH to you to deploy ECSs.\n"
},
"differentHosts": {
"type": "array",
"items": {
"type": "string"
},
"deprecationMessage": "Deprecated"
},
"group": {
"type": "string",
"description": "Specifies the **anti-affinity** group ID.\nThe instance will be placed into that group. Changing this creates a new server.\n"
},
"queries": {
"type": "array",
"items": {
"type": "string"
},
"deprecationMessage": "Deprecated"
},
"sameHosts": {
"type": "array",
"items": {
"type": "string"
},
"deprecationMessage": "Deprecated"
},
"targetCell": {
"type": "string",
"deprecationMessage": "Deprecated"
},
"tenancy": {
"type": "string",
"description": "Specifies whether the ECS is created on a Dedicated Host (DeH) or in a\nshared pool (default). The value can be **shared** or **dedicated**.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"dehId"
]
}
}
},
"flexibleengine:index/ComputeInstanceV2Timeouts:ComputeInstanceV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ComputeInstanceV2VolumeAttached:ComputeInstanceV2VolumeAttached": {
"properties": {
"bootIndex": {
"type": "number",
"description": "The boot index of the volume. It defaults to 0, which\nindicates that it's a system disk. Changing this creates a new server.\n"
},
"pciAddress": {
"type": "string",
"description": "The volume pci address on that attachment.\n"
},
"size": {
"type": "number",
"description": "The volume size on that attachment.\n"
},
"type": {
"type": "string",
"description": "The volume type on that attachment.\n"
},
"uuid": {
"type": "string",
"description": "The UUID of the image, volume, or snapshot.\nIt is Required unless `source_type` is set to `\"blank\"`. Changing this creates a new server.\n"
}
},
"type": "object",
"required": [
"bootIndex",
"pciAddress",
"size",
"type",
"uuid"
]
},
"flexibleengine:index/ComputeInterfaceAttachV2Timeouts:ComputeInterfaceAttachV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ComputeVolumeAttachV2Timeouts:ComputeVolumeAttachV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CsbsBackupPolicyV1Resource:CsbsBackupPolicyV1Resource": {
"properties": {
"id": {
"type": "string",
"description": "Specifies the ID of the object to be backed up.\n"
},
"name": {
"type": "string",
"description": "Specifies backup object name.\n"
},
"type": {
"type": "string",
"description": "Entity object type of the backup object.\nIf the type is VMs, the value is **OS::Nova::Server**.\n"
}
},
"type": "object",
"required": [
"id",
"name",
"type"
]
},
"flexibleengine:index/CsbsBackupPolicyV1ScheduledOperation:CsbsBackupPolicyV1ScheduledOperation": {
"properties": {
"description": {
"type": "string",
"description": "Specifies Scheduling period description.The value consists of 0 to 255\ncharacters and must not contain a greater-than sign (>) or less-than sign (<).\n"
},
"enabled": {
"type": "boolean",
"description": "Specifies whether the scheduling period is enabled. Default value is **true**.\n"
},
"id": {
"type": "string",
"description": "Specifies Scheduling period ID.\n"
},
"maxBackups": {
"type": "number",
"description": "Specifies maximum number of backups that can be automatically created for a\nbackup object.\n"
},
"name": {
"type": "string",
"description": "Specifies Scheduling period name.The value consists of 1 to 255 characters and\ncan contain only letters, digits, underscores (_), and hyphens (-).\n"
},
"operationType": {
"type": "string",
"description": "Specifies Operation type, which can be backup.\n"
},
"permanent": {
"type": "boolean",
"description": "Specifies whether backups are permanently retained.\n"
},
"retentionDurationDays": {
"type": "number",
"description": "Specifies duration of retaining a backup, in days.\n"
},
"triggerId": {
"type": "string",
"description": "Specifies Scheduler ID.\n"
},
"triggerName": {
"type": "string",
"description": "Specifies Scheduler name.\n"
},
"triggerPattern": {
"type": "string",
"description": "Specifies Scheduling policy of the scheduler.\n"
},
"triggerType": {
"type": "string",
"description": "Specifies Scheduler type.\n"
}
},
"type": "object",
"required": [
"operationType",
"triggerPattern"
],
"language": {
"nodejs": {
"requiredOutputs": [
"id",
"operationType",
"permanent",
"triggerId",
"triggerName",
"triggerPattern",
"triggerType"
]
}
}
},
"flexibleengine:index/CsbsBackupPolicyV1Timeouts:CsbsBackupPolicyV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CsbsBackupV1Timeouts:CsbsBackupV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CsbsBackupV1VmMetadata:CsbsBackupV1VmMetadata": {
"properties": {
"cloudServiceType": {
"type": "string",
"description": "Specifies ECS type.\n"
},
"disk": {
"type": "number",
"description": "Shows system disk size corresponding to the ECS specifications.\n"
},
"eip": {
"type": "string",
"description": "Specifies elastic IP address of the ECS.\n"
},
"imageType": {
"type": "string",
"description": "Specifies image type.\n"
},
"name": {
"type": "string",
"description": "Name of backup data.\n"
},
"privateIp": {
"type": "string",
"description": "It specifies internal IP address of the ECS.\n"
},
"ram": {
"type": "number",
"description": "Specifies memory size of the ECS, in MB.\n"
},
"vcpus": {
"type": "number",
"description": "Specifies CPU cores corresponding to the ECS.\n"
}
},
"type": "object",
"required": [
"cloudServiceType",
"disk",
"eip",
"imageType",
"name",
"privateIp",
"ram",
"vcpus"
]
},
"flexibleengine:index/CsbsBackupV1VolumeBackup:CsbsBackupV1VolumeBackup": {
"properties": {
"averageSpeed": {
"type": "number",
"description": "Specifies the average speed.\n"
},
"bootable": {
"type": "boolean",
"description": "Specifies whether the disk is bootable.\n"
},
"id": {
"type": "string",
"description": "Specifies Cinder backup ID.\n"
},
"imageType": {
"type": "string",
"description": "Specifies image type.\n"
},
"incremental": {
"type": "boolean",
"description": "Shows whether incremental backup is used.\n"
},
"name": {
"type": "string",
"description": "Name of backup data.\n"
},
"size": {
"type": "number",
"description": "Specifies accumulated size (MB) of backups.\n"
},
"snapshotId": {
"type": "string",
"description": "ID of snapshot.\n"
},
"sourceVolumeId": {
"type": "string",
"description": "It specifies source volume ID.\n"
},
"sourceVolumeName": {
"type": "string",
"description": "Specifies source volume name.\n"
},
"sourceVolumeSize": {
"type": "number",
"description": "Shows source volume size in GB.\n"
},
"spaceSavingRatio": {
"type": "number",
"description": "Specifies space saving rate.\n"
},
"status": {
"type": "string",
"description": "Status of backup Volume.\n"
}
},
"type": "object",
"required": [
"averageSpeed",
"bootable",
"id",
"imageType",
"incremental",
"name",
"size",
"snapshotId",
"sourceVolumeId",
"sourceVolumeName",
"sourceVolumeSize",
"spaceSavingRatio",
"status"
]
},
"flexibleengine:index/CseMicroserviceEngineConfigCenterAddress:CseMicroserviceEngineConfigCenterAddress": {
"properties": {
"private": {
"type": "string",
"description": "The internal access address.\n"
},
"public": {
"type": "string",
"description": "The public access address. This address is only set when EIP is bound.\n"
}
},
"type": "object",
"required": [
"private",
"public"
]
},
"flexibleengine:index/CseMicroserviceEngineServiceRegistryAddress:CseMicroserviceEngineServiceRegistryAddress": {
"properties": {
"private": {
"type": "string",
"description": "The internal access address.\n"
},
"public": {
"type": "string",
"description": "The public access address. This address is only set when EIP is bound.\n"
}
},
"type": "object",
"required": [
"private",
"public"
]
},
"flexibleengine:index/CseMicroserviceEngineTimeouts:CseMicroserviceEngineTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CseMicroserviceInstanceDataCenter:CseMicroserviceInstanceDataCenter": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "Specifies the custom availability zone name of the data center.\nChanging this will create a new microservice instance.\n"
},
"name": {
"type": "string",
"description": "Specifies the data center name.\nChanging this will create a new microservice instance.\n"
},
"region": {
"type": "string",
"description": "Specifies the custom region name of the data center.\nChanging this will create a new microservice instance.\n"
}
},
"type": "object",
"required": [
"availabilityZone",
"name",
"region"
]
},
"flexibleengine:index/CseMicroserviceInstanceHealthCheck:CseMicroserviceInstanceHealthCheck": {
"properties": {
"interval": {
"type": "number",
"description": "Specifies the heartbeat interval. The unit is **s** (second).\nChanging this will create a new microservice instance.\n"
},
"maxRetries": {
"type": "number",
"description": "Specifies the maximum retries.\nChanging this will create a new microservice instance.\n"
},
"mode": {
"type": "string",
"description": "Specifies the heartbeat mode. The valid values are **push** and **pull**.\nChanging this will create a new microservice instance.\n"
},
"port": {
"type": "number",
"description": "Specifies the port number.\nChanging this will create a new microservice instance.\n\n\nThe `data_center` block supports:\n"
}
},
"type": "object",
"required": [
"interval",
"maxRetries",
"mode"
],
"language": {
"nodejs": {
"requiredOutputs": [
"interval",
"maxRetries",
"mode",
"port"
]
}
}
},
"flexibleengine:index/CssClusterV1BackupStrategy:CssClusterV1BackupStrategy": {
"properties": {
"keepDays": {
"type": "number",
"description": "Specifies the number of days to retain the generated\nsnapshots. Snapshots are reserved for seven days by default.\n"
},
"prefix": {
"type": "string",
"description": "Specifies the prefix of the snapshot that is automatically\ncreated. The default value is \"snapshot\".\n"
},
"startTime": {
"type": "string",
"description": "Specifies the time when a snapshot is automatically\ncreated everyday. Snapshots can only be created on the hour. The time format is\nthe time followed by the time zone, specifically, **HH:mm z**. In the format, HH:mm\nrefers to the hour time and z refers to the time zone. For example, \"00:00 GMT+01:00\"\nand \"01:00 GMT+03:00\".\n"
}
},
"type": "object",
"required": [
"startTime"
]
},
"flexibleengine:index/CssClusterV1Node:CssClusterV1Node": {
"properties": {
"id": {
"type": "string",
"description": "Instance ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the cluster name. It contains 4 to 32 characters. Only letters,\ndigits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.\nChanging this parameter will create a new resource.\n"
},
"type": {
"type": "string",
"description": "Supported type: ess (indicating the Elasticsearch node).\n"
}
},
"type": "object",
"required": [
"id",
"name",
"type"
]
},
"flexibleengine:index/CssClusterV1NodeConfig:CssClusterV1NodeConfig": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "Specifies the availability zone(s). You can set multiple\nvailability zones, and use commas (,) to separate one from another. Cluster instances will be evenly distributed to\neach AZ. The `node_number` should be greater than or equal to the number of available zones.\nChanging this parameter will create a new resource.\n\n\nThe `network_info` block supports:\n"
},
"flavor": {
"type": "string",
"description": "Specifies the instance flavor name. For example: value range of flavor `ess.\nspec-2u8g`:\n40 GB to 800 GB; value range of flavor `ess.spec-4u16g`: 40 GB to 1600 GB; value range of flavor `ess.spec-8u32g`:\n80 GB to 3200 GB; value range of flavor `ess.spec-16u64g`: 100 GB to 6400 GB; value range of flavor `ess.spec-32u128g`:\n100 GB to 10240 GB. Changing this parameter will create a new resource.\n"
},
"networkInfo": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1NodeConfigNetworkInfo:CssClusterV1NodeConfigNetworkInfo",
"description": "Specifies the network information. network_info\nobject structure is documented below. Changing this parameter will create a new resource.\n"
},
"volume": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1NodeConfigVolume:CssClusterV1NodeConfigVolume",
"description": "Specifies the information about the volume. volume\nobject structure is documented below. Changing this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"flavor",
"networkInfo",
"volume"
]
},
"flexibleengine:index/CssClusterV1NodeConfigNetworkInfo:CssClusterV1NodeConfigNetworkInfo": {
"properties": {
"securityGroupId": {
"type": "string",
"description": "Specifies the security group ID. All instances in a cluster must\nhave the same security group. Changing this parameter will create a new resource.\n\n\nThe `volume` block supports:\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet. All instances in a cluster must have\nthe same subnet which should be configured with a **DNS address**. Changing this parameter will create a new resource.\n"
},
"vpcId": {
"type": "string",
"description": "Specifies the VPC ID, which is used for configuring cluster network.\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"securityGroupId",
"subnetId",
"vpcId"
]
},
"flexibleengine:index/CssClusterV1NodeConfigVolume:CssClusterV1NodeConfigVolume": {
"properties": {
"size": {
"type": "number",
"description": "Specifies the volume size in GB, which must be a multiple of 10.\n"
},
"volumeType": {
"type": "string",
"description": "Specifies the volume type. Changing this parameter will create a new\nresource. Supported value:\n- **COMMON**: The SATA disk is used;\n- **HIGH**: The SAS disk is used;\n- **ULTRAHIGH**: The solid-state drive (SSD) is used.\n\n\nThe `backup_strategy` block supports:\n"
}
},
"type": "object",
"required": [
"size",
"volumeType"
]
},
"flexibleengine:index/CssClusterV1Timeouts:CssClusterV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CssSnapshotV1Timeouts:CssSnapshotV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/CtsTrackerV1Timeouts:CtsTrackerV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DcsBackupV1Timeouts:DcsBackupV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DcsInstanceV1Timeouts:DcsInstanceV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DdmAccountSchema:DdmAccountSchema": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the DDM account.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the associated schema.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"description",
"name"
]
}
}
},
"flexibleengine:index/DdmAccountTimeouts:DdmAccountTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DdmInstanceNode:DdmInstanceNode": {
"properties": {
"ip": {
"type": "string",
"description": "Indicates the IP address of the DDM instance node.\n"
},
"port": {
"type": "string",
"description": "Indicates the port of the DDM instance node.\n"
},
"status": {
"type": "string",
"description": "Indicates the status of the DDM instance node.\n"
}
},
"type": "object",
"required": [
"ip",
"port",
"status"
]
},
"flexibleengine:index/DdmInstanceTimeouts:DdmInstanceTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DdmSchemaDataNode:DdmSchemaDataNode": {
"properties": {
"adminPassword": {
"type": "string",
"description": "Specifies the password for logging in to the associated RDS instance.\n",
"secret": true
},
"adminUser": {
"type": "string",
"description": "Specifies the username for logging in to the associated RDS instance.\n"
},
"id": {
"type": "string",
"description": "Specifies the ID of the RDS instance associated with the schema.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the DDM schema.\nAn instance name starts with a letter, consists of 2 to 48 characters, and can contain only lowercase letters,\ndigits, and underscores (_). Cannot contain keywords information_schema, mysql, performance_schema, or sys.\n\nChanging this parameter will create a new resource.\n"
},
"status": {
"type": "string",
"description": "Indicates the status of the associated RDS instance.\n"
}
},
"type": "object",
"required": [
"adminPassword",
"adminUser",
"id"
],
"language": {
"nodejs": {
"requiredOutputs": [
"adminPassword",
"adminUser",
"id",
"name",
"status"
]
}
}
},
"flexibleengine:index/DdmSchemaShard:DdmSchemaShard": {
"properties": {
"dbSlot": {
"type": "number",
"description": "Indicates the number of shards.\n"
},
"id": {
"type": "string",
"description": "Specifies the ID of the RDS instance associated with the schema.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the DDM schema.\nAn instance name starts with a letter, consists of 2 to 48 characters, and can contain only lowercase letters,\ndigits, and underscores (_). Cannot contain keywords information_schema, mysql, performance_schema, or sys.\n\nChanging this parameter will create a new resource.\n"
},
"status": {
"type": "string",
"description": "Indicates the status of the associated RDS instance.\n"
}
},
"type": "object",
"required": [
"dbSlot",
"id",
"name",
"status"
]
},
"flexibleengine:index/DdmSchemaTimeouts:DdmSchemaTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DdsBackupDatastore:DdsBackupDatastore": {
"properties": {
"type": {
"type": "string",
"description": "Indicates the DB engine.\n"
},
"version": {
"type": "string",
"description": "Indicates the database version. The value can be **4.2**, **4.0**, or **3.4**.\n"
}
},
"type": "object",
"required": [
"type",
"version"
]
},
"flexibleengine:index/DdsBackupTimeouts:DdsBackupTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DdsDatabaseRoleInheritedPrivilege:DdsDatabaseRoleInheritedPrivilege": {
"properties": {
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The operation permission list.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FDdsDatabaseRoleInheritedPrivilegeResource:DdsDatabaseRoleInheritedPrivilegeResource"
},
"description": "The details of the resource to which the privilege belongs.\nThe object structure is documented below.\n"
}
},
"type": "object",
"required": [
"actions",
"resources"
]
},
"flexibleengine:index/DdsDatabaseRoleInheritedPrivilegeResource:DdsDatabaseRoleInheritedPrivilegeResource": {
"properties": {
"collection": {
"type": "string",
"description": "The database collection type.\n"
},
"dbName": {
"type": "string",
"description": "Specifies the database name to which this owned role belongs.\nChanging this parameter will create a new role.\n"
}
},
"type": "object",
"required": [
"collection",
"dbName"
]
},
"flexibleengine:index/DdsDatabaseRolePrivilege:DdsDatabaseRolePrivilege": {
"properties": {
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The operation permission list.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FDdsDatabaseRolePrivilegeResource:DdsDatabaseRolePrivilegeResource"
},
"description": "The details of the resource to which the privilege belongs.\nThe object structure is documented below.\n"
}
},
"type": "object",
"required": [
"actions",
"resources"
]
},
"flexibleengine:index/DdsDatabaseRolePrivilegeResource:DdsDatabaseRolePrivilegeResource": {
"properties": {
"collection": {
"type": "string",
"description": "The database collection type.\n"
},
"dbName": {
"type": "string",
"description": "Specifies the database name to which this owned role belongs.\nChanging this parameter will create a new role.\n"
}
},
"type": "object",
"required": [
"collection",
"dbName"
]
},
"flexibleengine:index/DdsDatabaseRoleRole:DdsDatabaseRoleRole": {
"properties": {
"dbName": {
"type": "string",
"description": "Specifies the database name to which this owned role belongs.\nChanging this parameter will create a new role.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of role owned by the current role.\nThe name can contain `1` to `64` characters, only letters, digits, underscores (_), hyphens (-) and dots (.) are\nallowed. Changing this parameter will create a new role.\n"
}
},
"type": "object",
"required": [
"dbName",
"name"
]
},
"flexibleengine:index/DdsDatabaseRoleTimeouts:DdsDatabaseRoleTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DdsDatabaseUserInheritedPrivilege:DdsDatabaseUserInheritedPrivilege": {
"properties": {
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The operation permission list.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FDdsDatabaseUserInheritedPrivilegeResource:DdsDatabaseUserInheritedPrivilegeResource"
},
"description": "The details of the resource to which the privilege belongs.\nThe object structure is documented below.\n"
}
},
"type": "object",
"required": [
"actions",
"resources"
]
},
"flexibleengine:index/DdsDatabaseUserInheritedPrivilegeResource:DdsDatabaseUserInheritedPrivilegeResource": {
"properties": {
"collection": {
"type": "string",
"description": "The database collection type.\n"
},
"dbName": {
"type": "string",
"description": "Specifies the database name to which this owned role belongs.\nChanging this parameter will create a new user.\n"
}
},
"type": "object",
"required": [
"collection",
"dbName"
]
},
"flexibleengine:index/DdsDatabaseUserPrivilege:DdsDatabaseUserPrivilege": {
"properties": {
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The operation permission list.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FDdsDatabaseUserPrivilegeResource:DdsDatabaseUserPrivilegeResource"
},
"description": "The details of the resource to which the privilege belongs.\nThe object structure is documented below.\n"
}
},
"type": "object",
"required": [
"actions",
"resources"
]
},
"flexibleengine:index/DdsDatabaseUserPrivilegeResource:DdsDatabaseUserPrivilegeResource": {
"properties": {
"collection": {
"type": "string",
"description": "The database collection type.\n"
},
"dbName": {
"type": "string",
"description": "Specifies the database name to which this owned role belongs.\nChanging this parameter will create a new user.\n"
}
},
"type": "object",
"required": [
"collection",
"dbName"
]
},
"flexibleengine:index/DdsDatabaseUserRole:DdsDatabaseUserRole": {
"properties": {
"dbName": {
"type": "string",
"description": "Specifies the database name to which this owned role belongs.\nChanging this parameter will create a new user.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of role owned by the current user.\nThe name can contain `1` to `64` characters, only letters, digits, underscores (_), hyphens (-) and dots (.) are\nallowed. Changing this parameter will create a new user.\n"
}
},
"type": "object",
"required": [
"dbName",
"name"
]
},
"flexibleengine:index/DdsDatabaseUserTimeouts:DdsDatabaseUserTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DdsInstanceV3BackupStrategy:DdsInstanceV3BackupStrategy": {
"properties": {
"keepDays": {
"type": "number",
"description": "Specifies the number of days to retain the generated backup files.\nThe value range is from 0 to 732.\n+ If this parameter is set to 0, the automated backup policy is not set.\n+ If this parameter is not transferred, the automated backup policy is enabled by default.\nBackup files are stored for seven days by default.\n"
},
"startTime": {
"type": "string",
"description": "Specifies the backup time window. Automated backups will be triggered\nduring the backup time window. The value cannot be empty. It must be a valid value in the\n\"hh:mm-HH:MM\" format. The current time is in the UTC format.\n+ The HH value must be 1 greater than the hh value.\n+ The values from mm and MM must be the same and must be set to any of the following 00, 15, 30, or 45.\n"
}
},
"type": "object",
"required": [
"keepDays",
"startTime"
]
},
"flexibleengine:index/DdsInstanceV3Datastore:DdsInstanceV3Datastore": {
"properties": {
"storageEngine": {
"type": "string",
"description": "Specifies the storage engine of the DB instance. The valid values are\n`wiredTiger` and `rocksDB`.Changing this will create a new resource.\n\n\nThe `flavor` block supports:\n"
},
"type": {
"type": "string",
"description": "Specifies the node type. Valid value: mongos, shard, config, replica.\nChanging this creates a new resource.\n"
},
"version": {
"type": "string",
"description": "Specifies the DB instance version. The valid values are 3.4, 4.0 and 4.2.\nChanging this will create a new resource.\n"
}
},
"type": "object",
"required": [
"type",
"version"
]
},
"flexibleengine:index/DdsInstanceV3Flavor:DdsInstanceV3Flavor": {
"properties": {
"num": {
"type": "number",
"description": "Specifies the node quantity. Valid value:\n+ the number of mongos ranges from 2 to 12.\n+ the number of shard ranges from 2 to 12.\n+ config: the value is 1.\n+ replica: the value is 1.\nChanging this creates a new resource.\n"
},
"size": {
"type": "number",
"description": "Specifies the disk size. The value must be a multiple of 10. The unit is GB.\nThis parameter is mandatory for nodes except mongos and invalid for mongos. Changing this creates a new resource.\n"
},
"specCode": {
"type": "string",
"description": "Specifies the resource specification code.\nChanging this creates a new resource. Valid values:\n\nengine_name | type | vcpus | ram | speccode\n---- | --- | ---\nDDS-Community | mongos | 1 | 4 | dds.mongodb.s3.medium.4.mongos\nDDS-Community | mongos | 2 | 8 | dds.mongodb.s3.large.4.mongos\nDDS-Community | mongos | 4 | 16 | dds.mongodb.s3.xlarge.4.mongos\nDDS-Community | mongos | 8 | 32 | dds.mongodb.s3.2xlarge.4.mongos\nDDS-Community | mongos | 16 | 64 | dds.mongodb.s3.4xlarge.4.mongos\nDDS-Community | shard | 1 | 4 | dds.mongodb.s3.medium.4.shard\nDDS-Community | shard | 2 | 8 | dds.mongodb.s3.large.4.shard\nDDS-Community | shard | 4 | 16 | dds.mongodb.s3.xlarge.4.shard\nDDS-Community | shard | 8 | 32 | dds.mongodb.s3.2xlarge.4.shard\nDDS-Community | shard | 16 | 64 | dds.mongodb.s3.4xlarge.4.shard\nDDS-Community | config | 2 | 4 | dds.mongodb.s3.large.2.config\nDDS-Community | replica | 1 | 4 | dds.mongodb.s3.medium.4.repset\nDDS-Community | replica | 2 | 8 | dds.mongodb.s3.large.4.repset\nDDS-Community | replica | 4 | 16 | dds.mongodb.s3.xlarge.4.repset\nDDS-Community | replica | 8 | 32 | dds.mongodb.s3.2xlarge.4.repset\nDDS-Community | replica | 16 | 64 | dds.mongodb.s3.4xlarge.4.repset\n\n\nThe `backup_strategy` block supports:\n"
},
"storage": {
"type": "string",
"description": "Specifies the disk type. Valid value: ULTRAHIGH which indicates the type SSD.\nChanging this creates a new resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the node type. Valid value: mongos, shard, config, replica.\nChanging this creates a new resource.\n"
}
},
"type": "object",
"required": [
"num",
"specCode",
"type"
]
},
"flexibleengine:index/DdsInstanceV3Node:DdsInstanceV3Node": {
"properties": {
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the DB instance name. The DB instance name of the same\ntype is unique in the same tenant. Changing this creates a new instance.\n"
},
"privateIp": {
"type": "string",
"description": "Indicates the private IP address of a node. This parameter is valid only for\nmongos nodes, replica set instances, and single node instances.\n"
},
"publicIp": {
"type": "string",
"description": "Indicates the EIP that has been bound on a node. This parameter is valid only for\nmongos nodes of cluster instances, primary nodes and secondary nodes of replica set instances,\nand single node instances.\n"
},
"role": {
"type": "string",
"description": "Indicates the node role.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
},
"type": {
"type": "string",
"description": "Specifies the node type. Valid value: mongos, shard, config, replica.\nChanging this creates a new resource.\n"
}
},
"type": "object",
"required": [
"id",
"name",
"privateIp",
"publicIp",
"role",
"status",
"type"
]
},
"flexibleengine:index/DdsInstanceV3Timeouts:DdsInstanceV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DdsParameterTemplateParameter:DdsParameterTemplateParameter": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the parameter template description.\nThe description must consist of a maximum of 256 characters and cannot contain the carriage\nreturn character or the following special characters: >!<\"&'=.\n"
},
"name": {
"type": "string",
"description": "Specifies the parameter template name.\nThe value must be 1 to 64 characters in length and start with a letter (from A to Z or from a to z).\nIt is case-sensitive and can contain only letters, digits (from 0 to 9), hyphens (-), and underscores (_).\n"
},
"readonly": {
"type": "boolean",
"description": "Indicates whether the parameter is read-only.\n+ If the value is **true**, the parameter is read-only.\n+ If the value is **false**, the parameter is not read-only.\n"
},
"restartRequired": {
"type": "boolean",
"description": "Indicates whether the instance needs to be restarted.\n+ If the value is **true**, restart is required.\n+ If the value is **false**, restart is not required.\n"
},
"type": {
"type": "string",
"description": "Indicates the parameter type. The value can be integer, string, boolean, float, or list.\n"
},
"value": {
"type": "string",
"description": "Indicates the parameter value.\n"
},
"valueRange": {
"type": "string",
"description": "Indicates the value range.\n"
}
},
"type": "object",
"required": [
"description",
"name",
"readonly",
"restartRequired",
"type",
"value",
"valueRange"
]
},
"flexibleengine:index/DisStreamPartition:DisStreamPartition": {
"properties": {
"hashRange": {
"type": "string",
"description": "Possible value range of the hash key used by each partition.\n"
},
"id": {
"type": "string",
"description": "The ID of the partition.\n"
},
"sequenceNumberRange": {
"type": "string",
"description": "Sequence number range of each partition.\n"
},
"status": {
"type": "string",
"description": "The status of the partition.\n"
}
},
"type": "object",
"required": [
"hashRange",
"id",
"sequenceNumberRange",
"status"
]
},
"flexibleengine:index/DliDatasourceConnectionHost:DliDatasourceConnectionHost": {
"properties": {
"ip": {
"type": "string",
"description": "IPv4 address of the host.\n"
},
"name": {
"type": "string",
"description": "The user-defined host name.\n"
}
},
"type": "object",
"required": [
"ip",
"name"
]
},
"flexibleengine:index/DliDatasourceConnectionRoute:DliDatasourceConnectionRoute": {
"properties": {
"cidr": {
"type": "string",
"description": "The CIDR of the route.\n"
},
"name": {
"type": "string",
"description": "The user-defined host name.\n"
}
},
"type": "object",
"required": [
"cidr",
"name"
]
},
"flexibleengine:index/DliFlinksqlJobTimeouts:DliFlinksqlJobTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DliQueueTimeouts:DliQueueTimeouts": {
"properties": {
"default": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DliSparkJobDependentPackage:DliSparkJobDependentPackage": {
"properties": {
"groupName": {
"type": "string"
},
"packages": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FDliSparkJobDependentPackagePackage:DliSparkJobDependentPackagePackage"
}
}
},
"type": "object",
"required": [
"groupName",
"packages"
]
},
"flexibleengine:index/DliSparkJobDependentPackagePackage:DliSparkJobDependentPackagePackage": {
"properties": {
"packageName": {
"type": "string",
"description": "Specifies the resource name of the package.\nChanging this parameter will submit a new spark job.\n"
},
"type": {
"type": "string",
"description": "Specifies the resource type of the package.\nChanging this parameter will submit a new spark job.\n"
}
},
"type": "object",
"required": [
"packageName",
"type"
]
},
"flexibleengine:index/DliSparkJobTimeouts:DliSparkJobTimeouts": {
"properties": {
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DliSqlJobConf:DliSqlJobConf": {
"properties": {
"dliSqlJobTimeout": {
"type": "number",
"description": "Sets the job running timeout interval. If the timeout interval\nexpires, the job is canceled. Unit: `ms`. Changing this parameter will create a new resource.\n"
},
"dliSqlSqlasyncEnabled": {
"type": "boolean",
"description": "Specifies whether DDL and DCL statements are executed\nasynchronously. The value true indicates that asynchronous execution is enabled. Default value is `false`.\nChanging this parameter will create a new resource.\n"
},
"sparkSqlAutoBroadcastJoinThreshold": {
"type": "number",
"description": "Maximum size of the table that\ndisplays all working nodes when a connection is executed. You can set this parameter to -1 to disable the display.\nDefault value is `209715200`. Changing this parameter will create a new resource.\nCurrently, only the configuration unit metastore table that runs the ANALYZE TABLE COMPUTE statistics no-scan\ncommand and the file-based data source table that directly calculates statistics based on data files are supported.\nChanging this parameter will create a new resource.\n"
},
"sparkSqlBadRecordsPath": {
"type": "string",
"description": "Path of bad records. Changing this parameter will create\na new resource.\n"
},
"sparkSqlDynamicPartitionOverwriteEnabled": {
"type": "boolean",
"description": "In dynamic mode, Spark does not delete\nthe previous partitions and only overwrites the partitions without data during execution. Default value is `false`.\nChanging this parameter will create a new resource.\n"
},
"sparkSqlFilesMaxPartitionBytes": {
"type": "number",
"description": "Maximum number of bytes to be packed into a\nsingle partition when a file is read. Default value is `134217728`.\nChanging this parameter will create a new resource.\n"
},
"sparkSqlMaxRecordsPerFile": {
"type": "number",
"description": "Maximum number of records to be written\ninto a single file. If the value is zero or negative, there is no limit. Default value is `0`.\nChanging this parameter will create a new resource.\n"
},
"sparkSqlShufflePartitions": {
"type": "number",
"description": "Default number of partitions used to filter\ndata for join or aggregation. Default value is `4096`. Changing this parameter will create a new resource.\n"
}
},
"type": "object"
},
"flexibleengine:index/DliSqlJobTimeouts:DliSqlJobTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DliTableColumn:DliTableColumn": {
"properties": {
"description": {
"type": "string",
"description": "Specifies description of the table.\nChanging this parameter will create a new resource.\n"
},
"isPartition": {
"type": "boolean",
"description": "Specifies whether the column is a partition column. The value\n`true` indicates a partition column, and the value false indicates a non-partition column. The default value\nis false. Changing this parameter will create a new resource.\n\n> When creating a partition table, ensure that at least one column in the table is a non-partition column.\n"
},
"name": {
"type": "string",
"description": "Specifies the table name. The name can contain only digits, letters,\nand underscores, but cannot contain only digits or start with an underscore. Length range: 1 to 128 characters.\nChanging this parameter will create a new resource.\n"
},
"type": {
"type": "string",
"description": "Specifies data type of column. Changing this parameter will create a new\nresource.\n"
}
},
"type": "object",
"required": [
"name",
"type"
]
},
"flexibleengine:index/DliTableTimeouts:DliTableTimeouts": {
"properties": {
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DmsKafkaInstanceTimeouts:DmsKafkaInstanceTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DmsRocketmqInstanceCrossVpcAccess:DmsRocketmqInstanceCrossVpcAccess": {
"properties": {
"advertisedIp": {
"type": "string"
},
"lisenterIp": {
"type": "string"
},
"listenerIp": {
"type": "string"
},
"port": {
"type": "number"
},
"portId": {
"type": "string"
}
},
"type": "object",
"required": [
"advertisedIp",
"lisenterIp",
"listenerIp",
"port",
"portId"
]
},
"flexibleengine:index/DmsRocketmqInstanceTimeouts:DmsRocketmqInstanceTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DmsRocketmqTopicBroker:DmsRocketmqTopicBroker": {
"properties": {
"name": {
"type": "string",
"description": "Indicates the name of the broker.\n"
},
"readQueueNum": {
"type": "number",
"description": "Indicates the read queues number of the broker. It's useless when create a topic.\n"
},
"writeQueueNum": {
"type": "number",
"description": "Indicates the read queues number of the broker. It's useless when create a topic.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"name",
"readQueueNum",
"writeQueueNum"
]
}
}
},
"flexibleengine:index/DmsRocketmqUserGroupPerm:DmsRocketmqUserGroupPerm": {
"properties": {
"name": {
"type": "string",
"description": "Indicates the name of a topic or consumer group.\n"
},
"perm": {
"type": "string",
"description": "Indicates the permissions of the topic or consumer group.\nValue options: **PUB|SUB**, **PUB**, **SUB**, **DENY**.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"name",
"perm"
]
}
}
},
"flexibleengine:index/DmsRocketmqUserTopicPerm:DmsRocketmqUserTopicPerm": {
"properties": {
"name": {
"type": "string",
"description": "Indicates the name of a topic or consumer group.\n"
},
"perm": {
"type": "string",
"description": "Indicates the permissions of the topic or consumer group.\nValue options: **PUB|SUB**, **PUB**, **SUB**, **DENY**.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"name",
"perm"
]
}
}
},
"flexibleengine:index/DnsPtrrecordV2Timeouts:DnsPtrrecordV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DnsRecordsetV2Timeouts:DnsRecordsetV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DnsZoneV2Router:DnsZoneV2Router": {
"properties": {
"routerId": {
"type": "string",
"description": "The VPC UUID.\n"
},
"routerRegion": {
"type": "string",
"description": "The region of the VPC. Defaults to the `region`.\n"
}
},
"type": "object",
"required": [
"routerId"
]
},
"flexibleengine:index/DnsZoneV2Timeouts:DnsZoneV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DrsJobDestinationDb:DrsJobDestinationDb": {
"properties": {
"engineType": {
"type": "string",
"description": "Specifies the migration engine type.\nChanging this parameter will create a new resource. The options are as follows:\n+ **mysql**: MySQL migration, MySQL synchronization use.\n+ **mongodb**: Mongodb migration use.\n+ **cloudDataGuard-mysql**: Disaster recovery use.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the instance id of database when it is a RDS database.\nChanging this parameter will create a new resource.\n"
},
"ip": {
"type": "string",
"description": "Specifies the IP of database. Changing this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the job name. The name consists of 4 to 50 characters, starting with\na letter. Only letters, digits, underscores (_) and hyphens (-) are allowed.\n"
},
"password": {
"type": "string",
"description": "Specifies the password of database.\nChanging this parameter will create a new resource.\n",
"secret": true
},
"port": {
"type": "number",
"description": "Specifies the port of database. Changing this parameter will create a new resource.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the resource. If omitted, the\nprovider-level region will be used. Changing this parameter will create a new resource.\n"
},
"sslCertCheckSum": {
"type": "string",
"description": "Specifies the checksum of SSL certificate content.\nIt is mandatory when `ssl_enabled` is `true`. Changing this parameter will create a new resource.\n"
},
"sslCertKey": {
"type": "string",
"description": "Specifies the SSL certificate content, encrypted with base64.\nIt is mandatory when `ssl_enabled` is `true`. Changing this parameter will create a new resource.\n"
},
"sslCertName": {
"type": "string",
"description": "Specifies SSL certificate name.\nIt is mandatory when `ssl_enabled` is `true`. Changing this parameter will create a new resource.\n"
},
"sslCertPassword": {
"type": "string",
"description": "Specifies SSL certificate password. It is mandatory when\n`ssl_enabled` is `true` and the certificate file suffix is `.p12`. Changing this parameter will create a new resource.\n"
},
"sslEnabled": {
"type": "boolean",
"description": "Specifies whether to enable SSL connection.\nChanging this parameter will create a new resource.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet of database when it is a RDS database.\nIt is mandatory when `direction` is `down`. Changing this parameter will create a new resource.\n"
},
"user": {
"type": "string",
"description": "Specifies the user name of database.\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"engineType",
"ip",
"password",
"port",
"user"
],
"language": {
"nodejs": {
"requiredOutputs": [
"engineType",
"ip",
"name",
"password",
"port",
"region",
"user"
]
}
}
},
"flexibleengine:index/DrsJobLimitSpeed:DrsJobLimitSpeed": {
"properties": {
"endTime": {
"type": "string",
"description": "Specifies the time to end speed limit, this time is UTC time. The input must\nend at 59 minutes, the format is `hh:mm`, for example: 15:59. Changing this parameter will create a new resource.\n"
},
"speed": {
"type": "string",
"description": "Specifies the transmission speed, the value range is 1 to 9999, unit: `MB/s`.\nChanging this parameter will create a new resource.\n"
},
"startTime": {
"type": "string",
"description": "Specifies the time to start speed limit, this time is UTC time. The start\ntime is the whole hour, if there is a minute, it will be ignored, the format is `hh:mm`, and the hour number\nis two digits, for example: 01:00. Changing this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"endTime",
"speed",
"startTime"
]
},
"flexibleengine:index/DrsJobSourceDb:DrsJobSourceDb": {
"properties": {
"engineType": {
"type": "string",
"description": "Specifies the migration engine type.\nChanging this parameter will create a new resource. The options are as follows:\n+ **mysql**: MySQL migration, MySQL synchronization use.\n+ **mongodb**: Mongodb migration use.\n+ **cloudDataGuard-mysql**: Disaster recovery use.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the instance id of database when it is a RDS database.\nChanging this parameter will create a new resource.\n"
},
"ip": {
"type": "string",
"description": "Specifies the IP of database. Changing this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the job name. The name consists of 4 to 50 characters, starting with\na letter. Only letters, digits, underscores (_) and hyphens (-) are allowed.\n"
},
"password": {
"type": "string",
"description": "Specifies the password of database.\nChanging this parameter will create a new resource.\n",
"secret": true
},
"port": {
"type": "number",
"description": "Specifies the port of database. Changing this parameter will create a new resource.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the resource. If omitted, the\nprovider-level region will be used. Changing this parameter will create a new resource.\n"
},
"sslCertCheckSum": {
"type": "string",
"description": "Specifies the checksum of SSL certificate content.\nIt is mandatory when `ssl_enabled` is `true`. Changing this parameter will create a new resource.\n"
},
"sslCertKey": {
"type": "string",
"description": "Specifies the SSL certificate content, encrypted with base64.\nIt is mandatory when `ssl_enabled` is `true`. Changing this parameter will create a new resource.\n"
},
"sslCertName": {
"type": "string",
"description": "Specifies SSL certificate name.\nIt is mandatory when `ssl_enabled` is `true`. Changing this parameter will create a new resource.\n"
},
"sslCertPassword": {
"type": "string",
"description": "Specifies SSL certificate password. It is mandatory when\n`ssl_enabled` is `true` and the certificate file suffix is `.p12`. Changing this parameter will create a new resource.\n"
},
"sslEnabled": {
"type": "boolean",
"description": "Specifies whether to enable SSL connection.\nChanging this parameter will create a new resource.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet of database when it is a RDS database.\nIt is mandatory when `direction` is `down`. Changing this parameter will create a new resource.\n"
},
"user": {
"type": "string",
"description": "Specifies the user name of database.\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"engineType",
"ip",
"password",
"port",
"user"
],
"language": {
"nodejs": {
"requiredOutputs": [
"engineType",
"ip",
"name",
"password",
"port",
"region",
"user"
]
}
}
},
"flexibleengine:index/DrsJobTimeouts:DrsJobTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/DwsClusterV1Endpoint:DwsClusterV1Endpoint": {
"properties": {
"connectInfo": {
"type": "string",
"description": "Private network connection information\n"
},
"jdbcUrl": {
"type": "string",
"description": "JDBC URL. The following is the default format:\njdbc:postgresql://< public_connect_info>/\n"
}
},
"type": "object",
"required": [
"connectInfo",
"jdbcUrl"
]
},
"flexibleengine:index/DwsClusterV1PublicEndpoint:DwsClusterV1PublicEndpoint": {
"properties": {
"jdbcUrl": {
"type": "string",
"description": "JDBC URL. The following is the default format:\njdbc:postgresql://< public_connect_info>/\n"
},
"publicConnectInfo": {
"type": "string",
"description": "Public network connection information\n"
}
},
"type": "object",
"required": [
"jdbcUrl",
"publicConnectInfo"
]
},
"flexibleengine:index/DwsClusterV1PublicIp:DwsClusterV1PublicIp": {
"properties": {
"eipId": {
"type": "string",
"description": "EIP ID. Changing this will create a new resource.\n"
},
"publicBindType": {
"type": "string",
"description": "Binding type of an EIP. The value can be\neither of the following: *auto_assign*, *not_use* and *bind_existing*.\nThe default value is *not_use*. Changing this will create a new resource.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"eipId",
"publicBindType"
]
}
}
},
"flexibleengine:index/DwsClusterV1Timeouts:DwsClusterV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ElbBackendTimeouts:ElbBackendTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ElbHealthTimeouts:ElbHealthTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ElbIpgroupIpList:ElbIpgroupIpList": {
"properties": {
"description": {
"type": "string",
"description": "Human-readable description for the ip.\n"
},
"ip": {
"type": "string",
"description": "IP address or CIDR block.\n"
}
},
"type": "object",
"required": [
"ip"
]
},
"flexibleengine:index/ElbListenerTimeouts:ElbListenerTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ElbLoadbalancerTimeouts:ElbLoadbalancerTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ElbSecurityPolicyListener:ElbSecurityPolicyListener": {
"properties": {
"id": {
"type": "string",
"description": "The listener id.\n"
}
},
"type": "object",
"required": [
"id"
]
},
"flexibleengine:index/EnterpriseProjectTimeouts:EnterpriseProjectTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/FgsFunctionCustomImage:FgsFunctionCustomImage": {
"properties": {
"url": {
"type": "string"
}
},
"type": "object",
"required": [
"url"
]
},
"flexibleengine:index/FgsFunctionFuncMount:FgsFunctionFuncMount": {
"properties": {
"localMountPath": {
"type": "string",
"description": "Specifies the function access path.\n"
},
"mountResource": {
"type": "string",
"description": "Specifies the ID of the mounted resource (corresponding cloud service).\n"
},
"mountSharePath": {
"type": "string",
"description": "Specifies the remote mount path. Example: 192.168.0.12:/data.\n"
},
"mountType": {
"type": "string",
"description": "Specifies the mount type. Options: sfs, sfsTurbo, and ecs.\n"
},
"status": {
"type": "string",
"description": "The status of file system.\n"
}
},
"type": "object",
"required": [
"localMountPath",
"mountResource",
"mountSharePath",
"mountType"
],
"language": {
"nodejs": {
"requiredOutputs": [
"localMountPath",
"mountResource",
"mountSharePath",
"mountType",
"status"
]
}
}
},
"flexibleengine:index/FgsFunctionTimeouts:FgsFunctionTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/FgsFunctionVersion:FgsFunctionVersion": {
"properties": {
"aliases": {
"$ref": "#/types/flexibleengine:index%2FFgsFunctionVersionAliases:FgsFunctionVersionAliases",
"description": "The aliases management for specified version.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the function.\n"
}
},
"type": "object",
"required": [
"name"
]
},
"flexibleengine:index/FgsFunctionVersionAliases:FgsFunctionVersionAliases": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the function.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the function.\n"
}
},
"type": "object",
"required": [
"name"
]
},
"flexibleengine:index/FgsTriggerApig:FgsTriggerApig": {
"properties": {
"apiName": {
"type": "string",
"description": "Specifies the API name. Changing this will create a new trigger resource.\n"
},
"envName": {
"type": "string",
"description": "Specifies the API environment name.\nChanging this will create a new trigger resource.\n"
},
"groupId": {
"type": "string",
"description": "Specifies the ID of the APIG group to which the API belongs.\nChanging this will create a new trigger resource.\n"
},
"instanceId": {
"type": "string"
},
"requestProtocol": {
"type": "string",
"description": "Specifies the request protocol of the API. The valid value are\n**HTTP** and **HTTPS**. Default to **HTTPS**. Changing this will create a new trigger resource.\n"
},
"securityAuthentication": {
"type": "string",
"description": "Specifies the security authentication mode. The valid values\nare **NONE**, **APP** and **IAM**, default to **IAM**. Changing this will create a new trigger resource.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the timeout for request sending. The valid value is range form\n`1` to `60,000`, default to `5,000`. Changing this will create a new trigger resource.\n"
}
},
"type": "object",
"required": [
"apiName",
"envName",
"groupId"
]
},
"flexibleengine:index/FgsTriggerDis:FgsTriggerDis": {
"properties": {
"maxFetchBytes": {
"type": "number",
"description": "Specifies the maximum volume of data that can be obtained for a single\nrequest, in Byte. Only the records with a size smaller than this value can be obtained.\nThe valid value is range from `1,024` to `4,194,304`.\nChanging this will create a new trigger resource.\n"
},
"pullPeriod": {
"type": "number",
"description": "Specifies the interval at which data is pulled from the specified stream.\nThe valid value is range from `2` to `60,000`.\nChanging this will create a new trigger resource.\n"
},
"serialEnable": {
"type": "boolean",
"description": "Specifies the determines whether to pull data only after the data pulled\nin the last period has been processed.\nChanging this will create a new trigger resource.\n\n\nThe `apig` block supports:\n"
},
"startingPosition": {
"type": "string",
"description": "Specifies the type of starting position for DIS queue.\nThe valid values are as follows:\n+ **TRIM_HORIZON**: Starts reading from the earliest data stored in the partitions.\n+ **LATEST**: Starts reading from the latest data stored in the partitions.\nChanging this will create a new trigger resource.\n"
},
"streamName": {
"type": "string",
"description": "Specifies the name of the DIS stream resource.\nChanging this will create a new trigger resource.\n"
}
},
"type": "object",
"required": [
"maxFetchBytes",
"pullPeriod",
"serialEnable",
"startingPosition",
"streamName"
]
},
"flexibleengine:index/FgsTriggerKafka:FgsTriggerKafka": {
"properties": {
"batchSize": {
"type": "number"
},
"instanceId": {
"type": "string"
},
"password": {
"type": "string",
"secret": true
},
"topicIds": {
"type": "array",
"items": {
"type": "string"
}
},
"userName": {
"type": "string"
}
},
"type": "object",
"required": [
"instanceId",
"topicIds"
]
},
"flexibleengine:index/FgsTriggerLts:FgsTriggerLts": {
"properties": {
"logGroupId": {
"type": "string"
},
"logTopicId": {
"type": "string"
}
},
"type": "object",
"required": [
"logGroupId",
"logTopicId"
]
},
"flexibleengine:index/FgsTriggerObs:FgsTriggerObs": {
"properties": {
"bucketName": {
"type": "string",
"description": "Specifies the OBS bucket name.\nChanging this will create a new trigger resource.\n"
},
"eventNotificationName": {
"type": "string",
"description": "Specifies the event notification name.\nChanging this will create a new trigger resource.\n"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the events that can trigger functions.\nChanging this will create a new trigger resource.\nThe valid values are as follows:\n+ **ObjectCreated**, **Put**, **Post**, **Copy** and **CompleteMultipartUpload**.\n+ **ObjectRemoved**, **Delete** and **DeleteMarkerCreated**.\n\n> **NOTE:** If **ObjectCreated** is configured, **Put**, **Post**, **Copy** and **CompleteMultipartUpload** cannot\nbe configured. If **ObjectRemoved** is configured, **Delete** and **DeleteMarkerCreated** cannot be configured.\n"
},
"prefix": {
"type": "string",
"description": "Specifies the prefix to limit notifications to objects beginning with this keyword.\nChanging this will create a new trigger resource.\n"
},
"suffix": {
"type": "string",
"description": "Specifies the suffix to limit notifications to objects ending with this keyword.\nChanging this will create a new trigger resource.\n\n\nThe `smn` block supports:\n"
}
},
"type": "object",
"required": [
"bucketName",
"eventNotificationName",
"events"
]
},
"flexibleengine:index/FgsTriggerSmn:FgsTriggerSmn": {
"properties": {
"topicUrn": {
"type": "string",
"description": "Specifies the Uniform Resource Name (URN) for SMN topic.\nChanging this will create a new trigger resource.\n\n\nThe `dis` block supports:\n"
}
},
"type": "object",
"required": [
"topicUrn"
]
},
"flexibleengine:index/FgsTriggerTimeouts:FgsTriggerTimeouts": {
"properties": {
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/FgsTriggerTimer:FgsTriggerTimer": {
"properties": {
"additionalInformation": {
"type": "string",
"description": "Specifies the event used by the timer to trigger the function.\nChanging this will create a new trigger resource.\n\n\nThe `obs` block supports:\n"
},
"name": {
"type": "string",
"description": "Specifies the trigger name, which can contains of 1 to 64 characters.\nThe name must start with a letter, only letters, digits, hyphens (-) and underscores (_) are allowed.\nChanging this will create a new trigger resource.\n"
},
"schedule": {
"type": "string",
"description": "Specifies the time schedule.\nFor the rate type, schedule is composed of time and time unit.\nThe time unit supports minutes (m), hours (h) and days (d).\nFor the corn expression, please refer to the\n[User Guide](https://docs.prod-cloud-ocb.orange-business.com/usermanual/functiongraph/functiongraph_01_0908.html).\nChanging this will create a new trigger resource.\n"
},
"scheduleType": {
"type": "string",
"description": "Specifies the type of the time schedule.\nThe valid values are **Rate** and **Cron**.\nChanging this will create a new trigger resource.\n"
}
},
"type": "object",
"required": [
"name",
"schedule",
"scheduleType"
]
},
"flexibleengine:index/FwFirewallGroupV2Timeouts:FwFirewallGroupV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/FwPolicyV2Timeouts:FwPolicyV2Timeouts": {
"properties": {
"create": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/GaussdbCassandraInstanceBackupStrategy:GaussdbCassandraInstanceBackupStrategy": {
"properties": {
"keepDays": {
"type": "number",
"description": "Specifies the number of days to retain the generated backup files. The value ranges from\n0 to 35. If this parameter is set to 0, the automated backup policy is not set. If this parameter is not transferred,\nthe automated backup policy is enabled by default. Backup files are stored for seven days by default.\n"
},
"startTime": {
"type": "string",
"description": "Specifies the backup time window. Automated backups will be triggered during the\nbackup time window. It must be a valid value in the \"hh:mm-HH:MM\" format. The current time is in the UTC format. The\nHH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to 00. Example\nvalue: 08:00-09:00, 03:00-04:00.\n"
}
},
"type": "object",
"required": [
"startTime"
],
"language": {
"nodejs": {
"requiredOutputs": [
"keepDays",
"startTime"
]
}
}
},
"flexibleengine:index/GaussdbCassandraInstanceDatastore:GaussdbCassandraInstanceDatastore": {
"properties": {
"engine": {
"type": "string",
"description": "Specifies the database engine. Only \"GeminiDB-Cassandra\" is supported now.\nChanging this parameter will create a new resource.\n"
},
"storageEngine": {
"type": "string",
"description": "Specifies the storage engine. Only \"rocksDB\" is supported now.\nChanging this parameter will create a new resource.\n\n\nThe `backup_strategy` block supports:\n"
},
"version": {
"type": "string",
"description": "Specifies the database version.\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"engine",
"storageEngine",
"version"
]
},
"flexibleengine:index/GaussdbCassandraInstanceNode:GaussdbCassandraInstanceNode": {
"properties": {
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the instance name, which can be the same as an existing instance name. The value\nmust be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters,\ndigits, hyphens (-), and underscores (_).\n"
},
"privateIp": {
"type": "string",
"description": "Indicates the private IP address of a node.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
},
"supportReduce": {
"type": "boolean",
"description": "Indicates whether the node support reduce or not.\n"
}
},
"type": "object",
"required": [
"id",
"name",
"privateIp",
"status",
"supportReduce"
]
},
"flexibleengine:index/GaussdbCassandraInstanceTimeouts:GaussdbCassandraInstanceTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/GaussdbInfluxInstanceBackupStrategy:GaussdbInfluxInstanceBackupStrategy": {
"properties": {
"keepDays": {
"type": "number",
"description": "Specifies the number of days to retain the generated backup files. The value ranges from\n**0** to **35**. If this parameter is set to **0**, the automated backup policy is not set. If this parameter is not\ntransferred, the automated backup policy is enabled by default. Backup files are stored for seven days by default.\n"
},
"startTime": {
"type": "string",
"description": "Specifies the backup time window. Automated backups will be triggered during the\nbackup time window. It must be a valid value in the \"hh:mm-HH:MM\" format. The current time is in the UTC format. The\nHH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to 00. Example\nvalue: 08:00-09:00, 03:00-04:00.\n"
}
},
"type": "object",
"required": [
"startTime"
],
"language": {
"nodejs": {
"requiredOutputs": [
"keepDays",
"startTime"
]
}
}
},
"flexibleengine:index/GaussdbInfluxInstanceDatastore:GaussdbInfluxInstanceDatastore": {
"properties": {
"engine": {
"type": "string",
"description": "Specifies the database engine. Only **influxdb** is supported now.\nChanging this parameter will create a new resource.\n"
},
"storageEngine": {
"type": "string",
"description": "Specifies the storage engine. Only **rocksDB** is supported now.\nChanging this parameter will create a new resource.\n\n\nThe `backup_strategy` block supports:\n"
},
"version": {
"type": "string",
"description": "Specifies the database version.\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"engine",
"storageEngine",
"version"
]
},
"flexibleengine:index/GaussdbInfluxInstanceNode:GaussdbInfluxInstanceNode": {
"properties": {
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the instance name, which can be the same as an existing instance name. The\nvalue must be **4** to **64** characters in length and start with a letter. It is case-sensitive and can contain only\nletters, digits, hyphens (-), and underscores (_).\n"
},
"privateIp": {
"type": "string",
"description": "Indicates the private IP address of a node.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
},
"supportReduce": {
"type": "boolean",
"description": "Indicates whether the node support reduce or not.\n"
}
},
"type": "object",
"required": [
"id",
"name",
"privateIp",
"status",
"supportReduce"
]
},
"flexibleengine:index/GaussdbInfluxInstanceTimeouts:GaussdbInfluxInstanceTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/IdentityAclIpCidr:IdentityAclIpCidr": {
"properties": {
"cidr": {
"type": "string",
"description": "Specifies the IPv4 CIDR block, for example, **192.168.0.0/24**.\n"
},
"description": {
"type": "string",
"description": "Specifies a description about an IPv4 CIDR block. This parameter can contain a\nmaximum of 255 characters and the following characters are not allowed:**@#%^&*<>\\\\**.\n"
}
},
"type": "object",
"required": [
"cidr"
]
},
"flexibleengine:index/IdentityAclIpRange:IdentityAclIpRange": {
"properties": {
"description": {
"type": "string",
"description": "Specifies a description about an IP address range. This parameter can contain a\nmaximum of 255 characters and the following characters are not allowed:**@#%^&*<>\\\\**.\n\n->**NOTE:** Up to 200 `ip_cidrs` and `ip_ranges` can be created in total for each access method.\n"
},
"range": {
"type": "string",
"description": "Specifies the Ip address range, for example, **0.0.0.0-255.255.255.0**.\n"
}
},
"type": "object",
"required": [
"range"
]
},
"flexibleengine:index/IdentityAgencyV3ProjectRole:IdentityAgencyV3ProjectRole": {
"properties": {
"project": {
"type": "string",
"description": "Specifies the name of project.\n"
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies an array of role names.\n\n> **NOTE**\n- At least one of `project_role` and `domain_roles` must be specified when creating an agency.\n- We can get all **System-Defined Roles** from\n[FlexibleEngine](https://docs.prod-cloud-ocb.orange-business.com/permissions/index.html) or\ndata.flexibleengine_identity_role_v3.\n"
}
},
"type": "object",
"required": [
"project",
"roles"
]
},
"flexibleengine:index/IdentityAgencyV3Timeouts:IdentityAgencyV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/IdentityProjectV3Timeouts:IdentityProjectV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/IdentityProviderConversionConversionRule:IdentityProviderConversionConversionRule": {
"properties": {
"locals": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FIdentityProviderConversionConversionRuleLocal:IdentityProviderConversionConversionRuleLocal"
},
"description": "Specifies the federated user information on the cloud platform. The local\nobject structure is documented below.\n"
},
"remotes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FIdentityProviderConversionConversionRuleRemote:IdentityProviderConversionConversionRuleRemote"
},
"description": "Specifies Federated user information in the IDP system. The remote object\nstructure is documented below.\n\n> **NOTE:**\nIf the protocol of identity provider is SAML, this field is an expression consisting of assertion\nattributes and operators.\nIf the protocol of identity provider is OIDC, the value of this field is determined by the ID token.\n\n\nThe `local` block supports:\n"
}
},
"type": "object",
"required": [
"locals",
"remotes"
]
},
"flexibleengine:index/IdentityProviderConversionConversionRuleLocal:IdentityProviderConversionConversionRuleLocal": {
"properties": {
"group": {
"type": "string",
"description": "Specifies the user group to which the federated user belongs on the cloud platform.\n\n\nThe `remote` block supports:\n"
},
"username": {
"type": "string",
"description": "Specifies the name of a federated user on the cloud platform.\n"
}
},
"type": "object",
"required": [
"username"
]
},
"flexibleengine:index/IdentityProviderConversionConversionRuleRemote:IdentityProviderConversionConversionRuleRemote": {
"properties": {
"attribute": {
"type": "string",
"description": "Specifies the attribute in the IDP assertion.\n"
},
"condition": {
"type": "string",
"description": "Specifies the condition of conversion rule.\nAvailable options are:\n"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the rule is matched only if the specified strings appear in the attribute type.\n"
}
},
"type": "object",
"required": [
"attribute"
]
},
"flexibleengine:index/IdentityProviderConversionRule:IdentityProviderConversionRule": {
"properties": {
"locals": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FIdentityProviderConversionRuleLocal:IdentityProviderConversionRuleLocal"
},
"description": "The federated user information on the cloud platform. The local object structure is\ndocumented below.\n"
},
"remotes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FIdentityProviderConversionRuleRemote:IdentityProviderConversionRuleRemote"
},
"description": "The description of the identity provider. The remote object structure is documented below.\n"
}
},
"type": "object",
"required": [
"locals",
"remotes"
]
},
"flexibleengine:index/IdentityProviderConversionRuleLocal:IdentityProviderConversionRuleLocal": {
"properties": {
"group": {
"type": "string",
"description": "The user group to which the federated user belongs on the cloud platform.\n"
},
"username": {
"type": "string",
"description": "The name of a federated user on the cloud platform.\n"
}
},
"type": "object",
"required": [
"group",
"username"
]
},
"flexibleengine:index/IdentityProviderConversionRuleRemote:IdentityProviderConversionRuleRemote": {
"properties": {
"attribute": {
"type": "string",
"description": "The attribute in the IDP assertion.\n"
},
"condition": {
"type": "string",
"description": "The condition of conversion rule.\n"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The rule is matched only if the specified strings appear in the attribute type.\n"
}
},
"type": "object",
"required": [
"attribute",
"condition",
"values"
]
},
"flexibleengine:index/IdentityProviderOpenidConnectConfig:IdentityProviderOpenidConnectConfig": {
"properties": {
"accessType": {
"type": "string",
"description": "Specifies the access type of the identity provider.\nAvailable options are:\n"
},
"authorizationEndpoint": {
"type": "string",
"description": "Specifies the authorization endpoint of the OpenID Connect identity\nprovider. This field is required only if the access type is set to `program_console`.\n"
},
"clientId": {
"type": "string",
"description": "Specifies the ID of a client registered with the OpenID Connect identity provider.\n"
},
"providerUrl": {
"type": "string",
"description": "Specifies the URL of the identity provider.\nThis field corresponds to the iss field in the ID token.\n"
},
"responseMode": {
"type": "string",
"description": "Response mode.\nValid values is *form_post* and *fragment*, default value is *form_post*.\nThis field is required only if the access type is set to `program_console`.\n"
},
"responseType": {
"type": "string",
"description": "Response type. Valid values is *id_token*, default value is *id_token*.\nThis field is required only if the access type is set to `program_console`.\n"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the scopes of authorization requests. It is an array of one or more scopes.\nValid values are *openid*, *email*, *profile* and other values defined by you.\nThis field is required only if the access type is set to `program_console`.\n"
},
"signingKey": {
"type": "string",
"description": "Public key used to sign the ID token of the OpenID Connect identity provider.\nThis field is required only if the protocol is set to *oidc*.\n"
}
},
"type": "object",
"required": [
"accessType",
"clientId",
"providerUrl",
"signingKey"
],
"language": {
"nodejs": {
"requiredOutputs": [
"accessType",
"authorizationEndpoint",
"clientId",
"providerUrl",
"scopes",
"signingKey"
]
}
}
},
"flexibleengine:index/ImagesImageCopyTimeouts:ImagesImageCopyTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ImagesImageShareAccepterTimeouts:ImagesImageShareAccepterTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ImagesImageShareTimeouts:ImagesImageShareTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ImagesImageTimeouts:ImagesImageTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ImagesImageV2Timeouts:ImagesImageV2Timeouts": {
"properties": {
"create": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/KmsKeyV1Timeouts:KmsKeyV1Timeouts": {
"properties": {
"create": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbCertificateV2Timeouts:LbCertificateV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbL7policyV2Timeouts:LbL7policyV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbL7ruleV2Timeouts:LbL7ruleV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbListenerV2Timeouts:LbListenerV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbListenerV3Timeouts:LbListenerV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbLoadbalancerV2Timeouts:LbLoadbalancerV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbLoadbalancerV3Timeouts:LbLoadbalancerV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbMemberV2Timeouts:LbMemberV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbMemberV3Timeouts:LbMemberV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbMonitorV2Timeouts:LbMonitorV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbPoolV2Persistence:LbPoolV2Persistence": {
"properties": {
"cookieName": {
"type": "string",
"description": "The name of the cookie if persistence mode is set\nappropriately. It is Required if `type = APP_COOKIE`. Changing this will create a new resource.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the sticky session timeout duration in minutes. This parameter is\ninvalid when type is set to APP_COOKIE. Changing this will create a new resource.\nThe value range varies depending on the protocol of the backend server group:\n\n+ When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.\n+ When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.\n"
},
"type": {
"type": "string",
"description": "The type of persistence mode. The current specification\nsupports SOURCE_IP, HTTP_COOKIE, and APP_COOKIE. Changing this will create a new resource.\n"
}
},
"type": "object",
"required": [
"type"
],
"language": {
"nodejs": {
"requiredOutputs": [
"timeout",
"type"
]
}
}
},
"flexibleengine:index/LbPoolV2Timeouts:LbPoolV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbPoolV3Persistence:LbPoolV3Persistence": {
"properties": {
"cookieName": {
"type": "string",
"description": "Specifies the name of the cookie if persistence mode is set\nappropriately. Required if `type = APP_COOKIE`.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the sticky session timeout duration in minutes. This parameter is\ninvalid when type is set to APP_COOKIE. The value range varies depending on the protocol of the backend server group:\n+ When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.\n+ When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of persistence mode. The current specification supports\nSOURCE_IP, HTTP_COOKIE, and APP_COOKIE.\n"
}
},
"type": "object",
"required": [
"type"
],
"language": {
"nodejs": {
"requiredOutputs": [
"timeout",
"type"
]
}
}
},
"flexibleengine:index/LbPoolV3Timeouts:LbPoolV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/LbWhitelistV2Timeouts:LbWhitelistV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/MlsInstanceV1MrsCluster:MlsInstanceV1MrsCluster": {
"properties": {
"id": {
"type": "string",
"description": "Specifies the ID of the MRS cluster. Changing this creates a new instance.\n"
},
"userName": {
"type": "string",
"description": "Specifies the MRS cluster username. This parameter is mandatory\nonly when the MRS cluster is in the security mode. Changing this creates a new instance.\n"
},
"userPassword": {
"type": "string",
"description": "Specifies the password of the MRS cluster user. The password\nand username work in a pair. Changing this creates a new instance.\n",
"secret": true
}
},
"type": "object",
"required": [
"id"
],
"language": {
"nodejs": {
"requiredOutputs": [
"id",
"userName",
"userPassword"
]
}
}
},
"flexibleengine:index/MlsInstanceV1Network:MlsInstanceV1Network": {
"properties": {
"availableZone": {
"type": "string",
"description": "Specifies the AZ of the instance.\nChanging this creates a new instance.\n"
},
"publicIp": {
"$ref": "#/types/flexibleengine:index%2FMlsInstanceV1NetworkPublicIp:MlsInstanceV1NetworkPublicIp",
"description": "Specifies the IP address of the instance. The public_ip\nobject structure is documented below. Changing this creates a new instance.\n\n\nThe `public_ip` block supports:\n"
},
"securityGroup": {
"type": "string",
"description": "Specifies the ID of the security group of the instance.\nChanging this creates a new instance.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet where the instance resides.\nChanging this creates a new instance.\n"
},
"vpcId": {
"type": "string",
"description": "Specifies the ID of the virtual private cloud (VPC) where the\ninstance resides. Changing this creates a new instance.\n"
}
},
"type": "object",
"required": [
"availableZone",
"publicIp",
"subnetId",
"vpcId"
],
"language": {
"nodejs": {
"requiredOutputs": [
"availableZone",
"publicIp",
"securityGroup",
"subnetId",
"vpcId"
]
}
}
},
"flexibleengine:index/MlsInstanceV1NetworkPublicIp:MlsInstanceV1NetworkPublicIp": {
"properties": {
"bindType": {
"type": "string",
"description": "Specifies the bind type. Possible values: `auto_assign` and\n`not_use`. Changing this creates a new instance.\n\n\nThe `mrs_cluster` block supports:\n"
},
"eipId": {
"type": "string",
"description": "Indicates the EIP ID, This is returned only when bind_type is set to auto_assign.\n"
}
},
"type": "object",
"required": [
"bindType"
],
"language": {
"nodejs": {
"requiredOutputs": [
"bindType",
"eipId"
]
}
}
},
"flexibleengine:index/MlsInstanceV1Timeouts:MlsInstanceV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ModelartsDatasetDataSource:ModelartsDatasetDataSource": {
"properties": {
"clusterId": {
"type": "string",
"description": "Specifies the cluster ID of DWS/MRS when `data_type` is `1` or `4`.\nChanging this parameter will create a new resource.\n"
},
"dataType": {
"type": "number",
"description": "Specifies the type of data source. The options are as follows:\n+ **0**: OBS.\n+ **1**: GaussDB(DWS).\n+ **2**: DLI.\n+ **4**: MRS.\n\nChanging this parameter will create a new resource.\n"
},
"databaseName": {
"type": "string",
"description": "Specifies the database name of DWS/DLI when `data_type` is `1` or `2`.\nChanging this parameter will create a new resource.\n"
},
"password": {
"type": "string",
"description": "Specifies the password of database when `data_type` is `1`.\nChanging this parameter will create a new resource.\n",
"secret": true
},
"path": {
"type": "string",
"description": "Specifies the OBS path when `data_type` is `0`\nor the hdsf path when `data_type` is `4`. All the file in this directory and subdirectories will be which be imported\nto the dataset. Changing this parameter will create a new resource.\n"
},
"queueName": {
"type": "string",
"description": "Specifies the queue name of DLI when `data_type` is `2`.\nChanging this parameter will create a new resource.\n"
},
"tableName": {
"type": "string",
"description": "Specifies the table name of DWS/DLI when `data_type` is `1` or `2`.\nChanging this parameter will create a new resource.\n"
},
"userName": {
"type": "string",
"description": "Specifies the user name of databse when `data_type` is `1`.\nChanging this parameter will create a new resource.\n"
},
"withColumnHeader": {
"type": "boolean",
"description": "Specifies whether the data contains table header when the type\nof dataset is `400`(Table type). Default value is `true`. Changing this parameter will create a new resource.\n"
}
},
"type": "object"
},
"flexibleengine:index/ModelartsDatasetLabel:ModelartsDatasetLabel": {
"properties": {
"name": {
"type": "string",
"description": "Specifies the name of label.\n"
},
"propertyColor": {
"type": "string",
"description": "Specifies color of label.\n"
},
"propertyShape": {
"type": "string",
"description": "Specifies shape of label. Valid values include: `bndbox`, `polygon`,\n`circle`, `line`, `dashed`, `point`, `polyline`.\n"
},
"propertyShortcut": {
"type": "string",
"description": "Specifies shortcut of label.\n"
}
},
"type": "object",
"required": [
"name"
],
"language": {
"nodejs": {
"requiredOutputs": [
"name",
"propertyColor",
"propertyShape",
"propertyShortcut"
]
}
}
},
"flexibleengine:index/ModelartsDatasetLabelFormat:ModelartsDatasetLabelFormat": {
"properties": {
"labelSeparator": {
"type": "string",
"description": "Specifies the separator between label and label.\nChanging this parameter will create a new resource.\n"
},
"textLabelSeparator": {
"type": "string",
"description": "Specifies the separator between text and label.\nChanging this parameter will create a new resource.\n"
},
"type": {
"type": "string",
"description": "Specifies Label type for text classification.\nThe optional values are as follows:\n\n+ **0**: Label and text are separated, distinguished by the suffix `_result`.\nFor example: the text file is `abc.txt`, and the label file is \"`abc_result.txt`.\n+ **1**: Default, labels and text are in one file, separated by a delimiter. The separator between text and labels,\nthe separator between label and label can be specified by `label_separato` and `text_label_separator`.\n\nDefault value is `1`.\n"
}
},
"type": "object"
},
"flexibleengine:index/ModelartsDatasetSchema:ModelartsDatasetSchema": {
"properties": {
"name": {
"type": "string",
"description": "Specifies the field name. Changing this parameter will create a new resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the field type. Valid values include: `String`, `Short`, `Int`,\n`Long`, `Double`, `Float`, `Byte`, `Date`, `Timestamp`, `Bool`. Changing this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"name",
"type"
]
},
"flexibleengine:index/ModelartsDatasetTimeouts:ModelartsDatasetTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ModelartsDatasetVersionTimeouts:ModelartsDatasetVersionTimeouts": {
"properties": {
"create": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/MrsClusterV1AddJob:MrsClusterV1AddJob": {
"properties": {
"arguments": {
"type": "string",
"description": "Key parameter for program execution The parameter\nis specified by the function of the user's program. MRS is only responsible\nfor loading the parameter. The parameter contains a maximum of 2047 characters,\nexcluding special characters such as ;|&>'<$, and can be empty.\n"
},
"fileAction": {
"type": "string",
"description": "Data import and export import export\n"
},
"hiveScriptPath": {
"type": "string",
"description": "SQL program path This parameter is needed\nby Spark Script and Hive Script jobs only and must meet the following requirements:\nContains a maximum of 1023 characters, excluding special characters such as\n;|&><'$. The address cannot be empty or full of spaces. Starts with / or s3a://.\nEnds with .sql. sql is case-insensitive.\n"
},
"hql": {
"type": "string",
"description": "HiveQL statement\n"
},
"input": {
"type": "string",
"description": "Path for inputting data, which must start with / or s3a://.\nA correct OBS path is required. The parameter contains a maximum of 1023 characters,\nexcluding special characters such as ;|&>'<$, and can be empty.\n"
},
"jarPath": {
"type": "string",
"description": "Path of the .jar file or .sql file for program execution\nThe parameter must meet the following requirements: Contains a maximum of 1023\ncharacters, excluding special characters such as ;|&><'$. The address cannot\nbe empty or full of spaces. Starts with / or s3a://. Spark Script must end with\n.sql; while MapReduce and Spark Jar must end with .jar. sql and jar are case-insensitive.\n"
},
"jobLog": {
"type": "string",
"description": "Path for storing job logs that record job running status.\nThis path must start with / or s3a://. A correct OBS path is required. The parameter\ncontains a maximum of 1023 characters, excluding special characters such as\n;|&>'<$, and can be empty.\n"
},
"jobName": {
"type": "string",
"description": "Job name It contains only 1 to 64 letters, digits,\nhyphens (-), and underscores (_). NOTE: Identical job names are allowed but\nnot recommended.\n"
},
"jobType": {
"type": "number",
"description": "Job type. 1: MapReduce 2: Spark 3: Hive Script 4: HiveQL\n(not supported currently) 5: DistCp, importing and exporting data (not supported\nin this API currently). 6: Spark Script 7: Spark SQL, submitting Spark SQL statements\n(not supported in this API currently). NOTE: Spark and Hive jobs can be added\nto only clusters including Spark and Hive components.\n"
},
"output": {
"type": "string",
"description": "Path for outputting data, which must start with / or\ns3a://. A correct OBS path is required. If the path does not exist, the system\nautomatically creates it. The parameter contains a maximum of 1023 characters,\nexcluding special characters such as ;|&>'<$, and can be empty.\n"
},
"shutdownCluster": {
"type": "boolean",
"description": "Whether to delete the cluster after the jobs\nare complete true: Yes false: No\n"
},
"submitJobOnceClusterRun": {
"type": "boolean",
"description": "true: A job is submitted when a\ncluster is created. false: A job is submitted separately. The parameter is set\nto true in this example.\n"
}
},
"type": "object",
"required": [
"jarPath",
"jobName",
"jobType",
"submitJobOnceClusterRun"
],
"language": {
"nodejs": {
"requiredOutputs": [
"arguments",
"fileAction",
"hiveScriptPath",
"hql",
"input",
"jarPath",
"jobLog",
"jobName",
"jobType",
"output",
"shutdownCluster",
"submitJobOnceClusterRun"
]
}
}
},
"flexibleengine:index/MrsClusterV1ComponentList:MrsClusterV1ComponentList": {
"properties": {
"componentDesc": {
"type": "string",
"description": "Component description.\n"
},
"componentId": {
"type": "string",
"description": "Component ID. For example, component_id of Hadoop is MRS 3.1.0-LTS.1_001, MRS 2.1.0_001,\nMRS 2.0.1_001, and MRS 1.8.9_001.\n"
},
"componentName": {
"type": "string",
"description": "the Component name.\n+ MRS 3.1.0-LTS.1 supports the following components:\n- The analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine,\nLoader, Flink, Oozie, ZooKeeper, Ranger, and Tez.\n- The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger.\n+ MRS 2.0.1 supports the following components:\n- The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Hive, Hue, Loader, and Tez\n- The streaming cluster contains the following components: Kafka, Storm, and Flume.\n+ MRS 1.8.9 supports the following components:\n- The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Opentsdb, Hive, Hue, Loader,\nand Flink.\n- The streaming cluster contains the following components: Kafka, KafkaManager, Storm, and Flume.\n"
},
"componentVersion": {
"type": "string",
"description": "Component version.\n"
}
},
"type": "object",
"required": [
"componentName"
],
"language": {
"nodejs": {
"requiredOutputs": [
"componentDesc",
"componentId",
"componentName",
"componentVersion"
]
}
}
},
"flexibleengine:index/MrsClusterV1Timeouts:MrsClusterV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/MrsClusterV2AnalysisCoreNodes:MrsClusterV2AnalysisCoreNodes": {
"properties": {
"assignedRoles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the roles deployed in a node group. This argument is\n**Required** when the cluster type is CUSTOM. Each character string represents a role expression.\nChanging this will create a new MRS cluster resource.\n\n**Role expression definition:**\n\n+ If the role is deployed on all nodes in the node group, set this parameter to role_name, for example: `DataNode`.\n+ If the role is deployed on a specified subscript node in the node group: role_name:index1,index2..., indexN,\nfor example: `DataNode:1,2`. The subscript starts from 1.\n+ Some roles support multi-instance deployment (that is, multiple instances of the same role are deployed on a node):\nrole_name[instance_count], for example: `EsNode[9]`.\n\n[Mapping between roles and components](https://docs.prod-cloud-ocb.orange-business.com/api/mrs/mrs_02_0106.html)\n\n> `DBService` is a basic component of a cluster. Components such as Hive, Hue, Oozie, Loader, and Redis, and Loader\nstore their metadata in DBService, and provide the metadata backup and restoration functions by using DBService.\n"
},
"dataVolumeCount": {
"type": "number",
"description": "Specifies the data disk number of the nodes. The number configuration\nof each node are as follows:\n+ master_nodes: 1.\n+ analysis_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ analysis_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n\nChanging this will create a new MRS cluster resource.\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Specifies the data disk size of the nodes,in GB. The value range is 10\nto 32768. Required if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\n"
},
"dataVolumeType": {
"type": "string",
"description": "Specifies the data disk flavor of the nodes.\nRequired if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\nThe following disk types are supported:\n+ `SATA`: common I/O disk\n+ `SAS`: high I/O disk\n+ `SSD`: ultra-high I/O disk\n"
},
"flavor": {
"type": "string",
"description": "Specifies the instance specifications for each nodes in node group.\nChanging this will create a new MRS cluster resource.\n"
},
"hostIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "The host list of this nodes group in the cluster.\n"
},
"nodeNumber": {
"type": "number",
"description": "Specifies the number of nodes for the node group.\nOnly the core group and task group updations are allowed. The number of nodes after scaling cannot be less than the\nnumber of nodes originally created. It is **ForceNew** when the node type are **master_nodes** or **custom_nodes**,\nand changing this will create a new MRS cluster resource.\n"
},
"rootVolumeSize": {
"type": "number",
"description": "Specifies the system disk size of the nodes. Changing this will create\na new MRS cluster resource.\n"
},
"rootVolumeType": {
"type": "string",
"description": "Specifies the system disk flavor of the nodes. Changing this will\ncreate a new MRS cluster resource.\n"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"flavor",
"hostIps",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsClusterV2AnalysisTaskNodes:MrsClusterV2AnalysisTaskNodes": {
"properties": {
"assignedRoles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the roles deployed in a node group. This argument is\n**Required** when the cluster type is CUSTOM. Each character string represents a role expression.\nChanging this will create a new MRS cluster resource.\n\n**Role expression definition:**\n\n+ If the role is deployed on all nodes in the node group, set this parameter to role_name, for example: `DataNode`.\n+ If the role is deployed on a specified subscript node in the node group: role_name:index1,index2..., indexN,\nfor example: `DataNode:1,2`. The subscript starts from 1.\n+ Some roles support multi-instance deployment (that is, multiple instances of the same role are deployed on a node):\nrole_name[instance_count], for example: `EsNode[9]`.\n\n[Mapping between roles and components](https://docs.prod-cloud-ocb.orange-business.com/api/mrs/mrs_02_0106.html)\n\n> `DBService` is a basic component of a cluster. Components such as Hive, Hue, Oozie, Loader, and Redis, and Loader\nstore their metadata in DBService, and provide the metadata backup and restoration functions by using DBService.\n"
},
"dataVolumeCount": {
"type": "number",
"description": "Specifies the data disk number of the nodes. The number configuration\nof each node are as follows:\n+ master_nodes: 1.\n+ analysis_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ analysis_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n\nChanging this will create a new MRS cluster resource.\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Specifies the data disk size of the nodes,in GB. The value range is 10\nto 32768. Required if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\n"
},
"dataVolumeType": {
"type": "string",
"description": "Specifies the data disk flavor of the nodes.\nRequired if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\nThe following disk types are supported:\n+ `SATA`: common I/O disk\n+ `SAS`: high I/O disk\n+ `SSD`: ultra-high I/O disk\n"
},
"flavor": {
"type": "string",
"description": "Specifies the instance specifications for each nodes in node group.\nChanging this will create a new MRS cluster resource.\n"
},
"hostIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "The host list of this nodes group in the cluster.\n"
},
"nodeNumber": {
"type": "number",
"description": "Specifies the number of nodes for the node group.\nOnly the core group and task group updations are allowed. The number of nodes after scaling cannot be less than the\nnumber of nodes originally created. It is **ForceNew** when the node type are **master_nodes** or **custom_nodes**,\nand changing this will create a new MRS cluster resource.\n"
},
"rootVolumeSize": {
"type": "number",
"description": "Specifies the system disk size of the nodes. Changing this will create\na new MRS cluster resource.\n"
},
"rootVolumeType": {
"type": "string",
"description": "Specifies the system disk flavor of the nodes. Changing this will\ncreate a new MRS cluster resource.\n"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"flavor",
"hostIps",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsClusterV2Component:MrsClusterV2Component": {
"properties": {
"description": {
"type": "string",
"description": "Component description.\n"
},
"id": {
"type": "string",
"description": "Component ID. For example, component_id of Hadoop is MRS 3.1.0-LTS.1_001, MRS 2.0.1_001, and MRS 1.8.9_001.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the MRS cluster. The name can contain 2 to 64\ncharacters, which may consist of letters, digits, underscores (_) and hyphens (-). Changing this will create a new\nMRS cluster resource.\n"
},
"version": {
"type": "string",
"description": "Specifies the MRS cluster version. Currently, `MRS 1.8.9`,\n`MRS 2.0.1`, and `MRS 3.1.0-LTS.1` are supported. Changing this will create a new MRS cluster resource.\n"
}
},
"type": "object",
"required": [
"description",
"id",
"name",
"version"
]
},
"flexibleengine:index/MrsClusterV2CustomNode:MrsClusterV2CustomNode": {
"properties": {
"assignedRoles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the roles deployed in a node group. This argument is\n**Required** when the cluster type is CUSTOM. Each character string represents a role expression.\nChanging this will create a new MRS cluster resource.\n\n**Role expression definition:**\n\n+ If the role is deployed on all nodes in the node group, set this parameter to role_name, for example: `DataNode`.\n+ If the role is deployed on a specified subscript node in the node group: role_name:index1,index2..., indexN,\nfor example: `DataNode:1,2`. The subscript starts from 1.\n+ Some roles support multi-instance deployment (that is, multiple instances of the same role are deployed on a node):\nrole_name[instance_count], for example: `EsNode[9]`.\n\n[Mapping between roles and components](https://docs.prod-cloud-ocb.orange-business.com/api/mrs/mrs_02_0106.html)\n\n> `DBService` is a basic component of a cluster. Components such as Hive, Hue, Oozie, Loader, and Redis, and Loader\nstore their metadata in DBService, and provide the metadata backup and restoration functions by using DBService.\n"
},
"dataVolumeCount": {
"type": "number",
"description": "Specifies the data disk number of the nodes. The number configuration\nof each node are as follows:\n+ master_nodes: 1.\n+ analysis_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ analysis_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n\nChanging this will create a new MRS cluster resource.\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Specifies the data disk size of the nodes,in GB. The value range is 10\nto 32768. Required if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\n"
},
"dataVolumeType": {
"type": "string",
"description": "Specifies the data disk flavor of the nodes.\nRequired if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\nThe following disk types are supported:\n+ `SATA`: common I/O disk\n+ `SAS`: high I/O disk\n+ `SSD`: ultra-high I/O disk\n"
},
"flavor": {
"type": "string",
"description": "Specifies the instance specifications for each nodes in node group.\nChanging this will create a new MRS cluster resource.\n"
},
"groupName": {
"type": "string",
"description": "Specifies the name of nodes for the node group.\nThis argument is **Required** when the cluster type is CUSTOM. Changing this will create a new MRS cluster resource.\n"
},
"hostIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "The host list of this nodes group in the cluster.\n"
},
"nodeNumber": {
"type": "number",
"description": "Specifies the number of nodes for the node group.\nOnly the core group and task group updations are allowed. The number of nodes after scaling cannot be less than the\nnumber of nodes originally created. It is **ForceNew** when the node type are **master_nodes** or **custom_nodes**,\nand changing this will create a new MRS cluster resource.\n"
},
"rootVolumeSize": {
"type": "number",
"description": "Specifies the system disk size of the nodes. Changing this will create\na new MRS cluster resource.\n"
},
"rootVolumeType": {
"type": "string",
"description": "Specifies the system disk flavor of the nodes. Changing this will\ncreate a new MRS cluster resource.\n"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"flavor",
"groupName",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"flavor",
"groupName",
"hostIps",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsClusterV2MasterNodes:MrsClusterV2MasterNodes": {
"properties": {
"assignedRoles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the roles deployed in a node group. This argument is\n**Required** when the cluster type is CUSTOM. Each character string represents a role expression.\nChanging this will create a new MRS cluster resource.\n\n**Role expression definition:**\n\n+ If the role is deployed on all nodes in the node group, set this parameter to role_name, for example: `DataNode`.\n+ If the role is deployed on a specified subscript node in the node group: role_name:index1,index2..., indexN,\nfor example: `DataNode:1,2`. The subscript starts from 1.\n+ Some roles support multi-instance deployment (that is, multiple instances of the same role are deployed on a node):\nrole_name[instance_count], for example: `EsNode[9]`.\n\n[Mapping between roles and components](https://docs.prod-cloud-ocb.orange-business.com/api/mrs/mrs_02_0106.html)\n\n> `DBService` is a basic component of a cluster. Components such as Hive, Hue, Oozie, Loader, and Redis, and Loader\nstore their metadata in DBService, and provide the metadata backup and restoration functions by using DBService.\n"
},
"dataVolumeCount": {
"type": "number",
"description": "Specifies the data disk number of the nodes. The number configuration\nof each node are as follows:\n+ master_nodes: 1.\n+ analysis_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ analysis_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n\nChanging this will create a new MRS cluster resource.\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Specifies the data disk size of the nodes,in GB. The value range is 10\nto 32768. Required if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\n"
},
"dataVolumeType": {
"type": "string",
"description": "Specifies the data disk flavor of the nodes.\nRequired if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\nThe following disk types are supported:\n+ `SATA`: common I/O disk\n+ `SAS`: high I/O disk\n+ `SSD`: ultra-high I/O disk\n"
},
"flavor": {
"type": "string",
"description": "Specifies the instance specifications for each nodes in node group.\nChanging this will create a new MRS cluster resource.\n"
},
"hostIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "The host list of this nodes group in the cluster.\n"
},
"nodeNumber": {
"type": "number",
"description": "Specifies the number of nodes for the node group.\nOnly the core group and task group updations are allowed. The number of nodes after scaling cannot be less than the\nnumber of nodes originally created. It is **ForceNew** when the node type are **master_nodes** or **custom_nodes**,\nand changing this will create a new MRS cluster resource.\n"
},
"rootVolumeSize": {
"type": "number",
"description": "Specifies the system disk size of the nodes. Changing this will create\na new MRS cluster resource.\n"
},
"rootVolumeType": {
"type": "string",
"description": "Specifies the system disk flavor of the nodes. Changing this will\ncreate a new MRS cluster resource.\n"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"flavor",
"hostIps",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsClusterV2StreamingCoreNodes:MrsClusterV2StreamingCoreNodes": {
"properties": {
"assignedRoles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the roles deployed in a node group. This argument is\n**Required** when the cluster type is CUSTOM. Each character string represents a role expression.\nChanging this will create a new MRS cluster resource.\n\n**Role expression definition:**\n\n+ If the role is deployed on all nodes in the node group, set this parameter to role_name, for example: `DataNode`.\n+ If the role is deployed on a specified subscript node in the node group: role_name:index1,index2..., indexN,\nfor example: `DataNode:1,2`. The subscript starts from 1.\n+ Some roles support multi-instance deployment (that is, multiple instances of the same role are deployed on a node):\nrole_name[instance_count], for example: `EsNode[9]`.\n\n[Mapping between roles and components](https://docs.prod-cloud-ocb.orange-business.com/api/mrs/mrs_02_0106.html)\n\n> `DBService` is a basic component of a cluster. Components such as Hive, Hue, Oozie, Loader, and Redis, and Loader\nstore their metadata in DBService, and provide the metadata backup and restoration functions by using DBService.\n"
},
"dataVolumeCount": {
"type": "number",
"description": "Specifies the data disk number of the nodes. The number configuration\nof each node are as follows:\n+ master_nodes: 1.\n+ analysis_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ analysis_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n\nChanging this will create a new MRS cluster resource.\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Specifies the data disk size of the nodes,in GB. The value range is 10\nto 32768. Required if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\n"
},
"dataVolumeType": {
"type": "string",
"description": "Specifies the data disk flavor of the nodes.\nRequired if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\nThe following disk types are supported:\n+ `SATA`: common I/O disk\n+ `SAS`: high I/O disk\n+ `SSD`: ultra-high I/O disk\n"
},
"flavor": {
"type": "string",
"description": "Specifies the instance specifications for each nodes in node group.\nChanging this will create a new MRS cluster resource.\n"
},
"hostIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "The host list of this nodes group in the cluster.\n"
},
"nodeNumber": {
"type": "number",
"description": "Specifies the number of nodes for the node group.\nOnly the core group and task group updations are allowed. The number of nodes after scaling cannot be less than the\nnumber of nodes originally created. It is **ForceNew** when the node type are **master_nodes** or **custom_nodes**,\nand changing this will create a new MRS cluster resource.\n"
},
"rootVolumeSize": {
"type": "number",
"description": "Specifies the system disk size of the nodes. Changing this will create\na new MRS cluster resource.\n"
},
"rootVolumeType": {
"type": "string",
"description": "Specifies the system disk flavor of the nodes. Changing this will\ncreate a new MRS cluster resource.\n"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"flavor",
"hostIps",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsClusterV2StreamingTaskNodes:MrsClusterV2StreamingTaskNodes": {
"properties": {
"assignedRoles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the roles deployed in a node group. This argument is\n**Required** when the cluster type is CUSTOM. Each character string represents a role expression.\nChanging this will create a new MRS cluster resource.\n\n**Role expression definition:**\n\n+ If the role is deployed on all nodes in the node group, set this parameter to role_name, for example: `DataNode`.\n+ If the role is deployed on a specified subscript node in the node group: role_name:index1,index2..., indexN,\nfor example: `DataNode:1,2`. The subscript starts from 1.\n+ Some roles support multi-instance deployment (that is, multiple instances of the same role are deployed on a node):\nrole_name[instance_count], for example: `EsNode[9]`.\n\n[Mapping between roles and components](https://docs.prod-cloud-ocb.orange-business.com/api/mrs/mrs_02_0106.html)\n\n> `DBService` is a basic component of a cluster. Components such as Hive, Hue, Oozie, Loader, and Redis, and Loader\nstore their metadata in DBService, and provide the metadata backup and restoration functions by using DBService.\n"
},
"dataVolumeCount": {
"type": "number",
"description": "Specifies the data disk number of the nodes. The number configuration\nof each node are as follows:\n+ master_nodes: 1.\n+ analysis_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_core_nodes: minimum is one and the maximum is subject to the configuration of the corresponding flavor.\n+ analysis_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n+ streaming_task_nodes: minimum is zero and the maximum is subject to the configuration of the corresponding flavor.\n\nChanging this will create a new MRS cluster resource.\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Specifies the data disk size of the nodes,in GB. The value range is 10\nto 32768. Required if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\n"
},
"dataVolumeType": {
"type": "string",
"description": "Specifies the data disk flavor of the nodes.\nRequired if `data_volume_count` is greater than zero. Changing this will create a new MRS cluster resource.\nThe following disk types are supported:\n+ `SATA`: common I/O disk\n+ `SAS`: high I/O disk\n+ `SSD`: ultra-high I/O disk\n"
},
"flavor": {
"type": "string",
"description": "Specifies the instance specifications for each nodes in node group.\nChanging this will create a new MRS cluster resource.\n"
},
"hostIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "The host list of this nodes group in the cluster.\n"
},
"nodeNumber": {
"type": "number",
"description": "Specifies the number of nodes for the node group.\nOnly the core group and task group updations are allowed. The number of nodes after scaling cannot be less than the\nnumber of nodes originally created. It is **ForceNew** when the node type are **master_nodes** or **custom_nodes**,\nand changing this will create a new MRS cluster resource.\n"
},
"rootVolumeSize": {
"type": "number",
"description": "Specifies the system disk size of the nodes. Changing this will create\na new MRS cluster resource.\n"
},
"rootVolumeType": {
"type": "string",
"description": "Specifies the system disk flavor of the nodes. Changing this will\ncreate a new MRS cluster resource.\n"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"flavor",
"hostIps",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsClusterV2Timeouts:MrsClusterV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/MrsHybridClusterV1AnalysisCoreNodes:MrsHybridClusterV1AnalysisCoreNodes": {
"properties": {
"dataVolumeCount": {
"type": "number",
"description": "Number of data disks of the node\nValue range: 0 to 10\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Data disk size of the node\nValue range: 100 GB to 32000 GB\n"
},
"dataVolumeType": {
"type": "string",
"description": "Data disk storage type of the node, supporting SATA and SSD currently\n- SATA: common I/O\n- SSD: Ultrahigh-speed I/O\n"
},
"flavor": {
"type": "string",
"description": "Best match based on several years of commissioning\nexperience. MRS supports specifications of hosts, and host specifications are\ndetermined by CPUs, memory, and disks space.\n- Master nodes support s1.4xlarge and s1.8xlarge, c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4,\nc3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of a streaming cluster support s1.xlarge, c2.2xlarge, s1.2xlarge, s1.4xlarge, s1.8xlarge, d1.8xlarge,\nc3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of an analysis cluster support all specifications c2.2xlarge, s1.xlarge, s1.4xlarge, s1.8xlarge,\nd1.xlarge, d1.2xlarge, d1.4xlarge, d1.8xlarge, , c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2,\nc3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4, d2.xlarge.8, d2.2xlarge.8, d2.4xlarge.8, d2.8xlarge.8.\n\nThe following provides specification details.\n\nnode_size | CPU(core) | Memory(GB) | System Disk | Data Disk\n--- | --- | --- | --- | ---\nc2.2xlarge.linux.mrs | 8 | 16 | 40 | -\ncc3.xlarge.4.linux.mrs | 4 | 16 | 40 | -\ncc3.2xlarge.4.linux.mrs | 8 | 32 | 40 | -\ncc3.4xlarge.4.linux.mrs | 16 | 64 | 40 | -\ncc3.8xlarge.4.linux.mrs | 32 | 128 | 40 | -\ns1.xlarge.linux.mrs | 4 | 16 | 40 | -\ns1.4xlarge.linux.mrs | 16 | 64 | 40 | -\ns1.8xlarge.linux.mrs | 32 | 128 | 40 | -\ns3.xlarge.4.linux.mrs| 4 | 16 | 40 | -\ns3.2xlarge.4.linux.mrs| 8 | 32 | 40 | -\ns3.4xlarge.4.linux.mrs| 16 | 64 | 40 | -\nd1.xlarge.linux.mrs | 6 | 55 | 40 | 1.8 TB x 3 HDDs\nd1.2xlarge.linux.mrs | 12 | 110 | 40 | 1.8 TB x 6 HDDs\nd1.4xlarge.linux.mrs | 24 | 220 | 40 | 1.8 TB x 12 HDDs\nd1.8xlarge.linux.mrs | 48 | 440 | 40 | 1.8 TB x 24 HDDs\nd2.xlarge.linux.mrs | 4 | 32 | 40 | -\nd2.2xlarge.linux.mrs | 8 | 64 | 40 | -\nd2.4xlarge.linux.mrs | 16 | 128 | 40 | 1.8TB*8HDDs\nd2.8xlarge.linux.mrs | 32 | 256 | 40 | 1.8TB*16HDDs\n"
},
"nodeNumber": {
"type": "number",
"description": "Number of nodes. The value ranges from 0 to 500 and the default value is 0.\nThe total number of Core and Task nodes cannot exceed 500.\n"
},
"rootVolumeSize": {
"type": "number"
},
"rootVolumeType": {
"type": "string"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsHybridClusterV1AnalysisTaskNodes:MrsHybridClusterV1AnalysisTaskNodes": {
"properties": {
"dataVolumeCount": {
"type": "number",
"description": "Number of data disks of the node\nValue range: 0 to 10\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Data disk size of the node\nValue range: 100 GB to 32000 GB\n"
},
"dataVolumeType": {
"type": "string",
"description": "Data disk storage type of the node, supporting SATA and SSD currently\n- SATA: common I/O\n- SSD: Ultrahigh-speed I/O\n"
},
"flavor": {
"type": "string",
"description": "Best match based on several years of commissioning\nexperience. MRS supports specifications of hosts, and host specifications are\ndetermined by CPUs, memory, and disks space.\n- Master nodes support s1.4xlarge and s1.8xlarge, c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4,\nc3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of a streaming cluster support s1.xlarge, c2.2xlarge, s1.2xlarge, s1.4xlarge, s1.8xlarge, d1.8xlarge,\nc3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of an analysis cluster support all specifications c2.2xlarge, s1.xlarge, s1.4xlarge, s1.8xlarge,\nd1.xlarge, d1.2xlarge, d1.4xlarge, d1.8xlarge, , c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2,\nc3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4, d2.xlarge.8, d2.2xlarge.8, d2.4xlarge.8, d2.8xlarge.8.\n\nThe following provides specification details.\n\nnode_size | CPU(core) | Memory(GB) | System Disk | Data Disk\n--- | --- | --- | --- | ---\nc2.2xlarge.linux.mrs | 8 | 16 | 40 | -\ncc3.xlarge.4.linux.mrs | 4 | 16 | 40 | -\ncc3.2xlarge.4.linux.mrs | 8 | 32 | 40 | -\ncc3.4xlarge.4.linux.mrs | 16 | 64 | 40 | -\ncc3.8xlarge.4.linux.mrs | 32 | 128 | 40 | -\ns1.xlarge.linux.mrs | 4 | 16 | 40 | -\ns1.4xlarge.linux.mrs | 16 | 64 | 40 | -\ns1.8xlarge.linux.mrs | 32 | 128 | 40 | -\ns3.xlarge.4.linux.mrs| 4 | 16 | 40 | -\ns3.2xlarge.4.linux.mrs| 8 | 32 | 40 | -\ns3.4xlarge.4.linux.mrs| 16 | 64 | 40 | -\nd1.xlarge.linux.mrs | 6 | 55 | 40 | 1.8 TB x 3 HDDs\nd1.2xlarge.linux.mrs | 12 | 110 | 40 | 1.8 TB x 6 HDDs\nd1.4xlarge.linux.mrs | 24 | 220 | 40 | 1.8 TB x 12 HDDs\nd1.8xlarge.linux.mrs | 48 | 440 | 40 | 1.8 TB x 24 HDDs\nd2.xlarge.linux.mrs | 4 | 32 | 40 | -\nd2.2xlarge.linux.mrs | 8 | 64 | 40 | -\nd2.4xlarge.linux.mrs | 16 | 128 | 40 | 1.8TB*8HDDs\nd2.8xlarge.linux.mrs | 32 | 256 | 40 | 1.8TB*16HDDs\n"
},
"nodeNumber": {
"type": "number",
"description": "Number of nodes. The value ranges from 0 to 500 and the default value is 0.\nThe total number of Core and Task nodes cannot exceed 500.\n"
},
"rootVolumeSize": {
"type": "number"
},
"rootVolumeType": {
"type": "string"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsHybridClusterV1Component:MrsHybridClusterV1Component": {
"properties": {
"componentDesc": {
"type": "string",
"description": "Component description.\n"
},
"componentId": {
"type": "string",
"description": "Component ID. For example, component_id of Hadoop is MRS 3.1.0-LTS.1_001, MRS 2.1.0_001,\nMRS 2.0.1_001, and MRS 1.8.9_001.\n"
},
"componentName": {
"type": "string",
"description": "Component name.\n"
},
"componentVersion": {
"type": "string",
"description": "Component version.\n"
}
},
"type": "object",
"required": [
"componentDesc",
"componentId",
"componentName",
"componentVersion"
]
},
"flexibleengine:index/MrsHybridClusterV1MasterNodes:MrsHybridClusterV1MasterNodes": {
"properties": {
"dataVolumeCount": {
"type": "number",
"description": "Number of data disks of the node\nValue range: 0 to 10\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Data disk size of the node\nValue range: 100 GB to 32000 GB\n"
},
"dataVolumeType": {
"type": "string",
"description": "Data disk storage type of the node, supporting SATA and SSD currently\n- SATA: common I/O\n- SSD: Ultrahigh-speed I/O\n"
},
"flavor": {
"type": "string",
"description": "Best match based on several years of commissioning\nexperience. MRS supports specifications of hosts, and host specifications are\ndetermined by CPUs, memory, and disks space.\n- Master nodes support s1.4xlarge and s1.8xlarge, c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4,\nc3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of a streaming cluster support s1.xlarge, c2.2xlarge, s1.2xlarge, s1.4xlarge, s1.8xlarge, d1.8xlarge,\nc3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of an analysis cluster support all specifications c2.2xlarge, s1.xlarge, s1.4xlarge, s1.8xlarge,\nd1.xlarge, d1.2xlarge, d1.4xlarge, d1.8xlarge, , c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2,\nc3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4, d2.xlarge.8, d2.2xlarge.8, d2.4xlarge.8, d2.8xlarge.8.\n\nThe following provides specification details.\n\nnode_size | CPU(core) | Memory(GB) | System Disk | Data Disk\n--- | --- | --- | --- | ---\nc2.2xlarge.linux.mrs | 8 | 16 | 40 | -\ncc3.xlarge.4.linux.mrs | 4 | 16 | 40 | -\ncc3.2xlarge.4.linux.mrs | 8 | 32 | 40 | -\ncc3.4xlarge.4.linux.mrs | 16 | 64 | 40 | -\ncc3.8xlarge.4.linux.mrs | 32 | 128 | 40 | -\ns1.xlarge.linux.mrs | 4 | 16 | 40 | -\ns1.4xlarge.linux.mrs | 16 | 64 | 40 | -\ns1.8xlarge.linux.mrs | 32 | 128 | 40 | -\ns3.xlarge.4.linux.mrs| 4 | 16 | 40 | -\ns3.2xlarge.4.linux.mrs| 8 | 32 | 40 | -\ns3.4xlarge.4.linux.mrs| 16 | 64 | 40 | -\nd1.xlarge.linux.mrs | 6 | 55 | 40 | 1.8 TB x 3 HDDs\nd1.2xlarge.linux.mrs | 12 | 110 | 40 | 1.8 TB x 6 HDDs\nd1.4xlarge.linux.mrs | 24 | 220 | 40 | 1.8 TB x 12 HDDs\nd1.8xlarge.linux.mrs | 48 | 440 | 40 | 1.8 TB x 24 HDDs\nd2.xlarge.linux.mrs | 4 | 32 | 40 | -\nd2.2xlarge.linux.mrs | 8 | 64 | 40 | -\nd2.4xlarge.linux.mrs | 16 | 128 | 40 | 1.8TB*8HDDs\nd2.8xlarge.linux.mrs | 32 | 256 | 40 | 1.8TB*16HDDs\n"
},
"nodeNumber": {
"type": "number",
"description": "Number of nodes. The value ranges from 0 to 500 and the default value is 0.\nThe total number of Core and Task nodes cannot exceed 500.\n"
},
"rootVolumeSize": {
"type": "number"
},
"rootVolumeType": {
"type": "string"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsHybridClusterV1StreamingCoreNodes:MrsHybridClusterV1StreamingCoreNodes": {
"properties": {
"dataVolumeCount": {
"type": "number",
"description": "Number of data disks of the node\nValue range: 0 to 10\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Data disk size of the node\nValue range: 100 GB to 32000 GB\n"
},
"dataVolumeType": {
"type": "string",
"description": "Data disk storage type of the node, supporting SATA and SSD currently\n- SATA: common I/O\n- SSD: Ultrahigh-speed I/O\n"
},
"flavor": {
"type": "string",
"description": "Best match based on several years of commissioning\nexperience. MRS supports specifications of hosts, and host specifications are\ndetermined by CPUs, memory, and disks space.\n- Master nodes support s1.4xlarge and s1.8xlarge, c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4,\nc3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of a streaming cluster support s1.xlarge, c2.2xlarge, s1.2xlarge, s1.4xlarge, s1.8xlarge, d1.8xlarge,\nc3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of an analysis cluster support all specifications c2.2xlarge, s1.xlarge, s1.4xlarge, s1.8xlarge,\nd1.xlarge, d1.2xlarge, d1.4xlarge, d1.8xlarge, , c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2,\nc3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4, d2.xlarge.8, d2.2xlarge.8, d2.4xlarge.8, d2.8xlarge.8.\n\nThe following provides specification details.\n\nnode_size | CPU(core) | Memory(GB) | System Disk | Data Disk\n--- | --- | --- | --- | ---\nc2.2xlarge.linux.mrs | 8 | 16 | 40 | -\ncc3.xlarge.4.linux.mrs | 4 | 16 | 40 | -\ncc3.2xlarge.4.linux.mrs | 8 | 32 | 40 | -\ncc3.4xlarge.4.linux.mrs | 16 | 64 | 40 | -\ncc3.8xlarge.4.linux.mrs | 32 | 128 | 40 | -\ns1.xlarge.linux.mrs | 4 | 16 | 40 | -\ns1.4xlarge.linux.mrs | 16 | 64 | 40 | -\ns1.8xlarge.linux.mrs | 32 | 128 | 40 | -\ns3.xlarge.4.linux.mrs| 4 | 16 | 40 | -\ns3.2xlarge.4.linux.mrs| 8 | 32 | 40 | -\ns3.4xlarge.4.linux.mrs| 16 | 64 | 40 | -\nd1.xlarge.linux.mrs | 6 | 55 | 40 | 1.8 TB x 3 HDDs\nd1.2xlarge.linux.mrs | 12 | 110 | 40 | 1.8 TB x 6 HDDs\nd1.4xlarge.linux.mrs | 24 | 220 | 40 | 1.8 TB x 12 HDDs\nd1.8xlarge.linux.mrs | 48 | 440 | 40 | 1.8 TB x 24 HDDs\nd2.xlarge.linux.mrs | 4 | 32 | 40 | -\nd2.2xlarge.linux.mrs | 8 | 64 | 40 | -\nd2.4xlarge.linux.mrs | 16 | 128 | 40 | 1.8TB*8HDDs\nd2.8xlarge.linux.mrs | 32 | 256 | 40 | 1.8TB*16HDDs\n"
},
"nodeNumber": {
"type": "number",
"description": "Number of nodes. The value ranges from 0 to 500 and the default value is 0.\nThe total number of Core and Task nodes cannot exceed 500.\n"
},
"rootVolumeSize": {
"type": "number"
},
"rootVolumeType": {
"type": "string"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsHybridClusterV1StreamingTaskNodes:MrsHybridClusterV1StreamingTaskNodes": {
"properties": {
"dataVolumeCount": {
"type": "number",
"description": "Number of data disks of the node\nValue range: 0 to 10\n"
},
"dataVolumeSize": {
"type": "number",
"description": "Data disk size of the node\nValue range: 100 GB to 32000 GB\n"
},
"dataVolumeType": {
"type": "string",
"description": "Data disk storage type of the node, supporting SATA and SSD currently\n- SATA: common I/O\n- SSD: Ultrahigh-speed I/O\n"
},
"flavor": {
"type": "string",
"description": "Best match based on several years of commissioning\nexperience. MRS supports specifications of hosts, and host specifications are\ndetermined by CPUs, memory, and disks space.\n- Master nodes support s1.4xlarge and s1.8xlarge, c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4,\nc3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of a streaming cluster support s1.xlarge, c2.2xlarge, s1.2xlarge, s1.4xlarge, s1.8xlarge, d1.8xlarge,\nc3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2, c3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4.\n- Core nodes of an analysis cluster support all specifications c2.2xlarge, s1.xlarge, s1.4xlarge, s1.8xlarge,\nd1.xlarge, d1.2xlarge, d1.4xlarge, d1.8xlarge, , c3.2xlarge.2, c3.xlarge.4, c3.2xlarge.4, c3.4xlarge.2,\nc3.4xlarge.4, c3.8xlarge.4, c3.15xlarge.4, d2.xlarge.8, d2.2xlarge.8, d2.4xlarge.8, d2.8xlarge.8.\n\nThe following provides specification details.\n\nnode_size | CPU(core) | Memory(GB) | System Disk | Data Disk\n--- | --- | --- | --- | ---\nc2.2xlarge.linux.mrs | 8 | 16 | 40 | -\ncc3.xlarge.4.linux.mrs | 4 | 16 | 40 | -\ncc3.2xlarge.4.linux.mrs | 8 | 32 | 40 | -\ncc3.4xlarge.4.linux.mrs | 16 | 64 | 40 | -\ncc3.8xlarge.4.linux.mrs | 32 | 128 | 40 | -\ns1.xlarge.linux.mrs | 4 | 16 | 40 | -\ns1.4xlarge.linux.mrs | 16 | 64 | 40 | -\ns1.8xlarge.linux.mrs | 32 | 128 | 40 | -\ns3.xlarge.4.linux.mrs| 4 | 16 | 40 | -\ns3.2xlarge.4.linux.mrs| 8 | 32 | 40 | -\ns3.4xlarge.4.linux.mrs| 16 | 64 | 40 | -\nd1.xlarge.linux.mrs | 6 | 55 | 40 | 1.8 TB x 3 HDDs\nd1.2xlarge.linux.mrs | 12 | 110 | 40 | 1.8 TB x 6 HDDs\nd1.4xlarge.linux.mrs | 24 | 220 | 40 | 1.8 TB x 12 HDDs\nd1.8xlarge.linux.mrs | 48 | 440 | 40 | 1.8 TB x 24 HDDs\nd2.xlarge.linux.mrs | 4 | 32 | 40 | -\nd2.2xlarge.linux.mrs | 8 | 64 | 40 | -\nd2.4xlarge.linux.mrs | 16 | 128 | 40 | 1.8TB*8HDDs\nd2.8xlarge.linux.mrs | 32 | 256 | 40 | 1.8TB*16HDDs\n"
},
"nodeNumber": {
"type": "number",
"description": "Number of nodes. The value ranges from 0 to 500 and the default value is 0.\nThe total number of Core and Task nodes cannot exceed 500.\n"
},
"rootVolumeSize": {
"type": "number"
},
"rootVolumeType": {
"type": "string"
}
},
"type": "object",
"required": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber"
],
"language": {
"nodejs": {
"requiredOutputs": [
"dataVolumeCount",
"dataVolumeSize",
"dataVolumeType",
"flavor",
"nodeNumber",
"rootVolumeSize",
"rootVolumeType"
]
}
}
},
"flexibleengine:index/MrsHybridClusterV1Timeouts:MrsHybridClusterV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/MrsJobV1Timeouts:MrsJobV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/MrsJobV2Timeouts:MrsJobV2Timeouts": {
"properties": {
"create": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NatGatewayV2Timeouts:NatGatewayV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NatSnatRuleV2Timeouts:NatSnatRuleV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkAclTimeouts:NetworkAclTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingFloatingipV2Timeouts:NetworkingFloatingipV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingNetworkV2Segment:NetworkingNetworkV2Segment": {
"properties": {
"networkType": {
"type": "string",
"description": "The type of physical network.\n"
},
"physicalNetwork": {
"type": "string",
"description": "The physical network where this network is implemented.\n"
},
"segmentationId": {
"type": "number",
"description": "An isolated segment on the physical network.\n"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingNetworkV2Timeouts:NetworkingNetworkV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingPortV2AllowedAddressPair:NetworkingPortV2AllowedAddressPair": {
"properties": {
"ipAddress": {
"type": "string",
"description": "The additional IP address. The value can be an IP Address or a CIDR,\nand can not be *0.0.0.0*. A server connected to the port can send a packet with source address\nwhich matches one of the specified allowed address pairs.\nIt is recommended to configure an independent security group for the port if a large CIDR\nblock (subnet mask less than 24) is configured.\n"
},
"macAddress": {
"type": "string",
"description": "The additional MAC address.\n"
}
},
"type": "object",
"required": [
"ipAddress"
],
"language": {
"nodejs": {
"requiredOutputs": [
"ipAddress",
"macAddress"
]
}
}
},
"flexibleengine:index/NetworkingPortV2FixedIp:NetworkingPortV2FixedIp": {
"properties": {
"ipAddress": {
"type": "string",
"description": "The additional IP address. The value can be an IP Address or a CIDR,\nand can not be *0.0.0.0*. A server connected to the port can send a packet with source address\nwhich matches one of the specified allowed address pairs.\nIt is recommended to configure an independent security group for the port if a large CIDR\nblock (subnet mask less than 24) is configured.\n"
},
"subnetId": {
"type": "string",
"description": "The `ipv4_subnet_id` or `ipv6_subnet_id` of the\nVPC Subnet in which to allocate IP address for this port.\n"
}
},
"type": "object",
"required": [
"subnetId"
],
"language": {
"nodejs": {
"requiredOutputs": [
"ipAddress",
"subnetId"
]
}
}
},
"flexibleengine:index/NetworkingPortV2Timeouts:NetworkingPortV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingRouterInterfaceV2Timeouts:NetworkingRouterInterfaceV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingRouterV2Timeouts:NetworkingRouterV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingSecgroupRuleV2Timeouts:NetworkingSecgroupRuleV2Timeouts": {
"properties": {
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingSecgroupV2Timeouts:NetworkingSecgroupV2Timeouts": {
"properties": {
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingSubnetV2AllocationPool:NetworkingSubnetV2AllocationPool": {
"properties": {
"end": {
"type": "string",
"description": "The ending addresss.\n"
},
"start": {
"type": "string",
"description": "The starting address.\n"
}
},
"type": "object",
"required": [
"end",
"start"
]
},
"flexibleengine:index/NetworkingSubnetV2HostRoute:NetworkingSubnetV2HostRoute": {
"properties": {
"destinationCidr": {
"type": "string",
"description": "The destination CIDR.\n"
},
"nextHop": {
"type": "string",
"description": "The next hop in the route.\n"
}
},
"type": "object",
"required": [
"destinationCidr",
"nextHop"
]
},
"flexibleengine:index/NetworkingSubnetV2Timeouts:NetworkingSubnetV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/NetworkingVipV2Timeouts:NetworkingVipV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/ObsBucketAclAccountPermission:ObsBucketAclAccountPermission": {
"properties": {
"accessToAcls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to acl. Valid values are **READ_ACP** and **WRITE_ACP**.\n"
},
"accessToBuckets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to bucket. Valid values are **READ** and **WRITE**.\n"
},
"accountId": {
"type": "string",
"description": "Specifies the account id to authorize. The account id cannot be the bucket owner,\nand must be unique.\n"
}
},
"type": "object",
"required": [
"accountId"
]
},
"flexibleengine:index/ObsBucketAclLogDeliveryUserPermission:ObsBucketAclLogDeliveryUserPermission": {
"properties": {
"accessToAcls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to acl. Valid values are **READ_ACP** and **WRITE_ACP**.\n"
},
"accessToBuckets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to bucket. Valid values are **READ** and **WRITE**.\n"
}
},
"type": "object"
},
"flexibleengine:index/ObsBucketAclOwnerPermission:ObsBucketAclOwnerPermission": {
"properties": {
"accessToAcls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to acl. Valid values are **READ_ACP** and **WRITE_ACP**.\n"
},
"accessToBuckets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to bucket. Valid values are **READ** and **WRITE**.\n"
}
},
"type": "object"
},
"flexibleengine:index/ObsBucketAclPublicPermission:ObsBucketAclPublicPermission": {
"properties": {
"accessToAcls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to acl. Valid values are **READ_ACP** and **WRITE_ACP**.\n"
},
"accessToBuckets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to bucket. Valid values are **READ** and **WRITE**.\n"
}
},
"type": "object"
},
"flexibleengine:index/ObsBucketCorsRule:ObsBucketCorsRule": {
"properties": {
"allowedHeaders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the allowed header of cross-origin requests.\nOnly CORS requests matching the allowed header are valid.\n"
},
"allowedMethods": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the acceptable operation type of buckets and objects.\nThe methods include `GET`, `PUT`, `POST`, `DELETE` or `HEAD`.\n"
},
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
},
"description": "Requests from this origin can access the bucket. Multiple matching rules are\nallowed. One rule occupies one line, and allows one wildcard character (*) at most.\n"
},
"exposeHeaders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the exposed header in CORS responses, providing additional information\nfor clients.\n"
},
"maxAgeSeconds": {
"type": "number",
"description": "Specifies the duration that your browser can cache CORS responses, expressed in\nseconds. The default value is 100.\n\n\nThe `lifecycle_rule` object supports:\n"
}
},
"type": "object",
"required": [
"allowedMethods",
"allowedOrigins"
]
},
"flexibleengine:index/ObsBucketLifecycleRule:ObsBucketLifecycleRule": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Specifies lifecycle rule status.\n"
},
"expirations": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FObsBucketLifecycleRuleExpiration:ObsBucketLifecycleRuleExpiration"
},
"description": "Specifies a period when objects that have been last updated are automatically deleted.\nThe expiration object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.\n"
},
"noncurrentVersionExpirations": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FObsBucketLifecycleRuleNoncurrentVersionExpiration:ObsBucketLifecycleRuleNoncurrentVersionExpiration"
},
"description": "Specifies a period when noncurrent object versions are automatically\ndeleted. The noncurrent_version_expiration object structure is documented below.\n"
},
"noncurrentVersionTransitions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FObsBucketLifecycleRuleNoncurrentVersionTransition:ObsBucketLifecycleRuleNoncurrentVersionTransition"
},
"description": "Specifies a period when noncurrent object versions are automatically\ntransitioned to `STANDARD_IA` or `GLACIER` storage class.\nThe noncurrent_version_transition object structure is documented below.\n\nAt least one of `expiration`, `transition`, `noncurrent_version_expiration`, `noncurrent_version_transition` must\nbe specified.\n\n\nThe `expiration` object supports:\n"
},
"prefix": {
"type": "string",
"description": "Object key prefix identifying one or more objects to which the rule applies.\nIf omitted, all objects in the bucket will be managed by the lifecycle rule.\nThe prefix cannot start or end with a slash (/), cannot have consecutive slashes (/),\nand cannot contain the following special characters: \\:*?\"<>|.\n"
},
"transitions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FObsBucketLifecycleRuleTransition:ObsBucketLifecycleRuleTransition"
},
"description": "Specifies a period when objects that have been last updated are automatically\ntransitioned to `STANDARD_IA` or `GLACIER` storage class.\nThe transition object structure is documented below.\n"
}
},
"type": "object",
"required": [
"enabled",
"name"
]
},
"flexibleengine:index/ObsBucketLifecycleRuleExpiration:ObsBucketLifecycleRuleExpiration": {
"properties": {
"days": {
"type": "number",
"description": "Specifies the number of days when noncurrent object versions are automatically\ntransitioned to the specified storage class.\n"
}
},
"type": "object",
"required": [
"days"
]
},
"flexibleengine:index/ObsBucketLifecycleRuleNoncurrentVersionExpiration:ObsBucketLifecycleRuleNoncurrentVersionExpiration": {
"properties": {
"days": {
"type": "number",
"description": "Specifies the number of days when noncurrent object versions are automatically\ntransitioned to the specified storage class.\n"
}
},
"type": "object",
"required": [
"days"
]
},
"flexibleengine:index/ObsBucketLifecycleRuleNoncurrentVersionTransition:ObsBucketLifecycleRuleNoncurrentVersionTransition": {
"properties": {
"days": {
"type": "number",
"description": "Specifies the number of days when noncurrent object versions are automatically\ntransitioned to the specified storage class.\n"
},
"storageClass": {
"type": "string",
"description": "The class of storage used to store the object. Only \"STANDARD_IA\" and \"GLACIER\"\nare supported.\n"
}
},
"type": "object",
"required": [
"days",
"storageClass"
]
},
"flexibleengine:index/ObsBucketLifecycleRuleTransition:ObsBucketLifecycleRuleTransition": {
"properties": {
"days": {
"type": "number",
"description": "Specifies the number of days when noncurrent object versions are automatically\ntransitioned to the specified storage class.\n"
},
"storageClass": {
"type": "string",
"description": "The class of storage used to store the object. Only \"STANDARD_IA\" and \"GLACIER\"\nare supported.\n"
}
},
"type": "object",
"required": [
"days",
"storageClass"
]
},
"flexibleengine:index/ObsBucketLogging:ObsBucketLogging": {
"properties": {
"agency": {
"type": "string",
"description": "Specifies the IAM agency of OBS cloud service.\n\n> The IAM agency requires the `PutObject` permission for the target bucket. If default encryption is enabled for the\ntarget bucket, the agency also requires the `KMS Administrator` permission in the region where the target bucket is\nlocated.\n\n\nThe `website` object supports:\n"
},
"targetBucket": {
"type": "string",
"description": "The name of the bucket that will receive the log objects.\nThe acl policy of the target bucket should be `log-delivery-write`.\n"
},
"targetPrefix": {
"type": "string",
"description": "To specify a key prefix for log objects.\n"
}
},
"type": "object",
"required": [
"targetBucket"
],
"language": {
"nodejs": {
"requiredOutputs": [
"agency",
"targetBucket"
]
}
}
},
"flexibleengine:index/ObsBucketNotificationsNotification:ObsBucketNotificationsNotification": {
"properties": {
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "Type of events that need to be notified. The events include `ObjectCreated:*`,\n`ObjectCreated:Put`, `ObjectCreated:Post`, `ObjectCreated:Copy`, `ObjectCreated:CompleteMultipartUpload`,\n`ObjectRemoved:*`, `ObjectRemoved:Delete`, `ObjectRemoved:DeleteMarkerCreated`.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of OBS Notification. If not specified, the system assigns an ID\nautomatically.\n"
},
"prefix": {
"type": "string",
"description": "Specifies the prefix filtering rule. The value contains a maximum of 1024 characters.\n"
},
"suffix": {
"type": "string",
"description": "Specifies the suffix filtering rule. The value contains a maximum of 1024 characters.\n"
},
"topicUrn": {
"type": "string",
"description": "Specifies the SMN topic that authorizes OBS to publish messages.\n"
}
},
"type": "object",
"required": [
"events",
"topicUrn"
],
"language": {
"nodejs": {
"requiredOutputs": [
"events",
"name",
"prefix",
"suffix",
"topicUrn"
]
}
}
},
"flexibleengine:index/ObsBucketObjectAclAccountPermission:ObsBucketObjectAclAccountPermission": {
"properties": {
"accessToAcls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to acl. Valid values are **READ_ACP** and **WRITE_ACP**.\n"
},
"accessToObjects": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to object. Only **READ** supported.\n"
},
"accountId": {
"type": "string",
"description": "Specifies the account id to authorize. The account id cannot be the object owner,\nand must be unique.\n"
}
},
"type": "object",
"required": [
"accountId"
]
},
"flexibleengine:index/ObsBucketObjectAclOwnerPermission:ObsBucketObjectAclOwnerPermission": {
"properties": {
"accessToAcls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to acl. Valid values are **READ_ACP** and **WRITE_ACP**.\n"
},
"accessToObjects": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to object. Only **READ** supported.\n"
}
},
"type": "object",
"required": [
"accessToAcls",
"accessToObjects"
]
},
"flexibleengine:index/ObsBucketObjectAclPublicPermission:ObsBucketObjectAclPublicPermission": {
"properties": {
"accessToAcls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to acl. Valid values are **READ_ACP** and **WRITE_ACP**.\n"
},
"accessToObjects": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access to object. Only **READ** supported.\n"
}
},
"type": "object"
},
"flexibleengine:index/ObsBucketReplicationRule:ObsBucketReplicationRule": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Specifies cross-region replication rule status. Defaults to `true`.\n"
},
"id": {
"type": "string",
"description": "The ID of a rule in UUID format.\n"
},
"prefix": {
"type": "string",
"description": "Specifies the object key prefix identifying one or more objects to which the rule\napplies and duplicated prefixes are not supported. If omitted, all objects in the bucket will be managed by the\nlifecycle rule. To copy a folder, end the prefix with a slash (/), for example, imgs/.\n"
},
"storageClass": {
"type": "string",
"description": "Specifies the storage class for replicated objects. Valid values are \"STANDARD\",\n\"WARM\" (Infrequent Access) and \"COLD\" (Archive).\nIf omitted, the storage class of object copies is the same as that of objects in the source bucket.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"id"
]
}
}
},
"flexibleengine:index/ObsBucketWebsite:ObsBucketWebsite": {
"properties": {
"errorDocument": {
"type": "string",
"description": "Specifies the error page returned when an error occurs during static website\naccess. Only HTML, JPG, PNG, BMP, and WEBP files under the root directory are supported.\n"
},
"indexDocument": {
"type": "string",
"description": "Specifies the default homepage of the static website, only HTML web pages are\nsupported. It is **Optional** if using `redirect_all_requests_to`.\nOBS only allows files such as `index.html` in the root directory of a bucket to function as the default homepage.\nThat is to say, do not set the default homepage with a multi-level directory structure (for example, /page/index.html).\n"
},
"redirectAllRequestsTo": {
"type": "string",
"description": "A hostname to redirect all website requests for this bucket to.\nHostname can optionally be prefixed with a protocol (`http://` or `https://`) to use when redirecting requests.\nThe default is the protocol that is used in the original request.\n"
},
"routingRules": {
"type": "string",
"description": "A JSON or XML format containing routing rules describing redirect behavior and\nwhen redirects are applied.\nEach rule contains a `Condition` and a `Redirect` as shown in the following table:\n\nParameter | Key\n--- | ---\nCondition | KeyPrefixEquals, HttpErrorCodeReturnedEquals\nRedirect | Protocol, HostName, ReplaceKeyPrefixWith, ReplaceKeyWith, HttpRedirectCode\n\n\nThe `cors_rule` object supports:\n"
}
},
"type": "object"
},
"flexibleengine:index/RdsAccountTimeouts:RdsAccountTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RdsBackupDatabase:RdsBackupDatabase": {
"properties": {
"name": {
"type": "string",
"description": "Database to be backed up for Microsoft SQL Server.\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"name"
]
},
"flexibleengine:index/RdsBackupTimeouts:RdsBackupTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RdsCrossRegionBackupStrategyTimeouts:RdsCrossRegionBackupStrategyTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RdsDatabasePrivilegeTimeouts:RdsDatabasePrivilegeTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RdsDatabasePrivilegeUser:RdsDatabasePrivilegeUser": {
"properties": {
"name": {
"type": "string",
"description": "Specifies the username of the database account.\n"
},
"readonly": {
"type": "boolean",
"description": "Specifies the read-only permission. The value can be:\n+ **true**: indicates the read-only permission.\n+ **false**: indicates the read and write permission.\n\nThe default value is **false**.\n"
}
},
"type": "object",
"required": [
"name"
],
"language": {
"nodejs": {
"requiredOutputs": [
"name",
"readonly"
]
}
}
},
"flexibleengine:index/RdsDatabaseTimeouts:RdsDatabaseTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RdsInstanceV1Backupstrategy:RdsInstanceV1Backupstrategy": {
"properties": {
"keepdays": {
"type": "number",
"description": "Specifies the number of days to retain the generated backup files.\nIts value range is 0 to 35. If this parameter is not specified or set to 0, the\nautomated backup policy is disabled.\n"
},
"starttime": {
"type": "string",
"description": "Indicates the backup start time that has been set.\nThe backup task will be triggered within one hour after the backup start time.\nValid value: The value cannot be empty. It must use the hh:mm:ss format and\nmust be valid. The current time is the UTC time.\n"
}
},
"type": "object"
},
"flexibleengine:index/RdsInstanceV1Datastore:RdsInstanceV1Datastore": {
"properties": {
"type": {
"type": "string",
"description": "Specifies the DB engine. Currently, MySQL, PostgreSQL, and\nMicrosoft SQL Server are supported. The value is MySQL, PostgreSQL, or SQLServer.\n"
},
"version": {
"type": "string",
"description": "Specifies the DB instance version.\n\n* Available value for attributes\n\n\ntype | version\n---- | ---\nPostgreSQL | 9.5.5
9.6.3
9.6.5\nMySQL| 5.6.33
5.6.30
5.6.34
5.6.35
5.7.17\nSQLServer| 2014 SP2 SE\n"
}
},
"type": "object",
"required": [
"type",
"version"
]
},
"flexibleengine:index/RdsInstanceV1Ha:RdsInstanceV1Ha": {
"properties": {
"enable": {
"type": "boolean",
"description": "Specifies the configured parameters on the HA.\nValid value: The value is true or false. The value true indicates creating\nHA DB instances. The value false indicates creating a single DB instance.\n"
},
"replicationmode": {
"type": "string",
"description": "Specifies the replication mode for the standby DB instance.\nThe value cannot be empty.\nFor MySQL, the value is async or semisync.\nFor PostgreSQL, the value is async or sync.\n"
}
},
"type": "object"
},
"flexibleengine:index/RdsInstanceV1Nics:RdsInstanceV1Nics": {
"properties": {
"subnetid": {
"type": "string"
}
},
"type": "object",
"required": [
"subnetid"
]
},
"flexibleengine:index/RdsInstanceV1Securitygroup:RdsInstanceV1Securitygroup": {
"properties": {
"id": {
"type": "string",
"description": "Specifies the ID obtained from the securitygroup.\n"
}
},
"type": "object",
"required": [
"id"
]
},
"flexibleengine:index/RdsInstanceV1Timeouts:RdsInstanceV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RdsInstanceV1Volume:RdsInstanceV1Volume": {
"properties": {
"size": {
"type": "number",
"description": "Specifies the volume size.\nIts value must be a multiple of 10 and the value range is 100 GB to 2000 GB.\n"
},
"type": {
"type": "string",
"description": "Specifies the volume type. Valid value:\nIt must be COMMON (SATA) or ULTRAHIGH (SSD) and is case-sensitive.\n"
}
},
"type": "object",
"required": [
"size",
"type"
]
},
"flexibleengine:index/RdsInstanceV3BackupStrategy:RdsInstanceV3BackupStrategy": {
"properties": {
"keepDays": {
"type": "number",
"description": "Specifies the retention days for specific backup files. The value range is from 0 to\n732. If this parameter is not specified or set to 0, the automated backup policy is disabled.\n\n> **NOTE:** Primary/standby DB instances of Microsoft SQL Server do not support disabling the automated backup\npolicy.\n"
},
"period": {
"type": "string"
},
"startTime": {
"type": "string",
"description": "Specifies the backup time window. Automated backups will be triggered during the\nbackup time window. It must be a valid value in the **hh:mm-HH:MM** format.\nThe current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must\nbe the same and must be set to any of the following: 00, 15, 30, or 45. Example value: 08:15-09:15 23:00-00:00.\n\n\nThe `parameters` block supports:\n"
}
},
"type": "object",
"required": [
"startTime"
],
"language": {
"nodejs": {
"requiredOutputs": [
"keepDays",
"period",
"startTime"
]
}
}
},
"flexibleengine:index/RdsInstanceV3Db:RdsInstanceV3Db": {
"properties": {
"password": {
"type": "string",
"description": "Specifies the database password. The value cannot be\nempty and should contain 8 to 32 characters, including uppercase\nand lowercase letters, digits, and the following special\ncharacters: ~!@#%^*-_=+? You are advised to enter a strong\npassword to improve security, preventing security risks such as\nbrute force cracking. Changing this parameter will create a new resource.\n",
"secret": true
},
"port": {
"type": "number",
"description": "Specifies the database port.\n+ The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system\nand cannot be used). The default value is 3306.\n+ The PostgreSQL database port ranges from 2100 to 9500. The default value is 5432.\n+ The Microsoft SQL Server database port can be 1433 or ranges from 2100 to 9500, excluding 5355 and 5985.\nThe default value is 1433.\n+ The MariaDB database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system\nand cannot be used). The default value is 3306.\n\n\nThe `volume` block supports:\n"
},
"type": {
"type": "string",
"description": "Specifies the volume type. Its value can be any of the following\nand is case-sensitive:\n+ *COMMON*: indicates the SATA type.\n+ *ULTRAHIGH*: indicates the SSD type.\n+ *CLOUDSSD*: cloud SSD storage. This storage type is supported only with general-purpose and dedicated DB\ninstances.\n\nChanging this parameter will create a new resource.\n"
},
"userName": {
"type": "string",
"description": "Indicates the default username of database.\n"
},
"version": {
"type": "string",
"description": "Specifies the database version. The supported versions of each database\nare as follows:\n+ **MySQL**: MySQL databases support **5.6**, **5.7** and **8.0**.\n+ **PostgreSQL**: PostgreSQL databases support **9.5**, **9.6**, **10**, **11**, **12**, **13**, **14** and\n**1.0 (Enhanced Edition)**.\n+ **SQLServer**: SQLServer databases support **2014 SE** and **2014 EE**.\n+ **MariaDB**: MariaDB databases support **10.5**.\n\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"type",
"version"
],
"language": {
"nodejs": {
"requiredOutputs": [
"port",
"type",
"userName",
"version"
]
}
}
},
"flexibleengine:index/RdsInstanceV3Node:RdsInstanceV3Node": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "Specifies the list of AZ name.\nChanging this parameter will create a new resource.\n"
},
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the parameter name. Some of them needs the instance to be restarted\nto take effect.\n"
},
"role": {
"type": "string",
"description": "Indicates the node type. The value can be master or slave,\nindicating the primary node or standby node respectively.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
}
},
"type": "object",
"required": [
"availabilityZone",
"id",
"name",
"role",
"status"
]
},
"flexibleengine:index/RdsInstanceV3Parameter:RdsInstanceV3Parameter": {
"properties": {
"name": {
"type": "string",
"description": "Specifies the parameter name. Some of them needs the instance to be restarted\nto take effect.\n"
},
"value": {
"type": "string",
"description": "Specifies the parameter value.\n"
}
},
"type": "object",
"required": [
"name",
"value"
]
},
"flexibleengine:index/RdsInstanceV3Restore:RdsInstanceV3Restore": {
"properties": {
"backupId": {
"type": "string"
},
"databaseName": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"instanceId": {
"type": "string"
}
},
"type": "object",
"required": [
"backupId",
"instanceId"
]
},
"flexibleengine:index/RdsInstanceV3Timeouts:RdsInstanceV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"default": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RdsInstanceV3Volume:RdsInstanceV3Volume": {
"properties": {
"diskEncryptionId": {
"type": "string",
"description": "Specifies the key ID for disk encryption.\nChanging this parameter will create a new resource.\n\n\nThe `backup_strategy` block supports:\n"
},
"limitSize": {
"type": "number"
},
"size": {
"type": "number",
"description": "Specifies the volume size. Its value range is from 40 GB to 4000 GB.\nThe value must be a multiple of 10 and greater than the original size.\n"
},
"triggerThreshold": {
"type": "number"
},
"type": {
"type": "string",
"description": "Specifies the volume type. Its value can be any of the following\nand is case-sensitive:\n+ *COMMON*: indicates the SATA type.\n+ *ULTRAHIGH*: indicates the SSD type.\n+ *CLOUDSSD*: cloud SSD storage. This storage type is supported only with general-purpose and dedicated DB\ninstances.\n\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"size",
"type"
],
"language": {
"nodejs": {
"requiredOutputs": [
"diskEncryptionId",
"size",
"type"
]
}
}
},
"flexibleengine:index/RdsParametergroupV3ConfigurationParameter:RdsParametergroupV3ConfigurationParameter": {
"properties": {
"description": {
"type": "string",
"description": "The parameter group description. It contains a maximum of 256 characters and\ncannot contain the following special characters:>!<\"&'= the value is left blank by default.\n"
},
"name": {
"type": "string",
"description": "The parameter group name. It contains a maximum of 64 characters.\n"
},
"readonly": {
"type": "boolean",
"description": "Indicates whether the parameter is read-only.\n"
},
"restartRequired": {
"type": "boolean",
"description": "Indicates whether a restart is required.\n"
},
"type": {
"type": "string",
"description": "The DB engine. Currently, MySQL, PostgreSQL, and Microsoft SQL Server are supported.\nThe value is case-insensitive and can be **mysql**, **postgresql**, **sqlserver**or **mariadb**.\n"
},
"value": {
"type": "string",
"description": "Indicates the parameter value.\n"
},
"valueRange": {
"type": "string",
"description": "Indicates the parameter value range.\n"
}
},
"type": "object",
"required": [
"description",
"name",
"readonly",
"restartRequired",
"type",
"value",
"valueRange"
]
},
"flexibleengine:index/RdsParametergroupV3Datastore:RdsParametergroupV3Datastore": {
"properties": {
"type": {
"type": "string",
"description": "The DB engine. Currently, MySQL, PostgreSQL, and Microsoft SQL Server are supported.\nThe value is case-insensitive and can be **mysql**, **postgresql**, **sqlserver**or **mariadb**.\n"
},
"version": {
"type": "string",
"description": "Specifies the database version.\n\n+ MySQL databases support MySQL 5.6 and 5.7. Example value: 5.7.\n+ PostgreSQL databases support PostgreSQL 9.5 and 9.6. Example value: 9.5.\n+ MariaDB databases support MariaDB 10.5. Example value: 10.5.\n"
}
},
"type": "object",
"required": [
"type",
"version"
]
},
"flexibleengine:index/RdsParametergroupV3Timeouts:RdsParametergroupV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RdsReadReplicaV3Db:RdsReadReplicaV3Db": {
"properties": {
"port": {
"type": "number",
"description": "Indicates the database port information.\n"
},
"type": {
"type": "string",
"description": "Specifies the volume type. Its value can be any of the following\nand is case-sensitive:\n- ULTRAHIGH: indicates the SSD type.\n- ULTRAHIGHPRO: indicates the ultra-high I/O.\n\nChanging this parameter will create a new resource.\n"
},
"userName": {
"type": "string",
"description": "Indicates the default username of database.\n"
},
"version": {
"type": "string",
"description": "Indicates the database version.\n"
}
},
"type": "object",
"required": [
"port",
"type",
"userName",
"version"
]
},
"flexibleengine:index/RdsReadReplicaV3Timeouts:RdsReadReplicaV3Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RdsReadReplicaV3Volume:RdsReadReplicaV3Volume": {
"properties": {
"diskEncryptionId": {
"type": "string",
"description": "Specifies the key ID for disk encryption.\nChanging this parameter will create a new resource.\n"
},
"size": {
"type": "number",
"description": "Specifies the volume size. Its value range is from **40** GB to **4000** GB. The value must\nbe a multiple of 10 and greater than the original size.\n"
},
"type": {
"type": "string",
"description": "Specifies the volume type. Its value can be any of the following\nand is case-sensitive:\n- ULTRAHIGH: indicates the SSD type.\n- ULTRAHIGHPRO: indicates the ultra-high I/O.\n\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"type"
],
"language": {
"nodejs": {
"requiredOutputs": [
"size",
"type"
]
}
}
},
"flexibleengine:index/RdsSqlAuditTimeouts:RdsSqlAuditTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RtsSoftwareConfigV1Timeouts:RtsSoftwareConfigV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/RtsStackV1Timeouts:RtsStackV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/S3BucketCorsRule:S3BucketCorsRule": {
"properties": {
"allowedHeaders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies which headers are allowed.\n"
},
"allowedMethods": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies which methods are allowed. Can be `GET`, `PUT`, `POST`, `DELETE`\nor `HEAD`.\n"
},
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies which origins are allowed.\n"
},
"exposeHeaders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies expose header in the response.\n"
},
"maxAgeSeconds": {
"type": "number",
"description": "Specifies time in seconds that browser can cache the response for a preflight\nrequest.\n\n\nThe `versioning` object supports:\n"
}
},
"type": "object",
"required": [
"allowedMethods",
"allowedOrigins"
]
},
"flexibleengine:index/S3BucketLifecycleRule:S3BucketLifecycleRule": {
"properties": {
"abortIncompleteMultipartUploadDays": {
"type": "number",
"description": "Specifies the number of days after initiating a multipart\nupload when the multipart upload must be completed.\n"
},
"enabled": {
"type": "boolean",
"description": "Specifies lifecycle rule status.\n"
},
"expirations": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FS3BucketLifecycleRuleExpiration:S3BucketLifecycleRuleExpiration"
},
"description": "Specifies a period in the object's expire.\nThe expiration object structure is documented below.\n"
},
"id": {
"type": "string",
"description": "Unique identifier for the rule.\n"
},
"noncurrentVersionExpirations": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FS3BucketLifecycleRuleNoncurrentVersionExpiration:S3BucketLifecycleRuleNoncurrentVersionExpiration"
},
"description": "Specifies when noncurrent object versions expire.\nThe noncurrent_version_expiration object structure is documented below.\n\nAt least one of `expiration`, `noncurrent_version_expiration` must be specified.\n\n\nThe `expiration` object supports:\n"
},
"prefix": {
"type": "string",
"description": "Object key prefix identifying one or more objects to which the rule applies.\n"
}
},
"type": "object",
"required": [
"enabled"
],
"language": {
"nodejs": {
"requiredOutputs": [
"enabled",
"id"
]
}
}
},
"flexibleengine:index/S3BucketLifecycleRuleExpiration:S3BucketLifecycleRuleExpiration": {
"properties": {
"date": {
"type": "string",
"description": "Specifies the date after which you want the corresponding action to take effect.\n"
},
"days": {
"type": "number",
"description": "Specifies the number of days an object is noncurrent object versions expire.\n"
},
"expiredObjectDeleteMarker": {
"type": "boolean",
"description": "On a versioned bucket (versioning-enabled or versioning-suspended\nbucket), you can add this element in the lifecycle configuration to direct Amazon S3 to delete expired object delete\nmarkers.\n\n\nThe `noncurrent_version_expiration` object supports:\n"
}
},
"type": "object"
},
"flexibleengine:index/S3BucketLifecycleRuleNoncurrentVersionExpiration:S3BucketLifecycleRuleNoncurrentVersionExpiration": {
"properties": {
"days": {
"type": "number",
"description": "Specifies the number of days an object is noncurrent object versions expire.\n"
}
},
"type": "object"
},
"flexibleengine:index/S3BucketLogging:S3BucketLogging": {
"properties": {
"targetBucket": {
"type": "string",
"description": "The name of the bucket that will receive the log objects.\n"
},
"targetPrefix": {
"type": "string",
"description": "To specify a key prefix for log objects.\n\n\nThe `lifecycle_rule` object supports:\n"
}
},
"type": "object",
"required": [
"targetBucket"
]
},
"flexibleengine:index/S3BucketVersioning:S3BucketVersioning": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Specifies lifecycle rule status.\n"
},
"mfaDelete": {
"type": "boolean",
"description": "Enable MFA delete for either change the versioning state of your bucket or\npermanently delete an object version. Default is `false`.\n\n\nThe `logging` object supports:\n"
}
},
"type": "object"
},
"flexibleengine:index/S3BucketWebsite:S3BucketWebsite": {
"properties": {
"errorDocument": {
"type": "string",
"description": "An absolute path to the document to return in case of a 4XX error.\n"
},
"indexDocument": {
"type": "string",
"description": "Amazon S3 returns this index document when requests are made to the root domain\nor any of the subfolders. It is **Optional** if using `redirect_all_requests_to`.\n"
},
"redirectAllRequestsTo": {
"type": "string",
"description": "A hostname to redirect all website requests for this bucket to.\nHostname can optionally be prefixed with a protocol (`http://` or `https://`) to use when redirecting requests.\nThe default is the protocol that is used in the original request.\n"
},
"routingRules": {
"type": "string",
"description": "A json array containing [routing rules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html)\ndescribing redirect behavior and when redirects are applied.\n\n\nThe `cors_rule` object supports:\n"
}
},
"type": "object"
},
"flexibleengine:index/SdrsDrillV1Timeouts:SdrsDrillV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SdrsProtectedinstanceV1Timeouts:SdrsProtectedinstanceV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SdrsProtectiongroupV1Timeouts:SdrsProtectiongroupV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SdrsReplicationAttachV1Timeouts:SdrsReplicationAttachV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SdrsReplicationPairV1Timeouts:SdrsReplicationPairV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SfsAccessRuleV2Timeouts:SfsAccessRuleV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SfsFileSystemV2AccessRule:SfsFileSystemV2AccessRule": {
"properties": {
"accessLevel": {
"type": "string",
"description": "Specifies the access level of the shared file system. Possible values are *ro*\n(read-only) and *rw* (read-write). The default value is *rw* (read/write). Changing this will create a new access rule.\n"
},
"accessRuleId": {
"type": "string",
"description": "The UUID of the share access rule.\n"
},
"accessTo": {
"type": "string",
"description": "Specifies the value that defines the access rule. The value contains 1 to 255\ncharacters. Changing this will create a new access rule. The value varies according to the scenario:\n+ Set the VPC ID in VPC authorization scenarios.\n+ Set this parameter in IP address authorization scenario.\n\n- For an NFS shared file system, the value in the format of *VPC_ID#IP_address#priority#user_permission*.\nFor example, 0157b53f-4974-4e80-91c9-098532bcaf00#2.2.2.2/16#100#all_squash,root_squash.\n\n- For a CIFS shared file system, the value in the format of *VPC_ID#IP_address#priority*.\nFor example, 0157b53f-4974-4e80-91c9-098532bcaf00#2.2.2.2/16#0.\n\n> **NOTE:** If you want to create more access rules, please using flexibleengine_sfs_access_rule_v2.\n"
},
"accessType": {
"type": "string",
"description": "Specifies the type of the share access rule. The default value is *cert*.\nChanging this will create a new access rule.\n"
},
"status": {
"type": "string",
"description": "The status of the share access rule.\n"
}
},
"type": "object",
"required": [
"accessLevel",
"accessRuleId",
"accessTo",
"accessType",
"status"
]
},
"flexibleengine:index/SfsFileSystemV2Timeouts:SfsFileSystemV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SfsTurboTimeouts:SfsTurboTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SmnSubscriptionV2Extension:SmnSubscriptionV2Extension": {
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"keyword": {
"type": "string"
},
"signSecret": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SmsServerTemplateTimeouts:SmsServerTemplateTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SmsTaskTargetServerDisk:SmsTaskTargetServerDisk": {
"properties": {
"deviceType": {
"type": "string",
"description": "Specifies the partition type. The value can be **NORMAL** and **OS**.\nChanging this parameter will create a new resource.\n"
},
"diskId": {
"type": "string",
"description": "Specifies the disk index, e.g. \"0\".\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the volume name. In Windows, it indicates the drive letter,\nand in Linux, it indicates the device ID, e.g. \"/dev/sda1\".\nChanging this parameter will create a new resource.\n"
},
"physicalVolumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FSmsTaskTargetServerDiskPhysicalVolume:SmsTaskTargetServerDiskPhysicalVolume"
},
"description": "Specifies an array of physical volume informations.\nThe object is documented below. Changing this parameter will create a new resource.\n\n\nThe `physical_volumes` block supports:\n"
},
"size": {
"type": "number",
"description": "Specifies the volume size in MB. Changing this parameter will create a new resource.\n"
},
"usedSize": {
"type": "number",
"description": "Specifies the used space in MB.\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"deviceType",
"name",
"size"
],
"language": {
"nodejs": {
"requiredOutputs": [
"deviceType",
"diskId",
"name",
"size",
"usedSize"
]
}
}
},
"flexibleengine:index/SmsTaskTargetServerDiskPhysicalVolume:SmsTaskTargetServerDiskPhysicalVolume": {
"properties": {
"deviceType": {
"type": "string",
"description": "Specifies the partition type. The value can be **NORMAL** and **OS**.\nChanging this parameter will create a new resource.\n"
},
"fileSystem": {
"type": "string",
"description": "Specifies the file system type, e.g. \"ext4\".\nChanging this parameter will create a new resource.\n"
},
"index": {
"type": "number",
"description": "Specifies the serial number of the volume.\nChanging this parameter will create a new resource.\n"
},
"mountPoint": {
"type": "string",
"description": "Specifies the mount point, e.g. \"/\".\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the volume name. In Windows, it indicates the drive letter,\nand in Linux, it indicates the device ID, e.g. \"/dev/sda1\".\nChanging this parameter will create a new resource.\n"
},
"size": {
"type": "number",
"description": "Specifies the volume size in MB. Changing this parameter will create a new resource.\n"
},
"usedSize": {
"type": "number",
"description": "Specifies the used space in MB.\nChanging this parameter will create a new resource.\n"
},
"uuid": {
"type": "string",
"description": "Specifies the GUID of the volume.\nChanging this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"deviceType",
"fileSystem",
"index",
"mountPoint",
"name",
"size"
],
"language": {
"nodejs": {
"requiredOutputs": [
"deviceType",
"fileSystem",
"index",
"mountPoint",
"name",
"size",
"usedSize",
"uuid"
]
}
}
},
"flexibleengine:index/SmsTaskTimeouts:SmsTaskTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SwrOrganizationTimeouts:SwrOrganizationTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SwrOrganizationUsersSelfPermission:SwrOrganizationUsersSelfPermission": {
"properties": {
"permission": {
"type": "string",
"description": "Specifies the permission of the existing IAM user.\nThe values can be **Manage**, **Write** and **Read**.\n"
},
"userId": {
"type": "string",
"description": "Specifies the ID of the existing IAM user.\n"
},
"userName": {
"type": "string",
"description": "Specifies the name of the existing IAM user.\n"
}
},
"type": "object",
"required": [
"permission",
"userId",
"userName"
]
},
"flexibleengine:index/SwrOrganizationUsersTimeouts:SwrOrganizationUsersTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SwrOrganizationUsersUser:SwrOrganizationUsersUser": {
"properties": {
"permission": {
"type": "string",
"description": "Specifies the permission of the existing IAM user.\nThe values can be **Manage**, **Write** and **Read**.\n"
},
"userId": {
"type": "string",
"description": "Specifies the ID of the existing IAM user.\n"
},
"userName": {
"type": "string",
"description": "Specifies the name of the existing IAM user.\n"
}
},
"type": "object",
"required": [
"permission",
"userId"
],
"language": {
"nodejs": {
"requiredOutputs": [
"permission",
"userId",
"userName"
]
}
}
},
"flexibleengine:index/SwrRepositorySharingTimeouts:SwrRepositorySharingTimeouts": {
"properties": {
"default": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/SwrRepositoryTimeouts:SwrRepositoryTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
},
"update": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/TmsTagsTag:TmsTagsTag": {
"properties": {
"key": {
"type": "string",
"description": "Specifies the tag key. The value can contain up to 36 characters.\nOnly letters, digits, hyphens (-), underscores (_), and Unicode characters from \\u4e00 to \\u9fff are allowed.\nChanging this will create a new resource.\n"
},
"value": {
"type": "string",
"description": "Specifies the tag value. The value can contain up to 43 characters.\nOnly letters, digits, periods (.), hyphens (-), and underscores (_), and Unicode characters from \\u4e00 to \\u9fff\nare allowed. Changing this will create a new resource.\n"
}
},
"type": "object",
"required": [
"key",
"value"
]
},
"flexibleengine:index/TmsTagsTimeouts:TmsTagsTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VbsBackupPolicyV2Timeouts:VbsBackupPolicyV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VbsBackupV2Timeouts:VbsBackupV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcEipAssociateTimeouts:VpcEipAssociateTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcEipBandwidth:VpcEipBandwidth": {
"properties": {
"chargeMode": {
"type": "string",
"description": "Specifies whether the bandwidth is billed by traffic or by bandwidth size.\nOnly **traffic** supported now. Changing this creates a new EIP.\n"
},
"name": {
"type": "string",
"description": "The bandwidth name, which is a string of 1 to 64 characters\nthat contain letters, digits, underscores (_), and hyphens (-).\n"
},
"shareType": {
"type": "string",
"description": "Specifies the bandwidth type.\nThe value is *PER*, indicating that the bandwidth is dedicated.\nChanging this creates a new EIP.\n"
},
"size": {
"type": "number",
"description": "The bandwidth size. The value ranges from 1 to 1000 Mbit/s.\n"
}
},
"type": "object",
"required": [
"name",
"shareType",
"size"
],
"language": {
"nodejs": {
"requiredOutputs": [
"chargeMode",
"name",
"shareType",
"size"
]
}
}
},
"flexibleengine:index/VpcEipPublicip:VpcEipPublicip": {
"properties": {
"ipAddress": {
"type": "string",
"description": "The value must be a valid IP address in the available IP address segment.\nChanging this creates a new EIP.\n"
},
"portId": {
"type": "string",
"description": "The port id which this EIP will associate with. If the value\nis not specified, the EIP will be in unbind state.\n"
},
"type": {
"type": "string",
"description": "The value must be a type supported by the system. Only **5_bgp** supported now.\nChanging this creates a new EIP.\n"
}
},
"type": "object",
"required": [
"type"
],
"language": {
"nodejs": {
"requiredOutputs": [
"ipAddress",
"portId",
"type"
]
}
}
},
"flexibleengine:index/VpcEipTimeouts:VpcEipTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcEipV1Bandwidth:VpcEipV1Bandwidth": {
"properties": {
"chargeMode": {
"type": "string"
},
"name": {
"type": "string"
},
"shareType": {
"type": "string"
},
"size": {
"type": "number"
}
},
"type": "object",
"required": [
"name",
"shareType",
"size"
],
"language": {
"nodejs": {
"requiredOutputs": [
"chargeMode",
"name",
"shareType",
"size"
]
}
}
},
"flexibleengine:index/VpcEipV1Publicip:VpcEipV1Publicip": {
"properties": {
"ipAddress": {
"type": "string"
},
"portId": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object",
"required": [
"type"
],
"language": {
"nodejs": {
"requiredOutputs": [
"ipAddress",
"portId",
"type"
]
}
}
},
"flexibleengine:index/VpcEipV1Timeouts:VpcEipV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcFlowLogV1Timeouts:VpcFlowLogV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcPeeringConnectionAccepterV2Timeouts:VpcPeeringConnectionAccepterV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcPeeringConnectionV2Timeouts:VpcPeeringConnectionV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcRouteTableRoute:VpcRouteTableRoute": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the supplementary information about the route.\nThe value is a string of no more than 255 characters and cannot contain angle brackets (< or >).\n"
},
"destination": {
"type": "string",
"description": "Specifies the destination address in the CIDR notation format,\nfor example, 192.168.200.0/24. The destination of each route must be unique and cannot overlap\nwith any subnet in the VPC.\n"
},
"nexthop": {
"type": "string",
"description": "Specifies the next hop.\n+ If the route type is **ecs**, the value is an ECS instance ID in the VPC.\n+ If the route type is **eni**, the value is the extension NIC of an ECS in the VPC.\n+ If the route type is **vip**, the value is a virtual IP address.\n+ If the route type is **nat**, the value is a VPN gateway ID.\n+ If the route type is **peering**, the value is a VPC peering connection ID.\n+ If the route type is **vpn**, the value is a VPN gateway ID.\n+ If the route type is **dc**, the value is a Direct Connect gateway ID.\n"
},
"type": {
"type": "string",
"description": "Specifies the route type. Currently, the value can be:\n**ecs**, **eni**, **vip**, **nat**, **peering**, **vpn** and **dc**.\n"
}
},
"type": "object",
"required": [
"destination",
"nexthop",
"type"
]
},
"flexibleengine:index/VpcRouteTableTimeouts:VpcRouteTableTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcRouteTimeouts:VpcRouteTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcRouteV2Timeouts:VpcRouteV2Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcSubnetV1Timeouts:VpcSubnetV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcV1Route:VpcV1Route": {
"properties": {
"destination": {
"type": "string"
},
"nexthop": {
"type": "string"
}
},
"type": "object",
"required": [
"destination",
"nexthop"
]
},
"flexibleengine:index/VpcV1Timeouts:VpcV1Timeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcepApprovalConnection:VpcepApprovalConnection": {
"properties": {
"domainId": {
"type": "string",
"description": "The user's domain ID.\n"
},
"endpointId": {
"type": "string",
"description": "The unique ID of the VPC endpoint.\n"
},
"packetId": {
"type": "number",
"description": "The packet ID of the VPC endpoint.\n"
},
"status": {
"type": "string",
"description": "The connection status of the VPC endpoint.\n"
}
},
"type": "object",
"required": [
"domainId",
"endpointId",
"packetId",
"status"
]
},
"flexibleengine:index/VpcepApprovalTimeouts:VpcepApprovalTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcepEndpointTimeouts:VpcepEndpointTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/VpcepServiceConnection:VpcepServiceConnection": {
"properties": {
"domainId": {
"type": "string",
"description": "The user's domain ID.\n"
},
"endpointId": {
"type": "string",
"description": "The unique ID of the VPC endpoint.\n"
},
"packetId": {
"type": "number",
"description": "The packet ID of the VPC endpoint.\n"
},
"status": {
"type": "string",
"description": "The connection status of the VPC endpoint.\n"
}
},
"type": "object",
"required": [
"domainId",
"endpointId",
"packetId",
"status"
]
},
"flexibleengine:index/VpcepServicePortMapping:VpcepServicePortMapping": {
"properties": {
"protocol": {
"type": "string",
"description": "Specifies the protocol used in port mappings.\nThe value can be *TCP* or *UDP*. The default value is *TCP*.\n"
},
"servicePort": {
"type": "number",
"description": "Specifies the port for accessing the VPC endpoint service.\nThis port is provided by the backend service to provide services. The value ranges from 1 to 65535.\n"
},
"terminalPort": {
"type": "number",
"description": "Specifies the port for accessing the VPC endpoint.\nThis port is provided by the VPC endpoint, allowing you to access the VPC endpoint service.\nThe value ranges from 1 to 65535.\n"
}
},
"type": "object"
},
"flexibleengine:index/VpcepServiceTimeouts:VpcepServiceTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/WafCertificateTimeouts:WafCertificateTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/WafDedicatedCertificateTimeouts:WafDedicatedCertificateTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/WafDedicatedDomainServer:WafDedicatedDomainServer": {
"properties": {
"address": {
"type": "string",
"description": "IP address or domain name of the web server that the client accesses. For\nexample, `192.168.1.1` or `www.example.com`. Changing this creates a new service.\n"
},
"clientProtocol": {
"type": "string",
"description": "Protocol type of the client. The options include `HTTP` and `HTTPS`.\nChanging this creates a new service.\n"
},
"port": {
"type": "number",
"description": "Port number used by the web server. The value ranges from 0 to 65535. Changing this\ncreates a new service.\n"
},
"serverProtocol": {
"type": "string",
"description": "Protocol used by WAF to forward client requests to the server. The\noptions include `HTTP` and `HTTPS`. Changing this creates a new service.\n"
},
"type": {
"type": "string",
"description": "Server network type, IPv4 or IPv6. Valid values are: `ipv4` and `ipv6`. Changing\nthis creates a new service.\n"
},
"vpcId": {
"type": "string",
"description": "The id of the vpc used by the server. Changing this creates a service.\n"
}
},
"type": "object",
"required": [
"address",
"clientProtocol",
"port",
"serverProtocol",
"type",
"vpcId"
]
},
"flexibleengine:index/WafDedicatedInstanceTimeouts:WafDedicatedInstanceTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/WafDedicatedPolicyOption:WafDedicatedPolicyOption": {
"properties": {
"basicWebProtection": {
"type": "boolean",
"description": "Indicates whether Basic Web Protection is enabled.\n"
},
"blacklist": {
"type": "boolean",
"description": "Indicates whether Blacklist and Whitelist is enabled.\n"
},
"ccAttackProtection": {
"type": "boolean",
"description": "Indicates whether CC Attack Protection is enabled.\n"
},
"crawler": {
"type": "boolean",
"description": "Indicates whether the master crawler detection switch in Basic Web Protection is enabled.\n"
},
"crawlerEngine": {
"type": "boolean",
"description": "Indicates whether the Search Engine switch in Basic Web Protection is enabled.\n"
},
"crawlerOther": {
"type": "boolean",
"description": "Indicates whether detection of other crawlers in Basic Web Protection is enabled.\n"
},
"crawlerScanner": {
"type": "boolean",
"description": "Indicates whether the Scanner switch in Basic Web Protection is enabled.\n"
},
"crawlerScript": {
"type": "boolean",
"description": "Indicates whether the Script Tool switch in Basic Web Protection is enabled.\n"
},
"dataMasking": {
"type": "boolean",
"description": "Indicates whether Data Masking is enabled.\n"
},
"falseAlarmMasking": {
"type": "boolean",
"description": "Indicates whether False Alarm Masking is enabled.\n"
},
"generalCheck": {
"type": "boolean",
"description": "Indicates whether General Check in Basic Web Protection is enabled.\n"
},
"preciseProtection": {
"type": "boolean",
"description": "Indicates whether Precise Protection is enabled.\n"
},
"webTamperProtection": {
"type": "boolean",
"description": "Indicates whether Web Tamper Protection is enabled.\n"
},
"webshell": {
"type": "boolean",
"description": "Indicates whether webshell detection in Basic Web Protection is enabled.\n"
}
},
"type": "object",
"required": [
"basicWebProtection",
"blacklist",
"ccAttackProtection",
"crawler",
"crawlerEngine",
"crawlerOther",
"crawlerScanner",
"crawlerScript",
"dataMasking",
"falseAlarmMasking",
"generalCheck",
"preciseProtection",
"webTamperProtection",
"webshell"
]
},
"flexibleengine:index/WafDedicatedPolicyTimeouts:WafDedicatedPolicyTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/WafDomainServer:WafDomainServer": {
"properties": {
"address": {
"type": "string",
"description": "IP address or domain name of the web server that the client accesses.\nFor example, `192.168.1.1` or `www.a.com`.\n"
},
"clientProtocol": {
"type": "string",
"description": "Protocol type of the client. The options are *HTTP* and *HTTPS*.\n"
},
"port": {
"type": "number",
"description": "Port number used by the web server. The value ranges from 0 to 65535, for example, 8080.\n"
},
"serverProtocol": {
"type": "string",
"description": "Protocol used by WAF to forward client requests to the server.\nThe options are *HTTP* and *HTTPS*.\n"
}
},
"type": "object",
"required": [
"address",
"port"
],
"language": {
"nodejs": {
"requiredOutputs": [
"address",
"clientProtocol",
"port",
"serverProtocol"
]
}
}
},
"flexibleengine:index/WafDomainTimeouts:WafDomainTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/WafPolicyProtectionStatus:WafPolicyProtectionStatus": {
"properties": {
"basicWebProtection": {
"type": "boolean",
"description": "Specifies whether Basic Web Protection is enabled.\n"
},
"blacklist": {
"type": "boolean",
"description": "Specifies whether Blacklist and Whitelist is enabled.\n"
},
"ccProtection": {
"type": "boolean",
"description": "Specifies whether CC Attack Protection is enabled.\n"
},
"crawlerEngine": {
"type": "boolean",
"description": "Specifies whether the Search Engine switch in Basic Web Protection is enabled.\n"
},
"crawlerOther": {
"type": "boolean",
"description": "Specifies whether detection of other crawlers in Basic Web Protection is enabled.\n"
},
"crawlerScanner": {
"type": "boolean",
"description": "Specifies whether the Scanner switch in Basic Web Protection is enabled.\n"
},
"crawlerScript": {
"type": "boolean",
"description": "Specifies whether the Script Tool switch in Basic Web Protection is enabled.\n"
},
"dataMasking": {
"type": "boolean",
"description": "Specifies whether Data Masking is enabled.\n"
},
"falseAlarmMasking": {
"type": "boolean",
"description": "Specifies whether False Alarm Masking is enabled.\n"
},
"generalCheck": {
"type": "boolean",
"description": "Specifies whether General Check in Basic Web Protection is enabled.\n"
},
"preciseProtection": {
"type": "boolean",
"description": "Specifies whether Precise Protection is enabled.\n"
},
"webTamperProtection": {
"type": "boolean",
"description": "Specifies whether Web Tamper Protection is enabled.\n"
},
"webshell": {
"type": "boolean",
"description": "Specifies whether webshell detection in Basic Web Protection is enabled.\n"
}
},
"type": "object",
"language": {
"nodejs": {
"requiredOutputs": [
"basicWebProtection",
"blacklist",
"ccProtection",
"crawlerEngine",
"crawlerOther",
"crawlerScanner",
"crawlerScript",
"dataMasking",
"falseAlarmMasking",
"generalCheck",
"preciseProtection",
"webTamperProtection",
"webshell"
]
}
}
},
"flexibleengine:index/WafPolicyTimeouts:WafPolicyTimeouts": {
"properties": {
"create": {
"type": "string"
},
"delete": {
"type": "string"
}
},
"type": "object"
},
"flexibleengine:index/WafRulePreciseProtectionCondition:WafRulePreciseProtectionCondition": {
"properties": {
"content": {
"type": "string",
"description": "Specifies the content matching the condition.\n"
},
"field": {
"type": "string",
"description": "Specifies the matched field. The value can be *path*, *user-agent*, *ip*,\n*params*, *cookie*, *referer*, and *header*.\n"
},
"logic": {
"type": "string",
"description": "Specifies the logic relationship. The value can be *contain*, *not_contain*,\n*equal*, *not_equal*, *prefix*, *not_prefix*, *suffix*, and *not_suffix*.\nIf `field` is set to *ip*, `logic` can only be *equal* or *not_equal*.\n"
},
"subfield": {
"type": "string",
"description": "Specifies the matched subfield.\n- If `field` is set to *cookie*, subfield indicates cookie name.\n- If `field` is set to *params*, subfield indicates param name.\n- If `field` is set to *header*, subfield indicates an option in the header.\n"
}
},
"type": "object",
"required": [
"content",
"field",
"logic"
]
},
"flexibleengine:index/getApigEnvironmentsEnvironment:getApigEnvironmentsEnvironment": {
"properties": {
"createTime": {
"type": "string",
"description": "Time when the APIG environment was created, in RFC-3339 format.\n"
},
"description": {
"type": "string",
"description": "The description about the API environment.\n"
},
"id": {
"type": "string",
"description": "ID of the APIG environment.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API environment. The API environment name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits and underscores (_) are allowed.\n"
}
},
"type": "object",
"required": [
"createTime",
"description",
"id",
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getApigGroupsGroup:getApigGroupsGroup": {
"properties": {
"createdAt": {
"type": "string",
"description": "The creation time of the API group.\n"
},
"description": {
"type": "string",
"description": "The description of the API group.\n"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetApigGroupsGroupEnvironment:getApigGroupsGroupEnvironment"
},
"description": "The array of one or more environments of the API group.\nThe environment structure is documented below.\n"
},
"id": {
"type": "string",
"description": "The variable ID.\n"
},
"isDefault": {
"type": "number",
"description": "Indicates whether the API group is the default group.\n"
},
"name": {
"type": "string",
"description": "Specifies the API group name used to query.\n"
},
"onSellStatus": {
"type": "number",
"description": "Whether it has been listed on the cloud store.\nThe valid values are as follows:\n+ **1**: Listed.\n+ **2**: Not listed.\n+ **3**: Under review.\n"
},
"slDomain": {
"type": "string",
"description": "The subdomain name assigned by the system by default.\n"
},
"slDomains": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of subdomain names assigned by the system by default.\n"
},
"status": {
"type": "number",
"description": "The current status of the API group.\nThe valid values are as follows:\n+ **1**: Normal.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the API group.\n"
},
"urlDomains": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetApigGroupsGroupUrlDomain:getApigGroupsGroupUrlDomain"
},
"description": "List of independent domains bound on the API group.\nThe url_domains structure is documented below.\n"
}
},
"type": "object",
"required": [
"createdAt",
"description",
"environments",
"id",
"isDefault",
"name",
"onSellStatus",
"slDomain",
"slDomains",
"status",
"updatedAt",
"urlDomains"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getApigGroupsGroupEnvironment:getApigGroupsGroupEnvironment": {
"properties": {
"environmentId": {
"type": "string",
"description": "The ID of the environment to which the variables belong.\n"
},
"variables": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetApigGroupsGroupEnvironmentVariable:getApigGroupsGroupEnvironmentVariable"
},
"description": "The array of one or more environment variables. \nThe variable structure is documented below.\n"
}
},
"type": "object",
"required": [
"environmentId",
"variables"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getApigGroupsGroupEnvironmentVariable:getApigGroupsGroupEnvironmentVariable": {
"properties": {
"id": {
"type": "string",
"description": "The variable ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the API group name used to query.\n"
},
"value": {
"type": "string",
"description": "The variable value.\n"
}
},
"type": "object",
"required": [
"id",
"name",
"value"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getApigGroupsGroupUrlDomain:getApigGroupsGroupUrlDomain": {
"properties": {
"cnameStatus": {
"type": "number",
"description": "CNAME resolution status of the domain name.\nThe valid values are as follows:\n+ **1**: Not resolved.\n+ **2**: Resolving.\n+ **3**: Resolved.\n+ **4**: Resolution failed.\n"
},
"id": {
"type": "string",
"description": "The variable ID.\n"
},
"isHasTrustedRootCa": {
"type": "boolean",
"description": "Whether a trusted root certificate (CA) exists. The value is true\nif trusted_root_ca exists in the bound certificate. The default is **false**.\n"
},
"minSslVersion": {
"type": "string",
"description": "Minimum SSL version. The default is **TLSv1.1**.\nThe valid values are as follows:\n+ **TLSv1.1**\n+ **TLSv1.2**\n"
},
"name": {
"type": "string",
"description": "Specifies the API group name used to query.\n"
},
"sslId": {
"type": "string",
"description": "The SSL certificate ID.\n"
},
"sslName": {
"type": "string",
"description": "The SSL certificate name.\n"
},
"verifiedClientCertificateEnabled": {
"type": "boolean",
"description": "Whether to enable client certificate verification.\nThis parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists,\nand disabled if trusted_root_ca does not exist. The default is **false**.\n"
}
},
"type": "object",
"required": [
"cnameStatus",
"id",
"isHasTrustedRootCa",
"minSslVersion",
"name",
"sslId",
"sslName",
"verifiedClientCertificateEnabled"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsConfigurationsConfiguration:getAsConfigurationsConfiguration": {
"properties": {
"instanceConfigs": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetAsConfigurationsConfigurationInstanceConfig:getAsConfigurationsConfigurationInstanceConfig"
},
"description": "The list of information about instance configurations.\nThe instance_config structure is documented below.\n"
},
"scalingConfigurationName": {
"type": "string",
"description": "The AS configuration name.\n"
},
"status": {
"type": "string",
"description": "The AS configuration status, the value can be **Bound** or **Unbound**.\n"
}
},
"type": "object",
"required": [
"instanceConfigs",
"scalingConfigurationName",
"status"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsConfigurationsConfigurationInstanceConfig:getAsConfigurationsConfigurationInstanceConfig": {
"properties": {
"chargingMode": {
"type": "string",
"description": "The bandwidth billing mode, the value can be **traffic** or **bandwidth**.\n"
},
"disks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetAsConfigurationsConfigurationInstanceConfigDisk:getAsConfigurationsConfigurationInstanceConfigDisk"
},
"description": "The list of disk group information. The disk structure is documented below.\n"
},
"ecsGroupId": {
"type": "string",
"description": "The ECS group ID.\n"
},
"flavor": {
"type": "string",
"description": "The ECS flavor name.\n"
},
"flavorPriorityPolicy": {
"type": "string",
"description": "The priority policy used when there are multiple flavors\nand instances to be created using an AS configuration. The value can be `PICK_FIRST` and `COST_FIRST`.\n"
},
"image": {
"type": "string",
"description": "The ECS image ID.\n"
},
"instanceId": {
"type": "string",
"description": "The ECS instance ID when using its specification as the template to create AS configurations.\n"
},
"keyName": {
"type": "string",
"description": "The name of the SSH key pair used to log in to the instance.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to make available from within the instance.\n"
},
"personalities": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetAsConfigurationsConfigurationInstanceConfigPersonality:getAsConfigurationsConfigurationInstanceConfigPersonality"
},
"description": "The list of information about the injected file.\nThe personality structure is documented below.\n"
},
"publicIps": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetAsConfigurationsConfigurationInstanceConfigPublicIp:getAsConfigurationsConfigurationInstanceConfigPublicIp"
},
"description": "The EIP list of the ECS instance.\nThe public_ip structure is documented below.\n"
},
"securityGroupIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more security group IDs.\n"
},
"userData": {
"type": "string",
"description": "The user data to provide when launching the instance.\n"
}
},
"type": "object",
"required": [
"chargingMode",
"disks",
"ecsGroupId",
"flavor",
"flavorPriorityPolicy",
"image",
"instanceId",
"keyName",
"metadata",
"personalities",
"publicIps",
"securityGroupIds",
"userData"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsConfigurationsConfigurationInstanceConfigDisk:getAsConfigurationsConfigurationInstanceConfigDisk": {
"properties": {
"diskType": {
"type": "string",
"description": "The disk type.\n"
},
"kmsId": {
"type": "string",
"description": "The encryption KMS ID of the **DATA** disk.\n"
},
"size": {
"type": "number",
"description": "The bandwidth (Mbit/s).\n"
},
"volumeType": {
"type": "string",
"description": "The volume type.\n"
}
},
"type": "object",
"required": [
"diskType",
"kmsId",
"size",
"volumeType"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsConfigurationsConfigurationInstanceConfigPersonality:getAsConfigurationsConfigurationInstanceConfigPersonality": {
"properties": {
"content": {
"type": "string",
"description": "The content of the injected file.\n"
},
"path": {
"type": "string",
"description": "The path of the injected file.\n"
}
},
"type": "object",
"required": [
"content",
"path"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsConfigurationsConfigurationInstanceConfigPublicIp:getAsConfigurationsConfigurationInstanceConfigPublicIp": {
"properties": {
"eips": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetAsConfigurationsConfigurationInstanceConfigPublicIpEip:getAsConfigurationsConfigurationInstanceConfigPublicIpEip"
},
"description": "The list of EIP configuration that will be automatically assigned to the instance.\nThe eip object structure is documented below.\n"
}
},
"type": "object",
"required": [
"eips"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsConfigurationsConfigurationInstanceConfigPublicIpEip:getAsConfigurationsConfigurationInstanceConfigPublicIpEip": {
"properties": {
"bandwidths": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetAsConfigurationsConfigurationInstanceConfigPublicIpEipBandwidth:getAsConfigurationsConfigurationInstanceConfigPublicIpEipBandwidth"
},
"description": "The list of bandwidth information.\nThe bandwidth object structure is documented below.\n"
},
"ipType": {
"type": "string",
"description": "The EIP type.\n"
}
},
"type": "object",
"required": [
"bandwidths",
"ipType"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsConfigurationsConfigurationInstanceConfigPublicIpEipBandwidth:getAsConfigurationsConfigurationInstanceConfigPublicIpEipBandwidth": {
"properties": {
"chargingMode": {
"type": "string",
"description": "The bandwidth billing mode, the value can be **traffic** or **bandwidth**.\n"
},
"shareType": {
"type": "string",
"description": "The bandwidth sharing type.\n"
},
"size": {
"type": "number",
"description": "The bandwidth (Mbit/s).\n"
}
},
"type": "object",
"required": [
"chargingMode",
"shareType",
"size"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsGroupsGroup:getAsGroupsGroup": {
"properties": {
"activityType": {
"type": "string",
"description": "The type of the AS action.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The AZ information.\n"
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration, in seconds..\n"
},
"createdAt": {
"type": "string",
"description": "The time when an AS group was created. The time format complies with UTC.\n"
},
"currentInstanceNumber": {
"type": "number",
"description": "The number of current instances in the AS group.\n"
},
"deletePublicip": {
"type": "boolean",
"description": "Whether to delete the EIP bound to the ECS when deleting the ECS.\n"
},
"deleteVolume": {
"type": "boolean",
"description": "Whether to delete the data disks attached to the ECS when deleting the ECS.\n"
},
"description": {
"type": "string",
"description": "The description of the AS group.\n"
},
"desireInstanceNumber": {
"type": "number",
"description": "The expected number of instances in the AS group.\n"
},
"detail": {
"type": "string",
"description": "Details about the AS group. If a scaling action fails, this parameter is used to record errors.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id of the AS group.\nChanging this will create a new resource.\n"
},
"healthPeriodicAuditGracePeriod": {
"type": "number",
"description": "The grace period for health check.\n"
},
"healthPeriodicAuditMethod": {
"type": "string",
"description": "The health check method.\n"
},
"healthPeriodicAuditTime": {
"type": "number",
"description": "The health check interval.\n"
},
"iamAgencyName": {
"type": "string",
"description": "The agency name.\n"
},
"instanceTerminatePolicy": {
"type": "string",
"description": "The instance removal policy.\n"
},
"instances": {
"type": "array",
"items": {
"type": "string"
},
"description": "The scaling group instances ids.\n"
},
"isScaling": {
"type": "boolean",
"description": "The scaling flag of the AS group.\n"
},
"lbaasListeners": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetAsGroupsGroupLbaasListener:getAsGroupsGroupLbaasListener"
},
"description": "The enhanced load balancers.\nThe lbaas_listeners structure is documented below.\n"
},
"maxInstanceNumber": {
"type": "number",
"description": "The maximum number of instances in the AS group.\n"
},
"minInstanceNumber": {
"type": "number",
"description": "The minimum number of instances in the AS group.\n"
},
"multiAzScalingPolicy": {
"type": "string",
"description": "The priority policy used to select target AZs when adjusting the number of\ninstances in an AS group.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetAsGroupsGroupNetwork:getAsGroupsGroupNetwork"
},
"description": "The network information.\nThe networks structure is documented below.\n"
},
"scalingConfigurationId": {
"type": "string",
"description": "Specifies the AS configuration ID, which can be obtained using\nthe API for listing AS configurations.\n"
},
"scalingConfigurationName": {
"type": "string",
"description": "The AS configuration name.\n"
},
"scalingGroupId": {
"type": "string",
"description": "The AS group ID.\n"
},
"scalingGroupName": {
"type": "string",
"description": "The name of the AS group.\n"
},
"securityGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetAsGroupsGroupSecurityGroup:getAsGroupsGroupSecurityGroup"
},
"description": "The security group information.\nThe security_groups structure is documented below.\n"
},
"status": {
"type": "string",
"description": "Specifies the AS group status. The options are as follows:\n- **INSERVICE**: indicates that the AS group is functional.\n- **PAUSED**: indicates that the AS group is paused.\n- **ERROR**: indicates that the AS group malfunctions.\n- **DELETING**: indicates that the AS group is being deleted.\n- **FREEZED**: indicates that the AS group has been frozen.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The tag of AS group.\n"
},
"vpcId": {
"type": "string",
"description": "The ID of the VPC to which the AS group belongs.\n"
}
},
"type": "object",
"required": [
"activityType",
"availabilityZones",
"coolDownTime",
"createdAt",
"currentInstanceNumber",
"deletePublicip",
"deleteVolume",
"description",
"desireInstanceNumber",
"detail",
"enterpriseProjectId",
"healthPeriodicAuditGracePeriod",
"healthPeriodicAuditMethod",
"healthPeriodicAuditTime",
"iamAgencyName",
"instanceTerminatePolicy",
"instances",
"isScaling",
"lbaasListeners",
"maxInstanceNumber",
"minInstanceNumber",
"multiAzScalingPolicy",
"networks",
"scalingConfigurationId",
"scalingConfigurationName",
"scalingGroupId",
"scalingGroupName",
"securityGroups",
"status",
"tags",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsGroupsGroupLbaasListener:getAsGroupsGroupLbaasListener": {
"properties": {
"poolId": {
"type": "string",
"description": "The backend ECS group ID.\n"
},
"protocolPort": {
"type": "number",
"description": "The backend protocol ID, which is the port on which a backend ECS listens for traffic.\n"
},
"weight": {
"type": "number",
"description": "The weight, which determines the portion of requests a backend ECS processes\ncompared to other backend ECSs added to the same listener.\n"
}
},
"type": "object",
"required": [
"poolId",
"protocolPort",
"weight"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsGroupsGroupNetwork:getAsGroupsGroupNetwork": {
"properties": {
"id": {
"type": "string",
"description": "The ID of the security group.\n"
},
"ipv6BandwidthId": {
"type": "string",
"description": "The ID of the shared bandwidth of an IPv6 address.\n"
},
"ipv6Enable": {
"type": "boolean",
"description": "Specifies whether to support IPv6 addresses.\n"
},
"sourceDestCheck": {
"type": "boolean",
"description": "Whether processesing only traffic that is destined specifically for it.\n"
}
},
"type": "object",
"required": [
"id",
"ipv6BandwidthId",
"ipv6Enable",
"sourceDestCheck"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getAsGroupsGroupSecurityGroup:getAsGroupsGroupSecurityGroup": {
"properties": {
"id": {
"type": "string",
"description": "The ID of the security group.\n"
}
},
"type": "object",
"required": [
"id"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCbrBackupChildren:getCbrBackupChildren": {
"properties": {
"checkpointId": {
"type": "string",
"description": "The restore point ID of the sub-backup resource.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the sub-backup.\n"
},
"description": {
"type": "string",
"description": "The sub-backup description.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "The enterprise project to which the backup sub-backup resource belongs.\n"
},
"expiredAt": {
"type": "string",
"description": "The expiration time of the sub-backup.\n"
},
"extendInfos": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCbrBackupChildrenExtendInfo:getCbrBackupChildrenExtendInfo"
},
"description": "The extended information. The object structure is documented below.\n"
},
"id": {
"type": "string",
"description": "Specifies the backup ID.\n"
},
"name": {
"type": "string",
"description": "The sub-backup name.\n"
},
"replicationRecords": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCbrBackupChildrenReplicationRecord:getCbrBackupChildrenReplicationRecord"
},
"description": "The replication records. The object structure is\ndocumented above.\n"
},
"resourceAz": {
"type": "string",
"description": "The availability zone where the backup sub-backup resource is located.\n"
},
"resourceId": {
"type": "string",
"description": "The sub-backup resource ID.\n"
},
"resourceName": {
"type": "string",
"description": "The sub-backup resource name.\n"
},
"resourceSize": {
"type": "number",
"description": "The sub-backup resource size, in GB.\n"
},
"resourceType": {
"type": "string",
"description": "The sub-backup resource type.\n"
},
"status": {
"type": "string",
"description": "The sub-backup status.\n"
},
"type": {
"type": "string",
"description": "The sub-backup type.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the sub-backup.\n"
},
"vaultId": {
"type": "string",
"description": "The vault to which the backup resource belongs.\n"
}
},
"type": "object",
"required": [
"checkpointId",
"createdAt",
"description",
"enterpriseProjectId",
"expiredAt",
"extendInfos",
"id",
"name",
"replicationRecords",
"resourceAz",
"resourceId",
"resourceName",
"resourceSize",
"resourceType",
"status",
"type",
"updatedAt",
"vaultId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCbrBackupChildrenExtendInfo:getCbrBackupChildrenExtendInfo": {
"properties": {
"autoTrigger": {
"type": "boolean",
"description": "Whether the backup is automatically generated.\n"
},
"bootable": {
"type": "boolean",
"description": "Whether the backup is a system disk backup.\n"
},
"containSystemDisk": {
"type": "boolean",
"description": "Whether the VM backup data contains system disk data.\n"
},
"encrypted": {
"type": "boolean",
"description": "Whether the backup is encrypted.\n"
},
"incremental": {
"type": "boolean",
"description": "Whether the backup is an incremental backup.\n"
},
"isSystemDisk": {
"type": "boolean",
"description": "Whether the disk is a system disk.\n"
},
"osRegistryImages": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID list of images created using backups.\n"
},
"snapshotId": {
"type": "string",
"description": "Snapshot ID of the disk backup.\n"
},
"supportLld": {
"type": "boolean",
"description": "Whether to allow lazyloading for fast restoration.\n"
},
"supportedRestoreMode": {
"type": "string",
"description": "The restoration mode.\n"
}
},
"type": "object",
"required": [
"autoTrigger",
"bootable",
"containSystemDisk",
"encrypted",
"incremental",
"isSystemDisk",
"osRegistryImages",
"snapshotId",
"supportLld",
"supportedRestoreMode"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCbrBackupChildrenReplicationRecord:getCbrBackupChildrenReplicationRecord": {
"properties": {
"createdAt": {
"type": "string",
"description": "The creation time of the sub-backup.\n"
},
"destinationBackupId": {
"type": "string",
"description": "The ID of the destination backup used for replication.\n"
},
"destinationCheckpointId": {
"type": "string",
"description": "The record ID of the destination backup used for replication.\n"
},
"destinationProjectId": {
"type": "string",
"description": "The ID of the replication destination project.\n"
},
"destinationRegion": {
"type": "string",
"description": "The replication destination region.\n"
},
"destinationVaultId": {
"type": "string",
"description": "The destination vault ID.\n"
},
"extraInfos": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCbrBackupChildrenReplicationRecordExtraInfo:getCbrBackupChildrenReplicationRecordExtraInfo"
},
"description": "The additional information of the replication.\nThe object structure is documented below.\n"
},
"id": {
"type": "string",
"description": "Specifies the backup ID.\n"
},
"sourceBackupId": {
"type": "string",
"description": "The ID of the source backup used for replication.\n"
},
"sourceCheckpointId": {
"type": "string",
"description": "The ID of the source backup record used for replication.\n"
},
"sourceProjectId": {
"type": "string",
"description": "The ID of the replication source project.\n"
},
"sourceRegion": {
"type": "string",
"description": "The replication source region.\n"
},
"status": {
"type": "string",
"description": "The sub-backup status.\n"
},
"vaultId": {
"type": "string",
"description": "The vault to which the backup resource belongs.\n"
}
},
"type": "object",
"required": [
"createdAt",
"destinationBackupId",
"destinationCheckpointId",
"destinationProjectId",
"destinationRegion",
"destinationVaultId",
"extraInfos",
"id",
"sourceBackupId",
"sourceCheckpointId",
"sourceProjectId",
"sourceRegion",
"status",
"vaultId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCbrBackupChildrenReplicationRecordExtraInfo:getCbrBackupChildrenReplicationRecordExtraInfo": {
"properties": {
"autoTrigger": {
"type": "boolean",
"description": "Whether the backup is automatically generated.\n"
},
"destinationVaultId": {
"type": "string",
"description": "The destination vault ID.\n"
},
"failCode": {
"type": "string",
"description": "The error code.\n"
},
"failReason": {
"type": "string",
"description": "The error cause.\n"
},
"progress": {
"type": "number",
"description": "The replication progress.\n"
}
},
"type": "object",
"required": [
"autoTrigger",
"destinationVaultId",
"failCode",
"failReason",
"progress"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCbrBackupExtendInfo:getCbrBackupExtendInfo": {
"properties": {
"autoTrigger": {
"type": "boolean",
"description": "Whether the backup is automatically generated.\n"
},
"bootable": {
"type": "boolean",
"description": "Whether the backup is a system disk backup.\n"
},
"containSystemDisk": {
"type": "boolean",
"description": "Whether the VM backup data contains system disk data.\n"
},
"encrypted": {
"type": "boolean",
"description": "Whether the backup is encrypted.\n"
},
"incremental": {
"type": "boolean",
"description": "Whether the backup is an incremental backup.\n"
},
"isSystemDisk": {
"type": "boolean",
"description": "Whether the disk is a system disk.\n"
},
"osRegistryImages": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID list of images created using backups.\n"
},
"snapshotId": {
"type": "string",
"description": "Snapshot ID of the disk backup.\n"
},
"supportLld": {
"type": "boolean",
"description": "Whether to allow lazyloading for fast restoration.\n"
},
"supportedRestoreMode": {
"type": "string",
"description": "The restoration mode.\n"
}
},
"type": "object",
"required": [
"autoTrigger",
"bootable",
"containSystemDisk",
"encrypted",
"incremental",
"isSystemDisk",
"osRegistryImages",
"snapshotId",
"supportLld",
"supportedRestoreMode"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCbrBackupReplicationRecord:getCbrBackupReplicationRecord": {
"properties": {
"createdAt": {
"type": "string",
"description": "The creation time of the sub-backup.\n"
},
"destinationBackupId": {
"type": "string",
"description": "The ID of the destination backup used for replication.\n"
},
"destinationCheckpointId": {
"type": "string",
"description": "The record ID of the destination backup used for replication.\n"
},
"destinationProjectId": {
"type": "string",
"description": "The ID of the replication destination project.\n"
},
"destinationRegion": {
"type": "string",
"description": "The replication destination region.\n"
},
"destinationVaultId": {
"type": "string",
"description": "The destination vault ID.\n"
},
"extraInfos": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCbrBackupReplicationRecordExtraInfo:getCbrBackupReplicationRecordExtraInfo"
},
"description": "The additional information of the replication.\nThe object structure is documented below.\n"
},
"id": {
"type": "string",
"description": "Specifies the backup ID.\n"
},
"sourceBackupId": {
"type": "string",
"description": "The ID of the source backup used for replication.\n"
},
"sourceCheckpointId": {
"type": "string",
"description": "The ID of the source backup record used for replication.\n"
},
"sourceProjectId": {
"type": "string",
"description": "The ID of the replication source project.\n"
},
"sourceRegion": {
"type": "string",
"description": "The replication source region.\n"
},
"status": {
"type": "string",
"description": "The sub-backup status.\n"
},
"vaultId": {
"type": "string",
"description": "The vault to which the backup resource belongs.\n"
}
},
"type": "object",
"required": [
"createdAt",
"destinationBackupId",
"destinationCheckpointId",
"destinationProjectId",
"destinationRegion",
"destinationVaultId",
"extraInfos",
"id",
"sourceBackupId",
"sourceCheckpointId",
"sourceProjectId",
"sourceRegion",
"status",
"vaultId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCbrBackupReplicationRecordExtraInfo:getCbrBackupReplicationRecordExtraInfo": {
"properties": {
"autoTrigger": {
"type": "boolean",
"description": "Whether the backup is automatically generated.\n"
},
"destinationVaultId": {
"type": "string",
"description": "The destination vault ID.\n"
},
"failCode": {
"type": "string",
"description": "The error code.\n"
},
"failReason": {
"type": "string",
"description": "The error cause.\n"
},
"progress": {
"type": "number",
"description": "The replication progress.\n"
}
},
"type": "object",
"required": [
"autoTrigger",
"destinationVaultId",
"failCode",
"failReason",
"progress"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCbrVaultsVault:getCbrVaultsVault": {
"properties": {
"allocated": {
"type": "number",
"description": "The allocated capacity of the vault, in GB.\n"
},
"autoExpandEnabled": {
"type": "boolean",
"description": "Specifies whether to enable automatic expansion of the backup protection\ntype vault. Defaults to **false**.\n"
},
"consistentLevel": {
"type": "string",
"description": "Specifies the consistent level (specification) of the vault.\nThe valid values are as follows:\n+ **[crash_consistent](https://docs.prod-cloud-ocb.orange-business.com/usermanual/cbr/cbr_03_0109.html)**\n+ **[app_consistent](https://docs.prod-cloud-ocb.orange-business.com/usermanual/cbr/cbr_03_0109.html)**\n\nOnly server type vaults support application consistent.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the ID of the enterprise project to which the vault belongs.\n"
},
"id": {
"type": "string",
"description": "The vault ID in UUID format.\n"
},
"name": {
"type": "string",
"description": "Specifies the vault name. This parameter can contain a maximum of 64\ncharacters, which may consist of letters, digits, underscores(_) and hyphens (-).\n"
},
"policyId": {
"type": "string",
"description": "Specifies the ID of the policy associated with the vault.\nThe `policy_id` cannot be used with the vault of replicate protection type.\n"
},
"protectionType": {
"type": "string",
"description": "Specifies the protection type of the vault.\nThe valid values are **backup** and **replication**. Vaults of type **disk** don't support **replication**.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCbrVaultsVaultResource:getCbrVaultsVaultResource"
},
"description": "The array of one or more resources to attach to the vault.\nThe object structure is documented below.\n"
},
"size": {
"type": "number",
"description": "Specifies the vault sapacity, in GB. The valid value range is `1` to `10,485,760`.\n"
},
"specCode": {
"type": "string",
"description": "The specification code.\n"
},
"status": {
"type": "string",
"description": "Specifies the vault status, including **available**, **lock**, **frozen** and **error**.\n"
},
"storage": {
"type": "string",
"description": "The name of the bucket for the vault.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the vault.\n"
},
"type": {
"type": "string",
"description": "Specifies the object type of the vault. The vaild values are as follows:\n+ **server** (Cloud Servers)\n+ **disk** (EVS Disks)\n+ **turbo** (SFS Turbo file systems)\n"
},
"used": {
"type": "number",
"description": "The used capacity, in GB.\n"
}
},
"type": "object",
"required": [
"allocated",
"autoExpandEnabled",
"consistentLevel",
"enterpriseProjectId",
"id",
"name",
"policyId",
"protectionType",
"resources",
"size",
"specCode",
"status",
"storage",
"tags",
"type",
"used"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCbrVaultsVaultResource:getCbrVaultsVaultResource": {
"properties": {
"excludes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The array of disk IDs which will be excluded in the backup.\n"
},
"includes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The array of disk or SFS file system IDs which will be included in the backup.\n"
},
"serverId": {
"type": "string",
"description": "The ID of the ECS instance to be backed up.\n"
}
},
"type": "object",
"required": [
"excludes",
"includes",
"serverId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceAddonTemplateSupportVersion:getCceAddonTemplateSupportVersion": {
"properties": {
"bareMetals": {
"type": "array",
"items": {
"type": "string"
},
"description": "The cluster (Bare Metal) version that the add-on template supported.\n"
},
"virtualMachines": {
"type": "array",
"items": {
"type": "string"
},
"description": "The cluster (Virtual Machine) version that the add-on template supported.\n"
}
},
"type": "object",
"required": [
"bareMetals",
"virtualMachines"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceClusterV3Master:getCceClusterV3Master": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "The availability zone (AZ) of the master node.\n"
}
},
"type": "object",
"required": [
"availabilityZone"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceClustersCluster:getCceClustersCluster": {
"properties": {
"authenticationMode": {
"type": "string",
"description": "The authentication mode of the cluster, possible values are x509 and rbac. Defaults to **rbac**.\n"
},
"billingMode": {
"type": "number",
"description": "The charging mode of the cluster.\n"
},
"certificateClusters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCceClustersClusterCertificateCluster:getCceClustersClusterCertificateCluster"
},
"description": "The certificate clusters.\nThe certificate_clusters object structure is documented below.\n"
},
"certificateUsers": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCceClustersClusterCertificateUser:getCceClustersClusterCertificateUser"
},
"description": "The certificate users\nThe certificate_users object structure is documented below.\n"
},
"clusterType": {
"type": "string",
"description": "Specifies the type of the cluster. Possible values: **VirtualMachine**, **BareMetal**.\n"
},
"clusterVersion": {
"type": "string",
"description": "The version of the cluster.\n"
},
"containerNetworkCidr": {
"type": "string",
"description": "The container network segment.\n"
},
"containerNetworkType": {
"type": "string",
"description": "The container network type: **overlay_l2** , **underlay_ipvlan**, **vpc-router** or **eni**.\n"
},
"description": {
"type": "string",
"description": "The description of the cluster.\n"
},
"endpoints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCceClustersClusterEndpoint:getCceClustersClusterEndpoint"
},
"description": "The access addresses of kube-apiserver in the cluster.\nThe endpoints object structure is documented below.\n"
},
"eniSubnetCidr": {
"type": "string",
"description": "The ENI network segment.\n"
},
"eniSubnetId": {
"type": "string",
"description": "The ENI subnet ID.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project ID of the cluster.\n"
},
"flavorId": {
"type": "string",
"description": "The specification of the cluster.\n"
},
"id": {
"type": "string",
"description": "The ID of the cluster.\n"
},
"kubeConfigRaw": {
"type": "string",
"description": "The raw Kubernetes config to be used by kubectl and other compatible tools.\n"
},
"masters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCceClustersClusterMaster:getCceClustersClusterMaster"
},
"description": "The advanced configuration of master nodes.The masters object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the cluster.\n"
},
"securityGroupId": {
"type": "string",
"description": "The security group ID of the cluster.\n"
},
"serviceNetworkCidr": {
"type": "string",
"description": "The service network segment.\n"
},
"status": {
"type": "string",
"description": "Specifies the status of the cluster.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the VPC Subnet used to create the node.\n"
},
"vpcId": {
"type": "string",
"description": "Specifies the VPC ID to which the cluster belongs.\n"
}
},
"type": "object",
"required": [
"authenticationMode",
"billingMode",
"certificateClusters",
"certificateUsers",
"clusterType",
"clusterVersion",
"containerNetworkCidr",
"containerNetworkType",
"description",
"endpoints",
"eniSubnetCidr",
"eniSubnetId",
"enterpriseProjectId",
"flavorId",
"id",
"kubeConfigRaw",
"masters",
"name",
"securityGroupId",
"serviceNetworkCidr",
"status",
"subnetId",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceClustersClusterCertificateCluster:getCceClustersClusterCertificateCluster": {
"properties": {
"certificateAuthorityData": {
"type": "string",
"description": "The certificate data.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the cluster.\n"
},
"server": {
"type": "string",
"description": "The server IP address.\n"
}
},
"type": "object",
"required": [
"certificateAuthorityData",
"name",
"server"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceClustersClusterCertificateUser:getCceClustersClusterCertificateUser": {
"properties": {
"clientCertificateData": {
"type": "string",
"description": "The client certificate data.\n"
},
"clientKeyData": {
"type": "string",
"description": "The client key data.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the cluster.\n"
}
},
"type": "object",
"required": [
"clientCertificateData",
"clientKeyData",
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceClustersClusterEndpoint:getCceClustersClusterEndpoint": {
"properties": {
"type": {
"type": "string",
"description": "The type of the cluster access address.\n+ **Internal**: The user's subnet access address.\n+ **External**: The public network access address.\n"
},
"url": {
"type": "string",
"description": "The URL of the cluster access address.\n"
}
},
"type": "object",
"required": [
"type",
"url"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceClustersClusterMaster:getCceClustersClusterMaster": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "The availability zone (AZ) of the master node.\n"
}
},
"type": "object",
"required": [
"availabilityZone"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceNodeV3DataVolume:getCceNodeV3DataVolume": {
"properties": {
"diskSize": {
"type": "number",
"description": "Disk size in GB.\n"
},
"volumeType": {
"type": "string",
"description": "Disk type.\n"
}
},
"type": "object",
"required": [
"diskSize",
"volumeType"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceNodesNode:getCceNodesNode": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "The available partitions where the node is located.\n"
},
"billingMode": {
"type": "number",
"description": "The node's billing mode: The value is 0 (on demand).\n"
},
"dataVolumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCceNodesNodeDataVolume:getCceNodesNodeDataVolume"
},
"description": "The data related configuration. The volume object structure is documented below.\n"
},
"ecsGroupId": {
"type": "string",
"description": "The ID of ECS group to which the node belongs.\n"
},
"flavorId": {
"type": "string",
"description": "The flavor ID to be used.\n"
},
"id": {
"type": "string",
"description": "The ID of the node.\n"
},
"keyPair": {
"type": "string",
"description": "The key pair name when logging in to select the key pair mode.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the node.\n"
},
"os": {
"type": "string",
"description": "The operating system of the node.\n"
},
"privateIp": {
"type": "string",
"description": "The private IP of the node.\n"
},
"publicIp": {
"type": "string",
"description": "The elastic IP parameters of the node.\n"
},
"rootVolumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetCceNodesNodeRootVolume:getCceNodesNodeRootVolume"
},
"description": "The system disk related configuration. The volume object structure is documented below.\n"
},
"serverId": {
"type": "string",
"description": "The node's virtual machine ID in ECS.\n"
},
"status": {
"type": "string",
"description": "Specifies the status of the node.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the subnet to which the NIC belongs.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The tags of a VM node, key/value pair format.\n"
}
},
"type": "object",
"required": [
"availabilityZone",
"billingMode",
"dataVolumes",
"ecsGroupId",
"flavorId",
"id",
"keyPair",
"name",
"os",
"privateIp",
"publicIp",
"rootVolumes",
"serverId",
"status",
"subnetId",
"tags"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceNodesNodeDataVolume:getCceNodesNodeDataVolume": {
"properties": {
"extendParams": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Disk expansion parameters.\n"
},
"size": {
"type": "number",
"description": "Disk size in GB.\n"
},
"volumetype": {
"type": "string",
"description": "Disk type.\n"
}
},
"type": "object",
"required": [
"extendParams",
"size",
"volumetype"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCceNodesNodeRootVolume:getCceNodesNodeRootVolume": {
"properties": {
"extendParams": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Disk expansion parameters.\n"
},
"size": {
"type": "number",
"description": "Disk size in GB.\n"
},
"volumetype": {
"type": "string",
"description": "Disk type.\n"
}
},
"type": "object",
"required": [
"extendParams",
"size",
"volumetype"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeBmsNicV2FixedIp:getComputeBmsNicV2FixedIp": {
"properties": {
"ipAddress": {
"type": "string",
"description": "Specifies the NIC private IP address.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the subnet (subnet_id) corresponding to the private IP address of the NIC.\n"
}
},
"type": "object",
"required": [
"ipAddress",
"subnetId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeBmsServerV2Network:getComputeBmsServerV2Network": {
"properties": {
"fixedIpV4": {
"type": "string"
},
"fixedIpV6": {
"type": "string"
},
"mac": {
"type": "string"
},
"name": {
"type": "string",
"description": "The name of BMS.\n"
},
"port": {
"type": "string"
},
"uuid": {
"type": "string"
}
},
"type": "object",
"required": [
"fixedIpV4",
"fixedIpV6",
"mac",
"name",
"port",
"uuid"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeBmsServerV2SecurityGroup:getComputeBmsServerV2SecurityGroup": {
"properties": {
"name": {
"type": "string",
"description": "The name of BMS.\n"
}
},
"type": "object",
"required": [
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeInstanceV2BlockDevice:getComputeInstanceV2BlockDevice": {
"properties": {
"bootIndex": {
"type": "number",
"description": "The volume boot index on that attachment.\n"
},
"pciAddress": {
"type": "string",
"description": "The volume pci address on that attachment.\n"
},
"size": {
"type": "number",
"description": "The volume size on that attachment.\n"
},
"type": {
"type": "string",
"description": "The volume type on that attachment.\n"
},
"uuid": {
"type": "string",
"description": "The volume id on that attachment.\n"
}
},
"type": "object",
"required": [
"bootIndex",
"pciAddress",
"size",
"type",
"uuid"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeInstanceV2Network:getComputeInstanceV2Network": {
"properties": {
"fixedIpV4": {
"type": "string",
"description": "Specifies the IPv4 addresses of the server.\n"
},
"fixedIpV6": {
"type": "string",
"description": "The Fixed IPv6 address of the instance on that network.\n"
},
"mac": {
"type": "string",
"description": "The MAC address of the NIC on that network.\n"
},
"port": {
"type": "string",
"description": "The port ID corresponding to the IP address on that network.\n"
},
"uuid": {
"type": "string",
"description": "The volume id on that attachment.\n"
}
},
"type": "object",
"required": [
"fixedIpV4",
"fixedIpV6",
"mac",
"port",
"uuid"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeInstanceV2SchedulerHint:getComputeInstanceV2SchedulerHint": {
"properties": {
"group": {
"type": "string",
"description": "The UUID of a Server Group where the instance will be placed into.\n"
}
},
"type": "object",
"required": [
"group"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeInstancesInstance:getComputeInstancesInstance": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "Specifies the availability zone where the instance is located.\n"
},
"flavorId": {
"type": "string",
"description": "Specifies the flavor ID.\n"
},
"flavorName": {
"type": "string",
"description": "Specifies the flavor name of the instance.\n"
},
"floatingIp": {
"type": "string",
"description": "The EIP address that is associated to the instance.\n"
},
"id": {
"type": "string",
"description": "The instance ID in UUID format.\n"
},
"imageId": {
"type": "string",
"description": "Specifies the image ID of the instance.\n"
},
"imageName": {
"type": "string",
"description": "The image name of the instance.\n"
},
"keyPair": {
"type": "string",
"description": "Specifies the key pair that is used to authenticate the instance.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The metadata of the instance in key/value format.\n"
},
"name": {
"type": "string",
"description": "Specifies the server name, which can be queried with a regular expression.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetComputeInstancesInstanceNetwork:getComputeInstancesInstanceNetwork"
},
"description": "An array of one or more networks to attach to the instance.\nThe network object structure is documented below.\n"
},
"schedulerHints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetComputeInstancesInstanceSchedulerHint:getComputeInstancesInstanceSchedulerHint"
},
"description": "The scheduler with hints on how the instance should be launched.\nThe scheduler_hints object structure is documented below.\n"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more security group names\nto associate with the instance.\n"
},
"status": {
"type": "string",
"description": "Specifies the status of the instance. The valid values are as follows:\n+ **ACTIVE**: The instance is running properly.\n+ **SHUTOFF**: The instance has been properly stopped.\n+ **ERROR**: An error has occurred on the instance.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The tags of the instance in key/value format.\n"
},
"userData": {
"type": "string",
"description": "The user data (information after encoding) configured during instance creation.\n"
},
"volumeAttacheds": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetComputeInstancesInstanceVolumeAttached:getComputeInstancesInstanceVolumeAttached"
},
"description": "An array of one or more disks to attach to the instance.\nThe volume_attached object structure is documented below.\n"
}
},
"type": "object",
"required": [
"availabilityZone",
"flavorId",
"flavorName",
"floatingIp",
"id",
"imageId",
"imageName",
"keyPair",
"metadata",
"name",
"networks",
"schedulerHints",
"securityGroups",
"status",
"tags",
"userData",
"volumeAttacheds"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeInstancesInstanceNetwork:getComputeInstancesInstanceNetwork": {
"properties": {
"fixedIpV4": {
"type": "string",
"description": "Specifies the IPv4 addresses of the server.\n"
},
"fixedIpV6": {
"type": "string",
"description": "The Fixed IPv6 address of the instance on that network.\n"
},
"mac": {
"type": "string",
"description": "The MAC address of the NIC on that network.\n"
},
"port": {
"type": "string",
"description": "The port ID corresponding to the IP address on that network.\n"
},
"uuid": {
"type": "string",
"description": "The network UUID to attach to the server.\n"
}
},
"type": "object",
"required": [
"fixedIpV4",
"fixedIpV6",
"mac",
"port",
"uuid"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeInstancesInstanceSchedulerHint:getComputeInstancesInstanceSchedulerHint": {
"properties": {
"group": {
"type": "string",
"description": "The UUID of a Server Group where the instance will be placed into.\n"
}
},
"type": "object",
"required": [
"group"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeInstancesInstanceVolumeAttached:getComputeInstancesInstanceVolumeAttached": {
"properties": {
"isSysVolume": {
"type": "boolean",
"description": "Whether the volume is the system disk.\n"
},
"volumeId": {
"type": "string",
"description": "The volume id on that attachment.\n"
}
},
"type": "object",
"required": [
"isSysVolume",
"volumeId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getComputeServergroupsServergroup:getComputeServergroupsServergroup": {
"properties": {
"id": {
"type": "string",
"description": "The server group ID in UUID format.\n"
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more instance ID attached to the server group.\n"
},
"name": {
"type": "string",
"description": "Specifies the server group name.\n"
},
"policies": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of policies for the server group.\n"
}
},
"type": "object",
"required": [
"id",
"members",
"name",
"policies"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCsbsBackupPolicyV1Resource:getCsbsBackupPolicyV1Resource": {
"properties": {
"id": {
"type": "string",
"description": "Specifies the ID of backup policy.\n"
},
"name": {
"type": "string",
"description": "Specifies the backup policy name.\n"
},
"type": {
"type": "string",
"description": "Entity object type of the backup object.\n"
}
},
"type": "object",
"required": [
"id",
"name",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCsbsBackupPolicyV1ScheduledOperation:getCsbsBackupPolicyV1ScheduledOperation": {
"properties": {
"description": {
"type": "string",
"description": "Specifies Scheduling period description.\n"
},
"enabled": {
"type": "boolean",
"description": "Specifies whether the scheduling period is enabled.\n"
},
"id": {
"type": "string",
"description": "Specifies the ID of backup policy.\n"
},
"maxBackups": {
"type": "number",
"description": "Specifies maximum number of backups that can be automatically created for a backup object.\n"
},
"name": {
"type": "string",
"description": "Specifies the backup policy name.\n"
},
"operationType": {
"type": "string",
"description": "Specifies Operation type, which can be backup.\n"
},
"permanent": {
"type": "boolean",
"description": "Specifies whether backups are permanently retained.\n"
},
"retentionDurationDays": {
"type": "number",
"description": "Specifies duration of retaining a backup, in days.\n"
},
"triggerId": {
"type": "string",
"description": "Specifies Scheduler ID.\n"
},
"triggerName": {
"type": "string",
"description": "Specifies Scheduler name.\n"
},
"triggerPattern": {
"type": "string",
"description": "Specifies Scheduling policy of the scheduler.\n"
},
"triggerType": {
"type": "string",
"description": "Specifies Scheduler type.\n"
}
},
"type": "object",
"required": [
"description",
"enabled",
"id",
"maxBackups",
"name",
"operationType",
"permanent",
"retentionDurationDays",
"triggerId",
"triggerName",
"triggerPattern",
"triggerType"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCsbsBackupV1VmMetadata:getCsbsBackupV1VmMetadata": {
"properties": {
"cloudServiceType": {
"type": "string",
"description": "Specifies ECS type.\n"
},
"disk": {
"type": "number",
"description": "Shows system disk size corresponding to the ECS specifications.\n"
},
"eip": {
"type": "string",
"description": "Specifies elastic IP address of the ECS.\n"
},
"imageType": {
"type": "string",
"description": "Specifies image type.\n"
},
"name": {
"type": "string",
"description": "Name of backup data.\n"
},
"privateIp": {
"type": "string",
"description": "It specifies internal IP address of the ECS.\n"
},
"ram": {
"type": "number",
"description": "Specifies memory size of the ECS, in MB.\n"
},
"vcpus": {
"type": "number",
"description": "Specifies CPU cores corresponding to the ECS.\n"
}
},
"type": "object",
"required": [
"cloudServiceType",
"disk",
"eip",
"imageType",
"name",
"privateIp",
"ram",
"vcpus"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCsbsBackupV1VolumeBackup:getCsbsBackupV1VolumeBackup": {
"properties": {
"averageSpeed": {
"type": "number",
"description": "Specifies the average speed.\n"
},
"bootable": {
"type": "boolean",
"description": "Specifies whether the disk is bootable.\n"
},
"id": {
"type": "string",
"description": "Specifies the ID of backup.\n"
},
"imageType": {
"type": "string",
"description": "Specifies image type.\n"
},
"incremental": {
"type": "boolean",
"description": "Shows whether incremental backup is used.\n"
},
"name": {
"type": "string",
"description": "Name of backup data.\n"
},
"size": {
"type": "number",
"description": "Specifies accumulated size (MB) of backups.\n"
},
"snapshotId": {
"type": "string",
"description": "ID of snapshot.\n"
},
"sourceVolumeId": {
"type": "string",
"description": "It specifies source volume ID.\n"
},
"sourceVolumeName": {
"type": "string",
"description": "Specifies source volume name.\n"
},
"sourceVolumeSize": {
"type": "number",
"description": "Shows source volume size in GB.\n"
},
"spaceSavingRatio": {
"type": "number",
"description": "Specifies the space saving rate.\n"
},
"status": {
"type": "string",
"description": "Specifies the backup status.\n"
}
},
"type": "object",
"required": [
"averageSpeed",
"bootable",
"id",
"imageType",
"incremental",
"name",
"size",
"snapshotId",
"sourceVolumeId",
"sourceVolumeName",
"sourceVolumeSize",
"spaceSavingRatio",
"status"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getCssFlavorsFlavor:getCssFlavorsFlavor": {
"properties": {
"diskRange": {
"type": "string",
"description": "The disk capacity range of an instance, in GB.\n"
},
"id": {
"type": "string",
"description": "The ID of CSS flavor.\n"
},
"memory": {
"type": "number",
"description": "Specifies the memory size(GB) in the CSS flavor.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the CSS flavor.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to obtain the CSS flavors. If omitted, the\nprovider-level region will be used.\n"
},
"type": {
"type": "string",
"description": "Specifies the node instance type. The options are `ess`, `ess-cold`, `ess-master`\nand `ess-client`.\n"
},
"vcpus": {
"type": "number",
"description": "Specifies the number of vCPUs in the CSS flavor.\n"
},
"version": {
"type": "string",
"description": "Specifies the engine version. The options are `6.5.4`, `7.1.1`, `7.6.2`, `7.9.3`\nand `7.10.2`.\n"
}
},
"type": "object",
"required": [
"diskRange",
"id",
"memory",
"name",
"region",
"type",
"vcpus",
"version"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDcsFlavorsFlavor:getDcsFlavorsFlavor": {
"properties": {
"availableZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of available zones where the cache specification can be used.\n"
},
"cacheMode": {
"type": "string",
"description": "The mode of a cache engine. The valid values are as follows:\n"
},
"capacity": {
"type": "number",
"description": "The total memory of the cache, in GB.\n+ **Redis4.0, Redis5.0 and Redis6.0**: Stand-alone and active/standby type instance values:\n`0.125`, `0.25`, `0.5`, `1`, `2`, `4`, `8`, `16`, `32` and `64`.\nCluster instance specifications support `4`,`8`,`16`,`24`, `32`, `48`, `64`, `96`, `128`, `192`,\n`256`, `384`, `512`, `768` and `1024`.\n+ **Redis3.0**: Stand-alone and active/standby type instance values: `2`, `4`, `8`, `16`, `32` and `64`.\nProxy cluster instance specifications support `64`, `128`, `256`, `512`, and `1024`.\n+ **Memcached**: Stand-alone and active/standby type instance values: `2`, `4`, `8`, `16`, `32` and `64`.\n"
},
"chargingModes": {
"type": "array",
"items": {
"type": "string"
}
},
"cpuArchitecture": {
"type": "string",
"description": "The CPU architecture of cache instance.\nValid values *x86_64* and *aarch64*.\n"
},
"engine": {
"type": "string",
"description": "The engine of the cache instance. Valid values are *Redis* and *Memcached*.\nDefault value is *Redis*.\n"
},
"engineVersions": {
"type": "string",
"description": "Supported versions of the specification.\n"
},
"ipCount": {
"type": "number",
"description": "Number of IP addresses corresponding to the specifications.\n"
},
"name": {
"type": "string",
"description": "The flavor name of the cache instance.\n"
}
},
"type": "object",
"required": [
"availableZones",
"cacheMode",
"capacity",
"chargingModes",
"cpuArchitecture",
"engine",
"engineVersions",
"ipCount",
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDcsInstancesInstance:getDcsInstancesInstance": {
"properties": {
"accessUser": {
"type": "string",
"description": "Indicates the username used for accessing a DCS Memcached instance.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the code of the AZ where the cache node resides.\n"
},
"capacity": {
"type": "number",
"description": "Specifies the cache capacity. Unit: GB.\n"
},
"chargingMode": {
"type": "string"
},
"description": {
"type": "string",
"description": "Indicates the description of an instance.\n"
},
"domainName": {
"type": "string",
"description": "Indicates the domain name of the instance.\n"
},
"engine": {
"type": "string",
"description": "Indicates a cache engine.\n"
},
"engineVersion": {
"type": "string",
"description": "Indicates the version of a cache engine.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Indicates the enterprise project id of the dcs instance.\n"
},
"flavor": {
"type": "string",
"description": "Indicates the flavor of the cache instance.\n"
},
"id": {
"type": "string",
"description": "Indicates the ID of the instance.\n"
},
"maintainBegin": {
"type": "string",
"description": "Indicates the time at which the maintenance time window starts.\n"
},
"maintainEnd": {
"type": "string",
"description": "Indicates the time at which the maintenance time window ends.\n"
},
"maxMemory": {
"type": "number",
"description": "Indicates the total memory size. Unit: MB.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of an instance.\n"
},
"orderId": {
"type": "string",
"description": "Indicates the ID of the order that created the instance.\n"
},
"port": {
"type": "number",
"description": "Indicates the port of the cache instance.\n"
},
"privateIp": {
"type": "string",
"description": "Specifies the subnet Network ID.\n"
},
"securityGroupId": {
"type": "string",
"description": "Indicates the ID of the security group which the instance belongs to.\n"
},
"securityGroupName": {
"type": "string",
"description": "Indicates the name of security group which the instance belongs to.\n"
},
"status": {
"type": "string",
"description": "Specifies the cache instance status. The valid values are **RUNNING**, **ERROR**,\n**RESTARTING**, **FROZEN**, **EXTENDING**, **RESTORING**, **FLUSHING**.\n"
},
"subnetId": {
"type": "string",
"description": "Indicates the ID of subnet which the instance belongs to.\n"
},
"subnetName": {
"type": "string",
"description": "Indicates the name of subnet which the instance belongs to.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Indicates The key/value pairs to associate with the DCS instance.\n"
},
"usedMemory": {
"type": "number",
"description": "Indicates the size of the used memory. Unit: MB.\n"
},
"vpcId": {
"type": "string",
"description": "Indicates the ID of VPC which the instance belongs to.\n"
},
"vpcName": {
"type": "string",
"description": "Indicates the name of VPC which the instance belongs to.\n"
}
},
"type": "object",
"required": [
"accessUser",
"availabilityZones",
"capacity",
"chargingMode",
"description",
"domainName",
"engine",
"engineVersion",
"enterpriseProjectId",
"flavor",
"id",
"maintainBegin",
"maintainEnd",
"maxMemory",
"name",
"orderId",
"port",
"privateIp",
"securityGroupId",
"securityGroupName",
"status",
"subnetId",
"subnetName",
"tags",
"usedMemory",
"vpcId",
"vpcName"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDcsTemplatesTemplate:getDcsTemplatesTemplate": {
"properties": {
"cacheMode": {
"type": "string",
"description": "Specifies the DCS instance type. Value options:\n+ **single**: single-node.\n+ **ha**: master/standby.\n+ **cluster**: Redis Cluster.\n+ **proxy**: Proxy Cluster.\n"
},
"description": {
"type": "string",
"description": "Indicates the description of the template.\n"
},
"engine": {
"type": "string",
"description": "Specifies the cache engine. Value options: **Redis**, **Memcached**.\n"
},
"engineVersion": {
"type": "string",
"description": "Specifies the cache engine version. Value options: **4.0**, **5.0**, **6.0**.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the template.\n"
},
"productType": {
"type": "string",
"description": "Specifies the product edition. Value options:\n+ **generic**: standard edition.\n+ **enterprise**: professional edition.\n"
},
"storageType": {
"type": "string",
"description": "Specifies the storage type. Value options: **DRAM**, **SSD**.\n"
},
"templateId": {
"type": "string",
"description": "Specifies the ID of the template.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the template. Value options:\n+ **sys**: system template.\n+ **user**: custom template.\n"
}
},
"type": "object",
"required": [
"cacheMode",
"description",
"engine",
"engineVersion",
"name",
"productType",
"storageType",
"templateId",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdmAccountsAccount:getDdmAccountsAccount": {
"properties": {
"description": {
"type": "string",
"description": "Indicates the schema description.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the DDM account.\n"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the basic permissions of the DDM account.\n"
},
"schemas": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDdmAccountsAccountSchema:getDdmAccountsAccountSchema"
},
"description": "Indicates the schemas that associated with the account.\nThe Schema structure is documented below.\n"
},
"status": {
"type": "string",
"description": "Specifies the status of the DDM account.\n"
}
},
"type": "object",
"required": [
"description",
"name",
"permissions",
"schemas",
"status"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdmAccountsAccountSchema:getDdmAccountsAccountSchema": {
"properties": {
"description": {
"type": "string",
"description": "Indicates the schema description.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the DDM account.\n"
}
},
"type": "object",
"required": [
"description",
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdmEnginesEngine:getDdmEnginesEngine": {
"properties": {
"id": {
"type": "string",
"description": "Indicates the ID of the engine.\n"
},
"version": {
"type": "string",
"description": "Specifies the engine version.\n"
}
},
"type": "object",
"required": [
"id",
"version"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdmFlavorsFlavor:getDdmFlavorsFlavor": {
"properties": {
"code": {
"type": "string",
"description": "Specifies the VM flavor types recorded in DDM.\n"
},
"cpuArch": {
"type": "string",
"description": "Specifies the compute resource architecture type. The options are **X86** and **ARM**.\n"
},
"id": {
"type": "string",
"description": "Indicates the ID of a flavor.\n"
},
"memory": {
"type": "number",
"description": "Specifies the memory size. Unit GB.\n"
},
"vcpus": {
"type": "number",
"description": "Specifies the number of CPUs.\n"
}
},
"type": "object",
"required": [
"code",
"cpuArch",
"id",
"memory",
"vcpus"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdmInstanceNodesNode:getDdmInstanceNodesNode": {
"properties": {
"id": {
"type": "string",
"description": "Indicates the ID of the DDM instance node.\n"
},
"ip": {
"type": "string",
"description": "Indicates the IP address of the DDM instance node.\n"
},
"port": {
"type": "string",
"description": "Indicates the port of the DDM instance node.\n"
},
"status": {
"type": "string",
"description": "Indicates the status of the DDM instance node.\n"
}
},
"type": "object",
"required": [
"id",
"ip",
"port",
"status"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdmInstancesInstance:getDdmInstancesInstance": {
"properties": {
"accessIp": {
"type": "string",
"description": "Indicates the address for accessing the DDM instance.\n"
},
"accessPort": {
"type": "string",
"description": "Indicates the port for accessing the DDM instance.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the list of availability zones.\n"
},
"engineVersion": {
"type": "string",
"description": "Specifies the engine version.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the instance.\n"
},
"nodeNum": {
"type": "number",
"description": "Indicates the number of nodes.\n"
},
"securityGroupId": {
"type": "string",
"description": "Indicates the ID of a security group.\n"
},
"status": {
"type": "string",
"description": "Specifies the status of the instance.\n"
},
"subnetId": {
"type": "string",
"description": "Indicates the ID of a subnet.\n"
},
"vpcId": {
"type": "string",
"description": "Indicates the ID of a VPC.\n"
}
},
"type": "object",
"required": [
"accessIp",
"accessPort",
"availabilityZones",
"engineVersion",
"enterpriseProjectId",
"name",
"nodeNum",
"securityGroupId",
"status",
"subnetId",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdmSchemasSchema:getDdmSchemasSchema": {
"properties": {
"dataNodes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDdmSchemasSchemaDataNode:getDdmSchemasSchemaDataNode"
},
"description": "Indicates the RDS instances associated with the schema.\nThe DataNode structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the DDM schema.\n"
},
"shardMode": {
"type": "string",
"description": "Specifies the sharding mode of the schema. Values option: **cluster**, **single**.\n"
},
"shardNumber": {
"type": "number",
"description": "Indicates the number of shards in the same working mode.\n"
},
"status": {
"type": "string",
"description": "Specifies the status of the DDM schema.\n"
}
},
"type": "object",
"required": [
"dataNodes",
"name",
"shardMode",
"shardNumber",
"status"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdmSchemasSchemaDataNode:getDdmSchemasSchemaDataNode": {
"properties": {
"id": {
"type": "string",
"description": "Indicates the node ID of the associated RDS instance.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the DDM schema.\n"
},
"status": {
"type": "string",
"description": "Specifies the status of the DDM schema.\n"
}
},
"type": "object",
"required": [
"id",
"name",
"status"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdsFlavorsV3Flavor:getDdsFlavorsV3Flavor": {
"properties": {
"memory": {
"type": "string",
"description": "Specifies the ram of the dds flavor in GB.\n"
},
"specCode": {
"type": "string",
"description": "The name of the dds flavor.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the dds falvor. \"mongos\", \"shard\", \"config\",\n\"replica\" and \"single\" are supported.\n"
},
"vcpus": {
"type": "string",
"description": "Specifies the vcpus of the dds flavor.\n"
}
},
"type": "object",
"required": [
"memory",
"specCode",
"type",
"vcpus"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdsInstancesInstance:getDdsInstancesInstance": {
"properties": {
"backupStrategies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDdsInstancesInstanceBackupStrategy:getDdsInstancesInstanceBackupStrategy"
},
"description": "Indicates backup strategy.\nThe backup_strategy object structure is documented below.\n"
},
"datastores": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDdsInstancesInstanceDatastore:getDdsInstancesInstanceDatastore"
},
"description": "Indicates database information.\nThe datastore object structure is documented below.\n"
},
"dbUsername": {
"type": "string",
"description": "Indicates the DB Administrator name.\n"
},
"diskEncryptionId": {
"type": "string",
"description": "Indicates the disk encryption ID of the instance.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Indicates the enterprise project id of the dds instance.\n"
},
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"mode": {
"type": "string",
"description": "Specifies the mode of the database instance.\n"
},
"name": {
"type": "string",
"description": "Specifies the DB instance name.\n"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDdsInstancesInstanceNode:getDdsInstancesInstanceNode"
},
"description": "Indicates the instance nodes information.\nThe nodes object structure is documented below.\n"
},
"port": {
"type": "number",
"description": "Indicates the database port number. The port range is 2100 to 9500.\n"
},
"securityGroupId": {
"type": "string",
"description": "Indicates the security group ID of the DDS instance.\n"
},
"ssl": {
"type": "boolean",
"description": "Indicates whether to enable or disable SSL.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the subnet Network ID.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Indicates the key/value pairs to associate with the DDS instance.\n"
},
"vpcId": {
"type": "string",
"description": "Specifies the VPC ID.\n"
}
},
"type": "object",
"required": [
"backupStrategies",
"datastores",
"dbUsername",
"diskEncryptionId",
"enterpriseProjectId",
"id",
"mode",
"name",
"nodes",
"port",
"securityGroupId",
"ssl",
"status",
"subnetId",
"tags",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdsInstancesInstanceBackupStrategy:getDdsInstancesInstanceBackupStrategy": {
"properties": {
"keepDays": {
"type": "number",
"description": "Indicates the number of days to retain the generated backup files.\n"
},
"startTime": {
"type": "string",
"description": "Indicates the backup time window.\n"
}
},
"type": "object",
"required": [
"keepDays",
"startTime"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdsInstancesInstanceDatastore:getDdsInstancesInstanceDatastore": {
"properties": {
"storageEngine": {
"type": "string",
"description": "Indicates the storage engine of the DB instance.\n"
},
"type": {
"type": "string",
"description": "Indicates the node type.\n"
},
"version": {
"type": "string",
"description": "Indicates the DB instance version.\n"
}
},
"type": "object",
"required": [
"storageEngine",
"type",
"version"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDdsInstancesInstanceNode:getDdsInstancesInstanceNode": {
"properties": {
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the DB instance name.\n"
},
"privateIp": {
"type": "string",
"description": "Indicates the private IP address of a node.\n"
},
"publicIp": {
"type": "string",
"description": "Indicates the EIP that has been bound on a node.\n"
},
"role": {
"type": "string",
"description": "Indicates the node role.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
},
"type": {
"type": "string",
"description": "Indicates the node type.\n"
}
},
"type": "object",
"required": [
"id",
"name",
"privateIp",
"publicIp",
"role",
"status",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDmsKafkaFlavorsFlavor:getDmsKafkaFlavorsFlavor": {
"properties": {
"archTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of supported CPU architectures.\n"
},
"chargingModes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of supported billing modes.\n"
},
"id": {
"type": "string",
"description": "The flavor ID.\n"
},
"ios": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDmsKafkaFlavorsFlavorIo:getDmsKafkaFlavorsFlavorIo"
},
"description": "The list of supported disk IO types.\nThe object structure is documented below.\n"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDmsKafkaFlavorsFlavorProperty:getDmsKafkaFlavorsFlavorProperty"
},
"description": "The function property details.\nThe object structure is documented below.\n"
},
"supportFeatures": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDmsKafkaFlavorsFlavorSupportFeature:getDmsKafkaFlavorsFlavorSupportFeature"
},
"description": "The list of features supported by the current specification.\nThe object structure is documented below.\n"
},
"type": {
"type": "string",
"description": "Specifies flavor type. The valid values are **single** and **cluster**.\n"
},
"vmSpecification": {
"type": "string",
"description": "The underlying VM specification.\n"
}
},
"type": "object",
"required": [
"archTypes",
"chargingModes",
"id",
"ios",
"properties",
"supportFeatures",
"type",
"vmSpecification"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDmsKafkaFlavorsFlavorIo:getDmsKafkaFlavorsFlavorIo": {
"properties": {
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the list of availability zones with available resources.\n"
},
"storageSpecCode": {
"type": "string",
"description": "Specifies the disk IO encoding.\n+ **dms.physical.storage.high.v2**: Type of the disk that uses high I/O.\n+ **dms.physical.storage.ultra.v2**: Type of the disk that uses ultra-high I/O.\n"
},
"type": {
"type": "string",
"description": "Specifies flavor type. The valid values are **single** and **cluster**.\n"
},
"unavailabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of unavailability zones with available resources.\n"
}
},
"type": "object",
"required": [
"availabilityZones",
"storageSpecCode",
"type",
"unavailabilityZones"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDmsKafkaFlavorsFlavorProperty:getDmsKafkaFlavorsFlavorProperty": {
"properties": {
"flavorAlias": {
"type": "string",
"description": "The flavor ID alias.\n"
},
"maxBandwidthPerBroker": {
"type": "number",
"description": "The maximum bandwidth per broker.\n"
},
"maxBroker": {
"type": "number",
"description": "The maximum number of brokers.\n"
},
"maxConsumerPerBroker": {
"type": "number",
"description": "The maximum number of consumers per broker.\n"
},
"maxPartitionPerBroker": {
"type": "number",
"description": "The maximum number of partitions per broker.\n"
},
"maxStoragePerNode": {
"type": "number",
"description": "The maximum storage per node. The unit is GB.\n"
},
"maxTpsPerBroker": {
"type": "number",
"description": "The maximum TPS per broker.\n"
},
"minBroker": {
"type": "number",
"description": "The minimum number of brokers.\n"
},
"minStoragePerNode": {
"type": "number",
"description": "The minimum storage per node. The unit is GB.\n"
}
},
"type": "object",
"required": [
"flavorAlias",
"maxBandwidthPerBroker",
"maxBroker",
"maxConsumerPerBroker",
"maxPartitionPerBroker",
"maxStoragePerNode",
"maxTpsPerBroker",
"minBroker",
"minStoragePerNode"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDmsKafkaFlavorsFlavorSupportFeature:getDmsKafkaFlavorsFlavorSupportFeature": {
"properties": {
"name": {
"type": "string",
"description": "The function name, e.g. **connector_obs**.\n"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDmsKafkaFlavorsFlavorSupportFeatureProperty:getDmsKafkaFlavorsFlavorSupportFeatureProperty"
},
"description": "The function property details.\nThe object structure is documented below.\n"
}
},
"type": "object",
"required": [
"name",
"properties"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDmsKafkaFlavorsFlavorSupportFeatureProperty:getDmsKafkaFlavorsFlavorSupportFeatureProperty": {
"properties": {
"maxNode": {
"type": "number",
"description": "The maximum number of nodes for the dump function.\n"
},
"maxTask": {
"type": "number",
"description": "The maximum number of tasks for the dump function.\n"
},
"minNode": {
"type": "number",
"description": "The minimum number of nodes for the dump function.\n"
},
"minTask": {
"type": "number",
"description": "The minimum number of tasks for the dump function.\n"
}
},
"type": "object",
"required": [
"maxNode",
"maxTask",
"minNode",
"minTask"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDmsKafkaInstancesInstance:getDmsKafkaInstancesInstance": {
"properties": {
"accessUser": {
"type": "string",
"description": "The access username.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of AZ names.\n"
},
"connectAddress": {
"type": "string",
"description": "The IP address for instance connection.\n"
},
"crossVpcAccesses": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDmsKafkaInstancesInstanceCrossVpcAccess:getDmsKafkaInstancesInstanceCrossVpcAccess"
},
"description": "Indicates the Access information of cross-VPC. The cross_vpc_accesses\nobject structure is documented below.\n"
},
"description": {
"type": "string",
"description": "The instance description.\n"
},
"dumping": {
"type": "boolean",
"description": "Whether to dumping is enabled.\n"
},
"enableAutoTopic": {
"type": "boolean",
"description": "Whether to enable automatic topic creation.\n"
},
"enablePublicIp": {
"type": "boolean",
"description": "Whether public access to the instance is enabled.\n"
},
"enabledMechanisms": {
"type": "array",
"items": {
"type": "string"
}
},
"engineVersion": {
"type": "string",
"description": "The kafka engine version.\n"
},
"enterpriseProjectId": {
"type": "string"
},
"id": {
"type": "string",
"description": "The instance ID.\n"
},
"maintainBegin": {
"type": "string",
"description": "The time at which a maintenance time window starts, the format is `HH:mm`.\n"
},
"maintainEnd": {
"type": "string",
"description": "The time at which a maintenance time window ends, the format is `HH:mm`.\n"
},
"managementConnectAddress": {
"type": "string",
"description": "The connection address of the Kafka manager of an instance.\n"
},
"managerUser": {
"type": "string",
"description": "The username for logging in to the Kafka Manager.\n"
},
"manegementConnectAddress": {
"type": "string"
},
"name": {
"type": "string",
"description": "Specifies the kafka instance name for data-source queries.\n"
},
"networkId": {
"type": "string",
"description": "The subnet ID to which the instance belongs.\n"
},
"partitionNum": {
"type": "number",
"description": "The maximum number of topics in the DMS kafka instance.\n"
},
"port": {
"type": "number",
"description": "The port number.\n"
},
"productId": {
"type": "string",
"description": "The product ID used by the instance.\n"
},
"publicConnAddresses": {
"type": "string",
"description": "The instance public access address.\nThe format of each connection address is `{IP address}:{port}`.\n"
},
"publicIpIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the elastic IP address (EIP).\n"
},
"resourceSpecCode": {
"type": "string",
"description": "The resource specifications identifier.\n"
},
"retentionPolicy": {
"type": "string",
"description": "The action to be taken when the memory usage reaches the disk capacity threshold.\n"
},
"securityGroupId": {
"type": "string",
"description": "The security group ID associated with the instance.\n"
},
"securityProtocol": {
"type": "string"
},
"sslEnable": {
"type": "boolean",
"description": "Whether the Kafka SASL_SSL is enabled.\n"
},
"status": {
"type": "string",
"description": "Specifies the kafka instance status for data-source queries.\n"
},
"storageSpace": {
"type": "number",
"description": "The message storage capacity, in GB unit.\n"
},
"storageSpecCode": {
"type": "string",
"description": "The storage I/O specification.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the instance.\n"
},
"type": {
"type": "string",
"description": "The instance type.\n"
},
"usedStorageSpace": {
"type": "number",
"description": "The used message storage space, in GB unit.\n"
},
"userId": {
"type": "string",
"description": "The user ID who created the instance.\n"
},
"userName": {
"type": "string",
"description": "The username who created the instance.\n"
},
"vpcId": {
"type": "string",
"description": "The VPC ID to which the instance belongs.\n"
}
},
"type": "object",
"required": [
"accessUser",
"availabilityZones",
"connectAddress",
"crossVpcAccesses",
"description",
"dumping",
"enableAutoTopic",
"enablePublicIp",
"enabledMechanisms",
"engineVersion",
"enterpriseProjectId",
"id",
"maintainBegin",
"maintainEnd",
"managementConnectAddress",
"managerUser",
"manegementConnectAddress",
"name",
"networkId",
"partitionNum",
"port",
"productId",
"publicConnAddresses",
"publicIpIds",
"resourceSpecCode",
"retentionPolicy",
"securityGroupId",
"securityProtocol",
"sslEnable",
"status",
"storageSpace",
"storageSpecCode",
"tags",
"type",
"usedStorageSpace",
"userId",
"userName",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDmsKafkaInstancesInstanceCrossVpcAccess:getDmsKafkaInstancesInstanceCrossVpcAccess": {
"properties": {
"advertisedIp": {
"type": "string",
"description": "The advertised IP Address.\n"
},
"lisenterIp": {
"type": "string"
},
"listenerIp": {
"type": "string",
"description": "The listener IP address.\n"
},
"port": {
"type": "number",
"description": "The port number.\n"
},
"portId": {
"type": "string",
"description": "The port ID associated with the address.\n"
}
},
"type": "object",
"required": [
"advertisedIp",
"lisenterIp",
"listenerIp",
"port",
"portId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDmsRocketmqInstancesInstance:getDmsRocketmqInstancesInstance": {
"properties": {
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the list of availability zone names, where\ninstance brokers reside and which has available resources.\n"
},
"brokerAddress": {
"type": "string",
"description": "Indicates the service data address.\n"
},
"brokerNum": {
"type": "number",
"description": "Specifies the broker numbers. Defaults to 1.\n"
},
"crossVpcAccesses": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDmsRocketmqInstancesInstanceCrossVpcAccess:getDmsRocketmqInstancesInstanceCrossVpcAccess"
},
"description": "Indicates the Cross-VPC access information.\nThe cross_vpc_accesses object structure is documented below.\n"
},
"description": {
"type": "string",
"description": "Indicates the description of the DMS RocketMQ instance.\n"
},
"enableAcl": {
"type": "boolean",
"description": "Indicates whether access control is enabled.\n"
},
"enablePublicip": {
"type": "boolean",
"description": "Indicates whether to enable public access.\n"
},
"engineVersion": {
"type": "string",
"description": "Indicates the version of the RocketMQ engine.\n"
},
"flavorId": {
"type": "string",
"description": "Indicates a product ID.\n"
},
"id": {
"type": "string",
"description": "Indicates the ID of the DMS RocketMQ instance.\n"
},
"ipv6Enable": {
"type": "boolean",
"description": "Indicates whether to support IPv6. Defaults to false.\n"
},
"maintainBegin": {
"type": "string",
"description": "Indicates the time at which the maintenance window starts. The format is HH:mm:ss.\n"
},
"maintainEnd": {
"type": "string",
"description": "Indicates the time at which the maintenance window ends. The format is HH:mm:ss.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the DMS RocketMQ instance.\n"
},
"namesrvAddress": {
"type": "string",
"description": "Indicates the metadata address.\n"
},
"newSpecBillingEnable": {
"type": "boolean",
"description": "Indicates the whether billing based on new specifications is enabled.\n"
},
"nodeNum": {
"type": "number",
"description": "Indicates the node quantity.\n"
},
"publicBrokerAddress": {
"type": "string",
"description": "Indicates the public network service data address.\n"
},
"publicNamesrvAddress": {
"type": "string",
"description": "Indicates the public network metadata address.\n"
},
"publicipAddress": {
"type": "string",
"description": "Indicates the public IP address.\n"
},
"publicipId": {
"type": "string",
"description": "Indicates the ID of the EIP bound to the instance.\nUse commas (,) to separate multiple EIP IDs.\nThis parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).\n"
},
"resourceSpecCode": {
"type": "string",
"description": "Indicates the resource specifications.\n"
},
"securityGroupId": {
"type": "string",
"description": "Indicates the ID of a security group.\n"
},
"specification": {
"type": "string",
"description": "Indicates the instance specification. For a cluster DMS RocketMQ instance, VM specifications\nand the number of nodes are returned.\n"
},
"sslEnable": {
"type": "boolean",
"description": "Indicates whether the RocketMQ SASL_SSL is enabled. Defaults to false.\n"
},
"status": {
"type": "string",
"description": "Specifies the status of the DMS RocketMQ instance.\n"
},
"storageSpace": {
"type": "number",
"description": "Indicates the message storage capacity. Unit: GB.\n"
},
"storageSpecCode": {
"type": "string",
"description": "Indicates the storage I/O specification.\n"
},
"subnetId": {
"type": "string",
"description": "Indicates the ID of a subnet.\n"
},
"type": {
"type": "string",
"description": "Indicates the DMS RocketMQ instance type.\n"
},
"usedStorageSpace": {
"type": "number",
"description": "Indicates the used message storage space. Unit: GB.\n"
},
"vpcId": {
"type": "string",
"description": "Indicates the ID of a VPC.\n"
}
},
"type": "object",
"required": [
"availabilityZones",
"brokerAddress",
"brokerNum",
"crossVpcAccesses",
"description",
"enableAcl",
"enablePublicip",
"engineVersion",
"flavorId",
"id",
"ipv6Enable",
"maintainBegin",
"maintainEnd",
"name",
"namesrvAddress",
"newSpecBillingEnable",
"nodeNum",
"publicBrokerAddress",
"publicNamesrvAddress",
"publicipAddress",
"publicipId",
"resourceSpecCode",
"securityGroupId",
"specification",
"sslEnable",
"status",
"storageSpace",
"storageSpecCode",
"subnetId",
"type",
"usedStorageSpace",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDmsRocketmqInstancesInstanceCrossVpcAccess:getDmsRocketmqInstancesInstanceCrossVpcAccess": {
"properties": {
"advertisedIp": {
"type": "string",
"description": "Indicates the advertised IP.\n"
},
"lisenterIp": {
"type": "string"
},
"listenerIp": {
"type": "string",
"description": "Indicates the IP of the listener.\n"
},
"port": {
"type": "number",
"description": "Indicates the port.\n"
},
"portId": {
"type": "string",
"description": "Indicates the port ID associated with the address.\n"
}
},
"type": "object",
"required": [
"advertisedIp",
"lisenterIp",
"listenerIp",
"port",
"portId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDwsFlavorsFlavor:getDwsFlavorsFlavor": {
"properties": {
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the availability zone where the node resides.\n"
},
"datastoreType": {
"type": "string",
"description": "The type of datastore. The options are as follows:\n- **dws**: OLAP, elastic scaling, unlimited scaling of compute and storage capacity.\n- **hybrid**: a single data warehouse used for transaction and analytics workloads,\nin single-node or cluster mode.\n- **stream**: built-in time series operators; up to 40:1 compression ratio; applicable to IoT services.\n"
},
"elasticVolumeSpecs": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetDwsFlavorsFlavorElasticVolumeSpec:getDwsFlavorsFlavorElasticVolumeSpec"
},
"description": "The elastic_volume_specs object structure is documented below.\n"
},
"flavorId": {
"type": "string",
"description": "The name of the DWS node flavor. It is referenced by **node_type** in `flexibleengine.DwsClusterV1`.\n"
},
"memory": {
"type": "number",
"description": "Specifies the ram of the DWS node flavor in GB.\n"
},
"size": {
"type": "number",
"description": "Indicates the Disk size in GB.\n"
},
"vcpus": {
"type": "number",
"description": "Specifies the vcpus of the DWS node flavor.\n"
},
"volumetype": {
"type": "string",
"description": "Indicates Disk type.\n"
}
},
"type": "object",
"required": [
"availabilityZones",
"datastoreType",
"elasticVolumeSpecs",
"flavorId",
"memory",
"size",
"vcpus",
"volumetype"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getDwsFlavorsFlavorElasticVolumeSpec:getDwsFlavorsFlavorElasticVolumeSpec": {
"properties": {
"maxSize": {
"type": "number",
"description": "Maximum disk size.\n"
},
"minSize": {
"type": "number",
"description": "Minimum disk size.\n"
},
"step": {
"type": "number",
"description": "Disk size increment step.\n"
}
},
"type": "object",
"required": [
"maxSize",
"minSize",
"step"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getElbFlavorsFlavor:getElbFlavorsFlavor": {
"properties": {
"bandwidth": {
"type": "number",
"description": "Specifies the bandwidth size(Mbit/s) in the flavor.\n"
},
"cps": {
"type": "number",
"description": "Specifies the cps in the flavor.\n"
},
"id": {
"type": "string",
"description": "ID of the flavor.\n"
},
"maxConnections": {
"type": "number",
"description": "Specifies the maximum connections in the flavor.\n"
},
"name": {
"type": "string",
"description": "Name of the flavor.\n"
},
"qps": {
"type": "number",
"description": "Specifies the qps in the L7 flavor.\n"
},
"type": {
"type": "string",
"description": "Specifies the flavor type. Valid values are **L4** and **L7**.\n"
}
},
"type": "object",
"required": [
"bandwidth",
"cps",
"id",
"maxConnections",
"name",
"qps",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getElbLoadbalancersLoadbalancer:getElbLoadbalancersLoadbalancer": {
"properties": {
"autoscalingEnabled": {
"type": "boolean",
"description": "Whether the current load balancer enables elastic expansion.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of AZs where the load balancer is created.\n"
},
"backendSubnets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lists the IDs of subnets on the downstream plane.\n"
},
"crossVpcBackend": {
"type": "boolean",
"description": "Whether to enable IP as a Backend Server.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the ELB load balancer.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project ID.\n"
},
"id": {
"type": "string",
"description": "The load balancer ID.\n"
},
"ipv4Address": {
"type": "string",
"description": "The private IPv4 address bound to the load balancer.\n"
},
"ipv4PortId": {
"type": "string",
"description": "The ID of the port bound to the private IPv4 address of the load balancer.\n"
},
"ipv4SubnetId": {
"type": "string",
"description": "Specifies the ID of the IPv4 subnet where the load balancer resides.\n"
},
"ipv6Address": {
"type": "string",
"description": "The IPv6 address bound to the load balancer.\n"
},
"ipv6NetworkId": {
"type": "string",
"description": "Specifies the ID of the port bound to the IPv6 address of the load balancer.\n"
},
"l4FlavorId": {
"type": "string",
"description": "Specifies the ID of a flavor at Layer 4.\n"
},
"l7FlavorId": {
"type": "string",
"description": "Specifies the ID of a flavor at Layer 7.\n"
},
"minL7FlavorId": {
"type": "string",
"description": "The minimum seven-layer specification ID (specification type L7_elastic) for elastic expansion\nand contraction\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the ELB load balancer.\n"
},
"protectionReason": {
"type": "string",
"description": "The reason for update protection.\n"
},
"protectionStatus": {
"type": "string",
"description": "The protection status for update.\n"
},
"type": {
"type": "string",
"description": "Specifies whether the load balancer is a dedicated load balancer, Value options:\n**dedicated**, **share**.\n"
},
"vpcId": {
"type": "string",
"description": "Specifies the ID of the VPC where the load balancer resides.\n"
}
},
"type": "object",
"required": [
"autoscalingEnabled",
"availabilityZones",
"backendSubnets",
"crossVpcBackend",
"description",
"enterpriseProjectId",
"id",
"ipv4Address",
"ipv4PortId",
"ipv4SubnetId",
"ipv6Address",
"ipv6NetworkId",
"l4FlavorId",
"l7FlavorId",
"minL7FlavorId",
"name",
"protectionReason",
"protectionStatus",
"type",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getFgsDependenciesPackage:getFgsDependenciesPackage": {
"properties": {
"etag": {
"type": "string",
"description": "Unique ID of the dependent package.\n"
},
"fileName": {
"type": "string",
"description": "File name of the Dependent package.\n"
},
"id": {
"type": "string",
"description": "Dependent package ID.\n"
},
"link": {
"type": "string",
"description": "URL of the dependent package in the OBS console.\n"
},
"name": {
"type": "string",
"description": "Specifies the dependent package runtime to match.\n"
},
"owner": {
"type": "string",
"description": "Dependent package owner.\n"
},
"runtime": {
"type": "string",
"description": "Specifies the dependent package runtime to match. Valid values: **Java8**,\n**Node.js6.10**, **Node.js8.10**, **Node.js10.16**, **Node.js12.13**, **Python2.7**, **Python3.6**, **Go1.8**,\n**Go1.x**, **C#(.NET Core 2.0)**, **C#(.NET Core 2.1)**, **C#(.NET Core 3.1)** and **PHP7.3**.\n"
},
"size": {
"type": "number",
"description": "Dependent package size.\n"
}
},
"type": "object",
"required": [
"etag",
"fileName",
"id",
"link",
"name",
"owner",
"runtime",
"size"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getGaussdbCassandraFlavorsFlavor:getGaussdbCassandraFlavorsFlavor": {
"properties": {
"azStatus": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Indicates the flavor status in each availability zone.\n"
},
"memory": {
"type": "string",
"description": "Specifies the memory size of the flavors.\n"
},
"name": {
"type": "string",
"description": "Indicates the spec code of the flavor.\n"
},
"vcpus": {
"type": "string",
"description": "Specifies the count of vcpus of the flavors.\n"
},
"version": {
"type": "string",
"description": "Specifies the engine version of the flavors.\n"
}
},
"type": "object",
"required": [
"azStatus",
"memory",
"name",
"vcpus",
"version"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getGaussdbCassandraInstancesInstance:getGaussdbCassandraInstancesInstance": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "Indicates the availability zone where the node resides.\n"
},
"backupStrategies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetGaussdbCassandraInstancesInstanceBackupStrategy:getGaussdbCassandraInstancesInstanceBackupStrategy"
},
"description": "Indicates the advanced backup policy. The backup_strategy object\nstructure is documented below.\n"
},
"datastores": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetGaussdbCassandraInstancesInstanceDatastore:getGaussdbCassandraInstancesInstanceDatastore"
},
"description": "Indicates the database information. The datastore object structure is documented\nbelow.\n"
},
"dbUserName": {
"type": "string",
"description": "Indicates the default username.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Indicates the enterprise project id.\n"
},
"flavor": {
"type": "string",
"description": "Indicates the instance specifications.\n"
},
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"mode": {
"type": "string",
"description": "Indicates the instance mode.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the instance.\n"
},
"nodeNum": {
"type": "number",
"description": "Indicates the count of the nodes.\n"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetGaussdbCassandraInstancesInstanceNode:getGaussdbCassandraInstancesInstanceNode"
},
"description": "Indicates the instance nodes information. The nodes object structure is documented below.\n"
},
"port": {
"type": "number",
"description": "Indicates the database port.\n"
},
"privateIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the list of private IP address of the nodes.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the instance. If omitted, the provider-level region will\nbe used.\n"
},
"securityGroupId": {
"type": "string",
"description": "Indicates the security group ID.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the network ID of a subnet.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Indicates the key/value tags of the instance.\n"
},
"volumeSize": {
"type": "number",
"description": "Indicates the size of the volume.\n"
},
"vpcId": {
"type": "string",
"description": "Specifies the VPC ID.\n"
}
},
"type": "object",
"required": [
"availabilityZone",
"backupStrategies",
"datastores",
"dbUserName",
"enterpriseProjectId",
"flavor",
"id",
"mode",
"name",
"nodeNum",
"nodes",
"port",
"privateIps",
"region",
"securityGroupId",
"status",
"subnetId",
"tags",
"volumeSize",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getGaussdbCassandraInstancesInstanceBackupStrategy:getGaussdbCassandraInstancesInstanceBackupStrategy": {
"properties": {
"keepDays": {
"type": "number",
"description": "Indicates the number of days to retain the generated\n"
},
"startTime": {
"type": "string",
"description": "Indicates the backup time window.\n"
}
},
"type": "object",
"required": [
"keepDays",
"startTime"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getGaussdbCassandraInstancesInstanceDatastore:getGaussdbCassandraInstancesInstanceDatastore": {
"properties": {
"engine": {
"type": "string",
"description": "Indicates the database engine.\n"
},
"storageEngine": {
"type": "string",
"description": "Indicates the database storage engine.\n"
},
"version": {
"type": "string",
"description": "Indicates the database version.\n"
}
},
"type": "object",
"required": [
"engine",
"storageEngine",
"version"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getGaussdbCassandraInstancesInstanceNode:getGaussdbCassandraInstancesInstanceNode": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "Indicates the availability zone where the node resides.\n"
},
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the instance.\n"
},
"privateIp": {
"type": "string",
"description": "Indicates the private IP address of a node.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
},
"supportReduce": {
"type": "boolean",
"description": "Indicates whether the node support reduce.\n"
}
},
"type": "object",
"required": [
"availabilityZone",
"id",
"name",
"privateIp",
"status",
"supportReduce"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getGaussdbNosqlFlavorsFlavor:getGaussdbNosqlFlavorsFlavor": {
"properties": {
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "All available zones (on sale) for current flavor.\n"
},
"engine": {
"type": "string",
"description": "Specifies the type of the database engine. The valid values are as follows:\n+ **cassandra**: The default value and means to query GaussDB (for Cassandra) instance specifications.\n+ **influxdb**: Means to query GaussDB (for Influx) instance specifications.\n"
},
"engineVersion": {
"type": "string",
"description": "Specifies the version of the database engine.\n"
},
"memory": {
"type": "string",
"description": "Specifies the memory size in gigabytes (GB).\n"
},
"name": {
"type": "string",
"description": "The spec code of the flavor.\n"
},
"vcpus": {
"type": "string",
"description": "Specifies the number of vCPUs.\n"
}
},
"type": "object",
"required": [
"availabilityZones",
"engine",
"engineVersion",
"memory",
"name",
"vcpus"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getIdentityGroupUser:getIdentityGroupUser": {
"properties": {
"description": {
"type": "string",
"description": "Specifies the description of the identity group.\n"
},
"enabled": {
"type": "boolean",
"description": "Indicates the whether the IAM user is enabled.\n"
},
"id": {
"type": "string",
"description": "Specifies the ID of the identity group.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the identity group.\n"
},
"passwordExpiresAt": {
"type": "string",
"description": "Indicates the time when the password will expire.\nNull indicates that the password has unlimited validity.\n"
},
"passwordStatus": {
"type": "boolean",
"description": "Indicates the password status. True means that the password needs to be changed,\nand false means that the password is normal.\n"
},
"passwordStrength": {
"type": "string",
"description": "Indicates the password strength. The value can be high, mid, or low.\n"
}
},
"type": "object",
"required": [
"description",
"enabled",
"id",
"name",
"passwordExpiresAt",
"passwordStatus",
"passwordStrength"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getIdentityProjectsProject:getIdentityProjectsProject": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the IAM project is enabled.\n"
},
"id": {
"type": "string",
"description": "The IAM project ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the IAM project name to query.\n"
}
},
"type": "object",
"required": [
"enabled",
"id",
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getIdentityUsersUser:getIdentityUsersUser": {
"properties": {
"description": {
"type": "string",
"description": "Indicates the description of the IAM user.\n"
},
"enabled": {
"type": "boolean",
"description": "Specifies the status of the IAM user, the default value is **true**.\n"
},
"groups": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the user groups to which an IAM user belongs.\n"
},
"id": {
"type": "string",
"description": "Indicates the ID of the User.\n"
},
"name": {
"type": "string",
"description": "Specifies the IAM user name.\n"
},
"passwordExpiresAt": {
"type": "string",
"description": "Indicates the time when the password will expire.\nNull indicates that the password has unlimited validity.\n"
},
"passwordStatus": {
"type": "boolean",
"description": "Indicates the password status. True means that the password needs to be changed,\nand false means that the password is normal.\n"
}
},
"type": "object",
"required": [
"description",
"enabled",
"groups",
"id",
"name",
"passwordExpiresAt",
"passwordStatus"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getImagesImagesImage:getImagesImagesImage": {
"properties": {
"backupId": {
"type": "string",
"description": "The backup ID of the whole image in the CBR vault.\n"
},
"checksum": {
"type": "string",
"description": "The checksum of the data associated with the image.\n"
},
"containerFormat": {
"type": "string",
"description": "The format of the image's container.\n"
},
"createdAt": {
"type": "string",
"description": "The date when the image was created.\n"
},
"diskFormat": {
"type": "string",
"description": "The format of the image's disk.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project ID of the image.\n"
},
"id": {
"type": "string",
"description": "The ID of the image\n"
},
"imageType": {
"type": "string",
"description": "Specifies the environment where the image is used. For a BMS image, the value is **Ironic**.\n"
},
"minDiskGb": {
"type": "number",
"description": "The minimum amount of disk space required to use the image.\n"
},
"minRamMb": {
"type": "number",
"description": "The minimum amount of ram required to use the image.\n"
},
"name": {
"type": "string",
"description": "The name of the image. Cannot be used simultaneously with `name_regex`.\n"
},
"os": {
"type": "string",
"description": "Specifies the image OS type. The value can be **Windows**, **Ubuntu**,\n**RedHat**, **SUSE**, **CentOS**, **Debian**, **OpenSUSE**, **Oracle Linux**, **Fedora**, **Other**,\n**CoreOS**, or **EulerOS**.\n"
},
"osVersion": {
"type": "string",
"description": "Specifies the OS version. For example, *CentOS 7.4 64bit* or *Ubuntu 18.04 server 64bit*.\n"
},
"owner": {
"type": "string",
"description": "The owner (UUID) of the image.\n"
},
"protected": {
"type": "boolean",
"description": "Whether or not the image is protected.\n"
},
"sizeBytes": {
"type": "number",
"description": "The size of the image (in bytes).\n"
},
"status": {
"type": "string",
"description": "The status of the image.\n"
},
"updatedAt": {
"type": "string",
"description": "The date when the image was last updated.\n"
},
"visibility": {
"type": "string",
"description": "The visibility of the image. Must be one of\n**public**, **private**, **market** or **shared**.\n"
}
},
"type": "object",
"required": [
"backupId",
"checksum",
"containerFormat",
"createdAt",
"diskFormat",
"enterpriseProjectId",
"id",
"imageType",
"minDiskGb",
"minRamMb",
"name",
"os",
"osVersion",
"owner",
"protected",
"sizeBytes",
"status",
"updatedAt",
"visibility"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getLbListenersV2Listener:getLbListenersV2Listener": {
"properties": {
"connectionLimit": {
"type": "number",
"description": "The maximum number of connections allowed for the listener.\n"
},
"defaultPoolId": {
"type": "string",
"description": "The ID of the default pool with which the ELB listener is associated.\n"
},
"defaultTlsContainerRef": {
"type": "string",
"description": "The ID of the server certificate used by the listener.\n"
},
"description": {
"type": "string",
"description": "The description of the ELB listener.\n"
},
"http2Enable": {
"type": "boolean",
"description": "Whether the ELB listener uses HTTP/2.\n"
},
"id": {
"type": "string",
"description": "The ELB loadbalancer ID.\n"
},
"loadbalancers": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetLbListenersV2ListenerLoadbalancer:getLbListenersV2ListenerLoadbalancer"
},
"description": "Listener list.\nThe loadbalancers structure is documented below.\n"
},
"name": {
"type": "string",
"description": "The listener name.\n"
},
"protocol": {
"type": "string",
"description": "The listener protocol. \nThe valid values are **TCP**, **UDP**, **HTTP** and **TERMINATED_HTTPS**.\n"
},
"protocolPort": {
"type": "number",
"description": "The front-end listening port of the listener. \nThe valid value is range from `1` to `65535`.\n"
},
"sniContainerRefs": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of the SNI certificate (server certificates with a domain name) IDs used by the listener.\n"
}
},
"type": "object",
"required": [
"connectionLimit",
"defaultPoolId",
"defaultTlsContainerRef",
"description",
"http2Enable",
"id",
"loadbalancers",
"name",
"protocol",
"protocolPort",
"sniContainerRefs"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getLbListenersV2ListenerLoadbalancer:getLbListenersV2ListenerLoadbalancer": {
"properties": {
"id": {
"type": "string",
"description": "The ELB loadbalancer ID.\n"
}
},
"type": "object",
"required": [
"id"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getModelartsDatasetVersionsVersion:getModelartsDatasetVersionsVersion": {
"properties": {
"createdAt": {
"type": "string",
"description": "The creation time, in UTC format.\n"
},
"description": {
"type": "string",
"description": "The description of the dataset version.\n"
},
"files": {
"type": "number",
"description": "The total number of samples.\n"
},
"id": {
"type": "string",
"description": "The ID of the dataset version.\n"
},
"isCurrent": {
"type": "boolean",
"description": "Whether this version is current version.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the dataset version.\n"
},
"splitRatio": {
"type": "string",
"description": "Specifies the range of splitting ratio which randomly divides a labeled sample\ninto a training set and a validation set. Separate the minimum and maximum split ratios with commas,\nfor example: \"0.0,1.0\".\n"
},
"status": {
"type": "number",
"description": "Dataset version status. Valid values are as follows:\n+ **0**: Creating.\n+ **1**: Normal.\n+ **2**: Deleting.\n+ **3**: Deleted.\n+ **4**: Exception.\n"
},
"storagePath": {
"type": "string",
"description": "The path to save the manifest file of the version.\n"
},
"updatedAt": {
"type": "string",
"description": "The last update time, in UTC format.\n"
}
},
"type": "object",
"required": [
"createdAt",
"description",
"files",
"id",
"isCurrent",
"name",
"splitRatio",
"status",
"storagePath",
"updatedAt"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getModelartsDatasetsDataset:getModelartsDatasetsDataset": {
"properties": {
"createdAt": {
"type": "string",
"description": "The dataset creation time.\n"
},
"dataFormat": {
"type": "string",
"description": "The dataset format. Valid values include: `Default`, `CarbonData`: Carbon format(Supported only for\ntable type dataset.).\n"
},
"dataSources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetModelartsDatasetsDatasetDataSource:getModelartsDatasetsDatasetDataSource"
},
"description": "The data sources which is used to imported the source data (such as pictures/files/audio, etc.) in\nthis directory and subdirectories to the dataset. Structure is documented below.\n"
},
"description": {
"type": "string",
"description": "The description of the dataset.\n"
},
"id": {
"type": "string",
"description": "The ID of the dataset.\n"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetModelartsDatasetsDatasetLabel:getModelartsDatasetsDatasetLabel"
},
"description": "The labels information. Structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of datasets.\n"
},
"outputPath": {
"type": "string",
"description": "The OBS path for storing output files such as labeled files.\n"
},
"schemas": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetModelartsDatasetsDatasetSchema:getModelartsDatasetsDatasetSchema"
},
"description": "The schema information of source data when `type` is `400`(Table Type). Structure is documented below.\n"
},
"status": {
"type": "number",
"description": "Dataset status. Valid values are as follows:\n+ **0**: Creating.\n+ **1**: Completed.\n+ **2**: Deleting.\n+ **3**: Deleted.\n+ **4**: Exception.\n+ **5**: Syncing.\n+ **6**: Releasing.\n+ **7**: Version switching.\n+ **8**: Importing.\n"
},
"type": {
"type": "number",
"description": "Specifies the type of datasets. The options are:\n+ **0**: Image classification, supported formats: `.jpg`, `.png`, `.jpeg`, `.bmp`.\n+ **1**: Object detection, supported formats: `.jpg`, `.png`, `.jpeg`, `.bmp`.\n+ **3**: Image segmentation, supported formats: `.jpg`, `.png`, `.jpeg`, `.bmp`.\n+ **100**: Text classification, supported formats: `.txt`, `.csv`.\n+ **200**: Sound classification, Supported formats: `.wav`.\n+ **400**: Table type, supported formats: Carbon type.\n+ **600**: Video, supported formats: `.mp4`\n+ **900**: Free format.\n"
}
},
"type": "object",
"required": [
"createdAt",
"dataFormat",
"dataSources",
"description",
"id",
"labels",
"name",
"outputPath",
"schemas",
"status",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getModelartsDatasetsDatasetDataSource:getModelartsDatasetsDatasetDataSource": {
"properties": {
"dataType": {
"type": "number",
"description": "The type of data source. Valid values are as follows:\n+ *0*: OBS.\n+ *1*: GaussDB(DWS).\n+ *2*: DLI.\n+ *4*: MRS.\n"
},
"path": {
"type": "string",
"description": "The OBS path when `data_type` is `0`(OBS) or the HDFS path when `data_type` is `4`(MRS). All the file in this\ndirectory and subdirectories will be which be imported to the dataset.\n"
},
"withColumnHeader": {
"type": "boolean",
"description": "Whether the data contains table header when the type of dataset is `400`(Table type).\n"
}
},
"type": "object",
"required": [
"dataType",
"path",
"withColumnHeader"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getModelartsDatasetsDatasetLabel:getModelartsDatasetsDatasetLabel": {
"properties": {
"name": {
"type": "string",
"description": "Specifies the name of datasets.\n"
},
"propertyColor": {
"type": "string",
"description": "The color of label.\n"
},
"propertyShape": {
"type": "string",
"description": "The shape of label. Valid values include: `bndbox`, `polygon`, `circle`, `line`, `dashed`,\n`point`, `polyline`.\n"
},
"propertyShortcut": {
"type": "string",
"description": "The shortcut of label.\n"
}
},
"type": "object",
"required": [
"name",
"propertyColor",
"propertyShape",
"propertyShortcut"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getModelartsDatasetsDatasetSchema:getModelartsDatasetsDatasetSchema": {
"properties": {
"name": {
"type": "string",
"description": "Specifies the name of datasets.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of datasets. The options are:\n+ **0**: Image classification, supported formats: `.jpg`, `.png`, `.jpeg`, `.bmp`.\n+ **1**: Object detection, supported formats: `.jpg`, `.png`, `.jpeg`, `.bmp`.\n+ **3**: Image segmentation, supported formats: `.jpg`, `.png`, `.jpeg`, `.bmp`.\n+ **100**: Text classification, supported formats: `.txt`, `.csv`.\n+ **200**: Sound classification, Supported formats: `.wav`.\n+ **400**: Table type, supported formats: Carbon type.\n+ **600**: Video, supported formats: `.mp4`\n+ **900**: Free format.\n"
}
},
"type": "object",
"required": [
"name",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getModelartsModelTemplatesTemplate:getModelartsModelTemplatesTemplate": {
"properties": {
"arch": {
"type": "string"
},
"description": {
"type": "string",
"description": "The description of the input parameter.\n"
},
"engine": {
"type": "string",
"description": "The AI engine. \nThe valid values are **Caffe**, **Caffe1.0 CPU**, **Caffe1.0 GPU**, **MXNet**, **MXNet1.2.1**,\n**MindSpore**, **PyTorch**, **PyTorch1.0**, **TensorFlow**, and **TensorFlow1.8**.\n"
},
"environment": {
"type": "string",
"description": "Model runtime environment. \nThe valid values are **ascend-arm-py2.7**, **python2.7**, and **python3.6**.\n"
},
"id": {
"type": "string",
"description": "The ID of the input parameter.\n"
},
"name": {
"type": "string",
"description": "The name of the input parameter.\n"
},
"templateDocs": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetModelartsModelTemplatesTemplateTemplateDoc:getModelartsModelTemplatesTemplateTemplateDoc"
},
"description": "List of template description documents. \nThe template_docs structure is documented below.\n"
},
"templateInputs": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetModelartsModelTemplatesTemplateTemplateInput:getModelartsModelTemplatesTemplateTemplateInput"
},
"description": "List of input parameters for the model.\nThe template_inputs structure is documented below.\n"
},
"type": {
"type": "string",
"description": "The type of model. The valid values are **Classification** and **Common**.\n"
}
},
"type": "object",
"required": [
"arch",
"description",
"engine",
"environment",
"id",
"name",
"templateDocs",
"templateInputs",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getModelartsModelTemplatesTemplateTemplateDoc:getModelartsModelTemplatesTemplateTemplateDoc": {
"properties": {
"docName": {
"type": "string",
"description": "Document name.\n"
},
"docUrl": {
"type": "string",
"description": "HTTP(S) link of the document.\n"
}
},
"type": "object",
"required": [
"docName",
"docUrl"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getModelartsModelTemplatesTemplateTemplateInput:getModelartsModelTemplatesTemplateTemplateInput": {
"properties": {
"description": {
"type": "string",
"description": "The description of the input parameter.\n"
},
"id": {
"type": "string",
"description": "The ID of the input parameter.\n"
},
"name": {
"type": "string",
"description": "The name of the input parameter.\n"
},
"type": {
"type": "string",
"description": "The type of model. The valid values are **Classification** and **Common**.\n"
}
},
"type": "object",
"required": [
"description",
"id",
"name",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getObsBucketsBucket:getObsBucketsBucket": {
"properties": {
"bucket": {
"type": "string",
"description": "The name of the OBS bucket.\n"
},
"createdAt": {
"type": "string",
"description": "The date when the OBS bucket was created.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "The enterprise project id of the OBS bucket.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the OBS bucket.\nIf omitted, the provider-level region will be used.\n"
},
"storageClass": {
"type": "string",
"description": "The storage class of the OBS bucket.\n"
}
},
"type": "object",
"required": [
"bucket",
"createdAt",
"enterpriseProjectId",
"region",
"storageClass"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsBackupsBackup:getRdsBackupsBackup": {
"properties": {
"associatedWithDdm": {
"type": "boolean",
"description": "Whether a DDM instance has been associated.\n"
},
"beginTime": {
"type": "string",
"description": "Specifies the start time for obtaining the backup list.\nThe format of the start time is \"yyyy-mm-ddThh:mm:ssZ\".\n"
},
"databases": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetRdsBackupsBackupDatabase:getRdsBackupsBackupDatabase"
},
"description": "Database been backed up. The databases structure is documented below.\n"
},
"datastores": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetRdsBackupsBackupDatastore:getRdsBackupsBackupDatastore"
},
"description": "The database information. The datastore structure is documented below.\n"
},
"endTime": {
"type": "string",
"description": "Specifies the end time for obtaining the backup list.\nThe format of the end time is \"yyyy-mm-ddThh:mm:ssZ\" and the end time must be later than the start time.\n"
},
"id": {
"type": "string",
"description": "Backup ID.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the DB instance ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the backup name.\n"
},
"size": {
"type": "number",
"description": "Backup size in KB.\n"
},
"status": {
"type": "string",
"description": "Backup status. The options are as follows:\n- **BUILDING**: Backup in progress.\n- **COMPLETED**: Backup completed.\n- **FAILED**: Backup failed.\n- **DELETING**: Backup being deleted.\n"
},
"type": {
"type": "string",
"description": "DB engine. The value can be: **MySQL**, **PostgreSQL**, **SQL Server**, **MariaDB**.\n"
}
},
"type": "object",
"required": [
"associatedWithDdm",
"beginTime",
"databases",
"datastores",
"endTime",
"id",
"instanceId",
"name",
"size",
"status",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsBackupsBackupDatabase:getRdsBackupsBackupDatabase": {
"properties": {
"name": {
"type": "string",
"description": "Specifies the backup name.\n"
}
},
"type": "object",
"required": [
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsBackupsBackupDatastore:getRdsBackupsBackupDatastore": {
"properties": {
"type": {
"type": "string",
"description": "DB engine. The value can be: **MySQL**, **PostgreSQL**, **SQL Server**, **MariaDB**.\n"
},
"version": {
"type": "string",
"description": "DB engine version.\n"
}
},
"type": "object",
"required": [
"type",
"version"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsEngineVersionsVersion:getRdsEngineVersionsVersion": {
"properties": {
"id": {
"type": "string",
"description": "Indicates the database version ID. Its value is unique.\n"
},
"name": {
"type": "string",
"description": "Indicates the database version number. Only the major version number (two digits) is returned.\nFor example, if the version number is MySQL 5.6.X, only 5.6 is returned.\n"
}
},
"type": "object",
"required": [
"id",
"name"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsFlavorsV3Flavor:getRdsFlavorsV3Flavor": {
"properties": {
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The availability zones which the RDS flavor belongs to.\n"
},
"dbVersions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Available versions of the database.\n"
},
"groupType": {
"type": "string",
"description": "Specifies the performance specification, the valid values are as follows:\n- **normal**: General enhanced.\n- **normal2**: General enhanced type II.\n- **dedicatedNormal**: (dedicatedNormalLocalssd): Dedicated for x86.\n- **normalLocalssd**: x86 general type.\n- **general**: General type.\n- **bigmem**: Large memory type.\n"
},
"id": {
"type": "string",
"description": "The ID of the rds flavor.\n"
},
"instanceMode": {
"type": "string",
"description": "The mode of instance. Value: *ha*(indicates primary/standby instance),\n*single*(indicates single instance) and *replica*(indicates read replicas).\n"
},
"memory": {
"type": "number",
"description": "Specifies the memory size(GB) in the RDS flavor.\n"
},
"mode": {
"type": "string"
},
"name": {
"type": "string",
"description": "The name of the rds flavor.\n"
},
"vcpus": {
"type": "number",
"description": "Specifies the number of vCPUs in the RDS flavor.\n"
}
},
"type": "object",
"required": [
"availabilityZones",
"dbVersions",
"groupType",
"id",
"instanceMode",
"memory",
"mode",
"name",
"vcpus"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsInstancesInstance:getRdsInstancesInstance": {
"properties": {
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the availability zone where the node resides.\n"
},
"backupStrategies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetRdsInstancesInstanceBackupStrategy:getRdsInstancesInstanceBackupStrategy"
},
"description": "Indicates the advanced backup policy. The backup_strategy object structure\nis documented below.\n"
},
"created": {
"type": "string",
"description": "Indicates the creation time.\n"
},
"dbs": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetRdsInstancesInstanceDb:getRdsInstancesInstanceDb"
},
"description": "Indicates the database information. The db object structure is documented below.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id.\n"
},
"fixedIp": {
"type": "string",
"description": "Indicates the intranet floating IP address of the instance.\n"
},
"flavor": {
"type": "string",
"description": "Indicates the instance specifications.\n"
},
"haReplicationMode": {
"type": "string",
"description": "Indicates the replication mode for the standby DB instance.\n"
},
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the instance.\n"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetRdsInstancesInstanceNode:getRdsInstancesInstanceNode"
},
"description": "Indicates the instance nodes information. The nodes object structure is documented below.\n"
},
"paramGroupId": {
"type": "string",
"description": "Indicates the configuration ID.\n"
},
"privateIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the private ips in list.\n"
},
"publicIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the public ips in list.\n"
},
"region": {
"type": "string",
"description": "The region in which query obtain the instances. If omitted, the provider-level region\nwill be used.\n"
},
"securityGroupId": {
"type": "string",
"description": "Indicates the security group ID.\n"
},
"sslEnable": {
"type": "boolean",
"description": "Indicates whether to enable SSL.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the network ID of a subnet.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Indicates the tags of the instance.\n"
},
"timeZone": {
"type": "string",
"description": "Indicates the time zone.\n"
},
"volumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetRdsInstancesInstanceVolume:getRdsInstancesInstanceVolume"
},
"description": "Indicates the volume information. The volume object structure is documented below.\n"
},
"vpcId": {
"type": "string",
"description": "Specifies the VPC ID.\n"
}
},
"type": "object",
"required": [
"availabilityZones",
"backupStrategies",
"created",
"dbs",
"enterpriseProjectId",
"fixedIp",
"flavor",
"haReplicationMode",
"id",
"name",
"nodes",
"paramGroupId",
"privateIps",
"publicIps",
"region",
"securityGroupId",
"sslEnable",
"status",
"subnetId",
"tags",
"timeZone",
"volumes",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsInstancesInstanceBackupStrategy:getRdsInstancesInstanceBackupStrategy": {
"properties": {
"keepDays": {
"type": "number",
"description": "Indicates the number of days to retain the generated.\n"
},
"startTime": {
"type": "string",
"description": "Indicates the backup time window.\n"
}
},
"type": "object",
"required": [
"keepDays",
"startTime"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsInstancesInstanceDb:getRdsInstancesInstanceDb": {
"properties": {
"port": {
"type": "number",
"description": "Indicates the database port.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the instance. Valid values are:\n**Single**, **Ha**, **Replica**, and **Enterprise**.\n"
},
"userName": {
"type": "string",
"description": "Indicates the database username.\n"
},
"version": {
"type": "string",
"description": "Indicates the database version.\n"
}
},
"type": "object",
"required": [
"port",
"type",
"userName",
"version"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsInstancesInstanceNode:getRdsInstancesInstanceNode": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "Indicates the availability zone where the node resides.\n"
},
"id": {
"type": "string",
"description": "Indicates the node ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the instance.\n"
},
"role": {
"type": "string",
"description": "Indicates the node type.\n"
},
"status": {
"type": "string",
"description": "Indicates the node status.\n"
}
},
"type": "object",
"required": [
"availabilityZone",
"id",
"name",
"role",
"status"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsInstancesInstanceVolume:getRdsInstancesInstanceVolume": {
"properties": {
"diskEncryptionId": {
"type": "string",
"description": "Indicates the kms key id.\n"
},
"size": {
"type": "number",
"description": "Indicates the volume size.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the instance. Valid values are:\n**Single**, **Ha**, **Replica**, and **Enterprise**.\n"
}
},
"type": "object",
"required": [
"diskEncryptionId",
"size",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getRdsStorageTypesStorageType:getRdsStorageTypesStorageType": {
"properties": {
"azStatus": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The status details of the AZs to which the specification belongs.\nKey indicates the AZ ID, and value indicates the specification status in the AZ.\nThe options of value are as follows:\n- **normal**: The specifications in the AZ are available.\n- **unsupported**: The specifications are not supported by the AZ.\n- **sellout**: The specifications in the AZ are sold out.\n"
},
"name": {
"type": "string",
"description": "Indicates the storage type. Its value can be any of the following:\n- **COMMON**: Indicates the SATA type.\n- **ULTRAHIGH**: Indicates the SSD type.\n"
},
"supportComputeGroupTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Performance specifications.\nThe options are as follows:\n- **normal**: General-enhanced.\n- **normal2**: General-enhanced II.\n- **armFlavors**: Kunpeng general-enhanced.\n- **dedicicatenormal**: Exclusive x86.\n- **armlocalssd**: Standard Kunpeng.\n- **normallocalssd**: Standard x86.\n- **general**: General-purpose.\n- **dedicated**: Dedicated, which is only supported for cloud SSDs.\n- **rapid**: Dedicated, which is only supported for extreme SSDs.\n- **bigmen**: Large-memory.\n"
}
},
"type": "object",
"required": [
"azStatus",
"name",
"supportComputeGroupTypes"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getSfsTurbosTurbo:getSfsTurbosTurbo": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "The availability zone where the SFS turbo file system is located.\n"
},
"availableCapacity": {
"type": "string",
"description": "The available capacity of the SFS turbo file system, in GB.\n"
},
"cryptKeyId": {
"type": "string",
"description": "The ID of a KMS key to encrypt the SFS turbo file system.\n"
},
"enhanced": {
"type": "boolean",
"description": "Whether the SFS turbo file system is enhanced.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id of the SFS turbo file systems\nresource.\n"
},
"exportLocation": {
"type": "string",
"description": "The mount point of the SFS turbo file system.\n"
},
"id": {
"type": "string",
"description": "The resource ID of the SFS turbo file system.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the SFS turbo file system.\n"
},
"securityGroupId": {
"type": "string",
"description": "The ID of the security group to which the SFS turbo belongs.\n"
},
"shareProto": {
"type": "string",
"description": "Specifies the protocol of the SFS turbo file system. The valid value is **NFS**.\n"
},
"shareType": {
"type": "string",
"description": "Specifies the type of the SFS turbo file system.\nThe valid values are **STANDARD** and **PERFORMANCE**.\n"
},
"size": {
"type": "number",
"description": "Specifies the capacity of the SFS turbo file system, in GB.\nThe value ranges from `500` to `32,768`, and must be larger than `10,240` for an enhanced file system.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the VPC Subnet to which the SFS turbo belongs.\n"
},
"version": {
"type": "string",
"description": "The version of the SFS turbo file system.\n"
},
"vpcId": {
"type": "string",
"description": "The ID of the VPC to which the SFS turbo belongs.\n"
}
},
"type": "object",
"required": [
"availabilityZone",
"availableCapacity",
"cryptKeyId",
"enhanced",
"enterpriseProjectId",
"exportLocation",
"id",
"name",
"securityGroupId",
"shareProto",
"shareType",
"size",
"subnetId",
"version",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getSmnMessageTemplatesTemplate:getSmnMessageTemplatesTemplate": {
"properties": {
"createdAt": {
"type": "string",
"description": "Indicates the create time.\n"
},
"id": {
"type": "string",
"description": "Indicates the message template ID.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the message template.\n"
},
"protocol": {
"type": "string",
"description": "Specifies the protocol of the message template.\n"
},
"tagNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicates the variable list. The variable name will be quoted in braces ({}) in the template.\nWhen you use a template to send messages, you can replace the variable with any content.\n"
},
"updatedAt": {
"type": "string",
"description": "Indicates the update time.\n"
}
},
"type": "object",
"required": [
"createdAt",
"id",
"name",
"protocol",
"tagNames",
"updatedAt"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getSmnTopicsTopic:getSmnTopicsTopic": {
"properties": {
"displayName": {
"type": "string",
"description": "Specifies the topic display name.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id of the topic.\n"
},
"id": {
"type": "string",
"description": "The topic ID. The value is the topic URN.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the topic.\n"
},
"pushPolicy": {
"type": "number",
"description": "Message pushing policy.\n+ **0**: indicates that the message sending fails and the message is cached in the queue.\n+ **1**: indicates that the failed message is discarded.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"topicUrn": {
"type": "string",
"description": "Specifies the topic URN.\n"
}
},
"type": "object",
"required": [
"displayName",
"enterpriseProjectId",
"id",
"name",
"pushPolicy",
"tags",
"topicUrn"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getSmsSourceServersServer:getSmsSourceServersServer": {
"properties": {
"agentVersion": {
"type": "string",
"description": "The version of Agent installed on the source server.\n"
},
"connected": {
"type": "boolean",
"description": "Whether the source server is properly connected to SMS.\n"
},
"disks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetSmsSourceServersServerDisk:getSmsSourceServersServerDisk"
},
"description": "The disk information of the source server. The disks object structure is documented below.\n"
},
"id": {
"type": "string",
"description": "Specifies the ID of the source server.\n"
},
"ip": {
"type": "string",
"description": "Specifies the IP address of the source server.\n"
},
"memory": {
"type": "number",
"description": "The memory size in MB.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the source server.\n"
},
"osType": {
"type": "string",
"description": "The OS type of the source server. The value can be **WINDOWS** and **LINUX**.\n"
},
"osVersion": {
"type": "string",
"description": "The OS version of the source server, for example, UBUNTU_20_4_64BIT.\n"
},
"registeredTime": {
"type": "string",
"description": "The UTC time when the source server is registered.\n"
},
"state": {
"type": "string",
"description": "Specifies the status of the source server.\n"
},
"vcpus": {
"type": "number",
"description": "The vcpus count of the source server.\n"
}
},
"type": "object",
"required": [
"agentVersion",
"connected",
"disks",
"id",
"ip",
"memory",
"name",
"osType",
"osVersion",
"registeredTime",
"state",
"vcpus"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getSmsSourceServersServerDisk:getSmsSourceServersServerDisk": {
"properties": {
"deviceType": {
"type": "string",
"description": "The disk type. The value can be **BOOT**, **OS** and **NORMAL**.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the source server.\n"
},
"size": {
"type": "number",
"description": "The disk size in MB.\n"
}
},
"type": "object",
"required": [
"deviceType",
"name",
"size"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getVpcRouteTableRoute:getVpcRouteTableRoute": {
"properties": {
"description": {
"type": "string",
"description": "(String) - The description about the route.\n"
},
"destination": {
"type": "string",
"description": "(String) - The destination address in the CIDR notation format\n"
},
"nexthop": {
"type": "string",
"description": "(String) - The next hop.\n"
},
"type": {
"type": "string",
"description": "(String) - The route type.\n"
}
},
"type": "object",
"required": [
"description",
"destination",
"nexthop",
"type"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getVpcSubnetsSubnet:getVpcSubnetsSubnet": {
"properties": {
"availabilityZone": {
"type": "string",
"description": "Specifies the availability zone (AZ) to which the desired subnet belongs to.\n"
},
"cidr": {
"type": "string",
"description": "Specifies the network segment of desired subnet. The value must be in CIDR format.\n"
},
"description": {
"type": "string"
},
"dhcpEnable": {
"type": "boolean"
},
"dnsLists": {
"type": "array",
"items": {
"type": "string"
}
},
"gatewayIp": {
"type": "string",
"description": "Specifies the subnet gateway address of desired subnet.\n"
},
"id": {
"type": "string",
"description": "Specifies the id of the desired subnet.\n"
},
"ipv4SubnetId": {
"type": "string"
},
"ipv6Cidr": {
"type": "string"
},
"ipv6Enable": {
"type": "boolean"
},
"ipv6Gateway": {
"type": "string"
},
"ipv6SubnetId": {
"type": "string"
},
"name": {
"type": "string",
"description": "Specifies the name of the desired subnet.\n"
},
"primaryDns": {
"type": "string",
"description": "Specifies the IP address of DNS server 1 on the desired subnet.\n"
},
"secondaryDns": {
"type": "string",
"description": "Specifies the IP address of DNS server 2 on the desired subnet.\n"
},
"status": {
"type": "string",
"description": "Specifies the current status of the desired subnet.\nthe value can be ACTIVE, DOWN, UNKNOWN, or ERROR.\n"
},
"subnetId": {
"type": "string"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the included key/value pairs which associated with the desired subnet.\n\n> A maximum of 10 tag keys are allowed for each query operation. Each tag key can have up to 10 tag values.\nThe tag key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a\ntag must be unique, use commas(,) to separate the multiple values. An empty for values indicates any value.\nThe values are in the OR relationship.\n"
},
"vpcId": {
"type": "string",
"description": "Specifies the id of the VPC that the desired subnet belongs to.\n"
}
},
"type": "object",
"required": [
"availabilityZone",
"cidr",
"description",
"dhcpEnable",
"dnsLists",
"gatewayIp",
"id",
"ipv4SubnetId",
"ipv6Cidr",
"ipv6Enable",
"ipv6Gateway",
"ipv6SubnetId",
"name",
"primaryDns",
"secondaryDns",
"status",
"subnetId",
"tags",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getVpcV1Route:getVpcV1Route": {
"properties": {
"destination": {
"type": "string",
"description": "The destination network segment of a route.\n"
},
"nexthop": {
"type": "string",
"description": "The next hop of a route.\n"
}
},
"type": "object",
"required": [
"destination",
"nexthop"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getVpcepEndpointsEndpoint:getVpcepEndpointsEndpoint": {
"properties": {
"createdAt": {
"type": "string",
"description": "Creation date of the VPC endpoint.\n"
},
"enableDns": {
"type": "boolean",
"description": "Flag indicating dns has been enabled for the VPC endpoint.\n"
},
"enableWhitelist": {
"type": "boolean",
"description": "Flag indicating access control have been enabled on this VPC endpoint.\n"
},
"id": {
"type": "string",
"description": "The unique ID of the public VPC endpoint service.\n"
},
"ipAddress": {
"type": "string",
"description": "The IP of the VPC endpoint.\n"
},
"networkId": {
"type": "string",
"description": "The ID of the subnet holding the VPC endpoint.\n"
},
"packetId": {
"type": "number",
"description": "The marker id of the VPC endpoint.\n"
},
"privateDomainName": {
"type": "string",
"description": "DNS name pointing to the VPC endpoint ip.\n"
},
"projectId": {
"type": "string",
"description": "The ID of the project holding the VPC endpoint.\n"
},
"serviceId": {
"type": "string",
"description": "The ID of the VPC endpoint service.\n"
},
"serviceName": {
"type": "string",
"description": "Specifies the name of the VPC endpoint service.\nThe value is not case-sensitive and supports fuzzy match.\n"
},
"serviceType": {
"type": "string",
"description": "The type of the VPC endpoint.\n"
},
"status": {
"type": "string",
"description": "The connection status of the VPC endpoint.\n"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FgetVpcepEndpointsEndpointTag:getVpcepEndpointsEndpointTag"
},
"description": "The key/value pairs to associate with the VPC endpoint.\n"
},
"updatedAt": {
"type": "string",
"description": "Last update date of the VPC endpoint.\n"
},
"vpcId": {
"type": "string",
"description": "Specifies the unique ID of the vpc holding the VPC endpoint service.\n"
},
"whitelists": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of IP or CIDR block which can access the VPC endpoint.\n"
}
},
"type": "object",
"required": [
"createdAt",
"enableDns",
"enableWhitelist",
"id",
"ipAddress",
"networkId",
"packetId",
"privateDomainName",
"projectId",
"serviceId",
"serviceName",
"serviceType",
"status",
"tags",
"updatedAt",
"vpcId",
"whitelists"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getVpcepEndpointsEndpointTag:getVpcepEndpointsEndpointTag": {
"properties": {
"key": {
"type": "string",
"description": "The tag key. Each tag key contains a maximum of 127 unicode characters but cannot be left blank.\n"
},
"value": {
"type": "string",
"description": "The tag value list. Each value contains a maximum of 255 Unicode characters.\nBefore using values, delete SBC spaces before and after the value.\n"
}
},
"type": "object",
"required": [
"key",
"value"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getVpcepPublicServicesService:getVpcepPublicServicesService": {
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the public VPC endpoint service.\n"
},
"isCharge": {
"type": "boolean",
"description": "Indicates whether the associated VPC endpoint carries a charge.\n"
},
"owner": {
"type": "string",
"description": "The owner of the VPC endpoint service.\n"
},
"serviceName": {
"type": "string",
"description": "Specifies the name of the public VPC endpoint service.\nThe value is not case-sensitive and supports fuzzy match.\n"
},
"serviceType": {
"type": "string",
"description": "The type of the VPC endpoint service.\n"
}
},
"type": "object",
"required": [
"id",
"isCharge",
"owner",
"serviceName",
"serviceType"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getVpcsVpc:getVpcsVpc": {
"properties": {
"cidr": {
"type": "string",
"description": "Specifies the cidr block of the desired VPC.\n"
},
"description": {
"type": "string",
"description": "Indicates the description of the VPC.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project ID which the desired VPC belongs to.\n"
},
"id": {
"type": "string",
"description": "Specifies the id of the desired VPC.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the desired VPC. The value is a string of no more than 64 characters\nand can contain digits, letters, underscores (_) and hyphens (-).\n"
},
"status": {
"type": "string",
"description": "Specifies the current status of the desired VPC. The value can be CREATING, OK or ERROR.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the included key/value pairs which associated with the desired VPC.\n\n> A maximum of 10 tag keys are allowed for each query operation. Each tag key can have up to 10 tag values.\nThe tag key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a\ntag must be unique, use commas(,) to separate the multiple values. An empty for values indicates any value.\nThe values are in the OR relationship.\n"
}
},
"type": "object",
"required": [
"cidr",
"description",
"enterpriseProjectId",
"id",
"name",
"status",
"tags"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
},
"flexibleengine:index/getWafDedicatedInstancesInstance:getWafDedicatedInstancesInstance": {
"properties": {
"accessStatus": {
"type": "number",
"description": "The access status of the instance. `0`: inaccessible, `1`: accessible.\n"
},
"availableZone": {
"type": "string",
"description": "The available zone names for the WAF dedicated instances.\n"
},
"cpuArchitecture": {
"type": "string",
"description": "The ECS cpu architecture of WAF dedicated instance.\n"
},
"ecsFlavor": {
"type": "string",
"description": "The flavor of the ECS used by the WAF instance.\n"
},
"groupId": {
"type": "string",
"description": "The instance group ID used by the WAF dedicated instance in ELB mode.\n"
},
"id": {
"type": "string",
"description": "The id of WAF dedicated instance.\n"
},
"name": {
"type": "string",
"description": "The name of WAF dedicated instance.\n"
},
"runStatus": {
"type": "number",
"description": "The running status of the instance. Values are:\n"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "The security group of the instance. This is an array of security group ids.\n"
},
"serverId": {
"type": "string",
"description": "The service of the instance.\n"
},
"serviceIp": {
"type": "string",
"description": "The service ip of the instance.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the VPC Subnet of WAF dedicated instance VPC.\n"
},
"upgradable": {
"type": "number",
"description": "The instance is to support upgrades. `0`: Cannot be upgraded, `1`: Can be upgraded.\n"
},
"vpcId": {
"type": "string",
"description": "The VPC id of WAF dedicated instance.\n"
}
},
"type": "object",
"required": [
"accessStatus",
"availableZone",
"cpuArchitecture",
"ecsFlavor",
"groupId",
"id",
"name",
"runStatus",
"securityGroups",
"serverId",
"serviceIp",
"subnetId",
"upgradable",
"vpcId"
],
"language": {
"nodejs": {
"requiredInputs": []
}
}
}
},
"provider": {
"description": "The provider type for the flexibleengine 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 of the FlexibleEngine cloud to use.\n"
},
"authUrl": {
"type": "string",
"description": "The Identity authentication URL.\n"
},
"cacertFile": {
"type": "string",
"description": "A Custom CA certificate.\n"
},
"cert": {
"type": "string",
"description": "A client certificate to authenticate with.\n"
},
"cloud": {
"type": "string",
"description": "The endpoint of cloud provider, defaults to prod-cloud-ocb.orange-business.com\n"
},
"domainId": {
"type": "string",
"description": "The ID of the Domain to scope to (Identity v3).\n"
},
"domainName": {
"type": "string",
"description": "The name of the Domain to scope to (Identity v3).\n"
},
"key": {
"type": "string",
"description": "A client private key to authenticate with.\n"
},
"password": {
"type": "string",
"description": "Password to login with.\n",
"secret": true
},
"region": {
"type": "string",
"description": "The FlexibleEngine region to connect to.\n"
},
"secretKey": {
"type": "string",
"description": "The secret key of the FlexibleEngine cloud to use.\n"
},
"securityToken": {
"type": "string",
"description": "The security token to authenticate with a temporary security credential.\n"
},
"tenantId": {
"type": "string",
"description": "The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.\n"
},
"tenantName": {
"type": "string",
"description": "The name of the Tenant (Identity v2) or Project (Identity v3) to login with.\n"
},
"token": {
"type": "string",
"description": "Authentication token to use as an alternative to username/password.\n"
},
"userId": {
"type": "string",
"description": "User ID to login with.\n"
},
"userName": {
"type": "string",
"description": "Username to login with.\n"
}
},
"type": "object",
"required": [
"region"
],
"inputProperties": {
"accessKey": {
"type": "string",
"description": "The access key of the FlexibleEngine cloud to use.\n"
},
"authUrl": {
"type": "string",
"description": "The Identity authentication URL.\n"
},
"cacertFile": {
"type": "string",
"description": "A Custom CA certificate.\n"
},
"cert": {
"type": "string",
"description": "A client certificate to authenticate with.\n"
},
"cloud": {
"type": "string",
"description": "The endpoint of cloud provider, defaults to prod-cloud-ocb.orange-business.com\n"
},
"domainId": {
"type": "string",
"description": "The ID of the Domain to scope to (Identity v3).\n"
},
"domainName": {
"type": "string",
"description": "The name of the Domain to scope to (Identity v3).\n"
},
"endpoints": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Experimental Feature: the custom endpoints used to override the default endpoint URL\n"
},
"insecure": {
"type": "boolean",
"description": "Trust self-signed certificates.\n"
},
"key": {
"type": "string",
"description": "A client private key to authenticate with.\n"
},
"maxRetries": {
"type": "number",
"description": "How many times HTTP connection should be retried until giving up.\n"
},
"password": {
"type": "string",
"description": "Password to login with.\n",
"secret": true
},
"region": {
"type": "string",
"description": "The FlexibleEngine region to connect to.\n"
},
"secretKey": {
"type": "string",
"description": "The secret key of the FlexibleEngine cloud to use.\n"
},
"securityToken": {
"type": "string",
"description": "The security token to authenticate with a temporary security credential.\n"
},
"tenantId": {
"type": "string",
"description": "The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.\n"
},
"tenantName": {
"type": "string",
"description": "The name of the Tenant (Identity v2) or Project (Identity v3) to login with.\n"
},
"token": {
"type": "string",
"description": "Authentication token to use as an alternative to username/password.\n"
},
"userId": {
"type": "string",
"description": "User ID to login with.\n"
},
"userName": {
"type": "string",
"description": "Username to login with.\n"
}
},
"requiredInputs": [
"region"
]
},
"resources": {
"flexibleengine:index/antiddosV1:AntiddosV1": {
"description": "Anti-DDoS monitors the service traffic from the Internet to ECSs, ELB instances, and BMSs to detect attack traffic\nin real time. It then cleans attack traffic according to user-configured defense policies so that services run as normal.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst eipId = config.requireObject(\"eipId\");\nconst myantiddos = new flexibleengine.AntiddosV1(\"myantiddos\", {\n floatingIpId: eipId,\n enableL7: true,\n trafficPosId: 1,\n httpRequestPosId: 3,\n cleaningAccessPosId: 2,\n appTypeId: 0,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\neip_id = config.require_object(\"eipId\")\nmyantiddos = flexibleengine.AntiddosV1(\"myantiddos\",\n floating_ip_id=eip_id,\n enable_l7=True,\n traffic_pos_id=1,\n http_request_pos_id=3,\n cleaning_access_pos_id=2,\n app_type_id=0)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var eipId = config.RequireObject(\"eipId\");\n var myantiddos = new Flexibleengine.AntiddosV1(\"myantiddos\", new()\n {\n FloatingIpId = eipId,\n EnableL7 = true,\n TrafficPosId = 1,\n HttpRequestPosId = 3,\n CleaningAccessPosId = 2,\n AppTypeId = 0,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\teipId := cfg.RequireObject(\"eipId\")\n\t\t_, err := flexibleengine.NewAntiddosV1(ctx, \"myantiddos\", &flexibleengine.AntiddosV1Args{\n\t\t\tFloatingIpId: pulumi.Any(eipId),\n\t\t\tEnableL7: pulumi.Bool(true),\n\t\t\tTrafficPosId: pulumi.Float64(1),\n\t\t\tHttpRequestPosId: pulumi.Float64(3),\n\t\t\tCleaningAccessPosId: pulumi.Float64(2),\n\t\t\tAppTypeId: pulumi.Float64(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.pulumi.flexibleengine.AntiddosV1;\nimport com.pulumi.flexibleengine.AntiddosV1Args;\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 final var config = ctx.config();\n final var eipId = config.get(\"eipId\");\n var myantiddos = new AntiddosV1(\"myantiddos\", AntiddosV1Args.builder()\n .floatingIpId(eipId)\n .enableL7(true)\n .trafficPosId(1)\n .httpRequestPosId(3)\n .cleaningAccessPosId(2)\n .appTypeId(0)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n eipId:\n type: dynamic\nresources:\n myantiddos:\n type: flexibleengine:AntiddosV1\n properties:\n floatingIpId: ${eipId}\n enableL7: true\n trafficPosId: 1\n httpRequestPosId: 3\n cleaningAccessPosId: 2\n appTypeId: 0\n```\n\n\n## Import\n\nAntiddos can be imported using the `floating_ip_id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/antiddosV1:AntiddosV1 myantiddos c1881895-cdcb-4d23-96cb-032e6a3ee667\n```\n\n",
"properties": {
"antiddosV1Id": {
"type": "string"
},
"appTypeId": {
"type": "number",
"description": "The application type ID.\n"
},
"cleaningAccessPosId": {
"type": "number",
"description": "The position ID of access limit during cleaning. The value ranges from 1 to 8.\n"
},
"enableL7": {
"type": "boolean",
"description": "Specifies whether to enable L7 defense.\n"
},
"floatingIpId": {
"type": "string",
"description": "The ID corresponding to the Elastic IP Address (EIP).\n"
},
"httpRequestPosId": {
"type": "number",
"description": "The position ID of number of HTTP requests. The value ranges from 1 to 15.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to manage the Cloud Native Anti-DDos Basic resource.\nIf omitted, the provider-level region will be used. Changing this creates a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAntiddosV1Timeouts:AntiddosV1Timeouts"
},
"trafficPosId": {
"type": "number",
"description": "The position ID of traffic. The value ranges from 1 to 9.\n"
}
},
"type": "object",
"required": [
"antiddosV1Id",
"appTypeId",
"cleaningAccessPosId",
"enableL7",
"floatingIpId",
"httpRequestPosId",
"region",
"trafficPosId"
],
"inputProperties": {
"antiddosV1Id": {
"type": "string"
},
"appTypeId": {
"type": "number",
"description": "The application type ID.\n"
},
"cleaningAccessPosId": {
"type": "number",
"description": "The position ID of access limit during cleaning. The value ranges from 1 to 8.\n"
},
"enableL7": {
"type": "boolean",
"description": "Specifies whether to enable L7 defense.\n"
},
"floatingIpId": {
"type": "string",
"description": "The ID corresponding to the Elastic IP Address (EIP).\n"
},
"httpRequestPosId": {
"type": "number",
"description": "The position ID of number of HTTP requests. The value ranges from 1 to 15.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to manage the Cloud Native Anti-DDos Basic resource.\nIf omitted, the provider-level region will be used. Changing this creates a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAntiddosV1Timeouts:AntiddosV1Timeouts"
},
"trafficPosId": {
"type": "number",
"description": "The position ID of traffic. The value ranges from 1 to 9.\n"
}
},
"requiredInputs": [
"appTypeId",
"cleaningAccessPosId",
"enableL7",
"floatingIpId",
"httpRequestPosId",
"trafficPosId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AntiddosV1 resources.\n",
"properties": {
"antiddosV1Id": {
"type": "string"
},
"appTypeId": {
"type": "number",
"description": "The application type ID.\n"
},
"cleaningAccessPosId": {
"type": "number",
"description": "The position ID of access limit during cleaning. The value ranges from 1 to 8.\n"
},
"enableL7": {
"type": "boolean",
"description": "Specifies whether to enable L7 defense.\n"
},
"floatingIpId": {
"type": "string",
"description": "The ID corresponding to the Elastic IP Address (EIP).\n"
},
"httpRequestPosId": {
"type": "number",
"description": "The position ID of number of HTTP requests. The value ranges from 1 to 15.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to manage the Cloud Native Anti-DDos Basic resource.\nIf omitted, the provider-level region will be used. Changing this creates a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAntiddosV1Timeouts:AntiddosV1Timeouts"
},
"trafficPosId": {
"type": "number",
"description": "The position ID of traffic. The value ranges from 1 to 9.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/aomServiceDiscoveryRule:AomServiceDiscoveryRule": {
"description": "Manages an AOM service discovery rule resource within FlexibleEngine.\n\n## Example Usage\n\n### Basic example\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst discoveryRule = new flexibleengine.AomServiceDiscoveryRule(\"discoveryRule\", {\n detectLogEnabled: true,\n discoveryRuleEnabled: true,\n discoveryRules: [{\n checkContents: [\"java\"],\n checkMode: \"contain\",\n checkType: \"cmdLine\",\n }],\n isDefaultRule: false,\n logFileSuffixes: [\"log\"],\n logPathRules: [{\n args: [\"java\"],\n nameType: \"cmdLineHash\",\n values: [\"/tmp/log\"],\n }],\n nameRules: {\n applicationNameRules: [{\n args: [\"java\"],\n nameType: \"str\",\n }],\n serviceNameRules: [{\n args: [\"java\"],\n nameType: \"str\",\n }],\n },\n priority: 9999,\n serviceType: \"Java\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\ndiscovery_rule = flexibleengine.AomServiceDiscoveryRule(\"discoveryRule\",\n detect_log_enabled=True,\n discovery_rule_enabled=True,\n discovery_rules=[{\n \"check_contents\": [\"java\"],\n \"check_mode\": \"contain\",\n \"check_type\": \"cmdLine\",\n }],\n is_default_rule=False,\n log_file_suffixes=[\"log\"],\n log_path_rules=[{\n \"args\": [\"java\"],\n \"name_type\": \"cmdLineHash\",\n \"values\": [\"/tmp/log\"],\n }],\n name_rules={\n \"application_name_rules\": [{\n \"args\": [\"java\"],\n \"name_type\": \"str\",\n }],\n \"service_name_rules\": [{\n \"args\": [\"java\"],\n \"name_type\": \"str\",\n }],\n },\n priority=9999,\n service_type=\"Java\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var discoveryRule = new Flexibleengine.AomServiceDiscoveryRule(\"discoveryRule\", new()\n {\n DetectLogEnabled = true,\n DiscoveryRuleEnabled = true,\n DiscoveryRules = new[]\n {\n new Flexibleengine.Inputs.AomServiceDiscoveryRuleDiscoveryRuleArgs\n {\n CheckContents = new[]\n {\n \"java\",\n },\n CheckMode = \"contain\",\n CheckType = \"cmdLine\",\n },\n },\n IsDefaultRule = false,\n LogFileSuffixes = new[]\n {\n \"log\",\n },\n LogPathRules = new[]\n {\n new Flexibleengine.Inputs.AomServiceDiscoveryRuleLogPathRuleArgs\n {\n Args = new[]\n {\n \"java\",\n },\n NameType = \"cmdLineHash\",\n Values = new[]\n {\n \"/tmp/log\",\n },\n },\n },\n NameRules = new Flexibleengine.Inputs.AomServiceDiscoveryRuleNameRulesArgs\n {\n ApplicationNameRules = new[]\n {\n new Flexibleengine.Inputs.AomServiceDiscoveryRuleNameRulesApplicationNameRuleArgs\n {\n Args = new[]\n {\n \"java\",\n },\n NameType = \"str\",\n },\n },\n ServiceNameRules = new[]\n {\n new Flexibleengine.Inputs.AomServiceDiscoveryRuleNameRulesServiceNameRuleArgs\n {\n Args = new[]\n {\n \"java\",\n },\n NameType = \"str\",\n },\n },\n },\n Priority = 9999,\n ServiceType = \"Java\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewAomServiceDiscoveryRule(ctx, \"discoveryRule\", &flexibleengine.AomServiceDiscoveryRuleArgs{\n\t\t\tDetectLogEnabled: pulumi.Bool(true),\n\t\t\tDiscoveryRuleEnabled: pulumi.Bool(true),\n\t\t\tDiscoveryRules: flexibleengine.AomServiceDiscoveryRuleDiscoveryRuleArray{\n\t\t\t\t&flexibleengine.AomServiceDiscoveryRuleDiscoveryRuleArgs{\n\t\t\t\t\tCheckContents: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"java\"),\n\t\t\t\t\t},\n\t\t\t\t\tCheckMode: pulumi.String(\"contain\"),\n\t\t\t\t\tCheckType: pulumi.String(\"cmdLine\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tIsDefaultRule: pulumi.Bool(false),\n\t\t\tLogFileSuffixes: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"log\"),\n\t\t\t},\n\t\t\tLogPathRules: flexibleengine.AomServiceDiscoveryRuleLogPathRuleArray{\n\t\t\t\t&flexibleengine.AomServiceDiscoveryRuleLogPathRuleArgs{\n\t\t\t\t\tArgs: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"java\"),\n\t\t\t\t\t},\n\t\t\t\t\tNameType: pulumi.String(\"cmdLineHash\"),\n\t\t\t\t\tValues: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"/tmp/log\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tNameRules: &flexibleengine.AomServiceDiscoveryRuleNameRulesArgs{\n\t\t\t\tApplicationNameRules: flexibleengine.AomServiceDiscoveryRuleNameRulesApplicationNameRuleArray{\n\t\t\t\t\t&flexibleengine.AomServiceDiscoveryRuleNameRulesApplicationNameRuleArgs{\n\t\t\t\t\t\tArgs: pulumi.StringArray{\n\t\t\t\t\t\t\tpulumi.String(\"java\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t\tNameType: pulumi.String(\"str\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tServiceNameRules: flexibleengine.AomServiceDiscoveryRuleNameRulesServiceNameRuleArray{\n\t\t\t\t\t&flexibleengine.AomServiceDiscoveryRuleNameRulesServiceNameRuleArgs{\n\t\t\t\t\t\tArgs: pulumi.StringArray{\n\t\t\t\t\t\t\tpulumi.String(\"java\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t\tNameType: pulumi.String(\"str\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tPriority: pulumi.Float64(9999),\n\t\t\tServiceType: pulumi.String(\"Java\"),\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.flexibleengine.AomServiceDiscoveryRule;\nimport com.pulumi.flexibleengine.AomServiceDiscoveryRuleArgs;\nimport com.pulumi.flexibleengine.inputs.AomServiceDiscoveryRuleDiscoveryRuleArgs;\nimport com.pulumi.flexibleengine.inputs.AomServiceDiscoveryRuleLogPathRuleArgs;\nimport com.pulumi.flexibleengine.inputs.AomServiceDiscoveryRuleNameRulesArgs;\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 discoveryRule = new AomServiceDiscoveryRule(\"discoveryRule\", AomServiceDiscoveryRuleArgs.builder()\n .detectLogEnabled(\"true\")\n .discoveryRuleEnabled(\"true\")\n .discoveryRules(AomServiceDiscoveryRuleDiscoveryRuleArgs.builder()\n .checkContents(\"java\")\n .checkMode(\"contain\")\n .checkType(\"cmdLine\")\n .build())\n .isDefaultRule(\"false\")\n .logFileSuffixes(\"log\")\n .logPathRules(AomServiceDiscoveryRuleLogPathRuleArgs.builder()\n .args(\"java\")\n .nameType(\"cmdLineHash\")\n .values(\"/tmp/log\")\n .build())\n .nameRules(AomServiceDiscoveryRuleNameRulesArgs.builder()\n .applicationNameRules(AomServiceDiscoveryRuleNameRulesApplicationNameRuleArgs.builder()\n .args(\"java\")\n .nameType(\"str\")\n .build())\n .serviceNameRules(AomServiceDiscoveryRuleNameRulesServiceNameRuleArgs.builder()\n .args(\"java\")\n .nameType(\"str\")\n .build())\n .build())\n .priority(9999)\n .serviceType(\"Java\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n discoveryRule:\n type: flexibleengine:AomServiceDiscoveryRule\n properties:\n detectLogEnabled: 'true'\n discoveryRuleEnabled: 'true'\n discoveryRules:\n - checkContents:\n - java\n checkMode: contain\n checkType: cmdLine\n isDefaultRule: 'false'\n logFileSuffixes:\n - log\n logPathRules:\n - args:\n - java\n nameType: cmdLineHash\n values:\n - /tmp/log\n nameRules:\n applicationNameRules:\n - args:\n - java\n nameType: str\n serviceNameRules:\n - args:\n - java\n nameType: str\n priority: 9999\n serviceType: Java\n```\n\n\n## Import\n\nAOM service discovery rules can be imported using the `name`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/aomServiceDiscoveryRule:AomServiceDiscoveryRule alarm_rule rule_name\n```\n\n",
"properties": {
"aomServiceDiscoveryRuleId": {
"type": "string",
"description": "Indicates the resource ID of the service discovery rule. The value is the rule name.\n"
},
"detectLogEnabled": {
"type": "boolean",
"description": "Specifies whether to enable log collection. The default value is true.\n"
},
"discoveryRuleEnabled": {
"type": "boolean",
"description": "Specifies whether the rule is enabled. The default value is true.\n"
},
"discoveryRules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleDiscoveryRule:AomServiceDiscoveryRuleDiscoveryRule"
},
"description": "Specifies the discovery rule. If the array contains multiple conditions, only the\nprocesses that meet all the conditions will be matched. If the value of `check_type` is **cmdLine**, set the value of\n`check_mode` to **contain**. `check_content` is in the format of [\"xxx\"], indicating that the process must contain\nthe xxx parameter. If the value of `check_type` is **env**, set the value of `check_mode` to **contain**.\n`check_content` is in the format of [\"k1\",\"v1\"], indicating that the process must contain the environment variable\nwhose name is k1 and value is v1. If the value of `check_type` is **scope**, set the value of `check_mode`\nto **equals**. `check_content` is in the format of [\"hostId1\",\"hostId2\"], indicating that the rule takes effect only\non specified nodes. If no nodes are specified, the rule applies to all nodes of the project.\n"
},
"isDefaultRule": {
"type": "boolean",
"description": "Specifies whether the rule is the default one. The default value is false.\n"
},
"logFileSuffixes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the log file suffix. This is a list of strings.\nThe values can be: **log**, **trace**, and **out**.\n"
},
"logPathRules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleLogPathRule:AomServiceDiscoveryRuleLogPathRule"
},
"description": "Specifies the log path configuration rule. If cmdLineHash is a fixed string,\nlogs in the specified log path or log file are collected. Otherwise, only the files whose names end with\n.log or .trace are collected. If the value of `name_type` is **cmdLineHash**, args is in the format of [\"00001\"] and\nvalue is in the format of [\"/xxx/xx.log\"], indicating that the log path is /xxx/xx.log when the startup command is 00001.\n"
},
"name": {
"type": "string",
"description": "Specifies the rule name, which contains 4 to 63 characters. It must start\nwith a lowercase letter but cannot end with a hyphen (-). Only digits, lowercase letters, and hyphens are allowed.\n"
},
"nameRules": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleNameRules:AomServiceDiscoveryRuleNameRules",
"description": "Specifies the naming rules for discovered services and applications.\nThe object structure is documented below.\n"
},
"priority": {
"type": "number",
"description": "Specifies the rule priority. Value range: 1 to 9999. The default value is 9999.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the service discovery rule resource. If omitted,\nthe provider-level region will be used. Changing this creates a new resource.\n"
},
"ruleId": {
"type": "string",
"description": "The rule ID in uuid format.\n"
},
"serviceType": {
"type": "string",
"description": "Specifies the service type, which is used only for rule classification and UI display.\nYou can enter any field. For example, enter Java or Python by technology stack, or enter collector or database by function.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleTimeouts:AomServiceDiscoveryRuleTimeouts"
}
},
"type": "object",
"required": [
"aomServiceDiscoveryRuleId",
"discoveryRules",
"logFileSuffixes",
"name",
"nameRules",
"region",
"ruleId",
"serviceType"
],
"inputProperties": {
"aomServiceDiscoveryRuleId": {
"type": "string",
"description": "Indicates the resource ID of the service discovery rule. The value is the rule name.\n"
},
"detectLogEnabled": {
"type": "boolean",
"description": "Specifies whether to enable log collection. The default value is true.\n"
},
"discoveryRuleEnabled": {
"type": "boolean",
"description": "Specifies whether the rule is enabled. The default value is true.\n"
},
"discoveryRules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleDiscoveryRule:AomServiceDiscoveryRuleDiscoveryRule"
},
"description": "Specifies the discovery rule. If the array contains multiple conditions, only the\nprocesses that meet all the conditions will be matched. If the value of `check_type` is **cmdLine**, set the value of\n`check_mode` to **contain**. `check_content` is in the format of [\"xxx\"], indicating that the process must contain\nthe xxx parameter. If the value of `check_type` is **env**, set the value of `check_mode` to **contain**.\n`check_content` is in the format of [\"k1\",\"v1\"], indicating that the process must contain the environment variable\nwhose name is k1 and value is v1. If the value of `check_type` is **scope**, set the value of `check_mode`\nto **equals**. `check_content` is in the format of [\"hostId1\",\"hostId2\"], indicating that the rule takes effect only\non specified nodes. If no nodes are specified, the rule applies to all nodes of the project.\n"
},
"isDefaultRule": {
"type": "boolean",
"description": "Specifies whether the rule is the default one. The default value is false.\n"
},
"logFileSuffixes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the log file suffix. This is a list of strings.\nThe values can be: **log**, **trace**, and **out**.\n"
},
"logPathRules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleLogPathRule:AomServiceDiscoveryRuleLogPathRule"
},
"description": "Specifies the log path configuration rule. If cmdLineHash is a fixed string,\nlogs in the specified log path or log file are collected. Otherwise, only the files whose names end with\n.log or .trace are collected. If the value of `name_type` is **cmdLineHash**, args is in the format of [\"00001\"] and\nvalue is in the format of [\"/xxx/xx.log\"], indicating that the log path is /xxx/xx.log when the startup command is 00001.\n"
},
"name": {
"type": "string",
"description": "Specifies the rule name, which contains 4 to 63 characters. It must start\nwith a lowercase letter but cannot end with a hyphen (-). Only digits, lowercase letters, and hyphens are allowed.\n"
},
"nameRules": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleNameRules:AomServiceDiscoveryRuleNameRules",
"description": "Specifies the naming rules for discovered services and applications.\nThe object structure is documented below.\n"
},
"priority": {
"type": "number",
"description": "Specifies the rule priority. Value range: 1 to 9999. The default value is 9999.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the service discovery rule resource. If omitted,\nthe provider-level region will be used. Changing this creates a new resource.\n"
},
"serviceType": {
"type": "string",
"description": "Specifies the service type, which is used only for rule classification and UI display.\nYou can enter any field. For example, enter Java or Python by technology stack, or enter collector or database by function.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleTimeouts:AomServiceDiscoveryRuleTimeouts"
}
},
"requiredInputs": [
"discoveryRules",
"logFileSuffixes",
"nameRules",
"serviceType"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AomServiceDiscoveryRule resources.\n",
"properties": {
"aomServiceDiscoveryRuleId": {
"type": "string",
"description": "Indicates the resource ID of the service discovery rule. The value is the rule name.\n"
},
"detectLogEnabled": {
"type": "boolean",
"description": "Specifies whether to enable log collection. The default value is true.\n"
},
"discoveryRuleEnabled": {
"type": "boolean",
"description": "Specifies whether the rule is enabled. The default value is true.\n"
},
"discoveryRules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleDiscoveryRule:AomServiceDiscoveryRuleDiscoveryRule"
},
"description": "Specifies the discovery rule. If the array contains multiple conditions, only the\nprocesses that meet all the conditions will be matched. If the value of `check_type` is **cmdLine**, set the value of\n`check_mode` to **contain**. `check_content` is in the format of [\"xxx\"], indicating that the process must contain\nthe xxx parameter. If the value of `check_type` is **env**, set the value of `check_mode` to **contain**.\n`check_content` is in the format of [\"k1\",\"v1\"], indicating that the process must contain the environment variable\nwhose name is k1 and value is v1. If the value of `check_type` is **scope**, set the value of `check_mode`\nto **equals**. `check_content` is in the format of [\"hostId1\",\"hostId2\"], indicating that the rule takes effect only\non specified nodes. If no nodes are specified, the rule applies to all nodes of the project.\n"
},
"isDefaultRule": {
"type": "boolean",
"description": "Specifies whether the rule is the default one. The default value is false.\n"
},
"logFileSuffixes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the log file suffix. This is a list of strings.\nThe values can be: **log**, **trace**, and **out**.\n"
},
"logPathRules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleLogPathRule:AomServiceDiscoveryRuleLogPathRule"
},
"description": "Specifies the log path configuration rule. If cmdLineHash is a fixed string,\nlogs in the specified log path or log file are collected. Otherwise, only the files whose names end with\n.log or .trace are collected. If the value of `name_type` is **cmdLineHash**, args is in the format of [\"00001\"] and\nvalue is in the format of [\"/xxx/xx.log\"], indicating that the log path is /xxx/xx.log when the startup command is 00001.\n"
},
"name": {
"type": "string",
"description": "Specifies the rule name, which contains 4 to 63 characters. It must start\nwith a lowercase letter but cannot end with a hyphen (-). Only digits, lowercase letters, and hyphens are allowed.\n"
},
"nameRules": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleNameRules:AomServiceDiscoveryRuleNameRules",
"description": "Specifies the naming rules for discovered services and applications.\nThe object structure is documented below.\n"
},
"priority": {
"type": "number",
"description": "Specifies the rule priority. Value range: 1 to 9999. The default value is 9999.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the service discovery rule resource. If omitted,\nthe provider-level region will be used. Changing this creates a new resource.\n"
},
"ruleId": {
"type": "string",
"description": "The rule ID in uuid format.\n"
},
"serviceType": {
"type": "string",
"description": "Specifies the service type, which is used only for rule classification and UI display.\nYou can enter any field. For example, enter Java or Python by technology stack, or enter collector or database by function.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAomServiceDiscoveryRuleTimeouts:AomServiceDiscoveryRuleTimeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/apiGatewayApi:ApiGatewayApi": {
"description": "Provides an API gateway API resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst apigwGroup = new flexibleengine.ApiGatewayGroup(\"apigwGroup\", {description: \"your descpiption\"});\nconst apigwApi = new flexibleengine.ApiGatewayApi(\"apigwApi\", {\n groupId: apigwGroup.apiGatewayGroupId,\n description: \"your descpiption\",\n tags: [\n \"tag1\",\n \"tag2\",\n ],\n visibility: 1,\n authType: \"IAM\",\n backendType: \"HTTP\",\n requestProtocol: \"HTTPS\",\n requestMethod: \"GET\",\n requestUri: \"/test/path1\",\n exampleSuccessResponse: \"example response\",\n httpBackend: {\n protocol: \"HTTPS\",\n method: \"GET\",\n uri: \"/web/openapi\",\n urlDomain: \"backenddomain.com\",\n timeout: 10000,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\napigw_group = flexibleengine.ApiGatewayGroup(\"apigwGroup\", description=\"your descpiption\")\napigw_api = flexibleengine.ApiGatewayApi(\"apigwApi\",\n group_id=apigw_group.api_gateway_group_id,\n description=\"your descpiption\",\n tags=[\n \"tag1\",\n \"tag2\",\n ],\n visibility=1,\n auth_type=\"IAM\",\n backend_type=\"HTTP\",\n request_protocol=\"HTTPS\",\n request_method=\"GET\",\n request_uri=\"/test/path1\",\n example_success_response=\"example response\",\n http_backend={\n \"protocol\": \"HTTPS\",\n \"method\": \"GET\",\n \"uri\": \"/web/openapi\",\n \"url_domain\": \"backenddomain.com\",\n \"timeout\": 10000,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var apigwGroup = new Flexibleengine.ApiGatewayGroup(\"apigwGroup\", new()\n {\n Description = \"your descpiption\",\n });\n\n var apigwApi = new Flexibleengine.ApiGatewayApi(\"apigwApi\", new()\n {\n GroupId = apigwGroup.ApiGatewayGroupId,\n Description = \"your descpiption\",\n Tags = new[]\n {\n \"tag1\",\n \"tag2\",\n },\n Visibility = 1,\n AuthType = \"IAM\",\n BackendType = \"HTTP\",\n RequestProtocol = \"HTTPS\",\n RequestMethod = \"GET\",\n RequestUri = \"/test/path1\",\n ExampleSuccessResponse = \"example response\",\n HttpBackend = new Flexibleengine.Inputs.ApiGatewayApiHttpBackendArgs\n {\n Protocol = \"HTTPS\",\n Method = \"GET\",\n Uri = \"/web/openapi\",\n UrlDomain = \"backenddomain.com\",\n Timeout = 10000,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tapigwGroup, err := flexibleengine.NewApiGatewayGroup(ctx, \"apigwGroup\", &flexibleengine.ApiGatewayGroupArgs{\n\t\t\tDescription: pulumi.String(\"your descpiption\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewApiGatewayApi(ctx, \"apigwApi\", &flexibleengine.ApiGatewayApiArgs{\n\t\t\tGroupId: apigwGroup.ApiGatewayGroupId,\n\t\t\tDescription: pulumi.String(\"your descpiption\"),\n\t\t\tTags: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"tag1\"),\n\t\t\t\tpulumi.String(\"tag2\"),\n\t\t\t},\n\t\t\tVisibility: pulumi.Float64(1),\n\t\t\tAuthType: pulumi.String(\"IAM\"),\n\t\t\tBackendType: pulumi.String(\"HTTP\"),\n\t\t\tRequestProtocol: pulumi.String(\"HTTPS\"),\n\t\t\tRequestMethod: pulumi.String(\"GET\"),\n\t\t\tRequestUri: pulumi.String(\"/test/path1\"),\n\t\t\tExampleSuccessResponse: pulumi.String(\"example response\"),\n\t\t\tHttpBackend: &flexibleengine.ApiGatewayApiHttpBackendArgs{\n\t\t\t\tProtocol: pulumi.String(\"HTTPS\"),\n\t\t\t\tMethod: pulumi.String(\"GET\"),\n\t\t\t\tUri: pulumi.String(\"/web/openapi\"),\n\t\t\t\tUrlDomain: pulumi.String(\"backenddomain.com\"),\n\t\t\t\tTimeout: pulumi.Float64(10000),\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.flexibleengine.ApiGatewayGroup;\nimport com.pulumi.flexibleengine.ApiGatewayGroupArgs;\nimport com.pulumi.flexibleengine.ApiGatewayApi;\nimport com.pulumi.flexibleengine.ApiGatewayApiArgs;\nimport com.pulumi.flexibleengine.inputs.ApiGatewayApiHttpBackendArgs;\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 apigwGroup = new ApiGatewayGroup(\"apigwGroup\", ApiGatewayGroupArgs.builder()\n .description(\"your descpiption\")\n .build());\n\n var apigwApi = new ApiGatewayApi(\"apigwApi\", ApiGatewayApiArgs.builder()\n .groupId(apigwGroup.apiGatewayGroupId())\n .description(\"your descpiption\")\n .tags( \n \"tag1\",\n \"tag2\")\n .visibility(1)\n .authType(\"IAM\")\n .backendType(\"HTTP\")\n .requestProtocol(\"HTTPS\")\n .requestMethod(\"GET\")\n .requestUri(\"/test/path1\")\n .exampleSuccessResponse(\"example response\")\n .httpBackend(ApiGatewayApiHttpBackendArgs.builder()\n .protocol(\"HTTPS\")\n .method(\"GET\")\n .uri(\"/web/openapi\")\n .urlDomain(\"backenddomain.com\")\n .timeout(10000)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n apigwGroup:\n type: flexibleengine:ApiGatewayGroup\n properties:\n description: your descpiption\n apigwApi:\n type: flexibleengine:ApiGatewayApi\n properties:\n groupId: ${apigwGroup.apiGatewayGroupId}\n description: your descpiption\n tags:\n - tag1\n - tag2\n visibility: 1\n authType: IAM\n backendType: HTTP\n requestProtocol: HTTPS\n requestMethod: GET\n requestUri: /test/path1\n exampleSuccessResponse: example response\n httpBackend:\n protocol: HTTPS\n method: GET\n uri: /web/openapi\n urlDomain: backenddomain.com\n timeout: 10000\n```\n\n\n## Import\n\nAPI can be imported using the `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apiGatewayApi:ApiGatewayApi api 774438a28a574ac8a496325d1bf51807\n```\n\n",
"properties": {
"apiGatewayApiId": {
"type": "string",
"description": "The ID of the API.\n"
},
"authType": {
"type": "string",
"description": "Specifies the security authentication mode. The value can be 'APP', 'IAM', and '\nNONE'.\n"
},
"backendParameters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiBackendParameter:ApiGatewayApiBackendParameter"
},
"description": "the backend parameter list (documented below).\n"
},
"backendType": {
"type": "string",
"description": "Specifies the service backend type. The value can be:\n+ 'HTTP': the web service backend\n+ 'FUNCTION': the FunctionGraph service backend\n+ 'MOCK': the Mock service backend\n"
},
"cors": {
"type": "boolean",
"description": "Specifies whether CORS is supported or not.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the API. The description cannot exceed 255 characters.\n"
},
"exampleFailureResponse": {
"type": "string",
"description": "Specifies the example response for a failed request The length cannot\nexceed 20,480 characters.\n"
},
"exampleSuccessResponse": {
"type": "string",
"description": "Specifies the example response for a successful request. The length\ncannot exceed 20,480 characters.\n"
},
"functionBackend": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiFunctionBackend:ApiGatewayApiFunctionBackend",
"description": "Specifies the configuration when backend_type selected 'FUNCTION' (documented\nbelow).\n"
},
"groupId": {
"type": "string",
"description": "Specifies the ID of the API group. Changing this creates a new resource.\n"
},
"groupName": {
"type": "string",
"description": "The name of the API group to which the API belongs.\n"
},
"httpBackend": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiHttpBackend:ApiGatewayApiHttpBackend",
"description": "Specifies the configuration when backend_type selected 'HTTP' (documented below).\n"
},
"mockBackend": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiMockBackend:ApiGatewayApiMockBackend",
"description": "Specifies the configuration when backend_type selected 'MOCK' (documented below).\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API. An API name consists of 3–64 characters, starting with a\nletter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the API resource. If omitted, the provider-level\nregion will be used. Changing this creates a new API resource.\n"
},
"requestMethod": {
"type": "string",
"description": "Specifies the request method, including 'GET','POST','PUT' and etc..\n"
},
"requestParameters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiRequestParameter:ApiGatewayApiRequestParameter"
},
"description": "the request parameter list (documented below).\n"
},
"requestProtocol": {
"type": "string",
"description": "Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH'\nwhich means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.\n"
},
"requestUri": {
"type": "string",
"description": "Specifies the request path of the API. The value must comply with URI\nspecifications.\n"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "the tags of API in format of string list.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiTimeouts:ApiGatewayApiTimeouts"
},
"version": {
"type": "string",
"description": "Specifies the version of the API. A maximum of 16 characters are allowed.\n"
},
"visibility": {
"type": "number",
"description": "Specifies whether the API is available to the public. The value can only be 1 (public).\n"
}
},
"type": "object",
"required": [
"apiGatewayApiId",
"authType",
"backendType",
"exampleSuccessResponse",
"groupId",
"groupName",
"name",
"region",
"requestMethod",
"requestUri",
"version"
],
"inputProperties": {
"apiGatewayApiId": {
"type": "string",
"description": "The ID of the API.\n"
},
"authType": {
"type": "string",
"description": "Specifies the security authentication mode. The value can be 'APP', 'IAM', and '\nNONE'.\n"
},
"backendParameters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiBackendParameter:ApiGatewayApiBackendParameter"
},
"description": "the backend parameter list (documented below).\n"
},
"backendType": {
"type": "string",
"description": "Specifies the service backend type. The value can be:\n+ 'HTTP': the web service backend\n+ 'FUNCTION': the FunctionGraph service backend\n+ 'MOCK': the Mock service backend\n"
},
"cors": {
"type": "boolean",
"description": "Specifies whether CORS is supported or not.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the API. The description cannot exceed 255 characters.\n"
},
"exampleFailureResponse": {
"type": "string",
"description": "Specifies the example response for a failed request The length cannot\nexceed 20,480 characters.\n"
},
"exampleSuccessResponse": {
"type": "string",
"description": "Specifies the example response for a successful request. The length\ncannot exceed 20,480 characters.\n"
},
"functionBackend": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiFunctionBackend:ApiGatewayApiFunctionBackend",
"description": "Specifies the configuration when backend_type selected 'FUNCTION' (documented\nbelow).\n"
},
"groupId": {
"type": "string",
"description": "Specifies the ID of the API group. Changing this creates a new resource.\n"
},
"httpBackend": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiHttpBackend:ApiGatewayApiHttpBackend",
"description": "Specifies the configuration when backend_type selected 'HTTP' (documented below).\n"
},
"mockBackend": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiMockBackend:ApiGatewayApiMockBackend",
"description": "Specifies the configuration when backend_type selected 'MOCK' (documented below).\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API. An API name consists of 3–64 characters, starting with a\nletter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the API resource. If omitted, the provider-level\nregion will be used. Changing this creates a new API resource.\n"
},
"requestMethod": {
"type": "string",
"description": "Specifies the request method, including 'GET','POST','PUT' and etc..\n"
},
"requestParameters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiRequestParameter:ApiGatewayApiRequestParameter"
},
"description": "the request parameter list (documented below).\n"
},
"requestProtocol": {
"type": "string",
"description": "Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH'\nwhich means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.\n"
},
"requestUri": {
"type": "string",
"description": "Specifies the request path of the API. The value must comply with URI\nspecifications.\n"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "the tags of API in format of string list.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiTimeouts:ApiGatewayApiTimeouts"
},
"version": {
"type": "string",
"description": "Specifies the version of the API. A maximum of 16 characters are allowed.\n"
},
"visibility": {
"type": "number",
"description": "Specifies whether the API is available to the public. The value can only be 1 (public).\n"
}
},
"requiredInputs": [
"authType",
"backendType",
"exampleSuccessResponse",
"groupId",
"requestMethod",
"requestUri"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApiGatewayApi resources.\n",
"properties": {
"apiGatewayApiId": {
"type": "string",
"description": "The ID of the API.\n"
},
"authType": {
"type": "string",
"description": "Specifies the security authentication mode. The value can be 'APP', 'IAM', and '\nNONE'.\n"
},
"backendParameters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiBackendParameter:ApiGatewayApiBackendParameter"
},
"description": "the backend parameter list (documented below).\n"
},
"backendType": {
"type": "string",
"description": "Specifies the service backend type. The value can be:\n+ 'HTTP': the web service backend\n+ 'FUNCTION': the FunctionGraph service backend\n+ 'MOCK': the Mock service backend\n"
},
"cors": {
"type": "boolean",
"description": "Specifies whether CORS is supported or not.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the API. The description cannot exceed 255 characters.\n"
},
"exampleFailureResponse": {
"type": "string",
"description": "Specifies the example response for a failed request The length cannot\nexceed 20,480 characters.\n"
},
"exampleSuccessResponse": {
"type": "string",
"description": "Specifies the example response for a successful request. The length\ncannot exceed 20,480 characters.\n"
},
"functionBackend": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiFunctionBackend:ApiGatewayApiFunctionBackend",
"description": "Specifies the configuration when backend_type selected 'FUNCTION' (documented\nbelow).\n"
},
"groupId": {
"type": "string",
"description": "Specifies the ID of the API group. Changing this creates a new resource.\n"
},
"groupName": {
"type": "string",
"description": "The name of the API group to which the API belongs.\n"
},
"httpBackend": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiHttpBackend:ApiGatewayApiHttpBackend",
"description": "Specifies the configuration when backend_type selected 'HTTP' (documented below).\n"
},
"mockBackend": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiMockBackend:ApiGatewayApiMockBackend",
"description": "Specifies the configuration when backend_type selected 'MOCK' (documented below).\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API. An API name consists of 3–64 characters, starting with a\nletter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the API resource. If omitted, the provider-level\nregion will be used. Changing this creates a new API resource.\n"
},
"requestMethod": {
"type": "string",
"description": "Specifies the request method, including 'GET','POST','PUT' and etc..\n"
},
"requestParameters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiRequestParameter:ApiGatewayApiRequestParameter"
},
"description": "the request parameter list (documented below).\n"
},
"requestProtocol": {
"type": "string",
"description": "Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH'\nwhich means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.\n"
},
"requestUri": {
"type": "string",
"description": "Specifies the request path of the API. The value must comply with URI\nspecifications.\n"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "the tags of API in format of string list.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayApiTimeouts:ApiGatewayApiTimeouts"
},
"version": {
"type": "string",
"description": "Specifies the version of the API. A maximum of 16 characters are allowed.\n"
},
"visibility": {
"type": "number",
"description": "Specifies whether the API is available to the public. The value can only be 1 (public).\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apiGatewayEnvironment:ApiGatewayEnvironment": {
"description": "Manages a shared APIG environment resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst testEnv = new flexibleengine.ApiGatewayEnvironment(\"testEnv\", {description: \"test env\"});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\ntest_env = flexibleengine.ApiGatewayEnvironment(\"testEnv\", description=\"test env\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var testEnv = new Flexibleengine.ApiGatewayEnvironment(\"testEnv\", new()\n {\n Description = \"test env\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewApiGatewayEnvironment(ctx, \"testEnv\", &flexibleengine.ApiGatewayEnvironmentArgs{\n\t\t\tDescription: pulumi.String(\"test env\"),\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.flexibleengine.ApiGatewayEnvironment;\nimport com.pulumi.flexibleengine.ApiGatewayEnvironmentArgs;\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 testEnv = new ApiGatewayEnvironment(\"testEnv\", ApiGatewayEnvironmentArgs.builder()\n .description(\"test env\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n testEnv:\n type: flexibleengine:ApiGatewayEnvironment\n properties:\n description: test env\n```\n\n\n## Import\n\nAPIG environments can be imported using the `id`, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/apiGatewayEnvironment:ApiGatewayEnvironment test_env 774438a28a574ac8a496325d1bf51807\n```\n\n",
"properties": {
"apiGatewayEnvironmentId": {
"type": "string",
"description": "The environment ID.\n"
},
"createdAt": {
"type": "string",
"description": "The time when the shared APIG environment was created.\n"
},
"description": {
"type": "string",
"description": "Specifies the environment description.\nThe value can contain a maximum of `255` characters.\nChinese characters must be in **UTF-8** or **Unicode** format.\n"
},
"name": {
"type": "string",
"description": "Specifies the environment name.\nThe valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed.\nThe name must start with a letter.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the shared APIG environment is located.\nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"type": "object",
"required": [
"apiGatewayEnvironmentId",
"createdAt",
"name",
"region"
],
"inputProperties": {
"apiGatewayEnvironmentId": {
"type": "string",
"description": "The environment ID.\n"
},
"description": {
"type": "string",
"description": "Specifies the environment description.\nThe value can contain a maximum of `255` characters.\nChinese characters must be in **UTF-8** or **Unicode** format.\n"
},
"name": {
"type": "string",
"description": "Specifies the environment name.\nThe valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed.\nThe name must start with a letter.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the shared APIG environment is located.\nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"stateInputs": {
"description": "Input properties used for looking up and filtering ApiGatewayEnvironment resources.\n",
"properties": {
"apiGatewayEnvironmentId": {
"type": "string",
"description": "The environment ID.\n"
},
"createdAt": {
"type": "string",
"description": "The time when the shared APIG environment was created.\n"
},
"description": {
"type": "string",
"description": "Specifies the environment description.\nThe value can contain a maximum of `255` characters.\nChinese characters must be in **UTF-8** or **Unicode** format.\n"
},
"name": {
"type": "string",
"description": "Specifies the environment name.\nThe valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed.\nThe name must start with a letter.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the shared APIG environment is located.\nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apiGatewayGroup:ApiGatewayGroup": {
"description": "Provides an API gateway group resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst apigwGroup = new flexibleengine.ApiGatewayGroup(\"apigwGroup\", {description: \"your descpiption\"});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\napigw_group = flexibleengine.ApiGatewayGroup(\"apigwGroup\", description=\"your descpiption\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var apigwGroup = new Flexibleengine.ApiGatewayGroup(\"apigwGroup\", new()\n {\n Description = \"your descpiption\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewApiGatewayGroup(ctx, \"apigwGroup\", &flexibleengine.ApiGatewayGroupArgs{\n\t\t\tDescription: pulumi.String(\"your descpiption\"),\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.flexibleengine.ApiGatewayGroup;\nimport com.pulumi.flexibleengine.ApiGatewayGroupArgs;\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 apigwGroup = new ApiGatewayGroup(\"apigwGroup\", ApiGatewayGroupArgs.builder()\n .description(\"your descpiption\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n apigwGroup:\n type: flexibleengine:ApiGatewayGroup\n properties:\n description: your descpiption\n```\n\n\n## Import\n\nAPI groups can be imported using the `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apiGatewayGroup:ApiGatewayGroup apigw_group c8738f7c-a4b0-4c5f-a202-bda7dc4018a4\n```\n\n",
"properties": {
"apiGatewayGroupId": {
"type": "string",
"description": "ID of the API group.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the API group. The description cannot exceed 255\ncharacters.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API group. An API group name consists of 3–64 characters,\nstarting with a letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the API gateway group resource. If omitted, the\nprovider-level region will be used. Changing this creates a new gateway group resource.\n"
},
"status": {
"type": "number",
"description": "Status of the API group.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayGroupTimeouts:ApiGatewayGroupTimeouts"
}
},
"type": "object",
"required": [
"apiGatewayGroupId",
"name",
"region",
"status"
],
"inputProperties": {
"apiGatewayGroupId": {
"type": "string",
"description": "ID of the API group.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the API group. The description cannot exceed 255\ncharacters.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API group. An API group name consists of 3–64 characters,\nstarting with a letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the API gateway group resource. If omitted, the\nprovider-level region will be used. Changing this creates a new gateway group resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayGroupTimeouts:ApiGatewayGroupTimeouts"
}
},
"stateInputs": {
"description": "Input properties used for looking up and filtering ApiGatewayGroup resources.\n",
"properties": {
"apiGatewayGroupId": {
"type": "string",
"description": "ID of the API group.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the API group. The description cannot exceed 255\ncharacters.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API group. An API group name consists of 3–64 characters,\nstarting with a letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the API gateway group resource. If omitted, the\nprovider-level region will be used. Changing this creates a new gateway group resource.\n"
},
"status": {
"type": "number",
"description": "Status of the API group.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApiGatewayGroupTimeouts:ApiGatewayGroupTimeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/apigAclPolicy:ApigAclPolicy": {
"description": "Manages an ACL policy resource within FlexibleEngine.\n\n## Example Usage\n\n## Import\n\nACL Policies can be imported using their `id` and related dedicated instance ID, separated by a slash, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/apigAclPolicy:ApigAclPolicy test /\n```\n\n",
"properties": {
"apigAclPolicyId": {
"type": "string",
"description": "The ID of the ACL policy.\n"
},
"entityType": {
"type": "string",
"description": "Specifies the entity type of the ACL policy.\nThe valid values are as follows:\n+ **IP**: This rule is specified to control access to the API for specific IPs.\n+ **DOMAIN**: This rule is specified to control access to the API for specific accounts (specified by domain name).\n\nChanging this will create a new resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the ACL\npolicy belongs.\nChanging this will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the ACL policy. \nThe valid length is limited from `3` to `64`, only English letters, Chinese characters, digits and underscores (_) are\nallowed. The name must start with an English letter or Chinese character.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the ACL policy is located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the ACL policy.\nThe valid values are as follows:\n+ **PERMIT**: Allow specific IPs or accounts to access API.\n+ **DENY**: Forbid specific IPs or accounts to access API.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the ACL policy.\n"
},
"value": {
"type": "string",
"description": "Specifies one or more objects from which the access will be controlled. \nSeparate multiple objects with commas (,).\n"
}
},
"type": "object",
"required": [
"apigAclPolicyId",
"entityType",
"instanceId",
"name",
"region",
"type",
"updatedAt",
"value"
],
"inputProperties": {
"apigAclPolicyId": {
"type": "string",
"description": "The ID of the ACL policy.\n"
},
"entityType": {
"type": "string",
"description": "Specifies the entity type of the ACL policy.\nThe valid values are as follows:\n+ **IP**: This rule is specified to control access to the API for specific IPs.\n+ **DOMAIN**: This rule is specified to control access to the API for specific accounts (specified by domain name).\n\nChanging this will create a new resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the ACL\npolicy belongs.\nChanging this will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the ACL policy. \nThe valid length is limited from `3` to `64`, only English letters, Chinese characters, digits and underscores (_) are\nallowed. The name must start with an English letter or Chinese character.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the ACL policy is located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the ACL policy.\nThe valid values are as follows:\n+ **PERMIT**: Allow specific IPs or accounts to access API.\n+ **DENY**: Forbid specific IPs or accounts to access API.\n"
},
"value": {
"type": "string",
"description": "Specifies one or more objects from which the access will be controlled. \nSeparate multiple objects with commas (,).\n"
}
},
"requiredInputs": [
"entityType",
"instanceId",
"type",
"value"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigAclPolicy resources.\n",
"properties": {
"apigAclPolicyId": {
"type": "string",
"description": "The ID of the ACL policy.\n"
},
"entityType": {
"type": "string",
"description": "Specifies the entity type of the ACL policy.\nThe valid values are as follows:\n+ **IP**: This rule is specified to control access to the API for specific IPs.\n+ **DOMAIN**: This rule is specified to control access to the API for specific accounts (specified by domain name).\n\nChanging this will create a new resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the ACL\npolicy belongs.\nChanging this will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the ACL policy. \nThe valid length is limited from `3` to `64`, only English letters, Chinese characters, digits and underscores (_) are\nallowed. The name must start with an English letter or Chinese character.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the ACL policy is located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the ACL policy.\nThe valid values are as follows:\n+ **PERMIT**: Allow specific IPs or accounts to access API.\n+ **DENY**: Forbid specific IPs or accounts to access API.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the ACL policy.\n"
},
"value": {
"type": "string",
"description": "Specifies one or more objects from which the access will be controlled. \nSeparate multiple objects with commas (,).\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigAclPolicyAssociate:ApigAclPolicyAssociate": {
"description": "Use this resource to bind the APIs to the ACL policy within FlexibleEngine.\n\n> An ACL policy can only create one `flexibleengine.ApigAclPolicyAssociate` resource.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst policyId = config.requireObject(\"policyId\");\nconst apiPublishIds = config.requireObject>(\"apiPublishIds\");\nconst test = new flexibleengine.ApigAclPolicyAssociate(\"test\", {\n instanceId: instanceId,\n policyId: policyId,\n publishIds: apiPublishIds,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\npolicy_id = config.require_object(\"policyId\")\napi_publish_ids = config.require_object(\"apiPublishIds\")\ntest = flexibleengine.ApigAclPolicyAssociate(\"test\",\n instance_id=instance_id,\n policy_id=policy_id,\n publish_ids=api_publish_ids)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var policyId = config.RequireObject(\"policyId\");\n var apiPublishIds = config.RequireObject(\"apiPublishIds\");\n var test = new Flexibleengine.ApigAclPolicyAssociate(\"test\", new()\n {\n InstanceId = instanceId,\n PolicyId = policyId,\n PublishIds = apiPublishIds,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tpolicyId := cfg.RequireObject(\"policyId\")\n\t\tapiPublishIds := cfg.Require(\"apiPublishIds\")\n\t\t_, err := flexibleengine.NewApigAclPolicyAssociate(ctx, \"test\", &flexibleengine.ApigAclPolicyAssociateArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tPolicyId: pulumi.Any(policyId),\n\t\t\tPublishIds: apiPublishIds,\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.flexibleengine.ApigAclPolicyAssociate;\nimport com.pulumi.flexibleengine.ApigAclPolicyAssociateArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var policyId = config.get(\"policyId\");\n final var apiPublishIds = config.get(\"apiPublishIds\");\n var test = new ApigAclPolicyAssociate(\"test\", ApigAclPolicyAssociateArgs.builder()\n .instanceId(instanceId)\n .policyId(policyId)\n .publishIds(apiPublishIds)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n policyId:\n type: dynamic\n apiPublishIds:\n type: list(string)\nresources:\n test:\n type: flexibleengine:ApigAclPolicyAssociate\n properties:\n instanceId: ${instanceId}\n policyId: ${policyId}\n publishIds: ${apiPublishIds}\n```\n\n\n## Import\n\nAssociate resources can be imported using their `policy_id` and the APIG dedicated instance ID to which the policy\n\nbelongs, separated by a slash, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/apigAclPolicyAssociate:ApigAclPolicyAssociate test /\n```\n\n",
"properties": {
"apigAclPolicyAssociateId": {
"type": "string",
"description": "Resource ID. The format is `/`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the APIs and the\nACL policy belong.\nChanging this will create a new resource.\n"
},
"policyId": {
"type": "string",
"description": "Specifies the ACL Policy ID for APIs binding. \nChanging this will create a new resource.\n"
},
"publishIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the publish IDs corresponding to the APIs bound by the ACL policy.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the ACL policy and the APIs are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"type": "object",
"required": [
"apigAclPolicyAssociateId",
"instanceId",
"policyId",
"publishIds",
"region"
],
"inputProperties": {
"apigAclPolicyAssociateId": {
"type": "string",
"description": "Resource ID. The format is `/`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the APIs and the\nACL policy belong.\nChanging this will create a new resource.\n"
},
"policyId": {
"type": "string",
"description": "Specifies the ACL Policy ID for APIs binding. \nChanging this will create a new resource.\n"
},
"publishIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the publish IDs corresponding to the APIs bound by the ACL policy.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the ACL policy and the APIs are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"requiredInputs": [
"instanceId",
"policyId",
"publishIds"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigAclPolicyAssociate resources.\n",
"properties": {
"apigAclPolicyAssociateId": {
"type": "string",
"description": "Resource ID. The format is `/`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the APIs and the\nACL policy belong.\nChanging this will create a new resource.\n"
},
"policyId": {
"type": "string",
"description": "Specifies the ACL Policy ID for APIs binding. \nChanging this will create a new resource.\n"
},
"publishIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the publish IDs corresponding to the APIs bound by the ACL policy.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the ACL policy and the APIs are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigApi:ApigApi": {
"description": "Manages an APIG API resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst groupId = config.requireObject(\"groupId\");\nconst apiName = config.requireObject(\"apiName\");\nconst customResponseId = config.requireObject(\"customResponseId\");\nconst customAuthId = config.requireObject(\"customAuthId\");\nconst vpcChannelId = config.requireObject(\"vpcChannelId\");\nconst test = new flexibleengine.ApigApi(\"test\", {\n instanceId: instanceId,\n groupId: groupId,\n type: \"Public\",\n requestProtocol: \"HTTP\",\n requestMethod: \"POST\",\n requestPath: \"/terraform/users\",\n securityAuthentication: \"AUTHORIZER\",\n matching: \"Exact\",\n successResponse: \"Successful\",\n responseId: customResponseId,\n authorizerId: customAuthId,\n backendParams: [{\n type: \"SYSTEM\",\n name: \"X-User-Auth\",\n location: \"HEADER\",\n value: \"user_name\",\n }],\n web: {\n path: \"/backend/users\",\n vpcChannelId: vpcChannelId,\n requestMethod: \"POST\",\n requestProtocol: \"HTTP\",\n timeout: 5000,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\ngroup_id = config.require_object(\"groupId\")\napi_name = config.require_object(\"apiName\")\ncustom_response_id = config.require_object(\"customResponseId\")\ncustom_auth_id = config.require_object(\"customAuthId\")\nvpc_channel_id = config.require_object(\"vpcChannelId\")\ntest = flexibleengine.ApigApi(\"test\",\n instance_id=instance_id,\n group_id=group_id,\n type=\"Public\",\n request_protocol=\"HTTP\",\n request_method=\"POST\",\n request_path=\"/terraform/users\",\n security_authentication=\"AUTHORIZER\",\n matching=\"Exact\",\n success_response=\"Successful\",\n response_id=custom_response_id,\n authorizer_id=custom_auth_id,\n backend_params=[{\n \"type\": \"SYSTEM\",\n \"name\": \"X-User-Auth\",\n \"location\": \"HEADER\",\n \"value\": \"user_name\",\n }],\n web={\n \"path\": \"/backend/users\",\n \"vpc_channel_id\": vpc_channel_id,\n \"request_method\": \"POST\",\n \"request_protocol\": \"HTTP\",\n \"timeout\": 5000,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var groupId = config.RequireObject(\"groupId\");\n var apiName = config.RequireObject(\"apiName\");\n var customResponseId = config.RequireObject(\"customResponseId\");\n var customAuthId = config.RequireObject(\"customAuthId\");\n var vpcChannelId = config.RequireObject(\"vpcChannelId\");\n var test = new Flexibleengine.ApigApi(\"test\", new()\n {\n InstanceId = instanceId,\n GroupId = groupId,\n Type = \"Public\",\n RequestProtocol = \"HTTP\",\n RequestMethod = \"POST\",\n RequestPath = \"/terraform/users\",\n SecurityAuthentication = \"AUTHORIZER\",\n Matching = \"Exact\",\n SuccessResponse = \"Successful\",\n ResponseId = customResponseId,\n AuthorizerId = customAuthId,\n BackendParams = new[]\n {\n new Flexibleengine.Inputs.ApigApiBackendParamArgs\n {\n Type = \"SYSTEM\",\n Name = \"X-User-Auth\",\n Location = \"HEADER\",\n Value = \"user_name\",\n },\n },\n Web = new Flexibleengine.Inputs.ApigApiWebArgs\n {\n Path = \"/backend/users\",\n VpcChannelId = vpcChannelId,\n RequestMethod = \"POST\",\n RequestProtocol = \"HTTP\",\n Timeout = 5000,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tgroupId := cfg.RequireObject(\"groupId\")\n\t\tapiName := cfg.RequireObject(\"apiName\")\n\t\tcustomResponseId := cfg.RequireObject(\"customResponseId\")\n\t\tcustomAuthId := cfg.RequireObject(\"customAuthId\")\n\t\tvpcChannelId := cfg.RequireObject(\"vpcChannelId\")\n\t\t_, err := flexibleengine.NewApigApi(ctx, \"test\", &flexibleengine.ApigApiArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tGroupId: pulumi.Any(groupId),\n\t\t\tType: pulumi.String(\"Public\"),\n\t\t\tRequestProtocol: pulumi.String(\"HTTP\"),\n\t\t\tRequestMethod: pulumi.String(\"POST\"),\n\t\t\tRequestPath: pulumi.String(\"/terraform/users\"),\n\t\t\tSecurityAuthentication: pulumi.String(\"AUTHORIZER\"),\n\t\t\tMatching: pulumi.String(\"Exact\"),\n\t\t\tSuccessResponse: pulumi.String(\"Successful\"),\n\t\t\tResponseId: pulumi.Any(customResponseId),\n\t\t\tAuthorizerId: pulumi.Any(customAuthId),\n\t\t\tBackendParams: flexibleengine.ApigApiBackendParamArray{\n\t\t\t\t&flexibleengine.ApigApiBackendParamArgs{\n\t\t\t\t\tType: pulumi.String(\"SYSTEM\"),\n\t\t\t\t\tName: pulumi.String(\"X-User-Auth\"),\n\t\t\t\t\tLocation: pulumi.String(\"HEADER\"),\n\t\t\t\t\tValue: pulumi.String(\"user_name\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tWeb: &flexibleengine.ApigApiWebArgs{\n\t\t\t\tPath: pulumi.String(\"/backend/users\"),\n\t\t\t\tVpcChannelId: pulumi.Any(vpcChannelId),\n\t\t\t\tRequestMethod: pulumi.String(\"POST\"),\n\t\t\t\tRequestProtocol: pulumi.String(\"HTTP\"),\n\t\t\t\tTimeout: pulumi.Float64(5000),\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.flexibleengine.ApigApi;\nimport com.pulumi.flexibleengine.ApigApiArgs;\nimport com.pulumi.flexibleengine.inputs.ApigApiBackendParamArgs;\nimport com.pulumi.flexibleengine.inputs.ApigApiWebArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var groupId = config.get(\"groupId\");\n final var apiName = config.get(\"apiName\");\n final var customResponseId = config.get(\"customResponseId\");\n final var customAuthId = config.get(\"customAuthId\");\n final var vpcChannelId = config.get(\"vpcChannelId\");\n var test = new ApigApi(\"test\", ApigApiArgs.builder()\n .instanceId(instanceId)\n .groupId(groupId)\n .type(\"Public\")\n .requestProtocol(\"HTTP\")\n .requestMethod(\"POST\")\n .requestPath(\"/terraform/users\")\n .securityAuthentication(\"AUTHORIZER\")\n .matching(\"Exact\")\n .successResponse(\"Successful\")\n .responseId(customResponseId)\n .authorizerId(customAuthId)\n .backendParams(ApigApiBackendParamArgs.builder()\n .type(\"SYSTEM\")\n .name(\"X-User-Auth\")\n .location(\"HEADER\")\n .value(\"user_name\")\n .build())\n .web(ApigApiWebArgs.builder()\n .path(\"/backend/users\")\n .vpcChannelId(vpcChannelId)\n .requestMethod(\"POST\")\n .requestProtocol(\"HTTP\")\n .timeout(5000)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n groupId:\n type: dynamic\n apiName:\n type: dynamic\n customResponseId:\n type: dynamic\n customAuthId:\n type: dynamic\n vpcChannelId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigApi\n properties:\n instanceId: ${instanceId}\n groupId: ${groupId}\n type: Public\n requestProtocol: HTTP\n requestMethod: POST\n requestPath: /terraform/users\n securityAuthentication: AUTHORIZER\n matching: Exact\n successResponse: Successful\n responseId: ${customResponseId}\n authorizerId: ${customAuthId}\n backendParams:\n - type: SYSTEM\n name: X-User-Auth\n location: HEADER\n value: user_name\n web:\n path: /backend/users\n vpcChannelId: ${vpcChannelId}\n requestMethod: POST\n requestProtocol: HTTP\n timeout: 5000\n```\n\n\n## Import\n\nAPIs can be imported using the ID of the APIG dedicated instance to which the API belongs and API `name`, separated by a\n\nslash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigApi:ApigApi test /\n```\n\n",
"properties": {
"apigApiId": {
"type": "string",
"description": "ID of the APIG API.\n"
},
"authorizerId": {
"type": "string",
"description": "Specifies the ID of the backend custom authorization.\n\n\nThe `conditions` block supports:\n"
},
"backendParams": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiBackendParam:ApigApiBackendParam"
},
"description": "Specifies an array of one or more backend parameters. The maximum of request\nparameters is 50. The object structure is documented above.\n"
},
"bodyDescription": {
"type": "string",
"description": "Specifies the description of the API request body, which can be an example\nrequest body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be\nin UTF-8 or Unicode format.\n"
},
"cors": {
"type": "boolean",
"description": "Specifies whether CORS is supported, default to false.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the constant or system parameter, which contain a\nmaximum of 255 characters, and the angle brackets (< and >) are not allowed.\n"
},
"failureResponse": {
"type": "string",
"description": "Specifies the example response for a successful request. Ensure that the\nresponse does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.\n"
},
"funcGraph": {
"$ref": "#/types/flexibleengine:index%2FApigApiFuncGraph:ApigApiFuncGraph",
"description": "Specifies the function graph backend details. The object\nstructure is documented below. Changing this will create a new API resource.\n"
},
"funcGraphPolicies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiFuncGraphPolicy:ApigApiFuncGraphPolicy"
},
"description": "Specifies the Mock policy backends. The maximum of the policy is 5.\nThe object structure is documented below.\n"
},
"groupId": {
"type": "string",
"description": "Specifies an ID of the APIG group to which the API belongs to.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API belongs\nto. Changing this will create a new API resource.\n"
},
"matching": {
"type": "string",
"description": "Specifies the route matching mode. The valid value are **Exact** and **Prefix**,\ndefault to **Exact**.\n"
},
"mock": {
"$ref": "#/types/flexibleengine:index%2FApigApiMock:ApigApiMock",
"description": "Specifies the mock backend details. The object structure is documented\nbelow. Changing this will create a new API resource.\n"
},
"mockPolicies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiMockPolicy:ApigApiMockPolicy"
},
"description": "Specifies the Mock policy backends. The maximum of the policy is 5.\nThe object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API resource. If omitted, the\nprovider-level region will be used. Changing this will create a new API resource.\n"
},
"registeredAt": {
"type": "string",
"description": "Time when the API is registered, in UTC format.\n"
},
"requestMethod": {
"type": "string",
"description": "Specifies the backend request method of the API. The valid types are **GET**,\n**POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.\n"
},
"requestParams": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiRequestParam:ApigApiRequestParam"
},
"description": "Specifies an array of one or more request parameters of the front-end. The maximum\nof request parameters is 50. The object structure is documented below.\n"
},
"requestPath": {
"type": "string",
"description": "Specifies the request address, which can contain a maximum of 512 characters\nrequest parameters enclosed with brackets ({}).\n+ The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and\nunderscores (_) and must comply with URI specifications.\n+ The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters.\nOnly letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.\n"
},
"requestProtocol": {
"type": "string",
"description": "Specifies the backend request protocol. The valid values are **HTTP** and\n**HTTPS**, default to **HTTPS**.\n"
},
"responseId": {
"type": "string",
"description": "Specifies the APIG group response ID.\n"
},
"securityAuthentication": {
"type": "string",
"description": "Specifies the security authentication mode. The valid values are\n**NONE**, **APP** and **IAM**, default to **NONE**.\n"
},
"simpleAuthentication": {
"type": "boolean",
"description": "Specifies whether AppCode authentication is enabled. The applicaiton code\nmust located in the header when `simple_authentication` is true.\n"
},
"successResponse": {
"type": "string",
"description": "Specifies the example response for a successful request. Ensure that the\nresponse does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"updatedAt": {
"type": "string",
"description": "Time when the API was last modified, in UTC format.\n"
},
"web": {
"$ref": "#/types/flexibleengine:index%2FApigApiWeb:ApigApiWeb",
"description": "Specifies the web backend details. The object structure is documented\nbelow. Changing this will create a new API resource.\n"
},
"webPolicies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiWebPolicy:ApigApiWebPolicy"
},
"description": "Specifies the example response for a failed request. The maximum of the policy is 5.\nThe object structure is documented below.\n\n\nThe `request_params` block supports:\n"
}
},
"type": "object",
"required": [
"apigApiId",
"groupId",
"instanceId",
"name",
"region",
"registeredAt",
"requestMethod",
"requestPath",
"requestProtocol",
"simpleAuthentication",
"type",
"updatedAt"
],
"inputProperties": {
"apigApiId": {
"type": "string",
"description": "ID of the APIG API.\n"
},
"authorizerId": {
"type": "string",
"description": "Specifies the ID of the backend custom authorization.\n\n\nThe `conditions` block supports:\n"
},
"backendParams": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiBackendParam:ApigApiBackendParam"
},
"description": "Specifies an array of one or more backend parameters. The maximum of request\nparameters is 50. The object structure is documented above.\n"
},
"bodyDescription": {
"type": "string",
"description": "Specifies the description of the API request body, which can be an example\nrequest body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be\nin UTF-8 or Unicode format.\n"
},
"cors": {
"type": "boolean",
"description": "Specifies whether CORS is supported, default to false.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the constant or system parameter, which contain a\nmaximum of 255 characters, and the angle brackets (< and >) are not allowed.\n"
},
"failureResponse": {
"type": "string",
"description": "Specifies the example response for a successful request. Ensure that the\nresponse does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.\n"
},
"funcGraph": {
"$ref": "#/types/flexibleengine:index%2FApigApiFuncGraph:ApigApiFuncGraph",
"description": "Specifies the function graph backend details. The object\nstructure is documented below. Changing this will create a new API resource.\n"
},
"funcGraphPolicies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiFuncGraphPolicy:ApigApiFuncGraphPolicy"
},
"description": "Specifies the Mock policy backends. The maximum of the policy is 5.\nThe object structure is documented below.\n"
},
"groupId": {
"type": "string",
"description": "Specifies an ID of the APIG group to which the API belongs to.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API belongs\nto. Changing this will create a new API resource.\n"
},
"matching": {
"type": "string",
"description": "Specifies the route matching mode. The valid value are **Exact** and **Prefix**,\ndefault to **Exact**.\n"
},
"mock": {
"$ref": "#/types/flexibleengine:index%2FApigApiMock:ApigApiMock",
"description": "Specifies the mock backend details. The object structure is documented\nbelow. Changing this will create a new API resource.\n"
},
"mockPolicies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiMockPolicy:ApigApiMockPolicy"
},
"description": "Specifies the Mock policy backends. The maximum of the policy is 5.\nThe object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API resource. If omitted, the\nprovider-level region will be used. Changing this will create a new API resource.\n"
},
"requestMethod": {
"type": "string",
"description": "Specifies the backend request method of the API. The valid types are **GET**,\n**POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.\n"
},
"requestParams": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiRequestParam:ApigApiRequestParam"
},
"description": "Specifies an array of one or more request parameters of the front-end. The maximum\nof request parameters is 50. The object structure is documented below.\n"
},
"requestPath": {
"type": "string",
"description": "Specifies the request address, which can contain a maximum of 512 characters\nrequest parameters enclosed with brackets ({}).\n+ The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and\nunderscores (_) and must comply with URI specifications.\n+ The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters.\nOnly letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.\n"
},
"requestProtocol": {
"type": "string",
"description": "Specifies the backend request protocol. The valid values are **HTTP** and\n**HTTPS**, default to **HTTPS**.\n"
},
"responseId": {
"type": "string",
"description": "Specifies the APIG group response ID.\n"
},
"securityAuthentication": {
"type": "string",
"description": "Specifies the security authentication mode. The valid values are\n**NONE**, **APP** and **IAM**, default to **NONE**.\n"
},
"simpleAuthentication": {
"type": "boolean",
"description": "Specifies whether AppCode authentication is enabled. The applicaiton code\nmust located in the header when `simple_authentication` is true.\n"
},
"successResponse": {
"type": "string",
"description": "Specifies the example response for a successful request. Ensure that the\nresponse does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"web": {
"$ref": "#/types/flexibleengine:index%2FApigApiWeb:ApigApiWeb",
"description": "Specifies the web backend details. The object structure is documented\nbelow. Changing this will create a new API resource.\n"
},
"webPolicies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiWebPolicy:ApigApiWebPolicy"
},
"description": "Specifies the example response for a failed request. The maximum of the policy is 5.\nThe object structure is documented below.\n\n\nThe `request_params` block supports:\n"
}
},
"requiredInputs": [
"groupId",
"instanceId",
"requestMethod",
"requestPath",
"requestProtocol",
"type"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigApi resources.\n",
"properties": {
"apigApiId": {
"type": "string",
"description": "ID of the APIG API.\n"
},
"authorizerId": {
"type": "string",
"description": "Specifies the ID of the backend custom authorization.\n\n\nThe `conditions` block supports:\n"
},
"backendParams": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiBackendParam:ApigApiBackendParam"
},
"description": "Specifies an array of one or more backend parameters. The maximum of request\nparameters is 50. The object structure is documented above.\n"
},
"bodyDescription": {
"type": "string",
"description": "Specifies the description of the API request body, which can be an example\nrequest body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be\nin UTF-8 or Unicode format.\n"
},
"cors": {
"type": "boolean",
"description": "Specifies whether CORS is supported, default to false.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the constant or system parameter, which contain a\nmaximum of 255 characters, and the angle brackets (< and >) are not allowed.\n"
},
"failureResponse": {
"type": "string",
"description": "Specifies the example response for a successful request. Ensure that the\nresponse does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.\n"
},
"funcGraph": {
"$ref": "#/types/flexibleengine:index%2FApigApiFuncGraph:ApigApiFuncGraph",
"description": "Specifies the function graph backend details. The object\nstructure is documented below. Changing this will create a new API resource.\n"
},
"funcGraphPolicies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiFuncGraphPolicy:ApigApiFuncGraphPolicy"
},
"description": "Specifies the Mock policy backends. The maximum of the policy is 5.\nThe object structure is documented below.\n"
},
"groupId": {
"type": "string",
"description": "Specifies an ID of the APIG group to which the API belongs to.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API belongs\nto. Changing this will create a new API resource.\n"
},
"matching": {
"type": "string",
"description": "Specifies the route matching mode. The valid value are **Exact** and **Prefix**,\ndefault to **Exact**.\n"
},
"mock": {
"$ref": "#/types/flexibleengine:index%2FApigApiMock:ApigApiMock",
"description": "Specifies the mock backend details. The object structure is documented\nbelow. Changing this will create a new API resource.\n"
},
"mockPolicies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiMockPolicy:ApigApiMockPolicy"
},
"description": "Specifies the Mock policy backends. The maximum of the policy is 5.\nThe object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Specifies the backend policy name, which can contains of 3 to 64 characters and start with\na letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API resource. If omitted, the\nprovider-level region will be used. Changing this will create a new API resource.\n"
},
"registeredAt": {
"type": "string",
"description": "Time when the API is registered, in UTC format.\n"
},
"requestMethod": {
"type": "string",
"description": "Specifies the backend request method of the API. The valid types are **GET**,\n**POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.\n"
},
"requestParams": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiRequestParam:ApigApiRequestParam"
},
"description": "Specifies an array of one or more request parameters of the front-end. The maximum\nof request parameters is 50. The object structure is documented below.\n"
},
"requestPath": {
"type": "string",
"description": "Specifies the request address, which can contain a maximum of 512 characters\nrequest parameters enclosed with brackets ({}).\n+ The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and\nunderscores (_) and must comply with URI specifications.\n+ The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters.\nOnly letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.\n"
},
"requestProtocol": {
"type": "string",
"description": "Specifies the backend request protocol. The valid values are **HTTP** and\n**HTTPS**, default to **HTTPS**.\n"
},
"responseId": {
"type": "string",
"description": "Specifies the APIG group response ID.\n"
},
"securityAuthentication": {
"type": "string",
"description": "Specifies the security authentication mode. The valid values are\n**NONE**, **APP** and **IAM**, default to **NONE**.\n"
},
"simpleAuthentication": {
"type": "boolean",
"description": "Specifies whether AppCode authentication is enabled. The applicaiton code\nmust located in the header when `simple_authentication` is true.\n"
},
"successResponse": {
"type": "string",
"description": "Specifies the example response for a successful request. Ensure that the\nresponse does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.\n"
},
"type": {
"type": "string",
"description": "Specifies the condition type of the backend policy. The valid values are **Equal**,\n**Enumerated** and **Matching**, default to **Equal**.\n"
},
"updatedAt": {
"type": "string",
"description": "Time when the API was last modified, in UTC format.\n"
},
"web": {
"$ref": "#/types/flexibleengine:index%2FApigApiWeb:ApigApiWeb",
"description": "Specifies the web backend details. The object structure is documented\nbelow. Changing this will create a new API resource.\n"
},
"webPolicies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiWebPolicy:ApigApiWebPolicy"
},
"description": "Specifies the example response for a failed request. The maximum of the policy is 5.\nThe object structure is documented below.\n\n\nThe `request_params` block supports:\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigApiPublishment:ApigApiPublishment": {
"description": "## Example Usage\n\n### Publish a new version of the API\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst envId = config.requireObject(\"envId\");\nconst apiId = config.requireObject(\"apiId\");\nconst _default = new flexibleengine.ApigApiPublishment(\"default\", {\n instanceId: instanceId,\n envId: envId,\n apiId: apiId,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\nenv_id = config.require_object(\"envId\")\napi_id = config.require_object(\"apiId\")\ndefault = flexibleengine.ApigApiPublishment(\"default\",\n instance_id=instance_id,\n env_id=env_id,\n api_id=api_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var envId = config.RequireObject(\"envId\");\n var apiId = config.RequireObject(\"apiId\");\n var @default = new Flexibleengine.ApigApiPublishment(\"default\", new()\n {\n InstanceId = instanceId,\n EnvId = envId,\n ApiId = apiId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tenvId := cfg.RequireObject(\"envId\")\n\t\tapiId := cfg.RequireObject(\"apiId\")\n\t\t_, err := flexibleengine.NewApigApiPublishment(ctx, \"default\", &flexibleengine.ApigApiPublishmentArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tEnvId: pulumi.Any(envId),\n\t\t\tApiId: pulumi.Any(apiId),\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.flexibleengine.ApigApiPublishment;\nimport com.pulumi.flexibleengine.ApigApiPublishmentArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var envId = config.get(\"envId\");\n final var apiId = config.get(\"apiId\");\n var default_ = new ApigApiPublishment(\"default\", ApigApiPublishmentArgs.builder()\n .instanceId(instanceId)\n .envId(envId)\n .apiId(apiId)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n envId:\n type: dynamic\n apiId:\n type: dynamic\nresources:\n default:\n type: flexibleengine:ApigApiPublishment\n properties:\n instanceId: ${instanceId}\n envId: ${envId}\n apiId: ${apiId}\n```\n\n\n### Switch to a specified version of the API which is published\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst envId = config.requireObject(\"envId\");\nconst apiId = config.requireObject(\"apiId\");\nconst versionId = config.requireObject(\"versionId\");\nconst _default = new flexibleengine.ApigApiPublishment(\"default\", {\n instanceId: instanceId,\n envId: envId,\n apiId: apiId,\n versionId: versionId,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\nenv_id = config.require_object(\"envId\")\napi_id = config.require_object(\"apiId\")\nversion_id = config.require_object(\"versionId\")\ndefault = flexibleengine.ApigApiPublishment(\"default\",\n instance_id=instance_id,\n env_id=env_id,\n api_id=api_id,\n version_id=version_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var envId = config.RequireObject(\"envId\");\n var apiId = config.RequireObject(\"apiId\");\n var versionId = config.RequireObject(\"versionId\");\n var @default = new Flexibleengine.ApigApiPublishment(\"default\", new()\n {\n InstanceId = instanceId,\n EnvId = envId,\n ApiId = apiId,\n VersionId = versionId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tenvId := cfg.RequireObject(\"envId\")\n\t\tapiId := cfg.RequireObject(\"apiId\")\n\t\tversionId := cfg.RequireObject(\"versionId\")\n\t\t_, err := flexibleengine.NewApigApiPublishment(ctx, \"default\", &flexibleengine.ApigApiPublishmentArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tEnvId: pulumi.Any(envId),\n\t\t\tApiId: pulumi.Any(apiId),\n\t\t\tVersionId: pulumi.Any(versionId),\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.flexibleengine.ApigApiPublishment;\nimport com.pulumi.flexibleengine.ApigApiPublishmentArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var envId = config.get(\"envId\");\n final var apiId = config.get(\"apiId\");\n final var versionId = config.get(\"versionId\");\n var default_ = new ApigApiPublishment(\"default\", ApigApiPublishmentArgs.builder()\n .instanceId(instanceId)\n .envId(envId)\n .apiId(apiId)\n .versionId(versionId)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n envId:\n type: dynamic\n apiId:\n type: dynamic\n versionId:\n type: dynamic\nresources:\n default:\n type: flexibleengine:ApigApiPublishment\n properties:\n instanceId: ${instanceId}\n envId: ${envId}\n apiId: ${apiId}\n versionId: ${versionId}\n```\n\n\n## Import\n\nAPIs can be imported using their `instance_id`, `env_id` and `api_id`, separated by slashes, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigApiPublishment:ApigApiPublishment test \n```\n\n9b0a0a2f97aa43afbf7d852e3ba6a6f9/c5b32727186c4fe6b60408a8a297be09/9a3b3484c08545f9b9b0dcb2de0f5b8a\n\n",
"properties": {
"apiId": {
"type": "string",
"description": "Specifies the API ID to be published or already published.\nChanging this will create a new publishment resource.\n"
},
"apigApiPublishmentId": {
"type": "string",
"description": "Resource ID, which is constructed from the instance ID, environment ID, and API ID, separated by slashes.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the current publishment.\n"
},
"envId": {
"type": "string",
"description": "Specifies the environment ID to which the current version of the API will be\npublished or has been published. Changing this will create a new publishment resource.\n"
},
"envName": {
"type": "string",
"description": "Environment name to which the current version of the API is published.\n"
},
"histories": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiPublishmentHistory:ApigApiPublishmentHistory"
},
"description": "All publish informations of the API. The structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API belongs\nto. Changing this will create a new publishment resource.\n"
},
"publishId": {
"type": "string",
"description": "The publish ID of the API in current environment.\n"
},
"publishedAt": {
"type": "string",
"description": "Time when the current version was published.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to publish APIs.\nIf omitted, the provider-level region will be used. Changing this will create a new publishment resource.\n"
},
"versionId": {
"type": "string",
"description": "Specifies the version ID of the current publishment.\n"
}
},
"type": "object",
"required": [
"apiId",
"apigApiPublishmentId",
"envId",
"envName",
"histories",
"instanceId",
"publishId",
"publishedAt",
"region"
],
"inputProperties": {
"apiId": {
"type": "string",
"description": "Specifies the API ID to be published or already published.\nChanging this will create a new publishment resource.\n"
},
"apigApiPublishmentId": {
"type": "string",
"description": "Resource ID, which is constructed from the instance ID, environment ID, and API ID, separated by slashes.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the current publishment.\n"
},
"envId": {
"type": "string",
"description": "Specifies the environment ID to which the current version of the API will be\npublished or has been published. Changing this will create a new publishment resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API belongs\nto. Changing this will create a new publishment resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to publish APIs.\nIf omitted, the provider-level region will be used. Changing this will create a new publishment resource.\n"
},
"versionId": {
"type": "string",
"description": "Specifies the version ID of the current publishment.\n"
}
},
"requiredInputs": [
"apiId",
"envId",
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigApiPublishment resources.\n",
"properties": {
"apiId": {
"type": "string",
"description": "Specifies the API ID to be published or already published.\nChanging this will create a new publishment resource.\n"
},
"apigApiPublishmentId": {
"type": "string",
"description": "Resource ID, which is constructed from the instance ID, environment ID, and API ID, separated by slashes.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the current publishment.\n"
},
"envId": {
"type": "string",
"description": "Specifies the environment ID to which the current version of the API will be\npublished or has been published. Changing this will create a new publishment resource.\n"
},
"envName": {
"type": "string",
"description": "Environment name to which the current version of the API is published.\n"
},
"histories": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigApiPublishmentHistory:ApigApiPublishmentHistory"
},
"description": "All publish informations of the API. The structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API belongs\nto. Changing this will create a new publishment resource.\n"
},
"publishId": {
"type": "string",
"description": "The publish ID of the API in current environment.\n"
},
"publishedAt": {
"type": "string",
"description": "Time when the current version was published.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to publish APIs.\nIf omitted, the provider-level region will be used. Changing this will create a new publishment resource.\n"
},
"versionId": {
"type": "string",
"description": "Specifies the version ID of the current publishment.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigAppcode:ApigAppcode": {
"description": "Manages an APPCODE in application resource within FlexibleEngine.\n\n## Example Usage\n\n### Auto generate APPCODE\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst applicationId = config.requireObject(\"applicationId\");\nconst test = new flexibleengine.ApigAppcode(\"test\", {\n instanceId: instanceId,\n applicationId: applicationId,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\napplication_id = config.require_object(\"applicationId\")\ntest = flexibleengine.ApigAppcode(\"test\",\n instance_id=instance_id,\n application_id=application_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var applicationId = config.RequireObject(\"applicationId\");\n var test = new Flexibleengine.ApigAppcode(\"test\", new()\n {\n InstanceId = instanceId,\n ApplicationId = applicationId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tapplicationId := cfg.RequireObject(\"applicationId\")\n\t\t_, err := flexibleengine.NewApigAppcode(ctx, \"test\", &flexibleengine.ApigAppcodeArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tApplicationId: pulumi.Any(applicationId),\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.flexibleengine.ApigAppcode;\nimport com.pulumi.flexibleengine.ApigAppcodeArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var applicationId = config.get(\"applicationId\");\n var test = new ApigAppcode(\"test\", ApigAppcodeArgs.builder()\n .instanceId(instanceId)\n .applicationId(applicationId)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n applicationId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigAppcode\n properties:\n instanceId: ${instanceId}\n applicationId: ${applicationId}\n```\n\n\n### Manually configure APPCODE\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst applicationId = config.requireObject(\"applicationId\");\nconst appCode = config.requireObject(\"appCode\");\nconst test = new flexibleengine.ApigAppcode(\"test\", {\n instanceId: instanceId,\n applicationId: applicationId,\n value: appCode,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\napplication_id = config.require_object(\"applicationId\")\napp_code = config.require_object(\"appCode\")\ntest = flexibleengine.ApigAppcode(\"test\",\n instance_id=instance_id,\n application_id=application_id,\n value=app_code)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var applicationId = config.RequireObject(\"applicationId\");\n var appCode = config.RequireObject(\"appCode\");\n var test = new Flexibleengine.ApigAppcode(\"test\", new()\n {\n InstanceId = instanceId,\n ApplicationId = applicationId,\n Value = appCode,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tapplicationId := cfg.RequireObject(\"applicationId\")\n\t\tappCode := cfg.RequireObject(\"appCode\")\n\t\t_, err := flexibleengine.NewApigAppcode(ctx, \"test\", &flexibleengine.ApigAppcodeArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tApplicationId: pulumi.Any(applicationId),\n\t\t\tValue: pulumi.Any(appCode),\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.flexibleengine.ApigAppcode;\nimport com.pulumi.flexibleengine.ApigAppcodeArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var applicationId = config.get(\"applicationId\");\n final var appCode = config.get(\"appCode\");\n var test = new ApigAppcode(\"test\", ApigAppcodeArgs.builder()\n .instanceId(instanceId)\n .applicationId(applicationId)\n .value(appCode)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n applicationId:\n type: dynamic\n appCode:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigAppcode\n properties:\n instanceId: ${instanceId}\n applicationId: ${applicationId}\n value: ${appCode}\n```\n\n\n## Import\n\nAPPCODEs can be imported using related `instance_id`, `application_id` and their `id`, separated by slashes, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/apigAppcode:ApigAppcode test //\n```\n\n",
"properties": {
"apigAppcodeId": {
"type": "string",
"description": "The APPCODE ID.\n"
},
"applicationId": {
"type": "string",
"description": "Specifies the ID of application to which the APPCODE belongs.\nChanging this will create a new resource.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the APPCODE.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the application\nand APPCODE belong.\nChanging this will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the application and APPCODE are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"value": {
"type": "string",
"description": "Specifies the APPCODE value (content).\nThe value can contain `64` to `180` characters, starting with a letter, plus sign (+), or slash (/). Only letters and\nthe following special characters are allowed: `+_!@#$%/=`.\nIf omitted, a random value will be generated.\nChanging this will create a new resource.\n"
}
},
"type": "object",
"required": [
"apigAppcodeId",
"applicationId",
"createdAt",
"instanceId",
"region",
"value"
],
"inputProperties": {
"apigAppcodeId": {
"type": "string",
"description": "The APPCODE ID.\n"
},
"applicationId": {
"type": "string",
"description": "Specifies the ID of application to which the APPCODE belongs.\nChanging this will create a new resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the application\nand APPCODE belong.\nChanging this will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the application and APPCODE are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"value": {
"type": "string",
"description": "Specifies the APPCODE value (content).\nThe value can contain `64` to `180` characters, starting with a letter, plus sign (+), or slash (/). Only letters and\nthe following special characters are allowed: `+_!@#$%/=`.\nIf omitted, a random value will be generated.\nChanging this will create a new resource.\n"
}
},
"requiredInputs": [
"applicationId",
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigAppcode resources.\n",
"properties": {
"apigAppcodeId": {
"type": "string",
"description": "The APPCODE ID.\n"
},
"applicationId": {
"type": "string",
"description": "Specifies the ID of application to which the APPCODE belongs.\nChanging this will create a new resource.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the APPCODE.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the application\nand APPCODE belong.\nChanging this will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the application and APPCODE are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"value": {
"type": "string",
"description": "Specifies the APPCODE value (content).\nThe value can contain `64` to `180` characters, starting with a letter, plus sign (+), or slash (/). Only letters and\nthe following special characters are allowed: `+_!@#$%/=`.\nIf omitted, a random value will be generated.\nChanging this will create a new resource.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigApplication:ApigApplication": {
"description": "Manages an APIG application resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst appName = config.requireObject(\"appName\");\nconst appCode = config.requireObject(\"appCode\");\nconst test = new flexibleengine.ApigApplication(\"test\", {\n instanceId: instanceId,\n description: \"Created by script\",\n appCodes: [appCode],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\napp_name = config.require_object(\"appName\")\napp_code = config.require_object(\"appCode\")\ntest = flexibleengine.ApigApplication(\"test\",\n instance_id=instance_id,\n description=\"Created by script\",\n app_codes=[app_code])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var appName = config.RequireObject(\"appName\");\n var appCode = config.RequireObject(\"appCode\");\n var test = new Flexibleengine.ApigApplication(\"test\", new()\n {\n InstanceId = instanceId,\n Description = \"Created by script\",\n AppCodes = new[]\n {\n appCode,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tappName := cfg.RequireObject(\"appName\")\n\t\tappCode := cfg.RequireObject(\"appCode\")\n\t\t_, err := flexibleengine.NewApigApplication(ctx, \"test\", &flexibleengine.ApigApplicationArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tDescription: pulumi.String(\"Created by script\"),\n\t\t\tAppCodes: pulumi.StringArray{\n\t\t\t\tappCode,\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.flexibleengine.ApigApplication;\nimport com.pulumi.flexibleengine.ApigApplicationArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var appName = config.get(\"appName\");\n final var appCode = config.get(\"appCode\");\n var test = new ApigApplication(\"test\", ApigApplicationArgs.builder()\n .instanceId(instanceId)\n .description(\"Created by script\")\n .appCodes(appCode)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n appName:\n type: dynamic\n appCode:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigApplication\n properties:\n instanceId: ${instanceId}\n description: Created by script\n appCodes:\n - ${appCode}\n```\n\n\n## Import\n\nAPIG Applications can be imported using the ID of the APIG dedicated instance to which the application\n\nbelongs and APIG Application ID, separated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigApplication:ApigApplication test /\n```\n\n",
"properties": {
"apigApplicationId": {
"type": "string",
"description": "ID of the APIG application.\n"
},
"appCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies an array of one or more application codes which the APIG application belongs\nto. Up to five application codes can be created. The code consists of 64 to 180 characters, starting with a letter,\ndigit, plus sign (+) or slash (/). Only letters, digits and following special special characters are allowed: !@#$%+-_\n/=\n"
},
"appKey": {
"type": "string",
"description": "App key.\n"
},
"appSecret": {
"type": "string",
"description": "App secret.\n",
"secret": true
},
"description": {
"type": "string",
"description": "Specifies the description about the APIG application. The description contain a\nmaximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or\nUnicode format.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the APIG\napplication belongs to. Changing this will create a new APIG application resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API application. The API group name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be\nin UTF-8 or Unicode format.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the APIG application resource. If\nomitted, the provider-level region will be used. Changing this will create a new APIG application resource.\n"
},
"registrationTime": {
"type": "string",
"description": "Registration time, in RFC-3339 format.\n"
},
"secretAction": {
"type": "string",
"description": "Specifies the secret action to be done for the APIG application. The valid action\nis *RESET*.\n\n> **NOTE:** The `secret_action` is a one-time action.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the application.\n"
}
},
"type": "object",
"required": [
"apigApplicationId",
"appCodes",
"appKey",
"appSecret",
"description",
"instanceId",
"name",
"region",
"registrationTime",
"updatedAt"
],
"inputProperties": {
"apigApplicationId": {
"type": "string",
"description": "ID of the APIG application.\n"
},
"appCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies an array of one or more application codes which the APIG application belongs\nto. Up to five application codes can be created. The code consists of 64 to 180 characters, starting with a letter,\ndigit, plus sign (+) or slash (/). Only letters, digits and following special special characters are allowed: !@#$%+-_\n/=\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the APIG application. The description contain a\nmaximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or\nUnicode format.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the APIG\napplication belongs to. Changing this will create a new APIG application resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API application. The API group name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be\nin UTF-8 or Unicode format.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the APIG application resource. If\nomitted, the provider-level region will be used. Changing this will create a new APIG application resource.\n"
},
"secretAction": {
"type": "string",
"description": "Specifies the secret action to be done for the APIG application. The valid action\nis *RESET*.\n\n> **NOTE:** The `secret_action` is a one-time action.\n"
}
},
"requiredInputs": [
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigApplication resources.\n",
"properties": {
"apigApplicationId": {
"type": "string",
"description": "ID of the APIG application.\n"
},
"appCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies an array of one or more application codes which the APIG application belongs\nto. Up to five application codes can be created. The code consists of 64 to 180 characters, starting with a letter,\ndigit, plus sign (+) or slash (/). Only letters, digits and following special special characters are allowed: !@#$%+-_\n/=\n"
},
"appKey": {
"type": "string",
"description": "App key.\n"
},
"appSecret": {
"type": "string",
"description": "App secret.\n",
"secret": true
},
"description": {
"type": "string",
"description": "Specifies the description about the APIG application. The description contain a\nmaximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or\nUnicode format.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the APIG\napplication belongs to. Changing this will create a new APIG application resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API application. The API group name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be\nin UTF-8 or Unicode format.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the APIG application resource. If\nomitted, the provider-level region will be used. Changing this will create a new APIG application resource.\n"
},
"registrationTime": {
"type": "string",
"description": "Registration time, in RFC-3339 format.\n"
},
"secretAction": {
"type": "string",
"description": "Specifies the secret action to be done for the APIG application. The valid action\nis *RESET*.\n\n> **NOTE:** The `secret_action` is a one-time action.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the application.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigApplicationAuthorization:ApigApplicationAuthorization": {
"description": "Using this resource to authorize APIs for application, allowing it to access the published APIs within FlexibleEngine.\n\n> For an application, an environment can only create one `flexibleengine.ApigApplicationAuthorization` resource (all\n published APIs must belong to an environment).\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst applicationId = config.requireObject(\"applicationId\");\nconst publishedEnvId = config.requireObject(\"publishedEnvId\");\nconst publishedApiIds = config.requireObject>(\"publishedApiIds\");\nconst test = new flexibleengine.ApigApplicationAuthorization(\"test\", {\n instanceId: instanceId,\n applicationId: applicationId,\n envId: publishedEnvId,\n apiIds: publishedApiIds,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\napplication_id = config.require_object(\"applicationId\")\npublished_env_id = config.require_object(\"publishedEnvId\")\npublished_api_ids = config.require_object(\"publishedApiIds\")\ntest = flexibleengine.ApigApplicationAuthorization(\"test\",\n instance_id=instance_id,\n application_id=application_id,\n env_id=published_env_id,\n api_ids=published_api_ids)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var applicationId = config.RequireObject(\"applicationId\");\n var publishedEnvId = config.RequireObject(\"publishedEnvId\");\n var publishedApiIds = config.RequireObject(\"publishedApiIds\");\n var test = new Flexibleengine.ApigApplicationAuthorization(\"test\", new()\n {\n InstanceId = instanceId,\n ApplicationId = applicationId,\n EnvId = publishedEnvId,\n ApiIds = publishedApiIds,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tapplicationId := cfg.RequireObject(\"applicationId\")\n\t\tpublishedEnvId := cfg.RequireObject(\"publishedEnvId\")\n\t\tpublishedApiIds := cfg.Require(\"publishedApiIds\")\n\t\t_, err := flexibleengine.NewApigApplicationAuthorization(ctx, \"test\", &flexibleengine.ApigApplicationAuthorizationArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tApplicationId: pulumi.Any(applicationId),\n\t\t\tEnvId: pulumi.Any(publishedEnvId),\n\t\t\tApiIds: publishedApiIds,\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.flexibleengine.ApigApplicationAuthorization;\nimport com.pulumi.flexibleengine.ApigApplicationAuthorizationArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var applicationId = config.get(\"applicationId\");\n final var publishedEnvId = config.get(\"publishedEnvId\");\n final var publishedApiIds = config.get(\"publishedApiIds\");\n var test = new ApigApplicationAuthorization(\"test\", ApigApplicationAuthorizationArgs.builder()\n .instanceId(instanceId)\n .applicationId(applicationId)\n .envId(publishedEnvId)\n .apiIds(publishedApiIds)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n applicationId:\n type: dynamic\n publishedEnvId:\n type: dynamic\n publishedApiIds:\n type: list(string)\nresources:\n test:\n type: flexibleengine:ApigApplicationAuthorization\n properties:\n instanceId: ${instanceId}\n applicationId: ${applicationId}\n envId: ${publishedEnvId}\n apiIds: ${publishedApiIds}\n```\n\n\n## Import\n\nAuthorize relationships of application can be imported using related `instance_id` and their `id` (also consists of\n\n`env_id` and `application_id`), separated by the slashes, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/apigApplicationAuthorization:ApigApplicationAuthorization test //\n```\n\n",
"properties": {
"apiIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the authorized API IDs.\n"
},
"apigApplicationAuthorizationId": {
"type": "string",
"description": "The resource ID, also `/`.\n"
},
"applicationId": {
"type": "string",
"description": "Specifies the ID of the application authorized to access the APIs.\nChanging this will create a new resource.\n"
},
"envId": {
"type": "string",
"description": "Specifies the environment ID where the APIs were published.\nChanging this will create a new resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the application\nand APIs belong.\nChanging this will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the application and APIs are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApigApplicationAuthorizationTimeouts:ApigApplicationAuthorizationTimeouts"
}
},
"type": "object",
"required": [
"apiIds",
"apigApplicationAuthorizationId",
"applicationId",
"envId",
"instanceId",
"region"
],
"inputProperties": {
"apiIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the authorized API IDs.\n"
},
"apigApplicationAuthorizationId": {
"type": "string",
"description": "The resource ID, also `/`.\n"
},
"applicationId": {
"type": "string",
"description": "Specifies the ID of the application authorized to access the APIs.\nChanging this will create a new resource.\n"
},
"envId": {
"type": "string",
"description": "Specifies the environment ID where the APIs were published.\nChanging this will create a new resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the application\nand APIs belong.\nChanging this will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the application and APIs are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApigApplicationAuthorizationTimeouts:ApigApplicationAuthorizationTimeouts"
}
},
"requiredInputs": [
"apiIds",
"applicationId",
"envId",
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigApplicationAuthorization resources.\n",
"properties": {
"apiIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the authorized API IDs.\n"
},
"apigApplicationAuthorizationId": {
"type": "string",
"description": "The resource ID, also `/`.\n"
},
"applicationId": {
"type": "string",
"description": "Specifies the ID of the application authorized to access the APIs.\nChanging this will create a new resource.\n"
},
"envId": {
"type": "string",
"description": "Specifies the environment ID where the APIs were published.\nChanging this will create a new resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the application\nand APIs belong.\nChanging this will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the application and APIs are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApigApplicationAuthorizationTimeouts:ApigApplicationAuthorizationTimeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/apigChannel:ApigChannel": {
"description": "Manages a channel resource within FlexibleEngine.\n\n> After creating a channel of type server, you can configure it for an API of an HTTP/HTTPS backend service.\n\n## Example Usage\n\n### Create a channel of type server and use the default group to manage servers\n\n\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n channelName:\n type: dynamic\n backendServers:\n type: list(object({group_name = union(none, string), id = union(none, string), weight = union(none, number)}))\nresources:\n test:\n type: flexibleengine:ApigChannel\n properties:\n instanceId: ${instanceId}\n port: 8080\n dynamic:\n - forEach: ${backendServers}\n content:\n - id: ${member.value.id}\n weight: ${member.value.weight}\n```\n\n\n### Create a channel of type server and use the custom group to manage servers\n\n\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n channelName:\n type: dynamic\n backendServerGroups:\n type: list(object({description = union(none, string), name = union(none, string), weight = union(none, number)}))\n backendServers:\n type: list(object({group_name = union(none, string), id = union(none, string), weight = union(none, number)}))\nresources:\n test:\n type: flexibleengine:ApigChannel\n properties:\n instanceId: ${instanceId}\n port: 8080\n # The length of group list cannot be 0 if you want to use dynamic syntax\n dynamic:\n - forEach: ${backendServerGroups}\n content:\n - name: ${member.value.name}\n description: ${member.value.description}\n weight: ${member.value.weight}\n - forEach: ${backendServers}\n content:\n - groupName: ${member.value.group_name}\n id: ${member.value.id}\n weight: ${member.value.weight}\n```\n\n\n### Create a channel of type microservice\n\n\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n channelName:\n type: dynamic\n clusterId:\n type: dynamic\n workloadName:\n type: dynamic\n memberGroupsConfig:\n type: list(object({microservice_labels = union(map(string), none), microservice_port = union(none, number), name = union(none, string), weight = union(none, number)}))\nresources:\n test:\n type: flexibleengine:ApigChannel\n properties:\n instanceId: ${instanceId}\n port: 80\n balanceStrategy: 1\n memberType: ip\n type: 3\n dynamic:\n - forEach: ${memberGroupsConfig}\n content:\n - name: ${member_group.value.name}\n weight: ${member_group.value.weight}\n microservicePort: ${member_group.value.microservice_port}\n microserviceLabels: ${member_group.value.microservice_labels}\n healthCheck:\n protocol: TCP\n thresholdNormal: 2\n thresholdAbnormal: 2\n interval: 5\n timeout: 2\n port: 65530\n path: /\n method: GET\n httpCodes: 200,201,208-209\n enableClientSsl: false\n status: 1\n microservice:\n cceConfig:\n clusterId: ${clusterId}\n namespace: default\n workloadType: deployment\n workloadName: ${workloadName}\n```\n\n\n## Import\n\nChannels can be imported using their `id` and the ID of the related dedicated instance, separated by a slash, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/apigChannel:ApigChannel test /\n```\n\n",
"properties": {
"apigChannelId": {
"type": "string",
"description": "Specifies the ECS ID for each backend servers. \nRequired if the `member_type` is **ecs**.\nThis parameter and `member.host` are alternative.\n"
},
"balanceStrategy": {
"type": "number",
"description": "Specifies the distribution algorithm. \nThe valid values are as follows:\n+ **1**: Weighted round robin (WRR).\n+ **2**: Weighted least connections (WLC).\n+ **3**: Source hashing.\n+ **4**: URI hashing.\n"
},
"createdAt": {
"type": "string",
"description": "The time when the channel was created.\n"
},
"healthCheck": {
"$ref": "#/types/flexibleengine:index%2FApigChannelHealthCheck:ApigChannelHealthCheck",
"description": "Specifies the health configuration of cloud servers associated with the load balance\nchannel for APIG regularly check.\nThe health_check structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the channel\nbelongs.\nChanging this will create a new resource.\n"
},
"memberGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMemberGroup:ApigChannelMemberGroup"
},
"description": "Specifies the backend (server) groups of the channel. \nThe member_group structure is documented below.\n"
},
"memberType": {
"type": "string",
"description": "Specifies the member type of the channel. \nThe valid values are as follows:\n+ **ip**.\n+ **ecs**.\n"
},
"members": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMember:ApigChannelMember"
},
"description": "Specifies the backend servers of the channel. \nThis parameter is required and only available if the `type` is **2**.\nThe member structure is documented below.\n"
},
"microservice": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMicroservice:ApigChannelMicroservice",
"description": "Specifies the configuration of the microservice. \nThe microservice structure is documented below.\n\n\nThe `member_group` block supports:\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the backend server. \nRequired if the `member.id` is set.\nThis parameter and `member.host` are alternative.\n"
},
"port": {
"type": "number",
"description": "Specifies the destination host port for health check. \nThe valid value ranges from `0` to `65535`.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the channel is located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"status": {
"type": "number",
"description": "Specifies the status of health check. \nThe valid values are as follows:\n+ **1**: Normal.\n+ **2**: Abnormal.\n\nDefaults to **1** (normal).\n\n\nThe `microservice` block supports:\n"
},
"type": {
"type": "number",
"description": "Specifies the type of the channel. \nThe valid values are as follows:\n+ **2**: Server type.\n+ **3**: Microservice type.\n\nDefaults to **2** (server type).\n"
}
},
"type": "object",
"required": [
"apigChannelId",
"balanceStrategy",
"createdAt",
"instanceId",
"memberType",
"name",
"port",
"region",
"status",
"type"
],
"inputProperties": {
"apigChannelId": {
"type": "string",
"description": "Specifies the ECS ID for each backend servers. \nRequired if the `member_type` is **ecs**.\nThis parameter and `member.host` are alternative.\n"
},
"balanceStrategy": {
"type": "number",
"description": "Specifies the distribution algorithm. \nThe valid values are as follows:\n+ **1**: Weighted round robin (WRR).\n+ **2**: Weighted least connections (WLC).\n+ **3**: Source hashing.\n+ **4**: URI hashing.\n"
},
"healthCheck": {
"$ref": "#/types/flexibleengine:index%2FApigChannelHealthCheck:ApigChannelHealthCheck",
"description": "Specifies the health configuration of cloud servers associated with the load balance\nchannel for APIG regularly check.\nThe health_check structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the channel\nbelongs.\nChanging this will create a new resource.\n"
},
"memberGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMemberGroup:ApigChannelMemberGroup"
},
"description": "Specifies the backend (server) groups of the channel. \nThe member_group structure is documented below.\n"
},
"memberType": {
"type": "string",
"description": "Specifies the member type of the channel. \nThe valid values are as follows:\n+ **ip**.\n+ **ecs**.\n"
},
"members": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMember:ApigChannelMember"
},
"description": "Specifies the backend servers of the channel. \nThis parameter is required and only available if the `type` is **2**.\nThe member structure is documented below.\n"
},
"microservice": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMicroservice:ApigChannelMicroservice",
"description": "Specifies the configuration of the microservice. \nThe microservice structure is documented below.\n\n\nThe `member_group` block supports:\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the backend server. \nRequired if the `member.id` is set.\nThis parameter and `member.host` are alternative.\n"
},
"port": {
"type": "number",
"description": "Specifies the destination host port for health check. \nThe valid value ranges from `0` to `65535`.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the channel is located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"type": {
"type": "number",
"description": "Specifies the type of the channel. \nThe valid values are as follows:\n+ **2**: Server type.\n+ **3**: Microservice type.\n\nDefaults to **2** (server type).\n"
}
},
"requiredInputs": [
"balanceStrategy",
"instanceId",
"port"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigChannel resources.\n",
"properties": {
"apigChannelId": {
"type": "string",
"description": "Specifies the ECS ID for each backend servers. \nRequired if the `member_type` is **ecs**.\nThis parameter and `member.host` are alternative.\n"
},
"balanceStrategy": {
"type": "number",
"description": "Specifies the distribution algorithm. \nThe valid values are as follows:\n+ **1**: Weighted round robin (WRR).\n+ **2**: Weighted least connections (WLC).\n+ **3**: Source hashing.\n+ **4**: URI hashing.\n"
},
"createdAt": {
"type": "string",
"description": "The time when the channel was created.\n"
},
"healthCheck": {
"$ref": "#/types/flexibleengine:index%2FApigChannelHealthCheck:ApigChannelHealthCheck",
"description": "Specifies the health configuration of cloud servers associated with the load balance\nchannel for APIG regularly check.\nThe health_check structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the channel\nbelongs.\nChanging this will create a new resource.\n"
},
"memberGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMemberGroup:ApigChannelMemberGroup"
},
"description": "Specifies the backend (server) groups of the channel. \nThe member_group structure is documented below.\n"
},
"memberType": {
"type": "string",
"description": "Specifies the member type of the channel. \nThe valid values are as follows:\n+ **ip**.\n+ **ecs**.\n"
},
"members": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMember:ApigChannelMember"
},
"description": "Specifies the backend servers of the channel. \nThis parameter is required and only available if the `type` is **2**.\nThe member structure is documented below.\n"
},
"microservice": {
"$ref": "#/types/flexibleengine:index%2FApigChannelMicroservice:ApigChannelMicroservice",
"description": "Specifies the configuration of the microservice. \nThe microservice structure is documented below.\n\n\nThe `member_group` block supports:\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the backend server. \nRequired if the `member.id` is set.\nThis parameter and `member.host` are alternative.\n"
},
"port": {
"type": "number",
"description": "Specifies the destination host port for health check. \nThe valid value ranges from `0` to `65535`.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the channel is located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"status": {
"type": "number",
"description": "Specifies the status of health check. \nThe valid values are as follows:\n+ **1**: Normal.\n+ **2**: Abnormal.\n\nDefaults to **1** (normal).\n\n\nThe `microservice` block supports:\n"
},
"type": {
"type": "number",
"description": "Specifies the type of the channel. \nThe valid values are as follows:\n+ **2**: Server type.\n+ **3**: Microservice type.\n\nDefaults to **2** (server type).\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigCustomAuthorizer:ApigCustomAuthorizer": {
"description": "Manages an APIG custom authorizer resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst authorizerName = config.requireObject(\"authorizerName\");\nconst functionUrn = config.requireObject(\"functionUrn\");\nconst test = new flexibleengine.ApigCustomAuthorizer(\"test\", {\n instanceId: instanceId,\n functionUrn: functionUrn,\n type: \"FRONTEND\",\n cacheAge: 60,\n identities: [{\n name: \"user_name\",\n location: \"QUERY\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\nauthorizer_name = config.require_object(\"authorizerName\")\nfunction_urn = config.require_object(\"functionUrn\")\ntest = flexibleengine.ApigCustomAuthorizer(\"test\",\n instance_id=instance_id,\n function_urn=function_urn,\n type=\"FRONTEND\",\n cache_age=60,\n identities=[{\n \"name\": \"user_name\",\n \"location\": \"QUERY\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var authorizerName = config.RequireObject(\"authorizerName\");\n var functionUrn = config.RequireObject(\"functionUrn\");\n var test = new Flexibleengine.ApigCustomAuthorizer(\"test\", new()\n {\n InstanceId = instanceId,\n FunctionUrn = functionUrn,\n Type = \"FRONTEND\",\n CacheAge = 60,\n Identities = new[]\n {\n new Flexibleengine.Inputs.ApigCustomAuthorizerIdentityArgs\n {\n Name = \"user_name\",\n Location = \"QUERY\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tauthorizerName := cfg.RequireObject(\"authorizerName\")\n\t\tfunctionUrn := cfg.RequireObject(\"functionUrn\")\n\t\t_, err := flexibleengine.NewApigCustomAuthorizer(ctx, \"test\", &flexibleengine.ApigCustomAuthorizerArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tFunctionUrn: pulumi.Any(functionUrn),\n\t\t\tType: pulumi.String(\"FRONTEND\"),\n\t\t\tCacheAge: pulumi.Float64(60),\n\t\t\tIdentities: flexibleengine.ApigCustomAuthorizerIdentityArray{\n\t\t\t\t&flexibleengine.ApigCustomAuthorizerIdentityArgs{\n\t\t\t\t\tName: pulumi.String(\"user_name\"),\n\t\t\t\t\tLocation: pulumi.String(\"QUERY\"),\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.flexibleengine.ApigCustomAuthorizer;\nimport com.pulumi.flexibleengine.ApigCustomAuthorizerArgs;\nimport com.pulumi.flexibleengine.inputs.ApigCustomAuthorizerIdentityArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var authorizerName = config.get(\"authorizerName\");\n final var functionUrn = config.get(\"functionUrn\");\n var test = new ApigCustomAuthorizer(\"test\", ApigCustomAuthorizerArgs.builder()\n .instanceId(instanceId)\n .functionUrn(functionUrn)\n .type(\"FRONTEND\")\n .cacheAge(60)\n .identities(ApigCustomAuthorizerIdentityArgs.builder()\n .name(\"user_name\")\n .location(\"QUERY\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n authorizerName:\n type: dynamic\n functionUrn:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigCustomAuthorizer\n properties:\n instanceId: ${instanceId}\n functionUrn: ${functionUrn}\n type: FRONTEND\n cacheAge: 60\n identities:\n - name: user_name\n location: QUERY\n```\n\n\n## Import\n\nCustom Authorizers of the APIG can be imported using the ID of the APIG instance to which the group belongs and\n\nCustom Authorizer `name`, separated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigCustomAuthorizer:ApigCustomAuthorizer test /\n```\n\n",
"properties": {
"apigCustomAuthorizerId": {
"type": "string",
"description": "ID of the custom authorizer.\n"
},
"cacheAge": {
"type": "number",
"description": "Specifies the maximum cache age.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the custom authorizer.\n"
},
"functionUrn": {
"type": "string",
"description": "Specifies the uniform function URN of the function graph resource.\n"
},
"identities": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigCustomAuthorizerIdentity:ApigCustomAuthorizerIdentity"
},
"description": "Specifies an array of one or more parameter identities of the custom authorizer.\nThe object structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the\ncustom authorizer belongs to.\nChanging this will create a new custom authorizer resource.\n"
},
"isBodySend": {
"type": "boolean",
"description": "Specifies whether to send the body.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the custom authorizer.\nThe custom authorizer name consists of 3 to 64 characters, starting with a letter.\nOnly letters, digits and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the custom authorizer resource.\nIf omitted, the provider-level region will be used.\nChanging this will create a new custom authorizer resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the custom authoriz type.\nThe valid values are *FRONTEND* and *BACKEND*. Changing this will create a new custom authorizer resource.\n"
},
"userData": {
"type": "string",
"description": "Specifies the user data, which can contain a maximum of 2,048 characters.\nThe user data is used by APIG to invoke the specified authentication function when accessing the backend service.\n\n> **NOTE:** The user data will be displayed in plain text on the console.\n"
}
},
"type": "object",
"required": [
"apigCustomAuthorizerId",
"createdAt",
"functionUrn",
"instanceId",
"name",
"region"
],
"inputProperties": {
"apigCustomAuthorizerId": {
"type": "string",
"description": "ID of the custom authorizer.\n"
},
"cacheAge": {
"type": "number",
"description": "Specifies the maximum cache age.\n"
},
"functionUrn": {
"type": "string",
"description": "Specifies the uniform function URN of the function graph resource.\n"
},
"identities": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigCustomAuthorizerIdentity:ApigCustomAuthorizerIdentity"
},
"description": "Specifies an array of one or more parameter identities of the custom authorizer.\nThe object structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the\ncustom authorizer belongs to.\nChanging this will create a new custom authorizer resource.\n"
},
"isBodySend": {
"type": "boolean",
"description": "Specifies whether to send the body.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the custom authorizer.\nThe custom authorizer name consists of 3 to 64 characters, starting with a letter.\nOnly letters, digits and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the custom authorizer resource.\nIf omitted, the provider-level region will be used.\nChanging this will create a new custom authorizer resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the custom authoriz type.\nThe valid values are *FRONTEND* and *BACKEND*. Changing this will create a new custom authorizer resource.\n"
},
"userData": {
"type": "string",
"description": "Specifies the user data, which can contain a maximum of 2,048 characters.\nThe user data is used by APIG to invoke the specified authentication function when accessing the backend service.\n\n> **NOTE:** The user data will be displayed in plain text on the console.\n"
}
},
"requiredInputs": [
"functionUrn",
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigCustomAuthorizer resources.\n",
"properties": {
"apigCustomAuthorizerId": {
"type": "string",
"description": "ID of the custom authorizer.\n"
},
"cacheAge": {
"type": "number",
"description": "Specifies the maximum cache age.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the custom authorizer.\n"
},
"functionUrn": {
"type": "string",
"description": "Specifies the uniform function URN of the function graph resource.\n"
},
"identities": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigCustomAuthorizerIdentity:ApigCustomAuthorizerIdentity"
},
"description": "Specifies an array of one or more parameter identities of the custom authorizer.\nThe object structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the\ncustom authorizer belongs to.\nChanging this will create a new custom authorizer resource.\n"
},
"isBodySend": {
"type": "boolean",
"description": "Specifies whether to send the body.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the custom authorizer.\nThe custom authorizer name consists of 3 to 64 characters, starting with a letter.\nOnly letters, digits and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the custom authorizer resource.\nIf omitted, the provider-level region will be used.\nChanging this will create a new custom authorizer resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the custom authoriz type.\nThe valid values are *FRONTEND* and *BACKEND*. Changing this will create a new custom authorizer resource.\n"
},
"userData": {
"type": "string",
"description": "Specifies the user data, which can contain a maximum of 2,048 characters.\nThe user data is used by APIG to invoke the specified authentication function when accessing the backend service.\n\n> **NOTE:** The user data will be displayed in plain text on the console.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigEnvironment:ApigEnvironment": {
"description": "Manages an APIG environment resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst environmentName = config.requireObject(\"environmentName\");\nconst description = config.requireObject(\"description\");\nconst test = new flexibleengine.ApigEnvironment(\"test\", {\n instanceId: instanceId,\n description: description,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\nenvironment_name = config.require_object(\"environmentName\")\ndescription = config.require_object(\"description\")\ntest = flexibleengine.ApigEnvironment(\"test\",\n instance_id=instance_id,\n description=description)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var environmentName = config.RequireObject(\"environmentName\");\n var description = config.RequireObject(\"description\");\n var test = new Flexibleengine.ApigEnvironment(\"test\", new()\n {\n InstanceId = instanceId,\n Description = description,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tenvironmentName := cfg.RequireObject(\"environmentName\")\n\t\tdescription := cfg.RequireObject(\"description\")\n\t\t_, err := flexibleengine.NewApigEnvironment(ctx, \"test\", &flexibleengine.ApigEnvironmentArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tDescription: pulumi.Any(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.pulumi.flexibleengine.ApigEnvironment;\nimport com.pulumi.flexibleengine.ApigEnvironmentArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var environmentName = config.get(\"environmentName\");\n final var description = config.get(\"description\");\n var test = new ApigEnvironment(\"test\", ApigEnvironmentArgs.builder()\n .instanceId(instanceId)\n .description(description)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n environmentName:\n type: dynamic\n description:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigEnvironment\n properties:\n instanceId: ${instanceId}\n description: ${description}\n```\n\n\n## Import\n\nEnvironments can be imported using the ID of the APIG instance to which the environment belongs and environment ID,\n\nseparated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigEnvironment:ApigEnvironment test /\n```\n\n",
"properties": {
"apigEnvironmentId": {
"type": "string",
"description": "ID of the APIG environment.\n"
},
"createTime": {
"type": "string",
"description": "schema: Deprecated; The time when the environment was created.\n",
"deprecationMessage": "Deprecated"
},
"createdAt": {
"type": "string",
"description": "The time when the environment was created.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the API environment. The description contain a\nmaximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or\nUnicode format.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API\nenvironment belongs to. Changing this will create a new APIG environment resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API environment. The API environment name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the APIG environment resource. If\nomitted, the provider-level region will be used. Changing this will create a new APIG environment resource.\n"
}
},
"type": "object",
"required": [
"apigEnvironmentId",
"createTime",
"createdAt",
"instanceId",
"name",
"region"
],
"inputProperties": {
"apigEnvironmentId": {
"type": "string",
"description": "ID of the APIG environment.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the API environment. The description contain a\nmaximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or\nUnicode format.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API\nenvironment belongs to. Changing this will create a new APIG environment resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API environment. The API environment name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the APIG environment resource. If\nomitted, the provider-level region will be used. Changing this will create a new APIG environment resource.\n"
}
},
"requiredInputs": [
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigEnvironment resources.\n",
"properties": {
"apigEnvironmentId": {
"type": "string",
"description": "ID of the APIG environment.\n"
},
"createTime": {
"type": "string",
"description": "schema: Deprecated; The time when the environment was created.\n",
"deprecationMessage": "Deprecated"
},
"createdAt": {
"type": "string",
"description": "The time when the environment was created.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the API environment. The description contain a\nmaximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or\nUnicode format.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API\nenvironment belongs to. Changing this will create a new APIG environment resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API environment. The API environment name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the APIG environment resource. If\nomitted, the provider-level region will be used. Changing this will create a new APIG environment resource.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigGroup:ApigGroup": {
"description": "Manages an APIG (API) group resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst groupName = config.requireObject(\"groupName\");\nconst description = config.requireObject(\"description\");\nconst environmentId = config.requireObject(\"environmentId\");\nconst test = new flexibleengine.ApigGroup(\"test\", {\n instanceId: instanceId,\n description: description,\n environments: [{\n variables: [{\n name: \"TERRAFORM\",\n value: \"/stage/terraform\",\n }],\n environmentId: environmentId,\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\ngroup_name = config.require_object(\"groupName\")\ndescription = config.require_object(\"description\")\nenvironment_id = config.require_object(\"environmentId\")\ntest = flexibleengine.ApigGroup(\"test\",\n instance_id=instance_id,\n description=description,\n environments=[{\n \"variables\": [{\n \"name\": \"TERRAFORM\",\n \"value\": \"/stage/terraform\",\n }],\n \"environment_id\": environment_id,\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var groupName = config.RequireObject(\"groupName\");\n var description = config.RequireObject(\"description\");\n var environmentId = config.RequireObject(\"environmentId\");\n var test = new Flexibleengine.ApigGroup(\"test\", new()\n {\n InstanceId = instanceId,\n Description = description,\n Environments = new[]\n {\n new Flexibleengine.Inputs.ApigGroupEnvironmentArgs\n {\n Variables = new[]\n {\n new Flexibleengine.Inputs.ApigGroupEnvironmentVariableArgs\n {\n Name = \"TERRAFORM\",\n Value = \"/stage/terraform\",\n },\n },\n EnvironmentId = environmentId,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tgroupName := cfg.RequireObject(\"groupName\")\n\t\tdescription := cfg.RequireObject(\"description\")\n\t\tenvironmentId := cfg.RequireObject(\"environmentId\")\n\t\t_, err := flexibleengine.NewApigGroup(ctx, \"test\", &flexibleengine.ApigGroupArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tDescription: pulumi.Any(description),\n\t\t\tEnvironments: flexibleengine.ApigGroupEnvironmentArray{\n\t\t\t\t&flexibleengine.ApigGroupEnvironmentArgs{\n\t\t\t\t\tVariables: flexibleengine.ApigGroupEnvironmentVariableArray{\n\t\t\t\t\t\t&flexibleengine.ApigGroupEnvironmentVariableArgs{\n\t\t\t\t\t\t\tName: pulumi.String(\"TERRAFORM\"),\n\t\t\t\t\t\t\tValue: pulumi.String(\"/stage/terraform\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tEnvironmentId: pulumi.Any(environmentId),\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.flexibleengine.ApigGroup;\nimport com.pulumi.flexibleengine.ApigGroupArgs;\nimport com.pulumi.flexibleengine.inputs.ApigGroupEnvironmentArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var groupName = config.get(\"groupName\");\n final var description = config.get(\"description\");\n final var environmentId = config.get(\"environmentId\");\n var test = new ApigGroup(\"test\", ApigGroupArgs.builder()\n .instanceId(instanceId)\n .description(description)\n .environments(ApigGroupEnvironmentArgs.builder()\n .variables(ApigGroupEnvironmentVariableArgs.builder()\n .name(\"TERRAFORM\")\n .value(\"/stage/terraform\")\n .build())\n .environmentId(environmentId)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n groupName:\n type: dynamic\n description:\n type: dynamic\n environmentId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigGroup\n properties:\n instanceId: ${instanceId}\n description: ${description}\n environments:\n - variables:\n - name: TERRAFORM\n value: /stage/terraform\n environmentId: ${environmentId}\n```\n\n\n## Import\n\nAPI groups of the APIG can be imported using the ID of the APIG instance to which the group belongs and API group ID,\n\nseparated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigGroup:ApigGroup test /\n```\n\n",
"properties": {
"apigGroupId": {
"type": "string",
"description": "The variable ID.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the API group. The description contain a maximum of\n255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode\nformat.\n"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigGroupEnvironment:ApigGroupEnvironment"
},
"description": "Specifies an array of one or more APIG environments of the associated APIG group. The\nobject structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API group\nbelongs to. Changing this will create a new API group resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API group. The API group name consists of 3 to 64 characters,\nstarting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or\nUnicode format.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API group resource. If omitted,\nthe provider-level region will be used. Changing this will create a new API group resource.\n"
},
"registrationTime": {
"type": "string",
"description": "The registration time.\n"
},
"updateTime": {
"type": "string",
"description": "schema: Deprecated; The latest update time of the group.\n",
"deprecationMessage": "Deprecated"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the group.\n"
}
},
"type": "object",
"required": [
"apigGroupId",
"instanceId",
"name",
"region",
"registrationTime",
"updateTime",
"updatedAt"
],
"inputProperties": {
"apigGroupId": {
"type": "string",
"description": "The variable ID.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the API group. The description contain a maximum of\n255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode\nformat.\n"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigGroupEnvironment:ApigGroupEnvironment"
},
"description": "Specifies an array of one or more APIG environments of the associated APIG group. The\nobject structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API group\nbelongs to. Changing this will create a new API group resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API group. The API group name consists of 3 to 64 characters,\nstarting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or\nUnicode format.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API group resource. If omitted,\nthe provider-level region will be used. Changing this will create a new API group resource.\n"
}
},
"requiredInputs": [
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigGroup resources.\n",
"properties": {
"apigGroupId": {
"type": "string",
"description": "The variable ID.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the API group. The description contain a maximum of\n255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode\nformat.\n"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigGroupEnvironment:ApigGroupEnvironment"
},
"description": "Specifies an array of one or more APIG environments of the associated APIG group. The\nobject structure is documented below.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API group\nbelongs to. Changing this will create a new API group resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API group. The API group name consists of 3 to 64 characters,\nstarting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or\nUnicode format.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API group resource. If omitted,\nthe provider-level region will be used. Changing this will create a new API group resource.\n"
},
"registrationTime": {
"type": "string",
"description": "The registration time.\n"
},
"updateTime": {
"type": "string",
"description": "schema: Deprecated; The latest update time of the group.\n",
"deprecationMessage": "Deprecated"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the group.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigInstance:ApigInstance": {
"description": "Manages an APIG dedicated instance resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceName = config.requireObject(\"instanceName\");\nconst exampleVpc = new flexibleengine.VpcV1(\"exampleVpc\", {cidr: \"192.168.0.0/16\"});\nconst exampleSubnet = new flexibleengine.VpcSubnetV1(\"exampleSubnet\", {\n cidr: \"192.168.0.0/24\",\n gatewayIp: \"192.168.0.1\",\n vpcId: exampleVpc.vpcV1Id,\n});\nconst exampleSecgroup = new flexibleengine.NetworkingSecgroupV2(\"exampleSecgroup\", {description: \"My neutron security group\"});\nconst exampleEip = new flexibleengine.VpcEip(\"exampleEip\", {\n publicip: {\n type: \"5_bgp\",\n },\n bandwidth: {\n name: \"test\",\n size: 10,\n shareType: \"PER\",\n },\n});\nconst az = flexibleengine.getAvailabilityZones({});\nconst exampleApigInstance = new flexibleengine.ApigInstance(\"exampleApigInstance\", {\n edition: \"BASIC\",\n vpcId: exampleVpc.vpcV1Id,\n subnetId: exampleSubnet.vpcSubnetV1Id,\n securityGroupId: exampleSecgroup.networkingSecgroupV2Id,\n maintainBegin: \"06:00:00\",\n description: \"Created by script\",\n bandwidthSize: 3,\n eipId: exampleEip.vpcEipId,\n availableZones: [\n az.then(az => az.names?.[0]),\n az.then(az => az.names?.[1]),\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_name = config.require_object(\"instanceName\")\nexample_vpc = flexibleengine.VpcV1(\"exampleVpc\", cidr=\"192.168.0.0/16\")\nexample_subnet = flexibleengine.VpcSubnetV1(\"exampleSubnet\",\n cidr=\"192.168.0.0/24\",\n gateway_ip=\"192.168.0.1\",\n vpc_id=example_vpc.vpc_v1_id)\nexample_secgroup = flexibleengine.NetworkingSecgroupV2(\"exampleSecgroup\", description=\"My neutron security group\")\nexample_eip = flexibleengine.VpcEip(\"exampleEip\",\n publicip={\n \"type\": \"5_bgp\",\n },\n bandwidth={\n \"name\": \"test\",\n \"size\": 10,\n \"share_type\": \"PER\",\n })\naz = flexibleengine.get_availability_zones()\nexample_apig_instance = flexibleengine.ApigInstance(\"exampleApigInstance\",\n edition=\"BASIC\",\n vpc_id=example_vpc.vpc_v1_id,\n subnet_id=example_subnet.vpc_subnet_v1_id,\n security_group_id=example_secgroup.networking_secgroup_v2_id,\n maintain_begin=\"06:00:00\",\n description=\"Created by script\",\n bandwidth_size=3,\n eip_id=example_eip.vpc_eip_id,\n available_zones=[\n az.names[0],\n az.names[1],\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceName = config.RequireObject(\"instanceName\");\n var exampleVpc = new Flexibleengine.VpcV1(\"exampleVpc\", new()\n {\n Cidr = \"192.168.0.0/16\",\n });\n\n var exampleSubnet = new Flexibleengine.VpcSubnetV1(\"exampleSubnet\", new()\n {\n Cidr = \"192.168.0.0/24\",\n GatewayIp = \"192.168.0.1\",\n VpcId = exampleVpc.VpcV1Id,\n });\n\n var exampleSecgroup = new Flexibleengine.NetworkingSecgroupV2(\"exampleSecgroup\", new()\n {\n Description = \"My neutron security group\",\n });\n\n var exampleEip = new Flexibleengine.VpcEip(\"exampleEip\", new()\n {\n Publicip = new Flexibleengine.Inputs.VpcEipPublicipArgs\n {\n Type = \"5_bgp\",\n },\n Bandwidth = new Flexibleengine.Inputs.VpcEipBandwidthArgs\n {\n Name = \"test\",\n Size = 10,\n ShareType = \"PER\",\n },\n });\n\n var az = Flexibleengine.GetAvailabilityZones.Invoke();\n\n var exampleApigInstance = new Flexibleengine.ApigInstance(\"exampleApigInstance\", new()\n {\n Edition = \"BASIC\",\n VpcId = exampleVpc.VpcV1Id,\n SubnetId = exampleSubnet.VpcSubnetV1Id,\n SecurityGroupId = exampleSecgroup.NetworkingSecgroupV2Id,\n MaintainBegin = \"06:00:00\",\n Description = \"Created by script\",\n BandwidthSize = 3,\n EipId = exampleEip.VpcEipId,\n AvailableZones = new[]\n {\n az.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.Names[0]),\n az.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.Names[1]),\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceName := cfg.RequireObject(\"instanceName\")\n\t\texampleVpc, err := flexibleengine.NewVpcV1(ctx, \"exampleVpc\", &flexibleengine.VpcV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/16\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleSubnet, err := flexibleengine.NewVpcSubnetV1(ctx, \"exampleSubnet\", &flexibleengine.VpcSubnetV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/24\"),\n\t\t\tGatewayIp: pulumi.String(\"192.168.0.1\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleSecgroup, err := flexibleengine.NewNetworkingSecgroupV2(ctx, \"exampleSecgroup\", &flexibleengine.NetworkingSecgroupV2Args{\n\t\t\tDescription: pulumi.String(\"My neutron security group\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleEip, err := flexibleengine.NewVpcEip(ctx, \"exampleEip\", &flexibleengine.VpcEipArgs{\n\t\t\tPublicip: &flexibleengine.VpcEipPublicipArgs{\n\t\t\t\tType: pulumi.String(\"5_bgp\"),\n\t\t\t},\n\t\t\tBandwidth: &flexibleengine.VpcEipBandwidthArgs{\n\t\t\t\tName: pulumi.String(\"test\"),\n\t\t\t\tSize: pulumi.Float64(10),\n\t\t\t\tShareType: pulumi.String(\"PER\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\taz, err := flexibleengine.GetAvailabilityZones(ctx, &flexibleengine.GetAvailabilityZonesArgs{}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewApigInstance(ctx, \"exampleApigInstance\", &flexibleengine.ApigInstanceArgs{\n\t\t\tEdition: pulumi.String(\"BASIC\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t\tSubnetId: exampleSubnet.VpcSubnetV1Id,\n\t\t\tSecurityGroupId: exampleSecgroup.NetworkingSecgroupV2Id,\n\t\t\tMaintainBegin: pulumi.String(\"06:00:00\"),\n\t\t\tDescription: pulumi.String(\"Created by script\"),\n\t\t\tBandwidthSize: pulumi.Float64(3),\n\t\t\tEipId: exampleEip.VpcEipId,\n\t\t\tAvailableZones: pulumi.StringArray{\n\t\t\t\tpulumi.String(az.Names[0]),\n\t\t\t\tpulumi.String(az.Names[1]),\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.flexibleengine.VpcV1;\nimport com.pulumi.flexibleengine.VpcV1Args;\nimport com.pulumi.flexibleengine.VpcSubnetV1;\nimport com.pulumi.flexibleengine.VpcSubnetV1Args;\nimport com.pulumi.flexibleengine.NetworkingSecgroupV2;\nimport com.pulumi.flexibleengine.NetworkingSecgroupV2Args;\nimport com.pulumi.flexibleengine.VpcEip;\nimport com.pulumi.flexibleengine.VpcEipArgs;\nimport com.pulumi.flexibleengine.inputs.VpcEipPublicipArgs;\nimport com.pulumi.flexibleengine.inputs.VpcEipBandwidthArgs;\nimport com.pulumi.flexibleengine.FlexibleengineFunctions;\nimport com.pulumi.flexibleengine.inputs.GetAvailabilityZonesArgs;\nimport com.pulumi.flexibleengine.ApigInstance;\nimport com.pulumi.flexibleengine.ApigInstanceArgs;\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 final var config = ctx.config();\n final var instanceName = config.get(\"instanceName\");\n var exampleVpc = new VpcV1(\"exampleVpc\", VpcV1Args.builder()\n .cidr(\"192.168.0.0/16\")\n .build());\n\n var exampleSubnet = new VpcSubnetV1(\"exampleSubnet\", VpcSubnetV1Args.builder()\n .cidr(\"192.168.0.0/24\")\n .gatewayIp(\"192.168.0.1\")\n .vpcId(exampleVpc.vpcV1Id())\n .build());\n\n var exampleSecgroup = new NetworkingSecgroupV2(\"exampleSecgroup\", NetworkingSecgroupV2Args.builder()\n .description(\"My neutron security group\")\n .build());\n\n var exampleEip = new VpcEip(\"exampleEip\", VpcEipArgs.builder()\n .publicip(VpcEipPublicipArgs.builder()\n .type(\"5_bgp\")\n .build())\n .bandwidth(VpcEipBandwidthArgs.builder()\n .name(\"test\")\n .size(10)\n .shareType(\"PER\")\n .build())\n .build());\n\n final var az = FlexibleengineFunctions.getAvailabilityZones();\n\n var exampleApigInstance = new ApigInstance(\"exampleApigInstance\", ApigInstanceArgs.builder()\n .edition(\"BASIC\")\n .vpcId(exampleVpc.vpcV1Id())\n .subnetId(exampleSubnet.vpcSubnetV1Id())\n .securityGroupId(exampleSecgroup.networkingSecgroupV2Id())\n .maintainBegin(\"06:00:00\")\n .description(\"Created by script\")\n .bandwidthSize(3)\n .eipId(exampleEip.vpcEipId())\n .availableZones( \n az.applyValue(getAvailabilityZonesResult -> getAvailabilityZonesResult.names()[0]),\n az.applyValue(getAvailabilityZonesResult -> getAvailabilityZonesResult.names()[1]))\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceName:\n type: dynamic\nresources:\n exampleVpc:\n type: flexibleengine:VpcV1\n properties:\n cidr: 192.168.0.0/16\n exampleSubnet:\n type: flexibleengine:VpcSubnetV1\n properties:\n cidr: 192.168.0.0/24\n gatewayIp: 192.168.0.1\n vpcId: ${exampleVpc.vpcV1Id}\n exampleSecgroup:\n type: flexibleengine:NetworkingSecgroupV2\n properties:\n description: My neutron security group\n exampleEip:\n type: flexibleengine:VpcEip\n properties:\n publicip:\n type: 5_bgp\n bandwidth:\n name: test\n size: 10\n shareType: PER\n exampleApigInstance:\n type: flexibleengine:ApigInstance\n properties:\n edition: BASIC\n vpcId: ${exampleVpc.vpcV1Id}\n subnetId: ${exampleSubnet.vpcSubnetV1Id}\n securityGroupId: ${exampleSecgroup.networkingSecgroupV2Id}\n maintainBegin: 06:00:00\n description: Created by script\n bandwidthSize: 3\n eipId: ${exampleEip.vpcEipId}\n availableZones:\n - ${az.names[0]}\n - ${az.names[1]}\nvariables:\n az:\n fn::invoke:\n function: flexibleengine:getAvailabilityZones\n arguments: {}\n```\n\n\n## Import\n\nAPIG Dedicated Instances can be imported by their `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigInstance:ApigInstance test de379eed30aa4d31a84f426ea3c7ef4e\n```\n\n",
"properties": {
"apigInstanceId": {
"type": "string",
"description": "ID of the APIG dedicated instance.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies an array of available zone names for the APIG dedicated\ninstance. Changing this will create a new APIG dedicated instance resource.\n"
},
"availableZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "schema: Deprecated; The name list of availability zones for the dedicated instance.\n"
},
"bandwidthSize": {
"type": "number",
"description": "Specifies the egress bandwidth size of the APIG dedicated instance. The range of\nvalid value is from 1 to 2000.\n"
},
"createTime": {
"type": "string",
"description": "schema: Deprecated; Time when the dedicated instance is created.\n",
"deprecationMessage": "Deprecated"
},
"createdAt": {
"type": "string",
"description": "Time when the dedicated instance is created, in RFC-3339 format.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the APIG dedicated instance. The description\ncontain a maximum of 255 characters and the angle brackets (< and >) are not allowed.\n"
},
"edition": {
"type": "string",
"description": "Specifies the edition of the APIG dedicated instance. The supported editions\nare as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance\nresource.\n"
},
"egressAddress": {
"type": "string",
"description": "The egress (nat) public ip address.\n"
},
"eipId": {
"type": "string",
"description": "Specifies the eip ID associated with the APIG dedicated instance.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project ID to which the dedicated\ninstance belongs.\nThis parameter is required for enterprise users. Changing this will create a new resource.\n"
},
"ingressAddress": {
"type": "string",
"description": "The ingress eip address.\n"
},
"ipv6Enable": {
"type": "boolean",
"description": "Specifies whether public access with an IPv6 address is supported. \nChanging this will create a new resource.\n"
},
"loadbalancerProvider": {
"type": "string",
"description": "Specifies the provider type of load balancer used by the\ndedicated instance.\nThe valid values are as follows:\n+ **lvs**: Linux virtual server.\n+ **elb**: Elastic load balance.\n\nChanging this will create a new resource.\n"
},
"maintainBegin": {
"type": "string",
"description": "Specifies a start time of the maintenance time window in the format 'xx:00:00'.\nThe value of xx can be 02, 06, 10, 14, 18 or 22.\n"
},
"maintainEnd": {
"type": "string",
"description": "End time of the maintenance time window, 4-hour difference between the start time and end time.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API dedicated instance. The API group name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the APIG dedicated instance resource.\nIf omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.\n"
},
"securityGroupId": {
"type": "string",
"description": "Specifies the ID of the security group to which the APIG dedicated instance\nbelongs to.\n"
},
"status": {
"type": "string",
"description": "Status of the APIG dedicated instance.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet used to create the APIG dedicated\ninstance. Changing this will create a new APIG dedicated instance resource.\n"
},
"supportedFeatures": {
"type": "array",
"items": {
"type": "string"
},
"description": "The supported features of the APIG dedicated instance.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApigInstanceTimeouts:ApigInstanceTimeouts"
},
"vpcId": {
"type": "string",
"description": "Specifies the ID of the VPC used to create the APIG dedicated instance.\nChanging this will create a new APIG dedicated instance resource.\n"
},
"vpcIngressAddress": {
"type": "string",
"description": "The ingress private ip address of vpc.\n"
},
"vpcepServiceAddress": {
"type": "string",
"description": "The address (full name) of the VPC endpoint service.\n"
},
"vpcepServiceName": {
"type": "string",
"description": "Name of the VPC endpoint service.\n"
}
},
"type": "object",
"required": [
"apigInstanceId",
"availabilityZones",
"createTime",
"createdAt",
"edition",
"egressAddress",
"eipId",
"enterpriseProjectId",
"ingressAddress",
"ipv6Enable",
"loadbalancerProvider",
"maintainBegin",
"maintainEnd",
"name",
"region",
"securityGroupId",
"status",
"subnetId",
"supportedFeatures",
"vpcId",
"vpcIngressAddress",
"vpcepServiceAddress",
"vpcepServiceName"
],
"inputProperties": {
"apigInstanceId": {
"type": "string",
"description": "ID of the APIG dedicated instance.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies an array of available zone names for the APIG dedicated\ninstance. Changing this will create a new APIG dedicated instance resource.\n"
},
"availableZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "schema: Deprecated; The name list of availability zones for the dedicated instance.\n"
},
"bandwidthSize": {
"type": "number",
"description": "Specifies the egress bandwidth size of the APIG dedicated instance. The range of\nvalid value is from 1 to 2000.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the APIG dedicated instance. The description\ncontain a maximum of 255 characters and the angle brackets (< and >) are not allowed.\n"
},
"edition": {
"type": "string",
"description": "Specifies the edition of the APIG dedicated instance. The supported editions\nare as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance\nresource.\n"
},
"eipId": {
"type": "string",
"description": "Specifies the eip ID associated with the APIG dedicated instance.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project ID to which the dedicated\ninstance belongs.\nThis parameter is required for enterprise users. Changing this will create a new resource.\n"
},
"ipv6Enable": {
"type": "boolean",
"description": "Specifies whether public access with an IPv6 address is supported. \nChanging this will create a new resource.\n"
},
"loadbalancerProvider": {
"type": "string",
"description": "Specifies the provider type of load balancer used by the\ndedicated instance.\nThe valid values are as follows:\n+ **lvs**: Linux virtual server.\n+ **elb**: Elastic load balance.\n\nChanging this will create a new resource.\n"
},
"maintainBegin": {
"type": "string",
"description": "Specifies a start time of the maintenance time window in the format 'xx:00:00'.\nThe value of xx can be 02, 06, 10, 14, 18 or 22.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API dedicated instance. The API group name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the APIG dedicated instance resource.\nIf omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.\n"
},
"securityGroupId": {
"type": "string",
"description": "Specifies the ID of the security group to which the APIG dedicated instance\nbelongs to.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet used to create the APIG dedicated\ninstance. Changing this will create a new APIG dedicated instance resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApigInstanceTimeouts:ApigInstanceTimeouts"
},
"vpcId": {
"type": "string",
"description": "Specifies the ID of the VPC used to create the APIG dedicated instance.\nChanging this will create a new APIG dedicated instance resource.\n"
},
"vpcepServiceName": {
"type": "string",
"description": "Name of the VPC endpoint service.\n"
}
},
"requiredInputs": [
"edition",
"securityGroupId",
"subnetId",
"vpcId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigInstance resources.\n",
"properties": {
"apigInstanceId": {
"type": "string",
"description": "ID of the APIG dedicated instance.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies an array of available zone names for the APIG dedicated\ninstance. Changing this will create a new APIG dedicated instance resource.\n"
},
"availableZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "schema: Deprecated; The name list of availability zones for the dedicated instance.\n"
},
"bandwidthSize": {
"type": "number",
"description": "Specifies the egress bandwidth size of the APIG dedicated instance. The range of\nvalid value is from 1 to 2000.\n"
},
"createTime": {
"type": "string",
"description": "schema: Deprecated; Time when the dedicated instance is created.\n",
"deprecationMessage": "Deprecated"
},
"createdAt": {
"type": "string",
"description": "Time when the dedicated instance is created, in RFC-3339 format.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the APIG dedicated instance. The description\ncontain a maximum of 255 characters and the angle brackets (< and >) are not allowed.\n"
},
"edition": {
"type": "string",
"description": "Specifies the edition of the APIG dedicated instance. The supported editions\nare as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance\nresource.\n"
},
"egressAddress": {
"type": "string",
"description": "The egress (nat) public ip address.\n"
},
"eipId": {
"type": "string",
"description": "Specifies the eip ID associated with the APIG dedicated instance.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project ID to which the dedicated\ninstance belongs.\nThis parameter is required for enterprise users. Changing this will create a new resource.\n"
},
"ingressAddress": {
"type": "string",
"description": "The ingress eip address.\n"
},
"ipv6Enable": {
"type": "boolean",
"description": "Specifies whether public access with an IPv6 address is supported. \nChanging this will create a new resource.\n"
},
"loadbalancerProvider": {
"type": "string",
"description": "Specifies the provider type of load balancer used by the\ndedicated instance.\nThe valid values are as follows:\n+ **lvs**: Linux virtual server.\n+ **elb**: Elastic load balance.\n\nChanging this will create a new resource.\n"
},
"maintainBegin": {
"type": "string",
"description": "Specifies a start time of the maintenance time window in the format 'xx:00:00'.\nThe value of xx can be 02, 06, 10, 14, 18 or 22.\n"
},
"maintainEnd": {
"type": "string",
"description": "End time of the maintenance time window, 4-hour difference between the start time and end time.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API dedicated instance. The API group name consists of 3 to 64\ncharacters, starting with a letter. Only letters, digits, and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the APIG dedicated instance resource.\nIf omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.\n"
},
"securityGroupId": {
"type": "string",
"description": "Specifies the ID of the security group to which the APIG dedicated instance\nbelongs to.\n"
},
"status": {
"type": "string",
"description": "Status of the APIG dedicated instance.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet used to create the APIG dedicated\ninstance. Changing this will create a new APIG dedicated instance resource.\n"
},
"supportedFeatures": {
"type": "array",
"items": {
"type": "string"
},
"description": "The supported features of the APIG dedicated instance.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApigInstanceTimeouts:ApigInstanceTimeouts"
},
"vpcId": {
"type": "string",
"description": "Specifies the ID of the VPC used to create the APIG dedicated instance.\nChanging this will create a new APIG dedicated instance resource.\n"
},
"vpcIngressAddress": {
"type": "string",
"description": "The ingress private ip address of vpc.\n"
},
"vpcepServiceAddress": {
"type": "string",
"description": "The address (full name) of the VPC endpoint service.\n"
},
"vpcepServiceName": {
"type": "string",
"description": "Name of the VPC endpoint service.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigInstanceRoutes:ApigInstanceRoutes": {
"description": "Using this resource to manage the instance routes within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst test = new flexibleengine.ApigInstanceRoutes(\"test\", {\n instanceId: instanceId,\n nexthops: [\n \"172.16.3.0/24\",\n \"172.16.7.0/24\",\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\ntest = flexibleengine.ApigInstanceRoutes(\"test\",\n instance_id=instance_id,\n nexthops=[\n \"172.16.3.0/24\",\n \"172.16.7.0/24\",\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var test = new Flexibleengine.ApigInstanceRoutes(\"test\", new()\n {\n InstanceId = instanceId,\n Nexthops = new[]\n {\n \"172.16.3.0/24\",\n \"172.16.7.0/24\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\t_, err := flexibleengine.NewApigInstanceRoutes(ctx, \"test\", &flexibleengine.ApigInstanceRoutesArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tNexthops: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"172.16.3.0/24\"),\n\t\t\t\tpulumi.String(\"172.16.7.0/24\"),\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.flexibleengine.ApigInstanceRoutes;\nimport com.pulumi.flexibleengine.ApigInstanceRoutesArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n var test = new ApigInstanceRoutes(\"test\", ApigInstanceRoutesArgs.builder()\n .instanceId(instanceId)\n .nexthops( \n \"172.16.3.0/24\",\n \"172.16.7.0/24\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigInstanceRoutes\n properties:\n instanceId: ${instanceId}\n nexthops:\n - 172.16.3.0/24\n - 172.16.7.0/24\n```\n\n\n## Import\n\nRoutes can be imported using their related dedicated instance ID (`instance_id`), e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/apigInstanceRoutes:ApigInstanceRoutes test 128001b3c5eb4d3e91a8da9c0f46420f\n```\n\n",
"properties": {
"apigInstanceRoutesId": {
"type": "string",
"description": "The resource ID (instance ID).\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the routes belong.\nChanging this will create a new resource.\n"
},
"nexthops": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the configuration of the next-hop routes.\n\n> The network segment of the next hop cannot overlap with the network segment of the APIG instance.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the dedicated instance and routes are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"type": "object",
"required": [
"apigInstanceRoutesId",
"instanceId",
"nexthops",
"region"
],
"inputProperties": {
"apigInstanceRoutesId": {
"type": "string",
"description": "The resource ID (instance ID).\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the routes belong.\nChanging this will create a new resource.\n"
},
"nexthops": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the configuration of the next-hop routes.\n\n> The network segment of the next hop cannot overlap with the network segment of the APIG instance.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the dedicated instance and routes are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"requiredInputs": [
"instanceId",
"nexthops"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigInstanceRoutes resources.\n",
"properties": {
"apigInstanceRoutesId": {
"type": "string",
"description": "The resource ID (instance ID).\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the routes belong.\nChanging this will create a new resource.\n"
},
"nexthops": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the configuration of the next-hop routes.\n\n> The network segment of the next hop cannot overlap with the network segment of the APIG instance.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the dedicated instance and routes are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigResponse:ApigResponse": {
"description": "Manages an APIG (API) custom response resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst groupId = config.requireObject(\"groupId\");\nconst responseName = config.requireObject(\"responseName\");\nconst test = new flexibleengine.ApigResponse(\"test\", {\n instanceId: instanceId,\n groupId: groupId,\n rules: [{\n errorType: \"AUTHORIZER_FAILURE\",\n body: \"{\\\"code\\\":\\\"$context.authorizer.frontend.code\\\",\\\"message\\\":\\\"$context.authorizer.frontend.message\\\"}\",\n statusCode: 401,\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\ngroup_id = config.require_object(\"groupId\")\nresponse_name = config.require_object(\"responseName\")\ntest = flexibleengine.ApigResponse(\"test\",\n instance_id=instance_id,\n group_id=group_id,\n rules=[{\n \"error_type\": \"AUTHORIZER_FAILURE\",\n \"body\": \"{\\\"code\\\":\\\"$context.authorizer.frontend.code\\\",\\\"message\\\":\\\"$context.authorizer.frontend.message\\\"}\",\n \"status_code\": 401,\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var groupId = config.RequireObject(\"groupId\");\n var responseName = config.RequireObject(\"responseName\");\n var test = new Flexibleengine.ApigResponse(\"test\", new()\n {\n InstanceId = instanceId,\n GroupId = groupId,\n Rules = new[]\n {\n new Flexibleengine.Inputs.ApigResponseRuleArgs\n {\n ErrorType = \"AUTHORIZER_FAILURE\",\n Body = \"{\\\"code\\\":\\\"$context.authorizer.frontend.code\\\",\\\"message\\\":\\\"$context.authorizer.frontend.message\\\"}\",\n StatusCode = 401,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tgroupId := cfg.RequireObject(\"groupId\")\n\t\tresponseName := cfg.RequireObject(\"responseName\")\n\t\t_, err := flexibleengine.NewApigResponse(ctx, \"test\", &flexibleengine.ApigResponseArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tGroupId: pulumi.Any(groupId),\n\t\t\tRules: flexibleengine.ApigResponseRuleArray{\n\t\t\t\t&flexibleengine.ApigResponseRuleArgs{\n\t\t\t\t\tErrorType: pulumi.String(\"AUTHORIZER_FAILURE\"),\n\t\t\t\t\tBody: pulumi.String(\"{\\\"code\\\":\\\"$context.authorizer.frontend.code\\\",\\\"message\\\":\\\"$context.authorizer.frontend.message\\\"}\"),\n\t\t\t\t\tStatusCode: pulumi.Float64(401),\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.flexibleengine.ApigResponse;\nimport com.pulumi.flexibleengine.ApigResponseArgs;\nimport com.pulumi.flexibleengine.inputs.ApigResponseRuleArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var groupId = config.get(\"groupId\");\n final var responseName = config.get(\"responseName\");\n var test = new ApigResponse(\"test\", ApigResponseArgs.builder()\n .instanceId(instanceId)\n .groupId(groupId)\n .rules(ApigResponseRuleArgs.builder()\n .errorType(\"AUTHORIZER_FAILURE\")\n .body(\"{\\\"code\\\":\\\"$context.authorizer.frontend.code\\\",\\\"message\\\":\\\"$context.authorizer.frontend.message\\\"}\")\n .statusCode(401)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n groupId:\n type: dynamic\n responseName:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigResponse\n properties:\n instanceId: ${instanceId}\n groupId: ${groupId}\n rules:\n - errorType: AUTHORIZER_FAILURE\n body: '{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}'\n statusCode: 401\n```\n\n\n## Import\n\nAPI Responses can be imported using the ID of the APIG dedicated instances and API groups to which the API\n\nresponse belongs and API Response `name`, separated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigResponse:ApigResponse test //\n```\n\n",
"properties": {
"apigResponseId": {
"type": "string",
"description": "ID of the API custom response.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the API custom response.\n"
},
"groupId": {
"type": "string",
"description": "Specifies the ID of the API group to which the API response belongs to.\nChanging this will create a new API custom response resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the APIG dedicated instance to which the API group\nwhere the API custom response belongs. Changing this will create a new API custom response resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API custom response. The name consists of 1 to 64 characters,\nand only letters, digits, hyphens(-), and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API custom response resource. If\nomitted, the provider-level region will be used. Changing this will create a new API custom response resource.\n"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigResponseRule:ApigResponseRule"
},
"description": "Specifies the API custom response rules definition. The object structure is documented\nbelow.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the API custom response.\n"
}
},
"type": "object",
"required": [
"apigResponseId",
"createdAt",
"groupId",
"instanceId",
"name",
"region",
"updatedAt"
],
"inputProperties": {
"apigResponseId": {
"type": "string",
"description": "ID of the API custom response.\n"
},
"groupId": {
"type": "string",
"description": "Specifies the ID of the API group to which the API response belongs to.\nChanging this will create a new API custom response resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the APIG dedicated instance to which the API group\nwhere the API custom response belongs. Changing this will create a new API custom response resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API custom response. The name consists of 1 to 64 characters,\nand only letters, digits, hyphens(-), and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API custom response resource. If\nomitted, the provider-level region will be used. Changing this will create a new API custom response resource.\n"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigResponseRule:ApigResponseRule"
},
"description": "Specifies the API custom response rules definition. The object structure is documented\nbelow.\n"
}
},
"requiredInputs": [
"groupId",
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigResponse resources.\n",
"properties": {
"apigResponseId": {
"type": "string",
"description": "ID of the API custom response.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the API custom response.\n"
},
"groupId": {
"type": "string",
"description": "Specifies the ID of the API group to which the API response belongs to.\nChanging this will create a new API custom response resource.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the APIG dedicated instance to which the API group\nwhere the API custom response belongs. Changing this will create a new API custom response resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API custom response. The name consists of 1 to 64 characters,\nand only letters, digits, hyphens(-), and underscores (_) are allowed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API custom response resource. If\nomitted, the provider-level region will be used. Changing this will create a new API custom response resource.\n"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigResponseRule:ApigResponseRule"
},
"description": "Specifies the API custom response rules definition. The object structure is documented\nbelow.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the API custom response.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigSignature:ApigSignature": {
"description": "Manages a signature resource within FlexibleEngine.\n\n## Example Usage\n\n### Create a signature of the HMAC type\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst signatureName = config.requireObject(\"signatureName\");\nconst signatureKey = config.requireObject(\"signatureKey\");\nconst signatureSecret = config.requireObject(\"signatureSecret\");\nconst test = new flexibleengine.ApigSignature(\"test\", {\n instanceId: instanceId,\n type: \"hmac\",\n key: signatureKey,\n secret: signatureSecret,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\nsignature_name = config.require_object(\"signatureName\")\nsignature_key = config.require_object(\"signatureKey\")\nsignature_secret = config.require_object(\"signatureSecret\")\ntest = flexibleengine.ApigSignature(\"test\",\n instance_id=instance_id,\n type=\"hmac\",\n key=signature_key,\n secret=signature_secret)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var signatureName = config.RequireObject(\"signatureName\");\n var signatureKey = config.RequireObject(\"signatureKey\");\n var signatureSecret = config.RequireObject(\"signatureSecret\");\n var test = new Flexibleengine.ApigSignature(\"test\", new()\n {\n InstanceId = instanceId,\n Type = \"hmac\",\n Key = signatureKey,\n Secret = signatureSecret,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tsignatureName := cfg.RequireObject(\"signatureName\")\n\t\tsignatureKey := cfg.RequireObject(\"signatureKey\")\n\t\tsignatureSecret := cfg.RequireObject(\"signatureSecret\")\n\t\t_, err := flexibleengine.NewApigSignature(ctx, \"test\", &flexibleengine.ApigSignatureArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tType: pulumi.String(\"hmac\"),\n\t\t\tKey: pulumi.Any(signatureKey),\n\t\t\tSecret: pulumi.Any(signatureSecret),\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.flexibleengine.ApigSignature;\nimport com.pulumi.flexibleengine.ApigSignatureArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var signatureName = config.get(\"signatureName\");\n final var signatureKey = config.get(\"signatureKey\");\n final var signatureSecret = config.get(\"signatureSecret\");\n var test = new ApigSignature(\"test\", ApigSignatureArgs.builder()\n .instanceId(instanceId)\n .type(\"hmac\")\n .key(signatureKey)\n .secret(signatureSecret)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n signatureName:\n type: dynamic\n signatureKey:\n type: dynamic\n signatureSecret:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigSignature\n properties:\n instanceId: ${instanceId}\n type: hmac\n key: ${signatureKey}\n secret: ${signatureSecret}\n```\n\n\n### Create a signature and automatically generate key and secret\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst signatureName = config.requireObject(\"signatureName\");\nconst test = new flexibleengine.ApigSignature(\"test\", {\n instanceId: instanceId,\n type: \"hmac\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\nsignature_name = config.require_object(\"signatureName\")\ntest = flexibleengine.ApigSignature(\"test\",\n instance_id=instance_id,\n type=\"hmac\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var signatureName = config.RequireObject(\"signatureName\");\n var test = new Flexibleengine.ApigSignature(\"test\", new()\n {\n InstanceId = instanceId,\n Type = \"hmac\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tsignatureName := cfg.RequireObject(\"signatureName\")\n\t\t_, err := flexibleengine.NewApigSignature(ctx, \"test\", &flexibleengine.ApigSignatureArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tType: pulumi.String(\"hmac\"),\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.flexibleengine.ApigSignature;\nimport com.pulumi.flexibleengine.ApigSignatureArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var signatureName = config.get(\"signatureName\");\n var test = new ApigSignature(\"test\", ApigSignatureArgs.builder()\n .instanceId(instanceId)\n .type(\"hmac\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n signatureName:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigSignature\n properties:\n instanceId: ${instanceId}\n type: hmac\n```\n\n\n### Create a signature of the AES type\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst signatureName = config.requireObject(\"signatureName\");\nconst signatureKey = config.requireObject(\"signatureKey\");\nconst signatureSecret = config.requireObject(\"signatureSecret\");\nconst test = new flexibleengine.ApigSignature(\"test\", {\n instanceId: instanceId,\n type: \"aes\",\n algorithm: \"aes-128-cfb\",\n key: signatureKey,\n secret: signatureSecret,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\nsignature_name = config.require_object(\"signatureName\")\nsignature_key = config.require_object(\"signatureKey\")\nsignature_secret = config.require_object(\"signatureSecret\")\ntest = flexibleengine.ApigSignature(\"test\",\n instance_id=instance_id,\n type=\"aes\",\n algorithm=\"aes-128-cfb\",\n key=signature_key,\n secret=signature_secret)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var signatureName = config.RequireObject(\"signatureName\");\n var signatureKey = config.RequireObject(\"signatureKey\");\n var signatureSecret = config.RequireObject(\"signatureSecret\");\n var test = new Flexibleengine.ApigSignature(\"test\", new()\n {\n InstanceId = instanceId,\n Type = \"aes\",\n Algorithm = \"aes-128-cfb\",\n Key = signatureKey,\n Secret = signatureSecret,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tsignatureName := cfg.RequireObject(\"signatureName\")\n\t\tsignatureKey := cfg.RequireObject(\"signatureKey\")\n\t\tsignatureSecret := cfg.RequireObject(\"signatureSecret\")\n\t\t_, err := flexibleengine.NewApigSignature(ctx, \"test\", &flexibleengine.ApigSignatureArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tType: pulumi.String(\"aes\"),\n\t\t\tAlgorithm: pulumi.String(\"aes-128-cfb\"),\n\t\t\tKey: pulumi.Any(signatureKey),\n\t\t\tSecret: pulumi.Any(signatureSecret),\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.flexibleengine.ApigSignature;\nimport com.pulumi.flexibleengine.ApigSignatureArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var signatureName = config.get(\"signatureName\");\n final var signatureKey = config.get(\"signatureKey\");\n final var signatureSecret = config.get(\"signatureSecret\");\n var test = new ApigSignature(\"test\", ApigSignatureArgs.builder()\n .instanceId(instanceId)\n .type(\"aes\")\n .algorithm(\"aes-128-cfb\")\n .key(signatureKey)\n .secret(signatureSecret)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n signatureName:\n type: dynamic\n signatureKey:\n type: dynamic\n signatureSecret:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigSignature\n properties:\n instanceId: ${instanceId}\n type: aes\n algorithm: aes-128-cfb\n key: ${signatureKey}\n secret: ${signatureSecret}\n```\n\n\n## Import\n\nSignatures can be imported using their `id` and related dedicated instance ID, separated by a slash, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/apigSignature:ApigSignature test /\n```\n\n",
"properties": {
"algorithm": {
"type": "string",
"description": "Specifies the signature algorithm. \nThis parameter is required and only available when signature `type` is `aes`.\nThe valid values are as follows:\n+ **aes-128-cfb**\n+ **aes-256-cfb**\n\nChanging this will create a new resource.\n"
},
"apigSignatureId": {
"type": "string",
"description": "The ID of the signature.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the signature.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the signature\nbelongs.\nChanging this will create a new resource.\n"
},
"key": {
"type": "string",
"description": "Specifies the signature key. \n+ For `basic` type: The value contains `4` to `32` characters, including letters, digits, underscores (_) and\nhyphens (-). It must start with a letter.\n+ For `hmac` type: The value contains `8` to `32` characters, including letters, digits, underscores (_) and\nhyphens (-). It must start with a letter or digit.\n+ For `aes` type: The value contains `16` characters if the `aes-128-cfb` algorithm is used, or `32` characters if the\n`aes-256-cfb` algorithm is used. Only letters, digits, and special characters (`_-!@#$%+/=`) are allowed.\nIt must start with a letter, digit, plus sign (+), or slash (/).\n\nIf not specified, the key will automatically generated. The auto-generation is only supported on first creation.\nChanging this will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the signature name. \nThe valid length is limited from `3` to `64`, only English letters, Chinese characters, digits and underscores (_) are\nallowed. The name must start with an English letter or Chinese character.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the signature is located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"secret": {
"type": "string",
"description": "Specifies the signature secret. \nIf not specified, the secret will automatically generated. The auto-generation is only supported on first creation.\nChanging this will create a new resource.\n",
"secret": true
},
"type": {
"type": "string",
"description": "Specifies the type of signature. \nThe valid values are as follows:\n+ **basic**: Basic auth type.\n+ **hmac**: HMAC type.\n+ **aes**: AES type\n\nChanging this will create a new resource.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the signature.\n"
}
},
"type": "object",
"required": [
"algorithm",
"apigSignatureId",
"createdAt",
"instanceId",
"key",
"name",
"region",
"secret",
"type",
"updatedAt"
],
"inputProperties": {
"algorithm": {
"type": "string",
"description": "Specifies the signature algorithm. \nThis parameter is required and only available when signature `type` is `aes`.\nThe valid values are as follows:\n+ **aes-128-cfb**\n+ **aes-256-cfb**\n\nChanging this will create a new resource.\n"
},
"apigSignatureId": {
"type": "string",
"description": "The ID of the signature.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the signature\nbelongs.\nChanging this will create a new resource.\n"
},
"key": {
"type": "string",
"description": "Specifies the signature key. \n+ For `basic` type: The value contains `4` to `32` characters, including letters, digits, underscores (_) and\nhyphens (-). It must start with a letter.\n+ For `hmac` type: The value contains `8` to `32` characters, including letters, digits, underscores (_) and\nhyphens (-). It must start with a letter or digit.\n+ For `aes` type: The value contains `16` characters if the `aes-128-cfb` algorithm is used, or `32` characters if the\n`aes-256-cfb` algorithm is used. Only letters, digits, and special characters (`_-!@#$%+/=`) are allowed.\nIt must start with a letter, digit, plus sign (+), or slash (/).\n\nIf not specified, the key will automatically generated. The auto-generation is only supported on first creation.\nChanging this will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the signature name. \nThe valid length is limited from `3` to `64`, only English letters, Chinese characters, digits and underscores (_) are\nallowed. The name must start with an English letter or Chinese character.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the signature is located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"secret": {
"type": "string",
"description": "Specifies the signature secret. \nIf not specified, the secret will automatically generated. The auto-generation is only supported on first creation.\nChanging this will create a new resource.\n",
"secret": true
},
"type": {
"type": "string",
"description": "Specifies the type of signature. \nThe valid values are as follows:\n+ **basic**: Basic auth type.\n+ **hmac**: HMAC type.\n+ **aes**: AES type\n\nChanging this will create a new resource.\n"
}
},
"requiredInputs": [
"instanceId",
"type"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigSignature resources.\n",
"properties": {
"algorithm": {
"type": "string",
"description": "Specifies the signature algorithm. \nThis parameter is required and only available when signature `type` is `aes`.\nThe valid values are as follows:\n+ **aes-128-cfb**\n+ **aes-256-cfb**\n\nChanging this will create a new resource.\n"
},
"apigSignatureId": {
"type": "string",
"description": "The ID of the signature.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the signature.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the signature\nbelongs.\nChanging this will create a new resource.\n"
},
"key": {
"type": "string",
"description": "Specifies the signature key. \n+ For `basic` type: The value contains `4` to `32` characters, including letters, digits, underscores (_) and\nhyphens (-). It must start with a letter.\n+ For `hmac` type: The value contains `8` to `32` characters, including letters, digits, underscores (_) and\nhyphens (-). It must start with a letter or digit.\n+ For `aes` type: The value contains `16` characters if the `aes-128-cfb` algorithm is used, or `32` characters if the\n`aes-256-cfb` algorithm is used. Only letters, digits, and special characters (`_-!@#$%+/=`) are allowed.\nIt must start with a letter, digit, plus sign (+), or slash (/).\n\nIf not specified, the key will automatically generated. The auto-generation is only supported on first creation.\nChanging this will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the signature name. \nThe valid length is limited from `3` to `64`, only English letters, Chinese characters, digits and underscores (_) are\nallowed. The name must start with an English letter or Chinese character.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the signature is located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"secret": {
"type": "string",
"description": "Specifies the signature secret. \nIf not specified, the secret will automatically generated. The auto-generation is only supported on first creation.\nChanging this will create a new resource.\n",
"secret": true
},
"type": {
"type": "string",
"description": "Specifies the type of signature. \nThe valid values are as follows:\n+ **basic**: Basic auth type.\n+ **hmac**: HMAC type.\n+ **aes**: AES type\n\nChanging this will create a new resource.\n"
},
"updatedAt": {
"type": "string",
"description": "The latest update time of the signature.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigSignatureAssociate:ApigSignatureAssociate": {
"description": "Use this resource to bind the APIs to the signature within FlexibleEngine.\n\n> A signature can only create one `flexibleengine.ApigSignatureAssociate` resource.\n And a published ID for API can only bind a signature.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst signatureId = config.requireObject(\"signatureId\");\nconst apiPublishIds = config.requireObject>(\"apiPublishIds\");\nconst test = new flexibleengine.ApigSignatureAssociate(\"test\", {\n instanceId: instanceId,\n signatureId: signatureId,\n publishIds: apiPublishIds,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\nsignature_id = config.require_object(\"signatureId\")\napi_publish_ids = config.require_object(\"apiPublishIds\")\ntest = flexibleengine.ApigSignatureAssociate(\"test\",\n instance_id=instance_id,\n signature_id=signature_id,\n publish_ids=api_publish_ids)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var signatureId = config.RequireObject(\"signatureId\");\n var apiPublishIds = config.RequireObject(\"apiPublishIds\");\n var test = new Flexibleengine.ApigSignatureAssociate(\"test\", new()\n {\n InstanceId = instanceId,\n SignatureId = signatureId,\n PublishIds = apiPublishIds,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tsignatureId := cfg.RequireObject(\"signatureId\")\n\t\tapiPublishIds := cfg.Require(\"apiPublishIds\")\n\t\t_, err := flexibleengine.NewApigSignatureAssociate(ctx, \"test\", &flexibleengine.ApigSignatureAssociateArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tSignatureId: pulumi.Any(signatureId),\n\t\t\tPublishIds: apiPublishIds,\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.flexibleengine.ApigSignatureAssociate;\nimport com.pulumi.flexibleengine.ApigSignatureAssociateArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var signatureId = config.get(\"signatureId\");\n final var apiPublishIds = config.get(\"apiPublishIds\");\n var test = new ApigSignatureAssociate(\"test\", ApigSignatureAssociateArgs.builder()\n .instanceId(instanceId)\n .signatureId(signatureId)\n .publishIds(apiPublishIds)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n signatureId:\n type: dynamic\n apiPublishIds:\n type: list(string)\nresources:\n test:\n type: flexibleengine:ApigSignatureAssociate\n properties:\n instanceId: ${instanceId}\n signatureId: ${signatureId}\n publishIds: ${apiPublishIds}\n```\n\n\n## Import\n\nAssociate resources can be imported using their `signature_id` and the APIG dedicated instance ID to which the signature\n\nbelongs, separated by a slash, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/apigSignatureAssociate:ApigSignatureAssociate test /\n```\n\n",
"properties": {
"apigSignatureAssociateId": {
"type": "string",
"description": "Resource ID. The format is `/`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the APIs and the\nsignature belong.\nChanging this will create a new resource.\n"
},
"publishIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the publish IDs corresponding to the APIs bound by the signature.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the signature and the APIs are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"signatureId": {
"type": "string",
"description": "Specifies the signature ID for APIs binding. \nChanging this will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApigSignatureAssociateTimeouts:ApigSignatureAssociateTimeouts"
}
},
"type": "object",
"required": [
"apigSignatureAssociateId",
"instanceId",
"publishIds",
"region",
"signatureId"
],
"inputProperties": {
"apigSignatureAssociateId": {
"type": "string",
"description": "Resource ID. The format is `/`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the APIs and the\nsignature belong.\nChanging this will create a new resource.\n"
},
"publishIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the publish IDs corresponding to the APIs bound by the signature.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the signature and the APIs are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"signatureId": {
"type": "string",
"description": "Specifies the signature ID for APIs binding. \nChanging this will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApigSignatureAssociateTimeouts:ApigSignatureAssociateTimeouts"
}
},
"requiredInputs": [
"instanceId",
"publishIds",
"signatureId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigSignatureAssociate resources.\n",
"properties": {
"apigSignatureAssociateId": {
"type": "string",
"description": "Resource ID. The format is `/`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the dedicated instance to which the APIs and the\nsignature belong.\nChanging this will create a new resource.\n"
},
"publishIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the publish IDs corresponding to the APIs bound by the signature.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the signature and the APIs are located. \nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
},
"signatureId": {
"type": "string",
"description": "Specifies the signature ID for APIs binding. \nChanging this will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FApigSignatureAssociateTimeouts:ApigSignatureAssociateTimeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/apigThrottlingPolicy:ApigThrottlingPolicy": {
"description": "Manages an APIG (API) throttling policy resource within FlexibleEngine.\n\n## Example Usage\n\n### Create a basic throttling policy\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst policyName = config.requireObject(\"policyName\");\nconst description = config.requireObject(\"description\");\nconst test = new flexibleengine.ApigThrottlingPolicy(\"test\", {\n instanceId: instanceId,\n description: description,\n type: \"API-based\",\n period: 10,\n periodUnit: \"MINUTE\",\n maxApiRequests: 70,\n maxUserRequests: 45,\n maxAppRequests: 45,\n maxIpRequests: 45,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\npolicy_name = config.require_object(\"policyName\")\ndescription = config.require_object(\"description\")\ntest = flexibleengine.ApigThrottlingPolicy(\"test\",\n instance_id=instance_id,\n description=description,\n type=\"API-based\",\n period=10,\n period_unit=\"MINUTE\",\n max_api_requests=70,\n max_user_requests=45,\n max_app_requests=45,\n max_ip_requests=45)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var policyName = config.RequireObject(\"policyName\");\n var description = config.RequireObject(\"description\");\n var test = new Flexibleengine.ApigThrottlingPolicy(\"test\", new()\n {\n InstanceId = instanceId,\n Description = description,\n Type = \"API-based\",\n Period = 10,\n PeriodUnit = \"MINUTE\",\n MaxApiRequests = 70,\n MaxUserRequests = 45,\n MaxAppRequests = 45,\n MaxIpRequests = 45,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tpolicyName := cfg.RequireObject(\"policyName\")\n\t\tdescription := cfg.RequireObject(\"description\")\n\t\t_, err := flexibleengine.NewApigThrottlingPolicy(ctx, \"test\", &flexibleengine.ApigThrottlingPolicyArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tDescription: pulumi.Any(description),\n\t\t\tType: pulumi.String(\"API-based\"),\n\t\t\tPeriod: pulumi.Float64(10),\n\t\t\tPeriodUnit: pulumi.String(\"MINUTE\"),\n\t\t\tMaxApiRequests: pulumi.Float64(70),\n\t\t\tMaxUserRequests: pulumi.Float64(45),\n\t\t\tMaxAppRequests: pulumi.Float64(45),\n\t\t\tMaxIpRequests: pulumi.Float64(45),\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.flexibleengine.ApigThrottlingPolicy;\nimport com.pulumi.flexibleengine.ApigThrottlingPolicyArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var policyName = config.get(\"policyName\");\n final var description = config.get(\"description\");\n var test = new ApigThrottlingPolicy(\"test\", ApigThrottlingPolicyArgs.builder()\n .instanceId(instanceId)\n .description(description)\n .type(\"API-based\")\n .period(10)\n .periodUnit(\"MINUTE\")\n .maxApiRequests(70)\n .maxUserRequests(45)\n .maxAppRequests(45)\n .maxIpRequests(45)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n policyName:\n type: dynamic\n description:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigThrottlingPolicy\n properties:\n instanceId: ${instanceId}\n description: ${description}\n type: API-based\n period: 10\n periodUnit: MINUTE\n maxApiRequests: 70\n maxUserRequests: 45\n maxAppRequests: 45\n maxIpRequests: 45\n```\n\n\n### Create a throttling policy with a special throttle\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst policyName = config.requireObject(\"policyName\");\nconst description = config.requireObject(\"description\");\nconst applicationId = config.requireObject(\"applicationId\");\nconst test = new flexibleengine.ApigThrottlingPolicy(\"test\", {\n instanceId: instanceId,\n description: description,\n type: \"API-based\",\n period: 10,\n periodUnit: \"MINUTE\",\n maxApiRequests: 70,\n maxUserRequests: 45,\n maxAppRequests: 45,\n maxIpRequests: 45,\n appThrottles: [{\n maxApiRequests: 40,\n throttlingObjectId: applicationId,\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\npolicy_name = config.require_object(\"policyName\")\ndescription = config.require_object(\"description\")\napplication_id = config.require_object(\"applicationId\")\ntest = flexibleengine.ApigThrottlingPolicy(\"test\",\n instance_id=instance_id,\n description=description,\n type=\"API-based\",\n period=10,\n period_unit=\"MINUTE\",\n max_api_requests=70,\n max_user_requests=45,\n max_app_requests=45,\n max_ip_requests=45,\n app_throttles=[{\n \"max_api_requests\": 40,\n \"throttling_object_id\": application_id,\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var policyName = config.RequireObject(\"policyName\");\n var description = config.RequireObject(\"description\");\n var applicationId = config.RequireObject(\"applicationId\");\n var test = new Flexibleengine.ApigThrottlingPolicy(\"test\", new()\n {\n InstanceId = instanceId,\n Description = description,\n Type = \"API-based\",\n Period = 10,\n PeriodUnit = \"MINUTE\",\n MaxApiRequests = 70,\n MaxUserRequests = 45,\n MaxAppRequests = 45,\n MaxIpRequests = 45,\n AppThrottles = new[]\n {\n new Flexibleengine.Inputs.ApigThrottlingPolicyAppThrottleArgs\n {\n MaxApiRequests = 40,\n ThrottlingObjectId = applicationId,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tpolicyName := cfg.RequireObject(\"policyName\")\n\t\tdescription := cfg.RequireObject(\"description\")\n\t\tapplicationId := cfg.RequireObject(\"applicationId\")\n\t\t_, err := flexibleengine.NewApigThrottlingPolicy(ctx, \"test\", &flexibleengine.ApigThrottlingPolicyArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tDescription: pulumi.Any(description),\n\t\t\tType: pulumi.String(\"API-based\"),\n\t\t\tPeriod: pulumi.Float64(10),\n\t\t\tPeriodUnit: pulumi.String(\"MINUTE\"),\n\t\t\tMaxApiRequests: pulumi.Float64(70),\n\t\t\tMaxUserRequests: pulumi.Float64(45),\n\t\t\tMaxAppRequests: pulumi.Float64(45),\n\t\t\tMaxIpRequests: pulumi.Float64(45),\n\t\t\tAppThrottles: flexibleengine.ApigThrottlingPolicyAppThrottleArray{\n\t\t\t\t&flexibleengine.ApigThrottlingPolicyAppThrottleArgs{\n\t\t\t\t\tMaxApiRequests: pulumi.Float64(40),\n\t\t\t\t\tThrottlingObjectId: pulumi.Any(applicationId),\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.flexibleengine.ApigThrottlingPolicy;\nimport com.pulumi.flexibleengine.ApigThrottlingPolicyArgs;\nimport com.pulumi.flexibleengine.inputs.ApigThrottlingPolicyAppThrottleArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var policyName = config.get(\"policyName\");\n final var description = config.get(\"description\");\n final var applicationId = config.get(\"applicationId\");\n var test = new ApigThrottlingPolicy(\"test\", ApigThrottlingPolicyArgs.builder()\n .instanceId(instanceId)\n .description(description)\n .type(\"API-based\")\n .period(10)\n .periodUnit(\"MINUTE\")\n .maxApiRequests(70)\n .maxUserRequests(45)\n .maxAppRequests(45)\n .maxIpRequests(45)\n .appThrottles(ApigThrottlingPolicyAppThrottleArgs.builder()\n .maxApiRequests(40)\n .throttlingObjectId(applicationId)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n policyName:\n type: dynamic\n description:\n type: dynamic\n applicationId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigThrottlingPolicy\n properties:\n instanceId: ${instanceId}\n description: ${description}\n type: API-based\n period: 10\n periodUnit: MINUTE\n maxApiRequests: 70\n maxUserRequests: 45\n maxAppRequests: 45\n maxIpRequests: 45\n appThrottles:\n - maxApiRequests: 40\n throttlingObjectId: ${applicationId}\n```\n\n\n## Import\n\nAPI Throttling Policies of APIG can be imported using the ID of the APIG instances to which the\n\nenvironment belongs and `name`, separated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigThrottlingPolicy:ApigThrottlingPolicy test /\n```\n\n",
"properties": {
"apigThrottlingPolicyId": {
"type": "string",
"description": "ID of the special application throttling policy.\n"
},
"appThrottles": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigThrottlingPolicyAppThrottle:ApigThrottlingPolicyAppThrottle"
},
"description": "Specifies an array of one or more special throttling policies for APP limit.\nThe `throttle` object of the `app_throttles` structure is documented below.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the throttling policy.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the API throttling policy.\nThe description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.\nChinese characters must be in UTF-8 or Unicode format.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API\nthrottling policy belongs to. Changing this will create a new API throttling policy resource.\n"
},
"maxApiRequests": {
"type": "number",
"description": "Specifies the maximum number of times an API can be accessed within a specified\nperiod. The value of this parameter cannot exceed the default limit 200 TPS.\n"
},
"maxAppRequests": {
"type": "number",
"description": "Specifies the maximum number of times the API can be accessed by an app within\nthe same period. The value of this parameter must be less than or equal to the value of `max_user_requests`.\n"
},
"maxIpRequests": {
"type": "number",
"description": "Specifies the maximum number of times the API can be accessed by an IP address\nwithin the same period. The value of this parameter must be less than or equal to the value of `max_api_requests`.\n"
},
"maxUserRequests": {
"type": "number",
"description": "Specifies the maximum number of times the API can be accessed by a user within\nthe same period. The value of this parameter must be less than or equal to the value of `max_api_requests`.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API throttling policy.\nThe policy name consists of 3 to 64 characters, starting with a letter.\nOnly letters, digits and underscores (_) are allowed.\n"
},
"period": {
"type": "number",
"description": "Specifies the period of time for limiting the number of API calls.\nThis parameter applies with each of the API call limits: `max_api_requests`, `max_app_requests`, `max_ip_requests`\nand `max_user_requests`.\n"
},
"periodUnit": {
"type": "string",
"description": "Specifies the time unit for limiting the number of API calls.\nThe valid values are *SECOND*, *MINUTE*, *HOUR* and *DAY*, default to *MINUTE*.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API throttling policy resource.\nIf omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the request throttling policy.\nThe valid values are as follows:\n+ API-based: limiting the maximum number of times a single API bound to the policy can be called within the\nspecified period.\n+ API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified\nperiod.\n"
},
"userThrottles": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigThrottlingPolicyUserThrottle:ApigThrottlingPolicyUserThrottle"
},
"description": "Specifies an array of one or more special throttling policies for IAM user limit.\nThe `throttle` object of the `user_throttles` structure is documented below.\n"
}
},
"type": "object",
"required": [
"apigThrottlingPolicyId",
"createdAt",
"instanceId",
"maxApiRequests",
"name",
"period",
"region"
],
"inputProperties": {
"apigThrottlingPolicyId": {
"type": "string",
"description": "ID of the special application throttling policy.\n"
},
"appThrottles": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigThrottlingPolicyAppThrottle:ApigThrottlingPolicyAppThrottle"
},
"description": "Specifies an array of one or more special throttling policies for APP limit.\nThe `throttle` object of the `app_throttles` structure is documented below.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the API throttling policy.\nThe description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.\nChinese characters must be in UTF-8 or Unicode format.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API\nthrottling policy belongs to. Changing this will create a new API throttling policy resource.\n"
},
"maxApiRequests": {
"type": "number",
"description": "Specifies the maximum number of times an API can be accessed within a specified\nperiod. The value of this parameter cannot exceed the default limit 200 TPS.\n"
},
"maxAppRequests": {
"type": "number",
"description": "Specifies the maximum number of times the API can be accessed by an app within\nthe same period. The value of this parameter must be less than or equal to the value of `max_user_requests`.\n"
},
"maxIpRequests": {
"type": "number",
"description": "Specifies the maximum number of times the API can be accessed by an IP address\nwithin the same period. The value of this parameter must be less than or equal to the value of `max_api_requests`.\n"
},
"maxUserRequests": {
"type": "number",
"description": "Specifies the maximum number of times the API can be accessed by a user within\nthe same period. The value of this parameter must be less than or equal to the value of `max_api_requests`.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API throttling policy.\nThe policy name consists of 3 to 64 characters, starting with a letter.\nOnly letters, digits and underscores (_) are allowed.\n"
},
"period": {
"type": "number",
"description": "Specifies the period of time for limiting the number of API calls.\nThis parameter applies with each of the API call limits: `max_api_requests`, `max_app_requests`, `max_ip_requests`\nand `max_user_requests`.\n"
},
"periodUnit": {
"type": "string",
"description": "Specifies the time unit for limiting the number of API calls.\nThe valid values are *SECOND*, *MINUTE*, *HOUR* and *DAY*, default to *MINUTE*.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API throttling policy resource.\nIf omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the request throttling policy.\nThe valid values are as follows:\n+ API-based: limiting the maximum number of times a single API bound to the policy can be called within the\nspecified period.\n+ API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified\nperiod.\n"
},
"userThrottles": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigThrottlingPolicyUserThrottle:ApigThrottlingPolicyUserThrottle"
},
"description": "Specifies an array of one or more special throttling policies for IAM user limit.\nThe `throttle` object of the `user_throttles` structure is documented below.\n"
}
},
"requiredInputs": [
"instanceId",
"maxApiRequests",
"period"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigThrottlingPolicy resources.\n",
"properties": {
"apigThrottlingPolicyId": {
"type": "string",
"description": "ID of the special application throttling policy.\n"
},
"appThrottles": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigThrottlingPolicyAppThrottle:ApigThrottlingPolicyAppThrottle"
},
"description": "Specifies an array of one or more special throttling policies for APP limit.\nThe `throttle` object of the `app_throttles` structure is documented below.\n"
},
"createdAt": {
"type": "string",
"description": "The creation time of the throttling policy.\n"
},
"description": {
"type": "string",
"description": "Specifies the description about the API throttling policy.\nThe description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.\nChinese characters must be in UTF-8 or Unicode format.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the API\nthrottling policy belongs to. Changing this will create a new API throttling policy resource.\n"
},
"maxApiRequests": {
"type": "number",
"description": "Specifies the maximum number of times an API can be accessed within a specified\nperiod. The value of this parameter cannot exceed the default limit 200 TPS.\n"
},
"maxAppRequests": {
"type": "number",
"description": "Specifies the maximum number of times the API can be accessed by an app within\nthe same period. The value of this parameter must be less than or equal to the value of `max_user_requests`.\n"
},
"maxIpRequests": {
"type": "number",
"description": "Specifies the maximum number of times the API can be accessed by an IP address\nwithin the same period. The value of this parameter must be less than or equal to the value of `max_api_requests`.\n"
},
"maxUserRequests": {
"type": "number",
"description": "Specifies the maximum number of times the API can be accessed by a user within\nthe same period. The value of this parameter must be less than or equal to the value of `max_api_requests`.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the API throttling policy.\nThe policy name consists of 3 to 64 characters, starting with a letter.\nOnly letters, digits and underscores (_) are allowed.\n"
},
"period": {
"type": "number",
"description": "Specifies the period of time for limiting the number of API calls.\nThis parameter applies with each of the API call limits: `max_api_requests`, `max_app_requests`, `max_ip_requests`\nand `max_user_requests`.\n"
},
"periodUnit": {
"type": "string",
"description": "Specifies the time unit for limiting the number of API calls.\nThe valid values are *SECOND*, *MINUTE*, *HOUR* and *DAY*, default to *MINUTE*.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the API throttling policy resource.\nIf omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.\n"
},
"type": {
"type": "string",
"description": "Specifies the type of the request throttling policy.\nThe valid values are as follows:\n+ API-based: limiting the maximum number of times a single API bound to the policy can be called within the\nspecified period.\n+ API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified\nperiod.\n"
},
"userThrottles": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigThrottlingPolicyUserThrottle:ApigThrottlingPolicyUserThrottle"
},
"description": "Specifies an array of one or more special throttling policies for IAM user limit.\nThe `throttle` object of the `user_throttles` structure is documented below.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigThrottlingPolicyAssociate:ApigThrottlingPolicyAssociate": {
"description": "Use this resource to bind the APIs to the throttling policy within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst policyId = config.requireObject(\"policyId\");\nconst apiPublishId1 = config.requireObject(\"apiPublishId1\");\nconst apiPublishId2 = config.requireObject(\"apiPublishId2\");\nconst test = new flexibleengine.ApigThrottlingPolicyAssociate(\"test\", {\n instanceId: instanceId,\n policyId: policyId,\n publishIds: [\n apiPublishId1,\n apiPublishId2,\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\npolicy_id = config.require_object(\"policyId\")\napi_publish_id1 = config.require_object(\"apiPublishId1\")\napi_publish_id2 = config.require_object(\"apiPublishId2\")\ntest = flexibleengine.ApigThrottlingPolicyAssociate(\"test\",\n instance_id=instance_id,\n policy_id=policy_id,\n publish_ids=[\n api_publish_id1,\n api_publish_id2,\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var policyId = config.RequireObject(\"policyId\");\n var apiPublishId1 = config.RequireObject(\"apiPublishId1\");\n var apiPublishId2 = config.RequireObject(\"apiPublishId2\");\n var test = new Flexibleengine.ApigThrottlingPolicyAssociate(\"test\", new()\n {\n InstanceId = instanceId,\n PolicyId = policyId,\n PublishIds = new[]\n {\n apiPublishId1,\n apiPublishId2,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tpolicyId := cfg.RequireObject(\"policyId\")\n\t\tapiPublishId1 := cfg.RequireObject(\"apiPublishId1\")\n\t\tapiPublishId2 := cfg.RequireObject(\"apiPublishId2\")\n\t\t_, err := flexibleengine.NewApigThrottlingPolicyAssociate(ctx, \"test\", &flexibleengine.ApigThrottlingPolicyAssociateArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tPolicyId: pulumi.Any(policyId),\n\t\t\tPublishIds: pulumi.StringArray{\n\t\t\t\tapiPublishId1,\n\t\t\t\tapiPublishId2,\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.flexibleengine.ApigThrottlingPolicyAssociate;\nimport com.pulumi.flexibleengine.ApigThrottlingPolicyAssociateArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var policyId = config.get(\"policyId\");\n final var apiPublishId1 = config.get(\"apiPublishId1\");\n final var apiPublishId2 = config.get(\"apiPublishId2\");\n var test = new ApigThrottlingPolicyAssociate(\"test\", ApigThrottlingPolicyAssociateArgs.builder()\n .instanceId(instanceId)\n .policyId(policyId)\n .publishIds( \n apiPublishId1,\n apiPublishId2)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n policyId:\n type: dynamic\n apiPublishId1:\n type: dynamic\n apiPublishId2:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigThrottlingPolicyAssociate\n properties:\n instanceId: ${instanceId}\n policyId: ${policyId}\n publishIds:\n - ${apiPublishId1}\n - ${apiPublishId2}\n```\n\n\n## Import\n\nAssociate resources can be imported using the APIG dedicated instance ID to which the policy\n\nbelongs and `policy_id`, separated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigThrottlingPolicyAssociate:ApigThrottlingPolicyAssociate test /\n```\n\n",
"properties": {
"apigThrottlingPolicyAssociateId": {
"type": "string",
"description": "Resource ID. The format is `/`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the APIG dedicated instance to which the APIs and the\nthrottling policy belongs. Changing this will create a new resource.\n"
},
"policyId": {
"type": "string",
"description": "Specifies the ID of the API group to which the API response belongs to.\nChanging this will create a new resource.\n"
},
"publishIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the publish ID corresponding to the API bound by the throttling policy.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the API instance and throttling policy are located.\nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"type": "object",
"required": [
"apigThrottlingPolicyAssociateId",
"instanceId",
"policyId",
"publishIds",
"region"
],
"inputProperties": {
"apigThrottlingPolicyAssociateId": {
"type": "string",
"description": "Resource ID. The format is `/`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the APIG dedicated instance to which the APIs and the\nthrottling policy belongs. Changing this will create a new resource.\n"
},
"policyId": {
"type": "string",
"description": "Specifies the ID of the API group to which the API response belongs to.\nChanging this will create a new resource.\n"
},
"publishIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the publish ID corresponding to the API bound by the throttling policy.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the API instance and throttling policy are located.\nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"requiredInputs": [
"instanceId",
"policyId",
"publishIds"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigThrottlingPolicyAssociate resources.\n",
"properties": {
"apigThrottlingPolicyAssociateId": {
"type": "string",
"description": "Resource ID. The format is `/`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ID of the APIG dedicated instance to which the APIs and the\nthrottling policy belongs. Changing this will create a new resource.\n"
},
"policyId": {
"type": "string",
"description": "Specifies the ID of the API group to which the API response belongs to.\nChanging this will create a new resource.\n"
},
"publishIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the publish ID corresponding to the API bound by the throttling policy.\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the API instance and throttling policy are located.\nIf omitted, the provider-level region will be used. Changing this will create a new resource.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/apigVpcChannel:ApigVpcChannel": {
"description": "!> **WARNING:** It has been deprecated.\n\nManages a VPC channel resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst instanceId = config.requireObject(\"instanceId\");\nconst channelName = config.requireObject(\"channelName\");\nconst ecsId1 = config.requireObject(\"ecsId1\");\nconst ecsId2 = config.requireObject(\"ecsId2\");\nconst test = new flexibleengine.ApigVpcChannel(\"test\", {\n instanceId: instanceId,\n port: 8080,\n protocol: \"HTTPS\",\n path: \"/\",\n httpCode: \"201,202,203\",\n members: [\n {\n id: ecsId1,\n weight: 30,\n },\n {\n id: ecsId2,\n weight: 70,\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ninstance_id = config.require_object(\"instanceId\")\nchannel_name = config.require_object(\"channelName\")\necs_id1 = config.require_object(\"ecsId1\")\necs_id2 = config.require_object(\"ecsId2\")\ntest = flexibleengine.ApigVpcChannel(\"test\",\n instance_id=instance_id,\n port=8080,\n protocol=\"HTTPS\",\n path=\"/\",\n http_code=\"201,202,203\",\n members=[\n {\n \"id\": ecs_id1,\n \"weight\": 30,\n },\n {\n \"id\": ecs_id2,\n \"weight\": 70,\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var instanceId = config.RequireObject(\"instanceId\");\n var channelName = config.RequireObject(\"channelName\");\n var ecsId1 = config.RequireObject(\"ecsId1\");\n var ecsId2 = config.RequireObject(\"ecsId2\");\n var test = new Flexibleengine.ApigVpcChannel(\"test\", new()\n {\n InstanceId = instanceId,\n Port = 8080,\n Protocol = \"HTTPS\",\n Path = \"/\",\n HttpCode = \"201,202,203\",\n Members = new[]\n {\n new Flexibleengine.Inputs.ApigVpcChannelMemberArgs\n {\n Id = ecsId1,\n Weight = 30,\n },\n new Flexibleengine.Inputs.ApigVpcChannelMemberArgs\n {\n Id = ecsId2,\n Weight = 70,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tinstanceId := cfg.RequireObject(\"instanceId\")\n\t\tchannelName := cfg.RequireObject(\"channelName\")\n\t\tecsId1 := cfg.RequireObject(\"ecsId1\")\n\t\tecsId2 := cfg.RequireObject(\"ecsId2\")\n\t\t_, err := flexibleengine.NewApigVpcChannel(ctx, \"test\", &flexibleengine.ApigVpcChannelArgs{\n\t\t\tInstanceId: pulumi.Any(instanceId),\n\t\t\tPort: pulumi.Float64(8080),\n\t\t\tProtocol: pulumi.String(\"HTTPS\"),\n\t\t\tPath: pulumi.String(\"/\"),\n\t\t\tHttpCode: pulumi.String(\"201,202,203\"),\n\t\t\tMembers: flexibleengine.ApigVpcChannelMemberArray{\n\t\t\t\t&flexibleengine.ApigVpcChannelMemberArgs{\n\t\t\t\t\tId: pulumi.Any(ecsId1),\n\t\t\t\t\tWeight: pulumi.Float64(30),\n\t\t\t\t},\n\t\t\t\t&flexibleengine.ApigVpcChannelMemberArgs{\n\t\t\t\t\tId: pulumi.Any(ecsId2),\n\t\t\t\t\tWeight: pulumi.Float64(70),\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.flexibleengine.ApigVpcChannel;\nimport com.pulumi.flexibleengine.ApigVpcChannelArgs;\nimport com.pulumi.flexibleengine.inputs.ApigVpcChannelMemberArgs;\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 final var config = ctx.config();\n final var instanceId = config.get(\"instanceId\");\n final var channelName = config.get(\"channelName\");\n final var ecsId1 = config.get(\"ecsId1\");\n final var ecsId2 = config.get(\"ecsId2\");\n var test = new ApigVpcChannel(\"test\", ApigVpcChannelArgs.builder()\n .instanceId(instanceId)\n .port(8080)\n .protocol(\"HTTPS\")\n .path(\"/\")\n .httpCode(\"201,202,203\")\n .members( \n ApigVpcChannelMemberArgs.builder()\n .id(ecsId1)\n .weight(30)\n .build(),\n ApigVpcChannelMemberArgs.builder()\n .id(ecsId2)\n .weight(70)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n instanceId:\n type: dynamic\n channelName:\n type: dynamic\n ecsId1:\n type: dynamic\n ecsId2:\n type: dynamic\nresources:\n test:\n type: flexibleengine:ApigVpcChannel\n properties:\n instanceId: ${instanceId}\n port: 8080\n protocol: HTTPS\n path: /\n httpCode: 201,202,203\n members:\n - id: ${ecsId1}\n weight: 30\n - id: ${ecsId2}\n weight: 70\n```\n\n\n## Import\n\nVPC Channels can be imported using the ID of the APIG dedicated instance to which the channel\n\nbelongs and `name`, separated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/apigVpcChannel:ApigVpcChannel test /\n```\n\n",
"properties": {
"algorithm": {
"type": "string",
"description": "Specifies the type of the backend service.\nThe valid types are *WRR*, *WLC*, *SH* and *URI hashing*, default to *WRR*.\n"
},
"apigVpcChannelId": {
"type": "string",
"description": "ID of the VPC channel.\n"
},
"createdAt": {
"type": "string",
"description": "The time when the VPC channel was created.\n"
},
"healthyThreshold": {
"type": "number",
"description": "Specifies the healthy threshold, which refers to the number of consecutive\nsuccessful checks required for a backend server to be considered healthy.\nThe valid value is range from 2 to 10, default to 2.\n"
},
"httpCode": {
"type": "string",
"description": "Specifies the response codes for determining a successful HTTP response. \nThe valid value ranges from `100` to `599` and the valid formats are as follows:\n+ The multiple values, for example, **200,201,202**.\n+ The range, for example, **200-299**.\n+ Both multiple values and ranges, for example, **201,202,210-299**.\n\nIt is Required if the `protocol` is **HTTP**.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the APIG\nvpc channel belongs to.\nChanging this will create a new VPC channel resource.\n"
},
"interval": {
"type": "number",
"description": "Specifies the interval between consecutive checks, in second.\nThe valid value is range from 5 to 300, default to 10.\n"
},
"memberType": {
"type": "string",
"description": "Specifies the type of the backend service.\nThe valid types are *ECS* and *EIP*, default to *ECS*.\n"
},
"members": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigVpcChannelMember:ApigVpcChannelMember"
},
"description": "Specifies an array of one or more backend server IDs or IP addresses that bind the VPC\nchannel. The object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the VPC channel.\nThe channel name consists of 3 to 64 characters, starting with a letter.\nOnly letters, digits and underscores (_) are allowed.\nChinese characters must be in UTF-8 or Unicode format.\n"
},
"path": {
"type": "string",
"description": "Specifies the destination path for health checks.\nRequired if `protocol` is *HTTP* or *HTTPS*.\n"
},
"port": {
"type": "number",
"description": "Specifies the host port of the VPC channel.\nThe valid value is range from 1 to 65535.\n"
},
"protocol": {
"type": "string",
"description": "Specifies the protocol for performing health checks on backend servers in the VPC\nchannel.\nThe valid values are *TCP*, *HTTP* and *HTTPS*, default to *TCP*.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the VPC channel resource.\nIf omitted, the provider-level region will be used.\nChanging this will create a new VPC channel resource.\n"
},
"status": {
"type": "string",
"description": "The status of VPC channel, supports *Normal* and *Abnormal*.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the timeout for determining whether a health check fails, in second.\nThe value must be less than the value of time_interval.\nThe valid value is range from 2 to 30, default to 5.\n"
},
"unhealthyThreshold": {
"type": "number",
"description": "Specifies the unhealthy threshold, which refers to the number of consecutive\nfailed checks required for a backend server to be considered unhealthy.\nThe valid value is range from 2 to 10, default to 5.\n"
}
},
"type": "object",
"required": [
"apigVpcChannelId",
"createdAt",
"instanceId",
"members",
"name",
"port",
"region",
"status"
],
"inputProperties": {
"algorithm": {
"type": "string",
"description": "Specifies the type of the backend service.\nThe valid types are *WRR*, *WLC*, *SH* and *URI hashing*, default to *WRR*.\n"
},
"apigVpcChannelId": {
"type": "string",
"description": "ID of the VPC channel.\n"
},
"healthyThreshold": {
"type": "number",
"description": "Specifies the healthy threshold, which refers to the number of consecutive\nsuccessful checks required for a backend server to be considered healthy.\nThe valid value is range from 2 to 10, default to 2.\n"
},
"httpCode": {
"type": "string",
"description": "Specifies the response codes for determining a successful HTTP response. \nThe valid value ranges from `100` to `599` and the valid formats are as follows:\n+ The multiple values, for example, **200,201,202**.\n+ The range, for example, **200-299**.\n+ Both multiple values and ranges, for example, **201,202,210-299**.\n\nIt is Required if the `protocol` is **HTTP**.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the APIG\nvpc channel belongs to.\nChanging this will create a new VPC channel resource.\n"
},
"interval": {
"type": "number",
"description": "Specifies the interval between consecutive checks, in second.\nThe valid value is range from 5 to 300, default to 10.\n"
},
"memberType": {
"type": "string",
"description": "Specifies the type of the backend service.\nThe valid types are *ECS* and *EIP*, default to *ECS*.\n"
},
"members": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigVpcChannelMember:ApigVpcChannelMember"
},
"description": "Specifies an array of one or more backend server IDs or IP addresses that bind the VPC\nchannel. The object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the VPC channel.\nThe channel name consists of 3 to 64 characters, starting with a letter.\nOnly letters, digits and underscores (_) are allowed.\nChinese characters must be in UTF-8 or Unicode format.\n"
},
"path": {
"type": "string",
"description": "Specifies the destination path for health checks.\nRequired if `protocol` is *HTTP* or *HTTPS*.\n"
},
"port": {
"type": "number",
"description": "Specifies the host port of the VPC channel.\nThe valid value is range from 1 to 65535.\n"
},
"protocol": {
"type": "string",
"description": "Specifies the protocol for performing health checks on backend servers in the VPC\nchannel.\nThe valid values are *TCP*, *HTTP* and *HTTPS*, default to *TCP*.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the VPC channel resource.\nIf omitted, the provider-level region will be used.\nChanging this will create a new VPC channel resource.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the timeout for determining whether a health check fails, in second.\nThe value must be less than the value of time_interval.\nThe valid value is range from 2 to 30, default to 5.\n"
},
"unhealthyThreshold": {
"type": "number",
"description": "Specifies the unhealthy threshold, which refers to the number of consecutive\nfailed checks required for a backend server to be considered unhealthy.\nThe valid value is range from 2 to 10, default to 5.\n"
}
},
"requiredInputs": [
"instanceId",
"members",
"port"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ApigVpcChannel resources.\n",
"properties": {
"algorithm": {
"type": "string",
"description": "Specifies the type of the backend service.\nThe valid types are *WRR*, *WLC*, *SH* and *URI hashing*, default to *WRR*.\n"
},
"apigVpcChannelId": {
"type": "string",
"description": "ID of the VPC channel.\n"
},
"createdAt": {
"type": "string",
"description": "The time when the VPC channel was created.\n"
},
"healthyThreshold": {
"type": "number",
"description": "Specifies the healthy threshold, which refers to the number of consecutive\nsuccessful checks required for a backend server to be considered healthy.\nThe valid value is range from 2 to 10, default to 2.\n"
},
"httpCode": {
"type": "string",
"description": "Specifies the response codes for determining a successful HTTP response. \nThe valid value ranges from `100` to `599` and the valid formats are as follows:\n+ The multiple values, for example, **200,201,202**.\n+ The range, for example, **200-299**.\n+ Both multiple values and ranges, for example, **201,202,210-299**.\n\nIt is Required if the `protocol` is **HTTP**.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies an ID of the APIG dedicated instance to which the APIG\nvpc channel belongs to.\nChanging this will create a new VPC channel resource.\n"
},
"interval": {
"type": "number",
"description": "Specifies the interval between consecutive checks, in second.\nThe valid value is range from 5 to 300, default to 10.\n"
},
"memberType": {
"type": "string",
"description": "Specifies the type of the backend service.\nThe valid types are *ECS* and *EIP*, default to *ECS*.\n"
},
"members": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FApigVpcChannelMember:ApigVpcChannelMember"
},
"description": "Specifies an array of one or more backend server IDs or IP addresses that bind the VPC\nchannel. The object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the VPC channel.\nThe channel name consists of 3 to 64 characters, starting with a letter.\nOnly letters, digits and underscores (_) are allowed.\nChinese characters must be in UTF-8 or Unicode format.\n"
},
"path": {
"type": "string",
"description": "Specifies the destination path for health checks.\nRequired if `protocol` is *HTTP* or *HTTPS*.\n"
},
"port": {
"type": "number",
"description": "Specifies the host port of the VPC channel.\nThe valid value is range from 1 to 65535.\n"
},
"protocol": {
"type": "string",
"description": "Specifies the protocol for performing health checks on backend servers in the VPC\nchannel.\nThe valid values are *TCP*, *HTTP* and *HTTPS*, default to *TCP*.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the VPC channel resource.\nIf omitted, the provider-level region will be used.\nChanging this will create a new VPC channel resource.\n"
},
"status": {
"type": "string",
"description": "The status of VPC channel, supports *Normal* and *Abnormal*.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the timeout for determining whether a health check fails, in second.\nThe value must be less than the value of time_interval.\nThe valid value is range from 2 to 30, default to 5.\n"
},
"unhealthyThreshold": {
"type": "number",
"description": "Specifies the unhealthy threshold, which refers to the number of consecutive\nfailed checks required for a backend server to be considered unhealthy.\nThe valid value is range from 2 to 10, default to 5.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/asConfiguration:AsConfiguration": {
"description": "Manages a V1 AS Configuration resource within flexibleengine.\n\n## Example Usage\n\n### Basic AS Configuration\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\nimport * as fs from \"fs\";\n\nconst myAsConfig = new flexibleengine.AsConfiguration(\"myAsConfig\", {\n scalingConfigurationName: \"my_as_config\",\n instanceConfig: {\n flavor: _var.flavor,\n image: _var.image_id,\n disks: [{\n size: 40,\n volumeType: \"SATA\",\n diskType: \"SYS\",\n }],\n keyName: _var.keyname,\n userData: fs.readFileSync(\"userdata.txt\", \"utf8\"),\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nmy_as_config = flexibleengine.AsConfiguration(\"myAsConfig\",\n scaling_configuration_name=\"my_as_config\",\n instance_config={\n \"flavor\": var[\"flavor\"],\n \"image\": var[\"image_id\"],\n \"disks\": [{\n \"size\": 40,\n \"volume_type\": \"SATA\",\n \"disk_type\": \"SYS\",\n }],\n \"key_name\": var[\"keyname\"],\n \"user_data\": (lambda path: open(path).read())(\"userdata.txt\"),\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.IO;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var myAsConfig = new Flexibleengine.AsConfiguration(\"myAsConfig\", new()\n {\n ScalingConfigurationName = \"my_as_config\",\n InstanceConfig = new Flexibleengine.Inputs.AsConfigurationInstanceConfigArgs\n {\n Flavor = @var.Flavor,\n Image = @var.Image_id,\n Disks = new[]\n {\n new Flexibleengine.Inputs.AsConfigurationInstanceConfigDiskArgs\n {\n Size = 40,\n VolumeType = \"SATA\",\n DiskType = \"SYS\",\n },\n },\n KeyName = @var.Keyname,\n UserData = File.ReadAllText(\"userdata.txt\"),\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"os\"\n\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc readFileOrPanic(path string) pulumi.StringPtrInput {\n\tdata, err := os.ReadFile(path)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\treturn pulumi.String(string(data))\n}\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewAsConfiguration(ctx, \"myAsConfig\", &flexibleengine.AsConfigurationArgs{\n\t\t\tScalingConfigurationName: pulumi.String(\"my_as_config\"),\n\t\t\tInstanceConfig: &flexibleengine.AsConfigurationInstanceConfigArgs{\n\t\t\t\tFlavor: pulumi.Any(_var.Flavor),\n\t\t\t\tImage: pulumi.Any(_var.Image_id),\n\t\t\t\tDisks: flexibleengine.AsConfigurationInstanceConfigDiskArray{\n\t\t\t\t\t&flexibleengine.AsConfigurationInstanceConfigDiskArgs{\n\t\t\t\t\t\tSize: pulumi.Float64(40),\n\t\t\t\t\t\tVolumeType: pulumi.String(\"SATA\"),\n\t\t\t\t\t\tDiskType: pulumi.String(\"SYS\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tKeyName: pulumi.Any(_var.Keyname),\n\t\t\t\tUserData: pulumi.String(readFileOrPanic(\"userdata.txt\")),\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.flexibleengine.AsConfiguration;\nimport com.pulumi.flexibleengine.AsConfigurationArgs;\nimport com.pulumi.flexibleengine.inputs.AsConfigurationInstanceConfigArgs;\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 myAsConfig = new AsConfiguration(\"myAsConfig\", AsConfigurationArgs.builder()\n .scalingConfigurationName(\"my_as_config\")\n .instanceConfig(AsConfigurationInstanceConfigArgs.builder()\n .flavor(var_.flavor())\n .image(var_.image_id())\n .disks(AsConfigurationInstanceConfigDiskArgs.builder()\n .size(40)\n .volumeType(\"SATA\")\n .diskType(\"SYS\")\n .build())\n .keyName(var_.keyname())\n .userData(Files.readString(Paths.get(\"userdata.txt\")))\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n myAsConfig:\n type: flexibleengine:AsConfiguration\n properties:\n scalingConfigurationName: my_as_config\n instanceConfig:\n flavor: ${var.flavor}\n image: ${var.image_id}\n disks:\n - size: 40\n volumeType: SATA\n diskType: SYS\n keyName: ${var.keyname}\n userData:\n fn::readFile: userdata.txt\n```\n\n\n### AS Configuration With User Data and Metadata\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\nimport * as fs from \"fs\";\n\nconst myAsConfig = new flexibleengine.AsConfiguration(\"myAsConfig\", {\n scalingConfigurationName: \"my_as_config\",\n instanceConfig: {\n flavor: _var.flavor,\n image: _var.image_id,\n disks: [{\n size: 40,\n volumeType: \"SATA\",\n diskType: \"SYS\",\n }],\n keyName: _var.keyname,\n userData: fs.readFileSync(\"userdata.txt\", \"utf8\"),\n metadata: {\n some_key: \"some_value\",\n },\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nmy_as_config = flexibleengine.AsConfiguration(\"myAsConfig\",\n scaling_configuration_name=\"my_as_config\",\n instance_config={\n \"flavor\": var[\"flavor\"],\n \"image\": var[\"image_id\"],\n \"disks\": [{\n \"size\": 40,\n \"volume_type\": \"SATA\",\n \"disk_type\": \"SYS\",\n }],\n \"key_name\": var[\"keyname\"],\n \"user_data\": (lambda path: open(path).read())(\"userdata.txt\"),\n \"metadata\": {\n \"some_key\": \"some_value\",\n },\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.IO;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var myAsConfig = new Flexibleengine.AsConfiguration(\"myAsConfig\", new()\n {\n ScalingConfigurationName = \"my_as_config\",\n InstanceConfig = new Flexibleengine.Inputs.AsConfigurationInstanceConfigArgs\n {\n Flavor = @var.Flavor,\n Image = @var.Image_id,\n Disks = new[]\n {\n new Flexibleengine.Inputs.AsConfigurationInstanceConfigDiskArgs\n {\n Size = 40,\n VolumeType = \"SATA\",\n DiskType = \"SYS\",\n },\n },\n KeyName = @var.Keyname,\n UserData = File.ReadAllText(\"userdata.txt\"),\n Metadata = \n {\n { \"some_key\", \"some_value\" },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"os\"\n\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc readFileOrPanic(path string) pulumi.StringPtrInput {\n\tdata, err := os.ReadFile(path)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\treturn pulumi.String(string(data))\n}\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewAsConfiguration(ctx, \"myAsConfig\", &flexibleengine.AsConfigurationArgs{\n\t\t\tScalingConfigurationName: pulumi.String(\"my_as_config\"),\n\t\t\tInstanceConfig: &flexibleengine.AsConfigurationInstanceConfigArgs{\n\t\t\t\tFlavor: pulumi.Any(_var.Flavor),\n\t\t\t\tImage: pulumi.Any(_var.Image_id),\n\t\t\t\tDisks: flexibleengine.AsConfigurationInstanceConfigDiskArray{\n\t\t\t\t\t&flexibleengine.AsConfigurationInstanceConfigDiskArgs{\n\t\t\t\t\t\tSize: pulumi.Float64(40),\n\t\t\t\t\t\tVolumeType: pulumi.String(\"SATA\"),\n\t\t\t\t\t\tDiskType: pulumi.String(\"SYS\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tKeyName: pulumi.Any(_var.Keyname),\n\t\t\t\tUserData: pulumi.String(readFileOrPanic(\"userdata.txt\")),\n\t\t\t\tMetadata: pulumi.StringMap{\n\t\t\t\t\t\"some_key\": pulumi.String(\"some_value\"),\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.flexibleengine.AsConfiguration;\nimport com.pulumi.flexibleengine.AsConfigurationArgs;\nimport com.pulumi.flexibleengine.inputs.AsConfigurationInstanceConfigArgs;\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 myAsConfig = new AsConfiguration(\"myAsConfig\", AsConfigurationArgs.builder()\n .scalingConfigurationName(\"my_as_config\")\n .instanceConfig(AsConfigurationInstanceConfigArgs.builder()\n .flavor(var_.flavor())\n .image(var_.image_id())\n .disks(AsConfigurationInstanceConfigDiskArgs.builder()\n .size(40)\n .volumeType(\"SATA\")\n .diskType(\"SYS\")\n .build())\n .keyName(var_.keyname())\n .userData(Files.readString(Paths.get(\"userdata.txt\")))\n .metadata(Map.of(\"some_key\", \"some_value\"))\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n myAsConfig:\n type: flexibleengine:AsConfiguration\n properties:\n scalingConfigurationName: my_as_config\n instanceConfig:\n flavor: ${var.flavor}\n image: ${var.image_id}\n disks:\n - size: 40\n volumeType: SATA\n diskType: SYS\n keyName: ${var.keyname}\n userData:\n fn::readFile: userdata.txt\n metadata:\n some_key: some_value\n```\n\n\n`user_data` can come from a variety of sources: inline, read in from the `file`\nfunction, or the `template_cloudinit_config` resource.\n\n### AS Configuration uses the existing instance specifications as the template\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst myAsConfig = new flexibleengine.AsConfiguration(\"myAsConfig\", {\n scalingConfigurationName: \"my_as_config\",\n instanceConfig: {\n instanceId: \"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n keyName: _var.keyname,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nmy_as_config = flexibleengine.AsConfiguration(\"myAsConfig\",\n scaling_configuration_name=\"my_as_config\",\n instance_config={\n \"instance_id\": \"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n \"key_name\": var[\"keyname\"],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var myAsConfig = new Flexibleengine.AsConfiguration(\"myAsConfig\", new()\n {\n ScalingConfigurationName = \"my_as_config\",\n InstanceConfig = new Flexibleengine.Inputs.AsConfigurationInstanceConfigArgs\n {\n InstanceId = \"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n KeyName = @var.Keyname,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewAsConfiguration(ctx, \"myAsConfig\", &flexibleengine.AsConfigurationArgs{\n\t\t\tScalingConfigurationName: pulumi.String(\"my_as_config\"),\n\t\t\tInstanceConfig: &flexibleengine.AsConfigurationInstanceConfigArgs{\n\t\t\t\tInstanceId: pulumi.String(\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\"),\n\t\t\t\tKeyName: pulumi.Any(_var.Keyname),\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.flexibleengine.AsConfiguration;\nimport com.pulumi.flexibleengine.AsConfigurationArgs;\nimport com.pulumi.flexibleengine.inputs.AsConfigurationInstanceConfigArgs;\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 myAsConfig = new AsConfiguration(\"myAsConfig\", AsConfigurationArgs.builder()\n .scalingConfigurationName(\"my_as_config\")\n .instanceConfig(AsConfigurationInstanceConfigArgs.builder()\n .instanceId(\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\")\n .keyName(var_.keyname())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n myAsConfig:\n type: flexibleengine:AsConfiguration\n properties:\n scalingConfigurationName: my_as_config\n instanceConfig:\n instanceId: 4579f2f5-cbe8-425a-8f32-53dcb9d9053a\n keyName: ${var.keyname}\n```\n\n",
"properties": {
"asConfigurationId": {
"type": "string"
},
"instanceConfig": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationInstanceConfig:AsConfigurationInstanceConfig",
"description": "The information about instance configurations. The instance_config\ndictionary data structure is documented below. Changing this creates a new AS configuration.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the AS configuration. If\nomitted, the `region` argument of the provider is used. Changing this\ncreates a new AS configuration.\n"
},
"scalingConfigurationName": {
"type": "string",
"description": "The name of the AS configuration. The name can contain letters,\ndigits, underscores(_), and hyphens(-), and cannot exceed 64 characters. Changing this creates a new AS configuration.\n"
}
},
"type": "object",
"required": [
"asConfigurationId",
"instanceConfig",
"region",
"scalingConfigurationName"
],
"inputProperties": {
"asConfigurationId": {
"type": "string"
},
"instanceConfig": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationInstanceConfig:AsConfigurationInstanceConfig",
"description": "The information about instance configurations. The instance_config\ndictionary data structure is documented below. Changing this creates a new AS configuration.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the AS configuration. If\nomitted, the `region` argument of the provider is used. Changing this\ncreates a new AS configuration.\n"
},
"scalingConfigurationName": {
"type": "string",
"description": "The name of the AS configuration. The name can contain letters,\ndigits, underscores(_), and hyphens(-), and cannot exceed 64 characters. Changing this creates a new AS configuration.\n"
}
},
"requiredInputs": [
"instanceConfig",
"scalingConfigurationName"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AsConfiguration resources.\n",
"properties": {
"asConfigurationId": {
"type": "string"
},
"instanceConfig": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationInstanceConfig:AsConfigurationInstanceConfig",
"description": "The information about instance configurations. The instance_config\ndictionary data structure is documented below. Changing this creates a new AS configuration.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the AS configuration. If\nomitted, the `region` argument of the provider is used. Changing this\ncreates a new AS configuration.\n"
},
"scalingConfigurationName": {
"type": "string",
"description": "The name of the AS configuration. The name can contain letters,\ndigits, underscores(_), and hyphens(-), and cannot exceed 64 characters. Changing this creates a new AS configuration.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/asConfigurationV1:AsConfigurationV1": {
"properties": {
"asConfigurationV1Id": {
"type": "string"
},
"instanceConfig": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationV1InstanceConfig:AsConfigurationV1InstanceConfig"
},
"region": {
"type": "string"
},
"scalingConfigurationName": {
"type": "string"
}
},
"type": "object",
"required": [
"asConfigurationV1Id",
"instanceConfig",
"region",
"scalingConfigurationName"
],
"inputProperties": {
"asConfigurationV1Id": {
"type": "string"
},
"instanceConfig": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationV1InstanceConfig:AsConfigurationV1InstanceConfig"
},
"region": {
"type": "string"
},
"scalingConfigurationName": {
"type": "string"
}
},
"requiredInputs": [
"instanceConfig",
"scalingConfigurationName"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AsConfigurationV1 resources.\n",
"properties": {
"asConfigurationV1Id": {
"type": "string"
},
"instanceConfig": {
"$ref": "#/types/flexibleengine:index%2FAsConfigurationV1InstanceConfig:AsConfigurationV1InstanceConfig"
},
"region": {
"type": "string"
},
"scalingConfigurationName": {
"type": "string"
}
},
"type": "object"
}
},
"flexibleengine:index/asGroup:AsGroup": {
"description": "Manages a V1 Autoscaling Group resource within flexibleengine.\n\n## Example Usage\n\n### Basic Autoscaling Group\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst exampleVpc = new flexibleengine.VpcV1(\"exampleVpc\", {cidr: \"192.168.0.0/16\"});\nconst exampleSubnet = new flexibleengine.VpcSubnetV1(\"exampleSubnet\", {\n cidr: \"192.168.0.0/24\",\n gatewayIp: \"192.168.0.1\",\n vpcId: exampleVpc.vpcV1Id,\n});\nconst myAsGroup = new flexibleengine.AsGroup(\"myAsGroup\", {\n scalingGroupName: \"my_as_group\",\n desireInstanceNumber: 2,\n minInstanceNumber: 0,\n maxInstanceNumber: 10,\n scalingConfigurationId: \"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n vpcId: exampleVpc.vpcV1Id,\n deletePublicip: true,\n deleteInstances: \"yes\",\n networks: [{\n id: exampleSubnet.vpcSubnetV1Id,\n }],\n securityGroups: [{\n id: \"45e4c6de-6bf0-4843-8953-2babde3d4810\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nexample_vpc = flexibleengine.VpcV1(\"exampleVpc\", cidr=\"192.168.0.0/16\")\nexample_subnet = flexibleengine.VpcSubnetV1(\"exampleSubnet\",\n cidr=\"192.168.0.0/24\",\n gateway_ip=\"192.168.0.1\",\n vpc_id=example_vpc.vpc_v1_id)\nmy_as_group = flexibleengine.AsGroup(\"myAsGroup\",\n scaling_group_name=\"my_as_group\",\n desire_instance_number=2,\n min_instance_number=0,\n max_instance_number=10,\n scaling_configuration_id=\"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n vpc_id=example_vpc.vpc_v1_id,\n delete_publicip=True,\n delete_instances=\"yes\",\n networks=[{\n \"id\": example_subnet.vpc_subnet_v1_id,\n }],\n security_groups=[{\n \"id\": \"45e4c6de-6bf0-4843-8953-2babde3d4810\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var exampleVpc = new Flexibleengine.VpcV1(\"exampleVpc\", new()\n {\n Cidr = \"192.168.0.0/16\",\n });\n\n var exampleSubnet = new Flexibleengine.VpcSubnetV1(\"exampleSubnet\", new()\n {\n Cidr = \"192.168.0.0/24\",\n GatewayIp = \"192.168.0.1\",\n VpcId = exampleVpc.VpcV1Id,\n });\n\n var myAsGroup = new Flexibleengine.AsGroup(\"myAsGroup\", new()\n {\n ScalingGroupName = \"my_as_group\",\n DesireInstanceNumber = 2,\n MinInstanceNumber = 0,\n MaxInstanceNumber = 10,\n ScalingConfigurationId = \"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n VpcId = exampleVpc.VpcV1Id,\n DeletePublicip = true,\n DeleteInstances = \"yes\",\n Networks = new[]\n {\n new Flexibleengine.Inputs.AsGroupNetworkArgs\n {\n Id = exampleSubnet.VpcSubnetV1Id,\n },\n },\n SecurityGroups = new[]\n {\n new Flexibleengine.Inputs.AsGroupSecurityGroupArgs\n {\n Id = \"45e4c6de-6bf0-4843-8953-2babde3d4810\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texampleVpc, err := flexibleengine.NewVpcV1(ctx, \"exampleVpc\", &flexibleengine.VpcV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/16\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleSubnet, err := flexibleengine.NewVpcSubnetV1(ctx, \"exampleSubnet\", &flexibleengine.VpcSubnetV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/24\"),\n\t\t\tGatewayIp: pulumi.String(\"192.168.0.1\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewAsGroup(ctx, \"myAsGroup\", &flexibleengine.AsGroupArgs{\n\t\t\tScalingGroupName: pulumi.String(\"my_as_group\"),\n\t\t\tDesireInstanceNumber: pulumi.Float64(2),\n\t\t\tMinInstanceNumber: pulumi.Float64(0),\n\t\t\tMaxInstanceNumber: pulumi.Float64(10),\n\t\t\tScalingConfigurationId: pulumi.String(\"37e310f5-db9d-446e-9135-c625f9c2bbfc\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t\tDeletePublicip: pulumi.Bool(true),\n\t\t\tDeleteInstances: pulumi.String(\"yes\"),\n\t\t\tNetworks: flexibleengine.AsGroupNetworkArray{\n\t\t\t\t&flexibleengine.AsGroupNetworkArgs{\n\t\t\t\t\tId: exampleSubnet.VpcSubnetV1Id,\n\t\t\t\t},\n\t\t\t},\n\t\t\tSecurityGroups: flexibleengine.AsGroupSecurityGroupArray{\n\t\t\t\t&flexibleengine.AsGroupSecurityGroupArgs{\n\t\t\t\t\tId: pulumi.String(\"45e4c6de-6bf0-4843-8953-2babde3d4810\"),\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.flexibleengine.VpcV1;\nimport com.pulumi.flexibleengine.VpcV1Args;\nimport com.pulumi.flexibleengine.VpcSubnetV1;\nimport com.pulumi.flexibleengine.VpcSubnetV1Args;\nimport com.pulumi.flexibleengine.AsGroup;\nimport com.pulumi.flexibleengine.AsGroupArgs;\nimport com.pulumi.flexibleengine.inputs.AsGroupNetworkArgs;\nimport com.pulumi.flexibleengine.inputs.AsGroupSecurityGroupArgs;\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 exampleVpc = new VpcV1(\"exampleVpc\", VpcV1Args.builder()\n .cidr(\"192.168.0.0/16\")\n .build());\n\n var exampleSubnet = new VpcSubnetV1(\"exampleSubnet\", VpcSubnetV1Args.builder()\n .cidr(\"192.168.0.0/24\")\n .gatewayIp(\"192.168.0.1\")\n .vpcId(exampleVpc.vpcV1Id())\n .build());\n\n var myAsGroup = new AsGroup(\"myAsGroup\", AsGroupArgs.builder()\n .scalingGroupName(\"my_as_group\")\n .desireInstanceNumber(2)\n .minInstanceNumber(0)\n .maxInstanceNumber(10)\n .scalingConfigurationId(\"37e310f5-db9d-446e-9135-c625f9c2bbfc\")\n .vpcId(exampleVpc.vpcV1Id())\n .deletePublicip(true)\n .deleteInstances(\"yes\")\n .networks(AsGroupNetworkArgs.builder()\n .id(exampleSubnet.vpcSubnetV1Id())\n .build())\n .securityGroups(AsGroupSecurityGroupArgs.builder()\n .id(\"45e4c6de-6bf0-4843-8953-2babde3d4810\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n exampleVpc:\n type: flexibleengine:VpcV1\n properties:\n cidr: 192.168.0.0/16\n exampleSubnet:\n type: flexibleengine:VpcSubnetV1\n properties:\n cidr: 192.168.0.0/24\n gatewayIp: 192.168.0.1\n vpcId: ${exampleVpc.vpcV1Id}\n myAsGroup:\n type: flexibleengine:AsGroup\n properties:\n scalingGroupName: my_as_group\n desireInstanceNumber: 2\n minInstanceNumber: 0\n maxInstanceNumber: 10\n scalingConfigurationId: 37e310f5-db9d-446e-9135-c625f9c2bbfc\n vpcId: ${exampleVpc.vpcV1Id}\n deletePublicip: true\n deleteInstances: yes\n networks:\n - id: ${exampleSubnet.vpcSubnetV1Id}\n securityGroups:\n - id: 45e4c6de-6bf0-4843-8953-2babde3d4810\n```\n\n\n### Autoscaling Group Only Remove Members When Scaling Down\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst exampleVpc = new flexibleengine.VpcV1(\"exampleVpc\", {cidr: \"192.168.0.0/16\"});\nconst exampleSubnet = new flexibleengine.VpcSubnetV1(\"exampleSubnet\", {\n cidr: \"192.168.0.0/24\",\n gatewayIp: \"192.168.0.1\",\n vpcId: exampleVpc.vpcV1Id,\n});\nconst myAsGroupOnlyRemoveMembers = new flexibleengine.AsGroup(\"myAsGroupOnlyRemoveMembers\", {\n scalingGroupName: \"my_as_group_only_remove_members\",\n desireInstanceNumber: 2,\n minInstanceNumber: 0,\n maxInstanceNumber: 10,\n scalingConfigurationId: \"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n vpcId: exampleVpc.vpcV1Id,\n deletePublicip: true,\n deleteInstances: \"no\",\n networks: [{\n id: exampleSubnet.vpcSubnetV1Id,\n }],\n securityGroups: [{\n id: \"45e4c6de-6bf0-4843-8953-2babde3d4810\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nexample_vpc = flexibleengine.VpcV1(\"exampleVpc\", cidr=\"192.168.0.0/16\")\nexample_subnet = flexibleengine.VpcSubnetV1(\"exampleSubnet\",\n cidr=\"192.168.0.0/24\",\n gateway_ip=\"192.168.0.1\",\n vpc_id=example_vpc.vpc_v1_id)\nmy_as_group_only_remove_members = flexibleengine.AsGroup(\"myAsGroupOnlyRemoveMembers\",\n scaling_group_name=\"my_as_group_only_remove_members\",\n desire_instance_number=2,\n min_instance_number=0,\n max_instance_number=10,\n scaling_configuration_id=\"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n vpc_id=example_vpc.vpc_v1_id,\n delete_publicip=True,\n delete_instances=\"no\",\n networks=[{\n \"id\": example_subnet.vpc_subnet_v1_id,\n }],\n security_groups=[{\n \"id\": \"45e4c6de-6bf0-4843-8953-2babde3d4810\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var exampleVpc = new Flexibleengine.VpcV1(\"exampleVpc\", new()\n {\n Cidr = \"192.168.0.0/16\",\n });\n\n var exampleSubnet = new Flexibleengine.VpcSubnetV1(\"exampleSubnet\", new()\n {\n Cidr = \"192.168.0.0/24\",\n GatewayIp = \"192.168.0.1\",\n VpcId = exampleVpc.VpcV1Id,\n });\n\n var myAsGroupOnlyRemoveMembers = new Flexibleengine.AsGroup(\"myAsGroupOnlyRemoveMembers\", new()\n {\n ScalingGroupName = \"my_as_group_only_remove_members\",\n DesireInstanceNumber = 2,\n MinInstanceNumber = 0,\n MaxInstanceNumber = 10,\n ScalingConfigurationId = \"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n VpcId = exampleVpc.VpcV1Id,\n DeletePublicip = true,\n DeleteInstances = \"no\",\n Networks = new[]\n {\n new Flexibleengine.Inputs.AsGroupNetworkArgs\n {\n Id = exampleSubnet.VpcSubnetV1Id,\n },\n },\n SecurityGroups = new[]\n {\n new Flexibleengine.Inputs.AsGroupSecurityGroupArgs\n {\n Id = \"45e4c6de-6bf0-4843-8953-2babde3d4810\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texampleVpc, err := flexibleengine.NewVpcV1(ctx, \"exampleVpc\", &flexibleengine.VpcV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/16\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleSubnet, err := flexibleengine.NewVpcSubnetV1(ctx, \"exampleSubnet\", &flexibleengine.VpcSubnetV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/24\"),\n\t\t\tGatewayIp: pulumi.String(\"192.168.0.1\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewAsGroup(ctx, \"myAsGroupOnlyRemoveMembers\", &flexibleengine.AsGroupArgs{\n\t\t\tScalingGroupName: pulumi.String(\"my_as_group_only_remove_members\"),\n\t\t\tDesireInstanceNumber: pulumi.Float64(2),\n\t\t\tMinInstanceNumber: pulumi.Float64(0),\n\t\t\tMaxInstanceNumber: pulumi.Float64(10),\n\t\t\tScalingConfigurationId: pulumi.String(\"37e310f5-db9d-446e-9135-c625f9c2bbfc\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t\tDeletePublicip: pulumi.Bool(true),\n\t\t\tDeleteInstances: pulumi.String(\"no\"),\n\t\t\tNetworks: flexibleengine.AsGroupNetworkArray{\n\t\t\t\t&flexibleengine.AsGroupNetworkArgs{\n\t\t\t\t\tId: exampleSubnet.VpcSubnetV1Id,\n\t\t\t\t},\n\t\t\t},\n\t\t\tSecurityGroups: flexibleengine.AsGroupSecurityGroupArray{\n\t\t\t\t&flexibleengine.AsGroupSecurityGroupArgs{\n\t\t\t\t\tId: pulumi.String(\"45e4c6de-6bf0-4843-8953-2babde3d4810\"),\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.flexibleengine.VpcV1;\nimport com.pulumi.flexibleengine.VpcV1Args;\nimport com.pulumi.flexibleengine.VpcSubnetV1;\nimport com.pulumi.flexibleengine.VpcSubnetV1Args;\nimport com.pulumi.flexibleengine.AsGroup;\nimport com.pulumi.flexibleengine.AsGroupArgs;\nimport com.pulumi.flexibleengine.inputs.AsGroupNetworkArgs;\nimport com.pulumi.flexibleengine.inputs.AsGroupSecurityGroupArgs;\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 exampleVpc = new VpcV1(\"exampleVpc\", VpcV1Args.builder()\n .cidr(\"192.168.0.0/16\")\n .build());\n\n var exampleSubnet = new VpcSubnetV1(\"exampleSubnet\", VpcSubnetV1Args.builder()\n .cidr(\"192.168.0.0/24\")\n .gatewayIp(\"192.168.0.1\")\n .vpcId(exampleVpc.vpcV1Id())\n .build());\n\n var myAsGroupOnlyRemoveMembers = new AsGroup(\"myAsGroupOnlyRemoveMembers\", AsGroupArgs.builder()\n .scalingGroupName(\"my_as_group_only_remove_members\")\n .desireInstanceNumber(2)\n .minInstanceNumber(0)\n .maxInstanceNumber(10)\n .scalingConfigurationId(\"37e310f5-db9d-446e-9135-c625f9c2bbfc\")\n .vpcId(exampleVpc.vpcV1Id())\n .deletePublicip(true)\n .deleteInstances(\"no\")\n .networks(AsGroupNetworkArgs.builder()\n .id(exampleSubnet.vpcSubnetV1Id())\n .build())\n .securityGroups(AsGroupSecurityGroupArgs.builder()\n .id(\"45e4c6de-6bf0-4843-8953-2babde3d4810\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n exampleVpc:\n type: flexibleengine:VpcV1\n properties:\n cidr: 192.168.0.0/16\n exampleSubnet:\n type: flexibleengine:VpcSubnetV1\n properties:\n cidr: 192.168.0.0/24\n gatewayIp: 192.168.0.1\n vpcId: ${exampleVpc.vpcV1Id}\n myAsGroupOnlyRemoveMembers:\n type: flexibleengine:AsGroup\n properties:\n scalingGroupName: my_as_group_only_remove_members\n desireInstanceNumber: 2\n minInstanceNumber: 0\n maxInstanceNumber: 10\n scalingConfigurationId: 37e310f5-db9d-446e-9135-c625f9c2bbfc\n vpcId: ${exampleVpc.vpcV1Id}\n deletePublicip: true\n deleteInstances: no\n networks:\n - id: ${exampleSubnet.vpcSubnetV1Id}\n securityGroups:\n - id: 45e4c6de-6bf0-4843-8953-2babde3d4810\n```\n\n\n### Autoscaling Group With ELB Listener\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst exampleVpc = new flexibleengine.VpcV1(\"exampleVpc\", {cidr: \"192.168.0.0/16\"});\nconst exampleSubnet = new flexibleengine.VpcSubnetV1(\"exampleSubnet\", {\n cidr: \"192.168.0.0/24\",\n gatewayIp: \"192.168.0.1\",\n vpcId: exampleVpc.vpcV1Id,\n});\nconst lb1 = new flexibleengine.LbLoadbalancerV2(\"lb1\", {vipSubnetId: exampleSubnet.ipv4SubnetId});\nconst listener1 = new flexibleengine.LbListenerV2(\"listener1\", {\n protocol: \"HTTP\",\n protocolPort: 8080,\n loadbalancerId: lb1.lbLoadbalancerV2Id,\n});\nconst myAsGroupWithElb = new flexibleengine.AsGroup(\"myAsGroupWithElb\", {\n scalingGroupName: \"my_as_group_with_elb\",\n desireInstanceNumber: 2,\n minInstanceNumber: 0,\n maxInstanceNumber: 10,\n lbListenerId: listener1.lbListenerV2Id,\n scalingConfigurationId: \"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n vpcId: exampleVpc.vpcV1Id,\n deletePublicip: true,\n deleteInstances: \"yes\",\n networks: [{\n id: exampleSubnet.vpcSubnetV1Id,\n }],\n securityGroups: [{\n id: \"45e4c6de-6bf0-4843-8953-2babde3d4810\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nexample_vpc = flexibleengine.VpcV1(\"exampleVpc\", cidr=\"192.168.0.0/16\")\nexample_subnet = flexibleengine.VpcSubnetV1(\"exampleSubnet\",\n cidr=\"192.168.0.0/24\",\n gateway_ip=\"192.168.0.1\",\n vpc_id=example_vpc.vpc_v1_id)\nlb1 = flexibleengine.LbLoadbalancerV2(\"lb1\", vip_subnet_id=example_subnet.ipv4_subnet_id)\nlistener1 = flexibleengine.LbListenerV2(\"listener1\",\n protocol=\"HTTP\",\n protocol_port=8080,\n loadbalancer_id=lb1.lb_loadbalancer_v2_id)\nmy_as_group_with_elb = flexibleengine.AsGroup(\"myAsGroupWithElb\",\n scaling_group_name=\"my_as_group_with_elb\",\n desire_instance_number=2,\n min_instance_number=0,\n max_instance_number=10,\n lb_listener_id=listener1.lb_listener_v2_id,\n scaling_configuration_id=\"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n vpc_id=example_vpc.vpc_v1_id,\n delete_publicip=True,\n delete_instances=\"yes\",\n networks=[{\n \"id\": example_subnet.vpc_subnet_v1_id,\n }],\n security_groups=[{\n \"id\": \"45e4c6de-6bf0-4843-8953-2babde3d4810\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var exampleVpc = new Flexibleengine.VpcV1(\"exampleVpc\", new()\n {\n Cidr = \"192.168.0.0/16\",\n });\n\n var exampleSubnet = new Flexibleengine.VpcSubnetV1(\"exampleSubnet\", new()\n {\n Cidr = \"192.168.0.0/24\",\n GatewayIp = \"192.168.0.1\",\n VpcId = exampleVpc.VpcV1Id,\n });\n\n var lb1 = new Flexibleengine.LbLoadbalancerV2(\"lb1\", new()\n {\n VipSubnetId = exampleSubnet.Ipv4SubnetId,\n });\n\n var listener1 = new Flexibleengine.LbListenerV2(\"listener1\", new()\n {\n Protocol = \"HTTP\",\n ProtocolPort = 8080,\n LoadbalancerId = lb1.LbLoadbalancerV2Id,\n });\n\n var myAsGroupWithElb = new Flexibleengine.AsGroup(\"myAsGroupWithElb\", new()\n {\n ScalingGroupName = \"my_as_group_with_elb\",\n DesireInstanceNumber = 2,\n MinInstanceNumber = 0,\n MaxInstanceNumber = 10,\n LbListenerId = listener1.LbListenerV2Id,\n ScalingConfigurationId = \"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n VpcId = exampleVpc.VpcV1Id,\n DeletePublicip = true,\n DeleteInstances = \"yes\",\n Networks = new[]\n {\n new Flexibleengine.Inputs.AsGroupNetworkArgs\n {\n Id = exampleSubnet.VpcSubnetV1Id,\n },\n },\n SecurityGroups = new[]\n {\n new Flexibleengine.Inputs.AsGroupSecurityGroupArgs\n {\n Id = \"45e4c6de-6bf0-4843-8953-2babde3d4810\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texampleVpc, err := flexibleengine.NewVpcV1(ctx, \"exampleVpc\", &flexibleengine.VpcV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/16\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleSubnet, err := flexibleengine.NewVpcSubnetV1(ctx, \"exampleSubnet\", &flexibleengine.VpcSubnetV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/24\"),\n\t\t\tGatewayIp: pulumi.String(\"192.168.0.1\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlb1, err := flexibleengine.NewLbLoadbalancerV2(ctx, \"lb1\", &flexibleengine.LbLoadbalancerV2Args{\n\t\t\tVipSubnetId: exampleSubnet.Ipv4SubnetId,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlistener1, err := flexibleengine.NewLbListenerV2(ctx, \"listener1\", &flexibleengine.LbListenerV2Args{\n\t\t\tProtocol: pulumi.String(\"HTTP\"),\n\t\t\tProtocolPort: pulumi.Float64(8080),\n\t\t\tLoadbalancerId: lb1.LbLoadbalancerV2Id,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewAsGroup(ctx, \"myAsGroupWithElb\", &flexibleengine.AsGroupArgs{\n\t\t\tScalingGroupName: pulumi.String(\"my_as_group_with_elb\"),\n\t\t\tDesireInstanceNumber: pulumi.Float64(2),\n\t\t\tMinInstanceNumber: pulumi.Float64(0),\n\t\t\tMaxInstanceNumber: pulumi.Float64(10),\n\t\t\tLbListenerId: listener1.LbListenerV2Id,\n\t\t\tScalingConfigurationId: pulumi.String(\"37e310f5-db9d-446e-9135-c625f9c2bbfc\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t\tDeletePublicip: pulumi.Bool(true),\n\t\t\tDeleteInstances: pulumi.String(\"yes\"),\n\t\t\tNetworks: flexibleengine.AsGroupNetworkArray{\n\t\t\t\t&flexibleengine.AsGroupNetworkArgs{\n\t\t\t\t\tId: exampleSubnet.VpcSubnetV1Id,\n\t\t\t\t},\n\t\t\t},\n\t\t\tSecurityGroups: flexibleengine.AsGroupSecurityGroupArray{\n\t\t\t\t&flexibleengine.AsGroupSecurityGroupArgs{\n\t\t\t\t\tId: pulumi.String(\"45e4c6de-6bf0-4843-8953-2babde3d4810\"),\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.flexibleengine.VpcV1;\nimport com.pulumi.flexibleengine.VpcV1Args;\nimport com.pulumi.flexibleengine.VpcSubnetV1;\nimport com.pulumi.flexibleengine.VpcSubnetV1Args;\nimport com.pulumi.flexibleengine.LbLoadbalancerV2;\nimport com.pulumi.flexibleengine.LbLoadbalancerV2Args;\nimport com.pulumi.flexibleengine.LbListenerV2;\nimport com.pulumi.flexibleengine.LbListenerV2Args;\nimport com.pulumi.flexibleengine.AsGroup;\nimport com.pulumi.flexibleengine.AsGroupArgs;\nimport com.pulumi.flexibleengine.inputs.AsGroupNetworkArgs;\nimport com.pulumi.flexibleengine.inputs.AsGroupSecurityGroupArgs;\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 exampleVpc = new VpcV1(\"exampleVpc\", VpcV1Args.builder()\n .cidr(\"192.168.0.0/16\")\n .build());\n\n var exampleSubnet = new VpcSubnetV1(\"exampleSubnet\", VpcSubnetV1Args.builder()\n .cidr(\"192.168.0.0/24\")\n .gatewayIp(\"192.168.0.1\")\n .vpcId(exampleVpc.vpcV1Id())\n .build());\n\n var lb1 = new LbLoadbalancerV2(\"lb1\", LbLoadbalancerV2Args.builder()\n .vipSubnetId(exampleSubnet.ipv4SubnetId())\n .build());\n\n var listener1 = new LbListenerV2(\"listener1\", LbListenerV2Args.builder()\n .protocol(\"HTTP\")\n .protocolPort(8080)\n .loadbalancerId(lb1.lbLoadbalancerV2Id())\n .build());\n\n var myAsGroupWithElb = new AsGroup(\"myAsGroupWithElb\", AsGroupArgs.builder()\n .scalingGroupName(\"my_as_group_with_elb\")\n .desireInstanceNumber(2)\n .minInstanceNumber(0)\n .maxInstanceNumber(10)\n .lbListenerId(listener1.lbListenerV2Id())\n .scalingConfigurationId(\"37e310f5-db9d-446e-9135-c625f9c2bbfc\")\n .vpcId(exampleVpc.vpcV1Id())\n .deletePublicip(true)\n .deleteInstances(\"yes\")\n .networks(AsGroupNetworkArgs.builder()\n .id(exampleSubnet.vpcSubnetV1Id())\n .build())\n .securityGroups(AsGroupSecurityGroupArgs.builder()\n .id(\"45e4c6de-6bf0-4843-8953-2babde3d4810\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n exampleVpc:\n type: flexibleengine:VpcV1\n properties:\n cidr: 192.168.0.0/16\n exampleSubnet:\n type: flexibleengine:VpcSubnetV1\n properties:\n cidr: 192.168.0.0/24\n gatewayIp: 192.168.0.1\n vpcId: ${exampleVpc.vpcV1Id}\n lb1:\n type: flexibleengine:LbLoadbalancerV2\n properties:\n vipSubnetId: ${exampleSubnet.ipv4SubnetId}\n listener1:\n type: flexibleengine:LbListenerV2\n properties:\n protocol: HTTP\n protocolPort: 8080\n loadbalancerId: ${lb1.lbLoadbalancerV2Id}\n myAsGroupWithElb:\n type: flexibleengine:AsGroup\n properties:\n scalingGroupName: my_as_group_with_elb\n desireInstanceNumber: 2\n minInstanceNumber: 0\n maxInstanceNumber: 10\n lbListenerId: ${listener1.lbListenerV2Id}\n scalingConfigurationId: 37e310f5-db9d-446e-9135-c625f9c2bbfc\n vpcId: ${exampleVpc.vpcV1Id}\n deletePublicip: true\n deleteInstances: yes\n networks:\n - id: ${exampleSubnet.vpcSubnetV1Id}\n securityGroups:\n - id: 45e4c6de-6bf0-4843-8953-2babde3d4810\n```\n\n",
"properties": {
"asGroupId": {
"type": "string"
},
"availableZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The availability zones in which to create\nthe instances in the autoscaling group.\n"
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration (in seconds). The value ranges\nfrom 0 to 86400, and is 900 by default.\n"
},
"currentInstanceNumber": {
"type": "number",
"description": "Indicates the number of current instances in the AS group.\n"
},
"deleteInstances": {
"type": "string",
"description": "Whether to delete the instances in the AS group\nwhen deleting the AS group. The options are `yes` and `no`.\n"
},
"deletePublicip": {
"type": "boolean",
"description": "Whether to delete the elastic IP address bound to the\ninstances of AS group when deleting the instances. The options are `true` and `false`.\n"
},
"desireInstanceNumber": {
"type": "number",
"description": "The expected number of instances. The default\nvalue is the minimum number of instances. The value ranges from the minimum number of\ninstances to the maximum number of instances.\n"
},
"forceDelete": {
"type": "boolean",
"description": "Whether to forcibly delete the AS group, remove the ECS instances and release them.\nThe default value is `false`.\n"
},
"healthPeriodicAuditMethod": {
"type": "string",
"description": "The health check method for instances\nin the AS group. The health check methods include `ELB_AUDIT` and `NOVA_AUDIT`.\nIf load balancing is configured, the default value of this parameter is `ELB_AUDIT`.\nOtherwise, the default value is `NOVA_AUDIT`.\n"
},
"healthPeriodicAuditTime": {
"type": "number",
"description": "The health check period for instances.\nThe period has four options: 5 minutes (default), 15 minutes, 60 minutes, and 180 minutes.\n"
},
"instanceTerminatePolicy": {
"type": "string",
"description": "The instance removal policy. The policy has\nfour options: `OLD_CONFIG_OLD_INSTANCE` (default), `OLD_CONFIG_NEW_INSTANCE`,\n`OLD_INSTANCE`, and `NEW_INSTANCE`.\n"
},
"instances": {
"type": "array",
"items": {
"type": "string"
},
"description": "The instances IDs of the AS group.\n"
},
"lbListenerId": {
"type": "string",
"description": "The ELB listener IDs. The system supports up to\nsix ELB listeners, the IDs of which are separated using a comma (,).\n"
},
"lbaasListeners": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupLbaasListener:AsGroupLbaasListener"
},
"description": "An array of one or more enhanced load balancer.\nThe system supports the binding of up to six load balancers. The field is\nalternative to `lb_listener_id`. The object structure is documented below.\n"
},
"maxInstanceNumber": {
"type": "number",
"description": "The maximum number of instances.\nThe default value is 0.\n"
},
"minInstanceNumber": {
"type": "number",
"description": "The minimum number of instances.\nThe default value is 0.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupNetwork:AsGroupNetwork"
},
"description": "An array of one or more network IDs.\nThe system supports up to five networks. The networks object structure\nis documented below.\n"
},
"notifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The notification mode. The system only supports `EMAIL`\nmode which refers to notification by email.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the AS group. If\nomitted, the `region` argument of the provider is used. Changing this\ncreates a new AS group.\n"
},
"scalingConfigurationId": {
"type": "string",
"description": "The configuration ID which defines\nconfigurations of instances in the AS group.\n"
},
"scalingGroupName": {
"type": "string",
"description": "The name of the scaling group. The name can contain letters,\ndigits, underscores(_), and hyphens(-),and cannot exceed 64 characters.\n"
},
"securityGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupSecurityGroup:AsGroupSecurityGroup"
},
"description": "An array of `one` security group ID to\nassociate with the group. The security_groups object structure is\ndocumented below.\n"
},
"status": {
"type": "string",
"description": "Indicates the status of the AS group.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the scaling group.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAsGroupTimeouts:AsGroupTimeouts"
},
"vpcId": {
"type": "string",
"description": "The VPC ID. Changing this creates a new group.\n"
}
},
"type": "object",
"required": [
"asGroupId",
"currentInstanceNumber",
"desireInstanceNumber",
"instances",
"networks",
"region",
"scalingConfigurationId",
"scalingGroupName",
"securityGroups",
"status",
"vpcId"
],
"inputProperties": {
"asGroupId": {
"type": "string"
},
"availableZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The availability zones in which to create\nthe instances in the autoscaling group.\n"
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration (in seconds). The value ranges\nfrom 0 to 86400, and is 900 by default.\n"
},
"deleteInstances": {
"type": "string",
"description": "Whether to delete the instances in the AS group\nwhen deleting the AS group. The options are `yes` and `no`.\n"
},
"deletePublicip": {
"type": "boolean",
"description": "Whether to delete the elastic IP address bound to the\ninstances of AS group when deleting the instances. The options are `true` and `false`.\n"
},
"desireInstanceNumber": {
"type": "number",
"description": "The expected number of instances. The default\nvalue is the minimum number of instances. The value ranges from the minimum number of\ninstances to the maximum number of instances.\n"
},
"forceDelete": {
"type": "boolean",
"description": "Whether to forcibly delete the AS group, remove the ECS instances and release them.\nThe default value is `false`.\n"
},
"healthPeriodicAuditMethod": {
"type": "string",
"description": "The health check method for instances\nin the AS group. The health check methods include `ELB_AUDIT` and `NOVA_AUDIT`.\nIf load balancing is configured, the default value of this parameter is `ELB_AUDIT`.\nOtherwise, the default value is `NOVA_AUDIT`.\n"
},
"healthPeriodicAuditTime": {
"type": "number",
"description": "The health check period for instances.\nThe period has four options: 5 minutes (default), 15 minutes, 60 minutes, and 180 minutes.\n"
},
"instanceTerminatePolicy": {
"type": "string",
"description": "The instance removal policy. The policy has\nfour options: `OLD_CONFIG_OLD_INSTANCE` (default), `OLD_CONFIG_NEW_INSTANCE`,\n`OLD_INSTANCE`, and `NEW_INSTANCE`.\n"
},
"lbListenerId": {
"type": "string",
"description": "The ELB listener IDs. The system supports up to\nsix ELB listeners, the IDs of which are separated using a comma (,).\n"
},
"lbaasListeners": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupLbaasListener:AsGroupLbaasListener"
},
"description": "An array of one or more enhanced load balancer.\nThe system supports the binding of up to six load balancers. The field is\nalternative to `lb_listener_id`. The object structure is documented below.\n"
},
"maxInstanceNumber": {
"type": "number",
"description": "The maximum number of instances.\nThe default value is 0.\n"
},
"minInstanceNumber": {
"type": "number",
"description": "The minimum number of instances.\nThe default value is 0.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupNetwork:AsGroupNetwork"
},
"description": "An array of one or more network IDs.\nThe system supports up to five networks. The networks object structure\nis documented below.\n"
},
"notifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The notification mode. The system only supports `EMAIL`\nmode which refers to notification by email.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the AS group. If\nomitted, the `region` argument of the provider is used. Changing this\ncreates a new AS group.\n"
},
"scalingConfigurationId": {
"type": "string",
"description": "The configuration ID which defines\nconfigurations of instances in the AS group.\n"
},
"scalingGroupName": {
"type": "string",
"description": "The name of the scaling group. The name can contain letters,\ndigits, underscores(_), and hyphens(-),and cannot exceed 64 characters.\n"
},
"securityGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupSecurityGroup:AsGroupSecurityGroup"
},
"description": "An array of `one` security group ID to\nassociate with the group. The security_groups object structure is\ndocumented below.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the scaling group.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAsGroupTimeouts:AsGroupTimeouts"
},
"vpcId": {
"type": "string",
"description": "The VPC ID. Changing this creates a new group.\n"
}
},
"requiredInputs": [
"networks",
"scalingGroupName",
"securityGroups",
"vpcId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AsGroup resources.\n",
"properties": {
"asGroupId": {
"type": "string"
},
"availableZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The availability zones in which to create\nthe instances in the autoscaling group.\n"
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration (in seconds). The value ranges\nfrom 0 to 86400, and is 900 by default.\n"
},
"currentInstanceNumber": {
"type": "number",
"description": "Indicates the number of current instances in the AS group.\n"
},
"deleteInstances": {
"type": "string",
"description": "Whether to delete the instances in the AS group\nwhen deleting the AS group. The options are `yes` and `no`.\n"
},
"deletePublicip": {
"type": "boolean",
"description": "Whether to delete the elastic IP address bound to the\ninstances of AS group when deleting the instances. The options are `true` and `false`.\n"
},
"desireInstanceNumber": {
"type": "number",
"description": "The expected number of instances. The default\nvalue is the minimum number of instances. The value ranges from the minimum number of\ninstances to the maximum number of instances.\n"
},
"forceDelete": {
"type": "boolean",
"description": "Whether to forcibly delete the AS group, remove the ECS instances and release them.\nThe default value is `false`.\n"
},
"healthPeriodicAuditMethod": {
"type": "string",
"description": "The health check method for instances\nin the AS group. The health check methods include `ELB_AUDIT` and `NOVA_AUDIT`.\nIf load balancing is configured, the default value of this parameter is `ELB_AUDIT`.\nOtherwise, the default value is `NOVA_AUDIT`.\n"
},
"healthPeriodicAuditTime": {
"type": "number",
"description": "The health check period for instances.\nThe period has four options: 5 minutes (default), 15 minutes, 60 minutes, and 180 minutes.\n"
},
"instanceTerminatePolicy": {
"type": "string",
"description": "The instance removal policy. The policy has\nfour options: `OLD_CONFIG_OLD_INSTANCE` (default), `OLD_CONFIG_NEW_INSTANCE`,\n`OLD_INSTANCE`, and `NEW_INSTANCE`.\n"
},
"instances": {
"type": "array",
"items": {
"type": "string"
},
"description": "The instances IDs of the AS group.\n"
},
"lbListenerId": {
"type": "string",
"description": "The ELB listener IDs. The system supports up to\nsix ELB listeners, the IDs of which are separated using a comma (,).\n"
},
"lbaasListeners": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupLbaasListener:AsGroupLbaasListener"
},
"description": "An array of one or more enhanced load balancer.\nThe system supports the binding of up to six load balancers. The field is\nalternative to `lb_listener_id`. The object structure is documented below.\n"
},
"maxInstanceNumber": {
"type": "number",
"description": "The maximum number of instances.\nThe default value is 0.\n"
},
"minInstanceNumber": {
"type": "number",
"description": "The minimum number of instances.\nThe default value is 0.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupNetwork:AsGroupNetwork"
},
"description": "An array of one or more network IDs.\nThe system supports up to five networks. The networks object structure\nis documented below.\n"
},
"notifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The notification mode. The system only supports `EMAIL`\nmode which refers to notification by email.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the AS group. If\nomitted, the `region` argument of the provider is used. Changing this\ncreates a new AS group.\n"
},
"scalingConfigurationId": {
"type": "string",
"description": "The configuration ID which defines\nconfigurations of instances in the AS group.\n"
},
"scalingGroupName": {
"type": "string",
"description": "The name of the scaling group. The name can contain letters,\ndigits, underscores(_), and hyphens(-),and cannot exceed 64 characters.\n"
},
"securityGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupSecurityGroup:AsGroupSecurityGroup"
},
"description": "An array of `one` security group ID to\nassociate with the group. The security_groups object structure is\ndocumented below.\n"
},
"status": {
"type": "string",
"description": "Indicates the status of the AS group.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the scaling group.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAsGroupTimeouts:AsGroupTimeouts"
},
"vpcId": {
"type": "string",
"description": "The VPC ID. Changing this creates a new group.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/asGroupV1:AsGroupV1": {
"properties": {
"asGroupV1Id": {
"type": "string"
},
"availableZones": {
"type": "array",
"items": {
"type": "string"
}
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration, in seconds.\n"
},
"currentInstanceNumber": {
"type": "number"
},
"deleteInstances": {
"type": "string",
"description": "Whether to delete instances when they are removed from the AS group.\n"
},
"deletePublicip": {
"type": "boolean"
},
"desireInstanceNumber": {
"type": "number"
},
"forceDelete": {
"type": "boolean"
},
"healthPeriodicAuditMethod": {
"type": "string"
},
"healthPeriodicAuditTime": {
"type": "number",
"description": "The health check period for instances, in minutes.\n"
},
"instanceTerminatePolicy": {
"type": "string"
},
"instances": {
"type": "array",
"items": {
"type": "string"
},
"description": "The instances id list in the as group.\n"
},
"lbListenerId": {
"type": "string",
"description": "The system supports the binding of up to six ELB listeners, the IDs of which are separated using a comma.\n"
},
"lbaasListeners": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1LbaasListener:AsGroupV1LbaasListener"
}
},
"maxInstanceNumber": {
"type": "number"
},
"minInstanceNumber": {
"type": "number"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1Network:AsGroupV1Network"
}
},
"notifications": {
"type": "array",
"items": {
"type": "string"
}
},
"region": {
"type": "string"
},
"scalingConfigurationId": {
"type": "string"
},
"scalingGroupName": {
"type": "string"
},
"securityGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1SecurityGroup:AsGroupV1SecurityGroup"
}
},
"status": {
"type": "string"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1Timeouts:AsGroupV1Timeouts"
},
"vpcId": {
"type": "string"
}
},
"type": "object",
"required": [
"asGroupV1Id",
"currentInstanceNumber",
"desireInstanceNumber",
"instances",
"networks",
"region",
"scalingConfigurationId",
"scalingGroupName",
"securityGroups",
"status",
"vpcId"
],
"inputProperties": {
"asGroupV1Id": {
"type": "string"
},
"availableZones": {
"type": "array",
"items": {
"type": "string"
}
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration, in seconds.\n"
},
"deleteInstances": {
"type": "string",
"description": "Whether to delete instances when they are removed from the AS group.\n"
},
"deletePublicip": {
"type": "boolean"
},
"desireInstanceNumber": {
"type": "number"
},
"forceDelete": {
"type": "boolean"
},
"healthPeriodicAuditMethod": {
"type": "string"
},
"healthPeriodicAuditTime": {
"type": "number",
"description": "The health check period for instances, in minutes.\n"
},
"instanceTerminatePolicy": {
"type": "string"
},
"lbListenerId": {
"type": "string",
"description": "The system supports the binding of up to six ELB listeners, the IDs of which are separated using a comma.\n"
},
"lbaasListeners": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1LbaasListener:AsGroupV1LbaasListener"
}
},
"maxInstanceNumber": {
"type": "number"
},
"minInstanceNumber": {
"type": "number"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1Network:AsGroupV1Network"
}
},
"notifications": {
"type": "array",
"items": {
"type": "string"
}
},
"region": {
"type": "string"
},
"scalingConfigurationId": {
"type": "string"
},
"scalingGroupName": {
"type": "string"
},
"securityGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1SecurityGroup:AsGroupV1SecurityGroup"
}
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1Timeouts:AsGroupV1Timeouts"
},
"vpcId": {
"type": "string"
}
},
"requiredInputs": [
"networks",
"scalingGroupName",
"securityGroups",
"vpcId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AsGroupV1 resources.\n",
"properties": {
"asGroupV1Id": {
"type": "string"
},
"availableZones": {
"type": "array",
"items": {
"type": "string"
}
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration, in seconds.\n"
},
"currentInstanceNumber": {
"type": "number"
},
"deleteInstances": {
"type": "string",
"description": "Whether to delete instances when they are removed from the AS group.\n"
},
"deletePublicip": {
"type": "boolean"
},
"desireInstanceNumber": {
"type": "number"
},
"forceDelete": {
"type": "boolean"
},
"healthPeriodicAuditMethod": {
"type": "string"
},
"healthPeriodicAuditTime": {
"type": "number",
"description": "The health check period for instances, in minutes.\n"
},
"instanceTerminatePolicy": {
"type": "string"
},
"instances": {
"type": "array",
"items": {
"type": "string"
},
"description": "The instances id list in the as group.\n"
},
"lbListenerId": {
"type": "string",
"description": "The system supports the binding of up to six ELB listeners, the IDs of which are separated using a comma.\n"
},
"lbaasListeners": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1LbaasListener:AsGroupV1LbaasListener"
}
},
"maxInstanceNumber": {
"type": "number"
},
"minInstanceNumber": {
"type": "number"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1Network:AsGroupV1Network"
}
},
"notifications": {
"type": "array",
"items": {
"type": "string"
}
},
"region": {
"type": "string"
},
"scalingConfigurationId": {
"type": "string"
},
"scalingGroupName": {
"type": "string"
},
"securityGroups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1SecurityGroup:AsGroupV1SecurityGroup"
}
},
"status": {
"type": "string"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAsGroupV1Timeouts:AsGroupV1Timeouts"
},
"vpcId": {
"type": "string"
}
},
"type": "object"
}
},
"flexibleengine:index/asInstanceAttach:AsInstanceAttach": {
"description": "Manages an AS instance attachment resource within FlexibleEngine.\n\n## Example Usage\n\n### Add an instance\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst scalingGroupId = config.requireObject(\"scalingGroupId\");\nconst ecsId = config.requireObject(\"ecsId\");\nconst test = new flexibleengine.AsInstanceAttach(\"test\", {\n scalingGroupId: scalingGroupId,\n instanceId: ecsId,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nscaling_group_id = config.require_object(\"scalingGroupId\")\necs_id = config.require_object(\"ecsId\")\ntest = flexibleengine.AsInstanceAttach(\"test\",\n scaling_group_id=scaling_group_id,\n instance_id=ecs_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var scalingGroupId = config.RequireObject(\"scalingGroupId\");\n var ecsId = config.RequireObject(\"ecsId\");\n var test = new Flexibleengine.AsInstanceAttach(\"test\", new()\n {\n ScalingGroupId = scalingGroupId,\n InstanceId = ecsId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tscalingGroupId := cfg.RequireObject(\"scalingGroupId\")\n\t\tecsId := cfg.RequireObject(\"ecsId\")\n\t\t_, err := flexibleengine.NewAsInstanceAttach(ctx, \"test\", &flexibleengine.AsInstanceAttachArgs{\n\t\t\tScalingGroupId: pulumi.Any(scalingGroupId),\n\t\t\tInstanceId: pulumi.Any(ecsId),\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.flexibleengine.AsInstanceAttach;\nimport com.pulumi.flexibleengine.AsInstanceAttachArgs;\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 final var config = ctx.config();\n final var scalingGroupId = config.get(\"scalingGroupId\");\n final var ecsId = config.get(\"ecsId\");\n var test = new AsInstanceAttach(\"test\", AsInstanceAttachArgs.builder()\n .scalingGroupId(scalingGroupId)\n .instanceId(ecsId)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n scalingGroupId:\n type: dynamic\n ecsId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:AsInstanceAttach\n properties:\n scalingGroupId: ${scalingGroupId}\n instanceId: ${ecsId}\n```\n\n\n### Add an instance with protection\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst scalingGroupId = config.requireObject(\"scalingGroupId\");\nconst ecsId = config.requireObject(\"ecsId\");\nconst test = new flexibleengine.AsInstanceAttach(\"test\", {\n scalingGroupId: scalingGroupId,\n instanceId: ecsId,\n \"protected\": true,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nscaling_group_id = config.require_object(\"scalingGroupId\")\necs_id = config.require_object(\"ecsId\")\ntest = flexibleengine.AsInstanceAttach(\"test\",\n scaling_group_id=scaling_group_id,\n instance_id=ecs_id,\n protected=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var scalingGroupId = config.RequireObject(\"scalingGroupId\");\n var ecsId = config.RequireObject(\"ecsId\");\n var test = new Flexibleengine.AsInstanceAttach(\"test\", new()\n {\n ScalingGroupId = scalingGroupId,\n InstanceId = ecsId,\n Protected = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tscalingGroupId := cfg.RequireObject(\"scalingGroupId\")\n\t\tecsId := cfg.RequireObject(\"ecsId\")\n\t\t_, err := flexibleengine.NewAsInstanceAttach(ctx, \"test\", &flexibleengine.AsInstanceAttachArgs{\n\t\t\tScalingGroupId: pulumi.Any(scalingGroupId),\n\t\t\tInstanceId: pulumi.Any(ecsId),\n\t\t\tProtected: 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.pulumi.flexibleengine.AsInstanceAttach;\nimport com.pulumi.flexibleengine.AsInstanceAttachArgs;\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 final var config = ctx.config();\n final var scalingGroupId = config.get(\"scalingGroupId\");\n final var ecsId = config.get(\"ecsId\");\n var test = new AsInstanceAttach(\"test\", AsInstanceAttachArgs.builder()\n .scalingGroupId(scalingGroupId)\n .instanceId(ecsId)\n .protected_(true)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n scalingGroupId:\n type: dynamic\n ecsId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:AsInstanceAttach\n properties:\n scalingGroupId: ${scalingGroupId}\n instanceId: ${ecsId}\n protected: true\n```\n\n\n## Import\n\nThe AS instances can be imported by the `scaling_group_id` and `instance_id`, separated by a slash, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/asInstanceAttach:AsInstanceAttach test /\n```\n\nNote that the imported state may not be identical to your resource definition, due to `append_instance` is missing from\n\nthe API response.\n\nIt is generally recommended running `pulumi preview` after importing the resource.\n\nYou can then decide if changes should be applied to the resource, or the resource definition should be updated to\n\nalign with the resource. Also you can ignore changes as below.\n\nhcl\n\nresource \"flexibleengine_as_instance_attach\" \"test\" {\n\n ...\n\n lifecycle {\n\n ignore_changes = [append_instance]\n\n }\n\n}\n\n",
"properties": {
"appendInstance": {
"type": "boolean",
"description": "Specifies whether to add a new instance when the instance enter standby mode.\nThis parameter takes effect only when `standby` is set to true.\n"
},
"asInstanceAttachId": {
"type": "string",
"description": "The resource ID in format of `scaling_group_id`/`instance_id`.\n"
},
"healthStatus": {
"type": "string",
"description": "The instance health status. The value can be `INITIALIZING`, `NORMAL` or `ERROR`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ECS instance ID.\nChanging this creates a new resource.\n\n\n> Before adding instances to an AS group, ensure that the following conditions are met:\n
1. The instance is not in other AS groups.\n
2. The instance is in the same VPC as the AS group.\n
3. The instance is in the AZs used by the AS group.\n
4. After the instance is added, the total number of instances is less than or equal to the maximum number of\ninstances allowed.\n"
},
"instanceName": {
"type": "string",
"description": "The ECS instance name.\n"
},
"protected": {
"type": "boolean",
"description": "Specifies whether the instance can be removed **automatically** from the AS group.\nOnce configured, when AS automatically scales in the AS group, the instance that is protected will not be removed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the resource.\nIf omitted, the provider-level region will be used. Changing this creates a new resource.\n"
},
"scalingGroupId": {
"type": "string",
"description": "Specifies the AS group ID.\nChanging this creates a new resource.\n"
},
"standby": {
"type": "boolean",
"description": "Specifies whether to stop distributing traffic to the instance but do not want to remove\nit from the AS group. You can stop or restart the instance without worrying about it will be removed from the AS group.\n"
},
"status": {
"type": "string",
"description": "The instance lifecycle status in the AS group. The value can be `INSERVICE`, `STANDBY`, `PENDING` or `REMOVING`.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAsInstanceAttachTimeouts:AsInstanceAttachTimeouts"
}
},
"type": "object",
"required": [
"asInstanceAttachId",
"healthStatus",
"instanceId",
"instanceName",
"protected",
"region",
"scalingGroupId",
"standby",
"status"
],
"inputProperties": {
"appendInstance": {
"type": "boolean",
"description": "Specifies whether to add a new instance when the instance enter standby mode.\nThis parameter takes effect only when `standby` is set to true.\n"
},
"asInstanceAttachId": {
"type": "string",
"description": "The resource ID in format of `scaling_group_id`/`instance_id`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ECS instance ID.\nChanging this creates a new resource.\n\n\n> Before adding instances to an AS group, ensure that the following conditions are met:\n
1. The instance is not in other AS groups.\n
2. The instance is in the same VPC as the AS group.\n
3. The instance is in the AZs used by the AS group.\n
4. After the instance is added, the total number of instances is less than or equal to the maximum number of\ninstances allowed.\n"
},
"protected": {
"type": "boolean",
"description": "Specifies whether the instance can be removed **automatically** from the AS group.\nOnce configured, when AS automatically scales in the AS group, the instance that is protected will not be removed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the resource.\nIf omitted, the provider-level region will be used. Changing this creates a new resource.\n"
},
"scalingGroupId": {
"type": "string",
"description": "Specifies the AS group ID.\nChanging this creates a new resource.\n"
},
"standby": {
"type": "boolean",
"description": "Specifies whether to stop distributing traffic to the instance but do not want to remove\nit from the AS group. You can stop or restart the instance without worrying about it will be removed from the AS group.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAsInstanceAttachTimeouts:AsInstanceAttachTimeouts"
}
},
"requiredInputs": [
"instanceId",
"scalingGroupId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AsInstanceAttach resources.\n",
"properties": {
"appendInstance": {
"type": "boolean",
"description": "Specifies whether to add a new instance when the instance enter standby mode.\nThis parameter takes effect only when `standby` is set to true.\n"
},
"asInstanceAttachId": {
"type": "string",
"description": "The resource ID in format of `scaling_group_id`/`instance_id`.\n"
},
"healthStatus": {
"type": "string",
"description": "The instance health status. The value can be `INITIALIZING`, `NORMAL` or `ERROR`.\n"
},
"instanceId": {
"type": "string",
"description": "Specifies the ECS instance ID.\nChanging this creates a new resource.\n\n\n> Before adding instances to an AS group, ensure that the following conditions are met:\n
1. The instance is not in other AS groups.\n
2. The instance is in the same VPC as the AS group.\n
3. The instance is in the AZs used by the AS group.\n
4. After the instance is added, the total number of instances is less than or equal to the maximum number of\ninstances allowed.\n"
},
"instanceName": {
"type": "string",
"description": "The ECS instance name.\n"
},
"protected": {
"type": "boolean",
"description": "Specifies whether the instance can be removed **automatically** from the AS group.\nOnce configured, when AS automatically scales in the AS group, the instance that is protected will not be removed.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the resource.\nIf omitted, the provider-level region will be used. Changing this creates a new resource.\n"
},
"scalingGroupId": {
"type": "string",
"description": "Specifies the AS group ID.\nChanging this creates a new resource.\n"
},
"standby": {
"type": "boolean",
"description": "Specifies whether to stop distributing traffic to the instance but do not want to remove\nit from the AS group. You can stop or restart the instance without worrying about it will be removed from the AS group.\n"
},
"status": {
"type": "string",
"description": "The instance lifecycle status in the AS group. The value can be `INSERVICE`, `STANDBY`, `PENDING` or `REMOVING`.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FAsInstanceAttachTimeouts:AsInstanceAttachTimeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/asLifecycleHookV1:AsLifecycleHookV1": {
"description": "Manages an AS Lifecycle Hook resource within FlexibleEngine.\n\n## Example Usage\n\n### Basic Lifecycle Hook\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst hookName = config.requireObject(\"hookName\");\nconst asGroupId = config.requireObject(\"asGroupId\");\nconst smnTopicUrn = config.requireObject(\"smnTopicUrn\");\nconst test = new flexibleengine.AsLifecycleHookV1(\"test\", {\n scalingGroupId: asGroupId,\n type: \"ADD\",\n defaultResult: \"ABANDON\",\n notificationTopicUrn: smnTopicUrn,\n notificationMessage: \"This is a test message\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nhook_name = config.require_object(\"hookName\")\nas_group_id = config.require_object(\"asGroupId\")\nsmn_topic_urn = config.require_object(\"smnTopicUrn\")\ntest = flexibleengine.AsLifecycleHookV1(\"test\",\n scaling_group_id=as_group_id,\n type=\"ADD\",\n default_result=\"ABANDON\",\n notification_topic_urn=smn_topic_urn,\n notification_message=\"This is a test message\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var hookName = config.RequireObject(\"hookName\");\n var asGroupId = config.RequireObject(\"asGroupId\");\n var smnTopicUrn = config.RequireObject(\"smnTopicUrn\");\n var test = new Flexibleengine.AsLifecycleHookV1(\"test\", new()\n {\n ScalingGroupId = asGroupId,\n Type = \"ADD\",\n DefaultResult = \"ABANDON\",\n NotificationTopicUrn = smnTopicUrn,\n NotificationMessage = \"This is a test message\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\thookName := cfg.RequireObject(\"hookName\")\n\t\tasGroupId := cfg.RequireObject(\"asGroupId\")\n\t\tsmnTopicUrn := cfg.RequireObject(\"smnTopicUrn\")\n\t\t_, err := flexibleengine.NewAsLifecycleHookV1(ctx, \"test\", &flexibleengine.AsLifecycleHookV1Args{\n\t\t\tScalingGroupId: pulumi.Any(asGroupId),\n\t\t\tType: pulumi.String(\"ADD\"),\n\t\t\tDefaultResult: pulumi.String(\"ABANDON\"),\n\t\t\tNotificationTopicUrn: pulumi.Any(smnTopicUrn),\n\t\t\tNotificationMessage: pulumi.String(\"This is a test message\"),\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.flexibleengine.AsLifecycleHookV1;\nimport com.pulumi.flexibleengine.AsLifecycleHookV1Args;\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 final var config = ctx.config();\n final var hookName = config.get(\"hookName\");\n final var asGroupId = config.get(\"asGroupId\");\n final var smnTopicUrn = config.get(\"smnTopicUrn\");\n var test = new AsLifecycleHookV1(\"test\", AsLifecycleHookV1Args.builder()\n .scalingGroupId(asGroupId)\n .type(\"ADD\")\n .defaultResult(\"ABANDON\")\n .notificationTopicUrn(smnTopicUrn)\n .notificationMessage(\"This is a test message\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n hookName:\n type: dynamic\n asGroupId:\n type: dynamic\n smnTopicUrn:\n type: dynamic\nresources:\n test:\n type: flexibleengine:AsLifecycleHookV1\n properties:\n scalingGroupId: ${asGroupId}\n type: ADD\n defaultResult: ABANDON\n notificationTopicUrn: ${smnTopicUrn}\n notificationMessage: This is a test message\n```\n\n\n## Import\n\nLifecycle hooks can be imported using the Auto Scalling group ID `scaling_group_id` and hook Name `name` separated by a\n\nslash `/`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/asLifecycleHookV1:AsLifecycleHookV1 test /\n```\n\n",
"properties": {
"asLifecycleHookV1Id": {
"type": "string",
"description": "The resource ID.\n"
},
"createTime": {
"type": "string",
"description": "The server time in UTC format when the lifecycle hook is created.\n"
},
"defaultResult": {
"type": "string",
"description": "Specifies the default lifecycle hook callback operation.\nThis operation is performed when the timeout duration expires.\nThe valid values are *ABANDON* and *CONTINUE*, default to *ABANDON*.\n"
},
"name": {
"type": "string",
"description": "Specifies the lifecycle hook name.\nThis parameter can contain a maximum of 32 characters, which may consist of letters, digits,\nunderscores (_) and hyphens (-). Changing this creates a new AS configuration.\n"
},
"notificationMessage": {
"type": "string",
"description": "Specifies a customized notification.\nThis parameter can contains a maximum of 256 characters, which cannot contain the following characters: <>&'().\n"
},
"notificationTopicName": {
"type": "string",
"description": "The topic name in SMN.\n"
},
"notificationTopicUrn": {
"type": "string",
"description": "Specifies a unique topic in SMN.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the AS lifecycle hook.\nIf omitted, the provider-level region will be used. Changing this creates a new AS lifecycle hook.\n"
},
"scalingGroupId": {
"type": "string",
"description": "Specifies the ID of the AS group in UUID format.\nChanging this creates a new AS lifecycle hook.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the lifecycle hook timeout duration, which ranges from 300 to 86400 in the\nunit of second, default to 3600.\n"
},
"type": {
"type": "string",
"description": "Specifies the lifecycle hook type.\nThe valid values are following strings:\n+ `ADD`: The hook suspends the instance when the instance is started.\n+ `REMOVE`: The hook suspends the instance when the instance is terminated.\n"
}
},
"type": "object",
"required": [
"asLifecycleHookV1Id",
"createTime",
"name",
"notificationTopicName",
"notificationTopicUrn",
"region",
"scalingGroupId",
"type"
],
"inputProperties": {
"asLifecycleHookV1Id": {
"type": "string",
"description": "The resource ID.\n"
},
"defaultResult": {
"type": "string",
"description": "Specifies the default lifecycle hook callback operation.\nThis operation is performed when the timeout duration expires.\nThe valid values are *ABANDON* and *CONTINUE*, default to *ABANDON*.\n"
},
"name": {
"type": "string",
"description": "Specifies the lifecycle hook name.\nThis parameter can contain a maximum of 32 characters, which may consist of letters, digits,\nunderscores (_) and hyphens (-). Changing this creates a new AS configuration.\n"
},
"notificationMessage": {
"type": "string",
"description": "Specifies a customized notification.\nThis parameter can contains a maximum of 256 characters, which cannot contain the following characters: <>&'().\n"
},
"notificationTopicUrn": {
"type": "string",
"description": "Specifies a unique topic in SMN.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the AS lifecycle hook.\nIf omitted, the provider-level region will be used. Changing this creates a new AS lifecycle hook.\n"
},
"scalingGroupId": {
"type": "string",
"description": "Specifies the ID of the AS group in UUID format.\nChanging this creates a new AS lifecycle hook.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the lifecycle hook timeout duration, which ranges from 300 to 86400 in the\nunit of second, default to 3600.\n"
},
"type": {
"type": "string",
"description": "Specifies the lifecycle hook type.\nThe valid values are following strings:\n+ `ADD`: The hook suspends the instance when the instance is started.\n+ `REMOVE`: The hook suspends the instance when the instance is terminated.\n"
}
},
"requiredInputs": [
"notificationTopicUrn",
"scalingGroupId",
"type"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AsLifecycleHookV1 resources.\n",
"properties": {
"asLifecycleHookV1Id": {
"type": "string",
"description": "The resource ID.\n"
},
"createTime": {
"type": "string",
"description": "The server time in UTC format when the lifecycle hook is created.\n"
},
"defaultResult": {
"type": "string",
"description": "Specifies the default lifecycle hook callback operation.\nThis operation is performed when the timeout duration expires.\nThe valid values are *ABANDON* and *CONTINUE*, default to *ABANDON*.\n"
},
"name": {
"type": "string",
"description": "Specifies the lifecycle hook name.\nThis parameter can contain a maximum of 32 characters, which may consist of letters, digits,\nunderscores (_) and hyphens (-). Changing this creates a new AS configuration.\n"
},
"notificationMessage": {
"type": "string",
"description": "Specifies a customized notification.\nThis parameter can contains a maximum of 256 characters, which cannot contain the following characters: <>&'().\n"
},
"notificationTopicName": {
"type": "string",
"description": "The topic name in SMN.\n"
},
"notificationTopicUrn": {
"type": "string",
"description": "Specifies a unique topic in SMN.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the AS lifecycle hook.\nIf omitted, the provider-level region will be used. Changing this creates a new AS lifecycle hook.\n"
},
"scalingGroupId": {
"type": "string",
"description": "Specifies the ID of the AS group in UUID format.\nChanging this creates a new AS lifecycle hook.\n"
},
"timeout": {
"type": "number",
"description": "Specifies the lifecycle hook timeout duration, which ranges from 300 to 86400 in the\nunit of second, default to 3600.\n"
},
"type": {
"type": "string",
"description": "Specifies the lifecycle hook type.\nThe valid values are following strings:\n+ `ADD`: The hook suspends the instance when the instance is started.\n+ `REMOVE`: The hook suspends the instance when the instance is terminated.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/asNotification:AsNotification": {
"description": "Manages an AS notification resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst scalingGroupId = config.requireObject(\"scalingGroupId\");\nconst topicUrn = config.requireObject(\"topicUrn\");\nconst events = config.requireObject>(\"events\");\nconst test = new flexibleengine.AsNotification(\"test\", {\n scalingGroupId: scalingGroupId,\n topicUrn: topicUrn,\n events: events,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nscaling_group_id = config.require_object(\"scalingGroupId\")\ntopic_urn = config.require_object(\"topicUrn\")\nevents = config.require_object(\"events\")\ntest = flexibleengine.AsNotification(\"test\",\n scaling_group_id=scaling_group_id,\n topic_urn=topic_urn,\n events=events)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var scalingGroupId = config.RequireObject(\"scalingGroupId\");\n var topicUrn = config.RequireObject(\"topicUrn\");\n var events = config.RequireObject(\"events\");\n var test = new Flexibleengine.AsNotification(\"test\", new()\n {\n ScalingGroupId = scalingGroupId,\n TopicUrn = topicUrn,\n Events = events,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tscalingGroupId := cfg.RequireObject(\"scalingGroupId\")\n\t\ttopicUrn := cfg.RequireObject(\"topicUrn\")\n\t\tevents := cfg.Require(\"events\")\n\t\t_, err := flexibleengine.NewAsNotification(ctx, \"test\", &flexibleengine.AsNotificationArgs{\n\t\t\tScalingGroupId: pulumi.Any(scalingGroupId),\n\t\t\tTopicUrn: pulumi.Any(topicUrn),\n\t\t\tEvents: events,\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.flexibleengine.AsNotification;\nimport com.pulumi.flexibleengine.AsNotificationArgs;\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 final var config = ctx.config();\n final var scalingGroupId = config.get(\"scalingGroupId\");\n final var topicUrn = config.get(\"topicUrn\");\n final var events = config.get(\"events\");\n var test = new AsNotification(\"test\", AsNotificationArgs.builder()\n .scalingGroupId(scalingGroupId)\n .topicUrn(topicUrn)\n .events(events)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n scalingGroupId:\n type: dynamic\n topicUrn:\n type: dynamic\n events:\n type: list(string)\nresources:\n test:\n type: flexibleengine:AsNotification\n properties:\n scalingGroupId: ${scalingGroupId}\n topicUrn: ${topicUrn}\n events: ${events}\n```\n\n\n## Import\n\nThe as notification can be imported using `scaling_group_id`, `topic_urn`, separated by a slash, e.g.\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/asNotification:AsNotification test /\n```\n\n",
"properties": {
"asNotificationId": {
"type": "string",
"description": "The unique topic URN in SMN.\n"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the topic scene of AS group. The events include `SCALING_UP`,\n`SCALING_UP_FAIL`, `SCALING_DOWN`, `SCALING_DOWN_FAIL`, `SCALING_GROUP_ABNORMAL`.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the resource.\nIf omitted, the provider-level region will be used. Changing this creates a new resource.\n"
},
"scalingGroupId": {
"type": "string",
"description": "Specifies the AS group ID.\nChanging this creates a new AS notification.\n"
},
"topicName": {
"type": "string",
"description": "The topic name in SMN.\n"
},
"topicUrn": {
"type": "string",
"description": "Specifies the unique topic URN of the SMN.\nChanging this creates a new AS notification.\n"
}
},
"type": "object",
"required": [
"asNotificationId",
"events",
"region",
"scalingGroupId",
"topicName",
"topicUrn"
],
"inputProperties": {
"asNotificationId": {
"type": "string",
"description": "The unique topic URN in SMN.\n"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the topic scene of AS group. The events include `SCALING_UP`,\n`SCALING_UP_FAIL`, `SCALING_DOWN`, `SCALING_DOWN_FAIL`, `SCALING_GROUP_ABNORMAL`.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the resource.\nIf omitted, the provider-level region will be used. Changing this creates a new resource.\n"
},
"scalingGroupId": {
"type": "string",
"description": "Specifies the AS group ID.\nChanging this creates a new AS notification.\n"
},
"topicUrn": {
"type": "string",
"description": "Specifies the unique topic URN of the SMN.\nChanging this creates a new AS notification.\n"
}
},
"requiredInputs": [
"events",
"scalingGroupId",
"topicUrn"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AsNotification resources.\n",
"properties": {
"asNotificationId": {
"type": "string",
"description": "The unique topic URN in SMN.\n"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the topic scene of AS group. The events include `SCALING_UP`,\n`SCALING_UP_FAIL`, `SCALING_DOWN`, `SCALING_DOWN_FAIL`, `SCALING_GROUP_ABNORMAL`.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the resource.\nIf omitted, the provider-level region will be used. Changing this creates a new resource.\n"
},
"scalingGroupId": {
"type": "string",
"description": "Specifies the AS group ID.\nChanging this creates a new AS notification.\n"
},
"topicName": {
"type": "string",
"description": "The topic name in SMN.\n"
},
"topicUrn": {
"type": "string",
"description": "Specifies the unique topic URN of the SMN.\nChanging this creates a new AS notification.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/asPolicyV1:AsPolicyV1": {
"description": "Manages a V1 AS Policy resource within flexibleengine.\n\n## Example Usage\n\n### AS Recurrence Policy\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst hthAspolicy = new flexibleengine.AsPolicyV1(\"hthAspolicy\", {\n coolDownTime: 900,\n scalingGroupId: \"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n scalingPolicyAction: {\n instanceNumber: 1,\n operation: \"ADD\",\n },\n scalingPolicyName: \"hth_aspolicy\",\n scalingPolicyType: \"RECURRENCE\",\n scheduledPolicy: {\n endTime: \"2017-12-30T12:00Z\",\n launchTime: \"07:00\",\n recurrenceType: \"Daily\",\n startTime: \"2017-11-30T12:00Z\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nhth_aspolicy = flexibleengine.AsPolicyV1(\"hthAspolicy\",\n cool_down_time=900,\n scaling_group_id=\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n scaling_policy_action={\n \"instance_number\": 1,\n \"operation\": \"ADD\",\n },\n scaling_policy_name=\"hth_aspolicy\",\n scaling_policy_type=\"RECURRENCE\",\n scheduled_policy={\n \"end_time\": \"2017-12-30T12:00Z\",\n \"launch_time\": \"07:00\",\n \"recurrence_type\": \"Daily\",\n \"start_time\": \"2017-11-30T12:00Z\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var hthAspolicy = new Flexibleengine.AsPolicyV1(\"hthAspolicy\", new()\n {\n CoolDownTime = 900,\n ScalingGroupId = \"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n ScalingPolicyAction = new Flexibleengine.Inputs.AsPolicyV1ScalingPolicyActionArgs\n {\n InstanceNumber = 1,\n Operation = \"ADD\",\n },\n ScalingPolicyName = \"hth_aspolicy\",\n ScalingPolicyType = \"RECURRENCE\",\n ScheduledPolicy = new Flexibleengine.Inputs.AsPolicyV1ScheduledPolicyArgs\n {\n EndTime = \"2017-12-30T12:00Z\",\n LaunchTime = \"07:00\",\n RecurrenceType = \"Daily\",\n StartTime = \"2017-11-30T12:00Z\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewAsPolicyV1(ctx, \"hthAspolicy\", &flexibleengine.AsPolicyV1Args{\n\t\t\tCoolDownTime: pulumi.Float64(900),\n\t\t\tScalingGroupId: pulumi.String(\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\"),\n\t\t\tScalingPolicyAction: &flexibleengine.AsPolicyV1ScalingPolicyActionArgs{\n\t\t\t\tInstanceNumber: pulumi.Float64(1),\n\t\t\t\tOperation: pulumi.String(\"ADD\"),\n\t\t\t},\n\t\t\tScalingPolicyName: pulumi.String(\"hth_aspolicy\"),\n\t\t\tScalingPolicyType: pulumi.String(\"RECURRENCE\"),\n\t\t\tScheduledPolicy: &flexibleengine.AsPolicyV1ScheduledPolicyArgs{\n\t\t\t\tEndTime: pulumi.String(\"2017-12-30T12:00Z\"),\n\t\t\t\tLaunchTime: pulumi.String(\"07:00\"),\n\t\t\t\tRecurrenceType: pulumi.String(\"Daily\"),\n\t\t\t\tStartTime: pulumi.String(\"2017-11-30T12:00Z\"),\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.flexibleengine.AsPolicyV1;\nimport com.pulumi.flexibleengine.AsPolicyV1Args;\nimport com.pulumi.flexibleengine.inputs.AsPolicyV1ScalingPolicyActionArgs;\nimport com.pulumi.flexibleengine.inputs.AsPolicyV1ScheduledPolicyArgs;\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 hthAspolicy = new AsPolicyV1(\"hthAspolicy\", AsPolicyV1Args.builder()\n .coolDownTime(900)\n .scalingGroupId(\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\")\n .scalingPolicyAction(AsPolicyV1ScalingPolicyActionArgs.builder()\n .instanceNumber(1)\n .operation(\"ADD\")\n .build())\n .scalingPolicyName(\"hth_aspolicy\")\n .scalingPolicyType(\"RECURRENCE\")\n .scheduledPolicy(AsPolicyV1ScheduledPolicyArgs.builder()\n .endTime(\"2017-12-30T12:00Z\")\n .launchTime(\"07:00\")\n .recurrenceType(\"Daily\")\n .startTime(\"2017-11-30T12:00Z\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n hthAspolicy:\n type: flexibleengine:AsPolicyV1\n properties:\n coolDownTime: 900\n scalingGroupId: 4579f2f5-cbe8-425a-8f32-53dcb9d9053a\n scalingPolicyAction:\n instanceNumber: 1\n operation: ADD\n scalingPolicyName: hth_aspolicy\n scalingPolicyType: RECURRENCE\n scheduledPolicy:\n endTime: 2017-12-30T12:00Z\n launchTime: 07:00\n recurrenceType: Daily\n startTime: 2017-11-30T12:00Z\n```\n\n\n### AS Scheduled Policy\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst hthAspolicy1 = new flexibleengine.AsPolicyV1(\"hthAspolicy1\", {\n coolDownTime: 900,\n scalingGroupId: \"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n scalingPolicyAction: {\n instanceNumber: 1,\n operation: \"REMOVE\",\n },\n scalingPolicyName: \"hth_aspolicy_1\",\n scalingPolicyType: \"SCHEDULED\",\n scheduledPolicy: {\n launchTime: \"2017-12-22T12:00Z\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nhth_aspolicy1 = flexibleengine.AsPolicyV1(\"hthAspolicy1\",\n cool_down_time=900,\n scaling_group_id=\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n scaling_policy_action={\n \"instance_number\": 1,\n \"operation\": \"REMOVE\",\n },\n scaling_policy_name=\"hth_aspolicy_1\",\n scaling_policy_type=\"SCHEDULED\",\n scheduled_policy={\n \"launch_time\": \"2017-12-22T12:00Z\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var hthAspolicy1 = new Flexibleengine.AsPolicyV1(\"hthAspolicy1\", new()\n {\n CoolDownTime = 900,\n ScalingGroupId = \"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n ScalingPolicyAction = new Flexibleengine.Inputs.AsPolicyV1ScalingPolicyActionArgs\n {\n InstanceNumber = 1,\n Operation = \"REMOVE\",\n },\n ScalingPolicyName = \"hth_aspolicy_1\",\n ScalingPolicyType = \"SCHEDULED\",\n ScheduledPolicy = new Flexibleengine.Inputs.AsPolicyV1ScheduledPolicyArgs\n {\n LaunchTime = \"2017-12-22T12:00Z\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewAsPolicyV1(ctx, \"hthAspolicy1\", &flexibleengine.AsPolicyV1Args{\n\t\t\tCoolDownTime: pulumi.Float64(900),\n\t\t\tScalingGroupId: pulumi.String(\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\"),\n\t\t\tScalingPolicyAction: &flexibleengine.AsPolicyV1ScalingPolicyActionArgs{\n\t\t\t\tInstanceNumber: pulumi.Float64(1),\n\t\t\t\tOperation: pulumi.String(\"REMOVE\"),\n\t\t\t},\n\t\t\tScalingPolicyName: pulumi.String(\"hth_aspolicy_1\"),\n\t\t\tScalingPolicyType: pulumi.String(\"SCHEDULED\"),\n\t\t\tScheduledPolicy: &flexibleengine.AsPolicyV1ScheduledPolicyArgs{\n\t\t\t\tLaunchTime: pulumi.String(\"2017-12-22T12:00Z\"),\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.flexibleengine.AsPolicyV1;\nimport com.pulumi.flexibleengine.AsPolicyV1Args;\nimport com.pulumi.flexibleengine.inputs.AsPolicyV1ScalingPolicyActionArgs;\nimport com.pulumi.flexibleengine.inputs.AsPolicyV1ScheduledPolicyArgs;\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 hthAspolicy1 = new AsPolicyV1(\"hthAspolicy1\", AsPolicyV1Args.builder()\n .coolDownTime(900)\n .scalingGroupId(\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\")\n .scalingPolicyAction(AsPolicyV1ScalingPolicyActionArgs.builder()\n .instanceNumber(1)\n .operation(\"REMOVE\")\n .build())\n .scalingPolicyName(\"hth_aspolicy_1\")\n .scalingPolicyType(\"SCHEDULED\")\n .scheduledPolicy(AsPolicyV1ScheduledPolicyArgs.builder()\n .launchTime(\"2017-12-22T12:00Z\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n hthAspolicy1:\n type: flexibleengine:AsPolicyV1\n properties:\n coolDownTime: 900\n scalingGroupId: 4579f2f5-cbe8-425a-8f32-53dcb9d9053a\n scalingPolicyAction:\n instanceNumber: 1\n operation: REMOVE\n scalingPolicyName: hth_aspolicy_1\n scalingPolicyType: SCHEDULED\n scheduledPolicy:\n launchTime: 2017-12-22T12:00Z\n```\n\n\nPlease note that the `launch_time` of the `SCHEDULED` policy cannot be earlier than the current time.\n\n### AS Alarm Policy\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst hthAspolicy2 = new flexibleengine.AsPolicyV1(\"hthAspolicy2\", {\n alarmId: \"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n coolDownTime: 900,\n scalingGroupId: \"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n scalingPolicyAction: {\n instanceNumber: 1,\n operation: \"ADD\",\n },\n scalingPolicyName: \"hth_aspolicy_2\",\n scalingPolicyType: \"ALARM\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nhth_aspolicy2 = flexibleengine.AsPolicyV1(\"hthAspolicy2\",\n alarm_id=\"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n cool_down_time=900,\n scaling_group_id=\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n scaling_policy_action={\n \"instance_number\": 1,\n \"operation\": \"ADD\",\n },\n scaling_policy_name=\"hth_aspolicy_2\",\n scaling_policy_type=\"ALARM\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var hthAspolicy2 = new Flexibleengine.AsPolicyV1(\"hthAspolicy2\", new()\n {\n AlarmId = \"37e310f5-db9d-446e-9135-c625f9c2bbfc\",\n CoolDownTime = 900,\n ScalingGroupId = \"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\",\n ScalingPolicyAction = new Flexibleengine.Inputs.AsPolicyV1ScalingPolicyActionArgs\n {\n InstanceNumber = 1,\n Operation = \"ADD\",\n },\n ScalingPolicyName = \"hth_aspolicy_2\",\n ScalingPolicyType = \"ALARM\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewAsPolicyV1(ctx, \"hthAspolicy2\", &flexibleengine.AsPolicyV1Args{\n\t\t\tAlarmId: pulumi.String(\"37e310f5-db9d-446e-9135-c625f9c2bbfc\"),\n\t\t\tCoolDownTime: pulumi.Float64(900),\n\t\t\tScalingGroupId: pulumi.String(\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\"),\n\t\t\tScalingPolicyAction: &flexibleengine.AsPolicyV1ScalingPolicyActionArgs{\n\t\t\t\tInstanceNumber: pulumi.Float64(1),\n\t\t\t\tOperation: pulumi.String(\"ADD\"),\n\t\t\t},\n\t\t\tScalingPolicyName: pulumi.String(\"hth_aspolicy_2\"),\n\t\t\tScalingPolicyType: pulumi.String(\"ALARM\"),\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.flexibleengine.AsPolicyV1;\nimport com.pulumi.flexibleengine.AsPolicyV1Args;\nimport com.pulumi.flexibleengine.inputs.AsPolicyV1ScalingPolicyActionArgs;\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 hthAspolicy2 = new AsPolicyV1(\"hthAspolicy2\", AsPolicyV1Args.builder()\n .alarmId(\"37e310f5-db9d-446e-9135-c625f9c2bbfc\")\n .coolDownTime(900)\n .scalingGroupId(\"4579f2f5-cbe8-425a-8f32-53dcb9d9053a\")\n .scalingPolicyAction(AsPolicyV1ScalingPolicyActionArgs.builder()\n .instanceNumber(1)\n .operation(\"ADD\")\n .build())\n .scalingPolicyName(\"hth_aspolicy_2\")\n .scalingPolicyType(\"ALARM\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n hthAspolicy2:\n type: flexibleengine:AsPolicyV1\n properties:\n alarmId: 37e310f5-db9d-446e-9135-c625f9c2bbfc\n coolDownTime: 900\n scalingGroupId: 4579f2f5-cbe8-425a-8f32-53dcb9d9053a\n scalingPolicyAction:\n instanceNumber: 1\n operation: ADD\n scalingPolicyName: hth_aspolicy_2\n scalingPolicyType: ALARM\n```\n\n\n## Import\n\nAuto Scaling policy can be imported using the `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/asPolicyV1:AsPolicyV1 hth_aspolicy 5f3b5f5e-1b5f-4b5a-8f32-53dcb9d9053a\n```\n\n",
"properties": {
"alarmId": {
"type": "string",
"description": "The alarm rule ID. This argument is mandatory\nwhen `scaling_policy_type` is set to `ALARM`.\n"
},
"asPolicyV1Id": {
"type": "string"
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration (in seconds), and is 900 by default.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the AS policy. If\nomitted, the `region` argument of the provider is used. Changing this\ncreates a new AS policy.\n"
},
"scalingGroupId": {
"type": "string",
"description": "The AS group ID. Changing this creates a new AS policy.\n"
},
"scalingPolicyAction": {
"$ref": "#/types/flexibleengine:index%2FAsPolicyV1ScalingPolicyAction:AsPolicyV1ScalingPolicyAction",
"description": "The action of the AS policy. The scaling_policy_action\nstructure is documented below.\n"
},
"scalingPolicyName": {
"type": "string",
"description": "The name of the AS policy. The name can contain letters,\ndigits, underscores(_), and hyphens(-),and cannot exceed 64 characters.\n"
},
"scalingPolicyType": {
"type": "string",
"description": "The AS policy type. The values can be `ALARM`, `SCHEDULED`,\nand `RECURRENCE`.\n"
},
"scheduledPolicy": {
"$ref": "#/types/flexibleengine:index%2FAsPolicyV1ScheduledPolicy:AsPolicyV1ScheduledPolicy",
"description": "The periodic or scheduled AS policy. This argument is mandatory\nwhen `scaling_policy_type` is set to `SCHEDULED` or `RECURRENCE`. The scheduled_policy structure\nis documented below.\n"
}
},
"type": "object",
"required": [
"asPolicyV1Id",
"region",
"scalingGroupId",
"scalingPolicyName",
"scalingPolicyType"
],
"inputProperties": {
"alarmId": {
"type": "string",
"description": "The alarm rule ID. This argument is mandatory\nwhen `scaling_policy_type` is set to `ALARM`.\n"
},
"asPolicyV1Id": {
"type": "string"
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration (in seconds), and is 900 by default.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the AS policy. If\nomitted, the `region` argument of the provider is used. Changing this\ncreates a new AS policy.\n"
},
"scalingGroupId": {
"type": "string",
"description": "The AS group ID. Changing this creates a new AS policy.\n"
},
"scalingPolicyAction": {
"$ref": "#/types/flexibleengine:index%2FAsPolicyV1ScalingPolicyAction:AsPolicyV1ScalingPolicyAction",
"description": "The action of the AS policy. The scaling_policy_action\nstructure is documented below.\n"
},
"scalingPolicyName": {
"type": "string",
"description": "The name of the AS policy. The name can contain letters,\ndigits, underscores(_), and hyphens(-),and cannot exceed 64 characters.\n"
},
"scalingPolicyType": {
"type": "string",
"description": "The AS policy type. The values can be `ALARM`, `SCHEDULED`,\nand `RECURRENCE`.\n"
},
"scheduledPolicy": {
"$ref": "#/types/flexibleengine:index%2FAsPolicyV1ScheduledPolicy:AsPolicyV1ScheduledPolicy",
"description": "The periodic or scheduled AS policy. This argument is mandatory\nwhen `scaling_policy_type` is set to `SCHEDULED` or `RECURRENCE`. The scheduled_policy structure\nis documented below.\n"
}
},
"requiredInputs": [
"scalingGroupId",
"scalingPolicyName",
"scalingPolicyType"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering AsPolicyV1 resources.\n",
"properties": {
"alarmId": {
"type": "string",
"description": "The alarm rule ID. This argument is mandatory\nwhen `scaling_policy_type` is set to `ALARM`.\n"
},
"asPolicyV1Id": {
"type": "string"
},
"coolDownTime": {
"type": "number",
"description": "The cooling duration (in seconds), and is 900 by default.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the AS policy. If\nomitted, the `region` argument of the provider is used. Changing this\ncreates a new AS policy.\n"
},
"scalingGroupId": {
"type": "string",
"description": "The AS group ID. Changing this creates a new AS policy.\n"
},
"scalingPolicyAction": {
"$ref": "#/types/flexibleengine:index%2FAsPolicyV1ScalingPolicyAction:AsPolicyV1ScalingPolicyAction",
"description": "The action of the AS policy. The scaling_policy_action\nstructure is documented below.\n"
},
"scalingPolicyName": {
"type": "string",
"description": "The name of the AS policy. The name can contain letters,\ndigits, underscores(_), and hyphens(-),and cannot exceed 64 characters.\n"
},
"scalingPolicyType": {
"type": "string",
"description": "The AS policy type. The values can be `ALARM`, `SCHEDULED`,\nand `RECURRENCE`.\n"
},
"scheduledPolicy": {
"$ref": "#/types/flexibleengine:index%2FAsPolicyV1ScheduledPolicy:AsPolicyV1ScheduledPolicy",
"description": "The periodic or scheduled AS policy. This argument is mandatory\nwhen `scaling_policy_type` is set to `SCHEDULED` or `RECURRENCE`. The scheduled_policy structure\nis documented below.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/blockstorageVolumeV2:BlockstorageVolumeV2": {
"description": "Manages a V2 volume resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst volume1 = new flexibleengine.BlockstorageVolumeV2(\"volume1\", {\n description: \"first test volume\",\n metadata: {\n __system__cmkid: \"kms_id\",\n __system__encrypted: \"1\",\n },\n size: 3,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nvolume1 = flexibleengine.BlockstorageVolumeV2(\"volume1\",\n description=\"first test volume\",\n metadata={\n \"__system__cmkid\": \"kms_id\",\n \"__system__encrypted\": \"1\",\n },\n size=3)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var volume1 = new Flexibleengine.BlockstorageVolumeV2(\"volume1\", new()\n {\n Description = \"first test volume\",\n Metadata = \n {\n { \"__system__cmkid\", \"kms_id\" },\n { \"__system__encrypted\", \"1\" },\n },\n Size = 3,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewBlockstorageVolumeV2(ctx, \"volume1\", &flexibleengine.BlockstorageVolumeV2Args{\n\t\t\tDescription: pulumi.String(\"first test volume\"),\n\t\t\tMetadata: pulumi.StringMap{\n\t\t\t\t\"__system__cmkid\": pulumi.String(\"kms_id\"),\n\t\t\t\t\"__system__encrypted\": pulumi.String(\"1\"),\n\t\t\t},\n\t\t\tSize: pulumi.Float64(3),\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.flexibleengine.BlockstorageVolumeV2;\nimport com.pulumi.flexibleengine.BlockstorageVolumeV2Args;\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 volume1 = new BlockstorageVolumeV2(\"volume1\", BlockstorageVolumeV2Args.builder()\n .description(\"first test volume\")\n .metadata(Map.ofEntries(\n Map.entry(\"__system__cmkid\", \"kms_id\"),\n Map.entry(\"__system__encrypted\", \"1\")\n ))\n .size(3)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n volume1:\n type: flexibleengine:BlockstorageVolumeV2\n properties:\n description: first test volume\n metadata:\n __system__cmkid: kms_id\n __system__encrypted: '1'\n size: 3\n```\n\n\n## Import\n\nVolumes can be imported using the `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/blockstorageVolumeV2:BlockstorageVolumeV2 volume_1 ea257959-eeb1-4c10-8d33-26f0409a755d\n```\n\n",
"properties": {
"attachments": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FBlockstorageVolumeV2Attachment:BlockstorageVolumeV2Attachment"
},
"description": "If a volume is attached to an instance, this attribute will\ndisplay the Attachment ID, Instance ID, and the Device as the Instance sees it.\n"
},
"availabilityZone": {
"type": "string",
"description": "The availability zone for the volume.\nChanging this creates a new volume.\n"
},
"blockstorageVolumeV2Id": {
"type": "string",
"description": "Specifies a resource ID in UUID format.\n"
},
"cascade": {
"type": "boolean",
"description": "Specifies to delete all snapshots associated with the EVS disk, Defaults to false.\n"
},
"consistencyGroupId": {
"type": "string",
"description": "The consistency group to place the volume in.\nChanging this creates a new volume.\n"
},
"description": {
"type": "string",
"description": "A description of the volume.\nChanging this updates the volume's description.\n"
},
"imageId": {
"type": "string",
"description": "The image ID from which to create the volume.\nChanging this creates a new volume.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Metadata key/value pairs to associate with the volume.\nChanging this updates the existing volume metadata.\n\nThe EVS encryption capability with KMS key can be set with the following parameters:\n"
},
"multiattach": {
"type": "boolean",
"description": "Specifies whether the EVS disk is shareable.\n"
},
"name": {
"type": "string",
"description": "A unique name for the volume. Changing this updates the volume's name.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the volume.\nIf omitted, the `region` argument of the provider is used.\nChanging this creates a new volume.\n"
},
"size": {
"type": "number",
"description": "The size of the volume to create (in gigabytes).\n"
},
"snapshotId": {
"type": "string",
"description": "The snapshot ID from which to create the volume.\nChanging this creates a new volume.\n"
},
"sourceReplica": {
"type": "string",
"description": "The volume ID to replicate with.\nChanging this creates a new volume.\n"
},
"sourceVolId": {
"type": "string",
"description": "The volume ID from which to create the volume.\nChanging this creates a new volume.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the volume.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FBlockstorageVolumeV2Timeouts:BlockstorageVolumeV2Timeouts"
},
"volumeType": {
"type": "string",
"description": "The type of volume to create.\nChanging this creates a new volume.\n"
}
},
"type": "object",
"required": [
"attachments",
"availabilityZone",
"blockstorageVolumeV2Id",
"metadata",
"name",
"region",
"size",
"volumeType"
],
"inputProperties": {
"availabilityZone": {
"type": "string",
"description": "The availability zone for the volume.\nChanging this creates a new volume.\n"
},
"blockstorageVolumeV2Id": {
"type": "string",
"description": "Specifies a resource ID in UUID format.\n"
},
"cascade": {
"type": "boolean",
"description": "Specifies to delete all snapshots associated with the EVS disk, Defaults to false.\n"
},
"consistencyGroupId": {
"type": "string",
"description": "The consistency group to place the volume in.\nChanging this creates a new volume.\n"
},
"description": {
"type": "string",
"description": "A description of the volume.\nChanging this updates the volume's description.\n"
},
"imageId": {
"type": "string",
"description": "The image ID from which to create the volume.\nChanging this creates a new volume.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Metadata key/value pairs to associate with the volume.\nChanging this updates the existing volume metadata.\n\nThe EVS encryption capability with KMS key can be set with the following parameters:\n"
},
"multiattach": {
"type": "boolean",
"description": "Specifies whether the EVS disk is shareable.\n"
},
"name": {
"type": "string",
"description": "A unique name for the volume. Changing this updates the volume's name.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the volume.\nIf omitted, the `region` argument of the provider is used.\nChanging this creates a new volume.\n"
},
"size": {
"type": "number",
"description": "The size of the volume to create (in gigabytes).\n"
},
"snapshotId": {
"type": "string",
"description": "The snapshot ID from which to create the volume.\nChanging this creates a new volume.\n"
},
"sourceReplica": {
"type": "string",
"description": "The volume ID to replicate with.\nChanging this creates a new volume.\n"
},
"sourceVolId": {
"type": "string",
"description": "The volume ID from which to create the volume.\nChanging this creates a new volume.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the volume.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FBlockstorageVolumeV2Timeouts:BlockstorageVolumeV2Timeouts"
},
"volumeType": {
"type": "string",
"description": "The type of volume to create.\nChanging this creates a new volume.\n"
}
},
"requiredInputs": [
"size"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering BlockstorageVolumeV2 resources.\n",
"properties": {
"attachments": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FBlockstorageVolumeV2Attachment:BlockstorageVolumeV2Attachment"
},
"description": "If a volume is attached to an instance, this attribute will\ndisplay the Attachment ID, Instance ID, and the Device as the Instance sees it.\n"
},
"availabilityZone": {
"type": "string",
"description": "The availability zone for the volume.\nChanging this creates a new volume.\n"
},
"blockstorageVolumeV2Id": {
"type": "string",
"description": "Specifies a resource ID in UUID format.\n"
},
"cascade": {
"type": "boolean",
"description": "Specifies to delete all snapshots associated with the EVS disk, Defaults to false.\n"
},
"consistencyGroupId": {
"type": "string",
"description": "The consistency group to place the volume in.\nChanging this creates a new volume.\n"
},
"description": {
"type": "string",
"description": "A description of the volume.\nChanging this updates the volume's description.\n"
},
"imageId": {
"type": "string",
"description": "The image ID from which to create the volume.\nChanging this creates a new volume.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Metadata key/value pairs to associate with the volume.\nChanging this updates the existing volume metadata.\n\nThe EVS encryption capability with KMS key can be set with the following parameters:\n"
},
"multiattach": {
"type": "boolean",
"description": "Specifies whether the EVS disk is shareable.\n"
},
"name": {
"type": "string",
"description": "A unique name for the volume. Changing this updates the volume's name.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the volume.\nIf omitted, the `region` argument of the provider is used.\nChanging this creates a new volume.\n"
},
"size": {
"type": "number",
"description": "The size of the volume to create (in gigabytes).\n"
},
"snapshotId": {
"type": "string",
"description": "The snapshot ID from which to create the volume.\nChanging this creates a new volume.\n"
},
"sourceReplica": {
"type": "string",
"description": "The volume ID to replicate with.\nChanging this creates a new volume.\n"
},
"sourceVolId": {
"type": "string",
"description": "The volume ID from which to create the volume.\nChanging this creates a new volume.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the volume.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FBlockstorageVolumeV2Timeouts:BlockstorageVolumeV2Timeouts"
},
"volumeType": {
"type": "string",
"description": "The type of volume to create.\nChanging this creates a new volume.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cbrPolicy:CbrPolicy": {
"description": "Manages a CBR Policy resource within FlexibleEngine.\n\n## Example Usage\n\n### create a backup policy\n\n\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.flexibleengine.CbrPolicy;\nimport com.pulumi.flexibleengine.CbrPolicyArgs;\nimport com.pulumi.flexibleengine.inputs.CbrPolicyBackupCycleArgs;\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 final var config = ctx.config();\n final var policyName = config.get(\"policyName\");\n var test = new CbrPolicy(\"test\", CbrPolicyArgs.builder()\n .type(\"backup\")\n .timePeriod(20)\n .backupCycle(CbrPolicyBackupCycleArgs.builder()\n .frequency(\"WEEKLY\")\n .days(\"MO,TH\")\n .executionTimes(\"06:00\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n policyName:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CbrPolicy\n properties:\n type: backup\n timePeriod: 20\n backupCycle:\n frequency: WEEKLY\n days: MO,TH\n executionTimes:\n - 06:00\n```\n\n\n### create a replication policy\n\n\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.flexibleengine.CbrPolicy;\nimport com.pulumi.flexibleengine.CbrPolicyArgs;\nimport com.pulumi.flexibleengine.inputs.CbrPolicyBackupCycleArgs;\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 final var config = ctx.config();\n final var policyName = config.get(\"policyName\");\n final var destinationRegion = config.get(\"destinationRegion\");\n final var destinationProjectId = config.get(\"destinationProjectId\");\n var test = new CbrPolicy(\"test\", CbrPolicyArgs.builder()\n .type(\"replication\")\n .destinationRegion(destinationRegion)\n .destinationProjectId(destinationProjectId)\n .backupQuantity(20)\n .backupCycle(CbrPolicyBackupCycleArgs.builder()\n .frequency(\"DAILY\")\n .interval(5)\n .executionTimes(\"21:00\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n policyName:\n type: dynamic\n destinationRegion:\n type: dynamic\n destinationProjectId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CbrPolicy\n properties:\n type: replication\n destinationRegion: ${destinationRegion}\n destinationProjectId: ${destinationProjectId}\n backupQuantity: 20\n backupCycle:\n frequency: DAILY\n interval: 5\n executionTimes:\n - 21:00\n```\n\n\n## Import\n\nPolicies can be imported by their `id`. For example,\n\nbash\n\n```sh\n$ pulumi import flexibleengine:index/cbrPolicy:CbrPolicy test 4d2c2939-774f-42ef-ab15-e5b126b11ace\n```\n\n",
"properties": {
"backupCycle": {
"$ref": "#/types/flexibleengine:index%2FCbrPolicyBackupCycle:CbrPolicyBackupCycle",
"description": "Specifies the scheduling rule for the policy backup execution.\nThe backup_cycle structure is documented below.\n"
},
"backupQuantity": {
"type": "number",
"description": "Specifies the maximum number of retained backups. The value ranges from `2` to\n`99,999`. This parameter and `time_period` are alternative.\n"
},
"cbrPolicyId": {
"type": "string",
"description": "A resource ID in UUID format.\n"
},
"destinationProjectId": {
"type": "string",
"description": "Specifies the ID of the replication destination project, which is\nmandatory for cross-region replication. Required if `protection_type` is **replication**.\n"
},
"destinationRegion": {
"type": "string",
"description": "Specifies the name of the replication destination region, which is mandatory\nfor cross-region replication. Required if `protection_type` is **replication**.\n"
},
"enableAcceleration": {
"type": "boolean",
"description": "Specifies whether to enable the acceleration function to shorten\nthe replication time for cross-region.\nChanging this will create a new policy.\n"
},
"enabled": {
"type": "boolean",
"description": "Specifies whether to enable the policy. Default to **true**.\n"
},
"longTermRetention": {
"$ref": "#/types/flexibleengine:index%2FCbrPolicyLongTermRetention:CbrPolicyLongTermRetention",
"description": "Specifies the long-term retention rules, which is an advanced options of\nthe `backup_quantity`. The object structure is documented below.\n\n> The configuration of `long_term_retention` and `backup_quantity` will take effect together.\nWhen the number of retained backups exceeds the preset value (number of `backup_quantity`), the system automatically\ndeletes the earliest backups. By default, the system automatically clears data every other day.\n"
},
"name": {
"type": "string",
"description": "Specifies the policy name. \nThis parameter can contain a maximum of 64\ncharacters, which may consist of chinese characters, letters, digits, underscores(_) and hyphens (-).\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the policy is located. If omitted, the\nprovider-level region will be used. Changing this will create a new policy.\n"
},
"timePeriod": {
"type": "number",
"description": "Specifies the duration (in days) for retained backups. The value ranges from `2` to\n`99,999`.\n\n> **NOTE:** If this `backup_quantity` and `time_period` are both left blank, the backups will be retained permanently.\n"
},
"timeZone": {
"type": "string",
"description": "Specifies the UTC time zone, e.g. `UTC+08:00`.\nOnly available if `long_term_retention` is set.\n\n\nThe `backup_cycle` block supports:\n"
},
"type": {
"type": "string",
"description": "Specifies the protection type of the policy.\nValid values are **backup** and **replication**.\nChanging this will create a new policy.\n"
}
},
"type": "object",
"required": [
"backupCycle",
"cbrPolicyId",
"name",
"region",
"timeZone",
"type"
],
"inputProperties": {
"backupCycle": {
"$ref": "#/types/flexibleengine:index%2FCbrPolicyBackupCycle:CbrPolicyBackupCycle",
"description": "Specifies the scheduling rule for the policy backup execution.\nThe backup_cycle structure is documented below.\n"
},
"backupQuantity": {
"type": "number",
"description": "Specifies the maximum number of retained backups. The value ranges from `2` to\n`99,999`. This parameter and `time_period` are alternative.\n"
},
"cbrPolicyId": {
"type": "string",
"description": "A resource ID in UUID format.\n"
},
"destinationProjectId": {
"type": "string",
"description": "Specifies the ID of the replication destination project, which is\nmandatory for cross-region replication. Required if `protection_type` is **replication**.\n"
},
"destinationRegion": {
"type": "string",
"description": "Specifies the name of the replication destination region, which is mandatory\nfor cross-region replication. Required if `protection_type` is **replication**.\n"
},
"enableAcceleration": {
"type": "boolean",
"description": "Specifies whether to enable the acceleration function to shorten\nthe replication time for cross-region.\nChanging this will create a new policy.\n"
},
"enabled": {
"type": "boolean",
"description": "Specifies whether to enable the policy. Default to **true**.\n"
},
"longTermRetention": {
"$ref": "#/types/flexibleengine:index%2FCbrPolicyLongTermRetention:CbrPolicyLongTermRetention",
"description": "Specifies the long-term retention rules, which is an advanced options of\nthe `backup_quantity`. The object structure is documented below.\n\n> The configuration of `long_term_retention` and `backup_quantity` will take effect together.\nWhen the number of retained backups exceeds the preset value (number of `backup_quantity`), the system automatically\ndeletes the earliest backups. By default, the system automatically clears data every other day.\n"
},
"name": {
"type": "string",
"description": "Specifies the policy name. \nThis parameter can contain a maximum of 64\ncharacters, which may consist of chinese characters, letters, digits, underscores(_) and hyphens (-).\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the policy is located. If omitted, the\nprovider-level region will be used. Changing this will create a new policy.\n"
},
"timePeriod": {
"type": "number",
"description": "Specifies the duration (in days) for retained backups. The value ranges from `2` to\n`99,999`.\n\n> **NOTE:** If this `backup_quantity` and `time_period` are both left blank, the backups will be retained permanently.\n"
},
"timeZone": {
"type": "string",
"description": "Specifies the UTC time zone, e.g. `UTC+08:00`.\nOnly available if `long_term_retention` is set.\n\n\nThe `backup_cycle` block supports:\n"
},
"type": {
"type": "string",
"description": "Specifies the protection type of the policy.\nValid values are **backup** and **replication**.\nChanging this will create a new policy.\n"
}
},
"requiredInputs": [
"backupCycle",
"type"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CbrPolicy resources.\n",
"properties": {
"backupCycle": {
"$ref": "#/types/flexibleengine:index%2FCbrPolicyBackupCycle:CbrPolicyBackupCycle",
"description": "Specifies the scheduling rule for the policy backup execution.\nThe backup_cycle structure is documented below.\n"
},
"backupQuantity": {
"type": "number",
"description": "Specifies the maximum number of retained backups. The value ranges from `2` to\n`99,999`. This parameter and `time_period` are alternative.\n"
},
"cbrPolicyId": {
"type": "string",
"description": "A resource ID in UUID format.\n"
},
"destinationProjectId": {
"type": "string",
"description": "Specifies the ID of the replication destination project, which is\nmandatory for cross-region replication. Required if `protection_type` is **replication**.\n"
},
"destinationRegion": {
"type": "string",
"description": "Specifies the name of the replication destination region, which is mandatory\nfor cross-region replication. Required if `protection_type` is **replication**.\n"
},
"enableAcceleration": {
"type": "boolean",
"description": "Specifies whether to enable the acceleration function to shorten\nthe replication time for cross-region.\nChanging this will create a new policy.\n"
},
"enabled": {
"type": "boolean",
"description": "Specifies whether to enable the policy. Default to **true**.\n"
},
"longTermRetention": {
"$ref": "#/types/flexibleengine:index%2FCbrPolicyLongTermRetention:CbrPolicyLongTermRetention",
"description": "Specifies the long-term retention rules, which is an advanced options of\nthe `backup_quantity`. The object structure is documented below.\n\n> The configuration of `long_term_retention` and `backup_quantity` will take effect together.\nWhen the number of retained backups exceeds the preset value (number of `backup_quantity`), the system automatically\ndeletes the earliest backups. By default, the system automatically clears data every other day.\n"
},
"name": {
"type": "string",
"description": "Specifies the policy name. \nThis parameter can contain a maximum of 64\ncharacters, which may consist of chinese characters, letters, digits, underscores(_) and hyphens (-).\n"
},
"region": {
"type": "string",
"description": "Specifies the region where the policy is located. If omitted, the\nprovider-level region will be used. Changing this will create a new policy.\n"
},
"timePeriod": {
"type": "number",
"description": "Specifies the duration (in days) for retained backups. The value ranges from `2` to\n`99,999`.\n\n> **NOTE:** If this `backup_quantity` and `time_period` are both left blank, the backups will be retained permanently.\n"
},
"timeZone": {
"type": "string",
"description": "Specifies the UTC time zone, e.g. `UTC+08:00`.\nOnly available if `long_term_retention` is set.\n\n\nThe `backup_cycle` block supports:\n"
},
"type": {
"type": "string",
"description": "Specifies the protection type of the policy.\nValid values are **backup** and **replication**.\nChanging this will create a new policy.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cbrVault:CbrVault": {
"description": "Manages a CBR Vault resource within FlexibleEngine.\n\n## Example Usage\n\n### Create a server type vault\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst vaultName = config.requireObject(\"vaultName\");\nconst ecsInstanceId = config.requireObject(\"ecsInstanceId\");\nconst attachedVolumeIds = config.requireObject>(\"attachedVolumeIds\");\nconst test = new flexibleengine.CbrVault(\"test\", {\n type: \"server\",\n protectionType: \"backup\",\n consistentLevel: \"crash_consistent\",\n size: 100,\n resources: [{\n serverId: ecsInstanceId,\n excludes: attachedVolumeIds,\n }],\n tags: {\n foo: \"bar\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nvault_name = config.require_object(\"vaultName\")\necs_instance_id = config.require_object(\"ecsInstanceId\")\nattached_volume_ids = config.require_object(\"attachedVolumeIds\")\ntest = flexibleengine.CbrVault(\"test\",\n type=\"server\",\n protection_type=\"backup\",\n consistent_level=\"crash_consistent\",\n size=100,\n resources=[{\n \"server_id\": ecs_instance_id,\n \"excludes\": attached_volume_ids,\n }],\n tags={\n \"foo\": \"bar\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var vaultName = config.RequireObject(\"vaultName\");\n var ecsInstanceId = config.RequireObject(\"ecsInstanceId\");\n var attachedVolumeIds = config.RequireObject(\"attachedVolumeIds\");\n var test = new Flexibleengine.CbrVault(\"test\", new()\n {\n Type = \"server\",\n ProtectionType = \"backup\",\n ConsistentLevel = \"crash_consistent\",\n Size = 100,\n Resources = new[]\n {\n new Flexibleengine.Inputs.CbrVaultResourceArgs\n {\n ServerId = ecsInstanceId,\n Excludes = attachedVolumeIds,\n },\n },\n Tags = \n {\n { \"foo\", \"bar\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tvaultName := cfg.RequireObject(\"vaultName\")\n\t\tecsInstanceId := cfg.RequireObject(\"ecsInstanceId\")\n\t\tattachedVolumeIds := cfg.Require(\"attachedVolumeIds\")\n\t\t_, err := flexibleengine.NewCbrVault(ctx, \"test\", &flexibleengine.CbrVaultArgs{\n\t\t\tType: pulumi.String(\"server\"),\n\t\t\tProtectionType: pulumi.String(\"backup\"),\n\t\t\tConsistentLevel: pulumi.String(\"crash_consistent\"),\n\t\t\tSize: pulumi.Float64(100),\n\t\t\tResources: flexibleengine.CbrVaultResourceArray{\n\t\t\t\t&flexibleengine.CbrVaultResourceArgs{\n\t\t\t\t\tServerId: pulumi.Any(ecsInstanceId),\n\t\t\t\t\tExcludes: attachedVolumeIds,\n\t\t\t\t},\n\t\t\t},\n\t\t\tTags: pulumi.StringMap{\n\t\t\t\t\"foo\": pulumi.String(\"bar\"),\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.flexibleengine.CbrVault;\nimport com.pulumi.flexibleengine.CbrVaultArgs;\nimport com.pulumi.flexibleengine.inputs.CbrVaultResourceArgs;\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 final var config = ctx.config();\n final var vaultName = config.get(\"vaultName\");\n final var ecsInstanceId = config.get(\"ecsInstanceId\");\n final var attachedVolumeIds = config.get(\"attachedVolumeIds\");\n var test = new CbrVault(\"test\", CbrVaultArgs.builder()\n .type(\"server\")\n .protectionType(\"backup\")\n .consistentLevel(\"crash_consistent\")\n .size(100)\n .resources(CbrVaultResourceArgs.builder()\n .serverId(ecsInstanceId)\n .excludes(attachedVolumeIds)\n .build())\n .tags(Map.of(\"foo\", \"bar\"))\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n vaultName:\n type: dynamic\n ecsInstanceId:\n type: dynamic\n attachedVolumeIds:\n type: list(string)\nresources:\n test:\n type: flexibleengine:CbrVault\n properties:\n type: server\n protectionType: backup\n consistentLevel: crash_consistent\n size: 100\n resources:\n - serverId: ${ecsInstanceId}\n excludes: ${attachedVolumeIds}\n tags:\n foo: bar\n```\n\n\n### Create a disk type vault\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst vaultName = config.requireObject(\"vaultName\");\nconst evsVolumeIds = config.requireObject>(\"evsVolumeIds\");\nconst test = new flexibleengine.CbrVault(\"test\", {\n type: \"disk\",\n protectionType: \"backup\",\n size: 50,\n autoExpand: true,\n resources: [{\n includes: evsVolumeIds,\n }],\n tags: {\n foo: \"bar\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nvault_name = config.require_object(\"vaultName\")\nevs_volume_ids = config.require_object(\"evsVolumeIds\")\ntest = flexibleengine.CbrVault(\"test\",\n type=\"disk\",\n protection_type=\"backup\",\n size=50,\n auto_expand=True,\n resources=[{\n \"includes\": evs_volume_ids,\n }],\n tags={\n \"foo\": \"bar\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var vaultName = config.RequireObject(\"vaultName\");\n var evsVolumeIds = config.RequireObject(\"evsVolumeIds\");\n var test = new Flexibleengine.CbrVault(\"test\", new()\n {\n Type = \"disk\",\n ProtectionType = \"backup\",\n Size = 50,\n AutoExpand = true,\n Resources = new[]\n {\n new Flexibleengine.Inputs.CbrVaultResourceArgs\n {\n Includes = evsVolumeIds,\n },\n },\n Tags = \n {\n { \"foo\", \"bar\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tvaultName := cfg.RequireObject(\"vaultName\")\n\t\tevsVolumeIds := cfg.Require(\"evsVolumeIds\")\n\t\t_, err := flexibleengine.NewCbrVault(ctx, \"test\", &flexibleengine.CbrVaultArgs{\n\t\t\tType: pulumi.String(\"disk\"),\n\t\t\tProtectionType: pulumi.String(\"backup\"),\n\t\t\tSize: pulumi.Float64(50),\n\t\t\tAutoExpand: pulumi.Bool(true),\n\t\t\tResources: flexibleengine.CbrVaultResourceArray{\n\t\t\t\t&flexibleengine.CbrVaultResourceArgs{\n\t\t\t\t\tIncludes: evsVolumeIds,\n\t\t\t\t},\n\t\t\t},\n\t\t\tTags: pulumi.StringMap{\n\t\t\t\t\"foo\": pulumi.String(\"bar\"),\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.flexibleengine.CbrVault;\nimport com.pulumi.flexibleengine.CbrVaultArgs;\nimport com.pulumi.flexibleengine.inputs.CbrVaultResourceArgs;\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 final var config = ctx.config();\n final var vaultName = config.get(\"vaultName\");\n final var evsVolumeIds = config.get(\"evsVolumeIds\");\n var test = new CbrVault(\"test\", CbrVaultArgs.builder()\n .type(\"disk\")\n .protectionType(\"backup\")\n .size(50)\n .autoExpand(true)\n .resources(CbrVaultResourceArgs.builder()\n .includes(evsVolumeIds)\n .build())\n .tags(Map.of(\"foo\", \"bar\"))\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n vaultName:\n type: dynamic\n evsVolumeIds:\n type: list(string)\nresources:\n test:\n type: flexibleengine:CbrVault\n properties:\n type: disk\n protectionType: backup\n size: 50\n autoExpand: true\n resources:\n - includes: ${evsVolumeIds}\n tags:\n foo: bar\n```\n\n\n### Create an SFS turbo type vault\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst vaultName = config.requireObject(\"vaultName\");\nconst sfsTurboIds = config.requireObject>(\"sfsTurboIds\");\nconst test = new flexibleengine.CbrVault(\"test\", {\n type: \"turbo\",\n protectionType: \"backup\",\n size: 1000,\n resources: [{\n includes: sfsTurboIds,\n }],\n tags: {\n foo: \"bar\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nvault_name = config.require_object(\"vaultName\")\nsfs_turbo_ids = config.require_object(\"sfsTurboIds\")\ntest = flexibleengine.CbrVault(\"test\",\n type=\"turbo\",\n protection_type=\"backup\",\n size=1000,\n resources=[{\n \"includes\": sfs_turbo_ids,\n }],\n tags={\n \"foo\": \"bar\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var vaultName = config.RequireObject(\"vaultName\");\n var sfsTurboIds = config.RequireObject(\"sfsTurboIds\");\n var test = new Flexibleengine.CbrVault(\"test\", new()\n {\n Type = \"turbo\",\n ProtectionType = \"backup\",\n Size = 1000,\n Resources = new[]\n {\n new Flexibleengine.Inputs.CbrVaultResourceArgs\n {\n Includes = sfsTurboIds,\n },\n },\n Tags = \n {\n { \"foo\", \"bar\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tvaultName := cfg.RequireObject(\"vaultName\")\n\t\tsfsTurboIds := cfg.Require(\"sfsTurboIds\")\n\t\t_, err := flexibleengine.NewCbrVault(ctx, \"test\", &flexibleengine.CbrVaultArgs{\n\t\t\tType: pulumi.String(\"turbo\"),\n\t\t\tProtectionType: pulumi.String(\"backup\"),\n\t\t\tSize: pulumi.Float64(1000),\n\t\t\tResources: flexibleengine.CbrVaultResourceArray{\n\t\t\t\t&flexibleengine.CbrVaultResourceArgs{\n\t\t\t\t\tIncludes: sfsTurboIds,\n\t\t\t\t},\n\t\t\t},\n\t\t\tTags: pulumi.StringMap{\n\t\t\t\t\"foo\": pulumi.String(\"bar\"),\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.flexibleengine.CbrVault;\nimport com.pulumi.flexibleengine.CbrVaultArgs;\nimport com.pulumi.flexibleengine.inputs.CbrVaultResourceArgs;\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 final var config = ctx.config();\n final var vaultName = config.get(\"vaultName\");\n final var sfsTurboIds = config.get(\"sfsTurboIds\");\n var test = new CbrVault(\"test\", CbrVaultArgs.builder()\n .type(\"turbo\")\n .protectionType(\"backup\")\n .size(1000)\n .resources(CbrVaultResourceArgs.builder()\n .includes(sfsTurboIds)\n .build())\n .tags(Map.of(\"foo\", \"bar\"))\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n vaultName:\n type: dynamic\n sfsTurboIds:\n type: list(string)\nresources:\n test:\n type: flexibleengine:CbrVault\n properties:\n type: turbo\n protectionType: backup\n size: 1000\n resources:\n - includes: ${sfsTurboIds}\n tags:\n foo: bar\n```\n\n\n### Create an SFS turbo type vault with replicate protection type\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst vaultName = config.requireObject(\"vaultName\");\nconst test = new flexibleengine.CbrVault(\"test\", {\n type: \"turbo\",\n protectionType: \"replication\",\n size: 1000,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nvault_name = config.require_object(\"vaultName\")\ntest = flexibleengine.CbrVault(\"test\",\n type=\"turbo\",\n protection_type=\"replication\",\n size=1000)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var vaultName = config.RequireObject(\"vaultName\");\n var test = new Flexibleengine.CbrVault(\"test\", new()\n {\n Type = \"turbo\",\n ProtectionType = \"replication\",\n Size = 1000,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tvaultName := cfg.RequireObject(\"vaultName\")\n\t\t_, err := flexibleengine.NewCbrVault(ctx, \"test\", &flexibleengine.CbrVaultArgs{\n\t\t\tType: pulumi.String(\"turbo\"),\n\t\t\tProtectionType: pulumi.String(\"replication\"),\n\t\t\tSize: pulumi.Float64(1000),\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.flexibleengine.CbrVault;\nimport com.pulumi.flexibleengine.CbrVaultArgs;\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 final var config = ctx.config();\n final var vaultName = config.get(\"vaultName\");\n var test = new CbrVault(\"test\", CbrVaultArgs.builder()\n .type(\"turbo\")\n .protectionType(\"replication\")\n .size(1000)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n vaultName:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CbrVault\n properties:\n type: turbo\n protectionType: replication\n size: 1000\n```\n\n\n## Import\n\nVaults can be imported by their `id`. For example,\n\n```sh\n$ pulumi import flexibleengine:index/cbrVault:CbrVault test 01c33779-7c83-4182-8b6b-24a671fcedf8\n```\n\nNote that the imported state may not be identical to your resource definition, due to some attributes missing from the\n\nAPI response, security or some other reason. The missing attributes include: `period_unit`, `period`, `auto_renew`.\n\nIt is generally recommended running `pulumi preview` after importing a vault.\n\nYou can then decide if changes should be applied to the vault, or the resource definition should be updated to align\n\nwith the vault. Also you can ignore changes as below.\n\nhcl\n\nresource \"flexibleengine_cbr_vault\" \"test\" {\n\n ...\n\n lifecycle {\n\n ignore_changes = [\n\n period_unit, period, auto_renew,\n\n ]\n\n }\n\n}\n\n",
"properties": {
"allocated": {
"type": "number",
"description": "The allocated capacity of the vault, in GB.\n"
},
"autoBind": {
"type": "boolean",
"description": "Specifies whether automatic association is enabled. Defaults to **false**.\n"
},
"autoExpand": {
"type": "boolean",
"description": "Specifies to enable auto capacity expansion for the backup protection type vault.\nDefaults to **false**.\n"
},
"autoPay": {
"type": "string",
"deprecationMessage": "Deprecated"
},
"autoRenew": {
"type": "string"
},
"backupNamePrefix": {
"type": "string",
"description": "The backup name prefix.\n"
},
"bindRules": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the tags to filter resources for automatic association with **auto_bind**.\n"
},
"cbrVaultId": {
"type": "string",
"description": "Specifies the policy ID.\n"
},
"chargingMode": {
"type": "string"
},
"consistentLevel": {
"type": "string",
"description": "Specifies the consistent level (specification) of the vault.\nThe valid values are as follows:\n+ **[crash_consistent](https://docs.prod-cloud-ocb.orange-business.com/usermanual/cbr/cbr_03_0109.html)**\n+ **[app_consistent](https://docs.prod-cloud-ocb.orange-business.com/usermanual/cbr/cbr_03_0109.html)**\n\nOnly **server** type vaults support application consistent and defaults to **crash_consistent**.\nChanging this will create a new vault.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id of the cbr vault resource.\nChanging this will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies a unique name of the CBR vault. This parameter can contain a maximum of 64\ncharacters, which may consist of letters, digits, underscores(_) and hyphens (-).\n"
},
"period": {
"type": "number"
},
"periodUnit": {
"type": "string"
},
"policies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCbrVaultPolicy:CbrVaultPolicy"
},
"description": "Specifies the policy details to associate with the CBR vault.\nThe object structure is documented below.\n"
},
"policyId": {
"type": "string",
"description": "schema:Deprecated; Using parameter 'policy' instead.\n"
},
"protectionType": {
"type": "string",
"description": "Specifies the protection type of the CBR vault.\nThe valid values are **backup** and **replication**. Vaults of type **disk** don't support **replication**.\nChanging this will create a new vault.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CBR vault. If omitted, the\nprovider-level region will be used. Changing this will create a new vault.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCbrVaultResource:CbrVaultResource"
},
"description": "Specifies an array of one or more resources to attach to the CBR vault.\nThe object structure is documented below.\n\n> If configured, the names of all automatic backups generated for the vault will use this prefix.\n"
},
"size": {
"type": "number",
"description": "Specifies the vault capacity, in GB. The valid value range is `1` to `10,485,760`.\n"
},
"specCode": {
"type": "string",
"description": "The specification code.\n"
},
"status": {
"type": "string",
"description": "The vault status.\n"
},
"storage": {
"type": "string",
"description": "The name of the bucket for the vault.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the key/value pairs to associat\n\n\nThe `policy` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCbrVaultTimeouts:CbrVaultTimeouts"
},
"type": {
"type": "string",
"description": "Specifies the object type of the CBR vault.\nChanging this will create a new vault. Vaild values are as follows:\n+ **server** (Cloud Servers)\n+ **disk** (EVS Disks)\n+ **turbo** (SFS Turbo file systems)\n"
},
"used": {
"type": "number",
"description": "The used capacity, in GB.\n"
}
},
"type": "object",
"required": [
"allocated",
"autoBind",
"autoExpand",
"backupNamePrefix",
"cbrVaultId",
"chargingMode",
"enterpriseProjectId",
"name",
"protectionType",
"region",
"size",
"specCode",
"status",
"storage",
"type",
"used"
],
"inputProperties": {
"autoBind": {
"type": "boolean",
"description": "Specifies whether automatic association is enabled. Defaults to **false**.\n"
},
"autoExpand": {
"type": "boolean",
"description": "Specifies to enable auto capacity expansion for the backup protection type vault.\nDefaults to **false**.\n"
},
"autoPay": {
"type": "string",
"deprecationMessage": "Deprecated"
},
"autoRenew": {
"type": "string"
},
"backupNamePrefix": {
"type": "string",
"description": "The backup name prefix.\n"
},
"bindRules": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the tags to filter resources for automatic association with **auto_bind**.\n"
},
"cbrVaultId": {
"type": "string",
"description": "Specifies the policy ID.\n"
},
"chargingMode": {
"type": "string"
},
"consistentLevel": {
"type": "string",
"description": "Specifies the consistent level (specification) of the vault.\nThe valid values are as follows:\n+ **[crash_consistent](https://docs.prod-cloud-ocb.orange-business.com/usermanual/cbr/cbr_03_0109.html)**\n+ **[app_consistent](https://docs.prod-cloud-ocb.orange-business.com/usermanual/cbr/cbr_03_0109.html)**\n\nOnly **server** type vaults support application consistent and defaults to **crash_consistent**.\nChanging this will create a new vault.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id of the cbr vault resource.\nChanging this will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies a unique name of the CBR vault. This parameter can contain a maximum of 64\ncharacters, which may consist of letters, digits, underscores(_) and hyphens (-).\n"
},
"period": {
"type": "number"
},
"periodUnit": {
"type": "string"
},
"policies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCbrVaultPolicy:CbrVaultPolicy"
},
"description": "Specifies the policy details to associate with the CBR vault.\nThe object structure is documented below.\n"
},
"policyId": {
"type": "string",
"description": "schema:Deprecated; Using parameter 'policy' instead.\n"
},
"protectionType": {
"type": "string",
"description": "Specifies the protection type of the CBR vault.\nThe valid values are **backup** and **replication**. Vaults of type **disk** don't support **replication**.\nChanging this will create a new vault.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CBR vault. If omitted, the\nprovider-level region will be used. Changing this will create a new vault.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCbrVaultResource:CbrVaultResource"
},
"description": "Specifies an array of one or more resources to attach to the CBR vault.\nThe object structure is documented below.\n\n> If configured, the names of all automatic backups generated for the vault will use this prefix.\n"
},
"size": {
"type": "number",
"description": "Specifies the vault capacity, in GB. The valid value range is `1` to `10,485,760`.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the key/value pairs to associat\n\n\nThe `policy` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCbrVaultTimeouts:CbrVaultTimeouts"
},
"type": {
"type": "string",
"description": "Specifies the object type of the CBR vault.\nChanging this will create a new vault. Vaild values are as follows:\n+ **server** (Cloud Servers)\n+ **disk** (EVS Disks)\n+ **turbo** (SFS Turbo file systems)\n"
}
},
"requiredInputs": [
"protectionType",
"size",
"type"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CbrVault resources.\n",
"properties": {
"allocated": {
"type": "number",
"description": "The allocated capacity of the vault, in GB.\n"
},
"autoBind": {
"type": "boolean",
"description": "Specifies whether automatic association is enabled. Defaults to **false**.\n"
},
"autoExpand": {
"type": "boolean",
"description": "Specifies to enable auto capacity expansion for the backup protection type vault.\nDefaults to **false**.\n"
},
"autoPay": {
"type": "string",
"deprecationMessage": "Deprecated"
},
"autoRenew": {
"type": "string"
},
"backupNamePrefix": {
"type": "string",
"description": "The backup name prefix.\n"
},
"bindRules": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the tags to filter resources for automatic association with **auto_bind**.\n"
},
"cbrVaultId": {
"type": "string",
"description": "Specifies the policy ID.\n"
},
"chargingMode": {
"type": "string"
},
"consistentLevel": {
"type": "string",
"description": "Specifies the consistent level (specification) of the vault.\nThe valid values are as follows:\n+ **[crash_consistent](https://docs.prod-cloud-ocb.orange-business.com/usermanual/cbr/cbr_03_0109.html)**\n+ **[app_consistent](https://docs.prod-cloud-ocb.orange-business.com/usermanual/cbr/cbr_03_0109.html)**\n\nOnly **server** type vaults support application consistent and defaults to **crash_consistent**.\nChanging this will create a new vault.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id of the cbr vault resource.\nChanging this will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies a unique name of the CBR vault. This parameter can contain a maximum of 64\ncharacters, which may consist of letters, digits, underscores(_) and hyphens (-).\n"
},
"period": {
"type": "number"
},
"periodUnit": {
"type": "string"
},
"policies": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCbrVaultPolicy:CbrVaultPolicy"
},
"description": "Specifies the policy details to associate with the CBR vault.\nThe object structure is documented below.\n"
},
"policyId": {
"type": "string",
"description": "schema:Deprecated; Using parameter 'policy' instead.\n"
},
"protectionType": {
"type": "string",
"description": "Specifies the protection type of the CBR vault.\nThe valid values are **backup** and **replication**. Vaults of type **disk** don't support **replication**.\nChanging this will create a new vault.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CBR vault. If omitted, the\nprovider-level region will be used. Changing this will create a new vault.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCbrVaultResource:CbrVaultResource"
},
"description": "Specifies an array of one or more resources to attach to the CBR vault.\nThe object structure is documented below.\n\n> If configured, the names of all automatic backups generated for the vault will use this prefix.\n"
},
"size": {
"type": "number",
"description": "Specifies the vault capacity, in GB. The valid value range is `1` to `10,485,760`.\n"
},
"specCode": {
"type": "string",
"description": "The specification code.\n"
},
"status": {
"type": "string",
"description": "The vault status.\n"
},
"storage": {
"type": "string",
"description": "The name of the bucket for the vault.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the key/value pairs to associat\n\n\nThe `policy` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCbrVaultTimeouts:CbrVaultTimeouts"
},
"type": {
"type": "string",
"description": "Specifies the object type of the CBR vault.\nChanging this will create a new vault. Vaild values are as follows:\n+ **server** (Cloud Servers)\n+ **disk** (EVS Disks)\n+ **turbo** (SFS Turbo file systems)\n"
},
"used": {
"type": "number",
"description": "The used capacity, in GB.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cceAddonV3:CceAddonV3": {
"description": "Provides a CCE addon resource within FlexibleEngine.\n\n> **NOTE:** Currently, there is an ongoing certificate issue regarding the add-on management APIs.\n Please set `insecure = true` in provider block to ignore SSL certificate verification.\n\n## Example Usage\n\n### Basic Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst clusterId = config.requireObject(\"clusterId\");\nconst addonTest = new flexibleengine.CceAddonV3(\"addonTest\", {\n clusterId: clusterId,\n templateName: \"metrics-server\",\n version: \"1.0.6\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ncluster_id = config.require_object(\"clusterId\")\naddon_test = flexibleengine.CceAddonV3(\"addonTest\",\n cluster_id=cluster_id,\n template_name=\"metrics-server\",\n version=\"1.0.6\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var clusterId = config.RequireObject(\"clusterId\");\n var addonTest = new Flexibleengine.CceAddonV3(\"addonTest\", new()\n {\n ClusterId = clusterId,\n TemplateName = \"metrics-server\",\n Version = \"1.0.6\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tclusterId := cfg.RequireObject(\"clusterId\")\n\t\t_, err := flexibleengine.NewCceAddonV3(ctx, \"addonTest\", &flexibleengine.CceAddonV3Args{\n\t\t\tClusterId: pulumi.Any(clusterId),\n\t\t\tTemplateName: pulumi.String(\"metrics-server\"),\n\t\t\tVersion: pulumi.String(\"1.0.6\"),\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.flexibleengine.CceAddonV3;\nimport com.pulumi.flexibleengine.CceAddonV3Args;\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 final var config = ctx.config();\n final var clusterId = config.get(\"clusterId\");\n var addonTest = new CceAddonV3(\"addonTest\", CceAddonV3Args.builder()\n .clusterId(clusterId)\n .templateName(\"metrics-server\")\n .version(\"1.0.6\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n clusterId:\n type: dynamic\nresources:\n addonTest:\n type: flexibleengine:CceAddonV3\n properties:\n clusterId: ${clusterId}\n templateName: metrics-server\n version: 1.0.6\n```\n\n\n## Import\n\nCCE addon can be imported using the cluster ID and addon ID separated by a slash, e.g.:\n\n```sh\n$ pulumi import flexibleengine:index/cceAddonV3:CceAddonV3 my_addon /\n```\n\n```sh\n$ pulumi import flexibleengine:index/cceAddonV3:CceAddonV3 my_addon bb6923e4-b16e-11eb-b0cd-0255ac101da1/c7ecb230-b16f-11eb-b3b6-0255ac1015a3\n```\n\n",
"properties": {
"cceAddonV3Id": {
"type": "string",
"description": "ID of the addon instance.\n"
},
"clusterId": {
"type": "string",
"description": "ID of the cluster. Changing this parameter will create a new resource.\n"
},
"description": {
"type": "string",
"description": "Description of addon instance.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE addon resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE addon resource.\n"
},
"status": {
"type": "string",
"description": "Addon status information.\n"
},
"templateName": {
"type": "string",
"description": "Name of the addon template.\nChanging this parameter will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceAddonV3Timeouts:CceAddonV3Timeouts"
},
"values": {
"$ref": "#/types/flexibleengine:index%2FCceAddonV3Values:CceAddonV3Values",
"description": "Add-on template installation parameters.\nThese parameters vary depending on the add-on. Changing this parameter will create a new resource.\nThe values object structure is documented below.\n\n\nThe `values` block supports:\n"
},
"version": {
"type": "string",
"description": "Version of the addon. Changing this parameter will create a new resource.\n"
}
},
"type": "object",
"required": [
"cceAddonV3Id",
"clusterId",
"description",
"region",
"status",
"templateName",
"version"
],
"inputProperties": {
"cceAddonV3Id": {
"type": "string",
"description": "ID of the addon instance.\n"
},
"clusterId": {
"type": "string",
"description": "ID of the cluster. Changing this parameter will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE addon resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE addon resource.\n"
},
"templateName": {
"type": "string",
"description": "Name of the addon template.\nChanging this parameter will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceAddonV3Timeouts:CceAddonV3Timeouts"
},
"values": {
"$ref": "#/types/flexibleengine:index%2FCceAddonV3Values:CceAddonV3Values",
"description": "Add-on template installation parameters.\nThese parameters vary depending on the add-on. Changing this parameter will create a new resource.\nThe values object structure is documented below.\n\n\nThe `values` block supports:\n"
},
"version": {
"type": "string",
"description": "Version of the addon. Changing this parameter will create a new resource.\n"
}
},
"requiredInputs": [
"clusterId",
"templateName",
"version"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CceAddonV3 resources.\n",
"properties": {
"cceAddonV3Id": {
"type": "string",
"description": "ID of the addon instance.\n"
},
"clusterId": {
"type": "string",
"description": "ID of the cluster. Changing this parameter will create a new resource.\n"
},
"description": {
"type": "string",
"description": "Description of addon instance.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE addon resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE addon resource.\n"
},
"status": {
"type": "string",
"description": "Addon status information.\n"
},
"templateName": {
"type": "string",
"description": "Name of the addon template.\nChanging this parameter will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceAddonV3Timeouts:CceAddonV3Timeouts"
},
"values": {
"$ref": "#/types/flexibleengine:index%2FCceAddonV3Values:CceAddonV3Values",
"description": "Add-on template installation parameters.\nThese parameters vary depending on the add-on. Changing this parameter will create a new resource.\nThe values object structure is documented below.\n\n\nThe `values` block supports:\n"
},
"version": {
"type": "string",
"description": "Version of the addon. Changing this parameter will create a new resource.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cceClusterV3:CceClusterV3": {
"description": "Provides a cluster resource (CCE).\n\n## Example Usage\n\n \n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst flavorId = config.requireObject(\"flavorId\");\nconst exampleVpc = new flexibleengine.VpcV1(\"exampleVpc\", {cidr: \"192.168.0.0/16\"});\nconst exampleSubnet = new flexibleengine.VpcSubnetV1(\"exampleSubnet\", {\n cidr: \"192.168.0.0/24\",\n gatewayIp: \"192.168.0.1\",\n vpcId: exampleVpc.vpcV1Id,\n});\nconst cluster1 = new flexibleengine.CceClusterV3(\"cluster1\", {\n clusterType: \"VirtualMachine\",\n authenticationMode: \"rbac\",\n description: \"new cluster\",\n flavorId: flavorId,\n vpcId: exampleVpc.vpcV1Id,\n subnetId: exampleSubnet.vpcSubnetV1Id,\n containerNetworkType: \"overlay_l2\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nflavor_id = config.require_object(\"flavorId\")\nexample_vpc = flexibleengine.VpcV1(\"exampleVpc\", cidr=\"192.168.0.0/16\")\nexample_subnet = flexibleengine.VpcSubnetV1(\"exampleSubnet\",\n cidr=\"192.168.0.0/24\",\n gateway_ip=\"192.168.0.1\",\n vpc_id=example_vpc.vpc_v1_id)\ncluster1 = flexibleengine.CceClusterV3(\"cluster1\",\n cluster_type=\"VirtualMachine\",\n authentication_mode=\"rbac\",\n description=\"new cluster\",\n flavor_id=flavor_id,\n vpc_id=example_vpc.vpc_v1_id,\n subnet_id=example_subnet.vpc_subnet_v1_id,\n container_network_type=\"overlay_l2\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var flavorId = config.RequireObject(\"flavorId\");\n var exampleVpc = new Flexibleengine.VpcV1(\"exampleVpc\", new()\n {\n Cidr = \"192.168.0.0/16\",\n });\n\n var exampleSubnet = new Flexibleengine.VpcSubnetV1(\"exampleSubnet\", new()\n {\n Cidr = \"192.168.0.0/24\",\n GatewayIp = \"192.168.0.1\",\n VpcId = exampleVpc.VpcV1Id,\n });\n\n var cluster1 = new Flexibleengine.CceClusterV3(\"cluster1\", new()\n {\n ClusterType = \"VirtualMachine\",\n AuthenticationMode = \"rbac\",\n Description = \"new cluster\",\n FlavorId = flavorId,\n VpcId = exampleVpc.VpcV1Id,\n SubnetId = exampleSubnet.VpcSubnetV1Id,\n ContainerNetworkType = \"overlay_l2\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tflavorId := cfg.RequireObject(\"flavorId\")\n\t\texampleVpc, err := flexibleengine.NewVpcV1(ctx, \"exampleVpc\", &flexibleengine.VpcV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/16\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleSubnet, err := flexibleengine.NewVpcSubnetV1(ctx, \"exampleSubnet\", &flexibleengine.VpcSubnetV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/24\"),\n\t\t\tGatewayIp: pulumi.String(\"192.168.0.1\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewCceClusterV3(ctx, \"cluster1\", &flexibleengine.CceClusterV3Args{\n\t\t\tClusterType: pulumi.String(\"VirtualMachine\"),\n\t\t\tAuthenticationMode: pulumi.String(\"rbac\"),\n\t\t\tDescription: pulumi.String(\"new cluster\"),\n\t\t\tFlavorId: pulumi.Any(flavorId),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t\tSubnetId: exampleSubnet.VpcSubnetV1Id,\n\t\t\tContainerNetworkType: pulumi.String(\"overlay_l2\"),\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.flexibleengine.VpcV1;\nimport com.pulumi.flexibleengine.VpcV1Args;\nimport com.pulumi.flexibleengine.VpcSubnetV1;\nimport com.pulumi.flexibleengine.VpcSubnetV1Args;\nimport com.pulumi.flexibleengine.CceClusterV3;\nimport com.pulumi.flexibleengine.CceClusterV3Args;\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 final var config = ctx.config();\n final var flavorId = config.get(\"flavorId\");\n var exampleVpc = new VpcV1(\"exampleVpc\", VpcV1Args.builder()\n .cidr(\"192.168.0.0/16\")\n .build());\n\n var exampleSubnet = new VpcSubnetV1(\"exampleSubnet\", VpcSubnetV1Args.builder()\n .cidr(\"192.168.0.0/24\")\n .gatewayIp(\"192.168.0.1\")\n .vpcId(exampleVpc.vpcV1Id())\n .build());\n\n var cluster1 = new CceClusterV3(\"cluster1\", CceClusterV3Args.builder()\n .clusterType(\"VirtualMachine\")\n .authenticationMode(\"rbac\")\n .description(\"new cluster\")\n .flavorId(flavorId)\n .vpcId(exampleVpc.vpcV1Id())\n .subnetId(exampleSubnet.vpcSubnetV1Id())\n .containerNetworkType(\"overlay_l2\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n flavorId:\n type: dynamic\nresources:\n exampleVpc:\n type: flexibleengine:VpcV1\n properties:\n cidr: 192.168.0.0/16\n exampleSubnet:\n type: flexibleengine:VpcSubnetV1\n properties:\n cidr: 192.168.0.0/24\n gatewayIp: 192.168.0.1\n vpcId: ${exampleVpc.vpcV1Id}\n cluster1:\n type: flexibleengine:CceClusterV3\n properties:\n clusterType: VirtualMachine\n authenticationMode: rbac\n description: new cluster\n flavorId: ${flavorId}\n vpcId: ${exampleVpc.vpcV1Id}\n subnetId: ${exampleSubnet.vpcSubnetV1Id}\n containerNetworkType: overlay_l2\n```\n\n\n## Import\n\nCluster can be imported using their `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/cceClusterV3:CceClusterV3 cluster_1 4779ab1c-7c1a-44b1-a02e-93dfc361b32d\n```\n\n",
"properties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Cluster annotation, key/value pair format.\nChanging this parameter will create a new cluster resource.\n"
},
"authenticatingProxyCa": {
"type": "string",
"description": "CA root certificate provided in the authenticating_proxy mode.\nThe CA root certificate is encoded to the Base64 format. Changing this parameter will create a new cluster resource.\n"
},
"authenticationMode": {
"type": "string",
"description": "Authentication mode of the cluster, possible values are x509\nand rbac. Defaults to *rbac*. Changing this parameter will create a new cluster resource.\n"
},
"billingMode": {
"type": "number"
},
"cceClusterV3Id": {
"type": "string",
"description": "Id of the cluster resource.\n"
},
"certificateClusters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3CertificateCluster:CceClusterV3CertificateCluster"
},
"description": "Security group ID of the cluster.\nThe certificate_clusters object structure is documented below.\n"
},
"certificateUsers": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3CertificateUser:CceClusterV3CertificateUser"
},
"description": "Security group ID of the cluster.\nThe certificate_users object structure is documented below.\n"
},
"clusterType": {
"type": "string",
"description": "Cluster Type, possible values are VirtualMachine and BareMetal.\nChanging this parameter will create a new cluster resource.\n"
},
"clusterVersion": {
"type": "string",
"description": "For the cluster version, possible values are listed on the\n[CCE Cluster Version Release Notes](https://docs.prod-cloud-ocb.orange-business.com/usermanual2/cce/cce_10_0405.html).\nIf this parameter is not set, the latest available version will be used.\n"
},
"containerNetworkCidr": {
"type": "string",
"description": "Container network segment.\nChanging this parameter will create a new cluster resource.\n"
},
"containerNetworkType": {
"type": "string",
"description": "Container network parameters. Possible values:\n"
},
"customSans": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom san to add to certificate. (array of string)\n"
},
"description": {
"type": "string",
"description": "Cluster description.\n"
},
"eip": {
"type": "string",
"description": "EIP address of the cluster.\n"
},
"extendParam": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Extended parameter. Changing this parameter will create a new cluster resource.\n"
},
"externalApigEndpoint": {
"type": "string",
"description": "The endpoint of the cluster to be accessed through API Gateway.\n"
},
"externalEndpoint": {
"type": "string",
"description": "The external network address.\n"
},
"flavorId": {
"type": "string",
"description": "Cluster specifications. Changing this parameter will create a new cluster resource.\n\n+ `cce.s1.small` - small-scale single cluster (up to 50 nodes).\n+ `cce.s1.medium` - medium-scale single cluster (up to 200 nodes).\n+ `cce.s1.large` - large-scale single cluster (up to 1000 nodes).\n+ `cce.s2.small` - small-scale HA cluster (up to 50 nodes).\n+ `cce.s2.medium` - medium-scale HA cluster (up to 200 nodes).\n+ `cce.s2.large` - large-scale HA cluster (up to 1000 nodes).\n+ `cce.t1.small` - small-scale single physical machine cluster (up to 10 nodes).\n+ `cce.t1.medium` - medium-scale single physical machine cluster (up to 100 nodes).\n+ `cce.t1.large` - large-scale single physical machine cluster (up to 500 nodes).\n+ `cce.t2.small` - small-scale HA physical machine cluster (up to 10 nodes).\n+ `cce.t2.medium` - medium-scale HA physical machine cluster (up to 100 nodes).\n+ `cce.t2.large` - large-scale HA physical machine cluster (up to 500 nodes).\n"
},
"hibernate": {
"type": "boolean",
"description": "Specifies whether to hibernate the CCE cluster. Defaults to **false**. After a cluster is\nhibernated, resources such as workloads cannot be created or managed in the cluster, and the cluster cannot be\ndeleted.\n\n\nThe `masters` block supports:\n"
},
"highwaySubnetId": {
"type": "string",
"description": "The ID of the high speed network used to create bare metal nodes.\nChanging this parameter will create a new cluster resource.\n"
},
"internalEndpoint": {
"type": "string",
"description": "The internal network address.\n"
},
"kubeProxyMode": {
"type": "string",
"description": "Service forwarding mode. Two modes are available:\n\n+ iptables: Traditional kube-proxy uses iptables rules to implement service load balancing.\nIn this mode, too many iptables rules will be generated when many services are deployed. In addition,\nnon-incremental updates will cause a latency and even obvious performance issues in the case of heavy service traffic.\n+ ipvs: Optimized kube-proxy mode with higher throughput and faster speed. This mode supports incremental updates and\ncan keep connections uninterrupted during service updates. It is suitable for large-sized clusters.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Cluster tag, key/value pair format. Changing this parameter will create a new\ncluster resource.\n"
},
"masters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3Master:CceClusterV3Master"
},
"description": "Advanced configuration of master nodes. Changing this creates a new cluster.\nThe masters object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Cluster name. Changing this parameter will create a new cluster resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE cluster resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE cluster resource.\n"
},
"securityGroupId": {
"type": "string",
"description": "Security group ID of the cluster.\n"
},
"serviceNetworkCidr": {
"type": "string",
"description": "Service network segment. Changing this parameter will create\na new cluster resource.\n"
},
"status": {
"type": "string",
"description": "Cluster status information.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the VPC Subnet used to create the node.\nChanging this parameter will create a new cluster resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3Timeouts:CceClusterV3Timeouts"
},
"vpcId": {
"type": "string",
"description": "The ID of the VPC used to create the node.\nChanging this parameter will create a new cluster resource.\n"
}
},
"type": "object",
"required": [
"billingMode",
"cceClusterV3Id",
"certificateClusters",
"certificateUsers",
"clusterType",
"clusterVersion",
"containerNetworkCidr",
"containerNetworkType",
"customSans",
"description",
"externalApigEndpoint",
"externalEndpoint",
"flavorId",
"highwaySubnetId",
"internalEndpoint",
"name",
"region",
"securityGroupId",
"serviceNetworkCidr",
"status",
"subnetId",
"vpcId"
],
"inputProperties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Cluster annotation, key/value pair format.\nChanging this parameter will create a new cluster resource.\n"
},
"authenticatingProxyCa": {
"type": "string",
"description": "CA root certificate provided in the authenticating_proxy mode.\nThe CA root certificate is encoded to the Base64 format. Changing this parameter will create a new cluster resource.\n"
},
"authenticationMode": {
"type": "string",
"description": "Authentication mode of the cluster, possible values are x509\nand rbac. Defaults to *rbac*. Changing this parameter will create a new cluster resource.\n"
},
"billingMode": {
"type": "number"
},
"cceClusterV3Id": {
"type": "string",
"description": "Id of the cluster resource.\n"
},
"clusterType": {
"type": "string",
"description": "Cluster Type, possible values are VirtualMachine and BareMetal.\nChanging this parameter will create a new cluster resource.\n"
},
"clusterVersion": {
"type": "string",
"description": "For the cluster version, possible values are listed on the\n[CCE Cluster Version Release Notes](https://docs.prod-cloud-ocb.orange-business.com/usermanual2/cce/cce_10_0405.html).\nIf this parameter is not set, the latest available version will be used.\n"
},
"containerNetworkCidr": {
"type": "string",
"description": "Container network segment.\nChanging this parameter will create a new cluster resource.\n"
},
"containerNetworkType": {
"type": "string",
"description": "Container network parameters. Possible values:\n"
},
"customSans": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom san to add to certificate. (array of string)\n"
},
"description": {
"type": "string",
"description": "Cluster description.\n"
},
"eip": {
"type": "string",
"description": "EIP address of the cluster.\n"
},
"extendParam": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Extended parameter. Changing this parameter will create a new cluster resource.\n"
},
"flavorId": {
"type": "string",
"description": "Cluster specifications. Changing this parameter will create a new cluster resource.\n\n+ `cce.s1.small` - small-scale single cluster (up to 50 nodes).\n+ `cce.s1.medium` - medium-scale single cluster (up to 200 nodes).\n+ `cce.s1.large` - large-scale single cluster (up to 1000 nodes).\n+ `cce.s2.small` - small-scale HA cluster (up to 50 nodes).\n+ `cce.s2.medium` - medium-scale HA cluster (up to 200 nodes).\n+ `cce.s2.large` - large-scale HA cluster (up to 1000 nodes).\n+ `cce.t1.small` - small-scale single physical machine cluster (up to 10 nodes).\n+ `cce.t1.medium` - medium-scale single physical machine cluster (up to 100 nodes).\n+ `cce.t1.large` - large-scale single physical machine cluster (up to 500 nodes).\n+ `cce.t2.small` - small-scale HA physical machine cluster (up to 10 nodes).\n+ `cce.t2.medium` - medium-scale HA physical machine cluster (up to 100 nodes).\n+ `cce.t2.large` - large-scale HA physical machine cluster (up to 500 nodes).\n"
},
"hibernate": {
"type": "boolean",
"description": "Specifies whether to hibernate the CCE cluster. Defaults to **false**. After a cluster is\nhibernated, resources such as workloads cannot be created or managed in the cluster, and the cluster cannot be\ndeleted.\n\n\nThe `masters` block supports:\n"
},
"highwaySubnetId": {
"type": "string",
"description": "The ID of the high speed network used to create bare metal nodes.\nChanging this parameter will create a new cluster resource.\n"
},
"kubeProxyMode": {
"type": "string",
"description": "Service forwarding mode. Two modes are available:\n\n+ iptables: Traditional kube-proxy uses iptables rules to implement service load balancing.\nIn this mode, too many iptables rules will be generated when many services are deployed. In addition,\nnon-incremental updates will cause a latency and even obvious performance issues in the case of heavy service traffic.\n+ ipvs: Optimized kube-proxy mode with higher throughput and faster speed. This mode supports incremental updates and\ncan keep connections uninterrupted during service updates. It is suitable for large-sized clusters.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Cluster tag, key/value pair format. Changing this parameter will create a new\ncluster resource.\n"
},
"masters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3Master:CceClusterV3Master"
},
"description": "Advanced configuration of master nodes. Changing this creates a new cluster.\nThe masters object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Cluster name. Changing this parameter will create a new cluster resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE cluster resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE cluster resource.\n"
},
"serviceNetworkCidr": {
"type": "string",
"description": "Service network segment. Changing this parameter will create\na new cluster resource.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the VPC Subnet used to create the node.\nChanging this parameter will create a new cluster resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3Timeouts:CceClusterV3Timeouts"
},
"vpcId": {
"type": "string",
"description": "The ID of the VPC used to create the node.\nChanging this parameter will create a new cluster resource.\n"
}
},
"requiredInputs": [
"clusterType",
"containerNetworkType",
"flavorId",
"subnetId",
"vpcId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CceClusterV3 resources.\n",
"properties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Cluster annotation, key/value pair format.\nChanging this parameter will create a new cluster resource.\n"
},
"authenticatingProxyCa": {
"type": "string",
"description": "CA root certificate provided in the authenticating_proxy mode.\nThe CA root certificate is encoded to the Base64 format. Changing this parameter will create a new cluster resource.\n"
},
"authenticationMode": {
"type": "string",
"description": "Authentication mode of the cluster, possible values are x509\nand rbac. Defaults to *rbac*. Changing this parameter will create a new cluster resource.\n"
},
"billingMode": {
"type": "number"
},
"cceClusterV3Id": {
"type": "string",
"description": "Id of the cluster resource.\n"
},
"certificateClusters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3CertificateCluster:CceClusterV3CertificateCluster"
},
"description": "Security group ID of the cluster.\nThe certificate_clusters object structure is documented below.\n"
},
"certificateUsers": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3CertificateUser:CceClusterV3CertificateUser"
},
"description": "Security group ID of the cluster.\nThe certificate_users object structure is documented below.\n"
},
"clusterType": {
"type": "string",
"description": "Cluster Type, possible values are VirtualMachine and BareMetal.\nChanging this parameter will create a new cluster resource.\n"
},
"clusterVersion": {
"type": "string",
"description": "For the cluster version, possible values are listed on the\n[CCE Cluster Version Release Notes](https://docs.prod-cloud-ocb.orange-business.com/usermanual2/cce/cce_10_0405.html).\nIf this parameter is not set, the latest available version will be used.\n"
},
"containerNetworkCidr": {
"type": "string",
"description": "Container network segment.\nChanging this parameter will create a new cluster resource.\n"
},
"containerNetworkType": {
"type": "string",
"description": "Container network parameters. Possible values:\n"
},
"customSans": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom san to add to certificate. (array of string)\n"
},
"description": {
"type": "string",
"description": "Cluster description.\n"
},
"eip": {
"type": "string",
"description": "EIP address of the cluster.\n"
},
"extendParam": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Extended parameter. Changing this parameter will create a new cluster resource.\n"
},
"externalApigEndpoint": {
"type": "string",
"description": "The endpoint of the cluster to be accessed through API Gateway.\n"
},
"externalEndpoint": {
"type": "string",
"description": "The external network address.\n"
},
"flavorId": {
"type": "string",
"description": "Cluster specifications. Changing this parameter will create a new cluster resource.\n\n+ `cce.s1.small` - small-scale single cluster (up to 50 nodes).\n+ `cce.s1.medium` - medium-scale single cluster (up to 200 nodes).\n+ `cce.s1.large` - large-scale single cluster (up to 1000 nodes).\n+ `cce.s2.small` - small-scale HA cluster (up to 50 nodes).\n+ `cce.s2.medium` - medium-scale HA cluster (up to 200 nodes).\n+ `cce.s2.large` - large-scale HA cluster (up to 1000 nodes).\n+ `cce.t1.small` - small-scale single physical machine cluster (up to 10 nodes).\n+ `cce.t1.medium` - medium-scale single physical machine cluster (up to 100 nodes).\n+ `cce.t1.large` - large-scale single physical machine cluster (up to 500 nodes).\n+ `cce.t2.small` - small-scale HA physical machine cluster (up to 10 nodes).\n+ `cce.t2.medium` - medium-scale HA physical machine cluster (up to 100 nodes).\n+ `cce.t2.large` - large-scale HA physical machine cluster (up to 500 nodes).\n"
},
"hibernate": {
"type": "boolean",
"description": "Specifies whether to hibernate the CCE cluster. Defaults to **false**. After a cluster is\nhibernated, resources such as workloads cannot be created or managed in the cluster, and the cluster cannot be\ndeleted.\n\n\nThe `masters` block supports:\n"
},
"highwaySubnetId": {
"type": "string",
"description": "The ID of the high speed network used to create bare metal nodes.\nChanging this parameter will create a new cluster resource.\n"
},
"internalEndpoint": {
"type": "string",
"description": "The internal network address.\n"
},
"kubeProxyMode": {
"type": "string",
"description": "Service forwarding mode. Two modes are available:\n\n+ iptables: Traditional kube-proxy uses iptables rules to implement service load balancing.\nIn this mode, too many iptables rules will be generated when many services are deployed. In addition,\nnon-incremental updates will cause a latency and even obvious performance issues in the case of heavy service traffic.\n+ ipvs: Optimized kube-proxy mode with higher throughput and faster speed. This mode supports incremental updates and\ncan keep connections uninterrupted during service updates. It is suitable for large-sized clusters.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Cluster tag, key/value pair format. Changing this parameter will create a new\ncluster resource.\n"
},
"masters": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3Master:CceClusterV3Master"
},
"description": "Advanced configuration of master nodes. Changing this creates a new cluster.\nThe masters object structure is documented below.\n"
},
"name": {
"type": "string",
"description": "Cluster name. Changing this parameter will create a new cluster resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE cluster resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE cluster resource.\n"
},
"securityGroupId": {
"type": "string",
"description": "Security group ID of the cluster.\n"
},
"serviceNetworkCidr": {
"type": "string",
"description": "Service network segment. Changing this parameter will create\na new cluster resource.\n"
},
"status": {
"type": "string",
"description": "Cluster status information.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the VPC Subnet used to create the node.\nChanging this parameter will create a new cluster resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceClusterV3Timeouts:CceClusterV3Timeouts"
},
"vpcId": {
"type": "string",
"description": "The ID of the VPC used to create the node.\nChanging this parameter will create a new cluster resource.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cceNamespace:CceNamespace": {
"description": "Manages a CCE namespace resource within FlexibleEngine.\n\n> **NOTE:** Currently, there is an ongoing certificate issue regarding the namespace management APIs.\n Please set `insecure = true` in provider block to ignore SSL certificate verification.\n\n## Example Usage\n\n### Basic\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst clusterId = config.requireObject(\"clusterId\");\nconst test = new flexibleengine.CceNamespace(\"test\", {clusterId: clusterId});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ncluster_id = config.require_object(\"clusterId\")\ntest = flexibleengine.CceNamespace(\"test\", cluster_id=cluster_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var clusterId = config.RequireObject(\"clusterId\");\n var test = new Flexibleengine.CceNamespace(\"test\", new()\n {\n ClusterId = clusterId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tclusterId := cfg.RequireObject(\"clusterId\")\n\t\t_, err := flexibleengine.NewCceNamespace(ctx, \"test\", &flexibleengine.CceNamespaceArgs{\n\t\t\tClusterId: pulumi.Any(clusterId),\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.flexibleengine.CceNamespace;\nimport com.pulumi.flexibleengine.CceNamespaceArgs;\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 final var config = ctx.config();\n final var clusterId = config.get(\"clusterId\");\n var test = new CceNamespace(\"test\", CceNamespaceArgs.builder()\n .clusterId(clusterId)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n clusterId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CceNamespace\n properties:\n clusterId: ${clusterId}\n```\n\n\n## Import\n\nCCE namespace can be imported using the cluster ID and namespace `name` separated by a slash, e.g.:\n\n```sh\n$ pulumi import flexibleengine:index/cceNamespace:CceNamespace test /\n```\n\n```sh\n$ pulumi import flexibleengine:index/cceNamespace:CceNamespace test bb6923e4-b16e-11eb-b0cd-0255ac101da1/test-namespace\n```\n\n",
"properties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies an unstructured key value map for external parameters.\nChanging this will create a new namespace resource.\n"
},
"cceNamespaceId": {
"type": "string",
"description": "The namespace ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "Specifies the cluster ID to which the CCE namespace belongs.\nChanging this will create a new namespace resource.\n"
},
"creationTimestamp": {
"type": "string",
"description": "The server time when namespace was created.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the map of string keys and values for labels.\nChanging this will create a new namespace resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the unique name of the namespace.\nThis parameter can contain a maximum of 63 characters, which may consist of lowercase letters, digits and hyphens (-),\nand must start and end with lowercase letters and digits. Changing this will create a new namespace resource.\nExactly one of `name` or `prefix` must be provided.\n"
},
"prefix": {
"type": "string",
"description": "Specifies a prefix used by the server to generate a unique name.\nThis parameter can contain a maximum of 63 characters, which may consist of lowercase letters, digits and\nhyphens (-), and must start and end with lowercase letters and digits.\nChanging this will create a new namespace resource. Exactly one of `name` or `prefix` must be provided.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the namespace resource.\nIf omitted, the provider-level region will be used. Changing this will create a new namespace resource.\n"
},
"status": {
"type": "string",
"description": "The current phase of the namespace.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceNamespaceTimeouts:CceNamespaceTimeouts"
}
},
"type": "object",
"required": [
"annotations",
"cceNamespaceId",
"clusterId",
"creationTimestamp",
"labels",
"name",
"region",
"status"
],
"inputProperties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies an unstructured key value map for external parameters.\nChanging this will create a new namespace resource.\n"
},
"cceNamespaceId": {
"type": "string",
"description": "The namespace ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "Specifies the cluster ID to which the CCE namespace belongs.\nChanging this will create a new namespace resource.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the map of string keys and values for labels.\nChanging this will create a new namespace resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the unique name of the namespace.\nThis parameter can contain a maximum of 63 characters, which may consist of lowercase letters, digits and hyphens (-),\nand must start and end with lowercase letters and digits. Changing this will create a new namespace resource.\nExactly one of `name` or `prefix` must be provided.\n"
},
"prefix": {
"type": "string",
"description": "Specifies a prefix used by the server to generate a unique name.\nThis parameter can contain a maximum of 63 characters, which may consist of lowercase letters, digits and\nhyphens (-), and must start and end with lowercase letters and digits.\nChanging this will create a new namespace resource. Exactly one of `name` or `prefix` must be provided.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the namespace resource.\nIf omitted, the provider-level region will be used. Changing this will create a new namespace resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceNamespaceTimeouts:CceNamespaceTimeouts"
}
},
"requiredInputs": [
"clusterId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CceNamespace resources.\n",
"properties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies an unstructured key value map for external parameters.\nChanging this will create a new namespace resource.\n"
},
"cceNamespaceId": {
"type": "string",
"description": "The namespace ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "Specifies the cluster ID to which the CCE namespace belongs.\nChanging this will create a new namespace resource.\n"
},
"creationTimestamp": {
"type": "string",
"description": "The server time when namespace was created.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the map of string keys and values for labels.\nChanging this will create a new namespace resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the unique name of the namespace.\nThis parameter can contain a maximum of 63 characters, which may consist of lowercase letters, digits and hyphens (-),\nand must start and end with lowercase letters and digits. Changing this will create a new namespace resource.\nExactly one of `name` or `prefix` must be provided.\n"
},
"prefix": {
"type": "string",
"description": "Specifies a prefix used by the server to generate a unique name.\nThis parameter can contain a maximum of 63 characters, which may consist of lowercase letters, digits and\nhyphens (-), and must start and end with lowercase letters and digits.\nChanging this will create a new namespace resource. Exactly one of `name` or `prefix` must be provided.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the namespace resource.\nIf omitted, the provider-level region will be used. Changing this will create a new namespace resource.\n"
},
"status": {
"type": "string",
"description": "The current phase of the namespace.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceNamespaceTimeouts:CceNamespaceTimeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/cceNodePoolV3:CceNodePoolV3": {
"description": "Add a node pool to a container cluster.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst clusterId = config.requireObject(\"clusterId\");\nconst keyPair = config.requireObject(\"keyPair\");\nconst availabilityZone = config.requireObject(\"availabilityZone\");\nconst nodePool = new flexibleengine.CceNodePoolV3(\"nodePool\", {\n clusterId: clusterId,\n os: \"EulerOS 2.5\",\n initialNodeCount: 2,\n flavorId: \"s3.large.4\",\n availabilityZone: availabilityZone,\n keyPair: _var.keypair,\n scaleEnable: true,\n minNodeCount: 1,\n maxNodeCount: 10,\n scaleDownCooldownTime: 100,\n priority: 1,\n type: \"vm\",\n rootVolume: {\n size: 40,\n volumetype: \"SAS\",\n },\n dataVolumes: [{\n size: 100,\n volumetype: \"SAS\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ncluster_id = config.require_object(\"clusterId\")\nkey_pair = config.require_object(\"keyPair\")\navailability_zone = config.require_object(\"availabilityZone\")\nnode_pool = flexibleengine.CceNodePoolV3(\"nodePool\",\n cluster_id=cluster_id,\n os=\"EulerOS 2.5\",\n initial_node_count=2,\n flavor_id=\"s3.large.4\",\n availability_zone=availability_zone,\n key_pair=var[\"keypair\"],\n scale_enable=True,\n min_node_count=1,\n max_node_count=10,\n scale_down_cooldown_time=100,\n priority=1,\n type=\"vm\",\n root_volume={\n \"size\": 40,\n \"volumetype\": \"SAS\",\n },\n data_volumes=[{\n \"size\": 100,\n \"volumetype\": \"SAS\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var clusterId = config.RequireObject(\"clusterId\");\n var keyPair = config.RequireObject(\"keyPair\");\n var availabilityZone = config.RequireObject(\"availabilityZone\");\n var nodePool = new Flexibleengine.CceNodePoolV3(\"nodePool\", new()\n {\n ClusterId = clusterId,\n Os = \"EulerOS 2.5\",\n InitialNodeCount = 2,\n FlavorId = \"s3.large.4\",\n AvailabilityZone = availabilityZone,\n KeyPair = @var.Keypair,\n ScaleEnable = true,\n MinNodeCount = 1,\n MaxNodeCount = 10,\n ScaleDownCooldownTime = 100,\n Priority = 1,\n Type = \"vm\",\n RootVolume = new Flexibleengine.Inputs.CceNodePoolV3RootVolumeArgs\n {\n Size = 40,\n Volumetype = \"SAS\",\n },\n DataVolumes = new[]\n {\n new Flexibleengine.Inputs.CceNodePoolV3DataVolumeArgs\n {\n Size = 100,\n Volumetype = \"SAS\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tclusterId := cfg.RequireObject(\"clusterId\")\n\t\tkeyPair := cfg.RequireObject(\"keyPair\")\n\t\tavailabilityZone := cfg.RequireObject(\"availabilityZone\")\n\t\t_, err := flexibleengine.NewCceNodePoolV3(ctx, \"nodePool\", &flexibleengine.CceNodePoolV3Args{\n\t\t\tClusterId: pulumi.Any(clusterId),\n\t\t\tOs: pulumi.String(\"EulerOS 2.5\"),\n\t\t\tInitialNodeCount: pulumi.Float64(2),\n\t\t\tFlavorId: pulumi.String(\"s3.large.4\"),\n\t\t\tAvailabilityZone: pulumi.Any(availabilityZone),\n\t\t\tKeyPair: pulumi.Any(_var.Keypair),\n\t\t\tScaleEnable: pulumi.Bool(true),\n\t\t\tMinNodeCount: pulumi.Float64(1),\n\t\t\tMaxNodeCount: pulumi.Float64(10),\n\t\t\tScaleDownCooldownTime: pulumi.Float64(100),\n\t\t\tPriority: pulumi.Float64(1),\n\t\t\tType: pulumi.String(\"vm\"),\n\t\t\tRootVolume: &flexibleengine.CceNodePoolV3RootVolumeArgs{\n\t\t\t\tSize: pulumi.Float64(40),\n\t\t\t\tVolumetype: pulumi.String(\"SAS\"),\n\t\t\t},\n\t\t\tDataVolumes: flexibleengine.CceNodePoolV3DataVolumeArray{\n\t\t\t\t&flexibleengine.CceNodePoolV3DataVolumeArgs{\n\t\t\t\t\tSize: pulumi.Float64(100),\n\t\t\t\t\tVolumetype: pulumi.String(\"SAS\"),\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.flexibleengine.CceNodePoolV3;\nimport com.pulumi.flexibleengine.CceNodePoolV3Args;\nimport com.pulumi.flexibleengine.inputs.CceNodePoolV3RootVolumeArgs;\nimport com.pulumi.flexibleengine.inputs.CceNodePoolV3DataVolumeArgs;\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 final var config = ctx.config();\n final var clusterId = config.get(\"clusterId\");\n final var keyPair = config.get(\"keyPair\");\n final var availabilityZone = config.get(\"availabilityZone\");\n var nodePool = new CceNodePoolV3(\"nodePool\", CceNodePoolV3Args.builder()\n .clusterId(clusterId)\n .os(\"EulerOS 2.5\")\n .initialNodeCount(2)\n .flavorId(\"s3.large.4\")\n .availabilityZone(availabilityZone)\n .keyPair(var_.keypair())\n .scaleEnable(true)\n .minNodeCount(1)\n .maxNodeCount(10)\n .scaleDownCooldownTime(100)\n .priority(1)\n .type(\"vm\")\n .rootVolume(CceNodePoolV3RootVolumeArgs.builder()\n .size(40)\n .volumetype(\"SAS\")\n .build())\n .dataVolumes(CceNodePoolV3DataVolumeArgs.builder()\n .size(100)\n .volumetype(\"SAS\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n clusterId:\n type: dynamic\n keyPair:\n type: dynamic\n availabilityZone:\n type: dynamic\nresources:\n nodePool:\n type: flexibleengine:CceNodePoolV3\n properties:\n clusterId: ${clusterId}\n os: EulerOS 2.5\n initialNodeCount: 2\n flavorId: s3.large.4\n availabilityZone: ${availabilityZone}\n keyPair: ${var.keypair}\n scaleEnable: true\n minNodeCount: 1\n maxNodeCount: 10\n scaleDownCooldownTime: 100\n priority: 1\n type: vm\n rootVolume:\n size: 40\n volumetype: SAS\n dataVolumes:\n - size: 100\n volumetype: SAS\n```\n\n\n## Import\n\nNode_pool can be imported using the cluster ID and node_pool ID, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/cceNodePoolV3:CceNodePoolV3 node_pool_1 /\n```\n\n",
"properties": {
"availabilityZone": {
"type": "string",
"description": "specify the name of the available partition (AZ).\nDefault value is random to create nodes in a random AZ in the node pool.\nChanging this parameter will create a new resource.\n"
},
"billingMode": {
"type": "number",
"description": "Billing mode of a node.\n"
},
"cceNodePoolV3Id": {
"type": "string",
"description": "Specifies a resource ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "ID of the cluster. Changing this parameter will create a new resource.\n"
},
"currentNodeCount": {
"type": "number",
"description": "The current number of the nodes.\n"
},
"dataVolumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3DataVolume:CceNodePoolV3DataVolume"
},
"description": "Represents the data disk to be created.\nThe object structure is documented below. Changing this parameter will create a new resource.\n"
},
"ecsGroupId": {
"type": "string",
"description": "Specifies the ECS group ID. If specified, the node will be created under\nthe cloud server group. Changing this parameter will create a new resource.\n"
},
"extendParam": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"flavorId": {
"type": "string",
"description": "Specifies the flavor id. Changing this parameter will create a new resource.\n"
},
"initialNodeCount": {
"type": "number",
"description": "Specifies the initial number of expected nodes in the node pool.\nThis parameter can be also used to manually scale the node count afterwards.\n"
},
"keyPair": {
"type": "string",
"description": "Key pair name when logging in to select the key pair mode.\nThis parameter and `password` are alternative. Changing this parameter will create a new resource.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Tags of a Kubernetes node, key/value pair format.\n"
},
"maxNodeCount": {
"type": "number",
"description": "Maximum number of nodes allowed if auto scaling is enabled.\n"
},
"maxPods": {
"type": "number",
"description": "The maximum number of instances a node is allowed to create.\nChanging this parameter will create a new resource.\n"
},
"minNodeCount": {
"type": "number",
"description": "Minimum number of nodes allowed if auto scaling is enabled.\n"
},
"name": {
"type": "string",
"description": "Node Pool Name.\n"
},
"os": {
"type": "string",
"description": "Operating System of the node. The value can be EulerOS 2.5 and CentOS 7.6.\nChanging this parameter will create a new resource.\n"
},
"password": {
"type": "string",
"description": "root password when logging in to select the password mode.\nThis parameter must be **salted** and alternative to `key_pair`. Changing this parameter will create a new resource.\n",
"secret": true
},
"postinstall": {
"type": "string",
"description": "Script required after the installation. The input value can be\na Base64 encoded string or not. Changing this parameter will create a new resource.\n"
},
"preinstall": {
"type": "string",
"description": "Script required before installation. The input value can be\na Base64 encoded string or not. Changing this parameter will create a new resource.\n"
},
"priority": {
"type": "number",
"description": "Weight of a node pool. A node pool with a higher weight has a higher priority during scaling.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE node pool resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE node pool resource.\n"
},
"rootVolume": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3RootVolume:CceNodePoolV3RootVolume",
"description": "It corresponds to the system disk related configuration.\nThe object structure is documented below. Changing this parameter will create a new resource.\n"
},
"runtime": {
"type": "string",
"description": "Specifies the runtime of the CCE node pool. Valid values are *docker* and\n*containerd*. Changing this creates a new resource.\n"
},
"scaleDownCooldownTime": {
"type": "number",
"description": "Interval between two scaling operations, in minutes.\n"
},
"scaleEnable": {
"type": "boolean",
"description": "Whether to enable auto scaling. If Autoscaler is enabled, install the autoscaler\nadd-on to use the auto scaling feature.\n"
},
"scallEnable": {
"type": "boolean",
"deprecationMessage": "Deprecated"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the list of custom security group IDs for the node pool.\nIf specified, the nodes will be put in these security groups. When specifying a security group, do not modify\nthe rules of the port on which CCE running depends. Changing this parameter will create a new resource.\n"
},
"status": {
"type": "string",
"description": "Node status information.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the VPC Subnet to which the NIC belongs.\nChanging this parameter will create a new resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Tags of a VM node, key/value pair format.\n"
},
"taints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3Taint:CceNodePoolV3Taint"
},
"description": "You can add taints to created nodes to configure anti-affinity.\nThe object structure is documented below.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3Timeouts:CceNodePoolV3Timeouts"
},
"type": {
"type": "string",
"description": "Node Pool type. Possible values are: \"vm\" and \"ElasticBMS\".\n"
}
},
"type": "object",
"required": [
"billingMode",
"cceNodePoolV3Id",
"clusterId",
"currentNodeCount",
"dataVolumes",
"flavorId",
"initialNodeCount",
"name",
"os",
"region",
"rootVolume",
"runtime",
"scaleEnable",
"scallEnable",
"securityGroups",
"status"
],
"inputProperties": {
"availabilityZone": {
"type": "string",
"description": "specify the name of the available partition (AZ).\nDefault value is random to create nodes in a random AZ in the node pool.\nChanging this parameter will create a new resource.\n"
},
"cceNodePoolV3Id": {
"type": "string",
"description": "Specifies a resource ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "ID of the cluster. Changing this parameter will create a new resource.\n"
},
"dataVolumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3DataVolume:CceNodePoolV3DataVolume"
},
"description": "Represents the data disk to be created.\nThe object structure is documented below. Changing this parameter will create a new resource.\n"
},
"ecsGroupId": {
"type": "string",
"description": "Specifies the ECS group ID. If specified, the node will be created under\nthe cloud server group. Changing this parameter will create a new resource.\n"
},
"extendParam": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"flavorId": {
"type": "string",
"description": "Specifies the flavor id. Changing this parameter will create a new resource.\n"
},
"initialNodeCount": {
"type": "number",
"description": "Specifies the initial number of expected nodes in the node pool.\nThis parameter can be also used to manually scale the node count afterwards.\n"
},
"keyPair": {
"type": "string",
"description": "Key pair name when logging in to select the key pair mode.\nThis parameter and `password` are alternative. Changing this parameter will create a new resource.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Tags of a Kubernetes node, key/value pair format.\n"
},
"maxNodeCount": {
"type": "number",
"description": "Maximum number of nodes allowed if auto scaling is enabled.\n"
},
"maxPods": {
"type": "number",
"description": "The maximum number of instances a node is allowed to create.\nChanging this parameter will create a new resource.\n"
},
"minNodeCount": {
"type": "number",
"description": "Minimum number of nodes allowed if auto scaling is enabled.\n"
},
"name": {
"type": "string",
"description": "Node Pool Name.\n"
},
"os": {
"type": "string",
"description": "Operating System of the node. The value can be EulerOS 2.5 and CentOS 7.6.\nChanging this parameter will create a new resource.\n"
},
"password": {
"type": "string",
"description": "root password when logging in to select the password mode.\nThis parameter must be **salted** and alternative to `key_pair`. Changing this parameter will create a new resource.\n",
"secret": true
},
"postinstall": {
"type": "string",
"description": "Script required after the installation. The input value can be\na Base64 encoded string or not. Changing this parameter will create a new resource.\n"
},
"preinstall": {
"type": "string",
"description": "Script required before installation. The input value can be\na Base64 encoded string or not. Changing this parameter will create a new resource.\n"
},
"priority": {
"type": "number",
"description": "Weight of a node pool. A node pool with a higher weight has a higher priority during scaling.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE node pool resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE node pool resource.\n"
},
"rootVolume": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3RootVolume:CceNodePoolV3RootVolume",
"description": "It corresponds to the system disk related configuration.\nThe object structure is documented below. Changing this parameter will create a new resource.\n"
},
"runtime": {
"type": "string",
"description": "Specifies the runtime of the CCE node pool. Valid values are *docker* and\n*containerd*. Changing this creates a new resource.\n"
},
"scaleDownCooldownTime": {
"type": "number",
"description": "Interval between two scaling operations, in minutes.\n"
},
"scaleEnable": {
"type": "boolean",
"description": "Whether to enable auto scaling. If Autoscaler is enabled, install the autoscaler\nadd-on to use the auto scaling feature.\n"
},
"scallEnable": {
"type": "boolean",
"deprecationMessage": "Deprecated"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the list of custom security group IDs for the node pool.\nIf specified, the nodes will be put in these security groups. When specifying a security group, do not modify\nthe rules of the port on which CCE running depends. Changing this parameter will create a new resource.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the VPC Subnet to which the NIC belongs.\nChanging this parameter will create a new resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Tags of a VM node, key/value pair format.\n"
},
"taints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3Taint:CceNodePoolV3Taint"
},
"description": "You can add taints to created nodes to configure anti-affinity.\nThe object structure is documented below.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3Timeouts:CceNodePoolV3Timeouts"
},
"type": {
"type": "string",
"description": "Node Pool type. Possible values are: \"vm\" and \"ElasticBMS\".\n"
}
},
"requiredInputs": [
"clusterId",
"dataVolumes",
"flavorId",
"initialNodeCount",
"rootVolume"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CceNodePoolV3 resources.\n",
"properties": {
"availabilityZone": {
"type": "string",
"description": "specify the name of the available partition (AZ).\nDefault value is random to create nodes in a random AZ in the node pool.\nChanging this parameter will create a new resource.\n"
},
"billingMode": {
"type": "number",
"description": "Billing mode of a node.\n"
},
"cceNodePoolV3Id": {
"type": "string",
"description": "Specifies a resource ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "ID of the cluster. Changing this parameter will create a new resource.\n"
},
"currentNodeCount": {
"type": "number",
"description": "The current number of the nodes.\n"
},
"dataVolumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3DataVolume:CceNodePoolV3DataVolume"
},
"description": "Represents the data disk to be created.\nThe object structure is documented below. Changing this parameter will create a new resource.\n"
},
"ecsGroupId": {
"type": "string",
"description": "Specifies the ECS group ID. If specified, the node will be created under\nthe cloud server group. Changing this parameter will create a new resource.\n"
},
"extendParam": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"flavorId": {
"type": "string",
"description": "Specifies the flavor id. Changing this parameter will create a new resource.\n"
},
"initialNodeCount": {
"type": "number",
"description": "Specifies the initial number of expected nodes in the node pool.\nThis parameter can be also used to manually scale the node count afterwards.\n"
},
"keyPair": {
"type": "string",
"description": "Key pair name when logging in to select the key pair mode.\nThis parameter and `password` are alternative. Changing this parameter will create a new resource.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Tags of a Kubernetes node, key/value pair format.\n"
},
"maxNodeCount": {
"type": "number",
"description": "Maximum number of nodes allowed if auto scaling is enabled.\n"
},
"maxPods": {
"type": "number",
"description": "The maximum number of instances a node is allowed to create.\nChanging this parameter will create a new resource.\n"
},
"minNodeCount": {
"type": "number",
"description": "Minimum number of nodes allowed if auto scaling is enabled.\n"
},
"name": {
"type": "string",
"description": "Node Pool Name.\n"
},
"os": {
"type": "string",
"description": "Operating System of the node. The value can be EulerOS 2.5 and CentOS 7.6.\nChanging this parameter will create a new resource.\n"
},
"password": {
"type": "string",
"description": "root password when logging in to select the password mode.\nThis parameter must be **salted** and alternative to `key_pair`. Changing this parameter will create a new resource.\n",
"secret": true
},
"postinstall": {
"type": "string",
"description": "Script required after the installation. The input value can be\na Base64 encoded string or not. Changing this parameter will create a new resource.\n"
},
"preinstall": {
"type": "string",
"description": "Script required before installation. The input value can be\na Base64 encoded string or not. Changing this parameter will create a new resource.\n"
},
"priority": {
"type": "number",
"description": "Weight of a node pool. A node pool with a higher weight has a higher priority during scaling.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE node pool resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE node pool resource.\n"
},
"rootVolume": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3RootVolume:CceNodePoolV3RootVolume",
"description": "It corresponds to the system disk related configuration.\nThe object structure is documented below. Changing this parameter will create a new resource.\n"
},
"runtime": {
"type": "string",
"description": "Specifies the runtime of the CCE node pool. Valid values are *docker* and\n*containerd*. Changing this creates a new resource.\n"
},
"scaleDownCooldownTime": {
"type": "number",
"description": "Interval between two scaling operations, in minutes.\n"
},
"scaleEnable": {
"type": "boolean",
"description": "Whether to enable auto scaling. If Autoscaler is enabled, install the autoscaler\nadd-on to use the auto scaling feature.\n"
},
"scallEnable": {
"type": "boolean",
"deprecationMessage": "Deprecated"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the list of custom security group IDs for the node pool.\nIf specified, the nodes will be put in these security groups. When specifying a security group, do not modify\nthe rules of the port on which CCE running depends. Changing this parameter will create a new resource.\n"
},
"status": {
"type": "string",
"description": "Node status information.\n"
},
"subnetId": {
"type": "string",
"description": "The ID of the VPC Subnet to which the NIC belongs.\nChanging this parameter will create a new resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Tags of a VM node, key/value pair format.\n"
},
"taints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3Taint:CceNodePoolV3Taint"
},
"description": "You can add taints to created nodes to configure anti-affinity.\nThe object structure is documented below.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceNodePoolV3Timeouts:CceNodePoolV3Timeouts"
},
"type": {
"type": "string",
"description": "Node Pool type. Possible values are: \"vm\" and \"ElasticBMS\".\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cceNodeV3:CceNodeV3": {
"description": "Add a node to a container cluster.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst clusterId = config.requireObject(\"clusterId\");\nconst sshKey = config.requireObject(\"sshKey\");\nconst availabilityZone = config.requireObject(\"availabilityZone\");\nconst node1 = new flexibleengine.CceNodeV3(\"node1\", {\n clusterId: clusterId,\n flavorId: \"s1.medium\",\n availabilityZone: availabilityZone,\n keyPair: sshKey,\n iptype: \"5_bgp\",\n sharetype: \"PER\",\n bandwidthSize: 100,\n rootVolume: {\n size: 40,\n volumetype: \"SATA\",\n },\n dataVolumes: [{\n size: 100,\n volumetype: \"SATA\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ncluster_id = config.require_object(\"clusterId\")\nssh_key = config.require_object(\"sshKey\")\navailability_zone = config.require_object(\"availabilityZone\")\nnode1 = flexibleengine.CceNodeV3(\"node1\",\n cluster_id=cluster_id,\n flavor_id=\"s1.medium\",\n availability_zone=availability_zone,\n key_pair=ssh_key,\n iptype=\"5_bgp\",\n sharetype=\"PER\",\n bandwidth_size=100,\n root_volume={\n \"size\": 40,\n \"volumetype\": \"SATA\",\n },\n data_volumes=[{\n \"size\": 100,\n \"volumetype\": \"SATA\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var clusterId = config.RequireObject(\"clusterId\");\n var sshKey = config.RequireObject(\"sshKey\");\n var availabilityZone = config.RequireObject(\"availabilityZone\");\n var node1 = new Flexibleengine.CceNodeV3(\"node1\", new()\n {\n ClusterId = clusterId,\n FlavorId = \"s1.medium\",\n AvailabilityZone = availabilityZone,\n KeyPair = sshKey,\n Iptype = \"5_bgp\",\n Sharetype = \"PER\",\n BandwidthSize = 100,\n RootVolume = new Flexibleengine.Inputs.CceNodeV3RootVolumeArgs\n {\n Size = 40,\n Volumetype = \"SATA\",\n },\n DataVolumes = new[]\n {\n new Flexibleengine.Inputs.CceNodeV3DataVolumeArgs\n {\n Size = 100,\n Volumetype = \"SATA\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tclusterId := cfg.RequireObject(\"clusterId\")\n\t\tsshKey := cfg.RequireObject(\"sshKey\")\n\t\tavailabilityZone := cfg.RequireObject(\"availabilityZone\")\n\t\t_, err := flexibleengine.NewCceNodeV3(ctx, \"node1\", &flexibleengine.CceNodeV3Args{\n\t\t\tClusterId: pulumi.Any(clusterId),\n\t\t\tFlavorId: pulumi.String(\"s1.medium\"),\n\t\t\tAvailabilityZone: pulumi.Any(availabilityZone),\n\t\t\tKeyPair: pulumi.Any(sshKey),\n\t\t\tIptype: pulumi.String(\"5_bgp\"),\n\t\t\tSharetype: pulumi.String(\"PER\"),\n\t\t\tBandwidthSize: pulumi.Float64(100),\n\t\t\tRootVolume: &flexibleengine.CceNodeV3RootVolumeArgs{\n\t\t\t\tSize: pulumi.Float64(40),\n\t\t\t\tVolumetype: pulumi.String(\"SATA\"),\n\t\t\t},\n\t\t\tDataVolumes: flexibleengine.CceNodeV3DataVolumeArray{\n\t\t\t\t&flexibleengine.CceNodeV3DataVolumeArgs{\n\t\t\t\t\tSize: pulumi.Float64(100),\n\t\t\t\t\tVolumetype: pulumi.String(\"SATA\"),\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.flexibleengine.CceNodeV3;\nimport com.pulumi.flexibleengine.CceNodeV3Args;\nimport com.pulumi.flexibleengine.inputs.CceNodeV3RootVolumeArgs;\nimport com.pulumi.flexibleengine.inputs.CceNodeV3DataVolumeArgs;\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 final var config = ctx.config();\n final var clusterId = config.get(\"clusterId\");\n final var sshKey = config.get(\"sshKey\");\n final var availabilityZone = config.get(\"availabilityZone\");\n var node1 = new CceNodeV3(\"node1\", CceNodeV3Args.builder()\n .clusterId(clusterId)\n .flavorId(\"s1.medium\")\n .availabilityZone(availabilityZone)\n .keyPair(sshKey)\n .iptype(\"5_bgp\")\n .sharetype(\"PER\")\n .bandwidthSize(100)\n .rootVolume(CceNodeV3RootVolumeArgs.builder()\n .size(40)\n .volumetype(\"SATA\")\n .build())\n .dataVolumes(CceNodeV3DataVolumeArgs.builder()\n .size(100)\n .volumetype(\"SATA\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n clusterId:\n type: dynamic\n sshKey:\n type: dynamic\n availabilityZone:\n type: dynamic\nresources:\n node1:\n type: flexibleengine:CceNodeV3\n properties:\n clusterId: ${clusterId}\n flavorId: s1.medium\n availabilityZone: ${availabilityZone}\n keyPair: ${sshKey}\n iptype: 5_bgp\n sharetype: PER\n bandwidthSize: 100\n rootVolume:\n size: 40\n volumetype: SATA\n dataVolumes:\n - size: 100\n volumetype: SATA\n```\n\n\n## Import\n\nCCE node can be imported using the `cluster_id` and the `id` of the node separated by `/`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/cceNodeV3:CceNodeV3 node_1 1c4a7f7c-5b8f-11e8-9c2d-525400bd8000/1c4a7f7c-5b8f-11e8-9c2d-525400bd8000\n```\n\n",
"properties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Node annotation, key/value pair format. Changing this parameter will\ncreate a new resource.\n"
},
"availabilityZone": {
"type": "string",
"description": "specify the name of the available partition (AZ).\nChanging this parameter will create a new resource.\n"
},
"bandwidthChargeMode": {
"type": "string",
"description": "Bandwidth billing type. Changing this parameter will create a\nnew resource.\n"
},
"bandwidthSize": {
"type": "number",
"description": "Bandwidth size. Changing this parameter will create a new resource.\n"
},
"billingMode": {
"type": "number",
"deprecationMessage": "Deprecated"
},
"cceNodeV3Id": {
"type": "string",
"description": "The resource ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "ID of the cluster. Changing this parameter will create a new resource.\n"
},
"dataVolumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3DataVolume:CceNodeV3DataVolume"
},
"description": "Represents the data disk to be created.\nChanging this parameter will create a new resource.\n"
},
"ecsGroupId": {
"type": "string",
"description": "Specifies the ECS group ID. If specified, the node will be created under\nthe cloud server group. Changing this parameter will create a new resource.\n"
},
"ecsPerformanceType": {
"type": "string",
"description": "Classification of cloud server specifications.\nChanging this parameter will create a new resource.\n"
},
"eipCount": {
"type": "number",
"description": "Number of elastic IPs to be dynamically created. Changing this parameter\nwill create a new resource.\n"
},
"eipIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of existing elastic IP IDs. Changing this parameter will create a new\nresource.\n\n> If the `eip_ids` parameter is configured, you do not need to configure the `eip_count` and bandwidth parameters:\n`iptype`, `bandwidth_charge_mode`, `bandwidth_size` and `share_type`.\n"
},
"extendParam": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Extended parameter. Changing this parameter will create a new resource.\nAvailiable keys:\n"
},
"extendParamChargingMode": {
"type": "number",
"deprecationMessage": "Deprecated"
},
"flavorId": {
"type": "string",
"description": "Specifies the flavor id.Changing this parameter will create a new resource.\n"
},
"iptype": {
"type": "string",
"description": "Elastic IP type. Changing this parameter will create a new resource.\n"
},
"keyPair": {
"type": "string",
"description": "Key pair name when logging in to select the key pair mode.\nChanging this parameter will create a new resource.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Tags of a Kubernetes node, key/value pair format. Changing this parameter will\ncreate a new resource.\n"
},
"maxPods": {
"type": "number",
"description": "The maximum number of instances a node is allowed to create.\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Node Name.\n"
},
"orderId": {
"type": "string",
"deprecationMessage": "Deprecated"
},
"os": {
"type": "string",
"description": "Operating System of the node, possible values are EulerOS 2.2 and CentOS 7.6.\nDefaults to EulerOS 2.2. Changing this parameter will create a new resource.\n"
},
"postinstall": {
"type": "string",
"description": "Script required after installation. The input value can be a Base64\nencoded string or not. Changing this parameter will create a new resource.\n"
},
"preinstall": {
"type": "string",
"description": "Script required before installation. The input value can be a Base64\nencoded string or not. Changing this parameter will create a new resource.\n"
},
"privateIp": {
"type": "string",
"description": "Private IP of the CCE node.\n"
},
"productId": {
"type": "string",
"description": "The Product ID. Changing this parameter will create a new resource.\n"
},
"publicIp": {
"type": "string",
"description": "Public IP of the CCE node.\n"
},
"publicKey": {
"type": "string",
"description": "The Public key. Changing this parameter will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE node resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE node resource.\n"
},
"rootVolume": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3RootVolume:CceNodeV3RootVolume",
"description": "It corresponds to the system disk related configuration.\nChanging this parameter will create a new resource.\n"
},
"runtime": {
"type": "string",
"description": "Specifies the runtime of the CCE node. Valid values are *docker* and\n*containerd*. Changing this creates a new resource.\n"
},
"serverId": {
"type": "string",
"description": "ID of the ECS instance associated with the node.\n"
},
"sharetype": {
"type": "string",
"description": "Bandwidth sharing type. Changing this parameter will create a new resource.\n"
},
"status": {
"type": "string",
"description": "Node status information.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet to which the NIC belongs.\nChanging this parameter will create a new resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "VM tag, key/value pair format.\n"
},
"taints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3Taint:CceNodeV3Taint"
},
"description": "You can add taints to created nodes to configure anti-affinity.\nChanging this parameter will create a new resource.\nEach taint contains the following parameters:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3Timeouts:CceNodeV3Timeouts"
}
},
"type": "object",
"required": [
"availabilityZone",
"bandwidthChargeMode",
"bandwidthSize",
"cceNodeV3Id",
"clusterId",
"dataVolumes",
"ecsGroupId",
"ecsPerformanceType",
"eipCount",
"eipIds",
"flavorId",
"iptype",
"keyPair",
"maxPods",
"name",
"os",
"privateIp",
"productId",
"publicIp",
"publicKey",
"region",
"rootVolume",
"runtime",
"serverId",
"sharetype",
"status",
"subnetId"
],
"inputProperties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Node annotation, key/value pair format. Changing this parameter will\ncreate a new resource.\n"
},
"availabilityZone": {
"type": "string",
"description": "specify the name of the available partition (AZ).\nChanging this parameter will create a new resource.\n"
},
"bandwidthChargeMode": {
"type": "string",
"description": "Bandwidth billing type. Changing this parameter will create a\nnew resource.\n"
},
"bandwidthSize": {
"type": "number",
"description": "Bandwidth size. Changing this parameter will create a new resource.\n"
},
"billingMode": {
"type": "number",
"deprecationMessage": "Deprecated"
},
"cceNodeV3Id": {
"type": "string",
"description": "The resource ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "ID of the cluster. Changing this parameter will create a new resource.\n"
},
"dataVolumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3DataVolume:CceNodeV3DataVolume"
},
"description": "Represents the data disk to be created.\nChanging this parameter will create a new resource.\n"
},
"ecsGroupId": {
"type": "string",
"description": "Specifies the ECS group ID. If specified, the node will be created under\nthe cloud server group. Changing this parameter will create a new resource.\n"
},
"ecsPerformanceType": {
"type": "string",
"description": "Classification of cloud server specifications.\nChanging this parameter will create a new resource.\n"
},
"eipCount": {
"type": "number",
"description": "Number of elastic IPs to be dynamically created. Changing this parameter\nwill create a new resource.\n"
},
"eipIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of existing elastic IP IDs. Changing this parameter will create a new\nresource.\n\n> If the `eip_ids` parameter is configured, you do not need to configure the `eip_count` and bandwidth parameters:\n`iptype`, `bandwidth_charge_mode`, `bandwidth_size` and `share_type`.\n"
},
"extendParam": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Extended parameter. Changing this parameter will create a new resource.\nAvailiable keys:\n"
},
"extendParamChargingMode": {
"type": "number",
"deprecationMessage": "Deprecated"
},
"flavorId": {
"type": "string",
"description": "Specifies the flavor id.Changing this parameter will create a new resource.\n"
},
"iptype": {
"type": "string",
"description": "Elastic IP type. Changing this parameter will create a new resource.\n"
},
"keyPair": {
"type": "string",
"description": "Key pair name when logging in to select the key pair mode.\nChanging this parameter will create a new resource.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Tags of a Kubernetes node, key/value pair format. Changing this parameter will\ncreate a new resource.\n"
},
"maxPods": {
"type": "number",
"description": "The maximum number of instances a node is allowed to create.\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Node Name.\n"
},
"orderId": {
"type": "string",
"deprecationMessage": "Deprecated"
},
"os": {
"type": "string",
"description": "Operating System of the node, possible values are EulerOS 2.2 and CentOS 7.6.\nDefaults to EulerOS 2.2. Changing this parameter will create a new resource.\n"
},
"postinstall": {
"type": "string",
"description": "Script required after installation. The input value can be a Base64\nencoded string or not. Changing this parameter will create a new resource.\n"
},
"preinstall": {
"type": "string",
"description": "Script required before installation. The input value can be a Base64\nencoded string or not. Changing this parameter will create a new resource.\n"
},
"productId": {
"type": "string",
"description": "The Product ID. Changing this parameter will create a new resource.\n"
},
"publicKey": {
"type": "string",
"description": "The Public key. Changing this parameter will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE node resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE node resource.\n"
},
"rootVolume": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3RootVolume:CceNodeV3RootVolume",
"description": "It corresponds to the system disk related configuration.\nChanging this parameter will create a new resource.\n"
},
"runtime": {
"type": "string",
"description": "Specifies the runtime of the CCE node. Valid values are *docker* and\n*containerd*. Changing this creates a new resource.\n"
},
"sharetype": {
"type": "string",
"description": "Bandwidth sharing type. Changing this parameter will create a new resource.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet to which the NIC belongs.\nChanging this parameter will create a new resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "VM tag, key/value pair format.\n"
},
"taints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3Taint:CceNodeV3Taint"
},
"description": "You can add taints to created nodes to configure anti-affinity.\nChanging this parameter will create a new resource.\nEach taint contains the following parameters:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3Timeouts:CceNodeV3Timeouts"
}
},
"requiredInputs": [
"availabilityZone",
"clusterId",
"dataVolumes",
"flavorId",
"keyPair",
"rootVolume"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CceNodeV3 resources.\n",
"properties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Node annotation, key/value pair format. Changing this parameter will\ncreate a new resource.\n"
},
"availabilityZone": {
"type": "string",
"description": "specify the name of the available partition (AZ).\nChanging this parameter will create a new resource.\n"
},
"bandwidthChargeMode": {
"type": "string",
"description": "Bandwidth billing type. Changing this parameter will create a\nnew resource.\n"
},
"bandwidthSize": {
"type": "number",
"description": "Bandwidth size. Changing this parameter will create a new resource.\n"
},
"billingMode": {
"type": "number",
"deprecationMessage": "Deprecated"
},
"cceNodeV3Id": {
"type": "string",
"description": "The resource ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "ID of the cluster. Changing this parameter will create a new resource.\n"
},
"dataVolumes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3DataVolume:CceNodeV3DataVolume"
},
"description": "Represents the data disk to be created.\nChanging this parameter will create a new resource.\n"
},
"ecsGroupId": {
"type": "string",
"description": "Specifies the ECS group ID. If specified, the node will be created under\nthe cloud server group. Changing this parameter will create a new resource.\n"
},
"ecsPerformanceType": {
"type": "string",
"description": "Classification of cloud server specifications.\nChanging this parameter will create a new resource.\n"
},
"eipCount": {
"type": "number",
"description": "Number of elastic IPs to be dynamically created. Changing this parameter\nwill create a new resource.\n"
},
"eipIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of existing elastic IP IDs. Changing this parameter will create a new\nresource.\n\n> If the `eip_ids` parameter is configured, you do not need to configure the `eip_count` and bandwidth parameters:\n`iptype`, `bandwidth_charge_mode`, `bandwidth_size` and `share_type`.\n"
},
"extendParam": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Extended parameter. Changing this parameter will create a new resource.\nAvailiable keys:\n"
},
"extendParamChargingMode": {
"type": "number",
"deprecationMessage": "Deprecated"
},
"flavorId": {
"type": "string",
"description": "Specifies the flavor id.Changing this parameter will create a new resource.\n"
},
"iptype": {
"type": "string",
"description": "Elastic IP type. Changing this parameter will create a new resource.\n"
},
"keyPair": {
"type": "string",
"description": "Key pair name when logging in to select the key pair mode.\nChanging this parameter will create a new resource.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Tags of a Kubernetes node, key/value pair format. Changing this parameter will\ncreate a new resource.\n"
},
"maxPods": {
"type": "number",
"description": "The maximum number of instances a node is allowed to create.\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Node Name.\n"
},
"orderId": {
"type": "string",
"deprecationMessage": "Deprecated"
},
"os": {
"type": "string",
"description": "Operating System of the node, possible values are EulerOS 2.2 and CentOS 7.6.\nDefaults to EulerOS 2.2. Changing this parameter will create a new resource.\n"
},
"postinstall": {
"type": "string",
"description": "Script required after installation. The input value can be a Base64\nencoded string or not. Changing this parameter will create a new resource.\n"
},
"preinstall": {
"type": "string",
"description": "Script required before installation. The input value can be a Base64\nencoded string or not. Changing this parameter will create a new resource.\n"
},
"privateIp": {
"type": "string",
"description": "Private IP of the CCE node.\n"
},
"productId": {
"type": "string",
"description": "The Product ID. Changing this parameter will create a new resource.\n"
},
"publicIp": {
"type": "string",
"description": "Public IP of the CCE node.\n"
},
"publicKey": {
"type": "string",
"description": "The Public key. Changing this parameter will create a new resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CCE node resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CCE node resource.\n"
},
"rootVolume": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3RootVolume:CceNodeV3RootVolume",
"description": "It corresponds to the system disk related configuration.\nChanging this parameter will create a new resource.\n"
},
"runtime": {
"type": "string",
"description": "Specifies the runtime of the CCE node. Valid values are *docker* and\n*containerd*. Changing this creates a new resource.\n"
},
"serverId": {
"type": "string",
"description": "ID of the ECS instance associated with the node.\n"
},
"sharetype": {
"type": "string",
"description": "Bandwidth sharing type. Changing this parameter will create a new resource.\n"
},
"status": {
"type": "string",
"description": "Node status information.\n"
},
"subnetId": {
"type": "string",
"description": "Specifies the ID of the VPC Subnet to which the NIC belongs.\nChanging this parameter will create a new resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "VM tag, key/value pair format.\n"
},
"taints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3Taint:CceNodeV3Taint"
},
"description": "You can add taints to created nodes to configure anti-affinity.\nChanging this parameter will create a new resource.\nEach taint contains the following parameters:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCceNodeV3Timeouts:CceNodeV3Timeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/ccePvc:CcePvc": {
"description": "Manages a CCE Persistent Volume Claim resource within FlexibleEngine.\n\n> **NOTE:** Currently, there is an ongoing certificate issue regarding the PVC management APIs.\n Please set `insecure = true` in provider block to ignore SSL certificate verification.\n\n## Example Usage\n\n### Create PVC with EVS\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst clusterId = config.requireObject(\"clusterId\");\nconst namespace = config.requireObject(\"namespace\");\nconst pvcName = config.requireObject(\"pvcName\");\nconst test = new flexibleengine.CcePvc(\"test\", {\n clusterId: clusterId,\n namespace: namespace,\n annotations: {\n \"everest.io/disk-volume-type\": \"SSD\",\n },\n storageClassName: \"csi-disk\",\n accessModes: [\"ReadWriteOnce\"],\n storage: \"10Gi\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ncluster_id = config.require_object(\"clusterId\")\nnamespace = config.require_object(\"namespace\")\npvc_name = config.require_object(\"pvcName\")\ntest = flexibleengine.CcePvc(\"test\",\n cluster_id=cluster_id,\n namespace=namespace,\n annotations={\n \"everest.io/disk-volume-type\": \"SSD\",\n },\n storage_class_name=\"csi-disk\",\n access_modes=[\"ReadWriteOnce\"],\n storage=\"10Gi\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var clusterId = config.RequireObject(\"clusterId\");\n var @namespace = config.RequireObject(\"namespace\");\n var pvcName = config.RequireObject(\"pvcName\");\n var test = new Flexibleengine.CcePvc(\"test\", new()\n {\n ClusterId = clusterId,\n Namespace = @namespace,\n Annotations = \n {\n { \"everest.io/disk-volume-type\", \"SSD\" },\n },\n StorageClassName = \"csi-disk\",\n AccessModes = new[]\n {\n \"ReadWriteOnce\",\n },\n Storage = \"10Gi\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tclusterId := cfg.RequireObject(\"clusterId\")\n\t\tnamespace := cfg.RequireObject(\"namespace\")\n\t\tpvcName := cfg.RequireObject(\"pvcName\")\n\t\t_, err := flexibleengine.NewCcePvc(ctx, \"test\", &flexibleengine.CcePvcArgs{\n\t\t\tClusterId: pulumi.Any(clusterId),\n\t\t\tNamespace: pulumi.Any(namespace),\n\t\t\tAnnotations: pulumi.StringMap{\n\t\t\t\t\"everest.io/disk-volume-type\": pulumi.String(\"SSD\"),\n\t\t\t},\n\t\t\tStorageClassName: pulumi.String(\"csi-disk\"),\n\t\t\tAccessModes: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"ReadWriteOnce\"),\n\t\t\t},\n\t\t\tStorage: pulumi.String(\"10Gi\"),\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.flexibleengine.CcePvc;\nimport com.pulumi.flexibleengine.CcePvcArgs;\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 final var config = ctx.config();\n final var clusterId = config.get(\"clusterId\");\n final var namespace = config.get(\"namespace\");\n final var pvcName = config.get(\"pvcName\");\n var test = new CcePvc(\"test\", CcePvcArgs.builder()\n .clusterId(clusterId)\n .namespace(namespace)\n .annotations(Map.of(\"everest.io/disk-volume-type\", \"SSD\"))\n .storageClassName(\"csi-disk\")\n .accessModes(\"ReadWriteOnce\")\n .storage(\"10Gi\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n clusterId:\n type: dynamic\n namespace:\n type: dynamic\n pvcName:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CcePvc\n properties:\n clusterId: ${clusterId}\n namespace: ${namespace}\n annotations:\n everest.io/disk-volume-type: SSD\n storageClassName: csi-disk\n accessModes:\n - ReadWriteOnce\n storage: 10Gi\n```\n\n\n### Create PVC with OBS\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst clusterId = config.requireObject(\"clusterId\");\nconst namespace = config.requireObject(\"namespace\");\nconst pvcName = config.requireObject(\"pvcName\");\nconst test = new flexibleengine.CcePvc(\"test\", {\n clusterId: clusterId,\n namespace: namespace,\n annotations: {\n \"everest.io/obs-volume-type\": \"STANDARD\",\n \"csi.storage.k8s.io/fstype\": \"obsfs\",\n },\n storageClassName: \"csi-obs\",\n accessModes: [\"ReadWriteMany\"],\n storage: \"1Gi\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ncluster_id = config.require_object(\"clusterId\")\nnamespace = config.require_object(\"namespace\")\npvc_name = config.require_object(\"pvcName\")\ntest = flexibleengine.CcePvc(\"test\",\n cluster_id=cluster_id,\n namespace=namespace,\n annotations={\n \"everest.io/obs-volume-type\": \"STANDARD\",\n \"csi.storage.k8s.io/fstype\": \"obsfs\",\n },\n storage_class_name=\"csi-obs\",\n access_modes=[\"ReadWriteMany\"],\n storage=\"1Gi\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var clusterId = config.RequireObject(\"clusterId\");\n var @namespace = config.RequireObject(\"namespace\");\n var pvcName = config.RequireObject(\"pvcName\");\n var test = new Flexibleengine.CcePvc(\"test\", new()\n {\n ClusterId = clusterId,\n Namespace = @namespace,\n Annotations = \n {\n { \"everest.io/obs-volume-type\", \"STANDARD\" },\n { \"csi.storage.k8s.io/fstype\", \"obsfs\" },\n },\n StorageClassName = \"csi-obs\",\n AccessModes = new[]\n {\n \"ReadWriteMany\",\n },\n Storage = \"1Gi\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tclusterId := cfg.RequireObject(\"clusterId\")\n\t\tnamespace := cfg.RequireObject(\"namespace\")\n\t\tpvcName := cfg.RequireObject(\"pvcName\")\n\t\t_, err := flexibleengine.NewCcePvc(ctx, \"test\", &flexibleengine.CcePvcArgs{\n\t\t\tClusterId: pulumi.Any(clusterId),\n\t\t\tNamespace: pulumi.Any(namespace),\n\t\t\tAnnotations: pulumi.StringMap{\n\t\t\t\t\"everest.io/obs-volume-type\": pulumi.String(\"STANDARD\"),\n\t\t\t\t\"csi.storage.k8s.io/fstype\": pulumi.String(\"obsfs\"),\n\t\t\t},\n\t\t\tStorageClassName: pulumi.String(\"csi-obs\"),\n\t\t\tAccessModes: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"ReadWriteMany\"),\n\t\t\t},\n\t\t\tStorage: pulumi.String(\"1Gi\"),\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.flexibleengine.CcePvc;\nimport com.pulumi.flexibleengine.CcePvcArgs;\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 final var config = ctx.config();\n final var clusterId = config.get(\"clusterId\");\n final var namespace = config.get(\"namespace\");\n final var pvcName = config.get(\"pvcName\");\n var test = new CcePvc(\"test\", CcePvcArgs.builder()\n .clusterId(clusterId)\n .namespace(namespace)\n .annotations(Map.ofEntries(\n Map.entry(\"everest.io/obs-volume-type\", \"STANDARD\"),\n Map.entry(\"csi.storage.k8s.io/fstype\", \"obsfs\")\n ))\n .storageClassName(\"csi-obs\")\n .accessModes(\"ReadWriteMany\")\n .storage(\"1Gi\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n clusterId:\n type: dynamic\n namespace:\n type: dynamic\n pvcName:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CcePvc\n properties:\n clusterId: ${clusterId}\n namespace: ${namespace}\n annotations:\n everest.io/obs-volume-type: STANDARD\n csi.storage.k8s.io/fstype: obsfs\n storageClassName: csi-obs\n accessModes:\n - ReadWriteMany\n storage: 1Gi\n```\n\n\n### Create PVC with SFS\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst clusterId = config.requireObject(\"clusterId\");\nconst namespace = config.requireObject(\"namespace\");\nconst pvcName = config.requireObject(\"pvcName\");\nconst test = new flexibleengine.CcePvc(\"test\", {\n clusterId: clusterId,\n namespace: namespace,\n storageClassName: \"csi-nas\",\n accessModes: [\"ReadWriteMany\"],\n storage: \"10Gi\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\ncluster_id = config.require_object(\"clusterId\")\nnamespace = config.require_object(\"namespace\")\npvc_name = config.require_object(\"pvcName\")\ntest = flexibleengine.CcePvc(\"test\",\n cluster_id=cluster_id,\n namespace=namespace,\n storage_class_name=\"csi-nas\",\n access_modes=[\"ReadWriteMany\"],\n storage=\"10Gi\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var clusterId = config.RequireObject(\"clusterId\");\n var @namespace = config.RequireObject(\"namespace\");\n var pvcName = config.RequireObject(\"pvcName\");\n var test = new Flexibleengine.CcePvc(\"test\", new()\n {\n ClusterId = clusterId,\n Namespace = @namespace,\n StorageClassName = \"csi-nas\",\n AccessModes = new[]\n {\n \"ReadWriteMany\",\n },\n Storage = \"10Gi\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tclusterId := cfg.RequireObject(\"clusterId\")\n\t\tnamespace := cfg.RequireObject(\"namespace\")\n\t\tpvcName := cfg.RequireObject(\"pvcName\")\n\t\t_, err := flexibleengine.NewCcePvc(ctx, \"test\", &flexibleengine.CcePvcArgs{\n\t\t\tClusterId: pulumi.Any(clusterId),\n\t\t\tNamespace: pulumi.Any(namespace),\n\t\t\tStorageClassName: pulumi.String(\"csi-nas\"),\n\t\t\tAccessModes: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"ReadWriteMany\"),\n\t\t\t},\n\t\t\tStorage: pulumi.String(\"10Gi\"),\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.flexibleengine.CcePvc;\nimport com.pulumi.flexibleengine.CcePvcArgs;\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 final var config = ctx.config();\n final var clusterId = config.get(\"clusterId\");\n final var namespace = config.get(\"namespace\");\n final var pvcName = config.get(\"pvcName\");\n var test = new CcePvc(\"test\", CcePvcArgs.builder()\n .clusterId(clusterId)\n .namespace(namespace)\n .storageClassName(\"csi-nas\")\n .accessModes(\"ReadWriteMany\")\n .storage(\"10Gi\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n clusterId:\n type: dynamic\n namespace:\n type: dynamic\n pvcName:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CcePvc\n properties:\n clusterId: ${clusterId}\n namespace: ${namespace}\n storageClassName: csi-nas\n accessModes:\n - ReadWriteMany\n storage: 10Gi\n```\n\n\n## Import\n\nCCE PVC can be imported using the cluster ID, namespace name and PVC ID separated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/ccePvc:CcePvc test //\n```\n\n```sh\n$ pulumi import flexibleengine:index/ccePvc:CcePvc test 5c20fdad-7288-11eb-b817-0255ac10158b/default/fa540f3b-12d9-40e5-8268-04bcfed95a46\n```\n\nNote that the imported state may not be identical to your resource definition, due to some attributes missing from the\n\nAPI response, security or some other reason. The missing attributes include: `annotations`.\n\nIt is generally recommended running `pulumi preview` after importing a PVC.\n\nYou can then decide if changes should be applied to the PVC, or the resource\n\ndefinition should be updated to align with the PVC. Also you can ignore changes as below.\n\nhcl\n\nresource \"flexibleengine_cce_pvc\" \"test\" {\n\n ...\n\n lifecycle {\n\n ignore_changes = [\n\n annotations,\n\n ]\n\n }\n\n}\n\n",
"properties": {
"accessModes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the desired access modes the volume should have.\nThe valid values are as follows:\n+ **ReadWriteOnce**: The volume can be mounted as read-write by a single node.\n+ **ReadOnlyMany**: The volume can be mounted as read-only by many nodes.\n+ **ReadWriteMany**: The volume can be mounted as read-write by many nodes.\n"
},
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the unstructured key value map for external parameters.\nChanging this will create a new PVC resource.\n"
},
"ccePvcId": {
"type": "string",
"description": "The PVC ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "Specifies the cluster ID to which the CCE PVC belongs.\n"
},
"creationTimestamp": {
"type": "string",
"description": "The server time when PVC was created.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the map of string keys and values for labels.\nChanging this will create a new PVC resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the unique name of the PVC resource. This parameter can contain a\nmaximum of 63 characters, which may consist of lowercase letters, digits and hyphens (-), and must start and end with\nlowercase letters and digits. Changing this will create a new PVC resource.\n"
},
"namespace": {
"type": "string",
"description": "Specifies the namespace to logically divide your containers into different\ngroup. Changing this will create a new PVC resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the PVC resource.\nIf omitted, the provider-level region will be used. Changing this will create a new PVC resource.\n"
},
"status": {
"type": "string",
"description": "The current phase of the PVC.\n+ **Pending**: Not yet bound.\n+ **Bound**: Already bound.\n"
},
"storage": {
"type": "string",
"description": "Specifies the minimum amount of storage resources required.\nChanging this creates a new PVC resource.\n"
},
"storageClassName": {
"type": "string",
"description": "Specifies the type of the storage bound to the CCE PVC.\nThe valid values are as follows:\n+ **csi-disk**: EVS.\n+ **csi-obs**: OBS.\n+ **csi-nas**: SFS.\n+ **csi-sfsturbo**: SFS-Turbo.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCcePvcTimeouts:CcePvcTimeouts"
}
},
"type": "object",
"required": [
"accessModes",
"ccePvcId",
"clusterId",
"creationTimestamp",
"name",
"namespace",
"region",
"status",
"storage",
"storageClassName"
],
"inputProperties": {
"accessModes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the desired access modes the volume should have.\nThe valid values are as follows:\n+ **ReadWriteOnce**: The volume can be mounted as read-write by a single node.\n+ **ReadOnlyMany**: The volume can be mounted as read-only by many nodes.\n+ **ReadWriteMany**: The volume can be mounted as read-write by many nodes.\n"
},
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the unstructured key value map for external parameters.\nChanging this will create a new PVC resource.\n"
},
"ccePvcId": {
"type": "string",
"description": "The PVC ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "Specifies the cluster ID to which the CCE PVC belongs.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the map of string keys and values for labels.\nChanging this will create a new PVC resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the unique name of the PVC resource. This parameter can contain a\nmaximum of 63 characters, which may consist of lowercase letters, digits and hyphens (-), and must start and end with\nlowercase letters and digits. Changing this will create a new PVC resource.\n"
},
"namespace": {
"type": "string",
"description": "Specifies the namespace to logically divide your containers into different\ngroup. Changing this will create a new PVC resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the PVC resource.\nIf omitted, the provider-level region will be used. Changing this will create a new PVC resource.\n"
},
"storage": {
"type": "string",
"description": "Specifies the minimum amount of storage resources required.\nChanging this creates a new PVC resource.\n"
},
"storageClassName": {
"type": "string",
"description": "Specifies the type of the storage bound to the CCE PVC.\nThe valid values are as follows:\n+ **csi-disk**: EVS.\n+ **csi-obs**: OBS.\n+ **csi-nas**: SFS.\n+ **csi-sfsturbo**: SFS-Turbo.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCcePvcTimeouts:CcePvcTimeouts"
}
},
"requiredInputs": [
"accessModes",
"clusterId",
"namespace",
"storage",
"storageClassName"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CcePvc resources.\n",
"properties": {
"accessModes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the desired access modes the volume should have.\nThe valid values are as follows:\n+ **ReadWriteOnce**: The volume can be mounted as read-write by a single node.\n+ **ReadOnlyMany**: The volume can be mounted as read-only by many nodes.\n+ **ReadWriteMany**: The volume can be mounted as read-write by many nodes.\n"
},
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the unstructured key value map for external parameters.\nChanging this will create a new PVC resource.\n"
},
"ccePvcId": {
"type": "string",
"description": "The PVC ID in UUID format.\n"
},
"clusterId": {
"type": "string",
"description": "Specifies the cluster ID to which the CCE PVC belongs.\n"
},
"creationTimestamp": {
"type": "string",
"description": "The server time when PVC was created.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the map of string keys and values for labels.\nChanging this will create a new PVC resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the unique name of the PVC resource. This parameter can contain a\nmaximum of 63 characters, which may consist of lowercase letters, digits and hyphens (-), and must start and end with\nlowercase letters and digits. Changing this will create a new PVC resource.\n"
},
"namespace": {
"type": "string",
"description": "Specifies the namespace to logically divide your containers into different\ngroup. Changing this will create a new PVC resource.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the PVC resource.\nIf omitted, the provider-level region will be used. Changing this will create a new PVC resource.\n"
},
"status": {
"type": "string",
"description": "The current phase of the PVC.\n+ **Pending**: Not yet bound.\n+ **Bound**: Already bound.\n"
},
"storage": {
"type": "string",
"description": "Specifies the minimum amount of storage resources required.\nChanging this creates a new PVC resource.\n"
},
"storageClassName": {
"type": "string",
"description": "Specifies the type of the storage bound to the CCE PVC.\nThe valid values are as follows:\n+ **csi-disk**: EVS.\n+ **csi-obs**: OBS.\n+ **csi-nas**: SFS.\n+ **csi-sfsturbo**: SFS-Turbo.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCcePvcTimeouts:CcePvcTimeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/cesAlarmrule:CesAlarmrule": {
"description": "Manages a Cloud Eye alarm rule resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst alarmRule = new flexibleengine.CesAlarmrule(\"alarmRule\", {\n alarmName: \"alarm_rule\",\n metric: {\n namespace: \"SYS.ECS\",\n metricName: \"network_outgoing_bytes_rate_inband\",\n dimensions: [{\n name: \"instance_id\",\n value: _var.instance_id,\n }],\n },\n condition: {\n period: 300,\n filter: \"average\",\n comparisonOperator: \">\",\n value: 6,\n unit: \"B/s\",\n count: 1,\n },\n alarmActions: [{\n type: \"notification\",\n notificationLists: [_var.topic_id],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nalarm_rule = flexibleengine.CesAlarmrule(\"alarmRule\",\n alarm_name=\"alarm_rule\",\n metric={\n \"namespace\": \"SYS.ECS\",\n \"metric_name\": \"network_outgoing_bytes_rate_inband\",\n \"dimensions\": [{\n \"name\": \"instance_id\",\n \"value\": var[\"instance_id\"],\n }],\n },\n condition={\n \"period\": 300,\n \"filter\": \"average\",\n \"comparison_operator\": \">\",\n \"value\": 6,\n \"unit\": \"B/s\",\n \"count\": 1,\n },\n alarm_actions=[{\n \"type\": \"notification\",\n \"notification_lists\": [var[\"topic_id\"]],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var alarmRule = new Flexibleengine.CesAlarmrule(\"alarmRule\", new()\n {\n AlarmName = \"alarm_rule\",\n Metric = new Flexibleengine.Inputs.CesAlarmruleMetricArgs\n {\n Namespace = \"SYS.ECS\",\n MetricName = \"network_outgoing_bytes_rate_inband\",\n Dimensions = new[]\n {\n new Flexibleengine.Inputs.CesAlarmruleMetricDimensionArgs\n {\n Name = \"instance_id\",\n Value = @var.Instance_id,\n },\n },\n },\n Condition = new Flexibleengine.Inputs.CesAlarmruleConditionArgs\n {\n Period = 300,\n Filter = \"average\",\n ComparisonOperator = \">\",\n Value = 6,\n Unit = \"B/s\",\n Count = 1,\n },\n AlarmActions = new[]\n {\n new Flexibleengine.Inputs.CesAlarmruleAlarmActionArgs\n {\n Type = \"notification\",\n NotificationLists = new[]\n {\n @var.Topic_id,\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewCesAlarmrule(ctx, \"alarmRule\", &flexibleengine.CesAlarmruleArgs{\n\t\t\tAlarmName: pulumi.String(\"alarm_rule\"),\n\t\t\tMetric: &flexibleengine.CesAlarmruleMetricArgs{\n\t\t\t\tNamespace: pulumi.String(\"SYS.ECS\"),\n\t\t\t\tMetricName: pulumi.String(\"network_outgoing_bytes_rate_inband\"),\n\t\t\t\tDimensions: flexibleengine.CesAlarmruleMetricDimensionArray{\n\t\t\t\t\t&flexibleengine.CesAlarmruleMetricDimensionArgs{\n\t\t\t\t\t\tName: pulumi.String(\"instance_id\"),\n\t\t\t\t\t\tValue: pulumi.Any(_var.Instance_id),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tCondition: &flexibleengine.CesAlarmruleConditionArgs{\n\t\t\t\tPeriod: pulumi.Float64(300),\n\t\t\t\tFilter: pulumi.String(\"average\"),\n\t\t\t\tComparisonOperator: pulumi.String(\">\"),\n\t\t\t\tValue: pulumi.Float64(6),\n\t\t\t\tUnit: pulumi.String(\"B/s\"),\n\t\t\t\tCount: pulumi.Float64(1),\n\t\t\t},\n\t\t\tAlarmActions: flexibleengine.CesAlarmruleAlarmActionArray{\n\t\t\t\t&flexibleengine.CesAlarmruleAlarmActionArgs{\n\t\t\t\t\tType: pulumi.String(\"notification\"),\n\t\t\t\t\tNotificationLists: pulumi.StringArray{\n\t\t\t\t\t\t_var.Topic_id,\n\t\t\t\t\t},\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.flexibleengine.CesAlarmrule;\nimport com.pulumi.flexibleengine.CesAlarmruleArgs;\nimport com.pulumi.flexibleengine.inputs.CesAlarmruleMetricArgs;\nimport com.pulumi.flexibleengine.inputs.CesAlarmruleConditionArgs;\nimport com.pulumi.flexibleengine.inputs.CesAlarmruleAlarmActionArgs;\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 alarmRule = new CesAlarmrule(\"alarmRule\", CesAlarmruleArgs.builder()\n .alarmName(\"alarm_rule\")\n .metric(CesAlarmruleMetricArgs.builder()\n .namespace(\"SYS.ECS\")\n .metricName(\"network_outgoing_bytes_rate_inband\")\n .dimensions(CesAlarmruleMetricDimensionArgs.builder()\n .name(\"instance_id\")\n .value(var_.instance_id())\n .build())\n .build())\n .condition(CesAlarmruleConditionArgs.builder()\n .period(300)\n .filter(\"average\")\n .comparisonOperator(\">\")\n .value(6)\n .unit(\"B/s\")\n .count(1)\n .build())\n .alarmActions(CesAlarmruleAlarmActionArgs.builder()\n .type(\"notification\")\n .notificationLists(var_.topic_id())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n alarmRule:\n type: flexibleengine:CesAlarmrule\n properties:\n alarmName: alarm_rule\n metric:\n namespace: SYS.ECS\n metricName: network_outgoing_bytes_rate_inband\n dimensions:\n - name: instance_id\n value: ${var.instance_id}\n condition:\n period: 300\n filter: average\n comparisonOperator: '>'\n value: 6\n unit: B/s\n count: 1\n alarmActions:\n - type: notification\n notificationLists:\n - ${var.topic_id}\n```\n\n\n## Import\n\nCES alarm rules can be imported using the `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/cesAlarmrule:CesAlarmrule alarm_rule al1619678242900OxEaaODM2\n```\n\n",
"properties": {
"alarmActionEnabled": {
"type": "boolean",
"description": "Specifies whether to enable the action\nto be triggered by an alarm. The default value is true.\n\n> **Note** If alarm_action_enabled is set to true, either alarm_actions or\nok_actions cannot be empty. If alarm_actions and ok_actions coexist, their\ncorresponding notification_list must be of the same value.\n"
},
"alarmActions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleAlarmAction:CesAlarmruleAlarmAction"
},
"description": "Specifies the action triggered by an alarm. The\nstructure is described below.\n"
},
"alarmDescription": {
"type": "string",
"description": "The value can be a string of 0 to 256 characters.\n"
},
"alarmEnabled": {
"type": "boolean",
"description": "Specifies whether to enable the alarm. The default\nvalue is true.\n"
},
"alarmLevel": {
"type": "number",
"description": "Specifies the alarm severity. The value can be\n1, 2, 3 or 4, which indicates *critical*, *major*, *minor*, and *informational*, respectively.\nThe default value is 2. Changing this creates a new resource.\n"
},
"alarmName": {
"type": "string",
"description": "Specifies the name of an alarm rule. The value can\nbe a string of 1 to 128 characters that can consist of numbers, lowercase letters,\nuppercase letters, underscores (_), or hyphens (-).\n"
},
"alarmState": {
"type": "string",
"description": "Indicates the alarm status. The value can be:\n- ok: The alarm status is normal;\n- alarm: An alarm is generated;\n- insufficient_data: The required data is insufficient.\n"
},
"cesAlarmruleId": {
"type": "string",
"description": "Indicates the alarm rule ID.\n"
},
"condition": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleCondition:CesAlarmruleCondition",
"description": "Specifies the alarm triggering condition. The structure\nis described below.\n"
},
"insufficientdataActions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleInsufficientdataAction:CesAlarmruleInsufficientdataAction"
},
"deprecationMessage": "Deprecated"
},
"metric": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleMetric:CesAlarmruleMetric",
"description": "Specifies the alarm metrics. The structure is described\nbelow.\n"
},
"okActions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleOkAction:CesAlarmruleOkAction"
},
"description": "Specifies the action triggered by the clearing of\nan alarm. The structure is described below.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the alarm rule resource. If omitted, the\nprovider-level region will be used. Changing this creates a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleTimeouts:CesAlarmruleTimeouts"
},
"updateTime": {
"type": "number",
"description": "Indicates the time when the alarm status changed.\nThe value is a UNIX timestamp and the unit is ms.\n"
}
},
"type": "object",
"required": [
"alarmName",
"alarmState",
"cesAlarmruleId",
"condition",
"metric",
"region",
"updateTime"
],
"inputProperties": {
"alarmActionEnabled": {
"type": "boolean",
"description": "Specifies whether to enable the action\nto be triggered by an alarm. The default value is true.\n\n> **Note** If alarm_action_enabled is set to true, either alarm_actions or\nok_actions cannot be empty. If alarm_actions and ok_actions coexist, their\ncorresponding notification_list must be of the same value.\n"
},
"alarmActions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleAlarmAction:CesAlarmruleAlarmAction"
},
"description": "Specifies the action triggered by an alarm. The\nstructure is described below.\n"
},
"alarmDescription": {
"type": "string",
"description": "The value can be a string of 0 to 256 characters.\n"
},
"alarmEnabled": {
"type": "boolean",
"description": "Specifies whether to enable the alarm. The default\nvalue is true.\n"
},
"alarmLevel": {
"type": "number",
"description": "Specifies the alarm severity. The value can be\n1, 2, 3 or 4, which indicates *critical*, *major*, *minor*, and *informational*, respectively.\nThe default value is 2. Changing this creates a new resource.\n"
},
"alarmName": {
"type": "string",
"description": "Specifies the name of an alarm rule. The value can\nbe a string of 1 to 128 characters that can consist of numbers, lowercase letters,\nuppercase letters, underscores (_), or hyphens (-).\n"
},
"cesAlarmruleId": {
"type": "string",
"description": "Indicates the alarm rule ID.\n"
},
"condition": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleCondition:CesAlarmruleCondition",
"description": "Specifies the alarm triggering condition. The structure\nis described below.\n"
},
"insufficientdataActions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleInsufficientdataAction:CesAlarmruleInsufficientdataAction"
},
"deprecationMessage": "Deprecated"
},
"metric": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleMetric:CesAlarmruleMetric",
"description": "Specifies the alarm metrics. The structure is described\nbelow.\n"
},
"okActions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleOkAction:CesAlarmruleOkAction"
},
"description": "Specifies the action triggered by the clearing of\nan alarm. The structure is described below.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the alarm rule resource. If omitted, the\nprovider-level region will be used. Changing this creates a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleTimeouts:CesAlarmruleTimeouts"
}
},
"requiredInputs": [
"alarmName",
"condition",
"metric"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CesAlarmrule resources.\n",
"properties": {
"alarmActionEnabled": {
"type": "boolean",
"description": "Specifies whether to enable the action\nto be triggered by an alarm. The default value is true.\n\n> **Note** If alarm_action_enabled is set to true, either alarm_actions or\nok_actions cannot be empty. If alarm_actions and ok_actions coexist, their\ncorresponding notification_list must be of the same value.\n"
},
"alarmActions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleAlarmAction:CesAlarmruleAlarmAction"
},
"description": "Specifies the action triggered by an alarm. The\nstructure is described below.\n"
},
"alarmDescription": {
"type": "string",
"description": "The value can be a string of 0 to 256 characters.\n"
},
"alarmEnabled": {
"type": "boolean",
"description": "Specifies whether to enable the alarm. The default\nvalue is true.\n"
},
"alarmLevel": {
"type": "number",
"description": "Specifies the alarm severity. The value can be\n1, 2, 3 or 4, which indicates *critical*, *major*, *minor*, and *informational*, respectively.\nThe default value is 2. Changing this creates a new resource.\n"
},
"alarmName": {
"type": "string",
"description": "Specifies the name of an alarm rule. The value can\nbe a string of 1 to 128 characters that can consist of numbers, lowercase letters,\nuppercase letters, underscores (_), or hyphens (-).\n"
},
"alarmState": {
"type": "string",
"description": "Indicates the alarm status. The value can be:\n- ok: The alarm status is normal;\n- alarm: An alarm is generated;\n- insufficient_data: The required data is insufficient.\n"
},
"cesAlarmruleId": {
"type": "string",
"description": "Indicates the alarm rule ID.\n"
},
"condition": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleCondition:CesAlarmruleCondition",
"description": "Specifies the alarm triggering condition. The structure\nis described below.\n"
},
"insufficientdataActions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleInsufficientdataAction:CesAlarmruleInsufficientdataAction"
},
"deprecationMessage": "Deprecated"
},
"metric": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleMetric:CesAlarmruleMetric",
"description": "Specifies the alarm metrics. The structure is described\nbelow.\n"
},
"okActions": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleOkAction:CesAlarmruleOkAction"
},
"description": "Specifies the action triggered by the clearing of\nan alarm. The structure is described below.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the alarm rule resource. If omitted, the\nprovider-level region will be used. Changing this creates a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCesAlarmruleTimeouts:CesAlarmruleTimeouts"
},
"updateTime": {
"type": "number",
"description": "Indicates the time when the alarm status changed.\nThe value is a UNIX timestamp and the unit is ms.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/computeBmsServerV2:ComputeBmsServerV2": {
"description": "Manages a BMS Server resource within FlexibleEngine.\n\n## Example Usage\n\n### Basic Instance\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst imageId = config.requireObject(\"imageId\");\nconst flavorId = config.requireObject(\"flavorId\");\nconst keypairName = config.requireObject(\"keypairName\");\nconst availabilityZone = config.requireObject(\"availabilityZone\");\nconst basic = new flexibleengine.ComputeBmsServerV2(\"basic\", {\n imageId: imageId,\n flavorId: flavorId,\n keyPair: keypairName,\n securityGroups: [\"default\"],\n availabilityZone: availabilityZone,\n metadata: {\n \"this\": \"that\",\n },\n networks: [{\n uuid: flexibleengine_vpc_subnet_v1.example_subnet.id,\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nimage_id = config.require_object(\"imageId\")\nflavor_id = config.require_object(\"flavorId\")\nkeypair_name = config.require_object(\"keypairName\")\navailability_zone = config.require_object(\"availabilityZone\")\nbasic = flexibleengine.ComputeBmsServerV2(\"basic\",\n image_id=image_id,\n flavor_id=flavor_id,\n key_pair=keypair_name,\n security_groups=[\"default\"],\n availability_zone=availability_zone,\n metadata={\n \"this\": \"that\",\n },\n networks=[{\n \"uuid\": flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var imageId = config.RequireObject(\"imageId\");\n var flavorId = config.RequireObject(\"flavorId\");\n var keypairName = config.RequireObject(\"keypairName\");\n var availabilityZone = config.RequireObject(\"availabilityZone\");\n var basic = new Flexibleengine.ComputeBmsServerV2(\"basic\", new()\n {\n ImageId = imageId,\n FlavorId = flavorId,\n KeyPair = keypairName,\n SecurityGroups = new[]\n {\n \"default\",\n },\n AvailabilityZone = availabilityZone,\n Metadata = \n {\n { \"this\", \"that\" },\n },\n Networks = new[]\n {\n new Flexibleengine.Inputs.ComputeBmsServerV2NetworkArgs\n {\n Uuid = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\timageId := cfg.RequireObject(\"imageId\")\n\t\tflavorId := cfg.RequireObject(\"flavorId\")\n\t\tkeypairName := cfg.RequireObject(\"keypairName\")\n\t\tavailabilityZone := cfg.RequireObject(\"availabilityZone\")\n\t\t_, err := flexibleengine.NewComputeBmsServerV2(ctx, \"basic\", &flexibleengine.ComputeBmsServerV2Args{\n\t\t\tImageId: pulumi.Any(imageId),\n\t\t\tFlavorId: pulumi.Any(flavorId),\n\t\t\tKeyPair: pulumi.Any(keypairName),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t\tAvailabilityZone: pulumi.Any(availabilityZone),\n\t\t\tMetadata: pulumi.StringMap{\n\t\t\t\t\"this\": pulumi.String(\"that\"),\n\t\t\t},\n\t\t\tNetworks: flexibleengine.ComputeBmsServerV2NetworkArray{\n\t\t\t\t&flexibleengine.ComputeBmsServerV2NetworkArgs{\n\t\t\t\t\tUuid: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\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.flexibleengine.ComputeBmsServerV2;\nimport com.pulumi.flexibleengine.ComputeBmsServerV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeBmsServerV2NetworkArgs;\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 final var config = ctx.config();\n final var imageId = config.get(\"imageId\");\n final var flavorId = config.get(\"flavorId\");\n final var keypairName = config.get(\"keypairName\");\n final var availabilityZone = config.get(\"availabilityZone\");\n var basic = new ComputeBmsServerV2(\"basic\", ComputeBmsServerV2Args.builder()\n .imageId(imageId)\n .flavorId(flavorId)\n .keyPair(keypairName)\n .securityGroups(\"default\")\n .availabilityZone(availabilityZone)\n .metadata(Map.of(\"this\", \"that\"))\n .networks(ComputeBmsServerV2NetworkArgs.builder()\n .uuid(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n imageId:\n type: dynamic\n flavorId:\n type: dynamic\n keypairName:\n type: dynamic\n availabilityZone:\n type: dynamic\nresources:\n basic:\n type: flexibleengine:ComputeBmsServerV2\n properties:\n imageId: ${imageId}\n flavorId: ${flavorId}\n keyPair: ${keypairName}\n securityGroups:\n - default\n availabilityZone: ${availabilityZone}\n metadata:\n this: that\n networks:\n - uuid: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n```\n\n",
"properties": {
"accessIpV4": {
"type": "string",
"description": "This is a reserved attribute.\n"
},
"accessIpV6": {
"type": "string",
"description": "This is a reserved attribute.\n"
},
"adminPass": {
"type": "string",
"description": "The administrative password to assign to the bms server.\nChanging this changes the root password on the existing server.\n"
},
"availabilityZone": {
"type": "string",
"description": "The availability zone in which to create\nthe bms server. Changing this will create a new bms server resource.\n"
},
"blockDevices": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeBmsServerV2BlockDevice:ComputeBmsServerV2BlockDevice"
}
},
"computeBmsServerV2Id": {
"type": "string",
"description": "The id of the bms server.\n"
},
"configDrive": {
"type": "boolean",
"description": "Whether to use the config_drive feature to configure the instance.\n"
},
"flavorId": {
"type": "string",
"description": "The flavor ID of\nthe desired flavor for the bms server. Changing this resizes the existing bms server.\nIt is Required if `flavor_name` is empty.\n"
},
"flavorName": {
"type": "string",
"description": "The name of the\ndesired flavor for the bms server. Changing this resizes the existing bms server.\nIt is Required if `flavor_id` is empty.\n"
},
"hostId": {
"type": "string",
"description": "Specifies the host ID of the BMS.\n"
},
"hostStatus": {
"type": "string",
"description": "The nova-compute status: **UP, UNKNOWN, DOWN, MAINTENANCE** and **Null**.\n"
},
"imageId": {
"type": "string",
"description": "Changing this creates a new bms server. It is Required if `image_name` is\nempty. Changing this creates a new bms server.\n"
},
"imageName": {
"type": "string",
"description": "The name of the desired image for the bms server.\nChanging this creates a new bms server. It is Required if `image_id` is empty.\n"
},
"kernelId": {
"type": "string",
"description": "The UUID of the kernel image when the AMI image is used.\n"
},
"keyPair": {
"type": "string",
"description": "The name of a key pair to put on the bms server. The key\npair must already be created and associated with the tenant's account.\nChanging this creates a new bms server.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Metadata key/value pairs to make available from\nwithin the instance. Changing this updates the existing bms server metadata.\n"
},
"name": {
"type": "string",
"description": "The human-readable name of the network. Changing this creates a new bms server.\nIt is Required unless `uuid` or `port` is provided.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeBmsServerV2Network:ComputeBmsServerV2Network"
},
"description": "An array of one or more networks to attach to the\nbms instance. Changing this creates a new bms server.\nThe network object structure is documented below.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the bms server instance. If\nomitted, the `region` argument of the provider is used. Changing this will create a new bms server.\n"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more security group names\nto associate with the bms server. Changing this results in adding/removing\nsecurity groups from the existing bms server.\n"
},
"stopBeforeDestroy": {
"type": "boolean",
"description": "Whether to try stop instance gracefully\nbefore destroying it, thus giving chance for guest OS daemons to stop correctly.\nIf instance doesn't stop within timeout, it will be destroyed anyway.\n\n\nThe `network` block supports:\n"
},
"tenantId": {
"type": "string"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeBmsServerV2Timeouts:ComputeBmsServerV2Timeouts"
},
"userData": {
"type": "string",
"description": "The user data to provide when launching the instance.\nChanging this creates a new bms server.\n"
},
"userId": {
"type": "string",
"description": "The ID of the user to which the BMS belongs.\n"
}
},
"type": "object",
"required": [
"accessIpV4",
"accessIpV6",
"adminPass",
"availabilityZone",
"computeBmsServerV2Id",
"configDrive",
"flavorId",
"flavorName",
"hostId",
"hostStatus",
"imageId",
"imageName",
"kernelId",
"keyPair",
"name",
"region",
"securityGroups",
"tenantId",
"userId"
],
"inputProperties": {
"adminPass": {
"type": "string",
"description": "The administrative password to assign to the bms server.\nChanging this changes the root password on the existing server.\n"
},
"availabilityZone": {
"type": "string",
"description": "The availability zone in which to create\nthe bms server. Changing this will create a new bms server resource.\n"
},
"blockDevices": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeBmsServerV2BlockDevice:ComputeBmsServerV2BlockDevice"
}
},
"computeBmsServerV2Id": {
"type": "string",
"description": "The id of the bms server.\n"
},
"flavorId": {
"type": "string",
"description": "The flavor ID of\nthe desired flavor for the bms server. Changing this resizes the existing bms server.\nIt is Required if `flavor_name` is empty.\n"
},
"flavorName": {
"type": "string",
"description": "The name of the\ndesired flavor for the bms server. Changing this resizes the existing bms server.\nIt is Required if `flavor_id` is empty.\n"
},
"imageId": {
"type": "string",
"description": "Changing this creates a new bms server. It is Required if `image_name` is\nempty. Changing this creates a new bms server.\n"
},
"imageName": {
"type": "string",
"description": "The name of the desired image for the bms server.\nChanging this creates a new bms server. It is Required if `image_id` is empty.\n"
},
"keyPair": {
"type": "string",
"description": "The name of a key pair to put on the bms server. The key\npair must already be created and associated with the tenant's account.\nChanging this creates a new bms server.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Metadata key/value pairs to make available from\nwithin the instance. Changing this updates the existing bms server metadata.\n"
},
"name": {
"type": "string",
"description": "The human-readable name of the network. Changing this creates a new bms server.\nIt is Required unless `uuid` or `port` is provided.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeBmsServerV2Network:ComputeBmsServerV2Network"
},
"description": "An array of one or more networks to attach to the\nbms instance. Changing this creates a new bms server.\nThe network object structure is documented below.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the bms server instance. If\nomitted, the `region` argument of the provider is used. Changing this will create a new bms server.\n"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more security group names\nto associate with the bms server. Changing this results in adding/removing\nsecurity groups from the existing bms server.\n"
},
"stopBeforeDestroy": {
"type": "boolean",
"description": "Whether to try stop instance gracefully\nbefore destroying it, thus giving chance for guest OS daemons to stop correctly.\nIf instance doesn't stop within timeout, it will be destroyed anyway.\n\n\nThe `network` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeBmsServerV2Timeouts:ComputeBmsServerV2Timeouts"
},
"userData": {
"type": "string",
"description": "The user data to provide when launching the instance.\nChanging this creates a new bms server.\n"
}
},
"requiredInputs": [
"availabilityZone"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ComputeBmsServerV2 resources.\n",
"properties": {
"accessIpV4": {
"type": "string",
"description": "This is a reserved attribute.\n"
},
"accessIpV6": {
"type": "string",
"description": "This is a reserved attribute.\n"
},
"adminPass": {
"type": "string",
"description": "The administrative password to assign to the bms server.\nChanging this changes the root password on the existing server.\n"
},
"availabilityZone": {
"type": "string",
"description": "The availability zone in which to create\nthe bms server. Changing this will create a new bms server resource.\n"
},
"blockDevices": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeBmsServerV2BlockDevice:ComputeBmsServerV2BlockDevice"
}
},
"computeBmsServerV2Id": {
"type": "string",
"description": "The id of the bms server.\n"
},
"configDrive": {
"type": "boolean",
"description": "Whether to use the config_drive feature to configure the instance.\n"
},
"flavorId": {
"type": "string",
"description": "The flavor ID of\nthe desired flavor for the bms server. Changing this resizes the existing bms server.\nIt is Required if `flavor_name` is empty.\n"
},
"flavorName": {
"type": "string",
"description": "The name of the\ndesired flavor for the bms server. Changing this resizes the existing bms server.\nIt is Required if `flavor_id` is empty.\n"
},
"hostId": {
"type": "string",
"description": "Specifies the host ID of the BMS.\n"
},
"hostStatus": {
"type": "string",
"description": "The nova-compute status: **UP, UNKNOWN, DOWN, MAINTENANCE** and **Null**.\n"
},
"imageId": {
"type": "string",
"description": "Changing this creates a new bms server. It is Required if `image_name` is\nempty. Changing this creates a new bms server.\n"
},
"imageName": {
"type": "string",
"description": "The name of the desired image for the bms server.\nChanging this creates a new bms server. It is Required if `image_id` is empty.\n"
},
"kernelId": {
"type": "string",
"description": "The UUID of the kernel image when the AMI image is used.\n"
},
"keyPair": {
"type": "string",
"description": "The name of a key pair to put on the bms server. The key\npair must already be created and associated with the tenant's account.\nChanging this creates a new bms server.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Metadata key/value pairs to make available from\nwithin the instance. Changing this updates the existing bms server metadata.\n"
},
"name": {
"type": "string",
"description": "The human-readable name of the network. Changing this creates a new bms server.\nIt is Required unless `uuid` or `port` is provided.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeBmsServerV2Network:ComputeBmsServerV2Network"
},
"description": "An array of one or more networks to attach to the\nbms instance. Changing this creates a new bms server.\nThe network object structure is documented below.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the bms server instance. If\nomitted, the `region` argument of the provider is used. Changing this will create a new bms server.\n"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more security group names\nto associate with the bms server. Changing this results in adding/removing\nsecurity groups from the existing bms server.\n"
},
"stopBeforeDestroy": {
"type": "boolean",
"description": "Whether to try stop instance gracefully\nbefore destroying it, thus giving chance for guest OS daemons to stop correctly.\nIf instance doesn't stop within timeout, it will be destroyed anyway.\n\n\nThe `network` block supports:\n"
},
"tenantId": {
"type": "string"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeBmsServerV2Timeouts:ComputeBmsServerV2Timeouts"
},
"userData": {
"type": "string",
"description": "The user data to provide when launching the instance.\nChanging this creates a new bms server.\n"
},
"userId": {
"type": "string",
"description": "The ID of the user to which the BMS belongs.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/computeFloatingipAssociateV2:ComputeFloatingipAssociateV2": {
"description": "Associate a floating IP to an instance. This can be used instead of the\n`floating_ip` options in `flexibleengine.ComputeInstanceV2`.\n\n## Example Usage\n\n### Associate with EIP\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst instance1 = new flexibleengine.ComputeInstanceV2(\"instance1\", {\n imageId: \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavorId: \"3\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n});\nconst eip1 = new flexibleengine.VpcEip(\"eip1\", {\n publicip: {\n type: \"5_bgp\",\n },\n bandwidth: {\n name: \"test\",\n size: 8,\n shareType: \"PER\",\n chargeMode: \"traffic\",\n },\n});\nconst fip1 = new flexibleengine.ComputeFloatingipAssociateV2(\"fip1\", {\n floatingIp: eip1.publicip.apply(publicip => publicip.ipAddress),\n instanceId: instance1.computeInstanceV2Id,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\ninstance1 = flexibleengine.ComputeInstanceV2(\"instance1\",\n image_id=\"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavor_id=\"3\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"])\neip1 = flexibleengine.VpcEip(\"eip1\",\n publicip={\n \"type\": \"5_bgp\",\n },\n bandwidth={\n \"name\": \"test\",\n \"size\": 8,\n \"share_type\": \"PER\",\n \"charge_mode\": \"traffic\",\n })\nfip1 = flexibleengine.ComputeFloatingipAssociateV2(\"fip1\",\n floating_ip=eip1.publicip.ip_address,\n instance_id=instance1.compute_instance_v2_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var instance1 = new Flexibleengine.ComputeInstanceV2(\"instance1\", new()\n {\n ImageId = \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n FlavorId = \"3\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n });\n\n var eip1 = new Flexibleengine.VpcEip(\"eip1\", new()\n {\n Publicip = new Flexibleengine.Inputs.VpcEipPublicipArgs\n {\n Type = \"5_bgp\",\n },\n Bandwidth = new Flexibleengine.Inputs.VpcEipBandwidthArgs\n {\n Name = \"test\",\n Size = 8,\n ShareType = \"PER\",\n ChargeMode = \"traffic\",\n },\n });\n\n var fip1 = new Flexibleengine.ComputeFloatingipAssociateV2(\"fip1\", new()\n {\n FloatingIp = eip1.Publicip.Apply(publicip => publicip.IpAddress),\n InstanceId = instance1.ComputeInstanceV2Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tinstance1, err := flexibleengine.NewComputeInstanceV2(ctx, \"instance1\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tImageId: pulumi.String(\"ad091b52-742f-469e-8f3c-fd81cadf0743\"),\n\t\t\tFlavorId: pulumi.String(\"3\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\teip1, err := flexibleengine.NewVpcEip(ctx, \"eip1\", &flexibleengine.VpcEipArgs{\n\t\t\tPublicip: &flexibleengine.VpcEipPublicipArgs{\n\t\t\t\tType: pulumi.String(\"5_bgp\"),\n\t\t\t},\n\t\t\tBandwidth: &flexibleengine.VpcEipBandwidthArgs{\n\t\t\t\tName: pulumi.String(\"test\"),\n\t\t\t\tSize: pulumi.Float64(8),\n\t\t\t\tShareType: pulumi.String(\"PER\"),\n\t\t\t\tChargeMode: pulumi.String(\"traffic\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewComputeFloatingipAssociateV2(ctx, \"fip1\", &flexibleengine.ComputeFloatingipAssociateV2Args{\n\t\t\tFloatingIp: pulumi.String(eip1.Publicip.ApplyT(func(publicip flexibleengine.VpcEipPublicip) (*string, error) {\n\t\t\t\treturn &publicip.IpAddress, nil\n\t\t\t}).(pulumi.StringPtrOutput)),\n\t\t\tInstanceId: instance1.ComputeInstanceV2Id,\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.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.VpcEip;\nimport com.pulumi.flexibleengine.VpcEipArgs;\nimport com.pulumi.flexibleengine.inputs.VpcEipPublicipArgs;\nimport com.pulumi.flexibleengine.inputs.VpcEipBandwidthArgs;\nimport com.pulumi.flexibleengine.ComputeFloatingipAssociateV2;\nimport com.pulumi.flexibleengine.ComputeFloatingipAssociateV2Args;\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 instance1 = new ComputeInstanceV2(\"instance1\", ComputeInstanceV2Args.builder()\n .imageId(\"ad091b52-742f-469e-8f3c-fd81cadf0743\")\n .flavorId(3)\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .build());\n\n var eip1 = new VpcEip(\"eip1\", VpcEipArgs.builder()\n .publicip(VpcEipPublicipArgs.builder()\n .type(\"5_bgp\")\n .build())\n .bandwidth(VpcEipBandwidthArgs.builder()\n .name(\"test\")\n .size(8)\n .shareType(\"PER\")\n .chargeMode(\"traffic\")\n .build())\n .build());\n\n var fip1 = new ComputeFloatingipAssociateV2(\"fip1\", ComputeFloatingipAssociateV2Args.builder()\n .floatingIp(eip1.publicip().applyValue(publicip -> publicip.ipAddress()))\n .instanceId(instance1.computeInstanceV2Id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n instance1:\n type: flexibleengine:ComputeInstanceV2\n properties:\n imageId: ad091b52-742f-469e-8f3c-fd81cadf0743\n flavorId: 3\n keyPair: my_key_pair_name\n securityGroups:\n - default\n eip1:\n type: flexibleengine:VpcEip\n properties:\n publicip:\n type: 5_bgp\n bandwidth:\n name: test\n size: 8\n shareType: PER\n chargeMode: traffic\n fip1:\n type: flexibleengine:ComputeFloatingipAssociateV2\n properties:\n floatingIp: ${eip1.publicip.ipAddress}\n instanceId: ${instance1.computeInstanceV2Id}\n```\n\n\n### Explicitly set the network to attach to\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst instance1 = new flexibleengine.ComputeInstanceV2(\"instance1\", {\n imageId: \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavorId: \"3\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n networks: [\n {\n name: \"my_network\",\n },\n {\n name: \"default\",\n },\n ],\n});\nconst fip1 = new flexibleengine.ComputeFloatingipAssociateV2(\"fip1\", {\n floatingIp: flexibleengine_vpc_eip.eip_1.publicip[0].ip_address,\n instanceId: instance1.computeInstanceV2Id,\n fixedIp: instance1.networks.apply(networks => networks?.[1]?.fixedIpV4),\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\ninstance1 = flexibleengine.ComputeInstanceV2(\"instance1\",\n image_id=\"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavor_id=\"3\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"],\n networks=[\n {\n \"name\": \"my_network\",\n },\n {\n \"name\": \"default\",\n },\n ])\nfip1 = flexibleengine.ComputeFloatingipAssociateV2(\"fip1\",\n floating_ip=flexibleengine_vpc_eip[\"eip_1\"][\"publicip\"][0][\"ip_address\"],\n instance_id=instance1.compute_instance_v2_id,\n fixed_ip=instance1.networks[1].fixed_ip_v4)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var instance1 = new Flexibleengine.ComputeInstanceV2(\"instance1\", new()\n {\n ImageId = \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n FlavorId = \"3\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n Networks = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2NetworkArgs\n {\n Name = \"my_network\",\n },\n new Flexibleengine.Inputs.ComputeInstanceV2NetworkArgs\n {\n Name = \"default\",\n },\n },\n });\n\n var fip1 = new Flexibleengine.ComputeFloatingipAssociateV2(\"fip1\", new()\n {\n FloatingIp = flexibleengine_vpc_eip.Eip_1.Publicip[0].Ip_address,\n InstanceId = instance1.ComputeInstanceV2Id,\n FixedIp = instance1.Networks.Apply(networks => networks[1]?.FixedIpV4),\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tinstance1, err := flexibleengine.NewComputeInstanceV2(ctx, \"instance1\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tImageId: pulumi.String(\"ad091b52-742f-469e-8f3c-fd81cadf0743\"),\n\t\t\tFlavorId: pulumi.String(\"3\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t\tNetworks: flexibleengine.ComputeInstanceV2NetworkArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2NetworkArgs{\n\t\t\t\t\tName: pulumi.String(\"my_network\"),\n\t\t\t\t},\n\t\t\t\t&flexibleengine.ComputeInstanceV2NetworkArgs{\n\t\t\t\t\tName: pulumi.String(\"default\"),\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\t_, err = flexibleengine.NewComputeFloatingipAssociateV2(ctx, \"fip1\", &flexibleengine.ComputeFloatingipAssociateV2Args{\n\t\t\tFloatingIp: pulumi.Any(flexibleengine_vpc_eip.Eip_1.Publicip[0].Ip_address),\n\t\t\tInstanceId: instance1.ComputeInstanceV2Id,\n\t\t\tFixedIp: pulumi.String(instance1.Networks.ApplyT(func(networks []flexibleengine.ComputeInstanceV2Network) (*string, error) {\n\t\t\t\treturn &networks[1].FixedIpV4, nil\n\t\t\t}).(pulumi.StringPtrOutput)),\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.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2NetworkArgs;\nimport com.pulumi.flexibleengine.ComputeFloatingipAssociateV2;\nimport com.pulumi.flexibleengine.ComputeFloatingipAssociateV2Args;\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 instance1 = new ComputeInstanceV2(\"instance1\", ComputeInstanceV2Args.builder()\n .imageId(\"ad091b52-742f-469e-8f3c-fd81cadf0743\")\n .flavorId(3)\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .networks( \n ComputeInstanceV2NetworkArgs.builder()\n .name(\"my_network\")\n .build(),\n ComputeInstanceV2NetworkArgs.builder()\n .name(\"default\")\n .build())\n .build());\n\n var fip1 = new ComputeFloatingipAssociateV2(\"fip1\", ComputeFloatingipAssociateV2Args.builder()\n .floatingIp(flexibleengine_vpc_eip.eip_1().publicip()[0].ip_address())\n .instanceId(instance1.computeInstanceV2Id())\n .fixedIp(instance1.networks().applyValue(networks -> networks[1].fixedIpV4()))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n instance1:\n type: flexibleengine:ComputeInstanceV2\n properties:\n imageId: ad091b52-742f-469e-8f3c-fd81cadf0743\n flavorId: 3\n keyPair: my_key_pair_name\n securityGroups:\n - default\n networks:\n - name: my_network\n - name: default\n fip1:\n type: flexibleengine:ComputeFloatingipAssociateV2\n properties:\n floatingIp: ${flexibleengine_vpc_eip.eip_1.publicip[0].ip_address}\n instanceId: ${instance1.computeInstanceV2Id}\n fixedIp: ${instance1.networks[1].fixedIpV4}\n```\n\n\n## Import\n\nThis resource can be imported by specifying `floating_ip`, `instance_id` and `fixed_ip`, separated\n\nby a forward slash:\n\n```sh\n$ pulumi import flexibleengine:index/computeFloatingipAssociateV2:ComputeFloatingipAssociateV2 fip_1 //\n```\n\n",
"properties": {
"computeFloatingipAssociateV2Id": {
"type": "string"
},
"fixedIp": {
"type": "string",
"description": "The specific IP address to direct traffic to.\n"
},
"floatingIp": {
"type": "string",
"description": "The floating IP to associate.\n"
},
"instanceId": {
"type": "string",
"description": "The instance to associte the floating IP with.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nKeypairs are associated with accounts, but a Compute client is needed to\ncreate one. If omitted, the `region` argument of the provider is used.\nChanging this creates a new floatingip_associate.\n"
}
},
"type": "object",
"required": [
"computeFloatingipAssociateV2Id",
"floatingIp",
"instanceId",
"region"
],
"inputProperties": {
"computeFloatingipAssociateV2Id": {
"type": "string"
},
"fixedIp": {
"type": "string",
"description": "The specific IP address to direct traffic to.\n"
},
"floatingIp": {
"type": "string",
"description": "The floating IP to associate.\n"
},
"instanceId": {
"type": "string",
"description": "The instance to associte the floating IP with.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nKeypairs are associated with accounts, but a Compute client is needed to\ncreate one. If omitted, the `region` argument of the provider is used.\nChanging this creates a new floatingip_associate.\n"
}
},
"requiredInputs": [
"floatingIp",
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ComputeFloatingipAssociateV2 resources.\n",
"properties": {
"computeFloatingipAssociateV2Id": {
"type": "string"
},
"fixedIp": {
"type": "string",
"description": "The specific IP address to direct traffic to.\n"
},
"floatingIp": {
"type": "string",
"description": "The floating IP to associate.\n"
},
"instanceId": {
"type": "string",
"description": "The instance to associte the floating IP with.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nKeypairs are associated with accounts, but a Compute client is needed to\ncreate one. If omitted, the `region` argument of the provider is used.\nChanging this creates a new floatingip_associate.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/computeFloatingipV2:ComputeFloatingipV2": {
"description": "Manages a V2 floating IP resource within FlexibleEngine Nova (compute)\nthat can be used for compute instances.\n\n!> **Warning:** It will be deprecated, using `flexibleengine.VpcEip` instead.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst floatip1 = new flexibleengine.ComputeFloatingipV2(\"floatip1\", {});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nfloatip1 = flexibleengine.ComputeFloatingipV2(\"floatip1\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var floatip1 = new Flexibleengine.ComputeFloatingipV2(\"floatip1\");\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeFloatingipV2(ctx, \"floatip1\", 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.pulumi.flexibleengine.ComputeFloatingipV2;\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 floatip1 = new ComputeFloatingipV2(\"floatip1\");\n\n }\n}\n```\n```yaml\nresources:\n floatip1:\n type: flexibleengine:ComputeFloatingipV2\n```\n\n\n## Import\n\nFloating IPs can be imported using the `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/computeFloatingipV2:ComputeFloatingipV2 floatip_1 89c60255-9bd6-460c-822a-e2b959ede9d2\n```\n\n",
"properties": {
"address": {
"type": "string",
"description": "The actual floating IP address itself.\n"
},
"computeFloatingipV2Id": {
"type": "string"
},
"fixedIp": {
"type": "string",
"description": "The fixed IP address corresponding to the floating IP.\n"
},
"instanceId": {
"type": "string",
"description": "UUID of the compute instance associated with the floating IP.\n"
},
"pool": {
"type": "string",
"description": "The name of the pool from which to obtain the floating\nIP. Default value is admin_external_net. Changing this creates a new floating IP.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nA Compute client is needed to create a floating IP that can be used with\na compute instance. If omitted, the `region` argument of the provider\nis used. Changing this creates a new floating IP (which may or may not\nhave a different address).\n"
}
},
"type": "object",
"required": [
"address",
"computeFloatingipV2Id",
"fixedIp",
"instanceId",
"region"
],
"inputProperties": {
"computeFloatingipV2Id": {
"type": "string"
},
"pool": {
"type": "string",
"description": "The name of the pool from which to obtain the floating\nIP. Default value is admin_external_net. Changing this creates a new floating IP.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nA Compute client is needed to create a floating IP that can be used with\na compute instance. If omitted, the `region` argument of the provider\nis used. Changing this creates a new floating IP (which may or may not\nhave a different address).\n"
}
},
"stateInputs": {
"description": "Input properties used for looking up and filtering ComputeFloatingipV2 resources.\n",
"properties": {
"address": {
"type": "string",
"description": "The actual floating IP address itself.\n"
},
"computeFloatingipV2Id": {
"type": "string"
},
"fixedIp": {
"type": "string",
"description": "The fixed IP address corresponding to the floating IP.\n"
},
"instanceId": {
"type": "string",
"description": "UUID of the compute instance associated with the floating IP.\n"
},
"pool": {
"type": "string",
"description": "The name of the pool from which to obtain the floating\nIP. Default value is admin_external_net. Changing this creates a new floating IP.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nA Compute client is needed to create a floating IP that can be used with\na compute instance. If omitted, the `region` argument of the provider\nis used. Changing this creates a new floating IP (which may or may not\nhave a different address).\n"
}
},
"type": "object"
}
},
"flexibleengine:index/computeInstanceV2:ComputeInstanceV2": {
"description": "Manages a V2 VM instance resource within FlexibleEngine.\n\n## Example Usage\n\n### Basic Instance\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst basic = new flexibleengine.ComputeInstanceV2(\"basic\", {\n imageId: \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavorId: \"s3.large.2\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n networks: [{\n uuid: flexibleengine_vpc_subnet_v1.example_subnet.id,\n }],\n tags: {\n foo: \"bar\",\n \"this\": \"that\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nbasic = flexibleengine.ComputeInstanceV2(\"basic\",\n image_id=\"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavor_id=\"s3.large.2\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"],\n networks=[{\n \"uuid\": flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n }],\n tags={\n \"foo\": \"bar\",\n \"this\": \"that\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var basic = new Flexibleengine.ComputeInstanceV2(\"basic\", new()\n {\n ImageId = \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n FlavorId = \"s3.large.2\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n Networks = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2NetworkArgs\n {\n Uuid = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n },\n },\n Tags = \n {\n { \"foo\", \"bar\" },\n { \"this\", \"that\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeInstanceV2(ctx, \"basic\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tImageId: pulumi.String(\"ad091b52-742f-469e-8f3c-fd81cadf0743\"),\n\t\t\tFlavorId: pulumi.String(\"s3.large.2\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t\tNetworks: flexibleengine.ComputeInstanceV2NetworkArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2NetworkArgs{\n\t\t\t\t\tUuid: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTags: pulumi.StringMap{\n\t\t\t\t\"foo\": pulumi.String(\"bar\"),\n\t\t\t\t\"this\": pulumi.String(\"that\"),\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.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2NetworkArgs;\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 basic = new ComputeInstanceV2(\"basic\", ComputeInstanceV2Args.builder()\n .imageId(\"ad091b52-742f-469e-8f3c-fd81cadf0743\")\n .flavorId(\"s3.large.2\")\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .networks(ComputeInstanceV2NetworkArgs.builder()\n .uuid(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .build())\n .tags(Map.ofEntries(\n Map.entry(\"foo\", \"bar\"),\n Map.entry(\"this\", \"that\")\n ))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n basic:\n type: flexibleengine:ComputeInstanceV2\n properties:\n imageId: ad091b52-742f-469e-8f3c-fd81cadf0743\n flavorId: s3.large.2\n keyPair: my_key_pair_name\n securityGroups:\n - default\n networks:\n - uuid: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n tags:\n foo: bar\n this: that\n```\n\n\n### Instance With Attached Volume\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst myvol = new flexibleengine.BlockstorageVolumeV2(\"myvol\", {size: 1});\nconst myinstance = new flexibleengine.ComputeInstanceV2(\"myinstance\", {\n imageId: \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavorId: \"s3.large.2\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n networks: [{\n uuid: flexibleengine_vpc_subnet_v1.example_subnet.id,\n }],\n});\nconst attached = new flexibleengine.ComputeVolumeAttachV2(\"attached\", {\n instanceId: myinstance.computeInstanceV2Id,\n volumeId: myvol.blockstorageVolumeV2Id,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nmyvol = flexibleengine.BlockstorageVolumeV2(\"myvol\", size=1)\nmyinstance = flexibleengine.ComputeInstanceV2(\"myinstance\",\n image_id=\"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavor_id=\"s3.large.2\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"],\n networks=[{\n \"uuid\": flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n }])\nattached = flexibleengine.ComputeVolumeAttachV2(\"attached\",\n instance_id=myinstance.compute_instance_v2_id,\n volume_id=myvol.blockstorage_volume_v2_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var myvol = new Flexibleengine.BlockstorageVolumeV2(\"myvol\", new()\n {\n Size = 1,\n });\n\n var myinstance = new Flexibleengine.ComputeInstanceV2(\"myinstance\", new()\n {\n ImageId = \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n FlavorId = \"s3.large.2\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n Networks = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2NetworkArgs\n {\n Uuid = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n },\n },\n });\n\n var attached = new Flexibleengine.ComputeVolumeAttachV2(\"attached\", new()\n {\n InstanceId = myinstance.ComputeInstanceV2Id,\n VolumeId = myvol.BlockstorageVolumeV2Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmyvol, err := flexibleengine.NewBlockstorageVolumeV2(ctx, \"myvol\", &flexibleengine.BlockstorageVolumeV2Args{\n\t\t\tSize: pulumi.Float64(1),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmyinstance, err := flexibleengine.NewComputeInstanceV2(ctx, \"myinstance\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tImageId: pulumi.String(\"ad091b52-742f-469e-8f3c-fd81cadf0743\"),\n\t\t\tFlavorId: pulumi.String(\"s3.large.2\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t\tNetworks: flexibleengine.ComputeInstanceV2NetworkArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2NetworkArgs{\n\t\t\t\t\tUuid: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\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\t_, err = flexibleengine.NewComputeVolumeAttachV2(ctx, \"attached\", &flexibleengine.ComputeVolumeAttachV2Args{\n\t\t\tInstanceId: myinstance.ComputeInstanceV2Id,\n\t\t\tVolumeId: myvol.BlockstorageVolumeV2Id,\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.flexibleengine.BlockstorageVolumeV2;\nimport com.pulumi.flexibleengine.BlockstorageVolumeV2Args;\nimport com.pulumi.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2NetworkArgs;\nimport com.pulumi.flexibleengine.ComputeVolumeAttachV2;\nimport com.pulumi.flexibleengine.ComputeVolumeAttachV2Args;\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 myvol = new BlockstorageVolumeV2(\"myvol\", BlockstorageVolumeV2Args.builder()\n .size(1)\n .build());\n\n var myinstance = new ComputeInstanceV2(\"myinstance\", ComputeInstanceV2Args.builder()\n .imageId(\"ad091b52-742f-469e-8f3c-fd81cadf0743\")\n .flavorId(\"s3.large.2\")\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .networks(ComputeInstanceV2NetworkArgs.builder()\n .uuid(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .build())\n .build());\n\n var attached = new ComputeVolumeAttachV2(\"attached\", ComputeVolumeAttachV2Args.builder()\n .instanceId(myinstance.computeInstanceV2Id())\n .volumeId(myvol.blockstorageVolumeV2Id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n myvol:\n type: flexibleengine:BlockstorageVolumeV2\n properties:\n size: 1\n myinstance:\n type: flexibleengine:ComputeInstanceV2\n properties:\n imageId: ad091b52-742f-469e-8f3c-fd81cadf0743\n flavorId: s3.large.2\n keyPair: my_key_pair_name\n securityGroups:\n - default\n networks:\n - uuid: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n attached:\n type: flexibleengine:ComputeVolumeAttachV2\n properties:\n instanceId: ${myinstance.computeInstanceV2Id}\n volumeId: ${myvol.blockstorageVolumeV2Id}\n```\n\n\n### Boot From Volume\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst boot_from_volume = new flexibleengine.ComputeInstanceV2(\"boot-from-volume\", {\n flavorId: \"s3.large.2\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n blockDevices: [{\n uuid: \"\",\n sourceType: \"image\",\n volumeSize: 5,\n bootIndex: 0,\n destinationType: \"volume\",\n deleteOnTermination: true,\n volumeType: \"SSD\",\n }],\n networks: [{\n uuid: flexibleengine_vpc_subnet_v1.example_subnet.id,\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nboot_from_volume = flexibleengine.ComputeInstanceV2(\"boot-from-volume\",\n flavor_id=\"s3.large.2\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"],\n block_devices=[{\n \"uuid\": \"\",\n \"source_type\": \"image\",\n \"volume_size\": 5,\n \"boot_index\": 0,\n \"destination_type\": \"volume\",\n \"delete_on_termination\": True,\n \"volume_type\": \"SSD\",\n }],\n networks=[{\n \"uuid\": flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var boot_from_volume = new Flexibleengine.ComputeInstanceV2(\"boot-from-volume\", new()\n {\n FlavorId = \"s3.large.2\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n BlockDevices = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n Uuid = \"\",\n SourceType = \"image\",\n VolumeSize = 5,\n BootIndex = 0,\n DestinationType = \"volume\",\n DeleteOnTermination = true,\n VolumeType = \"SSD\",\n },\n },\n Networks = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2NetworkArgs\n {\n Uuid = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeInstanceV2(ctx, \"boot-from-volume\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tFlavorId: pulumi.String(\"s3.large.2\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t\tBlockDevices: flexibleengine.ComputeInstanceV2BlockDeviceArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tUuid: pulumi.String(\"\"),\n\t\t\t\t\tSourceType: pulumi.String(\"image\"),\n\t\t\t\t\tVolumeSize: pulumi.Float64(5),\n\t\t\t\t\tBootIndex: pulumi.Float64(0),\n\t\t\t\t\tDestinationType: pulumi.String(\"volume\"),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t\tVolumeType: pulumi.String(\"SSD\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tNetworks: flexibleengine.ComputeInstanceV2NetworkArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2NetworkArgs{\n\t\t\t\t\tUuid: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\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.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2BlockDeviceArgs;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2NetworkArgs;\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 boot_from_volume = new ComputeInstanceV2(\"boot-from-volume\", ComputeInstanceV2Args.builder()\n .flavorId(\"s3.large.2\")\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .blockDevices(ComputeInstanceV2BlockDeviceArgs.builder()\n .uuid(\"\")\n .sourceType(\"image\")\n .volumeSize(5)\n .bootIndex(0)\n .destinationType(\"volume\")\n .deleteOnTermination(true)\n .volumeType(\"SSD\")\n .build())\n .networks(ComputeInstanceV2NetworkArgs.builder()\n .uuid(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n boot-from-volume:\n type: flexibleengine:ComputeInstanceV2\n properties:\n flavorId: s3.large.2\n keyPair: my_key_pair_name\n securityGroups:\n - default\n blockDevices:\n - uuid: \n sourceType: image\n volumeSize: 5\n bootIndex: 0\n destinationType: volume\n deleteOnTermination: true\n volumeType: SSD\n networks:\n - uuid: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n```\n\n\n### Boot From an Existing Volume\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst myvol = new flexibleengine.BlockstorageVolumeV2(\"myvol\", {\n size: 5,\n imageId: \"\",\n});\nconst boot_from_volume = new flexibleengine.ComputeInstanceV2(\"boot-from-volume\", {\n flavorId: \"s3.large.2\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n blockDevices: [{\n uuid: myvol.blockstorageVolumeV2Id,\n sourceType: \"volume\",\n bootIndex: 0,\n destinationType: \"volume\",\n deleteOnTermination: true,\n }],\n networks: [{\n uuid: flexibleengine_vpc_subnet_v1.example_subnet.id,\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nmyvol = flexibleengine.BlockstorageVolumeV2(\"myvol\",\n size=5,\n image_id=\"\")\nboot_from_volume = flexibleengine.ComputeInstanceV2(\"boot-from-volume\",\n flavor_id=\"s3.large.2\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"],\n block_devices=[{\n \"uuid\": myvol.blockstorage_volume_v2_id,\n \"source_type\": \"volume\",\n \"boot_index\": 0,\n \"destination_type\": \"volume\",\n \"delete_on_termination\": True,\n }],\n networks=[{\n \"uuid\": flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var myvol = new Flexibleengine.BlockstorageVolumeV2(\"myvol\", new()\n {\n Size = 5,\n ImageId = \"\",\n });\n\n var boot_from_volume = new Flexibleengine.ComputeInstanceV2(\"boot-from-volume\", new()\n {\n FlavorId = \"s3.large.2\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n BlockDevices = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n Uuid = myvol.BlockstorageVolumeV2Id,\n SourceType = \"volume\",\n BootIndex = 0,\n DestinationType = \"volume\",\n DeleteOnTermination = true,\n },\n },\n Networks = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2NetworkArgs\n {\n Uuid = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmyvol, err := flexibleengine.NewBlockstorageVolumeV2(ctx, \"myvol\", &flexibleengine.BlockstorageVolumeV2Args{\n\t\t\tSize: pulumi.Float64(5),\n\t\t\tImageId: pulumi.String(\"\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewComputeInstanceV2(ctx, \"boot-from-volume\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tFlavorId: pulumi.String(\"s3.large.2\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t\tBlockDevices: flexibleengine.ComputeInstanceV2BlockDeviceArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tUuid: myvol.BlockstorageVolumeV2Id,\n\t\t\t\t\tSourceType: pulumi.String(\"volume\"),\n\t\t\t\t\tBootIndex: pulumi.Float64(0),\n\t\t\t\t\tDestinationType: pulumi.String(\"volume\"),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t},\n\t\t\t},\n\t\t\tNetworks: flexibleengine.ComputeInstanceV2NetworkArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2NetworkArgs{\n\t\t\t\t\tUuid: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\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.flexibleengine.BlockstorageVolumeV2;\nimport com.pulumi.flexibleengine.BlockstorageVolumeV2Args;\nimport com.pulumi.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2BlockDeviceArgs;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2NetworkArgs;\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 myvol = new BlockstorageVolumeV2(\"myvol\", BlockstorageVolumeV2Args.builder()\n .size(5)\n .imageId(\"\")\n .build());\n\n var boot_from_volume = new ComputeInstanceV2(\"boot-from-volume\", ComputeInstanceV2Args.builder()\n .flavorId(\"s3.large.2\")\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .blockDevices(ComputeInstanceV2BlockDeviceArgs.builder()\n .uuid(myvol.blockstorageVolumeV2Id())\n .sourceType(\"volume\")\n .bootIndex(0)\n .destinationType(\"volume\")\n .deleteOnTermination(true)\n .build())\n .networks(ComputeInstanceV2NetworkArgs.builder()\n .uuid(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n myvol:\n type: flexibleengine:BlockstorageVolumeV2\n properties:\n size: 5\n imageId: \n boot-from-volume:\n type: flexibleengine:ComputeInstanceV2\n properties:\n flavorId: s3.large.2\n keyPair: my_key_pair_name\n securityGroups:\n - default\n blockDevices:\n - uuid: ${myvol.blockstorageVolumeV2Id}\n sourceType: volume\n bootIndex: 0\n destinationType: volume\n deleteOnTermination: true\n networks:\n - uuid: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n```\n\n\n### Boot Instance, Create Volume, and Attach Volume as a Block Device\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst instance1 = new flexibleengine.ComputeInstanceV2(\"instance1\", {\n blockDevices: [\n {\n bootIndex: 0,\n deleteOnTermination: true,\n destinationType: \"local\",\n sourceType: \"image\",\n uuid: \"\",\n },\n {\n bootIndex: 1,\n deleteOnTermination: true,\n destinationType: \"volume\",\n sourceType: \"blank\",\n volumeSize: 1,\n },\n ],\n flavorId: \"s3.large.2\",\n imageId: \"\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\ninstance1 = flexibleengine.ComputeInstanceV2(\"instance1\",\n block_devices=[\n {\n \"boot_index\": 0,\n \"delete_on_termination\": True,\n \"destination_type\": \"local\",\n \"source_type\": \"image\",\n \"uuid\": \"\",\n },\n {\n \"boot_index\": 1,\n \"delete_on_termination\": True,\n \"destination_type\": \"volume\",\n \"source_type\": \"blank\",\n \"volume_size\": 1,\n },\n ],\n flavor_id=\"s3.large.2\",\n image_id=\"\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var instance1 = new Flexibleengine.ComputeInstanceV2(\"instance1\", new()\n {\n BlockDevices = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n BootIndex = 0,\n DeleteOnTermination = true,\n DestinationType = \"local\",\n SourceType = \"image\",\n Uuid = \"\",\n },\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n BootIndex = 1,\n DeleteOnTermination = true,\n DestinationType = \"volume\",\n SourceType = \"blank\",\n VolumeSize = 1,\n },\n },\n FlavorId = \"s3.large.2\",\n ImageId = \"\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeInstanceV2(ctx, \"instance1\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tBlockDevices: flexibleengine.ComputeInstanceV2BlockDeviceArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tBootIndex: pulumi.Float64(0),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t\tDestinationType: pulumi.String(\"local\"),\n\t\t\t\t\tSourceType: pulumi.String(\"image\"),\n\t\t\t\t\tUuid: pulumi.String(\"\"),\n\t\t\t\t},\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tBootIndex: pulumi.Float64(1),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t\tDestinationType: pulumi.String(\"volume\"),\n\t\t\t\t\tSourceType: pulumi.String(\"blank\"),\n\t\t\t\t\tVolumeSize: pulumi.Float64(1),\n\t\t\t\t},\n\t\t\t},\n\t\t\tFlavorId: pulumi.String(\"s3.large.2\"),\n\t\t\tImageId: pulumi.String(\"\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\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.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2BlockDeviceArgs;\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 instance1 = new ComputeInstanceV2(\"instance1\", ComputeInstanceV2Args.builder()\n .blockDevices( \n ComputeInstanceV2BlockDeviceArgs.builder()\n .bootIndex(0)\n .deleteOnTermination(true)\n .destinationType(\"local\")\n .sourceType(\"image\")\n .uuid(\"\")\n .build(),\n ComputeInstanceV2BlockDeviceArgs.builder()\n .bootIndex(1)\n .deleteOnTermination(true)\n .destinationType(\"volume\")\n .sourceType(\"blank\")\n .volumeSize(1)\n .build())\n .flavorId(\"s3.large.2\")\n .imageId(\"\")\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n instance1:\n type: flexibleengine:ComputeInstanceV2\n properties:\n blockDevices:\n - bootIndex: 0\n deleteOnTermination: true\n destinationType: local\n sourceType: image\n uuid: \n - bootIndex: 1\n deleteOnTermination: true\n destinationType: volume\n sourceType: blank\n volumeSize: 1\n flavorId: s3.large.2\n imageId: \n keyPair: my_key_pair_name\n securityGroups:\n - default\n```\n\n\n### Boot Instance and Attach Existing Volume as a Block Device\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst volume1 = new flexibleengine.BlockstorageVolumeV2(\"volume1\", {size: 1});\nconst instance1 = new flexibleengine.ComputeInstanceV2(\"instance1\", {\n imageId: \"\",\n flavorId: \"s3.large.2\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n blockDevices: [\n {\n uuid: \"\",\n sourceType: \"image\",\n destinationType: \"local\",\n bootIndex: 0,\n deleteOnTermination: true,\n },\n {\n uuid: volume1.blockstorageVolumeV2Id,\n sourceType: \"volume\",\n destinationType: \"volume\",\n bootIndex: 1,\n deleteOnTermination: true,\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nvolume1 = flexibleengine.BlockstorageVolumeV2(\"volume1\", size=1)\ninstance1 = flexibleengine.ComputeInstanceV2(\"instance1\",\n image_id=\"\",\n flavor_id=\"s3.large.2\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"],\n block_devices=[\n {\n \"uuid\": \"\",\n \"source_type\": \"image\",\n \"destination_type\": \"local\",\n \"boot_index\": 0,\n \"delete_on_termination\": True,\n },\n {\n \"uuid\": volume1.blockstorage_volume_v2_id,\n \"source_type\": \"volume\",\n \"destination_type\": \"volume\",\n \"boot_index\": 1,\n \"delete_on_termination\": True,\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var volume1 = new Flexibleengine.BlockstorageVolumeV2(\"volume1\", new()\n {\n Size = 1,\n });\n\n var instance1 = new Flexibleengine.ComputeInstanceV2(\"instance1\", new()\n {\n ImageId = \"\",\n FlavorId = \"s3.large.2\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n BlockDevices = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n Uuid = \"\",\n SourceType = \"image\",\n DestinationType = \"local\",\n BootIndex = 0,\n DeleteOnTermination = true,\n },\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n Uuid = volume1.BlockstorageVolumeV2Id,\n SourceType = \"volume\",\n DestinationType = \"volume\",\n BootIndex = 1,\n DeleteOnTermination = true,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tvolume1, err := flexibleengine.NewBlockstorageVolumeV2(ctx, \"volume1\", &flexibleengine.BlockstorageVolumeV2Args{\n\t\t\tSize: pulumi.Float64(1),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewComputeInstanceV2(ctx, \"instance1\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tImageId: pulumi.String(\"\"),\n\t\t\tFlavorId: pulumi.String(\"s3.large.2\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t\tBlockDevices: flexibleengine.ComputeInstanceV2BlockDeviceArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tUuid: pulumi.String(\"\"),\n\t\t\t\t\tSourceType: pulumi.String(\"image\"),\n\t\t\t\t\tDestinationType: pulumi.String(\"local\"),\n\t\t\t\t\tBootIndex: pulumi.Float64(0),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t},\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tUuid: volume1.BlockstorageVolumeV2Id,\n\t\t\t\t\tSourceType: pulumi.String(\"volume\"),\n\t\t\t\t\tDestinationType: pulumi.String(\"volume\"),\n\t\t\t\t\tBootIndex: pulumi.Float64(1),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\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.flexibleengine.BlockstorageVolumeV2;\nimport com.pulumi.flexibleengine.BlockstorageVolumeV2Args;\nimport com.pulumi.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2BlockDeviceArgs;\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 volume1 = new BlockstorageVolumeV2(\"volume1\", BlockstorageVolumeV2Args.builder()\n .size(1)\n .build());\n\n var instance1 = new ComputeInstanceV2(\"instance1\", ComputeInstanceV2Args.builder()\n .imageId(\"\")\n .flavorId(\"s3.large.2\")\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .blockDevices( \n ComputeInstanceV2BlockDeviceArgs.builder()\n .uuid(\"\")\n .sourceType(\"image\")\n .destinationType(\"local\")\n .bootIndex(0)\n .deleteOnTermination(true)\n .build(),\n ComputeInstanceV2BlockDeviceArgs.builder()\n .uuid(volume1.blockstorageVolumeV2Id())\n .sourceType(\"volume\")\n .destinationType(\"volume\")\n .bootIndex(1)\n .deleteOnTermination(true)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n volume1:\n type: flexibleengine:BlockstorageVolumeV2\n properties:\n size: 1\n instance1:\n type: flexibleengine:ComputeInstanceV2\n properties:\n imageId: \n flavorId: s3.large.2\n keyPair: my_key_pair_name\n securityGroups:\n - default\n blockDevices:\n - uuid: \n sourceType: image\n destinationType: local\n bootIndex: 0\n deleteOnTermination: true\n - uuid: ${volume1.blockstorageVolumeV2Id}\n sourceType: volume\n destinationType: volume\n bootIndex: 1\n deleteOnTermination: true\n```\n\n\n### Instance With Multiple Networks\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst eip1 = new flexibleengine.VpcEip(\"eip1\", {\n publicip: {\n type: \"5_bgp\",\n },\n bandwidth: {\n name: \"test\",\n size: 10,\n shareType: \"PER\",\n },\n});\nconst multi_net = new flexibleengine.ComputeInstanceV2(\"multi-net\", {\n imageId: \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavorId: \"s3.large.2\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n networks: [\n {\n uuid: flexibleengine_vpc_subnet_v1.example_subnet.id,\n },\n {\n uuid: flexibleengine_vpc_subnet_v1.example_subnet_2.id,\n },\n ],\n});\nconst myip = new flexibleengine.ComputeFloatingipAssociateV2(\"myip\", {\n floatingIp: eip1.publicip.apply(publicip => publicip.ipAddress),\n instanceId: multi_net.computeInstanceV2Id,\n fixedIp: multi_net.networks.apply(networks => networks?.[1]?.fixedIpV4),\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\neip1 = flexibleengine.VpcEip(\"eip1\",\n publicip={\n \"type\": \"5_bgp\",\n },\n bandwidth={\n \"name\": \"test\",\n \"size\": 10,\n \"share_type\": \"PER\",\n })\nmulti_net = flexibleengine.ComputeInstanceV2(\"multi-net\",\n image_id=\"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavor_id=\"s3.large.2\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"],\n networks=[\n {\n \"uuid\": flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n },\n {\n \"uuid\": flexibleengine_vpc_subnet_v1[\"example_subnet_2\"][\"id\"],\n },\n ])\nmyip = flexibleengine.ComputeFloatingipAssociateV2(\"myip\",\n floating_ip=eip1.publicip.ip_address,\n instance_id=multi_net.compute_instance_v2_id,\n fixed_ip=multi_net.networks[1].fixed_ip_v4)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var eip1 = new Flexibleengine.VpcEip(\"eip1\", new()\n {\n Publicip = new Flexibleengine.Inputs.VpcEipPublicipArgs\n {\n Type = \"5_bgp\",\n },\n Bandwidth = new Flexibleengine.Inputs.VpcEipBandwidthArgs\n {\n Name = \"test\",\n Size = 10,\n ShareType = \"PER\",\n },\n });\n\n var multi_net = new Flexibleengine.ComputeInstanceV2(\"multi-net\", new()\n {\n ImageId = \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n FlavorId = \"s3.large.2\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n Networks = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2NetworkArgs\n {\n Uuid = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n },\n new Flexibleengine.Inputs.ComputeInstanceV2NetworkArgs\n {\n Uuid = flexibleengine_vpc_subnet_v1.Example_subnet_2.Id,\n },\n },\n });\n\n var myip = new Flexibleengine.ComputeFloatingipAssociateV2(\"myip\", new()\n {\n FloatingIp = eip1.Publicip.Apply(publicip => publicip.IpAddress),\n InstanceId = multi_net.ComputeInstanceV2Id,\n FixedIp = multi_net.Networks.Apply(networks => networks[1]?.FixedIpV4),\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\teip1, err := flexibleengine.NewVpcEip(ctx, \"eip1\", &flexibleengine.VpcEipArgs{\n\t\t\tPublicip: &flexibleengine.VpcEipPublicipArgs{\n\t\t\t\tType: pulumi.String(\"5_bgp\"),\n\t\t\t},\n\t\t\tBandwidth: &flexibleengine.VpcEipBandwidthArgs{\n\t\t\t\tName: pulumi.String(\"test\"),\n\t\t\t\tSize: pulumi.Float64(10),\n\t\t\t\tShareType: pulumi.String(\"PER\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmulti_net, err := flexibleengine.NewComputeInstanceV2(ctx, \"multi-net\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tImageId: pulumi.String(\"ad091b52-742f-469e-8f3c-fd81cadf0743\"),\n\t\t\tFlavorId: pulumi.String(\"s3.large.2\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t\tNetworks: flexibleengine.ComputeInstanceV2NetworkArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2NetworkArgs{\n\t\t\t\t\tUuid: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\n\t\t\t\t},\n\t\t\t\t&flexibleengine.ComputeInstanceV2NetworkArgs{\n\t\t\t\t\tUuid: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet_2.Id),\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\t_, err = flexibleengine.NewComputeFloatingipAssociateV2(ctx, \"myip\", &flexibleengine.ComputeFloatingipAssociateV2Args{\n\t\t\tFloatingIp: pulumi.String(eip1.Publicip.ApplyT(func(publicip flexibleengine.VpcEipPublicip) (*string, error) {\n\t\t\t\treturn &publicip.IpAddress, nil\n\t\t\t}).(pulumi.StringPtrOutput)),\n\t\t\tInstanceId: multi_net.ComputeInstanceV2Id,\n\t\t\tFixedIp: pulumi.String(multi_net.Networks.ApplyT(func(networks []flexibleengine.ComputeInstanceV2Network) (*string, error) {\n\t\t\t\treturn &networks[1].FixedIpV4, nil\n\t\t\t}).(pulumi.StringPtrOutput)),\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.flexibleengine.VpcEip;\nimport com.pulumi.flexibleengine.VpcEipArgs;\nimport com.pulumi.flexibleengine.inputs.VpcEipPublicipArgs;\nimport com.pulumi.flexibleengine.inputs.VpcEipBandwidthArgs;\nimport com.pulumi.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2NetworkArgs;\nimport com.pulumi.flexibleengine.ComputeFloatingipAssociateV2;\nimport com.pulumi.flexibleengine.ComputeFloatingipAssociateV2Args;\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 eip1 = new VpcEip(\"eip1\", VpcEipArgs.builder()\n .publicip(VpcEipPublicipArgs.builder()\n .type(\"5_bgp\")\n .build())\n .bandwidth(VpcEipBandwidthArgs.builder()\n .name(\"test\")\n .size(10)\n .shareType(\"PER\")\n .build())\n .build());\n\n var multi_net = new ComputeInstanceV2(\"multi-net\", ComputeInstanceV2Args.builder()\n .imageId(\"ad091b52-742f-469e-8f3c-fd81cadf0743\")\n .flavorId(\"s3.large.2\")\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .networks( \n ComputeInstanceV2NetworkArgs.builder()\n .uuid(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .build(),\n ComputeInstanceV2NetworkArgs.builder()\n .uuid(flexibleengine_vpc_subnet_v1.example_subnet_2().id())\n .build())\n .build());\n\n var myip = new ComputeFloatingipAssociateV2(\"myip\", ComputeFloatingipAssociateV2Args.builder()\n .floatingIp(eip1.publicip().applyValue(publicip -> publicip.ipAddress()))\n .instanceId(multi_net.computeInstanceV2Id())\n .fixedIp(multi_net.networks().applyValue(networks -> networks[1].fixedIpV4()))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n eip1:\n type: flexibleengine:VpcEip\n properties:\n publicip:\n type: 5_bgp\n bandwidth:\n name: test\n size: 10\n shareType: PER\n multi-net:\n type: flexibleengine:ComputeInstanceV2\n properties:\n imageId: ad091b52-742f-469e-8f3c-fd81cadf0743\n flavorId: s3.large.2\n keyPair: my_key_pair_name\n securityGroups:\n - default\n networks:\n - uuid: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n - uuid: ${flexibleengine_vpc_subnet_v1.example_subnet_2.id}\n myip:\n type: flexibleengine:ComputeFloatingipAssociateV2\n properties:\n floatingIp: ${eip1.publicip.ipAddress}\n instanceId: ${[\"multi-net\"].computeInstanceV2Id}\n fixedIp: ${[\"multi-net\"].networks[1].fixedIpV4}\n```\n\n\n### Instance with Multiple Ephemeral Disks\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst multi_eph = new flexibleengine.ComputeInstanceV2(\"multi-eph\", {\n blockDevices: [\n {\n bootIndex: 0,\n deleteOnTermination: true,\n destinationType: \"local\",\n sourceType: \"image\",\n uuid: \"\",\n },\n {\n bootIndex: -1,\n deleteOnTermination: true,\n destinationType: \"local\",\n sourceType: \"blank\",\n volumeSize: 1,\n },\n {\n bootIndex: -1,\n deleteOnTermination: true,\n destinationType: \"local\",\n sourceType: \"blank\",\n volumeSize: 1,\n },\n ],\n flavorId: \"s3.large.2\",\n imageId: \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nmulti_eph = flexibleengine.ComputeInstanceV2(\"multi-eph\",\n block_devices=[\n {\n \"boot_index\": 0,\n \"delete_on_termination\": True,\n \"destination_type\": \"local\",\n \"source_type\": \"image\",\n \"uuid\": \"\",\n },\n {\n \"boot_index\": -1,\n \"delete_on_termination\": True,\n \"destination_type\": \"local\",\n \"source_type\": \"blank\",\n \"volume_size\": 1,\n },\n {\n \"boot_index\": -1,\n \"delete_on_termination\": True,\n \"destination_type\": \"local\",\n \"source_type\": \"blank\",\n \"volume_size\": 1,\n },\n ],\n flavor_id=\"s3.large.2\",\n image_id=\"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var multi_eph = new Flexibleengine.ComputeInstanceV2(\"multi-eph\", new()\n {\n BlockDevices = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n BootIndex = 0,\n DeleteOnTermination = true,\n DestinationType = \"local\",\n SourceType = \"image\",\n Uuid = \"\",\n },\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n BootIndex = -1,\n DeleteOnTermination = true,\n DestinationType = \"local\",\n SourceType = \"blank\",\n VolumeSize = 1,\n },\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n BootIndex = -1,\n DeleteOnTermination = true,\n DestinationType = \"local\",\n SourceType = \"blank\",\n VolumeSize = 1,\n },\n },\n FlavorId = \"s3.large.2\",\n ImageId = \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeInstanceV2(ctx, \"multi-eph\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tBlockDevices: flexibleengine.ComputeInstanceV2BlockDeviceArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tBootIndex: pulumi.Float64(0),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t\tDestinationType: pulumi.String(\"local\"),\n\t\t\t\t\tSourceType: pulumi.String(\"image\"),\n\t\t\t\t\tUuid: pulumi.String(\"\"),\n\t\t\t\t},\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tBootIndex: pulumi.Float64(-1),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t\tDestinationType: pulumi.String(\"local\"),\n\t\t\t\t\tSourceType: pulumi.String(\"blank\"),\n\t\t\t\t\tVolumeSize: pulumi.Float64(1),\n\t\t\t\t},\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tBootIndex: pulumi.Float64(-1),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t\tDestinationType: pulumi.String(\"local\"),\n\t\t\t\t\tSourceType: pulumi.String(\"blank\"),\n\t\t\t\t\tVolumeSize: pulumi.Float64(1),\n\t\t\t\t},\n\t\t\t},\n\t\t\tFlavorId: pulumi.String(\"s3.large.2\"),\n\t\t\tImageId: pulumi.String(\"ad091b52-742f-469e-8f3c-fd81cadf0743\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\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.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2BlockDeviceArgs;\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 multi_eph = new ComputeInstanceV2(\"multi-eph\", ComputeInstanceV2Args.builder()\n .blockDevices( \n ComputeInstanceV2BlockDeviceArgs.builder()\n .bootIndex(0)\n .deleteOnTermination(true)\n .destinationType(\"local\")\n .sourceType(\"image\")\n .uuid(\"\")\n .build(),\n ComputeInstanceV2BlockDeviceArgs.builder()\n .bootIndex(-1)\n .deleteOnTermination(true)\n .destinationType(\"local\")\n .sourceType(\"blank\")\n .volumeSize(1)\n .build(),\n ComputeInstanceV2BlockDeviceArgs.builder()\n .bootIndex(-1)\n .deleteOnTermination(true)\n .destinationType(\"local\")\n .sourceType(\"blank\")\n .volumeSize(1)\n .build())\n .flavorId(\"s3.large.2\")\n .imageId(\"ad091b52-742f-469e-8f3c-fd81cadf0743\")\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n multi-eph:\n type: flexibleengine:ComputeInstanceV2\n properties:\n blockDevices:\n - bootIndex: 0\n deleteOnTermination: true\n destinationType: local\n sourceType: image\n uuid: \n - bootIndex: -1\n deleteOnTermination: true\n destinationType: local\n sourceType: blank\n volumeSize: 1\n - bootIndex: -1\n deleteOnTermination: true\n destinationType: local\n sourceType: blank\n volumeSize: 1\n flavorId: s3.large.2\n imageId: ad091b52-742f-469e-8f3c-fd81cadf0743\n keyPair: my_key_pair_name\n securityGroups:\n - default\n```\n\n\n### Instance with User Data (cloud-init)\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst instance1 = new flexibleengine.ComputeInstanceV2(\"instance1\", {\n imageId: \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavorId: \"s3.large.2\",\n keyPair: \"my_key_pair_name\",\n securityGroups: [\"default\"],\n userData: `#cloud-config\nhostname: instance_1.example.com\nfqdn: instance_1.example.com`,\n networks: [{\n uuid: flexibleengine_vpc_subnet_v1.example_subnet.id,\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\ninstance1 = flexibleengine.ComputeInstanceV2(\"instance1\",\n image_id=\"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n flavor_id=\"s3.large.2\",\n key_pair=\"my_key_pair_name\",\n security_groups=[\"default\"],\n user_data=\"\"\"#cloud-config\nhostname: instance_1.example.com\nfqdn: instance_1.example.com\"\"\",\n networks=[{\n \"uuid\": flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var instance1 = new Flexibleengine.ComputeInstanceV2(\"instance1\", new()\n {\n ImageId = \"ad091b52-742f-469e-8f3c-fd81cadf0743\",\n FlavorId = \"s3.large.2\",\n KeyPair = \"my_key_pair_name\",\n SecurityGroups = new[]\n {\n \"default\",\n },\n UserData = @\"#cloud-config\nhostname: instance_1.example.com\nfqdn: instance_1.example.com\",\n Networks = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2NetworkArgs\n {\n Uuid = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeInstanceV2(ctx, \"instance1\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tImageId: pulumi.String(\"ad091b52-742f-469e-8f3c-fd81cadf0743\"),\n\t\t\tFlavorId: pulumi.String(\"s3.large.2\"),\n\t\t\tKeyPair: pulumi.String(\"my_key_pair_name\"),\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t\tUserData: pulumi.String(\"#cloud-config\\nhostname: instance_1.example.com\\nfqdn: instance_1.example.com\"),\n\t\t\tNetworks: flexibleengine.ComputeInstanceV2NetworkArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2NetworkArgs{\n\t\t\t\t\tUuid: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\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.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2NetworkArgs;\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 instance1 = new ComputeInstanceV2(\"instance1\", ComputeInstanceV2Args.builder()\n .imageId(\"ad091b52-742f-469e-8f3c-fd81cadf0743\")\n .flavorId(\"s3.large.2\")\n .keyPair(\"my_key_pair_name\")\n .securityGroups(\"default\")\n .userData(\"\"\"\n#cloud-config\nhostname: instance_1.example.com\nfqdn: instance_1.example.com \"\"\")\n .networks(ComputeInstanceV2NetworkArgs.builder()\n .uuid(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n instance1:\n type: flexibleengine:ComputeInstanceV2\n properties:\n imageId: ad091b52-742f-469e-8f3c-fd81cadf0743\n flavorId: s3.large.2\n keyPair: my_key_pair_name\n securityGroups:\n - default\n userData: |-\n #cloud-config\n hostname: instance_1.example.com\n fqdn: instance_1.example.com\n networks:\n - uuid: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n```\n\n\n`user_data` can come from a variety of sources: inline, read in from the `file`\nfunction, or the `template_cloudinit_config` resource.\n\n## Notes\n\n### Multiple Ephemeral Disks\n\nIt's possible to specify multiple `block_device` entries to create an instance\nwith multiple ephemeral (local) disks. In order to create multiple ephemeral\ndisks, the sum of the total amount of ephemeral space must be less than or\nequal to what the chosen flavor supports.\n\nThe following example shows how to create an instance with multiple ephemeral\ndisks:\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst foo = new flexibleengine.ComputeInstanceV2(\"foo\", {\n blockDevices: [\n {\n bootIndex: 0,\n deleteOnTermination: true,\n destinationType: \"local\",\n sourceType: \"image\",\n uuid: \"\",\n },\n {\n bootIndex: -1,\n deleteOnTermination: true,\n destinationType: \"local\",\n sourceType: \"blank\",\n volumeSize: 1,\n },\n {\n bootIndex: -1,\n deleteOnTermination: true,\n destinationType: \"local\",\n sourceType: \"blank\",\n volumeSize: 1,\n },\n ],\n securityGroups: [\"default\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nfoo = flexibleengine.ComputeInstanceV2(\"foo\",\n block_devices=[\n {\n \"boot_index\": 0,\n \"delete_on_termination\": True,\n \"destination_type\": \"local\",\n \"source_type\": \"image\",\n \"uuid\": \"\",\n },\n {\n \"boot_index\": -1,\n \"delete_on_termination\": True,\n \"destination_type\": \"local\",\n \"source_type\": \"blank\",\n \"volume_size\": 1,\n },\n {\n \"boot_index\": -1,\n \"delete_on_termination\": True,\n \"destination_type\": \"local\",\n \"source_type\": \"blank\",\n \"volume_size\": 1,\n },\n ],\n security_groups=[\"default\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var foo = new Flexibleengine.ComputeInstanceV2(\"foo\", new()\n {\n BlockDevices = new[]\n {\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n BootIndex = 0,\n DeleteOnTermination = true,\n DestinationType = \"local\",\n SourceType = \"image\",\n Uuid = \"\",\n },\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n BootIndex = -1,\n DeleteOnTermination = true,\n DestinationType = \"local\",\n SourceType = \"blank\",\n VolumeSize = 1,\n },\n new Flexibleengine.Inputs.ComputeInstanceV2BlockDeviceArgs\n {\n BootIndex = -1,\n DeleteOnTermination = true,\n DestinationType = \"local\",\n SourceType = \"blank\",\n VolumeSize = 1,\n },\n },\n SecurityGroups = new[]\n {\n \"default\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeInstanceV2(ctx, \"foo\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tBlockDevices: flexibleengine.ComputeInstanceV2BlockDeviceArray{\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tBootIndex: pulumi.Float64(0),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t\tDestinationType: pulumi.String(\"local\"),\n\t\t\t\t\tSourceType: pulumi.String(\"image\"),\n\t\t\t\t\tUuid: pulumi.String(\"\"),\n\t\t\t\t},\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tBootIndex: pulumi.Float64(-1),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t\tDestinationType: pulumi.String(\"local\"),\n\t\t\t\t\tSourceType: pulumi.String(\"blank\"),\n\t\t\t\t\tVolumeSize: pulumi.Float64(1),\n\t\t\t\t},\n\t\t\t\t&flexibleengine.ComputeInstanceV2BlockDeviceArgs{\n\t\t\t\t\tBootIndex: pulumi.Float64(-1),\n\t\t\t\t\tDeleteOnTermination: pulumi.Bool(true),\n\t\t\t\t\tDestinationType: pulumi.String(\"local\"),\n\t\t\t\t\tSourceType: pulumi.String(\"blank\"),\n\t\t\t\t\tVolumeSize: pulumi.Float64(1),\n\t\t\t\t},\n\t\t\t},\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\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.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.inputs.ComputeInstanceV2BlockDeviceArgs;\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 foo = new ComputeInstanceV2(\"foo\", ComputeInstanceV2Args.builder()\n .blockDevices( \n ComputeInstanceV2BlockDeviceArgs.builder()\n .bootIndex(0)\n .deleteOnTermination(true)\n .destinationType(\"local\")\n .sourceType(\"image\")\n .uuid(\"\")\n .build(),\n ComputeInstanceV2BlockDeviceArgs.builder()\n .bootIndex(-1)\n .deleteOnTermination(true)\n .destinationType(\"local\")\n .sourceType(\"blank\")\n .volumeSize(1)\n .build(),\n ComputeInstanceV2BlockDeviceArgs.builder()\n .bootIndex(-1)\n .deleteOnTermination(true)\n .destinationType(\"local\")\n .sourceType(\"blank\")\n .volumeSize(1)\n .build())\n .securityGroups(\"default\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n foo:\n type: flexibleengine:ComputeInstanceV2\n properties:\n blockDevices:\n - bootIndex: 0\n deleteOnTermination: true\n destinationType: local\n sourceType: image\n uuid: \n - bootIndex: -1\n deleteOnTermination: true\n destinationType: local\n sourceType: blank\n volumeSize: 1\n - bootIndex: -1\n deleteOnTermination: true\n destinationType: local\n sourceType: blank\n volumeSize: 1\n securityGroups:\n - default\n```\n\n\n## Import\n\nInstances can be imported by their `id`. For example,\n\n```sh\n$ pulumi import flexibleengine:index/computeInstanceV2:ComputeInstanceV2 my_instance b11b407c-e604-4e8d-8bc4-92398320b847\n```\n\nNote that the imported state may not be identical to your resource definition, due to some attrubutes\n\nmissing from the API response, security or some other reason. The missing attributes include:\n\n`admin_pass`, `config_drive`, `user_data`, `block_device`, `scheduler_hints`, `stop_before_destroy`,\n\n`network/access_network` and arguments for pre-paid. It is generally recommended running\n\n`pulumi preview` after importing an instance. You can then decide if changes should\n\nbe applied to the instance, or the resource definition should be updated to align\n\nwith the instance. Also you can ignore changes as below.\n\nhcl\n\nresource \"flexibleengine_compute_instance_v2\" \"my_instance\" {\n\n ...\n\n lifecycle {\n\n ignore_changes = [\n\n user_data, block_device,\n\n ]\n\n }\n\n}\n\n",
"properties": {
"accessIpV4": {
"type": "string",
"description": "The first detected Fixed IPv4 address *or* the Floating IP.\n"
},
"accessIpV6": {
"type": "string",
"description": "The first detected Fixed IPv6 address.\n"
},
"adminPass": {
"type": "string",
"description": "The administrative password to assign to the server.\n"
},
"allMetadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"autoRecovery": {
"type": "boolean",
"description": "Configures or deletes automatic recovery of an instance\n"
},
"availabilityZone": {
"type": "string",
"description": "The availability zone in which to create the server.\nChanging this creates a new server.\n"
},
"blockDevices": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2BlockDevice:ComputeInstanceV2BlockDevice"
},
"description": "Configuration of block devices. The block_device object\nstructure is documented below. You can specify multiple block devices which will create an instance with\nmultiple disks. This configuration is very flexible, so please see the\nfollowing [reference](http://docs.openstack.org/developer/nova/block_device_mapping.html) for more information.\n"
},
"computeInstanceV2Id": {
"type": "string"
},
"configDrive": {
"type": "boolean",
"description": "Whether to use the config_drive feature to\nconfigure the instance. Changing this creates a new server.\n"
},
"flavorId": {
"type": "string",
"description": "The flavor ID of the desired flavor for the server.\nIt is **Required** if `flavor_name` is empty. Changing this resizes the existing server.\n"
},
"flavorName": {
"type": "string",
"description": "The name of the desired flavor for the server.\nIt is **Required** if `flavor_id` is empty. Changing this resizes the existing server.\n"
},
"floatingIp": {
"type": "string",
"description": "The EIP address that is associate to the instance.\n"
},
"imageId": {
"type": "string",
"description": "The image ID of the desired image for the server.\nIt is **Required** if `image_name` is empty and not booting from a volume. Do not specify if booting from a volume.\nChanging this creates a new server.\n"
},
"imageName": {
"type": "string",
"description": "The name of the desired image for the server.\nIt is **Required** if `image_id` is empty and not booting from a volume. Do not specify if booting from a volume.\nChanging this creates a new server.\n"
},
"keyPair": {
"type": "string",
"description": "The name of a key pair to put on the server. The key\npair must already be created and associated with the tenant's account. Changing this creates a new server.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the instance.\n"
},
"name": {
"type": "string",
"description": "A unique name for the resource.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2Network:ComputeInstanceV2Network"
},
"description": "An array of one or more networks to attach to the\ninstance. The network object structure is documented below. Changing this\ncreates a new server.\n"
},
"personalities": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2Personality:ComputeInstanceV2Personality"
}
},
"region": {
"type": "string",
"description": "The region in which to create the server instance.\nIf omitted, the `region` argument of the provider is used. Changing this creates a new server.\n"
},
"schedulerHints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2SchedulerHint:ComputeInstanceV2SchedulerHint"
},
"description": "Provide the Nova scheduler with hints on how\nthe instance should be launched. The scheduler_hints object structure is documented below.\n"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more security group names\nto associate with the server. Changing this results in adding/removing\nsecurity groups from the existing server. *Note*: When attaching the\ninstance to networks using Ports, place the security groups on the Port and not the instance.\n"
},
"status": {
"type": "string",
"description": "The status of the instance.\n"
},
"stopBeforeDestroy": {
"type": "boolean",
"description": "Whether to try stop instance gracefully\nbefore destroying it, thus giving chance for guest OS daemons to stop correctly.\nIf instance doesn't stop within timeout, it will be destroyed anyway.\n"
},
"systemDiskId": {
"type": "string",
"description": "The system disk volume ID.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the key/value pairs to associate with the instance.\n\n\nThe `network` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2Timeouts:ComputeInstanceV2Timeouts"
},
"userData": {
"type": "string",
"description": "The user data to provide when launching the instance.\nChanging this creates a new server.\n"
},
"volumeAttacheds": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2VolumeAttached:ComputeInstanceV2VolumeAttached"
},
"description": "An array of one or more disks to attach to the instance.\nThe volume_attached object structure is documented below.\n"
}
},
"type": "object",
"required": [
"accessIpV4",
"accessIpV6",
"allMetadata",
"autoRecovery",
"availabilityZone",
"computeInstanceV2Id",
"flavorId",
"flavorName",
"floatingIp",
"imageId",
"imageName",
"name",
"region",
"securityGroups",
"status",
"systemDiskId",
"volumeAttacheds"
],
"inputProperties": {
"adminPass": {
"type": "string",
"description": "The administrative password to assign to the server.\n"
},
"autoRecovery": {
"type": "boolean",
"description": "Configures or deletes automatic recovery of an instance\n"
},
"availabilityZone": {
"type": "string",
"description": "The availability zone in which to create the server.\nChanging this creates a new server.\n"
},
"blockDevices": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2BlockDevice:ComputeInstanceV2BlockDevice"
},
"description": "Configuration of block devices. The block_device object\nstructure is documented below. You can specify multiple block devices which will create an instance with\nmultiple disks. This configuration is very flexible, so please see the\nfollowing [reference](http://docs.openstack.org/developer/nova/block_device_mapping.html) for more information.\n"
},
"computeInstanceV2Id": {
"type": "string"
},
"configDrive": {
"type": "boolean",
"description": "Whether to use the config_drive feature to\nconfigure the instance. Changing this creates a new server.\n"
},
"flavorId": {
"type": "string",
"description": "The flavor ID of the desired flavor for the server.\nIt is **Required** if `flavor_name` is empty. Changing this resizes the existing server.\n"
},
"flavorName": {
"type": "string",
"description": "The name of the desired flavor for the server.\nIt is **Required** if `flavor_id` is empty. Changing this resizes the existing server.\n"
},
"imageId": {
"type": "string",
"description": "The image ID of the desired image for the server.\nIt is **Required** if `image_name` is empty and not booting from a volume. Do not specify if booting from a volume.\nChanging this creates a new server.\n"
},
"imageName": {
"type": "string",
"description": "The name of the desired image for the server.\nIt is **Required** if `image_id` is empty and not booting from a volume. Do not specify if booting from a volume.\nChanging this creates a new server.\n"
},
"keyPair": {
"type": "string",
"description": "The name of a key pair to put on the server. The key\npair must already be created and associated with the tenant's account. Changing this creates a new server.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the instance.\n"
},
"name": {
"type": "string",
"description": "A unique name for the resource.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2Network:ComputeInstanceV2Network"
},
"description": "An array of one or more networks to attach to the\ninstance. The network object structure is documented below. Changing this\ncreates a new server.\n"
},
"personalities": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2Personality:ComputeInstanceV2Personality"
}
},
"region": {
"type": "string",
"description": "The region in which to create the server instance.\nIf omitted, the `region` argument of the provider is used. Changing this creates a new server.\n"
},
"schedulerHints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2SchedulerHint:ComputeInstanceV2SchedulerHint"
},
"description": "Provide the Nova scheduler with hints on how\nthe instance should be launched. The scheduler_hints object structure is documented below.\n"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more security group names\nto associate with the server. Changing this results in adding/removing\nsecurity groups from the existing server. *Note*: When attaching the\ninstance to networks using Ports, place the security groups on the Port and not the instance.\n"
},
"stopBeforeDestroy": {
"type": "boolean",
"description": "Whether to try stop instance gracefully\nbefore destroying it, thus giving chance for guest OS daemons to stop correctly.\nIf instance doesn't stop within timeout, it will be destroyed anyway.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the key/value pairs to associate with the instance.\n\n\nThe `network` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2Timeouts:ComputeInstanceV2Timeouts"
},
"userData": {
"type": "string",
"description": "The user data to provide when launching the instance.\nChanging this creates a new server.\n"
}
},
"stateInputs": {
"description": "Input properties used for looking up and filtering ComputeInstanceV2 resources.\n",
"properties": {
"accessIpV4": {
"type": "string",
"description": "The first detected Fixed IPv4 address *or* the Floating IP.\n"
},
"accessIpV6": {
"type": "string",
"description": "The first detected Fixed IPv6 address.\n"
},
"adminPass": {
"type": "string",
"description": "The administrative password to assign to the server.\n"
},
"allMetadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"autoRecovery": {
"type": "boolean",
"description": "Configures or deletes automatic recovery of an instance\n"
},
"availabilityZone": {
"type": "string",
"description": "The availability zone in which to create the server.\nChanging this creates a new server.\n"
},
"blockDevices": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2BlockDevice:ComputeInstanceV2BlockDevice"
},
"description": "Configuration of block devices. The block_device object\nstructure is documented below. You can specify multiple block devices which will create an instance with\nmultiple disks. This configuration is very flexible, so please see the\nfollowing [reference](http://docs.openstack.org/developer/nova/block_device_mapping.html) for more information.\n"
},
"computeInstanceV2Id": {
"type": "string"
},
"configDrive": {
"type": "boolean",
"description": "Whether to use the config_drive feature to\nconfigure the instance. Changing this creates a new server.\n"
},
"flavorId": {
"type": "string",
"description": "The flavor ID of the desired flavor for the server.\nIt is **Required** if `flavor_name` is empty. Changing this resizes the existing server.\n"
},
"flavorName": {
"type": "string",
"description": "The name of the desired flavor for the server.\nIt is **Required** if `flavor_id` is empty. Changing this resizes the existing server.\n"
},
"floatingIp": {
"type": "string",
"description": "The EIP address that is associate to the instance.\n"
},
"imageId": {
"type": "string",
"description": "The image ID of the desired image for the server.\nIt is **Required** if `image_name` is empty and not booting from a volume. Do not specify if booting from a volume.\nChanging this creates a new server.\n"
},
"imageName": {
"type": "string",
"description": "The name of the desired image for the server.\nIt is **Required** if `image_id` is empty and not booting from a volume. Do not specify if booting from a volume.\nChanging this creates a new server.\n"
},
"keyPair": {
"type": "string",
"description": "The name of a key pair to put on the server. The key\npair must already be created and associated with the tenant's account. Changing this creates a new server.\n"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The key/value pairs to associate with the instance.\n"
},
"name": {
"type": "string",
"description": "A unique name for the resource.\n"
},
"networks": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2Network:ComputeInstanceV2Network"
},
"description": "An array of one or more networks to attach to the\ninstance. The network object structure is documented below. Changing this\ncreates a new server.\n"
},
"personalities": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2Personality:ComputeInstanceV2Personality"
}
},
"region": {
"type": "string",
"description": "The region in which to create the server instance.\nIf omitted, the `region` argument of the provider is used. Changing this creates a new server.\n"
},
"schedulerHints": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2SchedulerHint:ComputeInstanceV2SchedulerHint"
},
"description": "Provide the Nova scheduler with hints on how\nthe instance should be launched. The scheduler_hints object structure is documented below.\n"
},
"securityGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more security group names\nto associate with the server. Changing this results in adding/removing\nsecurity groups from the existing server. *Note*: When attaching the\ninstance to networks using Ports, place the security groups on the Port and not the instance.\n"
},
"status": {
"type": "string",
"description": "The status of the instance.\n"
},
"stopBeforeDestroy": {
"type": "boolean",
"description": "Whether to try stop instance gracefully\nbefore destroying it, thus giving chance for guest OS daemons to stop correctly.\nIf instance doesn't stop within timeout, it will be destroyed anyway.\n"
},
"systemDiskId": {
"type": "string",
"description": "The system disk volume ID.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the key/value pairs to associate with the instance.\n\n\nThe `network` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2Timeouts:ComputeInstanceV2Timeouts"
},
"userData": {
"type": "string",
"description": "The user data to provide when launching the instance.\nChanging this creates a new server.\n"
},
"volumeAttacheds": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FComputeInstanceV2VolumeAttached:ComputeInstanceV2VolumeAttached"
},
"description": "An array of one or more disks to attach to the instance.\nThe volume_attached object structure is documented below.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/computeInterfaceAttachV2:ComputeInterfaceAttachV2": {
"description": "Attaches a Network Interface (a Port) to an Instance using the FlexibleEngine\nCompute (Nova) v2 API.\n\n## Example Usage\n\n### Basic Attachment\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst exampleVpc = new flexibleengine.VpcV1(\"exampleVpc\", {cidr: \"192.168.0.0/16\"});\nconst exampleSubnet = new flexibleengine.VpcSubnetV1(\"exampleSubnet\", {\n cidr: \"192.168.0.0/24\",\n gatewayIp: \"192.168.0.1\",\n vpcId: exampleVpc.vpcV1Id,\n});\nconst exampleInstance = new flexibleengine.ComputeInstanceV2(\"exampleInstance\", {securityGroups: [\"default\"]});\nconst exampleInterfaceAttach = new flexibleengine.ComputeInterfaceAttachV2(\"exampleInterfaceAttach\", {\n instanceId: exampleInstance.computeInstanceV2Id,\n networkId: exampleSubnet.vpcSubnetV1Id,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nexample_vpc = flexibleengine.VpcV1(\"exampleVpc\", cidr=\"192.168.0.0/16\")\nexample_subnet = flexibleengine.VpcSubnetV1(\"exampleSubnet\",\n cidr=\"192.168.0.0/24\",\n gateway_ip=\"192.168.0.1\",\n vpc_id=example_vpc.vpc_v1_id)\nexample_instance = flexibleengine.ComputeInstanceV2(\"exampleInstance\", security_groups=[\"default\"])\nexample_interface_attach = flexibleengine.ComputeInterfaceAttachV2(\"exampleInterfaceAttach\",\n instance_id=example_instance.compute_instance_v2_id,\n network_id=example_subnet.vpc_subnet_v1_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var exampleVpc = new Flexibleengine.VpcV1(\"exampleVpc\", new()\n {\n Cidr = \"192.168.0.0/16\",\n });\n\n var exampleSubnet = new Flexibleengine.VpcSubnetV1(\"exampleSubnet\", new()\n {\n Cidr = \"192.168.0.0/24\",\n GatewayIp = \"192.168.0.1\",\n VpcId = exampleVpc.VpcV1Id,\n });\n\n var exampleInstance = new Flexibleengine.ComputeInstanceV2(\"exampleInstance\", new()\n {\n SecurityGroups = new[]\n {\n \"default\",\n },\n });\n\n var exampleInterfaceAttach = new Flexibleengine.ComputeInterfaceAttachV2(\"exampleInterfaceAttach\", new()\n {\n InstanceId = exampleInstance.ComputeInstanceV2Id,\n NetworkId = exampleSubnet.VpcSubnetV1Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texampleVpc, err := flexibleengine.NewVpcV1(ctx, \"exampleVpc\", &flexibleengine.VpcV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/16\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleSubnet, err := flexibleengine.NewVpcSubnetV1(ctx, \"exampleSubnet\", &flexibleengine.VpcSubnetV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/24\"),\n\t\t\tGatewayIp: pulumi.String(\"192.168.0.1\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleInstance, err := flexibleengine.NewComputeInstanceV2(ctx, \"exampleInstance\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewComputeInterfaceAttachV2(ctx, \"exampleInterfaceAttach\", &flexibleengine.ComputeInterfaceAttachV2Args{\n\t\t\tInstanceId: exampleInstance.ComputeInstanceV2Id,\n\t\t\tNetworkId: exampleSubnet.VpcSubnetV1Id,\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.flexibleengine.VpcV1;\nimport com.pulumi.flexibleengine.VpcV1Args;\nimport com.pulumi.flexibleengine.VpcSubnetV1;\nimport com.pulumi.flexibleengine.VpcSubnetV1Args;\nimport com.pulumi.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.ComputeInterfaceAttachV2;\nimport com.pulumi.flexibleengine.ComputeInterfaceAttachV2Args;\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 exampleVpc = new VpcV1(\"exampleVpc\", VpcV1Args.builder()\n .cidr(\"192.168.0.0/16\")\n .build());\n\n var exampleSubnet = new VpcSubnetV1(\"exampleSubnet\", VpcSubnetV1Args.builder()\n .cidr(\"192.168.0.0/24\")\n .gatewayIp(\"192.168.0.1\")\n .vpcId(exampleVpc.vpcV1Id())\n .build());\n\n var exampleInstance = new ComputeInstanceV2(\"exampleInstance\", ComputeInstanceV2Args.builder()\n .securityGroups(\"default\")\n .build());\n\n var exampleInterfaceAttach = new ComputeInterfaceAttachV2(\"exampleInterfaceAttach\", ComputeInterfaceAttachV2Args.builder()\n .instanceId(exampleInstance.computeInstanceV2Id())\n .networkId(exampleSubnet.vpcSubnetV1Id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n exampleVpc:\n type: flexibleengine:VpcV1\n properties:\n cidr: 192.168.0.0/16\n exampleSubnet:\n type: flexibleengine:VpcSubnetV1\n properties:\n cidr: 192.168.0.0/24\n gatewayIp: 192.168.0.1\n vpcId: ${exampleVpc.vpcV1Id}\n exampleInstance:\n type: flexibleengine:ComputeInstanceV2\n properties:\n securityGroups:\n - default\n exampleInterfaceAttach:\n type: flexibleengine:ComputeInterfaceAttachV2\n properties:\n instanceId: ${exampleInstance.computeInstanceV2Id}\n networkId: ${exampleSubnet.vpcSubnetV1Id}\n```\n\n\n### Attachment Specifying a Fixed IP\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst exampleInterfaceAttach = new flexibleengine.ComputeInterfaceAttachV2(\"exampleInterfaceAttach\", {\n instanceId: flexibleengine_compute_instance_v2.example_instance.id,\n networkId: flexibleengine_vpc_subnet_v1.example_subnet.id,\n fixedIp: \"10.0.10.10\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nexample_interface_attach = flexibleengine.ComputeInterfaceAttachV2(\"exampleInterfaceAttach\",\n instance_id=flexibleengine_compute_instance_v2[\"example_instance\"][\"id\"],\n network_id=flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n fixed_ip=\"10.0.10.10\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var exampleInterfaceAttach = new Flexibleengine.ComputeInterfaceAttachV2(\"exampleInterfaceAttach\", new()\n {\n InstanceId = flexibleengine_compute_instance_v2.Example_instance.Id,\n NetworkId = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n FixedIp = \"10.0.10.10\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeInterfaceAttachV2(ctx, \"exampleInterfaceAttach\", &flexibleengine.ComputeInterfaceAttachV2Args{\n\t\t\tInstanceId: pulumi.Any(flexibleengine_compute_instance_v2.Example_instance.Id),\n\t\t\tNetworkId: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\n\t\t\tFixedIp: pulumi.String(\"10.0.10.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.pulumi.flexibleengine.ComputeInterfaceAttachV2;\nimport com.pulumi.flexibleengine.ComputeInterfaceAttachV2Args;\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 exampleInterfaceAttach = new ComputeInterfaceAttachV2(\"exampleInterfaceAttach\", ComputeInterfaceAttachV2Args.builder()\n .instanceId(flexibleengine_compute_instance_v2.example_instance().id())\n .networkId(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .fixedIp(\"10.0.10.10\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n exampleInterfaceAttach:\n type: flexibleengine:ComputeInterfaceAttachV2\n properties:\n instanceId: ${flexibleengine_compute_instance_v2.example_instance.id}\n networkId: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n fixedIp: 10.0.10.10\n```\n\n\n### Attachment Using an Existing Port\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst examplePort = new flexibleengine.NetworkingPortV2(\"examplePort\", {\n networkId: flexibleengine_vpc_subnet_v1.example_subnet.id,\n adminStateUp: true,\n});\nconst exampleInterfaceAttach = new flexibleengine.ComputeInterfaceAttachV2(\"exampleInterfaceAttach\", {\n instanceId: flexibleengine_compute_instance_v2.example_instance.id,\n portId: examplePort.networkingPortV2Id,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nexample_port = flexibleengine.NetworkingPortV2(\"examplePort\",\n network_id=flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n admin_state_up=True)\nexample_interface_attach = flexibleengine.ComputeInterfaceAttachV2(\"exampleInterfaceAttach\",\n instance_id=flexibleengine_compute_instance_v2[\"example_instance\"][\"id\"],\n port_id=example_port.networking_port_v2_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var examplePort = new Flexibleengine.NetworkingPortV2(\"examplePort\", new()\n {\n NetworkId = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n AdminStateUp = true,\n });\n\n var exampleInterfaceAttach = new Flexibleengine.ComputeInterfaceAttachV2(\"exampleInterfaceAttach\", new()\n {\n InstanceId = flexibleengine_compute_instance_v2.Example_instance.Id,\n PortId = examplePort.NetworkingPortV2Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texamplePort, err := flexibleengine.NewNetworkingPortV2(ctx, \"examplePort\", &flexibleengine.NetworkingPortV2Args{\n\t\t\tNetworkId: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\n\t\t\tAdminStateUp: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewComputeInterfaceAttachV2(ctx, \"exampleInterfaceAttach\", &flexibleengine.ComputeInterfaceAttachV2Args{\n\t\t\tInstanceId: pulumi.Any(flexibleengine_compute_instance_v2.Example_instance.Id),\n\t\t\tPortId: examplePort.NetworkingPortV2Id,\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.flexibleengine.NetworkingPortV2;\nimport com.pulumi.flexibleengine.NetworkingPortV2Args;\nimport com.pulumi.flexibleengine.ComputeInterfaceAttachV2;\nimport com.pulumi.flexibleengine.ComputeInterfaceAttachV2Args;\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 examplePort = new NetworkingPortV2(\"examplePort\", NetworkingPortV2Args.builder()\n .networkId(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .adminStateUp(\"true\")\n .build());\n\n var exampleInterfaceAttach = new ComputeInterfaceAttachV2(\"exampleInterfaceAttach\", ComputeInterfaceAttachV2Args.builder()\n .instanceId(flexibleengine_compute_instance_v2.example_instance().id())\n .portId(examplePort.networkingPortV2Id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n examplePort:\n type: flexibleengine:NetworkingPortV2\n properties:\n networkId: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n adminStateUp: 'true'\n exampleInterfaceAttach:\n type: flexibleengine:ComputeInterfaceAttachV2\n properties:\n instanceId: ${flexibleengine_compute_instance_v2.example_instance.id}\n portId: ${examplePort.networkingPortV2Id}\n```\n\n\n## Import\n\nInterface Attachments can be imported using the Instance ID and Port ID\n\nseparated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/computeInterfaceAttachV2:ComputeInterfaceAttachV2 ai_1 89c60255-9bd6-460c-822a-e2b959ede9d2/45670584-225f-46c3-b33e-6707b589b666\n```\n\n",
"properties": {
"computeInterfaceAttachV2Id": {
"type": "string"
},
"fixedIp": {
"type": "string",
"description": "An IP address to associate with the port.\nThis option cannot be used with port_id. You must specify a network_id.\nThe IP address must lie in a range on the supplied network.\n"
},
"instanceId": {
"type": "string",
"description": "The ID of the Instance to attach the Port or Network to.\n"
},
"networkId": {
"type": "string",
"description": "The ID of the Network to attach to an Instance.\nA port will be created automatically. This option and `port_id` are mutually exclusive.\n"
},
"portId": {
"type": "string",
"description": "The ID of the Port to attach to an Instance.\nThis option and `network_id` are mutually exclusive.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the interface attachment.\nIf omitted, the `region` argument of the provider is used. Changing this creates a new attachment.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeInterfaceAttachV2Timeouts:ComputeInterfaceAttachV2Timeouts"
}
},
"type": "object",
"required": [
"computeInterfaceAttachV2Id",
"instanceId",
"networkId",
"portId",
"region"
],
"inputProperties": {
"computeInterfaceAttachV2Id": {
"type": "string"
},
"fixedIp": {
"type": "string",
"description": "An IP address to associate with the port.\nThis option cannot be used with port_id. You must specify a network_id.\nThe IP address must lie in a range on the supplied network.\n"
},
"instanceId": {
"type": "string",
"description": "The ID of the Instance to attach the Port or Network to.\n"
},
"networkId": {
"type": "string",
"description": "The ID of the Network to attach to an Instance.\nA port will be created automatically. This option and `port_id` are mutually exclusive.\n"
},
"portId": {
"type": "string",
"description": "The ID of the Port to attach to an Instance.\nThis option and `network_id` are mutually exclusive.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the interface attachment.\nIf omitted, the `region` argument of the provider is used. Changing this creates a new attachment.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeInterfaceAttachV2Timeouts:ComputeInterfaceAttachV2Timeouts"
}
},
"requiredInputs": [
"instanceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ComputeInterfaceAttachV2 resources.\n",
"properties": {
"computeInterfaceAttachV2Id": {
"type": "string"
},
"fixedIp": {
"type": "string",
"description": "An IP address to associate with the port.\nThis option cannot be used with port_id. You must specify a network_id.\nThe IP address must lie in a range on the supplied network.\n"
},
"instanceId": {
"type": "string",
"description": "The ID of the Instance to attach the Port or Network to.\n"
},
"networkId": {
"type": "string",
"description": "The ID of the Network to attach to an Instance.\nA port will be created automatically. This option and `port_id` are mutually exclusive.\n"
},
"portId": {
"type": "string",
"description": "The ID of the Port to attach to an Instance.\nThis option and `network_id` are mutually exclusive.\n"
},
"region": {
"type": "string",
"description": "The region in which to create the interface attachment.\nIf omitted, the `region` argument of the provider is used. Changing this creates a new attachment.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeInterfaceAttachV2Timeouts:ComputeInterfaceAttachV2Timeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/computeKeypairV2:ComputeKeypairV2": {
"description": "Manages a V2 keypair resource within FlexibleEngine.\n\n## Example Usage\n\n### Create Key Pair\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst _new = new flexibleengine.ComputeKeypairV2(\"new\", {});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nnew = flexibleengine.ComputeKeypairV2(\"new\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var @new = new Flexibleengine.ComputeKeypairV2(\"new\");\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeKeypairV2(ctx, \"new\", 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.pulumi.flexibleengine.ComputeKeypairV2;\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 new_ = new ComputeKeypairV2(\"new\");\n\n }\n}\n```\n```yaml\nresources:\n new:\n type: flexibleengine:ComputeKeypairV2\n```\n\n\n### Import Key Pair\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst _import = new flexibleengine.ComputeKeypairV2(\"import\", {publicKey: \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAjpC1hwiOCCmKEWxJ4qzTTsJbKzndLotBCz5PcwtUnflmU+gHJtWMZKpuEGVi29h0A/+ydKek1O18k10Ff+4tyFjiHDQAnOfgWf7+b1yK+qDip3X1C0UPMbwHlTfSGWLGZqd9LvEFx9k3h/M+VtMvwR1lJ9LUyTAImnNjWG7TaIPmui30HvM2UiFEmqkr4ijq45MyX2+fLIePLRIF61p4whjHAQYufqyno3BS48icQb4p6iVEZPo4AE2o9oIyQvj2mx4dk5Y8CgSETOZTYDOR3rU2fZTRDRgPJDH9FWvQjF5tA0p3d9CoWWd2s6GKKbfoUIi8R/Db1BSPJwkqB\"});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nimport_ = flexibleengine.ComputeKeypairV2(\"import\", public_key=\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAjpC1hwiOCCmKEWxJ4qzTTsJbKzndLotBCz5PcwtUnflmU+gHJtWMZKpuEGVi29h0A/+ydKek1O18k10Ff+4tyFjiHDQAnOfgWf7+b1yK+qDip3X1C0UPMbwHlTfSGWLGZqd9LvEFx9k3h/M+VtMvwR1lJ9LUyTAImnNjWG7TaIPmui30HvM2UiFEmqkr4ijq45MyX2+fLIePLRIF61p4whjHAQYufqyno3BS48icQb4p6iVEZPo4AE2o9oIyQvj2mx4dk5Y8CgSETOZTYDOR3rU2fZTRDRgPJDH9FWvQjF5tA0p3d9CoWWd2s6GKKbfoUIi8R/Db1BSPJwkqB\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var import = new Flexibleengine.ComputeKeypairV2(\"import\", new()\n {\n PublicKey = \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAjpC1hwiOCCmKEWxJ4qzTTsJbKzndLotBCz5PcwtUnflmU+gHJtWMZKpuEGVi29h0A/+ydKek1O18k10Ff+4tyFjiHDQAnOfgWf7+b1yK+qDip3X1C0UPMbwHlTfSGWLGZqd9LvEFx9k3h/M+VtMvwR1lJ9LUyTAImnNjWG7TaIPmui30HvM2UiFEmqkr4ijq45MyX2+fLIePLRIF61p4whjHAQYufqyno3BS48icQb4p6iVEZPo4AE2o9oIyQvj2mx4dk5Y8CgSETOZTYDOR3rU2fZTRDRgPJDH9FWvQjF5tA0p3d9CoWWd2s6GKKbfoUIi8R/Db1BSPJwkqB\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeKeypairV2(ctx, \"import\", &flexibleengine.ComputeKeypairV2Args{\n\t\t\tPublicKey: pulumi.String(\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAjpC1hwiOCCmKEWxJ4qzTTsJbKzndLotBCz5PcwtUnflmU+gHJtWMZKpuEGVi29h0A/+ydKek1O18k10Ff+4tyFjiHDQAnOfgWf7+b1yK+qDip3X1C0UPMbwHlTfSGWLGZqd9LvEFx9k3h/M+VtMvwR1lJ9LUyTAImnNjWG7TaIPmui30HvM2UiFEmqkr4ijq45MyX2+fLIePLRIF61p4whjHAQYufqyno3BS48icQb4p6iVEZPo4AE2o9oIyQvj2mx4dk5Y8CgSETOZTYDOR3rU2fZTRDRgPJDH9FWvQjF5tA0p3d9CoWWd2s6GKKbfoUIi8R/Db1BSPJwkqB\"),\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.flexibleengine.ComputeKeypairV2;\nimport com.pulumi.flexibleengine.ComputeKeypairV2Args;\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 import_ = new ComputeKeypairV2(\"import\", ComputeKeypairV2Args.builder()\n .publicKey(\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAjpC1hwiOCCmKEWxJ4qzTTsJbKzndLotBCz5PcwtUnflmU+gHJtWMZKpuEGVi29h0A/+ydKek1O18k10Ff+4tyFjiHDQAnOfgWf7+b1yK+qDip3X1C0UPMbwHlTfSGWLGZqd9LvEFx9k3h/M+VtMvwR1lJ9LUyTAImnNjWG7TaIPmui30HvM2UiFEmqkr4ijq45MyX2+fLIePLRIF61p4whjHAQYufqyno3BS48icQb4p6iVEZPo4AE2o9oIyQvj2mx4dk5Y8CgSETOZTYDOR3rU2fZTRDRgPJDH9FWvQjF5tA0p3d9CoWWd2s6GKKbfoUIi8R/Db1BSPJwkqB\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n import:\n type: flexibleengine:ComputeKeypairV2\n properties:\n publicKey: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAjpC1hwiOCCmKEWxJ4qzTTsJbKzndLotBCz5PcwtUnflmU+gHJtWMZKpuEGVi29h0A/+ydKek1O18k10Ff+4tyFjiHDQAnOfgWf7+b1yK+qDip3X1C0UPMbwHlTfSGWLGZqd9LvEFx9k3h/M+VtMvwR1lJ9LUyTAImnNjWG7TaIPmui30HvM2UiFEmqkr4ijq45MyX2+fLIePLRIF61p4whjHAQYufqyno3BS48icQb4p6iVEZPo4AE2o9oIyQvj2mx4dk5Y8CgSETOZTYDOR3rU2fZTRDRgPJDH9FWvQjF5tA0p3d9CoWWd2s6GKKbfoUIi8R/Db1BSPJwkqB\n```\n\n\n## Import\n\nKeypairs can be imported using the `name`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/computeKeypairV2:ComputeKeypairV2 my-keypair test-keypair\n```\n\n",
"properties": {
"computeKeypairV2Id": {
"type": "string",
"description": "The resource ID which as same as keypair name.\n"
},
"name": {
"type": "string",
"description": "Specifies a unique name for the keypair.\nChanging this creates a new keypair.\n"
},
"privateKeyPath": {
"type": "string",
"description": "Specifies the path of the created private key.\nThe private key file (**.pem**) is created only after the resource is created.\nBy default, the private key file will be created in the same folder as the work directory.\nIf you need to create it in another folder, please specify the path for `private_key_path`.\nChanging this creates a new keypair.\n\n->**NOTE:** The private key file will be removed after the keypair is deleted.\n"
},
"publicKey": {
"type": "string",
"description": "Specifies a imported OpenSSH-formatted public key.\nChanging this creates a new keypair.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the keypair resource.\nIf omitted, the `region` argument of the provider is used.\nChanging this creates a new keypair.\n"
}
},
"type": "object",
"required": [
"computeKeypairV2Id",
"name",
"privateKeyPath",
"publicKey",
"region"
],
"inputProperties": {
"computeKeypairV2Id": {
"type": "string",
"description": "The resource ID which as same as keypair name.\n"
},
"name": {
"type": "string",
"description": "Specifies a unique name for the keypair.\nChanging this creates a new keypair.\n"
},
"privateKeyPath": {
"type": "string",
"description": "Specifies the path of the created private key.\nThe private key file (**.pem**) is created only after the resource is created.\nBy default, the private key file will be created in the same folder as the work directory.\nIf you need to create it in another folder, please specify the path for `private_key_path`.\nChanging this creates a new keypair.\n\n->**NOTE:** The private key file will be removed after the keypair is deleted.\n"
},
"publicKey": {
"type": "string",
"description": "Specifies a imported OpenSSH-formatted public key.\nChanging this creates a new keypair.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the keypair resource.\nIf omitted, the `region` argument of the provider is used.\nChanging this creates a new keypair.\n"
}
},
"stateInputs": {
"description": "Input properties used for looking up and filtering ComputeKeypairV2 resources.\n",
"properties": {
"computeKeypairV2Id": {
"type": "string",
"description": "The resource ID which as same as keypair name.\n"
},
"name": {
"type": "string",
"description": "Specifies a unique name for the keypair.\nChanging this creates a new keypair.\n"
},
"privateKeyPath": {
"type": "string",
"description": "Specifies the path of the created private key.\nThe private key file (**.pem**) is created only after the resource is created.\nBy default, the private key file will be created in the same folder as the work directory.\nIf you need to create it in another folder, please specify the path for `private_key_path`.\nChanging this creates a new keypair.\n\n->**NOTE:** The private key file will be removed after the keypair is deleted.\n"
},
"publicKey": {
"type": "string",
"description": "Specifies a imported OpenSSH-formatted public key.\nChanging this creates a new keypair.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the keypair resource.\nIf omitted, the `region` argument of the provider is used.\nChanging this creates a new keypair.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/computeServergroupV2:ComputeServergroupV2": {
"description": "Manages a V2 Server Group resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst test_sg = new flexibleengine.ComputeServergroupV2(\"test-sg\", {policies: [\"anti-affinity\"]});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\ntest_sg = flexibleengine.ComputeServergroupV2(\"test-sg\", policies=[\"anti-affinity\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var test_sg = new Flexibleengine.ComputeServergroupV2(\"test-sg\", new()\n {\n Policies = new[]\n {\n \"anti-affinity\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewComputeServergroupV2(ctx, \"test-sg\", &flexibleengine.ComputeServergroupV2Args{\n\t\t\tPolicies: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"anti-affinity\"),\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.flexibleengine.ComputeServergroupV2;\nimport com.pulumi.flexibleengine.ComputeServergroupV2Args;\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 test_sg = new ComputeServergroupV2(\"test-sg\", ComputeServergroupV2Args.builder()\n .policies(\"anti-affinity\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n test-sg:\n type: flexibleengine:ComputeServergroupV2\n properties:\n policies:\n - anti-affinity\n```\n\n\n## Import\n\nServer Groups can be imported using the `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/computeServergroupV2:ComputeServergroupV2 test-sg 1bc30ee9-9d5b-4c30-bdd5-7f1e663f5edf\n```\n\n",
"properties": {
"computeServergroupV2Id": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"description": "The instances that are part of this server group.\n"
},
"name": {
"type": "string",
"description": "A unique name for the server group. Changing this creates\na new server group.\n"
},
"policies": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of policies for the server group. Only **anti-affinity**\npolicy is supported right now, which menas all servers in this group must be\ndeployed on different hosts. Changing this creates a new server group.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nIf omitted, the `region` argument of the provider is used. Changing\nthis creates a new server group.\n"
},
"valueSpecs": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Map of additional options.\n"
}
},
"type": "object",
"required": [
"computeServergroupV2Id",
"members",
"name",
"region"
],
"inputProperties": {
"computeServergroupV2Id": {
"type": "string"
},
"name": {
"type": "string",
"description": "A unique name for the server group. Changing this creates\na new server group.\n"
},
"policies": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of policies for the server group. Only **anti-affinity**\npolicy is supported right now, which menas all servers in this group must be\ndeployed on different hosts. Changing this creates a new server group.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nIf omitted, the `region` argument of the provider is used. Changing\nthis creates a new server group.\n"
},
"valueSpecs": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Map of additional options.\n"
}
},
"stateInputs": {
"description": "Input properties used for looking up and filtering ComputeServergroupV2 resources.\n",
"properties": {
"computeServergroupV2Id": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"description": "The instances that are part of this server group.\n"
},
"name": {
"type": "string",
"description": "A unique name for the server group. Changing this creates\na new server group.\n"
},
"policies": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of policies for the server group. Only **anti-affinity**\npolicy is supported right now, which menas all servers in this group must be\ndeployed on different hosts. Changing this creates a new server group.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nIf omitted, the `region` argument of the provider is used. Changing\nthis creates a new server group.\n"
},
"valueSpecs": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Map of additional options.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/computeVolumeAttachV2:ComputeVolumeAttachV2": {
"description": "Attaches a Block Storage Volume to an Instance using the FlexibleEngine\nCompute (Nova) v2 API.\n\n## Example Usage\n\n### Basic attachment of a single volume to a single instance\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst volume1 = new flexibleengine.BlockstorageVolumeV2(\"volume1\", {size: 1});\nconst instance1 = new flexibleengine.ComputeInstanceV2(\"instance1\", {securityGroups: [\"default\"]});\nconst va1 = new flexibleengine.ComputeVolumeAttachV2(\"va1\", {\n instanceId: instance1.computeInstanceV2Id,\n volumeId: volume1.blockstorageVolumeV2Id,\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nvolume1 = flexibleengine.BlockstorageVolumeV2(\"volume1\", size=1)\ninstance1 = flexibleengine.ComputeInstanceV2(\"instance1\", security_groups=[\"default\"])\nva1 = flexibleengine.ComputeVolumeAttachV2(\"va1\",\n instance_id=instance1.compute_instance_v2_id,\n volume_id=volume1.blockstorage_volume_v2_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var volume1 = new Flexibleengine.BlockstorageVolumeV2(\"volume1\", new()\n {\n Size = 1,\n });\n\n var instance1 = new Flexibleengine.ComputeInstanceV2(\"instance1\", new()\n {\n SecurityGroups = new[]\n {\n \"default\",\n },\n });\n\n var va1 = new Flexibleengine.ComputeVolumeAttachV2(\"va1\", new()\n {\n InstanceId = instance1.ComputeInstanceV2Id,\n VolumeId = volume1.BlockstorageVolumeV2Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tvolume1, err := flexibleengine.NewBlockstorageVolumeV2(ctx, \"volume1\", &flexibleengine.BlockstorageVolumeV2Args{\n\t\t\tSize: pulumi.Float64(1),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tinstance1, err := flexibleengine.NewComputeInstanceV2(ctx, \"instance1\", &flexibleengine.ComputeInstanceV2Args{\n\t\t\tSecurityGroups: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"default\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewComputeVolumeAttachV2(ctx, \"va1\", &flexibleengine.ComputeVolumeAttachV2Args{\n\t\t\tInstanceId: instance1.ComputeInstanceV2Id,\n\t\t\tVolumeId: volume1.BlockstorageVolumeV2Id,\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.flexibleengine.BlockstorageVolumeV2;\nimport com.pulumi.flexibleengine.BlockstorageVolumeV2Args;\nimport com.pulumi.flexibleengine.ComputeInstanceV2;\nimport com.pulumi.flexibleengine.ComputeInstanceV2Args;\nimport com.pulumi.flexibleengine.ComputeVolumeAttachV2;\nimport com.pulumi.flexibleengine.ComputeVolumeAttachV2Args;\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 volume1 = new BlockstorageVolumeV2(\"volume1\", BlockstorageVolumeV2Args.builder()\n .size(1)\n .build());\n\n var instance1 = new ComputeInstanceV2(\"instance1\", ComputeInstanceV2Args.builder()\n .securityGroups(\"default\")\n .build());\n\n var va1 = new ComputeVolumeAttachV2(\"va1\", ComputeVolumeAttachV2Args.builder()\n .instanceId(instance1.computeInstanceV2Id())\n .volumeId(volume1.blockstorageVolumeV2Id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n volume1:\n type: flexibleengine:BlockstorageVolumeV2\n properties:\n size: 1\n instance1:\n type: flexibleengine:ComputeInstanceV2\n properties:\n securityGroups:\n - default\n va1:\n type: flexibleengine:ComputeVolumeAttachV2\n properties:\n instanceId: ${instance1.computeInstanceV2Id}\n volumeId: ${volume1.blockstorageVolumeV2Id}\n```\n\n\n## Import\n\nVolume Attachments can be imported using the Instance ID and Volume ID\n\nseparated by a slash, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/computeVolumeAttachV2:ComputeVolumeAttachV2 va_1 89c60255-9bd6-460c-822a-e2b959ede9d2/45670584-225f-46c3-b33e-6707b589b666\n```\n\n",
"properties": {
"computeVolumeAttachV2Id": {
"type": "string"
},
"device": {
"type": "string"
},
"instanceId": {
"type": "string",
"description": "The ID of the Instance to attach the Volume to.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nA Compute client is needed to create a volume attachment. If omitted, the\n`region` argument of the provider is used. Changing this creates a new volume attachment.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeVolumeAttachV2Timeouts:ComputeVolumeAttachV2Timeouts"
},
"volumeId": {
"type": "string",
"description": "The ID of the Volume to attach to an Instance.\n"
}
},
"type": "object",
"required": [
"computeVolumeAttachV2Id",
"device",
"instanceId",
"region",
"volumeId"
],
"inputProperties": {
"computeVolumeAttachV2Id": {
"type": "string"
},
"device": {
"type": "string"
},
"instanceId": {
"type": "string",
"description": "The ID of the Instance to attach the Volume to.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nA Compute client is needed to create a volume attachment. If omitted, the\n`region` argument of the provider is used. Changing this creates a new volume attachment.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeVolumeAttachV2Timeouts:ComputeVolumeAttachV2Timeouts"
},
"volumeId": {
"type": "string",
"description": "The ID of the Volume to attach to an Instance.\n"
}
},
"requiredInputs": [
"instanceId",
"volumeId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering ComputeVolumeAttachV2 resources.\n",
"properties": {
"computeVolumeAttachV2Id": {
"type": "string"
},
"device": {
"type": "string"
},
"instanceId": {
"type": "string",
"description": "The ID of the Instance to attach the Volume to.\n"
},
"region": {
"type": "string",
"description": "The region in which to obtain the V2 Compute client.\nA Compute client is needed to create a volume attachment. If omitted, the\n`region` argument of the provider is used. Changing this creates a new volume attachment.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FComputeVolumeAttachV2Timeouts:ComputeVolumeAttachV2Timeouts"
},
"volumeId": {
"type": "string",
"description": "The ID of the Volume to attach to an Instance.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/csbsBackupPolicyV1:CsbsBackupPolicyV1": {
"description": "Provides a FlexibleEngine Backup Policy of Resources.\n\n## Example Usage\n\n \n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst name = config.requireObject(\"name\");\nconst id = config.requireObject(\"id\");\nconst resourceName = config.requireObject(\"resourceName\");\nconst backupPolicyV1 = new flexibleengine.CsbsBackupPolicyV1(\"backupPolicyV1\", {\n resources: [{\n id: id,\n type: \"OS::Nova::Server\",\n name: resourceName,\n }],\n scheduledOperation: {\n enabled: true,\n operationType: \"backup\",\n triggerPattern: `BEGIN:VCALENDAR\\x0d\nBEGIN:VEVENT\\x0d\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\\x0d\nEND:VEVENT\\x0d\nEND:VCALENDAR\\x0d\n`,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nname = config.require_object(\"name\")\nid = config.require_object(\"id\")\nresource_name = config.require_object(\"resourceName\")\nbackup_policy_v1 = flexibleengine.CsbsBackupPolicyV1(\"backupPolicyV1\",\n resources=[{\n \"id\": id,\n \"type\": \"OS::Nova::Server\",\n \"name\": resource_name,\n }],\n scheduled_operation={\n \"enabled\": True,\n \"operation_type\": \"backup\",\n \"trigger_pattern\": \"\"\"BEGIN:VCALENDAR\\x0d\nBEGIN:VEVENT\\x0d\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\\x0d\nEND:VEVENT\\x0d\nEND:VCALENDAR\\x0d\n\"\"\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var name = config.RequireObject(\"name\");\n var id = config.RequireObject(\"id\");\n var resourceName = config.RequireObject(\"resourceName\");\n var backupPolicyV1 = new Flexibleengine.CsbsBackupPolicyV1(\"backupPolicyV1\", new()\n {\n Resources = new[]\n {\n new Flexibleengine.Inputs.CsbsBackupPolicyV1ResourceArgs\n {\n Id = id,\n Type = \"OS::Nova::Server\",\n Name = resourceName,\n },\n },\n ScheduledOperation = new Flexibleengine.Inputs.CsbsBackupPolicyV1ScheduledOperationArgs\n {\n Enabled = true,\n OperationType = \"backup\",\n TriggerPattern = @\"BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tname := cfg.RequireObject(\"name\")\n\t\tid := cfg.RequireObject(\"id\")\n\t\tresourceName := cfg.RequireObject(\"resourceName\")\n\t\t_, err := flexibleengine.NewCsbsBackupPolicyV1(ctx, \"backupPolicyV1\", &flexibleengine.CsbsBackupPolicyV1Args{\n\t\t\tResources: flexibleengine.CsbsBackupPolicyV1ResourceArray{\n\t\t\t\t&flexibleengine.CsbsBackupPolicyV1ResourceArgs{\n\t\t\t\t\tId: pulumi.Any(id),\n\t\t\t\t\tType: pulumi.String(\"OS::Nova::Server\"),\n\t\t\t\t\tName: pulumi.Any(resourceName),\n\t\t\t\t},\n\t\t\t},\n\t\t\tScheduledOperation: &flexibleengine.CsbsBackupPolicyV1ScheduledOperationArgs{\n\t\t\t\tEnabled: pulumi.Bool(true),\n\t\t\t\tOperationType: pulumi.String(\"backup\"),\n\t\t\t\tTriggerPattern: pulumi.String(`BEGIN:VCALENDAR\nBEGIN:VEVENT\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\nEND:VEVENT\nEND:VCALENDAR\n`),\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.flexibleengine.CsbsBackupPolicyV1;\nimport com.pulumi.flexibleengine.CsbsBackupPolicyV1Args;\nimport com.pulumi.flexibleengine.inputs.CsbsBackupPolicyV1ResourceArgs;\nimport com.pulumi.flexibleengine.inputs.CsbsBackupPolicyV1ScheduledOperationArgs;\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 final var config = ctx.config();\n final var name = config.get(\"name\");\n final var id = config.get(\"id\");\n final var resourceName = config.get(\"resourceName\");\n var backupPolicyV1 = new CsbsBackupPolicyV1(\"backupPolicyV1\", CsbsBackupPolicyV1Args.builder()\n .resources(CsbsBackupPolicyV1ResourceArgs.builder()\n .id(id)\n .type(\"OS::Nova::Server\")\n .name(resourceName)\n .build())\n .scheduledOperation(CsbsBackupPolicyV1ScheduledOperationArgs.builder()\n .enabled(true)\n .operationType(\"backup\")\n .triggerPattern(\"\"\"\nBEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n \"\"\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n name:\n type: dynamic\n id:\n type: dynamic\n resourceName:\n type: dynamic\nresources:\n backupPolicyV1:\n type: flexibleengine:CsbsBackupPolicyV1\n properties:\n resources:\n - id: ${id}\n type: OS::Nova::Server\n name: ${resourceName}\n scheduledOperation:\n enabled: true\n operationType: backup\n triggerPattern: \"BEGIN:VCALENDAR\\r\\nBEGIN:VEVENT\\r\\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\\r\\nEND:VEVENT\\r\\nEND:VCALENDAR\\r\\n\"\n```\n\n\n## Import\n\nBackup Policy can be imported using `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/csbsBackupPolicyV1:CsbsBackupPolicyV1 backup_policy_v1 7056d636-ac60-4663-8a6c-82d3c32c1c64\n```\n\n",
"properties": {
"common": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "General backup policy parameters, which are blank by default.\n"
},
"csbsBackupPolicyV1Id": {
"type": "string",
"description": "Specifies Scheduling period ID.\n"
},
"description": {
"type": "string",
"description": "Backup policy description. The value consists of 0 to 255 characters and\nmust not contain a greater-than sign (>) or less-than sign (<).\n"
},
"name": {
"type": "string",
"description": "Specifies the name of backup policy. The value consists of 1 to 255 characters and\ncan contain only letters, digits, underscores (_), and hyphens (-).\n"
},
"providerId": {
"type": "string",
"description": "Specifies backup provider ID. Default value is\n**fc4d5750-22e7-4798-8a46-f48f62c4c1da**\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CSBS backup policy resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CSBS backup policy resource.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupPolicyV1Resource:CsbsBackupPolicyV1Resource"
},
"description": "Backup Object.\n"
},
"scheduledOperation": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupPolicyV1ScheduledOperation:CsbsBackupPolicyV1ScheduledOperation",
"description": "Backup plan information.\n"
},
"status": {
"type": "string",
"description": "Status of Backup Policy.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupPolicyV1Timeouts:CsbsBackupPolicyV1Timeouts"
}
},
"type": "object",
"required": [
"csbsBackupPolicyV1Id",
"name",
"region",
"resources",
"scheduledOperation",
"status"
],
"inputProperties": {
"common": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "General backup policy parameters, which are blank by default.\n"
},
"csbsBackupPolicyV1Id": {
"type": "string",
"description": "Specifies Scheduling period ID.\n"
},
"description": {
"type": "string",
"description": "Backup policy description. The value consists of 0 to 255 characters and\nmust not contain a greater-than sign (>) or less-than sign (<).\n"
},
"name": {
"type": "string",
"description": "Specifies the name of backup policy. The value consists of 1 to 255 characters and\ncan contain only letters, digits, underscores (_), and hyphens (-).\n"
},
"providerId": {
"type": "string",
"description": "Specifies backup provider ID. Default value is\n**fc4d5750-22e7-4798-8a46-f48f62c4c1da**\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CSBS backup policy resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CSBS backup policy resource.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupPolicyV1Resource:CsbsBackupPolicyV1Resource"
},
"description": "Backup Object.\n"
},
"scheduledOperation": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupPolicyV1ScheduledOperation:CsbsBackupPolicyV1ScheduledOperation",
"description": "Backup plan information.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupPolicyV1Timeouts:CsbsBackupPolicyV1Timeouts"
}
},
"requiredInputs": [
"resources",
"scheduledOperation"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CsbsBackupPolicyV1 resources.\n",
"properties": {
"common": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "General backup policy parameters, which are blank by default.\n"
},
"csbsBackupPolicyV1Id": {
"type": "string",
"description": "Specifies Scheduling period ID.\n"
},
"description": {
"type": "string",
"description": "Backup policy description. The value consists of 0 to 255 characters and\nmust not contain a greater-than sign (>) or less-than sign (<).\n"
},
"name": {
"type": "string",
"description": "Specifies the name of backup policy. The value consists of 1 to 255 characters and\ncan contain only letters, digits, underscores (_), and hyphens (-).\n"
},
"providerId": {
"type": "string",
"description": "Specifies backup provider ID. Default value is\n**fc4d5750-22e7-4798-8a46-f48f62c4c1da**\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CSBS backup policy resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CSBS backup policy resource.\n"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupPolicyV1Resource:CsbsBackupPolicyV1Resource"
},
"description": "Backup Object.\n"
},
"scheduledOperation": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupPolicyV1ScheduledOperation:CsbsBackupPolicyV1ScheduledOperation",
"description": "Backup plan information.\n"
},
"status": {
"type": "string",
"description": "Status of Backup Policy.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupPolicyV1Timeouts:CsbsBackupPolicyV1Timeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/csbsBackupV1:CsbsBackupV1": {
"description": "Provides a FlexibleEngine Backup of Resources.\n\n## Example Usage\n\n \n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst backupName = config.requireObject(\"backupName\");\nconst resourceId = config.requireObject(\"resourceId\");\nconst backupV1 = new flexibleengine.CsbsBackupV1(\"backupV1\", {\n backupName: backupName,\n resourceId: resourceId,\n resourceType: \"OS::Nova::Server\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nbackup_name = config.require_object(\"backupName\")\nresource_id = config.require_object(\"resourceId\")\nbackup_v1 = flexibleengine.CsbsBackupV1(\"backupV1\",\n backup_name=backup_name,\n resource_id=resource_id,\n resource_type=\"OS::Nova::Server\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var backupName = config.RequireObject(\"backupName\");\n var resourceId = config.RequireObject(\"resourceId\");\n var backupV1 = new Flexibleengine.CsbsBackupV1(\"backupV1\", new()\n {\n BackupName = backupName,\n ResourceId = resourceId,\n ResourceType = \"OS::Nova::Server\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tbackupName := cfg.RequireObject(\"backupName\")\n\t\tresourceId := cfg.RequireObject(\"resourceId\")\n\t\t_, err := flexibleengine.NewCsbsBackupV1(ctx, \"backupV1\", &flexibleengine.CsbsBackupV1Args{\n\t\t\tBackupName: pulumi.Any(backupName),\n\t\t\tResourceId: pulumi.Any(resourceId),\n\t\t\tResourceType: pulumi.String(\"OS::Nova::Server\"),\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.flexibleengine.CsbsBackupV1;\nimport com.pulumi.flexibleengine.CsbsBackupV1Args;\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 final var config = ctx.config();\n final var backupName = config.get(\"backupName\");\n final var resourceId = config.get(\"resourceId\");\n var backupV1 = new CsbsBackupV1(\"backupV1\", CsbsBackupV1Args.builder()\n .backupName(backupName)\n .resourceId(resourceId)\n .resourceType(\"OS::Nova::Server\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n backupName:\n type: dynamic\n resourceId:\n type: dynamic\nresources:\n backupV1:\n type: flexibleengine:CsbsBackupV1\n properties:\n backupName: ${backupName}\n resourceId: ${resourceId}\n resourceType: OS::Nova::Server\n```\n\n\n## Import\n\nBackup can be imported using `backup_record_id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/csbsBackupV1:CsbsBackupV1 backup_v1 7056d636-ac60-4663-8a6c-82d3c32c1c64\n```\n\n",
"properties": {
"backupName": {
"type": "string",
"description": "Name for the backup. The value consists of 1 to 255 characters and can\ncontain only letters, digits, underscores (_), and hyphens (-). Changing backup_name creates a new backup.\n"
},
"backupRecordId": {
"type": "string",
"description": "Specifies backup record ID.\n"
},
"csbsBackupV1Id": {
"type": "string",
"description": "Specifies Cinder backup ID.\n"
},
"description": {
"type": "string",
"description": "Backup description. The value consists of 0 to 255 characters and must\nnot contain a greater-than sign (>) or less-than sign (<). Changing description creates a new backup.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CSBS backup resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CSBS backup resource.\n"
},
"resourceId": {
"type": "string",
"description": "ID of the target to which the backup is restored.\nChanging this creates a new backup.\n"
},
"resourceType": {
"type": "string",
"description": "Type of the target to which the backup is restored. The default value\nis **OS::Nova::Server** for an ECS. Changing this creates a new backup.\n"
},
"status": {
"type": "string",
"description": "Status of backup Volume.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupV1Timeouts:CsbsBackupV1Timeouts"
},
"vmMetadatas": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupV1VmMetadata:CsbsBackupV1VmMetadata"
},
"description": "The vm_metadata object structure is documented below.\n"
},
"volumeBackups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupV1VolumeBackup:CsbsBackupV1VolumeBackup"
},
"description": "The volume_backups object structure is documented below.\n"
}
},
"type": "object",
"required": [
"backupName",
"backupRecordId",
"csbsBackupV1Id",
"description",
"region",
"resourceId",
"status",
"vmMetadatas",
"volumeBackups"
],
"inputProperties": {
"backupName": {
"type": "string",
"description": "Name for the backup. The value consists of 1 to 255 characters and can\ncontain only letters, digits, underscores (_), and hyphens (-). Changing backup_name creates a new backup.\n"
},
"csbsBackupV1Id": {
"type": "string",
"description": "Specifies Cinder backup ID.\n"
},
"description": {
"type": "string",
"description": "Backup description. The value consists of 0 to 255 characters and must\nnot contain a greater-than sign (>) or less-than sign (<). Changing description creates a new backup.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CSBS backup resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CSBS backup resource.\n"
},
"resourceId": {
"type": "string",
"description": "ID of the target to which the backup is restored.\nChanging this creates a new backup.\n"
},
"resourceType": {
"type": "string",
"description": "Type of the target to which the backup is restored. The default value\nis **OS::Nova::Server** for an ECS. Changing this creates a new backup.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupV1Timeouts:CsbsBackupV1Timeouts"
}
},
"requiredInputs": [
"resourceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CsbsBackupV1 resources.\n",
"properties": {
"backupName": {
"type": "string",
"description": "Name for the backup. The value consists of 1 to 255 characters and can\ncontain only letters, digits, underscores (_), and hyphens (-). Changing backup_name creates a new backup.\n"
},
"backupRecordId": {
"type": "string",
"description": "Specifies backup record ID.\n"
},
"csbsBackupV1Id": {
"type": "string",
"description": "Specifies Cinder backup ID.\n"
},
"description": {
"type": "string",
"description": "Backup description. The value consists of 0 to 255 characters and must\nnot contain a greater-than sign (>) or less-than sign (<). Changing description creates a new backup.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the CSBS backup resource.\nIf omitted, the provider-level region will be used. Changing this will create a new CSBS backup resource.\n"
},
"resourceId": {
"type": "string",
"description": "ID of the target to which the backup is restored.\nChanging this creates a new backup.\n"
},
"resourceType": {
"type": "string",
"description": "Type of the target to which the backup is restored. The default value\nis **OS::Nova::Server** for an ECS. Changing this creates a new backup.\n"
},
"status": {
"type": "string",
"description": "Status of backup Volume.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupV1Timeouts:CsbsBackupV1Timeouts"
},
"vmMetadatas": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupV1VmMetadata:CsbsBackupV1VmMetadata"
},
"description": "The vm_metadata object structure is documented below.\n"
},
"volumeBackups": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCsbsBackupV1VolumeBackup:CsbsBackupV1VolumeBackup"
},
"description": "The volume_backups object structure is documented below.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cseMicroservice:CseMicroservice": {
"description": "Manages a dedicated microservice resource within FlexibleEngine.\n\n> When deleting a microservice, all instances under it will also be deleted together.\n\n## Example Usage\n\n### Create a microservice in an engine with RBAC authentication disabled\n\n\n```yaml\nconfiguration:\n engineConnAddr:\n type: dynamic\n serviceName:\n type: dynamic\n appName:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CseMicroservice\n properties:\n connectAddress: ${engineConnAddr}\n verison: 1.0.0\n environment: development\n appName: ${appName}\n```\n\n\n### Create a microservice in an engine with RBAC authentication enabled\n\n\n```yaml\nconfiguration:\n engineConnAddr:\n type: dynamic\n serviceName:\n type: dynamic\n appName:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CseMicroservice\n properties:\n connectAddress: ${engineConnAddr}\n verison: 1.0.0\n environment: development\n appName: ${appName}\n adminUser: root\n adminPass: Flexibleengine!123\n```\n\n\n## Import\n\nMicroservices can be imported using related `connect_address` and their `id`, separated by a slash (/), e.g.\n\n```sh\n$ pulumi import flexibleengine:index/cseMicroservice:CseMicroservice test https://124.70.26.32:30100/f14960ba495e03f59f85aacaaafbdef3fbff3f0d\n```\n\nIf you enabled the **RBAC** authorization, you also need to provide the account name and password, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/cseMicroservice:CseMicroservice test 'https://124.70.26.32:30100/f14960ba495e03f59f85aacaaafbdef3fbff3f0d/root/Test!123'\n```\n\nThe single quotes can help you solve the problem of special characters reporting errors on bash.\n\n",
"properties": {
"adminPass": {
"type": "string",
"description": "Specifies the account password.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice.\nThe password format must meet the following conditions:\n+ Must be `8` to `32` characters long.\n+ A password must contain at least one digit, one uppercase letter, one lowercase letter, and one special character\n(-~!@#%^*_=+?$&()|<>{}[]).\n+ Cannot be the account name or account name spelled backwards.\n+ The password can only start with a letter.\n",
"secret": true
},
"adminUser": {
"type": "string",
"description": "Specifies the account name. The initial account name is **root**.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice.\n"
},
"appName": {
"type": "string",
"description": "Specifies the name of the dedicated microservice application.\nChanging this will create a new microservice.\n"
},
"connectAddress": {
"type": "string",
"description": "Specifies the connection address of service registry center for the\nspecified dedicated CSE engine. Changing this will create a new microservice.\n\n> We are only support IPv4 addresses yet.\n"
},
"cseMicroserviceId": {
"type": "string",
"description": "The microservice ID.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the dedicated microservice.\nThe description can contian a maximum of `256` characters.\nChanging this will create a new microservice.\n"
},
"environment": {
"type": "string",
"description": "Specifies the environment (stage) type.\nThe valid values are **development**, **testing**, **acceptance** and **production**.\nIf omitted, the microservice will be deployed in an empty environment.\nChanging this will create a new microservice.\n"
},
"level": {
"type": "string",
"description": "Specifies the microservice level.\nThe valid values are **FRONT**, **MIDDLE**, and **BACK**. Changing this will create a new microservice.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the dedicated microservice.\nThe name can contain `1` to `128` characters, only letters, digits, underscore (_), hyphens (-) and dots (.) are\nallowed. The name must start and end with a letter or digit. Changing this will create a new microservice.\n"
},
"status": {
"type": "string",
"description": "The microservice status. The values supports **UP** and **DOWN**.\n"
},
"version": {
"type": "string",
"description": "Specifies the version of the dedicated microservice.\nChanging this will create a new microservice.\n"
}
},
"type": "object",
"required": [
"appName",
"connectAddress",
"cseMicroserviceId",
"name",
"status",
"version"
],
"inputProperties": {
"adminPass": {
"type": "string",
"description": "Specifies the account password.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice.\nThe password format must meet the following conditions:\n+ Must be `8` to `32` characters long.\n+ A password must contain at least one digit, one uppercase letter, one lowercase letter, and one special character\n(-~!@#%^*_=+?$&()|<>{}[]).\n+ Cannot be the account name or account name spelled backwards.\n+ The password can only start with a letter.\n",
"secret": true
},
"adminUser": {
"type": "string",
"description": "Specifies the account name. The initial account name is **root**.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice.\n"
},
"appName": {
"type": "string",
"description": "Specifies the name of the dedicated microservice application.\nChanging this will create a new microservice.\n"
},
"connectAddress": {
"type": "string",
"description": "Specifies the connection address of service registry center for the\nspecified dedicated CSE engine. Changing this will create a new microservice.\n\n> We are only support IPv4 addresses yet.\n"
},
"cseMicroserviceId": {
"type": "string",
"description": "The microservice ID.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the dedicated microservice.\nThe description can contian a maximum of `256` characters.\nChanging this will create a new microservice.\n"
},
"environment": {
"type": "string",
"description": "Specifies the environment (stage) type.\nThe valid values are **development**, **testing**, **acceptance** and **production**.\nIf omitted, the microservice will be deployed in an empty environment.\nChanging this will create a new microservice.\n"
},
"level": {
"type": "string",
"description": "Specifies the microservice level.\nThe valid values are **FRONT**, **MIDDLE**, and **BACK**. Changing this will create a new microservice.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the dedicated microservice.\nThe name can contain `1` to `128` characters, only letters, digits, underscore (_), hyphens (-) and dots (.) are\nallowed. The name must start and end with a letter or digit. Changing this will create a new microservice.\n"
},
"version": {
"type": "string",
"description": "Specifies the version of the dedicated microservice.\nChanging this will create a new microservice.\n"
}
},
"requiredInputs": [
"appName",
"connectAddress",
"version"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CseMicroservice resources.\n",
"properties": {
"adminPass": {
"type": "string",
"description": "Specifies the account password.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice.\nThe password format must meet the following conditions:\n+ Must be `8` to `32` characters long.\n+ A password must contain at least one digit, one uppercase letter, one lowercase letter, and one special character\n(-~!@#%^*_=+?$&()|<>{}[]).\n+ Cannot be the account name or account name spelled backwards.\n+ The password can only start with a letter.\n",
"secret": true
},
"adminUser": {
"type": "string",
"description": "Specifies the account name. The initial account name is **root**.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice.\n"
},
"appName": {
"type": "string",
"description": "Specifies the name of the dedicated microservice application.\nChanging this will create a new microservice.\n"
},
"connectAddress": {
"type": "string",
"description": "Specifies the connection address of service registry center for the\nspecified dedicated CSE engine. Changing this will create a new microservice.\n\n> We are only support IPv4 addresses yet.\n"
},
"cseMicroserviceId": {
"type": "string",
"description": "The microservice ID.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the dedicated microservice.\nThe description can contian a maximum of `256` characters.\nChanging this will create a new microservice.\n"
},
"environment": {
"type": "string",
"description": "Specifies the environment (stage) type.\nThe valid values are **development**, **testing**, **acceptance** and **production**.\nIf omitted, the microservice will be deployed in an empty environment.\nChanging this will create a new microservice.\n"
},
"level": {
"type": "string",
"description": "Specifies the microservice level.\nThe valid values are **FRONT**, **MIDDLE**, and **BACK**. Changing this will create a new microservice.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the dedicated microservice.\nThe name can contain `1` to `128` characters, only letters, digits, underscore (_), hyphens (-) and dots (.) are\nallowed. The name must start and end with a letter or digit. Changing this will create a new microservice.\n"
},
"status": {
"type": "string",
"description": "The microservice status. The values supports **UP** and **DOWN**.\n"
},
"version": {
"type": "string",
"description": "Specifies the version of the dedicated microservice.\nChanging this will create a new microservice.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cseMicroserviceEngine:CseMicroserviceEngine": {
"description": "Manages a dedicated microservice engine resource within FlexibleEngine.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst exampleCse = new flexibleengine.CseMicroserviceEngine(\"exampleCse\", {\n flavor: \"cse.s1.small\",\n networkId: flexibleengine_vpc_subnet_v1.example_subnet.id,\n authType: \"NONE\",\n availabilityZones: [\"eu-west-0a\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nexample_cse = flexibleengine.CseMicroserviceEngine(\"exampleCse\",\n flavor=\"cse.s1.small\",\n network_id=flexibleengine_vpc_subnet_v1[\"example_subnet\"][\"id\"],\n auth_type=\"NONE\",\n availability_zones=[\"eu-west-0a\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var exampleCse = new Flexibleengine.CseMicroserviceEngine(\"exampleCse\", new()\n {\n Flavor = \"cse.s1.small\",\n NetworkId = flexibleengine_vpc_subnet_v1.Example_subnet.Id,\n AuthType = \"NONE\",\n AvailabilityZones = new[]\n {\n \"eu-west-0a\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewCseMicroserviceEngine(ctx, \"exampleCse\", &flexibleengine.CseMicroserviceEngineArgs{\n\t\t\tFlavor: pulumi.String(\"cse.s1.small\"),\n\t\t\tNetworkId: pulumi.Any(flexibleengine_vpc_subnet_v1.Example_subnet.Id),\n\t\t\tAuthType: pulumi.String(\"NONE\"),\n\t\t\tAvailabilityZones: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"eu-west-0a\"),\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.flexibleengine.CseMicroserviceEngine;\nimport com.pulumi.flexibleengine.CseMicroserviceEngineArgs;\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 exampleCse = new CseMicroserviceEngine(\"exampleCse\", CseMicroserviceEngineArgs.builder()\n .flavor(\"cse.s1.small\")\n .networkId(flexibleengine_vpc_subnet_v1.example_subnet().id())\n .authType(\"NONE\")\n .availabilityZones(\"eu-west-0a\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n exampleCse:\n type: flexibleengine:CseMicroserviceEngine\n properties:\n flavor: cse.s1.small\n networkId: ${flexibleengine_vpc_subnet_v1.example_subnet.id}\n authType: NONE\n availabilityZones:\n - eu-west-0a\n```\n\n\n## Import\n\nEngines can be imported using their `id`, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/cseMicroserviceEngine:CseMicroserviceEngine test eddc5d42-f9d5-4f8e-984b-d6f3e088561c\n```\n\nNote that the imported state may not be identical to your resource definition, due to some attributes missing from the\n\nAPI response, security or some other reason. The missing attributes are `admin_pass` and `extend_params`.\n\nIt is generally recommended running `pulumi preview` after importing an instance.\n\nYou can then decide if changes should be applied to the instance, or the resource definition should be updated to\n\nalign with the instance. Also you can ignore changes as below.\n\nhcl\n\nresource \"flexibleengine_cse_microservice_engine\" \"test\" {\n\n ...\n\n lifecycle {\n\n ignore_changes = [\n\n admin_pass,\n\n extend_params,\n\n ]\n\n }\n\n}\n\n",
"properties": {
"adminPass": {
"type": "string",
"description": "Specifies the account password. The corresponding account name is **root**.\nRequired if `auth_type` is **RBAC**. Changing this will create a new engine.\nThe password format must meet the following conditions:\n+ Must be `8` to `32` characters long.\n+ A password must contain at least one digit, one uppercase letter, one lowercase letter, and one special character\n(-~!@#%^*_=+?$&()|<>{}[]).\n+ Cannot be the account name or account name spelled backwards.\n+ The password can only start with a letter.\n",
"secret": true
},
"authType": {
"type": "string",
"description": "Specifies the authentication method for the dedicated microservice engine.\nChanging this will create a new engine.\n+ **RBAC**: Enable security authentication.\nSecurity authentication applies to the scenario where multiple users use the same engine.\nAfter security authentication is enabled, all users who use the engine can log in using the account and password.\nYou can assign the account and role in the System Management.\n+ **NONE**: Disable security authentication.\nAfter security authentication is disabled, all users who use the engine can use the engine without using the account\nand password, and have the same operation permissions on all services.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the list of availability zone.\nChanging this will create a new engine.\n"
},
"configCenterAddresses": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceEngineConfigCenterAddress:CseMicroserviceEngineConfigCenterAddress"
},
"description": "The address of config center.\nThe object structure is documented below.\n"
},
"cseMicroserviceEngineId": {
"type": "string",
"description": "The resource ID in UUID format.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the dedicated microservice engine.\nThe description can contian a maximum of `255` characters.\nChanging this will create a new engine.\n"
},
"eipId": {
"type": "string",
"description": "Specifies the EIP ID to which the dedicated microservice engine assocated.\nChanging this will create a new engine.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id of the cse microservice\nengine resource. Changing this will create a new resource.\n"
},
"extendParams": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the additional parameters for the dedicated microservice engine.\nChanging this will create a new engine.\n\n> After the engine is created, the system will automatically add a series of additional parameters to it.\nThe specific parameters are subject to the state of the dedicated microservice engine.\nThis parameter will be affected by these parameters and will appear when `pulumi preview` or `pulumi up`.\nIf it is inconsistent with the script configuration, it can be ignored by `ignore_changes` in non-change scenarios.\n"
},
"flavor": {
"type": "string",
"description": "Specifies the flavor of the dedicated microservice engine.\nChanging this will create a new engine.\n"
},
"instanceLimit": {
"type": "number",
"description": "The maximum number of the microservice instance resources.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the dedicated microservice engine.\nThe name can contain `3` to `24` characters, only letters, digits and hyphens (-) are allowed.\nThe name must start with a letter and cannot end with a hyphen (-).\nChanging this will create a new engine.\n"
},
"networkId": {
"type": "string",
"description": "Specifies the ID of VPC the subnet to which the dedicated microservice\nengine belongs. Changing this will create a new engine.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the dedicated microservice engine.\nIf omitted, the provider-level region will be used. Changing this will create a new engine.\n"
},
"serviceLimit": {
"type": "number",
"description": "The maximum number of the microservice resources.\n"
},
"serviceRegistryAddresses": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceEngineServiceRegistryAddress:CseMicroserviceEngineServiceRegistryAddress"
},
"description": "The connection address of service center.\nThe object structure is documented below.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceEngineTimeouts:CseMicroserviceEngineTimeouts"
},
"version": {
"type": "string",
"description": "Specifies the version of the dedicated microservice engine. The value can be:\n**CSE**. Defaults to: **CSE**. Changing this will create a new engine.\n"
}
},
"type": "object",
"required": [
"authType",
"availabilityZones",
"configCenterAddresses",
"cseMicroserviceEngineId",
"extendParams",
"flavor",
"instanceLimit",
"name",
"networkId",
"region",
"serviceLimit",
"serviceRegistryAddresses"
],
"inputProperties": {
"adminPass": {
"type": "string",
"description": "Specifies the account password. The corresponding account name is **root**.\nRequired if `auth_type` is **RBAC**. Changing this will create a new engine.\nThe password format must meet the following conditions:\n+ Must be `8` to `32` characters long.\n+ A password must contain at least one digit, one uppercase letter, one lowercase letter, and one special character\n(-~!@#%^*_=+?$&()|<>{}[]).\n+ Cannot be the account name or account name spelled backwards.\n+ The password can only start with a letter.\n",
"secret": true
},
"authType": {
"type": "string",
"description": "Specifies the authentication method for the dedicated microservice engine.\nChanging this will create a new engine.\n+ **RBAC**: Enable security authentication.\nSecurity authentication applies to the scenario where multiple users use the same engine.\nAfter security authentication is enabled, all users who use the engine can log in using the account and password.\nYou can assign the account and role in the System Management.\n+ **NONE**: Disable security authentication.\nAfter security authentication is disabled, all users who use the engine can use the engine without using the account\nand password, and have the same operation permissions on all services.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the list of availability zone.\nChanging this will create a new engine.\n"
},
"cseMicroserviceEngineId": {
"type": "string",
"description": "The resource ID in UUID format.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the dedicated microservice engine.\nThe description can contian a maximum of `255` characters.\nChanging this will create a new engine.\n"
},
"eipId": {
"type": "string",
"description": "Specifies the EIP ID to which the dedicated microservice engine assocated.\nChanging this will create a new engine.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id of the cse microservice\nengine resource. Changing this will create a new resource.\n"
},
"extendParams": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the additional parameters for the dedicated microservice engine.\nChanging this will create a new engine.\n\n> After the engine is created, the system will automatically add a series of additional parameters to it.\nThe specific parameters are subject to the state of the dedicated microservice engine.\nThis parameter will be affected by these parameters and will appear when `pulumi preview` or `pulumi up`.\nIf it is inconsistent with the script configuration, it can be ignored by `ignore_changes` in non-change scenarios.\n"
},
"flavor": {
"type": "string",
"description": "Specifies the flavor of the dedicated microservice engine.\nChanging this will create a new engine.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the dedicated microservice engine.\nThe name can contain `3` to `24` characters, only letters, digits and hyphens (-) are allowed.\nThe name must start with a letter and cannot end with a hyphen (-).\nChanging this will create a new engine.\n"
},
"networkId": {
"type": "string",
"description": "Specifies the ID of VPC the subnet to which the dedicated microservice\nengine belongs. Changing this will create a new engine.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the dedicated microservice engine.\nIf omitted, the provider-level region will be used. Changing this will create a new engine.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceEngineTimeouts:CseMicroserviceEngineTimeouts"
},
"version": {
"type": "string",
"description": "Specifies the version of the dedicated microservice engine. The value can be:\n**CSE**. Defaults to: **CSE**. Changing this will create a new engine.\n"
}
},
"requiredInputs": [
"authType",
"availabilityZones",
"flavor",
"networkId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CseMicroserviceEngine resources.\n",
"properties": {
"adminPass": {
"type": "string",
"description": "Specifies the account password. The corresponding account name is **root**.\nRequired if `auth_type` is **RBAC**. Changing this will create a new engine.\nThe password format must meet the following conditions:\n+ Must be `8` to `32` characters long.\n+ A password must contain at least one digit, one uppercase letter, one lowercase letter, and one special character\n(-~!@#%^*_=+?$&()|<>{}[]).\n+ Cannot be the account name or account name spelled backwards.\n+ The password can only start with a letter.\n",
"secret": true
},
"authType": {
"type": "string",
"description": "Specifies the authentication method for the dedicated microservice engine.\nChanging this will create a new engine.\n+ **RBAC**: Enable security authentication.\nSecurity authentication applies to the scenario where multiple users use the same engine.\nAfter security authentication is enabled, all users who use the engine can log in using the account and password.\nYou can assign the account and role in the System Management.\n+ **NONE**: Disable security authentication.\nAfter security authentication is disabled, all users who use the engine can use the engine without using the account\nand password, and have the same operation permissions on all services.\n"
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the list of availability zone.\nChanging this will create a new engine.\n"
},
"configCenterAddresses": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceEngineConfigCenterAddress:CseMicroserviceEngineConfigCenterAddress"
},
"description": "The address of config center.\nThe object structure is documented below.\n"
},
"cseMicroserviceEngineId": {
"type": "string",
"description": "The resource ID in UUID format.\n"
},
"description": {
"type": "string",
"description": "Specifies the description of the dedicated microservice engine.\nThe description can contian a maximum of `255` characters.\nChanging this will create a new engine.\n"
},
"eipId": {
"type": "string",
"description": "Specifies the EIP ID to which the dedicated microservice engine assocated.\nChanging this will create a new engine.\n"
},
"enterpriseProjectId": {
"type": "string",
"description": "Specifies the enterprise project id of the cse microservice\nengine resource. Changing this will create a new resource.\n"
},
"extendParams": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the additional parameters for the dedicated microservice engine.\nChanging this will create a new engine.\n\n> After the engine is created, the system will automatically add a series of additional parameters to it.\nThe specific parameters are subject to the state of the dedicated microservice engine.\nThis parameter will be affected by these parameters and will appear when `pulumi preview` or `pulumi up`.\nIf it is inconsistent with the script configuration, it can be ignored by `ignore_changes` in non-change scenarios.\n"
},
"flavor": {
"type": "string",
"description": "Specifies the flavor of the dedicated microservice engine.\nChanging this will create a new engine.\n"
},
"instanceLimit": {
"type": "number",
"description": "The maximum number of the microservice instance resources.\n"
},
"name": {
"type": "string",
"description": "Specifies the name of the dedicated microservice engine.\nThe name can contain `3` to `24` characters, only letters, digits and hyphens (-) are allowed.\nThe name must start with a letter and cannot end with a hyphen (-).\nChanging this will create a new engine.\n"
},
"networkId": {
"type": "string",
"description": "Specifies the ID of VPC the subnet to which the dedicated microservice\nengine belongs. Changing this will create a new engine.\n"
},
"region": {
"type": "string",
"description": "Specifies the region in which to create the dedicated microservice engine.\nIf omitted, the provider-level region will be used. Changing this will create a new engine.\n"
},
"serviceLimit": {
"type": "number",
"description": "The maximum number of the microservice resources.\n"
},
"serviceRegistryAddresses": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceEngineServiceRegistryAddress:CseMicroserviceEngineServiceRegistryAddress"
},
"description": "The connection address of service center.\nThe object structure is documented below.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceEngineTimeouts:CseMicroserviceEngineTimeouts"
},
"version": {
"type": "string",
"description": "Specifies the version of the dedicated microservice engine. The value can be:\n**CSE**. Defaults to: **CSE**. Changing this will create a new engine.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cseMicroserviceInstance:CseMicroserviceInstance": {
"description": "Manages a dedicated microservice instance resource within FlexibleEngine.\n\n## Example Usage\n\n### Create a microservice instance under a microservice with RBAC authentication of engine disabled\n\n\n```yaml\nconfiguration:\n engineConnAddr:\n type: dynamic\n microserviceId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CseMicroserviceInstance\n properties:\n connectAddress: ${engineConnAddr}\n microserviceId: ${microserviceId}\n hostName: localhost\n endpoints:\n - grpc://127.0.1.132:9980\n - rest://127.0.0.111:8081\n verison: 1.0.0\n properties:\n _TAGS: A, B\n attr1: a\n nodeIP: 127.0.0.1\n healthCheck:\n mode: push\n interval: 30\n maxRetries: 3\n dataCenter:\n name: dc\n region: ${var.region_name}\n availabilityZone: ${var.az_name}\n```\n\n\n### Create a microservice instance under a microservice with RBAC authentication of engine enabled\n\n\n```yaml\nconfiguration:\n engineConnAddr:\n type: dynamic\n microserviceId:\n type: dynamic\nresources:\n test:\n type: flexibleengine:CseMicroserviceInstance\n properties:\n connectAddress: ${engineConnAddr}\n microserviceId: ${microserviceId}\n hostName: localhost\n endpoints:\n - grpc://127.0.1.132:9980\n - rest://127.0.0.111:8081\n verison: 1.0.0\n properties:\n _TAGS: A, B\n attr1: a\n nodeIP: 127.0.0.1\n healthCheck:\n mode: push\n interval: 30\n maxRetries: 3\n dataCenter:\n name: dc\n region: ${var.region_name}\n availabilityZone: ${var.az_name}\n adminUser: root\n adminPass: Flexibleengine!123\n```\n\n\n## Import\n\nMicroservices can be imported using related `connect_address`, `microservice_id` and their `id`, separated by a\n\nslash (/), e.g.\n\n```sh\n$ pulumi import flexibleengine:index/cseMicroserviceInstance:CseMicroserviceInstance test https://124.70.26.32:30100/f14960ba495e03f59f85aacaaafbdef3fbff3f0d/336e7428dd9411eca913fa163e7364b7\n```\n\nIf you enabled the **RBAC** authorization, you also need to provide the account name and password, e.g.\n\n```sh\n$ pulumi import flexibleengine:index/cseMicroserviceInstance:CseMicroserviceInstance test 'https://124.70.26.32:30100/f14960ba495e03f59f85aacaaafbdef3fbff3f0d/336e7428dd9411eca913fa163e7364b7/root/Test!123'\n```\n\nThe single quotes can help you solve the problem of special characters reporting errors on bash.\n\n",
"properties": {
"adminPass": {
"type": "string",
"description": "Specifies the account password.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice instance.\nThe password format must meet the following conditions:\n+ Must be `8` to `32` characters long.\n+ A password must contain at least one digit, one uppercase letter, one lowercase letter, and one special character\n(-~!@#%^*_=+?$&()|<>{}[]).\n+ Cannot be the account name or account name spelled backwards.\n+ The password can only start with a letter.\n\n\nThe `health_check` block supports:\n",
"secret": true
},
"adminUser": {
"type": "string",
"description": "Specifies the account name. The initial account name is **root**.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice instance.\n"
},
"connectAddress": {
"type": "string",
"description": "Specifies the connection address of service registry center for the\nspecified dedicated CSE engine. Changing this will create a new microservice instance.\n\n> We are only support IPv4 addresses yet.\n"
},
"cseMicroserviceInstanceId": {
"type": "string",
"description": "The microservice instance ID.\n"
},
"dataCenter": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceInstanceDataCenter:CseMicroserviceInstanceDataCenter",
"description": "Specifies the data center configuration.\nThe object structure is documented below.\nChanging this will create a new microservice instance.\n"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access addresses information.\nChanging this will create a new microservice instance.\n"
},
"healthCheck": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceInstanceHealthCheck:CseMicroserviceInstanceHealthCheck",
"description": "Specifies the health check configuration.\nThe object structure is documented below.\nChanging this will create a new microservice instance.\n"
},
"hostName": {
"type": "string",
"description": "Specifies the host name, such as `localhost`.\nChanging this will create a new microservice instance.\n"
},
"microserviceId": {
"type": "string",
"description": "Specifies the ID of the dedicated microservice to which the instance\nbelongs. Changing this will create a new microservice instance.\n"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the extended attributes.\nChanging this will create a new microservice instance.\n"
},
"status": {
"type": "string",
"description": "The microservice instance status. The values supports **UP**, **DOWN**, **STARTING** and **OUTOFSERVICE**.\n"
},
"version": {
"type": "string",
"description": "Specifies the verison of the dedicated microservice instance.\nChanging this will create a new microservice instance.\n"
}
},
"type": "object",
"required": [
"connectAddress",
"cseMicroserviceInstanceId",
"endpoints",
"hostName",
"microserviceId",
"properties",
"status",
"version"
],
"inputProperties": {
"adminPass": {
"type": "string",
"description": "Specifies the account password.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice instance.\nThe password format must meet the following conditions:\n+ Must be `8` to `32` characters long.\n+ A password must contain at least one digit, one uppercase letter, one lowercase letter, and one special character\n(-~!@#%^*_=+?$&()|<>{}[]).\n+ Cannot be the account name or account name spelled backwards.\n+ The password can only start with a letter.\n\n\nThe `health_check` block supports:\n",
"secret": true
},
"adminUser": {
"type": "string",
"description": "Specifies the account name. The initial account name is **root**.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice instance.\n"
},
"connectAddress": {
"type": "string",
"description": "Specifies the connection address of service registry center for the\nspecified dedicated CSE engine. Changing this will create a new microservice instance.\n\n> We are only support IPv4 addresses yet.\n"
},
"cseMicroserviceInstanceId": {
"type": "string",
"description": "The microservice instance ID.\n"
},
"dataCenter": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceInstanceDataCenter:CseMicroserviceInstanceDataCenter",
"description": "Specifies the data center configuration.\nThe object structure is documented below.\nChanging this will create a new microservice instance.\n"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access addresses information.\nChanging this will create a new microservice instance.\n"
},
"healthCheck": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceInstanceHealthCheck:CseMicroserviceInstanceHealthCheck",
"description": "Specifies the health check configuration.\nThe object structure is documented below.\nChanging this will create a new microservice instance.\n"
},
"hostName": {
"type": "string",
"description": "Specifies the host name, such as `localhost`.\nChanging this will create a new microservice instance.\n"
},
"microserviceId": {
"type": "string",
"description": "Specifies the ID of the dedicated microservice to which the instance\nbelongs. Changing this will create a new microservice instance.\n"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the extended attributes.\nChanging this will create a new microservice instance.\n"
},
"version": {
"type": "string",
"description": "Specifies the verison of the dedicated microservice instance.\nChanging this will create a new microservice instance.\n"
}
},
"requiredInputs": [
"connectAddress",
"endpoints",
"hostName",
"microserviceId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CseMicroserviceInstance resources.\n",
"properties": {
"adminPass": {
"type": "string",
"description": "Specifies the account password.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice instance.\nThe password format must meet the following conditions:\n+ Must be `8` to `32` characters long.\n+ A password must contain at least one digit, one uppercase letter, one lowercase letter, and one special character\n(-~!@#%^*_=+?$&()|<>{}[]).\n+ Cannot be the account name or account name spelled backwards.\n+ The password can only start with a letter.\n\n\nThe `health_check` block supports:\n",
"secret": true
},
"adminUser": {
"type": "string",
"description": "Specifies the account name. The initial account name is **root**.\nRequired if the `auth_type` of engine is **RBAC**. Changing this will create a new microservice instance.\n"
},
"connectAddress": {
"type": "string",
"description": "Specifies the connection address of service registry center for the\nspecified dedicated CSE engine. Changing this will create a new microservice instance.\n\n> We are only support IPv4 addresses yet.\n"
},
"cseMicroserviceInstanceId": {
"type": "string",
"description": "The microservice instance ID.\n"
},
"dataCenter": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceInstanceDataCenter:CseMicroserviceInstanceDataCenter",
"description": "Specifies the data center configuration.\nThe object structure is documented below.\nChanging this will create a new microservice instance.\n"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the access addresses information.\nChanging this will create a new microservice instance.\n"
},
"healthCheck": {
"$ref": "#/types/flexibleengine:index%2FCseMicroserviceInstanceHealthCheck:CseMicroserviceInstanceHealthCheck",
"description": "Specifies the health check configuration.\nThe object structure is documented below.\nChanging this will create a new microservice instance.\n"
},
"hostName": {
"type": "string",
"description": "Specifies the host name, such as `localhost`.\nChanging this will create a new microservice instance.\n"
},
"microserviceId": {
"type": "string",
"description": "Specifies the ID of the dedicated microservice to which the instance\nbelongs. Changing this will create a new microservice instance.\n"
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the extended attributes.\nChanging this will create a new microservice instance.\n"
},
"status": {
"type": "string",
"description": "The microservice instance status. The values supports **UP**, **DOWN**, **STARTING** and **OUTOFSERVICE**.\n"
},
"version": {
"type": "string",
"description": "Specifies the verison of the dedicated microservice instance.\nChanging this will create a new microservice instance.\n"
}
},
"type": "object"
}
},
"flexibleengine:index/cssClusterV1:CssClusterV1": {
"description": "CSS cluster management\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst exampleVpc = new flexibleengine.VpcV1(\"exampleVpc\", {cidr: \"192.168.0.0/16\"});\nconst exampleSubnet = new flexibleengine.VpcSubnetV1(\"exampleSubnet\", {\n cidr: \"192.168.0.0/24\",\n gatewayIp: \"192.168.0.1\",\n vpcId: exampleVpc.vpcV1Id,\n});\nconst exampleSecgroup = new flexibleengine.NetworkingSecgroupV2(\"exampleSecgroup\", {description: \"My neutron security group\"});\nconst cluster = new flexibleengine.CssClusterV1(\"cluster\", {\n engineVersion: \"7.9.3\",\n nodeNumber: 1,\n nodeConfig: {\n availabilityZone: \"eu-west-0a\",\n flavor: \"ess.spec-4u16g\",\n networkInfo: {\n vpcId: exampleVpc.vpcV1Id,\n subnetId: exampleSubnet.vpcSubnetV1Id,\n securityGroupId: exampleSecgroup.networkingSecgroupV2Id,\n },\n volume: {\n volumeType: \"COMMON\",\n size: 40,\n },\n },\n tags: {\n foo: \"bar\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nexample_vpc = flexibleengine.VpcV1(\"exampleVpc\", cidr=\"192.168.0.0/16\")\nexample_subnet = flexibleengine.VpcSubnetV1(\"exampleSubnet\",\n cidr=\"192.168.0.0/24\",\n gateway_ip=\"192.168.0.1\",\n vpc_id=example_vpc.vpc_v1_id)\nexample_secgroup = flexibleengine.NetworkingSecgroupV2(\"exampleSecgroup\", description=\"My neutron security group\")\ncluster = flexibleengine.CssClusterV1(\"cluster\",\n engine_version=\"7.9.3\",\n node_number=1,\n node_config={\n \"availability_zone\": \"eu-west-0a\",\n \"flavor\": \"ess.spec-4u16g\",\n \"network_info\": {\n \"vpc_id\": example_vpc.vpc_v1_id,\n \"subnet_id\": example_subnet.vpc_subnet_v1_id,\n \"security_group_id\": example_secgroup.networking_secgroup_v2_id,\n },\n \"volume\": {\n \"volume_type\": \"COMMON\",\n \"size\": 40,\n },\n },\n tags={\n \"foo\": \"bar\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var exampleVpc = new Flexibleengine.VpcV1(\"exampleVpc\", new()\n {\n Cidr = \"192.168.0.0/16\",\n });\n\n var exampleSubnet = new Flexibleengine.VpcSubnetV1(\"exampleSubnet\", new()\n {\n Cidr = \"192.168.0.0/24\",\n GatewayIp = \"192.168.0.1\",\n VpcId = exampleVpc.VpcV1Id,\n });\n\n var exampleSecgroup = new Flexibleengine.NetworkingSecgroupV2(\"exampleSecgroup\", new()\n {\n Description = \"My neutron security group\",\n });\n\n var cluster = new Flexibleengine.CssClusterV1(\"cluster\", new()\n {\n EngineVersion = \"7.9.3\",\n NodeNumber = 1,\n NodeConfig = new Flexibleengine.Inputs.CssClusterV1NodeConfigArgs\n {\n AvailabilityZone = \"eu-west-0a\",\n Flavor = \"ess.spec-4u16g\",\n NetworkInfo = new Flexibleengine.Inputs.CssClusterV1NodeConfigNetworkInfoArgs\n {\n VpcId = exampleVpc.VpcV1Id,\n SubnetId = exampleSubnet.VpcSubnetV1Id,\n SecurityGroupId = exampleSecgroup.NetworkingSecgroupV2Id,\n },\n Volume = new Flexibleengine.Inputs.CssClusterV1NodeConfigVolumeArgs\n {\n VolumeType = \"COMMON\",\n Size = 40,\n },\n },\n Tags = \n {\n { \"foo\", \"bar\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texampleVpc, err := flexibleengine.NewVpcV1(ctx, \"exampleVpc\", &flexibleengine.VpcV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/16\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleSubnet, err := flexibleengine.NewVpcSubnetV1(ctx, \"exampleSubnet\", &flexibleengine.VpcSubnetV1Args{\n\t\t\tCidr: pulumi.String(\"192.168.0.0/24\"),\n\t\t\tGatewayIp: pulumi.String(\"192.168.0.1\"),\n\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\texampleSecgroup, err := flexibleengine.NewNetworkingSecgroupV2(ctx, \"exampleSecgroup\", &flexibleengine.NetworkingSecgroupV2Args{\n\t\t\tDescription: pulumi.String(\"My neutron security group\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = flexibleengine.NewCssClusterV1(ctx, \"cluster\", &flexibleengine.CssClusterV1Args{\n\t\t\tEngineVersion: pulumi.String(\"7.9.3\"),\n\t\t\tNodeNumber: pulumi.Float64(1),\n\t\t\tNodeConfig: &flexibleengine.CssClusterV1NodeConfigArgs{\n\t\t\t\tAvailabilityZone: pulumi.String(\"eu-west-0a\"),\n\t\t\t\tFlavor: pulumi.String(\"ess.spec-4u16g\"),\n\t\t\t\tNetworkInfo: &flexibleengine.CssClusterV1NodeConfigNetworkInfoArgs{\n\t\t\t\t\tVpcId: exampleVpc.VpcV1Id,\n\t\t\t\t\tSubnetId: exampleSubnet.VpcSubnetV1Id,\n\t\t\t\t\tSecurityGroupId: exampleSecgroup.NetworkingSecgroupV2Id,\n\t\t\t\t},\n\t\t\t\tVolume: &flexibleengine.CssClusterV1NodeConfigVolumeArgs{\n\t\t\t\t\tVolumeType: pulumi.String(\"COMMON\"),\n\t\t\t\t\tSize: pulumi.Float64(40),\n\t\t\t\t},\n\t\t\t},\n\t\t\tTags: pulumi.StringMap{\n\t\t\t\t\"foo\": pulumi.String(\"bar\"),\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.flexibleengine.VpcV1;\nimport com.pulumi.flexibleengine.VpcV1Args;\nimport com.pulumi.flexibleengine.VpcSubnetV1;\nimport com.pulumi.flexibleengine.VpcSubnetV1Args;\nimport com.pulumi.flexibleengine.NetworkingSecgroupV2;\nimport com.pulumi.flexibleengine.NetworkingSecgroupV2Args;\nimport com.pulumi.flexibleengine.CssClusterV1;\nimport com.pulumi.flexibleengine.CssClusterV1Args;\nimport com.pulumi.flexibleengine.inputs.CssClusterV1NodeConfigArgs;\nimport com.pulumi.flexibleengine.inputs.CssClusterV1NodeConfigNetworkInfoArgs;\nimport com.pulumi.flexibleengine.inputs.CssClusterV1NodeConfigVolumeArgs;\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 exampleVpc = new VpcV1(\"exampleVpc\", VpcV1Args.builder()\n .cidr(\"192.168.0.0/16\")\n .build());\n\n var exampleSubnet = new VpcSubnetV1(\"exampleSubnet\", VpcSubnetV1Args.builder()\n .cidr(\"192.168.0.0/24\")\n .gatewayIp(\"192.168.0.1\")\n .vpcId(exampleVpc.vpcV1Id())\n .build());\n\n var exampleSecgroup = new NetworkingSecgroupV2(\"exampleSecgroup\", NetworkingSecgroupV2Args.builder()\n .description(\"My neutron security group\")\n .build());\n\n var cluster = new CssClusterV1(\"cluster\", CssClusterV1Args.builder()\n .engineVersion(\"7.9.3\")\n .nodeNumber(1)\n .nodeConfig(CssClusterV1NodeConfigArgs.builder()\n .availabilityZone(\"eu-west-0a\")\n .flavor(\"ess.spec-4u16g\")\n .networkInfo(CssClusterV1NodeConfigNetworkInfoArgs.builder()\n .vpcId(exampleVpc.vpcV1Id())\n .subnetId(exampleSubnet.vpcSubnetV1Id())\n .securityGroupId(exampleSecgroup.networkingSecgroupV2Id())\n .build())\n .volume(CssClusterV1NodeConfigVolumeArgs.builder()\n .volumeType(\"COMMON\")\n .size(40)\n .build())\n .build())\n .tags(Map.of(\"foo\", \"bar\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n exampleVpc:\n type: flexibleengine:VpcV1\n properties:\n cidr: 192.168.0.0/16\n exampleSubnet:\n type: flexibleengine:VpcSubnetV1\n properties:\n cidr: 192.168.0.0/24\n gatewayIp: 192.168.0.1\n vpcId: ${exampleVpc.vpcV1Id}\n exampleSecgroup:\n type: flexibleengine:NetworkingSecgroupV2\n properties:\n description: My neutron security group\n cluster:\n type: flexibleengine:CssClusterV1\n properties:\n engineVersion: 7.9.3\n nodeNumber: 1\n nodeConfig:\n availabilityZone: eu-west-0a\n flavor: ess.spec-4u16g\n networkInfo:\n vpcId: ${exampleVpc.vpcV1Id}\n subnetId: ${exampleSubnet.vpcSubnetV1Id}\n securityGroupId: ${exampleSecgroup.networkingSecgroupV2Id}\n volume:\n volumeType: COMMON\n size: 40\n tags:\n foo: bar\n```\n\n",
"properties": {
"backupStrategy": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1BackupStrategy:CssClusterV1BackupStrategy",
"description": "Specifies the advanced backup policy.\nbackup_strategy object structure is documented below.\n\n> **NOTE:** `backup_strategy` requires the authority of *OBS Bucket* and *IAM Agency*.\n"
},
"created": {
"type": "string",
"description": "Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss.\n"
},
"cssClusterV1Id": {
"type": "string",
"description": "Instance ID.\n"
},
"endpoint": {
"type": "string",
"description": "Indicates the IP address and port number.\n"
},
"engineType": {
"type": "string",
"description": "Specifies the engine type. The default value is `elasticsearch`.\nCurrently, the value can only be \"elasticsearch\". Changing this parameter will create a new resource.\n"
},
"engineVersion": {
"type": "string",
"description": "Specifies the engine version. For example, `7.6.2` and `7.9.3`.\nFor details, see CSS [Supported Cluster Versions](https://docs.prod-cloud-ocb.orange-business.com/api/css/css_03_0056.html).\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the cluster name. It contains 4 to 32 characters. Only letters,\ndigits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.\nChanging this parameter will create a new resource.\n"
},
"nodeConfig": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1NodeConfig:CssClusterV1NodeConfig",
"description": "Specifies the node configuration. node_config\nobject structure is documented below. Changing this parameter will create a new resource.\n"
},
"nodeNumber": {
"type": "number",
"description": "Specifies the number of cluster instances. The value range is 1 to 32. Defaults to 1.\n"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1Node:CssClusterV1Node"
},
"description": "List of node objects. nodes object structure is documented below.\n"
},
"password": {
"type": "string",
"description": "Specifies the password of the cluster administrator admin in security mode.\nThis parameter is mandatory only when security_mode is set to true. Changing this parameter will create a new resource.\nThe administrator password must meet the following requirements:\n- The password can contain 8 to 32 characters.\n- The password must contain at least 3 of the following character types: uppercase letters, lowercase letters,\ndigits, and special characters (~!@#$%^&*()-_=+\\\\|[{}];:,<.>/?).\n",
"secret": true
},
"securityMode": {
"type": "boolean",
"description": "Whether to enable communication encryption and security authentication.\nAvailable values include *true* and *false*. security_mode is disabled by default.\nChanging this parameter will create a new resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the key/value pairs to associate with the cluster.\n\n\nThe `node_config` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1Timeouts:CssClusterV1Timeouts"
}
},
"type": "object",
"required": [
"created",
"cssClusterV1Id",
"endpoint",
"engineVersion",
"name",
"nodeConfig",
"nodes"
],
"inputProperties": {
"backupStrategy": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1BackupStrategy:CssClusterV1BackupStrategy",
"description": "Specifies the advanced backup policy.\nbackup_strategy object structure is documented below.\n\n> **NOTE:** `backup_strategy` requires the authority of *OBS Bucket* and *IAM Agency*.\n"
},
"cssClusterV1Id": {
"type": "string",
"description": "Instance ID.\n"
},
"engineType": {
"type": "string",
"description": "Specifies the engine type. The default value is `elasticsearch`.\nCurrently, the value can only be \"elasticsearch\". Changing this parameter will create a new resource.\n"
},
"engineVersion": {
"type": "string",
"description": "Specifies the engine version. For example, `7.6.2` and `7.9.3`.\nFor details, see CSS [Supported Cluster Versions](https://docs.prod-cloud-ocb.orange-business.com/api/css/css_03_0056.html).\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the cluster name. It contains 4 to 32 characters. Only letters,\ndigits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.\nChanging this parameter will create a new resource.\n"
},
"nodeConfig": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1NodeConfig:CssClusterV1NodeConfig",
"description": "Specifies the node configuration. node_config\nobject structure is documented below. Changing this parameter will create a new resource.\n"
},
"nodeNumber": {
"type": "number",
"description": "Specifies the number of cluster instances. The value range is 1 to 32. Defaults to 1.\n"
},
"password": {
"type": "string",
"description": "Specifies the password of the cluster administrator admin in security mode.\nThis parameter is mandatory only when security_mode is set to true. Changing this parameter will create a new resource.\nThe administrator password must meet the following requirements:\n- The password can contain 8 to 32 characters.\n- The password must contain at least 3 of the following character types: uppercase letters, lowercase letters,\ndigits, and special characters (~!@#$%^&*()-_=+\\\\|[{}];:,<.>/?).\n",
"secret": true
},
"securityMode": {
"type": "boolean",
"description": "Whether to enable communication encryption and security authentication.\nAvailable values include *true* and *false*. security_mode is disabled by default.\nChanging this parameter will create a new resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the key/value pairs to associate with the cluster.\n\n\nThe `node_config` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1Timeouts:CssClusterV1Timeouts"
}
},
"requiredInputs": [
"engineVersion",
"nodeConfig"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CssClusterV1 resources.\n",
"properties": {
"backupStrategy": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1BackupStrategy:CssClusterV1BackupStrategy",
"description": "Specifies the advanced backup policy.\nbackup_strategy object structure is documented below.\n\n> **NOTE:** `backup_strategy` requires the authority of *OBS Bucket* and *IAM Agency*.\n"
},
"created": {
"type": "string",
"description": "Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss.\n"
},
"cssClusterV1Id": {
"type": "string",
"description": "Instance ID.\n"
},
"endpoint": {
"type": "string",
"description": "Indicates the IP address and port number.\n"
},
"engineType": {
"type": "string",
"description": "Specifies the engine type. The default value is `elasticsearch`.\nCurrently, the value can only be \"elasticsearch\". Changing this parameter will create a new resource.\n"
},
"engineVersion": {
"type": "string",
"description": "Specifies the engine version. For example, `7.6.2` and `7.9.3`.\nFor details, see CSS [Supported Cluster Versions](https://docs.prod-cloud-ocb.orange-business.com/api/css/css_03_0056.html).\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the cluster name. It contains 4 to 32 characters. Only letters,\ndigits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.\nChanging this parameter will create a new resource.\n"
},
"nodeConfig": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1NodeConfig:CssClusterV1NodeConfig",
"description": "Specifies the node configuration. node_config\nobject structure is documented below. Changing this parameter will create a new resource.\n"
},
"nodeNumber": {
"type": "number",
"description": "Specifies the number of cluster instances. The value range is 1 to 32. Defaults to 1.\n"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1Node:CssClusterV1Node"
},
"description": "List of node objects. nodes object structure is documented below.\n"
},
"password": {
"type": "string",
"description": "Specifies the password of the cluster administrator admin in security mode.\nThis parameter is mandatory only when security_mode is set to true. Changing this parameter will create a new resource.\nThe administrator password must meet the following requirements:\n- The password can contain 8 to 32 characters.\n- The password must contain at least 3 of the following character types: uppercase letters, lowercase letters,\ndigits, and special characters (~!@#$%^&*()-_=+\\\\|[{}];:,<.>/?).\n",
"secret": true
},
"securityMode": {
"type": "boolean",
"description": "Whether to enable communication encryption and security authentication.\nAvailable values include *true* and *false*. security_mode is disabled by default.\nChanging this parameter will create a new resource.\n"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Specifies the key/value pairs to associate with the cluster.\n\n\nThe `node_config` block supports:\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCssClusterV1Timeouts:CssClusterV1Timeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/cssSnapshotV1:CssSnapshotV1": {
"description": "CSS cluster snapshot management\n\n## Example Usage\n\n### create a snapshot\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst snapshot = new flexibleengine.CssSnapshotV1(\"snapshot\", {clusterId: _var.css_cluster_id});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nsnapshot = flexibleengine.CssSnapshotV1(\"snapshot\", cluster_id=var[\"css_cluster_id\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var snapshot = new Flexibleengine.CssSnapshotV1(\"snapshot\", new()\n {\n ClusterId = @var.Css_cluster_id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := flexibleengine.NewCssSnapshotV1(ctx, \"snapshot\", &flexibleengine.CssSnapshotV1Args{\n\t\t\tClusterId: pulumi.Any(_var.Css_cluster_id),\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.flexibleengine.CssSnapshotV1;\nimport com.pulumi.flexibleengine.CssSnapshotV1Args;\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 snapshot = new CssSnapshotV1(\"snapshot\", CssSnapshotV1Args.builder()\n .clusterId(var_.css_cluster_id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n snapshot:\n type: flexibleengine:CssSnapshotV1\n properties:\n clusterId: ${var.css_cluster_id}\n```\n\n\n## Import\n\nThis resource can be imported by specifying the CSS cluster ID and snapshot ID\n\nseparated by a slash, e.g.:\n\n```sh\n$ pulumi import flexibleengine:index/cssSnapshotV1:CssSnapshotV1 snapshot_1 /\n```\n\n",
"properties": {
"backupType": {
"type": "string",
"description": "Indicates the snapshot creation mode, the value should be \"manual\" or \"automated\".\n"
},
"clusterId": {
"type": "string",
"description": "Specifies ID of the CSS cluster where index data is to be backed up.\nChanging this parameter will create a new resource.\n"
},
"clusterName": {
"type": "string",
"description": "Indicates the CSS cluster name.\n"
},
"cssSnapshotV1Id": {
"type": "string"
},
"description": {
"type": "string",
"description": "Specifies the description of a snapshot. The value contains 0 to 256\ncharacters, and angle brackets (<) and (>) are not allowed. Changing this parameter will create a new resource.\n"
},
"indices": {
"type": "string",
"description": "Specifies the name of the index to be backed up. Multiple index names\nare separated by commas (,). By default, data of all indices is backed up. You can use the\nasterisk (*) to back up data of certain indices. For example, if you enter 2018-06*, then\ndata of indices with the name prefix of 2018-06 will be backed up.\nThe value contains 0 to 1024 characters. Uppercase letters, spaces, and certain special\ncharacters (including \"\\<|>/?) are not allowed.\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the snapshot name. The snapshot name must\nstart with a letter and contains 4 to 64 characters consisting of only\nlowercase letters, digits, hyphens (-), and underscores (_).\nChanging this parameter will create a new resource.\n"
},
"status": {
"type": "string",
"description": "Indicates the snapshot status.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCssSnapshotV1Timeouts:CssSnapshotV1Timeouts"
}
},
"type": "object",
"required": [
"backupType",
"clusterId",
"clusterName",
"cssSnapshotV1Id",
"indices",
"name",
"status"
],
"inputProperties": {
"clusterId": {
"type": "string",
"description": "Specifies ID of the CSS cluster where index data is to be backed up.\nChanging this parameter will create a new resource.\n"
},
"cssSnapshotV1Id": {
"type": "string"
},
"description": {
"type": "string",
"description": "Specifies the description of a snapshot. The value contains 0 to 256\ncharacters, and angle brackets (<) and (>) are not allowed. Changing this parameter will create a new resource.\n"
},
"indices": {
"type": "string",
"description": "Specifies the name of the index to be backed up. Multiple index names\nare separated by commas (,). By default, data of all indices is backed up. You can use the\nasterisk (*) to back up data of certain indices. For example, if you enter 2018-06*, then\ndata of indices with the name prefix of 2018-06 will be backed up.\nThe value contains 0 to 1024 characters. Uppercase letters, spaces, and certain special\ncharacters (including \"\\<|>/?) are not allowed.\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the snapshot name. The snapshot name must\nstart with a letter and contains 4 to 64 characters consisting of only\nlowercase letters, digits, hyphens (-), and underscores (_).\nChanging this parameter will create a new resource.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCssSnapshotV1Timeouts:CssSnapshotV1Timeouts"
}
},
"requiredInputs": [
"clusterId"
],
"stateInputs": {
"description": "Input properties used for looking up and filtering CssSnapshotV1 resources.\n",
"properties": {
"backupType": {
"type": "string",
"description": "Indicates the snapshot creation mode, the value should be \"manual\" or \"automated\".\n"
},
"clusterId": {
"type": "string",
"description": "Specifies ID of the CSS cluster where index data is to be backed up.\nChanging this parameter will create a new resource.\n"
},
"clusterName": {
"type": "string",
"description": "Indicates the CSS cluster name.\n"
},
"cssSnapshotV1Id": {
"type": "string"
},
"description": {
"type": "string",
"description": "Specifies the description of a snapshot. The value contains 0 to 256\ncharacters, and angle brackets (<) and (>) are not allowed. Changing this parameter will create a new resource.\n"
},
"indices": {
"type": "string",
"description": "Specifies the name of the index to be backed up. Multiple index names\nare separated by commas (,). By default, data of all indices is backed up. You can use the\nasterisk (*) to back up data of certain indices. For example, if you enter 2018-06*, then\ndata of indices with the name prefix of 2018-06 will be backed up.\nThe value contains 0 to 1024 characters. Uppercase letters, spaces, and certain special\ncharacters (including \"\\<|>/?) are not allowed.\nChanging this parameter will create a new resource.\n"
},
"name": {
"type": "string",
"description": "Specifies the snapshot name. The snapshot name must\nstart with a letter and contains 4 to 64 characters consisting of only\nlowercase letters, digits, hyphens (-), and underscores (_).\nChanging this parameter will create a new resource.\n"
},
"status": {
"type": "string",
"description": "Indicates the snapshot status.\n"
},
"timeouts": {
"$ref": "#/types/flexibleengine:index%2FCssSnapshotV1Timeouts:CssSnapshotV1Timeouts"
}
},
"type": "object"
}
},
"flexibleengine:index/ctsTrackerV1:CtsTrackerV1": {
"description": "Allows you to collect, store, and query cloud resource operation records.\n\n## Example Usage\n\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as flexibleengine from \"@pulumi/flexibleengine\";\n\nconst config = new pulumi.Config();\nconst bucketName = config.requireObject(\"bucketName\");\nconst trackerV1 = new flexibleengine.CtsTrackerV1(\"trackerV1\", {\n bucketName: bucketName,\n filePrefixName: \"tracker\",\n});\n```\n```python\nimport pulumi\nimport pulumi_flexibleengine as flexibleengine\n\nconfig = pulumi.Config()\nbucket_name = config.require_object(\"bucketName\")\ntracker_v1 = flexibleengine.CtsTrackerV1(\"trackerV1\",\n bucket_name=bucket_name,\n file_prefix_name=\"tracker\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Flexibleengine = Pulumi.Flexibleengine;\n\nreturn await Deployment.RunAsync(() => \n{\n var config = new Config();\n var bucketName = config.RequireObject