Class ImportedVpc

Defines a Imported VPC object

Hierarchy

  • VpcBase
    • ImportedVpc

Constructors

constructor

Properties

cidrs env internetGateway internetGatewayAttachment internetGatewayId? name node physicalName stack virtualPrivateGateway virtualPrivateGatewayAttachment virtualPrivateGatewayId? vpcId vpnConnections

Methods

_enableCrossEnvironment addCidr addFlowLogs addInternetGateway addInternetGatewayDependent addVirtualPrivateGateway addVirtualPrivateGatewayDependent applyRemovalPolicy generatePhysicalName getResourceArnAttribute getResourceNameAttribute setDhcpOptions toString isConstruct isOwnedResource isResource

Constructors

constructor

Properties

Readonly cidrs

cidrs: CfnVPCCidrBlock[]

Readonly env

env: ResourceEnvironment

Protected internetGateway

internetGateway: undefined | CfnInternetGateway

Protected internetGatewayAttachment

internetGatewayAttachment: undefined | CfnVPCGatewayAttachment

Optional internetGatewayId

internetGatewayId?: string

Readonly name

name: string

Readonly node

node: Node

The tree node.

Stability

stable

Protected Readonly physicalName

physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Readonly stack

stack: Stack

Protected virtualPrivateGateway

virtualPrivateGateway: undefined | VpnGateway

Protected virtualPrivateGatewayAttachment

virtualPrivateGatewayAttachment: undefined | CfnVPCGatewayAttachment

Optional virtualPrivateGatewayId

virtualPrivateGatewayId?: string

Readonly vpcId

vpcId: string

Readonly vpnConnections

vpnConnections: VpnConnection[] = []

Methods

_enableCrossEnvironment

  • _enableCrossEnvironment(): void
  • Internal

    Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

    Returns void

addCidr

  • Parameters

    • options: {
          amazonProvidedIpv6CidrBlock?: boolean;
          cidrBlock?: string;
          ipv4IpamPoolId?: string;
          ipv4NetmaskLength?: number;
          ipv6CidrBlock?: string;
          ipv6IpamPoolId?: string;
          ipv6NetmaskLength?: number;
          ipv6Pool?: string;
      }
      • Optional amazonProvidedIpv6CidrBlock?: boolean
      • Optional cidrBlock?: string
      • Optional ipv4IpamPoolId?: string
      • Optional ipv4NetmaskLength?: number
      • Optional ipv6CidrBlock?: string
      • Optional ipv6IpamPoolId?: string
      • Optional ipv6NetmaskLength?: number
      • Optional ipv6Pool?: string

    Returns void

addFlowLogs

  • Parameters

    • options: {
          acceleratorPrefix: string;
          bucketArn?: string;
          destinations: ("s3" | "cloud-watch-logs")[];
          encryptionKey?: IKey;
          logFormat?: string;
          logRetentionInDays?: number;
          maxAggregationInterval: number;
          overrideS3LogPath?: string;
          trafficType: "ALL" | "ACCEPT" | "REJECT";
          useExistingRoles: boolean;
      }
      • acceleratorPrefix: string
      • Optional bucketArn?: string
      • destinations: ("s3" | "cloud-watch-logs")[]
      • Optional encryptionKey?: IKey
      • Optional logFormat?: string
      • Optional logRetentionInDays?: number
      • maxAggregationInterval: number
      • Optional overrideS3LogPath?: string
      • trafficType: "ALL" | "ACCEPT" | "REJECT"
      • useExistingRoles: boolean

    Returns void

addInternetGateway

  • Returns void

addInternetGatewayDependent

  • Parameters

    • dependent: Construct

    Returns void

addVirtualPrivateGateway

  • Parameters

    • asn: number

    Returns void

addVirtualPrivateGatewayDependent

  • Parameters

    • dependent: Construct

    Returns void

applyRemovalPolicy

  • Apply the given removal policy to this resource

    The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

    The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

    Parameters

    • policy: RemovalPolicy

    Returns void

Protected generatePhysicalName

  • Returns string

Protected getResourceArnAttribute

  • Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

    Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

    Parameters

    • arnAttr: string

      The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

    • arnComponents: ArnComponents

      The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

    Returns string

Protected getResourceNameAttribute

  • Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

    Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

    Parameters

    • nameAttr: string

      The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

    Returns string

setDhcpOptions

  • Parameters

    • dhcpOptions: string

    Returns void

toString

  • Returns a string representation of this construct.

    Stability

    stable

    Returns string

Static isConstruct

  • (deprecated) Checks if x is a construct.

    Returns

    true if x is an object created from a class which extends Construct.

    Deprecated

    use x instanceof Construct instead

    Parameters

    • x: any

      Any object.

    Returns x is Construct

Static isOwnedResource

  • Returns true if the construct was created by CDK, and false otherwise

    Parameters

    • construct: IConstruct

    Returns boolean

Static isResource

  • Check whether the given construct is a Resource

    Parameters

    • construct: IConstruct

    Returns construct is Resource

Settings

Member Visibility

Theme

Generated using TypeDoc