Use DATASOURCE::VPC::PrefixLists to query prefix lists - Resource Orchestration Service

DATASOURCE::VPC::PrefixLists is used to query prefix lists.

Syntax

{
  "Type": "DATASOURCE::VPC::PrefixLists",
  "Properties": {
    "PrefixListName": String,
    "ResourceGroupId": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
PrefixListName	String	No	Yes	The name of the prefix list.	The name must be 1 to 128 characters in length. It cannot start with `http://` or `https://`.
ResourceGroupId	String	No	Yes	The ID of the resource group to which the virtual private cloud (VPC) belongs.	None.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

PrefixListIds: the IDs of the prefix lists.
PrefixLists: details of the prefix lists.

Property	Type	Description	Constraint
PrefixListIds	List	The IDs of the prefix lists.	None.
PrefixLists	List	Details of the prefix lists.	None.
MaxEntries	Number	The maximum number of CIDR blocks that are specified in the prefix list.	None.
Status	String	The state of the prefix list.	Valid values: Created: The prefix list is created. Deleted: The prefix list is deleted. Modifying: The prefix list is being modified.
ShareType	String	Indicates whether the prefix list is shared.	Valid values: Shared: The prefix list is shared. Null: The prefix list is not shared.
PrefixListName	String	The name of the prefix list.	None.
IpVersion	String	The IP version of the prefix list.	Valid values: IPv4 IPv6
ResourceGroupId	String	The ID of the resource group.	None.
Entries	List	The CIDR blocks that are specified in the prefix list.	Example: `[ "100.115.XX.XX/24" ]`
OwnerId	String	The Alibaba Cloud account to which the prefix list belongs.	None.
PrefixListId	String	The ID of the prefix list.	None.
CreateTime	String	The time when the prefix list was created.	None.
PrefixListDescription	String	The description of the prefix list.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
Resources:
  ExtensionDataSource:
    Properties:
      PrefixListName: Test
    Type: DATASOURCE::VPC::PrefixLists
Outputs:
  PrefixListIds:
    Description: The list of prefix list IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PrefixListIds
  PrefixLists:
    Description: The list of prefix lists.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PrefixLists

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::PrefixLists",
      "Properties": {
        "PrefixListName": "Test"
      }
    }
  },
  "Outputs": {
    "PrefixListIds": {
      "Description": "The list of prefix list IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrefixListIds"
        ]
      }
    },
    "PrefixLists": {
      "Description": "The list of prefix lists.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrefixLists"
        ]
      }
    }
  }
}