Vpc
- Implements: @alicloud/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 { datasource } from '@alicloud/ros-cdk-vpc'
new datasource.Vpc(scope: Construct, id: string, props: VpcProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | VpcProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: VpcProps
enableResourcePropertyConstraintOptional
- Type: boolean
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 toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-vpc'
datasource.Vpc.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrCidrBlock | string | @alicloud/ros-cdk-core.IResolvable | Attribute CidrBlock: The IPv4 CIDR block of the VPC. |
attrClassicLinkEnabled | string | @alicloud/ros-cdk-core.IResolvable | Attribute ClassicLinkEnabled: status of vpc ClassicLink.. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The time at which the VPC was created. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: The description of the VPC. |
attrDhcpOptionsSetId | string | @alicloud/ros-cdk-core.IResolvable | Attribute DhcpOptionsSetId: The ID of the DHCP option set. |
attrIpv6CidrBlock | string | @alicloud/ros-cdk-core.IResolvable | Attribute Ipv6CidrBlock: The ipv6 cidr block of vpc. |
attrIpv6CidrBlocks | string | @alicloud/ros-cdk-core.IResolvable | Attribute Ipv6CidrBlocks: The IPv6 network segment of the VPC. |
attrIsDefault | string | @alicloud/ros-cdk-core.IResolvable | Attribute IsDefault: Indicates whether to query the default VPC in the specified region. |
attrResourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs. |
attrRouterId | string | @alicloud/ros-cdk-core.IResolvable | Attribute RouterId: The ID of the VRouter. |
attrSecondaryCidrBlocks | string | @alicloud/ros-cdk-core.IResolvable | Attribute SecondaryCidrBlocks: Additional network segment information. |
attrTags | string | @alicloud/ros-cdk-core.IResolvable | Attribute Tags: The tags of Vpc. |
attrUserCidrs | string | @alicloud/ros-cdk-core.IResolvable | Attribute UserCidrs: A list of user CIDRs. |
attrVpcId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VpcId: The ID of the VPC. |
attrVpcName | string | @alicloud/ros-cdk-core.IResolvable | Attribute VpcName: The name of the VPC. |
attrVSwitchIds | string | @alicloud/ros-cdk-core.IResolvable | Attribute VSwitchIds: A list of VSwitches in the VPC. |
props | VpcProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrCidrBlockRequired
public readonly attrCidrBlock: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CidrBlock: The IPv4 CIDR block of the VPC.
attrClassicLinkEnabledRequired
public readonly attrClassicLinkEnabled: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ClassicLinkEnabled: status of vpc ClassicLink..
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The time at which the VPC was created.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: The description of the VPC.
attrDhcpOptionsSetIdRequired
public readonly attrDhcpOptionsSetId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DhcpOptionsSetId: The ID of the DHCP option set.
attrIpv6CidrBlockRequired
public readonly attrIpv6CidrBlock: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Ipv6CidrBlock: The ipv6 cidr block of vpc.
attrIpv6CidrBlocksRequired
public readonly attrIpv6CidrBlocks: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Ipv6CidrBlocks: The IPv6 network segment of the VPC.
attrIsDefaultRequired
public readonly attrIsDefault: string | IResolvable;
- Type: string | @alicloud/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 readonly attrResourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.
attrRouterIdRequired
public readonly attrRouterId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RouterId: The ID of the VRouter.
attrSecondaryCidrBlocksRequired
public readonly attrSecondaryCidrBlocks: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SecondaryCidrBlocks: Additional network segment information.
attrTagsRequired
public readonly attrTags: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Tags: The tags of Vpc.
attrUserCidrsRequired
public readonly attrUserCidrs: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UserCidrs: A list of user CIDRs.
attrVpcIdRequired
public readonly attrVpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VpcId: The ID of the VPC.
attrVpcNameRequired
public readonly attrVpcName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VpcName: The name of the VPC.
attrVSwitchIdsRequired
public readonly attrVSwitchIds: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VSwitchIds: A list of VSwitches in the VPC.
propsRequired
public readonly props: VpcProps;
- Type: VpcProps