Ipam
- Implements: IIpam
This class encapsulates and extends the ROS resource type ALIYUN::VPC::Ipam.
Initializers
import com.aliyun.ros.cdk.vpc.Ipam;
Ipam.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.operatingRegionList(IResolvable)
.operatingRegionList(java.util.List<java.lang.String)
.operatingRegionList(IResolvable>)
// .ipamDescription(java.lang.String)
// .ipamDescription(IResolvable)
// .ipamName(java.lang.String)
// .ipamName(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .tags(java.util.List<TagsProperty>)
.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. |
operatingRegionList | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property operatingRegionList: List of IPAM effective regions. |
ipamDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ipamDescription: The description of IPAM. |
ipamName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ipamName: The name of the IPAM. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group. |
tags | java.util.List<TagsProperty> | Property tags: Tags of ipam. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
operatingRegionListRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property operatingRegionList: List of IPAM effective regions.
ipamDescriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ipamDescription: The description of IPAM.
It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http:// 'or 'https. If the description is not filled in, it is blank. The default value is blank.
ipamNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ipamName: The name of the IPAM.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags of ipam.
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.
- 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
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)
- 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.vpc.Ipam;
Ipam.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. |
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. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The creation time of the IPAM. |
attrDefaultResourceDiscoveryAssociationId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DefaultResourceDiscoveryAssociationId: After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM. |
attrDefaultResourceDiscoveryId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DefaultResourceDiscoveryId: After IPAM is created, the system creates resource discovery by default. |
attrIpamDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IpamDescription: The description of IPAM. |
attrIpamId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IpamId: The first ID of the resource. |
attrIpamName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IpamName: The name of the IPAM. |
attrOperatingRegionList | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OperatingRegionList: List of IPAM effective regions. |
attrPrivateDefaultScopeId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PrivateDefaultScopeId: After an IPAM is created, the scope of the private network IPAM created by the system by default. |
attrPublicDefaultScopeId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PublicDefaultScopeId: After an IPAM is created, the public network IPAM is created by default. |
attrResourceDiscoveryAssociationCount | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceDiscoveryAssociationCount: The number of resource discovery objects associated with IPAM. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of the resource group. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tag of the IPAM. |
props | IpamProps | 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
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The creation time of the IPAM.
attrDefaultResourceDiscoveryAssociationIdRequired
public java.lang.Object getAttrDefaultResourceDiscoveryAssociationId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DefaultResourceDiscoveryAssociationId: After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
attrDefaultResourceDiscoveryIdRequired
public java.lang.Object getAttrDefaultResourceDiscoveryId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DefaultResourceDiscoveryId: After IPAM is created, the system creates resource discovery by default.
attrIpamDescriptionRequired
public java.lang.Object getAttrIpamDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IpamDescription: The description of IPAM.
attrIpamIdRequired
public java.lang.Object getAttrIpamId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IpamId: The first ID of the resource.
attrIpamNameRequired
public java.lang.Object getAttrIpamName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IpamName: The name of the IPAM.
attrOperatingRegionListRequired
public java.lang.Object getAttrOperatingRegionList();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OperatingRegionList: List of IPAM effective regions.
attrPrivateDefaultScopeIdRequired
public java.lang.Object getAttrPrivateDefaultScopeId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PrivateDefaultScopeId: After an IPAM is created, the scope of the private network IPAM created by the system by default.
attrPublicDefaultScopeIdRequired
public java.lang.Object getAttrPublicDefaultScopeId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PublicDefaultScopeId: After an IPAM is created, the public network IPAM is created by default.
attrResourceDiscoveryAssociationCountRequired
public java.lang.Object getAttrResourceDiscoveryAssociationCount();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceDiscoveryAssociationCount: The number of resource discovery objects associated with IPAM.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tag of the IPAM.
propsRequired
public IpamProps getProps();
- Type: IpamProps