Skip to content

Aggregator

This class encapsulates and extends the ROS resource type ALIYUN::Config::Aggregator, which is used to create an account group.

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)
    .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.ListAggregatorAccountsProperty> 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.
aggregatorType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property aggregatorType: Account group type.

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.ListAggregatorAccountsProperty>

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.

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).

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.
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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • 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.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
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 com.aliyun.ros.cdk.core.IResolvable Attribute AggregatorId: The ID of the aggregator.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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 IResolvable getAttrAggregatorId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AggregatorId: The ID of the aggregator.