Vpc
- Implements: com.aliyun.ros.cdk.vpc.datasource.IVpc
This class encapsulates and extends the ROS resource type DATASOURCE::VPC::Vpc, which is used to query the information about a virtual private cloud (VPC).
Initializers
import com.aliyun.ros.cdk.vpc.datasource.Vpc;
Vpc.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.vpcId(java.lang.String)
.vpcId(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. |
vpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vpcId: The ID of the VPC. |
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
vpcIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpcId: The ID of the VPC.
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.
- 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.datasource.Vpc;
Vpc.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. |
attrCidrBlock | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CidrBlock: The IPv4 CIDR block of the VPC. |
attrClassicLinkEnabled | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ClassicLinkEnabled: status of vpc ClassicLink.. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time at which the VPC was created. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description of the VPC. |
attrDhcpOptionsSetId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DhcpOptionsSetId: The ID of the DHCP option set. |
attrIpv6CidrBlock | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Ipv6CidrBlock: The ipv6 cidr block of vpc. |
attrIpv6CidrBlocks | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Ipv6CidrBlocks: The IPv6 network segment of the VPC. |
attrIsDefault | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IsDefault: Indicates whether to query the default VPC in the specified region. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs. |
attrRouterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RouterId: The ID of the VRouter. |
attrSecondaryCidrBlocks | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecondaryCidrBlocks: Additional network segment information. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tags of Vpc. |
attrUserCidrs | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UserCidrs: A list of user CIDRs. |
attrVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcId: The ID of the VPC. |
attrVpcName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcName: The name of the VPC. |
attrVSwitchIds | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VSwitchIds: A list of VSwitches in the VPC. |
props | VpcProps | 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
attrCidrBlockRequired
public java.lang.Object getAttrCidrBlock();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CidrBlock: The IPv4 CIDR block of the VPC.
attrClassicLinkEnabledRequired
public java.lang.Object getAttrClassicLinkEnabled();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ClassicLinkEnabled: status of vpc ClassicLink..
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time at which the VPC was created.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the VPC.
attrDhcpOptionsSetIdRequired
public java.lang.Object getAttrDhcpOptionsSetId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DhcpOptionsSetId: The ID of the DHCP option set.
attrIpv6CidrBlockRequired
public java.lang.Object getAttrIpv6CidrBlock();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Ipv6CidrBlock: The ipv6 cidr block of vpc.
attrIpv6CidrBlocksRequired
public java.lang.Object getAttrIpv6CidrBlocks();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Ipv6CidrBlocks: The IPv6 network segment of the VPC.
attrIsDefaultRequired
public java.lang.Object getAttrIsDefault();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IsDefault: Indicates whether to query the default VPC in the specified region.
Valid values:
- true (default): All VPCs in the specified region are queried.
- false: The default VPC is not queried.
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 to which the VPC belongs.
attrRouterIdRequired
public java.lang.Object getAttrRouterId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RouterId: The ID of the VRouter.
attrSecondaryCidrBlocksRequired
public java.lang.Object getAttrSecondaryCidrBlocks();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecondaryCidrBlocks: Additional network segment information.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tags of Vpc.
attrUserCidrsRequired
public java.lang.Object getAttrUserCidrs();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UserCidrs: A list of user CIDRs.
attrVpcIdRequired
public java.lang.Object getAttrVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcId: The ID of the VPC.
attrVpcNameRequired
public java.lang.Object getAttrVpcName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcName: The name of the VPC.
attrVSwitchIdsRequired
public java.lang.Object getAttrVSwitchIds();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VSwitchIds: A list of VSwitches in the VPC.
propsRequired
public VpcProps getProps();
- Type: VpcProps