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

Syntax

{
  "Type": "ALIYUN::ESA::OriginProtection",
  "Properties": {
    "SiteId": Integer,
    "OriginConverge": String
  }
}

Properties

Parameter

Type

Required

Update allowed

Description

Constraints

SiteId

Integer

Yes

No

The ID of the site.

None

OriginConverge

String

No

Yes

The IP convergence status.

Valid values:

on
off

Return values

Fn::GetAtt

OriginProtection: Indicates whether origin protection is enabled.
OriginConverge: The IP convergence status.
SiteId: The ID of the site.
LatestIpWhitelist: The latest IP whitelist for origin protection.
DiffIpWhitelist: The updated IP whitelist for origin protection.
CurrentIpWhitelist: The IP whitelist for origin protection used by the site.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  OriginConverge:
    Type: String
    Description:
      en: |-
        The IP convergence status.
        Valid values:
        *   on
        *   off
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  SiteId:
    Type: Number
    Description:
      en: The site ID.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::OriginProtection
    Properties:
      OriginConverge:
        Ref: OriginConverge
      SiteId:
        Ref: SiteId
Outputs:
  OriginProtection:
    Description: Indicates whether origin protection is enabled.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - OriginProtection
  OriginConverge:
    Description: The IP convergence status.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - OriginConverge
  SiteId:
    Description: The site ID.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteId
  LatestIpWhitelist:
    Description: The latest IP whitelist for origin protection.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - LatestIpWhitelist
  DiffIpWhitelist:
    Description: The updated IP whitelist for origin protection.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DiffIpWhitelist
  CurrentIpWhitelist:
    Description: The IP whitelist for origin protection used by the site.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CurrentIpWhitelist

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "OriginConverge": {
      "Type": "String",
      "Description": {
        "en": "The IP convergence status.\nValid values:\n*   on\n*   off"
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::OriginProtection",
      "Properties": {
        "OriginConverge": {
          "Ref": "OriginConverge"
        },
        "SiteId": {
          "Ref": "SiteId"
        }
      }
    }
  },
  "Outputs": {
    "OriginProtection": {
      "Description": "Indicates whether origin protection is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "OriginProtection"
        ]
      }
    },
    "OriginConverge": {
      "Description": "The IP convergence status.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "OriginConverge"
        ]
      }
    },
    "SiteId": {
      "Description": "The site ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteId"
        ]
      }
    },
    "LatestIpWhitelist": {
      "Description": "The latest IP whitelist for origin protection.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "LatestIpWhitelist"
        ]
      }
    },
    "DiffIpWhitelist": {
      "Description": "The updated IP whitelist for origin protection.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DiffIpWhitelist"
        ]
      }
    },
    "CurrentIpWhitelist": {
      "Description": "The IP whitelist for origin protection used by the site.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CurrentIpWhitelist"
        ]
      }
    }
  }
}