Aggregator
This class encapsulates and extends the ROS resource type ALIYUN::Config::Aggregator
, which is used to create an account group.
Initializers
import ros_cdk_config
ros_cdk_config.Aggregator(
scope: Construct,
id: str,
aggregator_name: typing.Union[str, IResolvable],
description: typing.Union[str, IResolvable],
aggregator_accounts: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AggregatorAccountsProperty]]] = None,
aggregator_type: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
aggregator_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property aggregatorName: The name of aggregator. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: The description of aggregator. |
aggregator_accounts |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[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. |
aggregator_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property aggregatorType: Account group type. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
aggregator_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property aggregatorName: The name of aggregator.
description
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of aggregator.
aggregator_accounts
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[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.
aggregator_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property aggregatorType: Account group type.
Value: RD: Global account group.CUSTOM: Custom account group (default value).
enable_resource_property_constraint
Optional
- Type: bool
Methods
Name | Description |
---|---|
to_string |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition |
No description. |
add_count |
No description. |
add_dependency |
No description. |
add_resource_desc |
No description. |
apply_removal_policy |
No description. |
get_att |
No description. |
set_metadata |
No description. |
to_string
def to_string() -> str
Returns a string representation of this construct.
synthesize
def synthesize(
session: ISynthesisSession
) -> None
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: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_config
ros_cdk_config.Aggregator.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
Name | Type | Description |
---|---|---|
node |
ros_cdk_core.ConstructNode |
The construct tree node associated with this construct. |
ref |
str |
No description. |
stack |
ros_cdk_core.Stack |
The stack in which this resource is defined. |
resource |
ros_cdk_core.RosResource |
No description. |
attr_aggregator_id |
ros_cdk_core.IResolvable |
Attribute AggregatorId: The ID of the aggregator. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
ref
Required
ref: str
- Type: str
stack
Required
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resource
Optional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_aggregator_id
Required
attr_aggregator_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute AggregatorId: The ID of the aggregator.