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/aws-quickstarts

AWS Quickstarts for the CDK

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

Reference

View in Nuget

csproj:

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

dotnet:

dotnet add package Amazon.CDK.AWS.QuickStarts --version 0.25.3

packages.config:

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

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:quickstarts:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="quickstarts" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>quickstarts</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:quickstarts:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='quickstarts', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-quickstarts@0.25.3

package.json:

{
  "@aws-cdk/aws-quickstarts": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-quickstarts@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-quickstarts@0.25.3

package.json:

{
  "@aws-cdk/aws-quickstarts": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-quickstarts@0.25.3

RemoteDesktopGateway

class @aws-cdk/aws-quickstarts.RemoteDesktopGateway(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.QuickStarts;
import software.amazon.awscdk.services.quickstarts.RemoteDesktopGateway;
const { RemoteDesktopGateway } = require('@aws-cdk/aws-quickstarts');
import { RemoteDesktopGateway } from '@aws-cdk/aws-quickstarts';

Embed the Remote Desktop Gateway AWS QuickStart

Extends:

@aws-cdk/cdk.Construct

Implements:

@aws-cdk/aws-ec2.IConnectable

Parameters:
connections

Implements @aws-cdk/aws-ec2.IConnectable.connections()

Type:@aws-cdk/aws-ec2.Connections (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

RemoteDesktopGatewayProps (interface)

class @aws-cdk/aws-quickstarts.RemoteDesktopGatewayProps

Language-specific names:

using Amazon.CDK.AWS.QuickStarts;
import software.amazon.awscdk.services.quickstarts.RemoteDesktopGatewayProps;
// RemoteDesktopGatewayProps is an interface
import { RemoteDesktopGatewayProps } from '@aws-cdk/aws-quickstarts';
adminPassword
Type:string
keyPairName
Type:string
rdgwCIDR
Type:string
vpc
Type:@aws-cdk/aws-ec2.IVpcNetwork
adminUser
Type:string (optional)
domainDNSName
Type:string (optional)
numberOfRDGWHosts
Type:number (optional)
qss3BucketName
Type:string (optional)
qss3KeyPrefix
Type:string (optional)
rdgwInstanceType
Type:string (optional)

SqlServer

class @aws-cdk/aws-quickstarts.SqlServer(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.QuickStarts;
import software.amazon.awscdk.services.quickstarts.SqlServer;
const { SqlServer } = require('@aws-cdk/aws-quickstarts');
import { SqlServer } from '@aws-cdk/aws-quickstarts';

An instance of Microsoft SQL server with associated security groups

Extends:

@aws-cdk/cdk.Construct

Implements:

@aws-cdk/aws-ec2.IConnectable

Parameters:
connections

Implements @aws-cdk/aws-ec2.IConnectable.connections()

Type:@aws-cdk/aws-ec2.Connections (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

SqlServerProps (interface)

class @aws-cdk/aws-quickstarts.SqlServerProps

Language-specific names:

using Amazon.CDK.AWS.QuickStarts;
import software.amazon.awscdk.services.quickstarts.SqlServerProps;
// SqlServerProps is an interface
import { SqlServerProps } from '@aws-cdk/aws-quickstarts';
masterPassword
Type:string
masterUsername
Type:string
vpc
Type:@aws-cdk/aws-ec2.IVpcNetwork
allocatedStorage
Type:number (optional)
engine
Type:string (optional)
engineVersion
Type:string (optional)
instanceClass
Type:string (optional)
licenseModel
Type:string (optional)