ALIYUN::VPC::Ipam - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "ALIYUN::VPC::Ipam",
  "Properties": {
    "OperatingRegionList": List,
    "IpamName": String,
    "IpamDescription": String,
    "ResourceGroupId": String,
    "Tags": List
  }
}

Propriedades

Propriedade	Tipo	Obrigatória	Editável	Descrição	Restrição
OperatingRegionList	List	Sim	Sim	Regiões efetivas do IPAM.	Máximo: 100 regiões.
IpamName	String	Não	Sim	Nome do IPAM.	De 1 a 128 caracteres. Não pode começar com `http://` ou `https://`.
IpamDescription	String	Não	Sim	Descrição do IPAM.	De 1 a 256 caracteres. Deve começar com uma letra. Não pode começar com `http://` ou `https://`. Vazio por padrão.
ResourceGroupId	String	Não	Sim	ID do grupo de recursos.	Nenhuma.
Tags	List	Não	Sim	Tags do recurso.	Máximo: 20 tags. Para mais informações, consulte Propriedades de Tags.

Sintaxe de Tags

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Propriedades de Tags

Propriedade	Tipo	Obrigatória	Editável	Descrição	Restrição
Key	String	Sim	Não	Chave da tag.	Não pode estar vazia. Até 64 caracteres, incluindo dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra. Não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.
Value	String	Não	Não	Valor da tag.	Pode estar vazio. Até 128 caracteres. Não pode conter `http://` ou `https://`.

Valores de retorno

Fn::GetAtt

OperatingRegionList: regiões efetivas do IPAM.
DefaultResourceDiscoveryAssociationId: ID da associação entre o IPAM e a descoberta de recursos padrão.
DefaultResourceDiscoveryId: ID da descoberta de recursos padrão.
IpamName: nome do IPAM.
ResourceGroupId: ID do grupo de recursos.
IpamId: ID do IPAM.
CreateTime: horário de criação do IPAM.
IpamDescription: descrição do IPAM.
ResourceDiscoveryAssociationCount: quantidade de associações de descoberta de recursos.
PrivateDefaultScopeId: escopo privado padrão do IPAM.
PublicDefaultScopeId: escopo público padrão do IPAM.
Tags: tags do IPAM.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  OperatingRegionList:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: |-
            The effective region of IPAM.
            > Support to select one or more regions.
        Required: false
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: List of IPAM effective regions.
    Required: true
    MinLength: 1
    MaxLength: 100
    Default:
      - cn-hangzhou
      - cn-beijing
  ResourceGroupId:
    AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
    Type: String
    Description:
      en: The ID of the resource group.
    Required: false
  IpamName:
    Type: String
    Description:
      en: The name of the IPAM.
    Required: false
    Default: test_ipam
Resources:
  ExtensionResource:
    Type: ALIYUN::VPC::Ipam
    Properties:
      OperatingRegionList:
        Ref: OperatingRegionList
      ResourceGroupId:
        Ref: ResourceGroupId
      IpamName:
        Ref: IpamName
Outputs:
  OperatingRegionList:
    Description: List of IPAM effective regions.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - OperatingRegionList
  DefaultResourceDiscoveryAssociationId:
    Description: After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DefaultResourceDiscoveryAssociationId
  DefaultResourceDiscoveryId:
    Description: After IPAM is created, the system creates resource discovery by default.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DefaultResourceDiscoveryId
  IpamName:
    Description: The name of the IPAM.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamName
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceGroupId
  IpamId:
    Description: The first ID of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamId
  CreateTime:
    Description: The creation time of the IPAM.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  IpamDescription:
    Description: The description of IPAM.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamDescription
  ResourceDiscoveryAssociationCount:
    Description: The number of resource discovery objects associated with IPAM.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceDiscoveryAssociationCount
  PrivateDefaultScopeId:
    Description: After an IPAM is created, the scope of the private network IPAM created by the system by default.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PrivateDefaultScopeId
  PublicDefaultScopeId:
    Description: After an IPAM is created, the public network IPAM is created by default.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PublicDefaultScopeId
  Tags:
    Description: The tag of the IPAM.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "OperatingRegionList": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "The effective region of IPAM.\n> Support to select one or more regions."
          },
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "List of IPAM effective regions."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 100,
      "Default": [
        "cn-hangzhou",
        "cn-beijing"
      ]
    },
    "ResourceGroupId": {
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
      "Type": "String",
      "Description": {
        "en": "The ID of the resource group."
      },
      "Required": false
    },
    "IpamName": {
      "Type": "String",
      "Description": {
        "en": "The name of the IPAM."
      },
      "Required": false,
      "Default": "test_ipam"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::Ipam",
      "Properties": {
        "OperatingRegionList": {
          "Ref": "OperatingRegionList"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "IpamName": {
          "Ref": "IpamName"
        }
      }
    }
  },
  "Outputs": {
    "OperatingRegionList": {
      "Description": "List of IPAM effective regions.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "OperatingRegionList"
        ]
      }
    },
    "DefaultResourceDiscoveryAssociationId": {
      "Description": "After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DefaultResourceDiscoveryAssociationId"
        ]
      }
    },
    "DefaultResourceDiscoveryId": {
      "Description": "After IPAM is created, the system creates resource discovery by default.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DefaultResourceDiscoveryId"
        ]
      }
    },
    "IpamName": {
      "Description": "The name of the IPAM.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamName"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "IpamId": {
      "Description": "The first ID of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the IPAM.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "IpamDescription": {
      "Description": "The description of IPAM.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamDescription"
        ]
      }
    },
    "ResourceDiscoveryAssociationCount": {
      "Description": "The number of resource discovery objects associated with IPAM.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceDiscoveryAssociationCount"
        ]
      }
    },
    "PrivateDefaultScopeId": {
      "Description": "After an IPAM is created, the scope of the private network IPAM created by the system by default.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PrivateDefaultScopeId"
        ]
      }
    },
    "PublicDefaultScopeId": {
      "Description": "After an IPAM is created, the public network IPAM is created by default.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PublicDefaultScopeId"
        ]
      }
    },
    "Tags": {
      "Description": "The tag of the IPAM.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    }
  }
}