Use the ALIYUN::ResourceManager::MultiAccountDeliveryChannel resource type to create a multi-account delivery channel.
Syntax
{
"Type": "ALIYUN::ResourceManager::MultiAccountDeliveryChannel",
"Properties": {
"DeliveryChannelDescription": String,
"DeliveryChannelFilter": Map,
"MultiAccountDeliveryChannelName": String,
"MultiAccountDeliveryChannelId": String,
"ResourceChangeDelivery": Map,
"ResourceSnapshotDelivery": Map
}
}Properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
DeliveryChannelDescription |
String |
Yes |
Yes |
The description of the delivery channel. |
None |
|
DeliveryChannelFilter |
Map |
Yes |
Yes |
The scope of the delivery channel. |
For more information, see DeliveryChannelFilter properties. |
|
MultiAccountDeliveryChannelName |
String |
Yes |
Yes |
The name of the delivery channel. |
None |
|
MultiAccountDeliveryChannelId |
String |
No |
Yes |
The delivery channel ID. |
None |
|
ResourceChangeDelivery |
Map |
No |
Yes |
Configurations for delivering resource configuration change events. |
For more information, see ResourceChangeDelivery properties. |
|
ResourceSnapshotDelivery |
Map |
No |
Yes |
Configurations for the scheduled delivery of resource snapshots. |
For more information, see ResourceSnapshotDelivery properties. |
ResourceChangeDelivery syntax
"ResourceChangeDelivery": {
"SlsProperties": Map,
"TargetArn": String
}ResourceChangeDelivery properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
SlsProperties |
Map |
No |
Yes |
The SLS configurations. |
For more information, see SlsProperties properties. |
|
TargetArn |
String |
No |
Yes |
The target ARN. |
None |
SlsProperties syntax
"SlsProperties": {
"OversizedDataOssTargetArn": String
}SlsProperties properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
OversizedDataOssTargetArn |
String |
No |
Yes |
The ARN of the delivery destination for oversized data. |
Specify the ARN of an OSS bucket with a prefix of resourcecenter-. |
DeliveryChannelFilter syntax
"DeliveryChannelFilter": {
"ResourceTypes": List,
"AccountScopes": List
}DeliveryChannelFilter properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
AccountScopes |
List |
Yes |
Yes |
The account scopes of the delivery channel. |
None |
|
ResourceTypes |
List |
No |
Yes |
The resource types delivered by the channel. |
None |
ResourceSnapshotDelivery syntax
"ResourceSnapshotDelivery": {
"DeliveryTime": String,
"TargetArn": String
}ResourceSnapshotDelivery properties
|
Parameter |
Type |
Required |
Update allowed |
Description |
Constraints |
|
DeliveryTime |
String |
No |
Yes |
The delivery time. |
None |
|
TargetArn |
String |
No |
Yes |
The target ARN. |
None |
Return values
Fn::GetAtt
-
ResourceChangeDelivery: Configurations for delivering resource configuration change events.
-
DeliveryChannelDescription: The description of the channel.
-
MultiAccountDeliveryChannelId: The ID of the delivery channel.
-
MultiAccountDeliveryChannelName: The name of the channel.
-
DeliveryChannelFilter: The scope of the channel.
-
ResourceSnapshotDelivery: Configurations for the scheduled delivery of resource snapshots.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
DeliveryChannelFilter:
Description:
en: The effective scope of the delivery channel.
Required: true
Type: Json
AssociationPropertyMetadata:
Parameters:
ResourceTypes:
Description:
en: The resource types that are delivered by the delivery channel.
Required: false
Default: Null
Type: Json
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Type: String
Description:
en: The resource type.
Default: Null
Required: false
AccountScopes:
Description:
en: The account scopes of the delivery channel.
Required: true
Type: Json
AssociationProperty: List[Parameter]
AssociationPropertyMetadata:
Parameter:
Type: String
Description:
en: |-
The account scope of the delivery channel. Valid values:
* The ID of a Resource Directory. This value specifies that the resources of the management account and all members of the Resource Directory are delivered.
* The ID of the Root folder. This value specifies that the resources of all members in the Root folder and its subfolders are delivered.
* The ID of a folder. This value specifies that the resources of all members in the folder are delivered.
* The ID of a member. This value specifies that the resources of the member are delivered.
Required: true
MultiAccountDeliveryChannelName:
Type: String
Description:
en: The name of the delivery channel.
Required: true
ResourceSnapshotDelivery:
Description:
en: The configurations for scheduled delivery of resource snapshots.
Required: false
Default: Null
Type: Json
AssociationPropertyMetadata:
Parameters:
TargetArn:
Type: String
Description:
en: The ARN of the delivery destination.
Default: Null
Required: false
DeliveryTime:
Type: String
Description:
en: The delivery time.
Default: Null
Required: false
DeliveryChannelDescription:
Type: String
Description:
en: The description of the delivery channel.
Required: true
ResourceChangeDelivery:
Description:
en: The configurations for the delivery of resource configuration change events.
Required: false
Default: Null
Type: Json
AssociationPropertyMetadata:
Parameters:
TargetArn:
Type: String
Description:
en: The target ARN.
Default: Null
Required: false
SlsProperties:
Description:
en: The SLS configurations.
Required: false
Default: Null
Type: Json
AssociationPropertyMetadata:
Parameters:
OversizedDataOssTargetArn:
Type: String
Description:
en: The ARN of the delivery destination for oversized data. If the size of a resource configuration change event exceeds 1 MB, the event is delivered as an OSS object. You must enter the ARN of an OSS bucket that has a prefix of resourcecenter-.
Default: Null
Required: false
MultiAccountDeliveryChannelId:
Type: String
Description:
en: The delivery channel ID.
Default: Null
Required: false
Resources:
ExtensionResource:
Type: ALIYUN::ResourceManager::MultiAccountDeliveryChannel
Properties:
DeliveryChannelFilter:
Ref: DeliveryChannelFilter
MultiAccountDeliveryChannelName:
Ref: MultiAccountDeliveryChannelName
ResourceSnapshotDelivery:
Ref: ResourceSnapshotDelivery
DeliveryChannelDescription:
Ref: DeliveryChannelDescription
ResourceChangeDelivery:
Ref: ResourceChangeDelivery
MultiAccountDeliveryChannelId:
Ref: MultiAccountDeliveryChannelId
Outputs:
DeliveryChannelFilter:
Value:
Fn::GetAtt:
- ExtensionResource
- DeliveryChannelFilter
Description: The effective scope of the delivery channel.
MultiAccountDeliveryChannelName:
Value:
Fn::GetAtt:
- ExtensionResource
- MultiAccountDeliveryChannelName
Description: The name of the delivery channel.
ResourceSnapshotDelivery:
Value:
Fn::GetAtt:
- ExtensionResource
- ResourceSnapshotDelivery
Description: The configurations for scheduled delivery of resource snapshots.
DeliveryChannelDescription:
Value:
Fn::GetAtt:
- ExtensionResource
- DeliveryChannelDescription
Description: The description of the delivery channel.
ResourceChangeDelivery:
Value:
Fn::GetAtt:
- ExtensionResource
- ResourceChangeDelivery
Description: The configurations for the delivery of resource configuration change events.
MultiAccountDeliveryChannelId:
Value:
Fn::GetAtt:
- ExtensionResource
- MultiAccountDeliveryChannelId
Description: The delivery channel ID.
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"DeliveryChannelFilter": {
"Description": {
"en": "The effective scope of the delivery channel."
},
"Required": true,
"Type": "Json",
"AssociationPropertyMetadata": {
"Parameters": {
"ResourceTypes": {
"Description": {
"en": "The resource types that are delivered by the delivery channel."
},
"Required": false,
"Default": null,
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The resource type."
},
"Default": null,
"Required": false
}
}
},
"AccountScopes": {
"Description": {
"en": "The account scopes of the delivery channel."
},
"Required": true,
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Description": {
"en": "The account scope of the delivery channel. Valid values: \n* The ID of a Resource Directory. This value specifies that the resources of the management account and all members of the Resource Directory are delivered.\n* The ID of the Root folder. This value specifies that the resources of all members in the Root folder and its subfolders are delivered.\n* The ID of a folder. This value specifies that the resources of all members in the folder are delivered.\n* The ID of a member. This value specifies that the resources of the member are delivered."
},
"Required": true
}
}
}
}
}
},
"MultiAccountDeliveryChannelName": {
"Type": "String",
"Description": {
"en": "The name of the delivery channel."
},
"Required": true
},
"ResourceSnapshotDelivery": {
"Description": {
"en": "The configurations for scheduled delivery of resource snapshots."
},
"Required": false,
"Default": null,
"Type": "Json",
"AssociationPropertyMetadata": {
"Parameters": {
"TargetArn": {
"Type": "String",
"Description": {
"en": "The ARN of the delivery destination."
},
"Default": null,
"Required": false
},
"DeliveryTime": {
"Type": "String",
"Description": {
"en": "The delivery time."
},
"Default": null,
"Required": false
}
}
}
},
"DeliveryChannelDescription": {
"Type": "String",
"Description": {
"en": "The description of the delivery channel."
},
"Required": true
},
"ResourceChangeDelivery": {
"Description": {
"en": "The configurations for the delivery of resource configuration change events."
},
"Required": false,
"Default": null,
"Type": "Json",
"AssociationPropertyMetadata": {
"Parameters": {
"TargetArn": {
"Type": "String",
"Description": {
"en": "The target ARN."
},
"Default": null,
"Required": false
},
"SlsProperties": {
"Description": {
"en": "The SLS configurations."
},
"Required": false,
"Default": null,
"Type": "Json",
"AssociationPropertyMetadata": {
"Parameters": {
"OversizedDataOssTargetArn": {
"Type": "String",
"Description": {
"en": "The ARN of the delivery destination for oversized data. If the size of a resource configuration change event exceeds 1 MB, the event is delivered as an OSS object. You must enter the ARN of an OSS bucket that has a prefix of resourcecenter-."
},
"Default": null,
"Required": false
}
}
}
}
}
}
},
"MultiAccountDeliveryChannelId": {
"Type": "String",
"Description": {
"en": "The delivery channel ID."
},
"Default": null,
"Required": false
}
},
"Resources": {
"ExtensionResource": {
"Type": "ALIYUN::ResourceManager::MultiAccountDeliveryChannel",
"Properties": {
"DeliveryChannelFilter": {
"Ref": "DeliveryChannelFilter"
},
"MultiAccountDeliveryChannelName": {
"Ref": "MultiAccountDeliveryChannelName"
},
"ResourceSnapshotDelivery": {
"Ref": "ResourceSnapshotDelivery"
},
"DeliveryChannelDescription": {
"Ref": "DeliveryChannelDescription"
},
"ResourceChangeDelivery": {
"Ref": "ResourceChangeDelivery"
},
"MultiAccountDeliveryChannelId": {
"Ref": "MultiAccountDeliveryChannelId"
}
}
}
},
"Outputs": {
"DeliveryChannelFilter": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"DeliveryChannelFilter"
]
},
"Description": "The effective scope of the delivery channel."
},
"MultiAccountDeliveryChannelName": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"MultiAccountDeliveryChannelName"
]
},
"Description": "The name of the delivery channel."
},
"ResourceSnapshotDelivery": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"ResourceSnapshotDelivery"
]
},
"Description": "The configurations for scheduled delivery of resource snapshots."
},
"DeliveryChannelDescription": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"DeliveryChannelDescription"
]
},
"Description": "The description of the delivery channel."
},
"ResourceChangeDelivery": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"ResourceChangeDelivery"
]
},
"Description": "The configurations for the delivery of resource configuration change events."
},
"MultiAccountDeliveryChannelId": {
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"MultiAccountDeliveryChannelId"
]
},
"Description": "The delivery channel ID."
}
}
}