All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::KMS::NetworkRule

Last Updated:Jan 03, 2025

ALIYUN::KMS::NetworkRule is used to create a network access rule.

Syntax

{
  "Type": "ALIYUN::KMS::NetworkRule",
  "Properties": {
    "NetworkRuleName": String,
    "Description": String,
    "SourcePrivateIp": List
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

NetworkRuleName

String

Yes

No

The name of the network access rule.

None.

Description

String

No

Yes

The description.

None.

SourcePrivateIp

List

No

Yes

The private IP addresses or private CIDR blocks.

You can specify up to 800 private IP addresses or private CIDR blocks.

Return values

Fn::GetAtt

  • Description: the description.

  • SourcePrivateIp: the private IP addresses or private CIDR blocks.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SourcePrivateIp:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: CIDR format IP.
        Required: false
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: VPC network whitelist, The private IP address or private CIDR block, Supports binding up to 800 CIDR blocks or IP addresses.
    Required: false
    MinLength: 1
    MaxLength: 800
  NetworkRuleName:
    Type: String
    Description:
      en: The name of the access control rule.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::KMS::NetworkRule
    Properties:
      SourcePrivateIp:
        Ref: SourcePrivateIp
      NetworkRuleName:
        Ref: NetworkRuleName
Outputs:
  Description:
    Description: Description.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
  SourcePrivateIp:
    Description: VPC network whitelist.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SourcePrivateIp
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SourcePrivateIp": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "CIDR format IP."
          },
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "VPC network whitelist, The private IP address or private CIDR block, Supports binding up to 800 CIDR blocks or IP addresses."
      },
      "Required": false,
      "MinLength": 1,
      "MaxLength": 800
    },
    "NetworkRuleName": {
      "Type": "String",
      "Description": {
        "en": "The name of the access control rule."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::KMS::NetworkRule",
      "Properties": {
        "SourcePrivateIp": {
          "Ref": "SourcePrivateIp"
        },
        "NetworkRuleName": {
          "Ref": "NetworkRuleName"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "Description.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "SourcePrivateIp": {
      "Description": "VPC network whitelist.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SourcePrivateIp"
        ]
      }
    }
  }
}