Metadata
Important:
The first section of a policy template provides generic information about the policy such as its name, a short and long description as well as the policy severity and category:
name "AWS Reserved Instances Recommendations"
rs_pt_ver 20180301
type "policy"
short_description "A policy that sends email notifications when AWS RI Recommendations are identified. NOTE: These RI Purchase Recommendations are generated by AWS. See the [README](https://github.com/flexera-public/policy_templates/tree/master/cost/aws/reserved_instances/recommendations) and [docs.flexera.com/flexera/EN/Automation](https://docs.flexera.com/flexera/EN/Automation/AutomationGS.htm) to learn more."
long_description ""
severity "medium"
category "Cost"
default_frequency "daily"
info(
version: "2.19",
provider: "AWS",
service: "EC2",
policy_set: "Reserved Instances",
recommendation_type: "Rate Reduction",
hide_skip_approvals: "true"
)
The following tables describe the required and optional policy template metadata.
Metadata |
Description |
name |
Defines the policy template name. It must be unique in the project. |
rs_pt_ver |
Indicates the policy template language version. The value must be "20180301". |
type |
Must be "policy". |
short_description |
Provides a short description of what the policy does. |
Metadata |
Description |
||||||||||||||||||
default_frequency |
Sets the interval between policy evaluations if another value is not selected by the person applying the policy. It must be one of "15 minutes" (default), "hourly", "daily", "weekly" or "monthly". |
||||||||||||||||||
long_description |
Provides a long description of what the policy does. |
||||||||||||||||||
severity |
Indicates the policy severity, it must be one of "low" (default), "medium", "high" or "critical". |
||||||||||||||||||
category |
Is an arbitrary value used to group policies into categories, for example "Cost", "Compliance" or "Security". |
||||||||||||||||||
info |
Specifies an arbitrary list of metadata attached to the policy and should be an mapping of string to string. For the List of Flexera Policies, the standard is to use the following metadata fields:
|
||||||||||||||||||
tenancy |
Specifies whether this policy can be applied to more than one project at a time and how incidents are grouped together. It must be one of "multi", or "single". If a policy has a credential declaration in it, only single is supported and is the default if not specified. If a policy does not have such a declaration, then this defaults to multi. Generally speaking this should only be set manually in the case where the policy acts on organization-wide resources such as Cloud Cost Optimization APIs, in which case it should be set to single. Otherwise the default is sufficient and this can be omitted. |