Skip to content

AddressBook

This class encapsulates and extends the ROS resource type ALIYUN::CLOUDFW::AddressBook, which is used to create an address book that is used for access control.

Address books include IP address books, Elastic Compute Service (ECS) tag-based address books, port address books, and domain address books.

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)
//  .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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Address book description.
groupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property groupName: Name Address book.
groupType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property groupType: Type the address book, the optional values ​​are: ip: IP Address Book domain: domain name address book port: Port Address Book tag: ECS label address book.
addressList java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property addressList: Address list of the address book, between multiple addresses separated by commas.
autoAddTagEcs 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.
regionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property regionId: Region ID.
tagList com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTagListProperty> Property tagList:.
tagRelation java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property tagRelation: The relationship between the labels to be matched more ECS.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

descriptionRequired

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

Property description: Address book description.

groupNameRequired

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

Property groupName: Name Address book.

groupTypeRequired

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

Property groupType: Type the address book, the optional values ​​are: ip: IP Address Book domain: domain name address book port: Port Address Book tag: ECS label address book.

addressListOptional

  • 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

autoAddTagEcsOptional

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

regionIdOptional

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

Property regionId: Region ID.

Default to cn-hangzhou.

tagListOptional

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

Property tagList:.

tagRelationOptional

  • 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

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.cloudfw.AddressBook;
AddressBook.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.
attrGroupUuid com.aliyun.ros.cdk.core.IResolvable Attribute GroupUuid: After a successful return to the address book to add unique identification ID.

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

attrGroupUuidRequired 

public IResolvable getAttrGroupUuid();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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