ALIYUN::CloudStorageGateway::Gateway-Resource Orchestration Service(ROS)-阿里云帮助中心

Syntax

{
  "Type": "ALIYUN::CloudStorageGateway::Gateway",
  "Properties": {
    "Category": String,
    "Location": String,
    "Name": String,
    "Type": String,
    "Description": String,
    "GatewayClass": String,
    "PublicNetworkBandwidth": Integer,
    "PostPaid": Boolean,
    "ResourceRegionId": String,
    "ReleaseAfterExpiration": Boolean,
    "StorageBundleId": String,
    "SecondaryVSwitchId": String,
    "UntrustedEnvId": String,
    "UntrustedEnvInstanceType": String,
    "VSwitchId": String
  }
}

Properties

Parameter	Type	Required	Update allowed	Description	Constraints
Category	String	Yes	No	The category of the gateway.	None
Location	String	Yes	No	The deployment location of the gateway.	Allowed values: cloud on-premises
Name	String	Yes	No	The name of the gateway.	None
Type	String	Yes	No	The type of the gateway.	Allowed values: File Iscsi
Description	String	No	No	The description of the gateway.	Length: 0 to 255 characters.
GatewayClass	String	No	No	The class of the gateway.	None
PostPaid	Boolean	No	No	Specifies whether the gateway is a pay-as-you-go instance.	None
PublicNetworkBandwidth	Integer	No	No	The public network bandwidth of the gateway.	Range: 5 to 200.
ReleaseAfterExpiration	Boolean	No	No	Specifies whether to automatically release the gateway after it expires.	None
ResourceRegionId	String	No	No	The ID of the region where the resource is located.	None
SecondaryVSwitchId	String	No	No	The ID of the secondary vSwitch.	None
StorageBundleId	String	No	No	The ID of the storage bundle.	None
UntrustedEnvId	String	No	No	The ID of the untrusted environment.	None
UntrustedEnvInstanceType	String	No	No	The instance type of the untrusted environment.	None
VSwitchId	String	No	No	The ID of the vSwitch.	None

Return values

Fn::GetAtt

GatewayId: The ID of the gateway.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Category:
    Type: String
    Description:
      en: The category of the gateway.
    Required: true
  Name:
    Type: String
    Description:
      en: The name of the gateway.
    Required: true
  Type:
    Type: String
    Description:
      en: The type of the gateway.
    AllowedValues:
      - File
      - Iscsi
    Required: true
  Location:
    Type: String
    Description:
      en: The location where the gateway is deployed.
    AllowedValues:
      - cloud
      - on-premises
    Required: true
Resources:
  Gateway:
    Type: ALIYUN::CloudStorageGateway::Gateway
    Properties:
      Category:
        Ref: Category
      Name:
        Ref: Name
      Type:
        Ref: Type
      Location:
        Ref: Location
Outputs:
  GatewayId:
    Description:
      en: The ID of the gateway.
    Value:
      Fn::GetAtt:
        - Gateway
        - GatewayId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Category": {
      "Type": "String",
      "Description": {
        "en": "The category of the gateway."
      },
      "Required": true
    },
    "Name": {
      "Type": "String",
      "Description": {
        "en": "The name of the gateway."
      },
      "Required": true
    },
    "Type": {
      "Type": "String",
      "Description": {
        "en": "The type of the gateway."
      },
      "AllowedValues": [
        "File",
        "Iscsi"
      ],
      "Required": true
    },
    "Location": {
      "Type": "String",
      "Description": {
        "en": "The location where the gateway is deployed."
      },
      "AllowedValues": [
        "cloud",
        "on-premises"
      ],
      "Required": true
    }
  },
  "Resources": {
    "Gateway": {
      "Type": "ALIYUN::CloudStorageGateway::Gateway",
      "Properties": {
        "Category": {
          "Ref": "Category"
        },
        "Name": {
          "Ref": "Name"
        },
        "Type": {
          "Ref": "Type"
        },
        "Location": {
          "Ref": "Location"
        }
      }
    }
  },
  "Outputs": {
    "GatewayId": {
      "Description": {
        "en": "The ID of the gateway."
      },
      "Value": {
        "Fn::GetAtt": [
          "Gateway",
          "GatewayId"
        ]
      }
    }
  }
}