Skip to content

AggregatorProps

Properties for defining a Aggregator.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-config-aggregator

Initializer 

import { AggregatorProps } from '@alicloud/ros-cdk-config'
const aggregatorProps: AggregatorProps = { ... }

Properties

Name Type Description
aggregatorName string | @alicloud/ros-cdk-core.IResolvable Property aggregatorName: The name of aggregator.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of aggregator.
aggregatorAccounts @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AggregatorAccountsProperty[] Property aggregatorAccounts: The member account in aggregator.When the AggregatorType is RD, this parameter can be empty, which means that all accounts in the resource directory will be added to the global account group.When the AggregatorType is FOLDER, this parameter can be empty,which means that all accounts in the resource folder will be added to the global account group.
aggregatorType string | @alicloud/ros-cdk-core.IResolvable Property aggregatorType: Account group type.
folderId string | @alicloud/ros-cdk-core.IResolvable Property folderId: The ID of the attached folder.

aggregatorNameRequired 

public readonly aggregatorName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property aggregatorName: The name of aggregator.

descriptionRequired 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of aggregator.

aggregatorAccountsOptional 

public readonly aggregatorAccounts: IResolvable | IResolvable | AggregatorAccountsProperty[];

Property aggregatorAccounts: The member account in aggregator.When the AggregatorType is RD, this parameter can be empty, which means that all accounts in the resource directory will be added to the global account group.When the AggregatorType is FOLDER, this parameter can be empty,which means that all accounts in the resource folder will be added to the global account group.

aggregatorTypeOptional 

public readonly aggregatorType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property aggregatorType: Account group type.

Value: RD: Global account group. CUSTOM: Custom account group (default value). FOLDER: Folder account group. Must set FolderId if the AggregatorType is FOLDER. Please refer to ListAccounts for accessing FolderId.

folderIdOptional 

public readonly folderId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property folderId: The ID of the attached folder.

You can specify multiple folder IDs. Separate the IDs with commas (,). This parameter is required if you set AggregatorType to FOLDER.