ALIYUN::ESA::CustomScenePolicy - Resource Orchestration Service

The ALIYUN::ESA::CustomScenePolicy resource type is used to create scenario-specific policies.

Syntax

{
  "Type": "ALIYUN::ESA::CustomScenePolicy",
  "Properties": {
    "CustomScenePolicyName": String,
    "CreateTime": String,
    "EndTime": String,
    "Objects": String,
    "Template": String
  }
}

Properties

Property	Type	Required	Update Allowed	Description	Constraints
CustomScenePolicyName	String	Yes	Yes	The policy name.	None
CreateTime	String	Yes	Yes	The start time of the policy.	The time must be in UTC and in the yyyy-MM-ddTHH:mm:ssZ format. This format follows the ISO 8601 standard.
EndTime	String	Yes	Yes	The end time of the policy.	The time must be in UTC and in the yyyy-MM-ddTHH:mm:ssZ format. This format follows the ISO 8601 standard.
Objects	String	Yes	Yes	The IDs of the websites to associate.	Separate multiple website IDs with commas (,). Note This field is scheduled for deprecation. Use the websiteIds field instead. If websiteIds is specified, Objects is ignored. To prevent ambiguity during updates, you must specify either websiteIds or Objects.
Template	String	Yes	Yes	The template name.	Valid value: promotion: Major events

Return values

Fn::GetAtt

CustomScenePolicyName: The name of the policy.
EndTime: The time when the policy expires.
CreateTime: The time when the policy was created.
Objects: The IDs of the associated websites.
PolicyId: The ID of the policy.
Template: The name of the template.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CustomScenePolicyName:
    Type: String
    Description:
      en: The policy name.
    Required: true
  EndTime:
    Type: String
    Description:
      en: |-
        The time when the policy expires.
        The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    Required: true
  CreateTime:
    Type: String
    Description:
      en: |-
        The time when the policy takes effect.
        The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    Required: true
  Objects:
    Type: String
    Description:
      en: The IDs of the websites that you want to associate with the policy. Separate multiple IDs with commas (,).
    Required: true
  Template:
    Type: String
    Description:
      en: |-
        The name of the policy template. Valid value:
        promotion: major events.
    AllowedValues:
      - promotion
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::CustomScenePolicy
    Properties:
      CustomScenePolicyName:
        Ref: CustomScenePolicyName
      EndTime:
        Ref: EndTime
      CreateTime:
        Ref: CreateTime
      Objects:
        Ref: Objects
      Template:
        Ref: Template
Outputs:
  CustomScenePolicyName:
    Description: The name of the policy.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CustomScenePolicyName
  EndTime:
    Description: The time when the policy expires.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EndTime
  CreateTime:
    Description: The time when the policy takes effect.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  Objects:
    Description: The IDs of websites associated.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Objects
  PolicyId:
    Description: The Id of the Policy.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PolicyId
  Template:
    Description: The name of the policy template.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Template

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CustomScenePolicyName": {
      "Type": "String",
      "Description": {
        "en": "The policy name."
      },
      "Required": true
    },
    "EndTime": {
      "Type": "String",
      "Description": {
        "en": "The time when the policy expires.\nThe time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC."
      },
      "Required": true
    },
    "CreateTime": {
      "Type": "String",
      "Description": {
        "en": "The time when the policy takes effect.\nThe time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC."
      },
      "Required": true
    },
    "Objects": {
      "Type": "String",
      "Description": {
        "en": "The IDs of the websites that you want to associate with the policy. Separate multiple IDs with commas (,)."
      },
      "Required": true
    },
    "Template": {
      "Type": "String",
      "Description": {
        "en": "The name of the policy template. Valid value:\npromotion: major events."
      },
      "AllowedValues": [
        "promotion"
      ],
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::CustomScenePolicy",
      "Properties": {
        "CustomScenePolicyName": {
          "Ref": "CustomScenePolicyName"
        },
        "EndTime": {
          "Ref": "EndTime"
        },
        "CreateTime": {
          "Ref": "CreateTime"
        },
        "Objects": {
          "Ref": "Objects"
        },
        "Template": {
          "Ref": "Template"
        }
      }
    }
  },
  "Outputs": {
    "CustomScenePolicyName": {
      "Description": "The name of the policy.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CustomScenePolicyName"
        ]
      }
    },
    "EndTime": {
      "Description": "The time when the policy expires.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EndTime"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the policy takes effect.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "Objects": {
      "Description": "The IDs of websites associated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Objects"
        ]
      }
    },
    "PolicyId": {
      "Description": "The Id of the Policy.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PolicyId"
        ]
      }
    },
    "Template": {
      "Description": "The name of the policy template.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Template"
        ]
      }
    }
  }
}