VpcPeerConnection
- Implements: IVpcPeerConnection
This class encapsulates and extends the ROS resource type ALIYUN::VPC::VpcPeerConnection.
Initializers
import com.aliyun.ros.cdk.vpc.VpcPeerConnection;
VpcPeerConnection.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.acceptingVpcId(java.lang.String)
.acceptingVpcId(IResolvable)
.vpcId(java.lang.String)
.vpcId(IResolvable)
// .acceptingAliUid(java.lang.Number)
// .acceptingAliUid(IResolvable)
// .acceptingRegionId(java.lang.String)
// .acceptingRegionId(IResolvable)
// .bandwidth(java.lang.Number)
// .bandwidth(IResolvable)
// .deletionForce(java.lang.Boolean)
// .deletionForce(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .linkType(java.lang.String)
// .linkType(IResolvable)
// .name(java.lang.String)
// .name(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(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. |
acceptingVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property acceptingVpcId: The ID of the acceptor VPC. |
vpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vpcId: The ID of the requester VPC. |
acceptingAliUid | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property acceptingAliUid: The ID of the Alibaba Cloud account to which the acceptor VPC belongs. |
acceptingRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property acceptingRegionId: The region ID of the acceptor VPC of the VPC peering connection that you want to create. |
bandwidth | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property bandwidth: The bandwidth of the VPC peering connection. |
deletionForce | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property deletionForce: Specifies whether to forcefully delete the VPC peering connection. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the VPC peering connection. |
linkType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property linkType: The link type. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of the VPC peering connection. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
acceptingVpcIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property acceptingVpcId: The ID of the acceptor VPC.
vpcIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpcId: The ID of the requester VPC.
acceptingAliUidOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property acceptingAliUid: The ID of the Alibaba Cloud account to which the acceptor VPC belongs.
To create a VPC peering connection within your Alibaba Cloud account, enter the ID of your Alibaba Cloud account. To create a VPC peering connection between your Alibaba Cloud account and another Alibaba Cloud account, enter the ID of the peer Alibaba Cloud account. Note If the acceptor VPC belongs to a Resource Access Management (RAM) user, you must set the value of AcceptingAliUid to the ID of the corresponding Alibaba Cloud account. Default current account ID.
acceptingRegionIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property acceptingRegionId: The region ID of the acceptor VPC of the VPC peering connection that you want to create.
To create an intra-region VPC peering connection, enter a region ID that is the same as that of the requester VPC. To create an inter-region VPC peering connection, enter a region ID that is different from that of the requester VPC. Default current region.
bandwidthOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property bandwidth: The bandwidth of the VPC peering connection.
If you specify this parameter, make sure that you are creating an inter-region VPC peering connection.
deletionForceOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property deletionForce: Specifies whether to forcefully delete the VPC peering connection.
Valid values:false (default): notrue: yes If you forcefully delete the VPC peering connection, the system deletes the routes that point to the VPC peering connection from the VPC route table.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the VPC peering connection.
The description must be 2 to 256 characters in length. It must start with a letter but cannot start with http:// or https://.
linkTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property linkType: The link type.
Valid values: Platinum, Gold. If you specify this parameter, make sure that you are creating an inter-region VPC peering connection.
nameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the VPC peering connection.
The name must be 2 to 128 characters in length and can contain digits, underscores (_), and hyphens (-). It must start with a letter.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
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.VpcPeerConnection;
VpcPeerConnection.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. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: The ID of the VPC peering connection. |
props | VpcPeerConnectionProps | 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
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The ID of the VPC peering connection.
propsRequired
public VpcPeerConnectionProps getProps();
- Type: VpcPeerConnectionProps