The ALIYUN::PAI::ResourceGroup resource creates a resource group.
Syntax
{
"Type": "ALIYUN::PAI::ResourceGroup",
"Properties": {
"ComputingResourceProvider": String,
"Description": String,
"Name": String,
"ResourceGroupId": String,
"ResourceType": String,
"Tag": List,
"UserVpc": Map,
"Version": String
}
}Properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
ComputingResourceProvider |
String |
No |
No |
The computing resource provider of the resource group. |
None |
|
Description |
String |
No |
No |
The description of the resource group. |
None |
|
Name |
String |
No |
No |
The name of the resource group. |
None |
|
ResourceGroupId |
String |
No |
No |
The ID of the resource group. |
None |
|
ResourceType |
String |
No |
No |
The resource group type. |
None |
|
Tag |
List |
No |
No |
The tags of the resource group. |
For more information, see Tag properties. |
|
UserVpc |
Map |
No |
No |
The VPC configuration for the resource group. |
For more information, see UserVpc properties. |
|
Version |
String |
No |
No |
The resource group version. |
None |
Tag syntax
"Tag": [
{
"Value": String,
"Key": String
}
]Tag properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
Key |
String |
Yes |
No |
The tag key. |
None |
|
Value |
String |
Yes |
No |
The tag value. |
None |
UserVpc syntax
"UserVpc": {
"VpcId": String,
"SecurityGroupId": String,
"DefaultRoute": String,
"SwitchId": String,
"DefaultForwardInfo": Map,
"ExtendedCIDRs": List,
"RoleArn": String
}UserVpc properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
SecurityGroupId |
String |
Yes |
No |
The ID of the security group that controls network access for the resource group. |
None |
|
SwitchId |
String |
Yes |
No |
The ID of the vSwitch in the VPC. |
None |
|
VpcId |
String |
Yes |
No |
The ID of the Virtual Private Cloud (VPC) associated with the resource group. |
None |
|
DefaultForwardInfo |
Map |
No |
No |
Settings for default traffic forwarding, including the NAT Gateway and Elastic IP Address (EIP). |
For more information, see DefaultForwardInfo properties. |
|
DefaultRoute |
String |
No |
No |
The default route for network traffic. |
None |
|
ExtendedCIDRs |
List |
No |
No |
A list of additional CIDR blocks to extend the network address range. |
None |
|
RoleArn |
String |
No |
No |
The Alibaba Cloud Resource Name (ARN) of the RAM role that authorizes access to other cloud services. |
None |
DefaultForwardInfo syntax
"DefaultForwardInfo": {
"EipAllocationId": String,
"NatGatewayId": String
}DefaultForwardInfo properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
EipAllocationId |
String |
No |
No |
The allocation ID of the associated Elastic IP Address (EIP). |
None |
|
NatGatewayId |
String |
No |
No |
The unique identifier of the NAT Gateway. |
None |
Return values
Fn::GetAtt
ResourceGroupID: The ID of the resource group.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
ComputingResourceProvider:
Description:
en: The computing resource provider of the resource group.
Required: false
Type: String
Description:
AssociationProperty: TextArea
Description:
en: The description of the resource group.
Required: false
Type: String
Name:
Description:
en: The name of the resource group.
Required: false
Type: String
ResourceGroupId:
AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
Description:
en: The ID of the resource group.
Required: false
Type: String
ResourceType:
Description:
en: The type of the resource group.
Required: false
Type: String
Tag:
AssociationProperty: List[Parameters]
AssociationPropertyMetadata:
Parameters:
Key:
Description:
en: The tag key.
Required: true
Type: String
Value:
Description:
en: The tag value.
Required: true
Type: String
Description:
en: The tags of the resource group.
Required: false
Type: Json
UserVpc:
AssociationPropertyMetadata:
Parameters:
DefaultForwardInfo:
AssociationPropertyMetadata:
Parameters:
EipAllocationId:
Description:
en: The allocation ID of the associated Elastic IP Address (EIP).
Required: false
Type: String
NatGatewayId:
Description:
en: The unique identifier of the NAT Gateway.
Required: false
Type: String
Description:
en: Settings for default traffic forwarding, including the NAT Gateway
and Elastic IP Address (EIP).
Required: false
Type: Json
DefaultRoute:
Description:
en: The default route for network traffic.
Required: false
Type: String
ExtendedCIDRs:
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Required: false
Type: String
Description:
en: A list of additional CIDR blocks to extend the network address range.
Required: false
Type: Json
RoleArn:
Description:
en: The Alibaba Cloud Resource Name (ARN) of the RAM role that authorizes
access to other cloud services.
Required: false
Type: String
SecurityGroupId:
AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
AssociationPropertyMetadata:
VpcId: ${VpcId}
Description:
en: The ID of the security group that controls network access for the
resource group.
Required: true
Type: String
SwitchId:
Description:
en: The ID of the vSwitch in the VPC.
Required: true
Type: String
VpcId:
AssociationProperty: ALIYUN::ECS::VPC::VPCId
Description:
en: The ID of the Virtual Private Cloud (VPC) associated with the resource group.
Required: true
Type: String
Description:
en: The VPC configuration for the resource group.
Required: false
Type: Json
Version:
Description:
en: The version of the resource group.
Required: false
Type: String
Resources:
ResourceGroup:
Properties:
ComputingResourceProvider:
Ref: ComputingResourceProvider
Description:
Ref: Description
Name:
Ref: Name
ResourceGroupId:
Ref: ResourceGroupId
ResourceType:
Ref: ResourceType
Tag:
Ref: Tag
UserVpc:
Ref: UserVpc
Version:
Ref: Version
Type: ALIYUN::PAI::ResourceGroup
Outputs:
ResourceGroupID:
Description: The ID of the resource group.
Value:
Fn::GetAtt:
- ResourceGroup
- ResourceGroupID
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"Description": {
"Type": "String",
"AssociationProperty": "TextArea",
"Description": {
"en": "The description of the resource group."
},
"Required": false
},
"ComputingResourceProvider": {
"Type": "String",
"Description": {
"en": "The computing resource provider of the resource group."
},
"Required": false
},
"ResourceGroupId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
"Description": {
"en": "The ID of the resource group."
},
"Required": false
},
"Version": {
"Type": "String",
"Description": {
"en": "The version of the resource group."
},
"Required": false
},
"ResourceType": {
"Type": "String",
"Description": {
"en": "The type of the resource group."
},
"Required": false
},
"Tag": {
"AssociationPropertyMetadata": {
"Parameters": {
"Value": {
"Type": "String",
"Description": {
"en": "The tag value."
},
"Required": true
},
"Key": {
"Type": "String",
"Description": {
"en": "The tag key."
},
"Required": true
}
}
},
"Type": "Json",
"AssociationProperty": "List[Parameters]",
"Description": {
"en": "The tags of the resource group."
},
"Required": false
},
"UserVpc": {
"AssociationPropertyMetadata": {
"Parameters": {
"VpcId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
"Description": {
"en": "The ID of the Virtual Private Cloud (VPC) associated with the resource group."
},
"Required": true
},
"SecurityGroupId": {
"AssociationPropertyMetadata": {
"VpcId": "${VpcId}"
},
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
"Description": {
"en": "The ID of the security group that controls network access for the resource group."
},
"Required": true
},
"DefaultRoute": {
"Type": "String",
"Description": {
"en": "The default route for network traffic."
},
"Required": false
},
"SwitchId": {
"Type": "String",
"Description": {
"en": "The ID of the vSwitch in the VPC."
},
"Required": true
},
"DefaultForwardInfo": {
"AssociationPropertyMetadata": {
"Parameters": {
"EipAllocationId": {
"Type": "String",
"Description": {
"en": "The allocation ID of the associated Elastic IP Address (EIP)."
},
"Required": false
},
"NatGatewayId": {
"Type": "String",
"Description": {
"en": "The unique identifier of the NAT Gateway."
},
"Required": false
}
}
},
"Type": "Json",
"Description": {
"en": "Settings for default traffic forwarding, including the NAT Gateway and Elastic IP Address (EIP)."
},
"Required": false
},
"ExtendedCIDRs": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "A list of additional CIDR blocks to extend the network address range."
},
"Required": false
},
"RoleArn": {
"Type": "String",
"Description": {
"en": "The Alibaba Cloud Resource Name (ARN) of the RAM role that authorizes access to other cloud services."
},
"Required": false
}
}
},
"Type": "Json",
"Description": {
"en": "The VPC configuration for the resource group."
},
"Required": false
},
"Name": {
"Type": "String",
"Description": {
"en": "The name of the resource group."
},
"Required": false
}
},
"Resources": {
"ResourceGroup": {
"Type": "ALIYUN::PAI::ResourceGroup",
"Properties": {
"Description": {
"Ref": "Description"
},
"ComputingResourceProvider": {
"Ref": "ComputingResourceProvider"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
},
"Version": {
"Ref": "Version"
},
"ResourceType": {
"Ref": "ResourceType"
},
"Tag": {
"Ref": "Tag"
},
"UserVpc": {
"Ref": "UserVpc"
},
"Name": {
"Ref": "Name"
}
}
}
},
"Outputs": {
"ResourceGroupID": {
"Description": "The ID of the resource group.",
"Value": {
"Fn::GetAtt": [
"ResourceGroup",
"ResourceGroupID"
]
}
}
}
}