Skip to content

API.md

Latest commit

 

History

History
398 lines (245 loc) · 14.4 KB

API.md

File metadata and controls

398 lines (245 loc) · 14.4 KB

API Reference

Constructs

Aws

Initializers 

import { Aws } from 'terraform-cdk-serverless-github-actions-runner-controller'

new Aws(scope: Construct, id: string, props: AwsProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props AwsProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { Aws } from 'terraform-cdk-serverless-github-actions-runner-controller'

Aws.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Azure

Initializers 

import { Azure } from 'terraform-cdk-serverless-github-actions-runner-controller'

new Azure(scope: Construct, id: string)
Name Type Description
scope constructs.Construct No description.
id string No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { Azure } from 'terraform-cdk-serverless-github-actions-runner-controller'

Azure.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Gcp

Initializers 

import { Gcp } from 'terraform-cdk-serverless-github-actions-runner-controller'

new Gcp(scope: Construct, id: string)
Name Type Description
scope constructs.Construct No description.
id string No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { Gcp } from 'terraform-cdk-serverless-github-actions-runner-controller'

Gcp.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Structs

AwsProps

Initializer 

import { AwsProps } from 'terraform-cdk-serverless-github-actions-runner-controller'

const awsProps: AwsProps = { ... }

Properties

Name Type Description
clusterName string No description.
containerSupport boolean No description.
securityGroupFilters cdktf.IResolvable | @cdktf/provider-aws.dataAwsSecurityGroups.DataAwsSecurityGroupsFilter[] No description.
subnetFilters cdktf.IResolvable | @cdktf/provider-aws.dataAwsSubnets.DataAwsSubnetsFilter[] No description.
clusterNameRequired 
public readonly clusterName: string;
  • Type: string
containerSupportRequired 
public readonly containerSupport: boolean;
  • Type: boolean
securityGroupFiltersOptional 
public readonly securityGroupFilters: IResolvable | DataAwsSecurityGroupsFilter[];
  • Type: cdktf.IResolvable | @cdktf/provider-aws.dataAwsSecurityGroups.DataAwsSecurityGroupsFilter[]

https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-security-groups.html

subnetFiltersOptional 
public readonly subnetFilters: IResolvable | DataAwsSubnetsFilter[];
  • Type: cdktf.IResolvable | @cdktf/provider-aws.dataAwsSubnets.DataAwsSubnetsFilter[]

https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html