Skip to content

AddressBook

  • Implements: com.aliyun.ros.cdk.cloudfw.datasource.IAddressBook

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AddressList: The addresses in the address book.
attrAddressListCount java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AddressListCount: The number of addresses in the address book.
attrAutoAddTagEcs java.lang.String OR 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the address book.
attrGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute GroupName: The name of the address book.
attrGroupType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute GroupType: The type of the address book.
attrGroupUuid java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute GroupUuid: The UUID of the address book.
attrReferenceCount java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ReferenceCount: The number of times that the address book is referenced.
attrTagRelation java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TagRelation: The logical relationship among ECS tags.
attrTags java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The details about the ECS tags that can be automatically added to the address book.
props AddressBookProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

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.


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 java.lang.Object getAttrAddressList();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AddressList: The addresses in the address book.


attrAddressListCountRequired

public java.lang.Object getAttrAddressListCount();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrAutoAddTagEcsRequired

public java.lang.Object getAttrAutoAddTagEcs();
  • Type: java.lang.String OR 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 java.lang.Object getAttrDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the address book.


attrGroupNameRequired

public java.lang.Object getAttrGroupName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GroupName: The name of the address book.


attrGroupTypeRequired

public java.lang.Object getAttrGroupType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GroupType: The type of the address book.


attrGroupUuidRequired

public java.lang.Object getAttrGroupUuid();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GroupUuid: The UUID of the address book.


attrReferenceCountRequired

public java.lang.Object getAttrReferenceCount();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrTagRelationRequired

public java.lang.Object getAttrTagRelation();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TagRelation: The logical relationship among ECS tags.


attrTagsRequired

public java.lang.Object getAttrTags();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


propsRequired

public AddressBookProps getProps();