ALIYUN::BastionHost::Instance_资源编排(ROS)-阿里云帮助中心

ALIYUN::BastionHost::Instance类型用于创建堡垒机实例。

语法

{
  "Type": "ALIYUN::BastionHost::Instance",
  "Properties": {
    "ExtraBandwidth": Integer,
    "ResourceGroupId": String,
    "Version": String,
    "ExtendedStoragePlans": Integer,
    "AutoRenew": Boolean,
    "Period": Integer,
    "AutoPay": Boolean,
    "Plan": Integer,
    "StartInstanceParam": Map,
    "PeriodUnit": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
ExtraBandwidth	Integer	是	是	带宽扩展包。	堡垒机会配置默认带宽，如果默认配置无法满足运维需求，您可以通过带宽扩展包进行扩展。取值范围为0~200Mbps。
ResourceGroupId	String	否	否	堡垒机所在资源组。	无
Version	String	是	否	垒机实例的版本。	取值： Enterprise：提供堡垒机双引擎运行模式，提供数据库运维管控、Linux密码自动轮转、Web方式运维、网络域代理混合统一运维等更多运维场景能力，具有更高的可靠性和稳定性。正常业务时，双引擎同时运行提高运维效率；单点故障时，双引擎自动切换，保障业务正常运行。企业双擎版支持更高规格的业务性能，可支持1,000及以上规格资产的高效、稳定运维。 Basic：基础版为单引擎运行模式，可满足您基础的运维和审计需求。
ExtendedStoragePlans	Integer	是	是	选择需购买的带宽扩展包。	您购买的售卖规格默认会配置相应的公网带宽，如果默认配置的带宽无法满足您的需求，您需要在购买堡垒机实例时选择相应的带宽扩展包。取值范围为0~500TB。
AutoRenew	Boolean	否	否	到期是否自动续费。	自动更新周期为每月。启用自动续订后，系统会在资源到期前9天扣除续订费用。如果支付失败，系统不会停止扣除费用，直到扣除成功或资源过期前一天。
Period	Integer	否	否	实例的订阅周期。	当PeriodUnit为Month时：取值为：[1, 3, 6]。当PeriodUnit为Year时：取值为：[1, 2, 3]。
AutoPay	Boolean	否	否	是否自动付款。	取值： true：自动付款。 false：手动付款。
Plan	Integer	是	是	资产数。	取值范围：[50, 100, 200, 500, 1000, 2000, 5000, 10000]。
StartInstanceParam	Map	是	否	启动主机实例所需的参数。	更多信息，请参见StartInstanceParam属性。
PeriodUnit	String	否	否	订阅持续时间的单位。	取值： Month：月。 Year：年。

StartInstanceParam语法

"StartInstanceParam": {
  "VswitchId": String,
  "SecurityGroupIds": List
}

StartInstanceParam属性

属性名称	类型	必须	允许更新	描述	约束
VswitchId	String	是	否	交换机ID。	无
SecurityGroupIds	List	是	否	安全组ID列表。	最多支持20个。

返回值

Fn::GetAtt

InstanceId：堡垒机实例ID。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AutoPay:
    Default: false
    Description:
      en: Whether to auto pay the bill.
    Required: false
    Type: Boolean
  AutoRenew:
    Description:
      en: Whether to auto renew the prepay instance. The auto-renewal period is Monthly.After
        you enable auto-renewal, the system deducts the renewal fee nine days before
        the resource expires.If the payment fails, the system does not stop deducting
        the fee until the deduction is successful or one day before the resource expires.
    Required: false
    Type: Boolean
  ExtendedStoragePlans:
    Description:
      en: 'If the default storage capacity is insufficient, you can purchase extended
        storage plans.Unit: TB'
    MaxValue: 500
    MinValue: 0
    Required: true
    Type: Number
  ExtraBandwidth:
    Description:
      en: 'Additional bandwidth is added to the default settings to ensure efficient
        O&M.Unit: Mbps'
    MaxValue: 200
    MinValue: 0
    Required: true
    Type: Number
  Period:
    AllowedValues:
    - 1
    - 2
    - 3
    - 6
    AssociationProperty: PayPeriod
    Description:
      en: 'The subscription period of the bastionhost instanceIf PeriodUnit is month,
        the valid range is 1, 3, 6

        If periodUnit is year, the valid range is 1, 2, 3'
    Required: false
    Type: Number
  PeriodUnit:
    AllowedValues:
    - Month
    - Year
    AssociationProperty: PayPeriodUnit
    Description:
      en: 'The unit of the subscription duration. Valid values:

        Month

        Year

        Default value: Month.'
    Required: false
    Type: String
  Plan:
    AllowedValues:
    - 50
    - 100
    - 200
    - 500
    - 1000
    - 2000
    - 5000
    - 10000
    Description:
      en: 'The number of asset authorization and concurrency limit.Unit: Asset number'
    Required: true
    Type: Number
  ResourceGroupId:
    AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
    Description:
      en: Resource group ID.
    Required: false
    Type: String
  StartInstanceParam:
    AssociationPropertyMetadata:
      Parameters:
        SecurityGroupIds:
          AssociationProperty: List[Parameter]
          AssociationPropertyMetadata:
            Parameter:
              AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
              AssociationPropertyMetadata:
                VpcId: ${VpcId}
              Description:
                en: Security group id.
              Required: false
              Type: String
          Description:
            en: List of security group IDs bound to the bastion host instance
          MaxLength: 20
          MinLength: 1
          Required: true
          Type: Json
        VswitchId:
          Description:
            en: The VSwitch ID bound to the bastion host instance.
          Required: true
          Type: String
    Description:
      en: Parameters required to start a bastion host instance.
    Required: true
    Type: Json
  Version:
    AllowedValues:
    - Enterprise
    - Basic
    Description:
      en: 'Enterprise version:- Deployment instructions: dual-engine architecture,
        supports multiple availability zones, and ensures high stability

        - Operation and maintenance scenarios: unified operation and maintenance of
        assets on Alibaba Cloud, offline IDC servers, and third-party clouds

        - Asset type: Linux/Windows, database assets

        - User management: RAM, AD/LDAP and local users

        - Control strategy: fine-grained strategic control such as operation and maintenance
        approval, high-risk command blocking, etc.

        - Operation and maintenance audit: full traceability of operation and maintenance
        log audit and video audit

        Value-added capabilities: automatic password change of Linux assets, database
        operation and maintenance management and control, convenient operation and
        maintenance of Web and client, network domain agent hybrid cloud scenario
        operation and maintenance mode, etc.Basic version:- Deployment instructions:
        The basic version is deployed on a single machine and does not support multiple
        availability zones.

        - Operation and maintenance scenarios: unified operation and maintenance of
        assets on Alibaba Cloud, offline IDC servers, and third-party clouds

        - Asset type: Linux/Windows assets

        - User management: RAM, AD/LDAP and local users

        - Control strategy: Operation and maintenance approval, high-risk command
        blocking and other strategic management and control

        - Operation and maintenance audit: full traceability of operation and maintenance
        log audit and video audit'
    Required: true
    Type: String
Resources:
  Instance:
    Properties:
      AutoPay:
        Ref: AutoPay
      AutoRenew:
        Ref: AutoRenew
      ExtendedStoragePlans:
        Ref: ExtendedStoragePlans
      ExtraBandwidth:
        Ref: ExtraBandwidth
      Period:
        Ref: Period
      PeriodUnit:
        Ref: PeriodUnit
      Plan:
        Ref: Plan
      ResourceGroupId:
        Ref: ResourceGroupId
      StartInstanceParam:
        Ref: StartInstanceParam
      Version:
        Ref: Version
    Type: ALIYUN::BastionHost::Instance
Outputs:
  InstanceId:
    Description: Instance Id.
    Value:
      Fn::GetAtt:
      - Instance
      - InstanceId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ExtraBandwidth": {
      "Type": "Number",
      "Description": {
        "en": "Additional bandwidth is added to the default settings to ensure efficient O&M.Unit: Mbps"
      },
      "Required": true,
      "MinValue": 0,
      "MaxValue": 200
    },
    "ResourceGroupId": {
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
      "Type": "String",
      "Description": {
        "en": "Resource group ID."
      },
      "Required": false
    },
    "Version": {
      "Type": "String",
      "Description": {
        "en": "Enterprise version:- Deployment instructions: dual-engine architecture, supports multiple availability zones, and ensures high stability\n- Operation and maintenance scenarios: unified operation and maintenance of assets on Alibaba Cloud, offline IDC servers, and third-party clouds\n- Asset type: Linux/Windows, database assets\n- User management: RAM, AD/LDAP and local users\n- Control strategy: fine-grained strategic control such as operation and maintenance approval, high-risk command blocking, etc.\n- Operation and maintenance audit: full traceability of operation and maintenance log audit and video audit\nValue-added capabilities: automatic password change of Linux assets, database operation and maintenance management and control, convenient operation and maintenance of Web and client, network domain agent hybrid cloud scenario operation and maintenance mode, etc.Basic version:- Deployment instructions: The basic version is deployed on a single machine and does not support multiple availability zones.\n- Operation and maintenance scenarios: unified operation and maintenance of assets on Alibaba Cloud, offline IDC servers, and third-party clouds\n- Asset type: Linux/Windows assets\n- User management: RAM, AD/LDAP and local users\n- Control strategy: Operation and maintenance approval, high-risk command blocking and other strategic management and control\n- Operation and maintenance audit: full traceability of operation and maintenance log audit and video audit"
      },
      "AllowedValues": [
        "Enterprise",
        "Basic"
      ],
      "Required": true
    },
    "ExtendedStoragePlans": {
      "Type": "Number",
      "Description": {
        "en": "If the default storage capacity is insufficient, you can purchase extended storage plans.Unit: TB"
      },
      "Required": true,
      "MinValue": 0,
      "MaxValue": 500
    },
    "AutoRenew": {
      "Type": "Boolean",
      "Description": {
        "en": "Whether to auto renew the prepay instance. The auto-renewal period is Monthly.After you enable auto-renewal, the system deducts the renewal fee nine days before the resource expires.If the payment fails, the system does not stop deducting the fee until the deduction is successful or one day before the resource expires."
      },
      "Required": false
    },
    "Period": {
      "AssociationProperty": "PayPeriod",
      "Type": "Number",
      "Description": {
        "en": "The subscription period of the bastionhost instanceIf PeriodUnit is month, the valid range is 1, 3, 6\nIf periodUnit is year, the valid range is 1, 2, 3"
      },
      "AllowedValues": [
        1,
        2,
        3,
        6
      ],
      "Required": false
    },
    "AutoPay": {
      "Type": "Boolean",
      "Description": {
        "en": "Whether to auto pay the bill."
      },
      "Required": false,
      "Default": false
    },
    "Plan": {
      "Type": "Number",
      "Description": {
        "en": "The number of asset authorization and concurrency limit.Unit: Asset number"
      },
      "AllowedValues": [
        50,
        100,
        200,
        500,
        1000,
        2000,
        5000,
        10000
      ],
      "Required": true
    },
    "StartInstanceParam": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "VswitchId": {
            "Type": "String",
            "Description": {
              "en": "The VSwitch ID bound to the bastion host instance."
            },
            "Required": true
          },
          "SecurityGroupIds": {
            "AssociationPropertyMetadata": {
              "Parameter": {
                "AssociationPropertyMetadata": {
                  "VpcId": "${VpcId}"
                },
                "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
                "Type": "String",
                "Description": {
                  "en": "Security group id."
                },
                "Required": false
              }
            },
            "AssociationProperty": "List[Parameter]",
            "Type": "Json",
            "Description": {
              "en": "List of security group IDs bound to the bastion host instance"
            },
            "Required": true,
            "MinLength": 1,
            "MaxLength": 20
          }
        }
      },
      "Type": "Json",
      "Description": {
        "en": "Parameters required to start a bastion host instance."
      },
      "Required": true
    },
    "PeriodUnit": {
      "AssociationProperty": "PayPeriodUnit",
      "Type": "String",
      "Description": {
        "en": "The unit of the subscription duration. Valid values:\nMonth\nYear\nDefault value: Month."
      },
      "AllowedValues": [
        "Month",
        "Year"
      ],
      "Required": false
    }
  },
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::BastionHost::Instance",
      "Properties": {
        "ExtraBandwidth": {
          "Ref": "ExtraBandwidth"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "Version": {
          "Ref": "Version"
        },
        "ExtendedStoragePlans": {
          "Ref": "ExtendedStoragePlans"
        },
        "AutoRenew": {
          "Ref": "AutoRenew"
        },
        "Period": {
          "Ref": "Period"
        },
        "AutoPay": {
          "Ref": "AutoPay"
        },
        "Plan": {
          "Ref": "Plan"
        },
        "StartInstanceParam": {
          "Ref": "StartInstanceParam"
        },
        "PeriodUnit": {
          "Ref": "PeriodUnit"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "Instance Id.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    }
  }
}