Skip to content

AddressBook

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

Initializers

import com.aliyun.ros.cdk.cloudfw.datasource.AddressBook;
AddressBook.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .groupUuid(java.lang.String)
    .groupUuid(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
groupUuid java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property groupUuid: The UUID of the address book.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

groupUuidRequired

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

Property groupUuid: The UUID of the address book.


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.datasource.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.
attrAddressList com.aliyun.ros.cdk.core.IResolvable Attribute AddressList: The addresses in the address book.
attrAddressListCount com.aliyun.ros.cdk.core.IResolvable Attribute AddressListCount: The number of addresses in the address book.
attrAutoAddTagEcs com.aliyun.ros.cdk.core.IResolvable Attribute AutoAddTagEcs: Indicates whether the public IP addresses of ECS instances are automatically added to the address book if the instances match the specified tags.
attrDescription com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the address book.
attrGroupName com.aliyun.ros.cdk.core.IResolvable Attribute GroupName: The name of the address book.
attrGroupType com.aliyun.ros.cdk.core.IResolvable Attribute GroupType: The type of the address book.
attrGroupUuid com.aliyun.ros.cdk.core.IResolvable Attribute GroupUuid: The UUID of the address book.
attrReferenceCount com.aliyun.ros.cdk.core.IResolvable Attribute ReferenceCount: The number of times that the address book is referenced.
attrTagRelation com.aliyun.ros.cdk.core.IResolvable Attribute TagRelation: The logical relationship among ECS tags.
attrTags com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The details about the ECS tags that can be automatically added to the address book.

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

attrAddressListRequired

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

Attribute AddressList: The addresses in the address book.


attrAddressListCountRequired

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

Attribute AddressListCount: The number of addresses in the address book.


attrAutoAddTagEcsRequired

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

Attribute AutoAddTagEcs: Indicates whether the public IP addresses of ECS instances are automatically added to the address book if the instances match the specified tags.


attrDescriptionRequired

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

Attribute Description: The description of the address book.


attrGroupNameRequired

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

Attribute GroupName: The name of the address book.


attrGroupTypeRequired

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

Attribute GroupType: The type of the address book.


attrGroupUuidRequired

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

Attribute GroupUuid: The UUID of the address book.


attrReferenceCountRequired

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

Attribute ReferenceCount: The number of times that the address book is referenced.


attrTagRelationRequired

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

Attribute TagRelation: The logical relationship among ECS tags.


attrTagsRequired

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

Attribute Tags: The details about the ECS tags that can be automatically added to the address book.