ALIYUN::ARMS::EnvCustomJob - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::ARMS::EnvCustomJob",
  "Properties": {
    "ConfigYaml": String,
    "EnvironmentId": String,
    "EnvCustomJobName": String,
    "AliyunLang": String
  }
}

Properties

Parameter	Type	Required	Update Allowed	Description	Constraints
ConfigYaml	String	Yes	Yes	The YAML configuration string of the custom job.	None
EnvCustomJobName	String	Yes	No	The name of the custom job.	None
EnvironmentId	String	Yes	No	The ID of the environment instance.	None
AliyunLang	String	No	No	The response language.	Valid values: zh and en. Default value: zh.

Return values

Fn::GetAtt

EnvironmentId: The ID of the environment instance.
EnvCustomJobName: The name of the custom job.
ConfigYaml: The YAML configuration string of the custom job.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  EnvironmentId:
    Type: String
    Description: The ID of the environment instance.
    Required: true
  EnvCustomJobName:
    Type: String
    Description: The name of the custom job.
    Required: true
  ConfigYaml:
    Type: String
    Description: The YAML configuration string of the custom job.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ARMS::EnvCustomJob
    Properties:
      EnvironmentId:
        Ref: EnvironmentId
      EnvCustomJobName:
        Ref: EnvCustomJobName
      ConfigYaml:
        Ref: ConfigYaml
Outputs:
  EnvironmentId:
    Description: The ID of the environment instance.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EnvironmentId
  EnvCustomJobName:
    Description: The name of the custom job.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EnvCustomJobName
  ConfigYaml:
    Description: The YAML configuration string of the custom job.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ConfigYaml

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "EnvironmentId": {
      "Type": "String",
      "Description": "The ID of the environment instance.",
      "Required": true
    },
    "EnvCustomJobName": {
      "Type": "String",
      "Description": "The name of the custom job.",
      "Required": true
    },
    "ConfigYaml": {
      "Type": "String",
      "Description": "The YAML configuration string of the custom job.",
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ARMS::EnvCustomJob",
      "Properties": {
        "EnvironmentId": {
          "Ref": "EnvironmentId"
        },
        "EnvCustomJobName": {
          "Ref": "EnvCustomJobName"
        },
        "ConfigYaml": {
          "Ref": "ConfigYaml"
        }
      }
    }
  },
  "Outputs": {
    "EnvironmentId": {
      "Description": "The ID of the environment instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EnvironmentId"
        ]
      }
    },
    "EnvCustomJobName": {
      "Description": "The name of the custom job.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EnvCustomJobName"
        ]
      }
    },
    "ConfigYaml": {
      "Description": "The YAML configuration string of the custom job.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ConfigYaml"
        ]
      }
    }
  }
}