AddressBook

• Implements: IAddressBook

This class encapsulates and extends the ROS resource type ALIYUN::CLOUDFW::AddressBook.

Initializers

import com.aliyun.ros.cdk.cloudfw.AddressBook;
AddressBook.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .description(java.lang.String)
    .description(IResolvable)
    .groupName(java.lang.String)
    .groupName(IResolvable)
    .groupType(java.lang.String)
    .groupType(IResolvable)
//  .ackClusterConnectorId(java.lang.String)
//  .ackClusterConnectorId(IResolvable)
//  .ackLabels(IResolvable)
//  .ackLabels(java.util.List<IResolvable)
//  .ackLabels(AckLabelsProperty>)
//  .ackNamespaces(IResolvable)
//  .ackNamespaces(java.util.List<java.lang.String)
//  .ackNamespaces(IResolvable>)
//  .addressList(java.lang.String)
//  .addressList(IResolvable)
//  .autoAddTagEcs(java.lang.Boolean)
//  .autoAddTagEcs(IResolvable)
//  .regionId(java.lang.String)
//  .regionId(IResolvable)
//  .tagList(IResolvable)
//  .tagList(java.util.List<IResolvable)
//  .tagList(TagListProperty>)
//  .tagRelation(java.lang.String)
//  .tagRelation(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

description^Required

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

Property description: Address book description.

groupName^Required

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

Property groupName: Name Address book.

groupType^Required

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

Property groupType: Type of the address book.

ackClusterConnectorId^Optional

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

Property ackClusterConnectorId: ACK cluster connector ID.

Batch query ACK cluster connector list.

ackLabels^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAckLabelsProperty>

Property ackLabels: ACK cluster container group label list.

Up to 10.

ackNamespaces^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property ackNamespaces: ACK cluster container group namespace list.

Up to 10.

addressList^Optional

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

Property addressList: Address list of the address book, between multiple addresses separated by commas.

Note: When GroupType ip, it must be set to port or domain. When GroupType as ip, address list, fill in the IP address. For example: 1.2.3.4/32, 1.2.3.0/24 When GroupType for the port, the address list to fill in ports or port ranges. For example: 80, 100/200 When GroupType for the domain, the domain name to fill in the address list. For example: demo1.aliyun.com, demo2.aliyun.com

autoAddTagEcs^Optional

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

Property autoAddTagEcs: Whether to automatically add new ECS public network IP matching tags to the address book.

Default to false.

regionId^Optional

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

Property regionId: Region ID.

Default to cn-hangzhou.

tagList^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTagListProperty>

Property tagList: The list of ECS tags.

tagRelation^Optional

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

Property tagRelation: The relationship between the labels to be matched more ECS.

and: the relationship between multiple labels "and" that matches both ECS IP public network more tags will be added to the address book. or: a plurality of inter-labeled "or" relationship, i.e., as long as a matching tag ECS public IP address book will be added.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.cloudfw.AddressBook;
AddressBook.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrGroupUuid^Required

public java.lang.Object getAttrGroupUuid();

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

Attribute GroupUuid: After a successful return to the address book to add unique identification ID.

props^Required

public AddressBookProps getProps();

• Type: AddressBookProps