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. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
id
Required
- Type: java.lang.String
enableResourcePropertyConstraint
Optional
- Type: java.lang.Boolean
groupUuid
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property groupUuid: The UUID of the address book.
refreshOptions
Optional
- 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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.
- 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. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
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
attrAddressList
Required
public IResolvable getAttrAddressList();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute AddressList: The addresses in the address book.
attrAddressListCount
Required
public IResolvable getAttrAddressListCount();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute AddressListCount: The number of addresses in the address book.
attrAutoAddTagEcs
Required
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.
attrDescription
Required
public IResolvable getAttrDescription();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the address book.
attrGroupName
Required
public IResolvable getAttrGroupName();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute GroupName: The name of the address book.
attrGroupType
Required
public IResolvable getAttrGroupType();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute GroupType: The type of the address book.
attrGroupUuid
Required
public IResolvable getAttrGroupUuid();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute GroupUuid: The UUID of the address book.
attrReferenceCount
Required
public IResolvable getAttrReferenceCount();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute ReferenceCount: The number of times that the address book is referenced.
attrTagRelation
Required
public IResolvable getAttrTagRelation();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute TagRelation: The logical relationship among ECS tags.
attrTags
Required
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.