This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/cx-api

Cloud Executable protocol

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.CXAPI" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.CXAPI --version 0.25.3

packages.config:

<package id="Amazon.CDK.CXAPI" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:cdk-cx-api:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="cdk-cx-api" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>cdk-cx-api</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:cdk-cx-api:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='cdk-cx-api', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/cx-api@0.25.3

package.json:

{
  "@aws-cdk/cx-api": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/cx-api@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/cx-api@0.25.3

package.json:

{
  "@aws-cdk/cx-api": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/cx-api@0.25.3

AppRuntime (interface)

class @aws-cdk/cx-api.AppRuntime

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.AppRuntime;
// AppRuntime is an interface
import { AppRuntime } from '@aws-cdk/cx-api';

Information about the application’s runtime components.

libraries

The list of libraries loaded in the application, associated with their versions.

Type:string => string

Artifact (interface)

class @aws-cdk/cx-api.Artifact

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.Artifact;
// Artifact is an interface
import { Artifact } from '@aws-cdk/cx-api';
environment
Type:string
type
Type:ArtifactType
dependencies
Type:string[] (optional)
metadata
Type:string => any (optional)
missing
Type:string => any (optional)
properties
Type:string => any (optional)

ArtifactType (enum)

class @aws-cdk/cx-api.ArtifactType

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.ArtifactType;
const { ArtifactType } = require('@aws-cdk/cx-api');
import { ArtifactType } from '@aws-cdk/cx-api';
AwsCloudFormationStack
AwsEcrDockerImage
AwsS3Object

AssemblyManifest (interface)

class @aws-cdk/cx-api.AssemblyManifest

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.AssemblyManifest;
// AssemblyManifest is an interface
import { AssemblyManifest } from '@aws-cdk/cx-api';
version

Protocol version

Type:string
artifacts

The set of artifacts in this assembly.

Type:string => Artifact (optional)
runtime

Runtime information.

Type:AppRuntime (optional)

AvailabilityZonesContextQuery (interface)

class @aws-cdk/cx-api.AvailabilityZonesContextQuery

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.AvailabilityZonesContextQuery;
// AvailabilityZonesContextQuery is an interface
import { AvailabilityZonesContextQuery } from '@aws-cdk/cx-api';

Query to hosted zone context provider

account

Query account

Type:string (optional)
region

Query region

Type:string (optional)

BuildManifest (interface)

class @aws-cdk/cx-api.BuildManifest

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.BuildManifest;
// BuildManifest is an interface
import { BuildManifest } from '@aws-cdk/cx-api';
steps
Type:string => BuildStep

BuildStep (interface)

class @aws-cdk/cx-api.BuildStep

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.BuildStep;
// BuildStep is an interface
import { BuildStep } from '@aws-cdk/cx-api';
parameters
Type:string => any
type
Type:string
depends
Type:string[] (optional)

BuildStepType (enum)

class @aws-cdk/cx-api.BuildStepType

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.BuildStepType;
const { BuildStepType } = require('@aws-cdk/cx-api');
import { BuildStepType } from '@aws-cdk/cx-api';
CopyFile
ZipDirectory

ContainerImageAssetMetadataEntry (interface)

class @aws-cdk/cx-api.ContainerImageAssetMetadataEntry

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.ContainerImageAssetMetadataEntry;
// ContainerImageAssetMetadataEntry is an interface
import { ContainerImageAssetMetadataEntry } from '@aws-cdk/cx-api';
id

Logical identifier for the asset

Type:string
imageNameParameter

ECR Repository name and tag (separated by “:”) where this asset is stored.

Type:string
packaging

Type of asset

Type:string
path

Path on disk to the asset

Type:string

Environment (interface)

class @aws-cdk/cx-api.Environment

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.Environment;
// Environment is an interface
import { Environment } from '@aws-cdk/cx-api';

Models an AWS execution environment, for use within the CDK toolkit.

account

The 12-digit AWS account ID for the account this environment deploys into

Type:string
name

The arbitrary name of this environment (user-set, or at least user-meaningful)

Type:string
region

The AWS region name where this environment deploys into

Type:string

FileAssetMetadataEntry (interface)

class @aws-cdk/cx-api.FileAssetMetadataEntry

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.FileAssetMetadataEntry;
// FileAssetMetadataEntry is an interface
import { FileAssetMetadataEntry } from '@aws-cdk/cx-api';
id

Logical identifier for the asset

Type:string
packaging

Requested packaging style

Type:string
path

Path on disk to the asset

Type:string
s3BucketParameter

Name of parameter where S3 bucket should be passed in

Type:string
s3KeyParameter

Name of parameter where S3 key should be passed in

Type:string

HostedZoneContextQuery (interface)

class @aws-cdk/cx-api.HostedZoneContextQuery

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.HostedZoneContextQuery;
// HostedZoneContextQuery is an interface
import { HostedZoneContextQuery } from '@aws-cdk/cx-api';

Query to hosted zone context provider

domainName

The domain name e.g. example.com to lookup

Type:string
account

Query account

Type:string (optional)
privateZone

True if the zone you want to find is a private hosted zone

Type:boolean (optional)
region

Query region

Type:string (optional)
vpcId

The VPC ID to that the private zone must be associated with

If you provide VPC ID and privateZone is false, this will return no results

and raise an error.

Type:string (optional)

MetadataEntry (interface)

class @aws-cdk/cx-api.MetadataEntry

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.MetadataEntry;
// MetadataEntry is an interface
import { MetadataEntry } from '@aws-cdk/cx-api';

An metadata entry in the construct.

trace

A stack trace for when the entry was created.

Type:string[]
type

The type of the metadata entry.

Type:string
data

The data.

Type:any (optional)

MissingContext (interface)

class @aws-cdk/cx-api.MissingContext

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.MissingContext;
// MissingContext is an interface
import { MissingContext } from '@aws-cdk/cx-api';

Represents a missing piece of context.

props
Type:string => any
provider
Type:string

SSMParameterContextQuery (interface)

class @aws-cdk/cx-api.SSMParameterContextQuery

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.SSMParameterContextQuery;
// SSMParameterContextQuery is an interface
import { SSMParameterContextQuery } from '@aws-cdk/cx-api';

Query to hosted zone context provider

account

Query account

Type:string (optional)
parameterName

Parameter name to query

Type:string (optional)
region

Query region

Type:string (optional)

SynthesizeResponse (interface)

class @aws-cdk/cx-api.SynthesizeResponse

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.SynthesizeResponse;
// SynthesizeResponse is an interface
import { SynthesizeResponse } from '@aws-cdk/cx-api';
Extends:AssemblyManifest
stacks
Type:SynthesizedStack[]
version

Inherited from @aws-cdk/cx-api.AssemblyManifest

Protocol version

Type:string
artifacts

Inherited from @aws-cdk/cx-api.AssemblyManifest

The set of artifacts in this assembly.

Type:string => Artifact (optional)
runtime

Inherited from @aws-cdk/cx-api.AssemblyManifest

Runtime information.

Type:AppRuntime (optional)

SynthesizedStack (interface)

class @aws-cdk/cx-api.SynthesizedStack

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.SynthesizedStack;
// SynthesizedStack is an interface
import { SynthesizedStack } from '@aws-cdk/cx-api';

A complete synthesized stack

environment
Type:Environment
metadata
Type:string => MetadataEntry[]
name
Type:string
template
Type:any
dependsOn

Other stacks this stack depends on

Type:string[] (optional)
missing
Type:string => MissingContext (optional)

VpcContextQuery (interface)

class @aws-cdk/cx-api.VpcContextQuery

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.VpcContextQuery;
// VpcContextQuery is an interface
import { VpcContextQuery } from '@aws-cdk/cx-api';

Query input for looking up a VPC

filter

Filters to apply to the VPC

Filter parameters are the same as passed to DescribeVpcs.

Type:string => string
account

Query account

Type:string (optional)
region

Query region

Type:string (optional)

VpcContextResponse (interface)

class @aws-cdk/cx-api.VpcContextResponse

Language-specific names:

using Amazon.CDK.CXAPI;
import software.amazon.awscdk.cxapi.VpcContextResponse;
// VpcContextResponse is an interface
import { VpcContextResponse } from '@aws-cdk/cx-api';

Properties of a discovered VPC

availabilityZones

AZs

Type:string[]
vpcId

VPC id

Type:string
isolatedSubnetIds

IDs of all isolated subnets

Element count: #(availabilityZones) · #(isolatedGroups)

Type:string[] (optional)
isolatedSubnetNames

Name of isolated subnet groups

Element count: #(isolatedGroups)

Type:string[] (optional)
privateSubnetIds

IDs of all private subnets

Element count: #(availabilityZones) · #(privateGroups)

Type:string[] (optional)
privateSubnetNames

Name of private subnet groups

Element count: #(privateGroups)

Type:string[] (optional)
publicSubnetIds

IDs of all public subnets

Element count: #(availabilityZones) · #(publicGroups)

Type:string[] (optional)
publicSubnetNames

Name of public subnet groups

Element count: #(publicGroups)

Type:string[] (optional)
vpnGatewayId

The VPN gateway ID

Type:string (optional)