Aggregator
- Implements: IAggregator
This class encapsulates and extends the ROS resource type ALIYUN::Config::Aggregator.
Initializers
import com.aliyun.ros.cdk.config.Aggregator;
Aggregator.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.aggregatorName(java.lang.String)
.aggregatorName(IResolvable)
.description(java.lang.String)
.description(IResolvable)
// .aggregatorAccounts(IResolvable)
// .aggregatorAccounts(java.util.List<IResolvable)
// .aggregatorAccounts(AggregatorAccountsProperty>)
// .aggregatorType(java.lang.String)
// .aggregatorType(IResolvable)
// .folderId(java.lang.String)
// .folderId(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
aggregatorName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property aggregatorName: The name of aggregator. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of aggregator. |
aggregatorAccounts | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | 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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property aggregatorType: Account group type. |
folderId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property folderId: The ID of the attached folder. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
aggregatorNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property aggregatorName: The name of aggregator.
descriptionRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of aggregator.
aggregatorAccountsOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
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
- Type: java.lang.String OR com.aliyun.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
- Type: java.lang.String OR com.aliyun.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.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.config.Aggregator;
Aggregator.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrAggregatorId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AggregatorId: The ID of the aggregator. |
props | AggregatorProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrAggregatorIdRequired
public java.lang.Object getAttrAggregatorId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AggregatorId: The ID of the aggregator.
propsRequired
public AggregatorProps getProps();
- Type: AggregatorProps