The ALIYUN::VPC::IpamResourceDiscovery type creates a resource discovery instance.
Syntax
{
"Type": "ALIYUN::VPC::IpamResourceDiscovery",
"Properties": {
"OperatingRegionList": List,
"IpamResourceDiscoveryDescription": String,
"IpamResourceDiscoveryName": String,
"ResourceGroupId": String,
"Tags": List
}
}Properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
OperatingRegionList |
List |
Yes |
Yes |
The regions where resource discovery is active. |
Number of items: 1 to 100. |
|
IpamResourceDiscoveryDescription |
String |
No |
Yes |
A description of the resource discovery. |
None |
|
IpamResourceDiscoveryName |
String |
No |
Yes |
A name for the resource discovery. |
None |
|
ResourceGroupId |
String |
No |
Yes |
The resource group ID. |
None |
|
Tags |
List |
No |
Yes |
The tags to assign to the resource discovery. |
Maximum number of items: 20. For more information, see Tags property. |
Tags syntax
"Tags": [
{
"Value": String,
"Key": String
}
]Tags property
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
Key |
String |
Yes |
No |
The key of the tag. |
None |
|
Value |
String |
No |
No |
The value of the tag. |
None |
Return values
Fn::GetAtt
-
OperatingRegionList: The regions where resource discovery is active.
-
Type: The type of the resource discovery.
-
ResourceGroupId: The resource group ID.
-
CreateTime: The creation time of the resource discovery.
-
Tags: The tags assigned to the discovery instance.
-
IpamResourceDiscoveryDescription: The description of the resource discovery.
-
IpamResourceDiscoveryId: The resource discovery instance ID.
-
IpamResourceDiscoveryName: The name of the resource discovery.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
IpamResourceDiscoveryName:
Type: String
Description:
en: A name for the resource discovery.
Default: Null
Required: false
Tags:
Description:
en: The tags to assign to the resource discovery.
Required: false
Default: Null
Type: Json
MaxLength: 20
AssociationProperty: List[Parameters]
AssociationPropertyMetadata:
Parameters:
Key:
Type: String
Required: true
Value:
Type: String
Default: Null
Required: false
ListMetadata:
Order:
- Key
- Value
IpamResourceDiscoveryDescription:
Type: String
Description:
en: A description of the resource discovery.
Default: Null
Required: false
OperatingRegionList:
Description:
en: The regions where resource discovery is active.
Required: true
Type: Json
MinLength: 1
MaxLength: 100
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Type: String
Description:
en: A region where resource discovery is active.
Default: Null
Required: false
ResourceGroupId:
Type: String
Description:
en: The resource group ID.
AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
Default: Null
Required: false
Resources:
ExtensionResource:
Type: ALIYUN::VPC::IpamResourceDiscovery
Properties:
IpamResourceDiscoveryName:
Ref: IpamResourceDiscoveryName
Tags:
Ref: Tags
IpamResourceDiscoveryDescription:
Ref: IpamResourceDiscoveryDescription
OperatingRegionList:
Ref: OperatingRegionList
ResourceGroupId:
Ref: ResourceGroupId
Outputs:
IpamResourceDiscoveryId:
Value:
Fn::GetAtt:
- ExtensionResource
- IpamResourceDiscoveryId
Description: The resource discovery instance ID.
Tags:
Value:
Fn::GetAtt:
- ExtensionResource
- Tags
Description: The tags assigned to the discovery instance.
OperatingRegionList:
Value:
Fn::GetAtt:
- ExtensionResource
- OperatingRegionList
Description: The regions where resource discovery is active.
ResourceGroupId:
Value:
Fn::GetAtt:
- ExtensionResource
- ResourceGroupId
Description: The resource group ID.
IpamResourceDiscoveryName:
Value:
Fn::GetAtt:
- ExtensionResource
- IpamResourceDiscoveryName
Description: The name of the resource discovery.
Type:
Value:
Fn::GetAtt:
- ExtensionResource
- Type
Description: The type of the resource discovery.
CreateTime:
Value:
Fn::GetAtt:
- ExtensionResource
- CreateTime
Description: The creation time of the resource discovery.
IpamResourceDiscoveryDescription:
Value:
Fn::GetAtt:
- ExtensionResource
- IpamResourceDiscoveryDescription
Description: The description of the resource discovery.
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"IpamResourceDiscoveryName": {
"Type": "String",
"Description": {
"en": "A name for the resource discovery."
},
"Default": null,
"Required": false
},
"Tags": {
"Description": {
"en": "The tags to assign to the resource discovery."
},
"Required": false,
"Default": null,
"Type": "Json",
"MaxLength": 20,
"AssociationProperty": "List[Parameters]",
"AssociationPropertyMetadata": {
"Parameters": {
"Key": {
"Type": "String",
"Required": true
},
"Value": {
"Type": "String",
"Default": null,
"Required": false
}
},
"ListMetadata": {
"Order": [
"Key",
"Value"
]
}
}
},
"IpamResourceDiscoveryDescription": {
"Type": "String",
"Description": {
"en": "A description of the resource discovery."
},
"Default": null,
"Required": false
},
"OperatingRegionList": {
"Description": {
"en": "The regions where resource discovery is active."
},
"Required": true,
"Type": "Json",
"MinLength": 1,
"MaxLength": 100,
"AssociationProperty": "List[Parameter]",
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "A region where resource discovery is active."
},
"Default": null,
"Required": false
}
}
},
"ResourceGroupId": {
"Type": "String",
"Description": {
"en": "The resource group ID."
},
"AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
"Default": null,
"Required": false
}
},
"Resources": {
"ExtensionResource": {
"Type": "ALIYUN::VPC::IpamResourceDiscovery",
"Properties": {
"IpamResourceDiscoveryName": {
"Ref": "IpamResourceDiscoveryName"
},
"Tags": {
"Ref": "Tags"
},
"IpamResourceDiscoveryDescription": {
"Ref": "IpamResourceDiscoveryDescription"
},
"OperatingRegionList": {
"Ref": "OperatingRegionList"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
}
}
}
},
"Outputs": {
"IpamResourceDiscoveryId": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"IpamResourceDiscoveryId"
]
},
"Description": "The resource discovery instance ID."
},
"Tags": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Tags"
]
},
"Description": "The tags assigned to the discovery instance."
},
"OperatingRegionList": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"OperatingRegionList"
]
},
"Description": "The regions where resource discovery is active."
},
"ResourceGroupId": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"ResourceGroupId"
]
},
"Description": "The resource group ID."
},
"IpamResourceDiscoveryName": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"IpamResourceDiscoveryName"
]
},
"Description": "The name of the resource discovery."
},
"Type": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Type"
]
},
"Description": "The type of the resource discovery."
},
"CreateTime": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"CreateTime"
]
},
"Description": "The creation time of the resource discovery."
},
"IpamResourceDiscoveryDescription": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"IpamResourceDiscoveryDescription"
]
},
"Description": "The description of the resource discovery."
}
}
}