Skip to content

Vpc

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

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.
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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • 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.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
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 @alicloud/ros-cdk-core.IResolvable Attribute CidrBlock: The IPv4 CIDR block of the VPC.
attrClassicLinkEnabled @alicloud/ros-cdk-core.IResolvable Attribute ClassicLinkEnabled: status of vpc ClassicLink..
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The time at which the VPC was created.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the VPC.
attrDhcpOptionsSetId @alicloud/ros-cdk-core.IResolvable Attribute DhcpOptionsSetId: The ID of the DHCP option set.
attrIpv6CidrBlock @alicloud/ros-cdk-core.IResolvable Attribute Ipv6CidrBlock: The ipv6 cidr block of vpc.
attrIpv6CidrBlocks @alicloud/ros-cdk-core.IResolvable Attribute Ipv6CidrBlocks: The IPv6 network segment of the VPC.
attrIsDefault @alicloud/ros-cdk-core.IResolvable Attribute IsDefault: Indicates whether to query the default VPC in the specified region.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.
attrRouterId @alicloud/ros-cdk-core.IResolvable Attribute RouterId: The ID of the VRouter.
attrSecondaryCidrBlocks @alicloud/ros-cdk-core.IResolvable Attribute SecondaryCidrBlocks: Additional network segment information.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tags of Vpc.
attrUserCidrs @alicloud/ros-cdk-core.IResolvable Attribute UserCidrs: A list of user CIDRs.
attrVpcId @alicloud/ros-cdk-core.IResolvable Attribute VpcId: The ID of the VPC.
attrVpcName @alicloud/ros-cdk-core.IResolvable Attribute VpcName: The name of the VPC.
attrVSwitchIds @alicloud/ros-cdk-core.IResolvable Attribute VSwitchIds: A list of VSwitches in the VPC.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

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: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CidrBlock: The IPv4 CIDR block of the VPC.

attrClassicLinkEnabledRequired 

public readonly attrClassicLinkEnabled: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ClassicLinkEnabled: status of vpc ClassicLink..

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time at which the VPC was created.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the VPC.

attrDhcpOptionsSetIdRequired 

public readonly attrDhcpOptionsSetId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DhcpOptionsSetId: The ID of the DHCP option set.

attrIpv6CidrBlockRequired 

public readonly attrIpv6CidrBlock: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Ipv6CidrBlock: The ipv6 cidr block of vpc.

attrIpv6CidrBlocksRequired 

public readonly attrIpv6CidrBlocks: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Ipv6CidrBlocks: The IPv6 network segment of the VPC.

attrIsDefaultRequired 

public readonly attrIsDefault: IResolvable;
  • Type: @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: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.

attrRouterIdRequired 

public readonly attrRouterId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute RouterId: The ID of the VRouter.

attrSecondaryCidrBlocksRequired 

public readonly attrSecondaryCidrBlocks: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecondaryCidrBlocks: Additional network segment information.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tags of Vpc.

attrUserCidrsRequired 

public readonly attrUserCidrs: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute UserCidrs: A list of user CIDRs.

attrVpcIdRequired 

public readonly attrVpcId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcId: The ID of the VPC.

attrVpcNameRequired 

public readonly attrVpcName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcName: The name of the VPC.

attrVSwitchIdsRequired 

public readonly attrVSwitchIds: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchIds: A list of VSwitches in the VPC.