DATASOURCE::VPC::PrefixList

Updated at: 2024-12-26 09:29

DATASOURCE::VPC::PrefixList is used to query the information about a prefix list.

Syntax

{
  "Type": "DATASOURCE::VPC::PrefixList",
  "Properties": {
    "PrefixListId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Property

Type

Required

Editable

Description

Constraint

PrefixListId

String

Yes

Yes

The ID of the prefix list that you want to query.

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

  • MaxEntries: the maximum number of CIDR blocks in the prefix list.

  • ResourceGroupId: the ID of the resource group to which the prefix list belongs.

  • OwnerId: the ID of the Alibaba Cloud account to which the prefix list belongs.

  • PrefixListDescription: the description of the prefix list.

  • IpVersion: the IP version of the prefix list.

  • PrefixListId: the ID of the prefix list.

  • PrefixListName: the name of the prefix list.

  • CreateTime: the time when the prefix list was created.

  • Entries: the CIDR blocks in the prefix list.  

  • Tags: the tags.

  • ShareType: the share type of the prefix list.

Examples

YAML
JSON
YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PrefixListId:
    Description:
      en: The ID of the query Prefix List.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      PrefixListId:
        Ref: PrefixListId
    Type: DATASOURCE::VPC::PrefixList
Outputs:
  CreateTime:
    Description: The time when the prefix list was created.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  Entries:
    Description: The CIDR address block list of the prefix list.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Entries
  IpVersion:
    Description: The IP version of the prefix list.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - IpVersion
  MaxEntries:
    Description: The maximum number of entries for CIDR address blocks in the prefix
      list.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaxEntries
  OwnerId:
    Description: The Alibaba Cloud account (primary account) to which the prefix list
      belongs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - OwnerId
  PrefixListDescription:
    Description: The description of the prefix list.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PrefixListDescription
  PrefixListId:
    Description: The ID of the query Prefix List.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PrefixListId
  PrefixListName:
    Description: The name of the prefix list.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PrefixListName
  ResourceGroupId:
    Description: The ID of the resource group to which the VPC belongs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ResourceGroupId
  ShareType:
    Description: The share type of the prefix list.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ShareType
  Tags:
    Description: The tags of PrefixList.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Tags
                        
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PrefixListId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the query Prefix List."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::PrefixList",
      "Properties": {
        "PrefixListId": {
          "Ref": "PrefixListId"
        }
      }
    }
  },
  "Outputs": {
    "MaxEntries": {
      "Description": "The maximum number of entries for CIDR address blocks in the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaxEntries"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group to which the VPC belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "OwnerId": {
      "Description": "The Alibaba Cloud account (primary account) to which the prefix list belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "OwnerId"
        ]
      }
    },
    "PrefixListDescription": {
      "Description": "The description of the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrefixListDescription"
        ]
      }
    },
    "IpVersion": {
      "Description": "The IP version of the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IpVersion"
        ]
      }
    },
    "PrefixListId": {
      "Description": "The ID of the query Prefix List.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrefixListId"
        ]
      }
    },
    "PrefixListName": {
      "Description": "The name of the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrefixListName"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the prefix list was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "Entries": {
      "Description": "The CIDR address block list of the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Entries"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of PrefixList.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "ShareType": {
      "Description": "The share type of the prefix list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ShareType"
        ]
      }
    }
  }
}
                        
  • On this page (1, T)
  • Syntax
  • Properties
  • Return values
  • Examples
Feedback
phone Contact Us