Skip to content

Vpcs

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::Vpcs, which is used to query the virtual private clouds (VPCs) that you created.

Initializers

import com.aliyun.ros.cdk.vpc.datasource.Vpcs;
Vpcs.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .dhcpOptionsSetId(java.lang.String)
//  .dhcpOptionsSetId(IResolvable)
//  .isDefault(java.lang.Boolean)
//  .isDefault(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .vpcIds(IResolvable)
//  .vpcIds(java.util.List<java.lang.String)
//  .vpcIds(IResolvable>)
//  .vpcName(java.lang.String)
//  .vpcName(IResolvable)
//  .vpcOwnerId(java.lang.String)
//  .vpcOwnerId(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.
dhcpOptionsSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dhcpOptionsSetId: The ID of the DHCP options set.
isDefault java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isDefault: Specifies whether to query the default VPC in the specified region.
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.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the VPC to be queried belongs.
vpcIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property vpcIds: The list of The VPC IDs.
vpcName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcName: The name of the VPC.
vpcOwnerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcOwnerId: The ID of the Alibaba Cloud account to which the VPC belongs.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dhcpOptionsSetIdOptional

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

Property dhcpOptionsSetId: The ID of the DHCP options set.


isDefaultOptional

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

Property isDefault: Specifies whether to query the default VPC in the specified region.

Valid values: true(default): queries all VPCs in the specified region. false: does not query the default 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.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group to which the VPC to be queried belongs.


vpcIdsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property vpcIds: The list of The VPC IDs.

You can specify up to 20 VPC IDs.


vpcNameOptional

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

Property vpcName: The name of the VPC.


vpcOwnerIdOptional

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

Property vpcOwnerId: The ID of the Alibaba Cloud account to which the VPC belongs.


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.vpc.datasource.Vpcs;
Vpcs.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.
attrVpcIds com.aliyun.ros.cdk.core.IResolvable Attribute VpcIds: The list of The VPC IDs.
attrVpcs com.aliyun.ros.cdk.core.IResolvable Attribute Vpcs: The detailed information about the VPCs.

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

attrVpcIdsRequired

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

Attribute VpcIds: The list of The VPC IDs.


attrVpcsRequired

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

Attribute Vpcs: The detailed information about the VPCs.