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

The CDK Construct Library for AWS OpsWorks

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

Reference

View in Nuget

csproj:

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

dotnet:

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

packages.config:

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

View in Maven Central

Apache Buildr:

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

Apache Ivy:

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

Apache Maven:

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

Gradle / Grails:

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

Groovy Grape:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

CfnApp

class @aws-cdk/aws-opsworks.CfnApp(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnApp;
const { CfnApp } = require('@aws-cdk/aws-opsworks');
import { CfnApp } from '@aws-cdk/aws-opsworks';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
appId
Type:string (readonly)
propertyOverrides
Type:CfnAppProps (readonly)
class DataSourceProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnApp.DataSourceProperty;
// CfnApp.DataSourceProperty is an interface
import { CfnApp.DataSourceProperty } from '@aws-cdk/aws-opsworks';
arn

CfnApp.DataSourceProperty.Arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-arn

Type:string (optional)
databaseName

CfnApp.DataSourceProperty.DatabaseName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-databasename

Type:string (optional)
type

CfnApp.DataSourceProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-type

Type:string (optional)
class EnvironmentVariableProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnApp.EnvironmentVariableProperty;
// CfnApp.EnvironmentVariableProperty is an interface
import { CfnApp.EnvironmentVariableProperty } from '@aws-cdk/aws-opsworks';
key

CfnApp.EnvironmentVariableProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#cfn-opsworks-app-environment-key

Type:string
value

CfnApp.EnvironmentVariableProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#value

Type:string
secure

CfnApp.EnvironmentVariableProperty.Secure

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#cfn-opsworks-app-environment-secure

Type:boolean or @aws-cdk/cdk.Token (optional)
class SourceProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnApp.SourceProperty;
// CfnApp.SourceProperty is an interface
import { CfnApp.SourceProperty } from '@aws-cdk/aws-opsworks';
password

CfnApp.SourceProperty.Password

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-pw

Type:string (optional)
revision

CfnApp.SourceProperty.Revision

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-revision

Type:string (optional)
sshKey

CfnApp.SourceProperty.SshKey

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-sshkey

Type:string (optional)
type

CfnApp.SourceProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-type

Type:string (optional)
url

CfnApp.SourceProperty.Url

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-url

Type:string (optional)
username

CfnApp.SourceProperty.Username

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-username

Type:string (optional)
class SslConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnApp.SslConfigurationProperty;
// CfnApp.SslConfigurationProperty is an interface
import { CfnApp.SslConfigurationProperty } from '@aws-cdk/aws-opsworks';
certificate

CfnApp.SslConfigurationProperty.Certificate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-certificate

Type:string (optional)
chain

CfnApp.SslConfigurationProperty.Chain

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-chain

Type:string (optional)
privateKey

CfnApp.SslConfigurationProperty.PrivateKey

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-privatekey

Type:string (optional)
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnAppProps (interface)

class @aws-cdk/aws-opsworks.CfnAppProps

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnAppProps;
// CfnAppProps is an interface
import { CfnAppProps } from '@aws-cdk/aws-opsworks';
name

AWS::OpsWorks::App.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-name

Type:string
stackId

AWS::OpsWorks::App.StackId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-stackid

Type:string
type

AWS::OpsWorks::App.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type

Type:string
appSource

AWS::OpsWorks::App.AppSource

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource

Type:SourceProperty or @aws-cdk/cdk.Token (optional)
attributes

AWS::OpsWorks::App.Attributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
dataSources

AWS::OpsWorks::App.DataSources

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or DataSourceProperty)[] (optional)
description

AWS::OpsWorks::App.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-description

Type:string (optional)
domains

AWS::OpsWorks::App.Domains

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-domains

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
enableSsl

AWS::OpsWorks::App.EnableSsl

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl

Type:boolean or @aws-cdk/cdk.Token (optional)
environment

AWS::OpsWorks::App.Environment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or EnvironmentVariableProperty)[] (optional)
shortname

AWS::OpsWorks::App.Shortname

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-shortname

Type:string (optional)
sslConfiguration

AWS::OpsWorks::App.SslConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration

Type:@aws-cdk/cdk.Token or SslConfigurationProperty (optional)

CfnElasticLoadBalancerAttachment

class @aws-cdk/aws-opsworks.CfnElasticLoadBalancerAttachment(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnElasticLoadBalancerAttachment;
const { CfnElasticLoadBalancerAttachment } = require('@aws-cdk/aws-opsworks');
import { CfnElasticLoadBalancerAttachment } from '@aws-cdk/aws-opsworks';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnElasticLoadBalancerAttachmentProps (readonly)
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnElasticLoadBalancerAttachmentProps (interface)

class @aws-cdk/aws-opsworks.CfnElasticLoadBalancerAttachmentProps

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnElasticLoadBalancerAttachmentProps;
// CfnElasticLoadBalancerAttachmentProps is an interface
import { CfnElasticLoadBalancerAttachmentProps } from '@aws-cdk/aws-opsworks';
elasticLoadBalancerName

AWS::OpsWorks::ElasticLoadBalancerAttachment.ElasticLoadBalancerName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html#cfn-opsworks-elbattachment-elbname

Type:string
layerId

AWS::OpsWorks::ElasticLoadBalancerAttachment.LayerId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html#cfn-opsworks-elbattachment-layerid

Type:string

CfnInstance

class @aws-cdk/aws-opsworks.CfnInstance(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnInstance;
const { CfnInstance } = require('@aws-cdk/aws-opsworks');
import { CfnInstance } from '@aws-cdk/aws-opsworks';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
instanceAvailabilityZone
Type:string (readonly)
instanceId
Type:string (readonly)
instancePrivateDnsName
Type:string (readonly)
instancePrivateIp
Type:string (readonly)
instancePublicDnsName
Type:string (readonly)
instancePublicIp
Type:string (readonly)
propertyOverrides
Type:CfnInstanceProps (readonly)
class BlockDeviceMappingProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnInstance.BlockDeviceMappingProperty;
// CfnInstance.BlockDeviceMappingProperty is an interface
import { CfnInstance.BlockDeviceMappingProperty } from '@aws-cdk/aws-opsworks';
deviceName

CfnInstance.BlockDeviceMappingProperty.DeviceName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-devicename

Type:string (optional)
ebs

CfnInstance.BlockDeviceMappingProperty.Ebs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-ebs

Type:@aws-cdk/cdk.Token or EbsBlockDeviceProperty (optional)
noDevice

CfnInstance.BlockDeviceMappingProperty.NoDevice

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-nodevice

Type:string (optional)
virtualName

CfnInstance.BlockDeviceMappingProperty.VirtualName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-virtualname

Type:string (optional)
class EbsBlockDeviceProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnInstance.EbsBlockDeviceProperty;
// CfnInstance.EbsBlockDeviceProperty is an interface
import { CfnInstance.EbsBlockDeviceProperty } from '@aws-cdk/aws-opsworks';
deleteOnTermination

CfnInstance.EbsBlockDeviceProperty.DeleteOnTermination

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-deleteontermination

Type:boolean or @aws-cdk/cdk.Token (optional)
iops

CfnInstance.EbsBlockDeviceProperty.Iops

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-iops

Type:number or @aws-cdk/cdk.Token (optional)
snapshotId

CfnInstance.EbsBlockDeviceProperty.SnapshotId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-snapshotid

Type:string (optional)
volumeSize

CfnInstance.EbsBlockDeviceProperty.VolumeSize

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumesize

Type:number or @aws-cdk/cdk.Token (optional)
volumeType

CfnInstance.EbsBlockDeviceProperty.VolumeType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumetype

Type:string (optional)
class TimeBasedAutoScalingProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnInstance.TimeBasedAutoScalingProperty;
// CfnInstance.TimeBasedAutoScalingProperty is an interface
import { CfnInstance.TimeBasedAutoScalingProperty } from '@aws-cdk/aws-opsworks';
friday

CfnInstance.TimeBasedAutoScalingProperty.Friday

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-friday

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
monday

CfnInstance.TimeBasedAutoScalingProperty.Monday

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-monday

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
saturday

CfnInstance.TimeBasedAutoScalingProperty.Saturday

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-saturday

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
sunday

CfnInstance.TimeBasedAutoScalingProperty.Sunday

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-sunday

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
thursday

CfnInstance.TimeBasedAutoScalingProperty.Thursday

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-thursday

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
tuesday

CfnInstance.TimeBasedAutoScalingProperty.Tuesday

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-tuesday

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
wednesday

CfnInstance.TimeBasedAutoScalingProperty.Wednesday

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-wednesday

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnInstanceProps (interface)

class @aws-cdk/aws-opsworks.CfnInstanceProps

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnInstanceProps;
// CfnInstanceProps is an interface
import { CfnInstanceProps } from '@aws-cdk/aws-opsworks';
instanceType

AWS::OpsWorks::Instance.InstanceType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-instancetype

Type:string
layerIds

AWS::OpsWorks::Instance.LayerIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-layerids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
stackId

AWS::OpsWorks::Instance.StackId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-stackid

Type:string
agentVersion

AWS::OpsWorks::Instance.AgentVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-agentversion

Type:string (optional)
amiId

AWS::OpsWorks::Instance.AmiId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-amiid

Type:string (optional)
architecture

AWS::OpsWorks::Instance.Architecture

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-architecture

Type:string (optional)
autoScalingType

AWS::OpsWorks::Instance.AutoScalingType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-autoscalingtype

Type:string (optional)
availabilityZone

AWS::OpsWorks::Instance.AvailabilityZone

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-availabilityzone

Type:string (optional)
blockDeviceMappings

AWS::OpsWorks::Instance.BlockDeviceMappings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-blockdevicemappings

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or BlockDeviceMappingProperty)[] (optional)
ebsOptimized

AWS::OpsWorks::Instance.EbsOptimized

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-ebsoptimized

Type:boolean or @aws-cdk/cdk.Token (optional)
elasticIps

AWS::OpsWorks::Instance.ElasticIps

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-elasticips

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
hostname

AWS::OpsWorks::Instance.Hostname

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-hostname

Type:string (optional)
installUpdatesOnBoot

AWS::OpsWorks::Instance.InstallUpdatesOnBoot

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-installupdatesonboot

Type:boolean or @aws-cdk/cdk.Token (optional)
os

AWS::OpsWorks::Instance.Os

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-os

Type:string (optional)
rootDeviceType

AWS::OpsWorks::Instance.RootDeviceType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-rootdevicetype

Type:string (optional)
sshKeyName

AWS::OpsWorks::Instance.SshKeyName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-sshkeyname

Type:string (optional)
subnetId

AWS::OpsWorks::Instance.SubnetId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-subnetid

Type:string (optional)
tenancy

AWS::OpsWorks::Instance.Tenancy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-tenancy

Type:string (optional)
timeBasedAutoScaling

AWS::OpsWorks::Instance.TimeBasedAutoScaling

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-timebasedautoscaling

Type:@aws-cdk/cdk.Token or TimeBasedAutoScalingProperty (optional)
virtualizationType

AWS::OpsWorks::Instance.VirtualizationType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-virtualizationtype

Type:string (optional)
volumes

AWS::OpsWorks::Instance.Volumes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-volumes

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)

CfnLayer

class @aws-cdk/aws-opsworks.CfnLayer(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnLayer;
const { CfnLayer } = require('@aws-cdk/aws-opsworks');
import { CfnLayer } from '@aws-cdk/aws-opsworks';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
layerId
Type:string (readonly)
propertyOverrides
Type:CfnLayerProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class AutoScalingThresholdsProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnLayer.AutoScalingThresholdsProperty;
// CfnLayer.AutoScalingThresholdsProperty is an interface
import { CfnLayer.AutoScalingThresholdsProperty } from '@aws-cdk/aws-opsworks';
cpuThreshold

CfnLayer.AutoScalingThresholdsProperty.CpuThreshold

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-cputhreshold

Type:number or @aws-cdk/cdk.Token (optional)
ignoreMetricsTime

CfnLayer.AutoScalingThresholdsProperty.IgnoreMetricsTime

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-ignoremetricstime

Type:number or @aws-cdk/cdk.Token (optional)
instanceCount

CfnLayer.AutoScalingThresholdsProperty.InstanceCount

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-instancecount

Type:number or @aws-cdk/cdk.Token (optional)
loadThreshold

CfnLayer.AutoScalingThresholdsProperty.LoadThreshold

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-loadthreshold

Type:number or @aws-cdk/cdk.Token (optional)
memoryThreshold

CfnLayer.AutoScalingThresholdsProperty.MemoryThreshold

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-memorythreshold

Type:number or @aws-cdk/cdk.Token (optional)
thresholdsWaitTime

CfnLayer.AutoScalingThresholdsProperty.ThresholdsWaitTime

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-thresholdwaittime

Type:number or @aws-cdk/cdk.Token (optional)
class LifecycleEventConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnLayer.LifecycleEventConfigurationProperty;
// CfnLayer.LifecycleEventConfigurationProperty is an interface
import { CfnLayer.LifecycleEventConfigurationProperty } from '@aws-cdk/aws-opsworks';
shutdownEventConfiguration

CfnLayer.LifecycleEventConfigurationProperty.ShutdownEventConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration

Type:@aws-cdk/cdk.Token or ShutdownEventConfigurationProperty (optional)
class LoadBasedAutoScalingProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnLayer.LoadBasedAutoScalingProperty;
// CfnLayer.LoadBasedAutoScalingProperty is an interface
import { CfnLayer.LoadBasedAutoScalingProperty } from '@aws-cdk/aws-opsworks';
downScaling

CfnLayer.LoadBasedAutoScalingProperty.DownScaling

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-downscaling

Type:@aws-cdk/cdk.Token or AutoScalingThresholdsProperty (optional)
enable

CfnLayer.LoadBasedAutoScalingProperty.Enable

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-enable

Type:boolean or @aws-cdk/cdk.Token (optional)
upScaling

CfnLayer.LoadBasedAutoScalingProperty.UpScaling

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-upscaling

Type:@aws-cdk/cdk.Token or AutoScalingThresholdsProperty (optional)
class RecipesProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnLayer.RecipesProperty;
// CfnLayer.RecipesProperty is an interface
import { CfnLayer.RecipesProperty } from '@aws-cdk/aws-opsworks';
configure

CfnLayer.RecipesProperty.Configure

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-configure

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
deploy

CfnLayer.RecipesProperty.Deploy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-deploy

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
setup

CfnLayer.RecipesProperty.Setup

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-setup

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
shutdown

CfnLayer.RecipesProperty.Shutdown

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-shutdown

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
undeploy

CfnLayer.RecipesProperty.Undeploy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-undeploy

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class ShutdownEventConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnLayer.ShutdownEventConfigurationProperty;
// CfnLayer.ShutdownEventConfigurationProperty is an interface
import { CfnLayer.ShutdownEventConfigurationProperty } from '@aws-cdk/aws-opsworks';
delayUntilElbConnectionsDrained

CfnLayer.ShutdownEventConfigurationProperty.DelayUntilElbConnectionsDrained

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration-delayuntilelbconnectionsdrained

Type:boolean or @aws-cdk/cdk.Token (optional)
executionTimeout

CfnLayer.ShutdownEventConfigurationProperty.ExecutionTimeout

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration-executiontimeout

Type:number or @aws-cdk/cdk.Token (optional)
class VolumeConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnLayer.VolumeConfigurationProperty;
// CfnLayer.VolumeConfigurationProperty is an interface
import { CfnLayer.VolumeConfigurationProperty } from '@aws-cdk/aws-opsworks';
encrypted

CfnLayer.VolumeConfigurationProperty.Encrypted

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-encrypted

Type:boolean or @aws-cdk/cdk.Token (optional)
iops

CfnLayer.VolumeConfigurationProperty.Iops

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-iops

Type:number or @aws-cdk/cdk.Token (optional)
mountPoint

CfnLayer.VolumeConfigurationProperty.MountPoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-mountpoint

Type:string (optional)
numberOfDisks

CfnLayer.VolumeConfigurationProperty.NumberOfDisks

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-numberofdisks

Type:number or @aws-cdk/cdk.Token (optional)
raidLevel

CfnLayer.VolumeConfigurationProperty.RaidLevel

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-raidlevel

Type:number or @aws-cdk/cdk.Token (optional)
size

CfnLayer.VolumeConfigurationProperty.Size

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-size

Type:number or @aws-cdk/cdk.Token (optional)
volumeType

CfnLayer.VolumeConfigurationProperty.VolumeType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-volumetype

Type:string (optional)
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnLayerProps (interface)

class @aws-cdk/aws-opsworks.CfnLayerProps

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnLayerProps;
// CfnLayerProps is an interface
import { CfnLayerProps } from '@aws-cdk/aws-opsworks';
autoAssignElasticIps

AWS::OpsWorks::Layer.AutoAssignElasticIps

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignelasticips

Type:boolean or @aws-cdk/cdk.Token
autoAssignPublicIps

AWS::OpsWorks::Layer.AutoAssignPublicIps

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignpublicips

Type:boolean or @aws-cdk/cdk.Token
enableAutoHealing

AWS::OpsWorks::Layer.EnableAutoHealing

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-enableautohealing

Type:boolean or @aws-cdk/cdk.Token
name

AWS::OpsWorks::Layer.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-name

Type:string
shortname

AWS::OpsWorks::Layer.Shortname

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-shortname

Type:string
stackId

AWS::OpsWorks::Layer.StackId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-stackid

Type:string
type

AWS::OpsWorks::Layer.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-type

Type:string
attributes

AWS::OpsWorks::Layer.Attributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-attributes

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
customInstanceProfileArn

AWS::OpsWorks::Layer.CustomInstanceProfileArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-custominstanceprofilearn

Type:string (optional)
customJson

AWS::OpsWorks::Layer.CustomJson

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customjson

Type:json or @aws-cdk/cdk.Token (optional)
customRecipes

AWS::OpsWorks::Layer.CustomRecipes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customrecipes

Type:@aws-cdk/cdk.Token or RecipesProperty (optional)
customSecurityGroupIds

AWS::OpsWorks::Layer.CustomSecurityGroupIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customsecuritygroupids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
installUpdatesOnBoot

AWS::OpsWorks::Layer.InstallUpdatesOnBoot

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-installupdatesonboot

Type:boolean or @aws-cdk/cdk.Token (optional)
lifecycleEventConfiguration

AWS::OpsWorks::Layer.LifecycleEventConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-lifecycleeventconfiguration

Type:@aws-cdk/cdk.Token or LifecycleEventConfigurationProperty (optional)
loadBasedAutoScaling

AWS::OpsWorks::Layer.LoadBasedAutoScaling

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-loadbasedautoscaling

Type:@aws-cdk/cdk.Token or LoadBasedAutoScalingProperty (optional)
packages

AWS::OpsWorks::Layer.Packages

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-packages

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
tags

AWS::OpsWorks::Layer.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)
useEbsOptimizedInstances

AWS::OpsWorks::Layer.UseEbsOptimizedInstances

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-useebsoptimizedinstances

Type:boolean or @aws-cdk/cdk.Token (optional)
volumeConfigurations

AWS::OpsWorks::Layer.VolumeConfigurations

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-volumeconfigurations

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or VolumeConfigurationProperty)[] (optional)

CfnStack

class @aws-cdk/aws-opsworks.CfnStack(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnStack;
const { CfnStack } = require('@aws-cdk/aws-opsworks');
import { CfnStack } from '@aws-cdk/aws-opsworks';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnStackProps (readonly)
stackId
Type:string (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class ChefConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnStack.ChefConfigurationProperty;
// CfnStack.ChefConfigurationProperty is an interface
import { CfnStack.ChefConfigurationProperty } from '@aws-cdk/aws-opsworks';
berkshelfVersion

CfnStack.ChefConfigurationProperty.BerkshelfVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-chefconfiguration-berkshelfversion

Type:string (optional)
manageBerkshelf

CfnStack.ChefConfigurationProperty.ManageBerkshelf

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-chefconfiguration-berkshelfversion

Type:boolean or @aws-cdk/cdk.Token (optional)
class ElasticIpProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnStack.ElasticIpProperty;
// CfnStack.ElasticIpProperty is an interface
import { CfnStack.ElasticIpProperty } from '@aws-cdk/aws-opsworks';
ip

CfnStack.ElasticIpProperty.Ip

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-ip

Type:string
name

CfnStack.ElasticIpProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-name

Type:string (optional)
class RdsDbInstanceProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnStack.RdsDbInstanceProperty;
// CfnStack.RdsDbInstanceProperty is an interface
import { CfnStack.RdsDbInstanceProperty } from '@aws-cdk/aws-opsworks';
dbPassword

CfnStack.RdsDbInstanceProperty.DbPassword

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbpassword

Type:string
dbUser

CfnStack.RdsDbInstanceProperty.DbUser

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbuser

Type:string
rdsDbInstanceArn

CfnStack.RdsDbInstanceProperty.RdsDbInstanceArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-rdsdbinstancearn

Type:string
class SourceProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnStack.SourceProperty;
// CfnStack.SourceProperty is an interface
import { CfnStack.SourceProperty } from '@aws-cdk/aws-opsworks';
password

CfnStack.SourceProperty.Password

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-password

Type:string (optional)
revision

CfnStack.SourceProperty.Revision

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-revision

Type:string (optional)
sshKey

CfnStack.SourceProperty.SshKey

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-sshkey

Type:string (optional)
type

CfnStack.SourceProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-type

Type:string (optional)
url

CfnStack.SourceProperty.Url

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-url

Type:string (optional)
username

CfnStack.SourceProperty.Username

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-username

Type:string (optional)
class StackConfigurationManagerProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnStack.StackConfigurationManagerProperty;
// CfnStack.StackConfigurationManagerProperty is an interface
import { CfnStack.StackConfigurationManagerProperty } from '@aws-cdk/aws-opsworks';
name

CfnStack.StackConfigurationManagerProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html#cfn-opsworks-configmanager-name

Type:string (optional)
version

CfnStack.StackConfigurationManagerProperty.Version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html#cfn-opsworks-configmanager-version

Type:string (optional)
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnStackProps (interface)

class @aws-cdk/aws-opsworks.CfnStackProps

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnStackProps;
// CfnStackProps is an interface
import { CfnStackProps } from '@aws-cdk/aws-opsworks';
defaultInstanceProfileArn

AWS::OpsWorks::Stack.DefaultInstanceProfileArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultinstanceprof

Type:string
name

AWS::OpsWorks::Stack.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-name

Type:string
serviceRoleArn

AWS::OpsWorks::Stack.ServiceRoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-servicerolearn

Type:string
agentVersion

AWS::OpsWorks::Stack.AgentVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-agentversion

Type:string (optional)
attributes

AWS::OpsWorks::Stack.Attributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-attributes

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
chefConfiguration

AWS::OpsWorks::Stack.ChefConfiguration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-chefconfiguration

Type:@aws-cdk/cdk.Token or ChefConfigurationProperty (optional)
cloneAppIds

AWS::OpsWorks::Stack.CloneAppIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-cloneappids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
clonePermissions

AWS::OpsWorks::Stack.ClonePermissions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-clonepermissions

Type:boolean or @aws-cdk/cdk.Token (optional)
configurationManager

AWS::OpsWorks::Stack.ConfigurationManager

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-configmanager

Type:@aws-cdk/cdk.Token or StackConfigurationManagerProperty (optional)
customCookbooksSource

AWS::OpsWorks::Stack.CustomCookbooksSource

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custcookbooksource

Type:@aws-cdk/cdk.Token or SourceProperty (optional)
customJson

AWS::OpsWorks::Stack.CustomJson

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custjson

Type:json or @aws-cdk/cdk.Token (optional)
defaultAvailabilityZone

AWS::OpsWorks::Stack.DefaultAvailabilityZone

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultaz

Type:string (optional)
defaultOs

AWS::OpsWorks::Stack.DefaultOs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultos

Type:string (optional)
defaultRootDeviceType

AWS::OpsWorks::Stack.DefaultRootDeviceType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultrootdevicetype

Type:string (optional)
defaultSshKeyName

AWS::OpsWorks::Stack.DefaultSshKeyName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultsshkeyname

Type:string (optional)
defaultSubnetId

AWS::OpsWorks::Stack.DefaultSubnetId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#defaultsubnet

Type:string (optional)
ecsClusterArn

AWS::OpsWorks::Stack.EcsClusterArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-ecsclusterarn

Type:string (optional)
elasticIps

AWS::OpsWorks::Stack.ElasticIps

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-elasticips

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ElasticIpProperty)[] (optional)
hostnameTheme

AWS::OpsWorks::Stack.HostnameTheme

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-hostnametheme

Type:string (optional)
rdsDbInstances

AWS::OpsWorks::Stack.RdsDbInstances

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-rdsdbinstances

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or RdsDbInstanceProperty)[] (optional)
sourceStackId

AWS::OpsWorks::Stack.SourceStackId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-sourcestackid

Type:string (optional)
tags

AWS::OpsWorks::Stack.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)
useCustomCookbooks

AWS::OpsWorks::Stack.UseCustomCookbooks

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#usecustcookbooks

Type:boolean or @aws-cdk/cdk.Token (optional)
useOpsworksSecurityGroups

AWS::OpsWorks::Stack.UseOpsworksSecurityGroups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-useopsworkssecuritygroups

Type:boolean or @aws-cdk/cdk.Token (optional)
vpcId

AWS::OpsWorks::Stack.VpcId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-vpcid

Type:string (optional)

CfnUserProfile

class @aws-cdk/aws-opsworks.CfnUserProfile(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnUserProfile;
const { CfnUserProfile } = require('@aws-cdk/aws-opsworks');
import { CfnUserProfile } from '@aws-cdk/aws-opsworks';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnUserProfileProps (readonly)
userProfileArn
Type:string (readonly)
userProfileSshUsername
Type:string (readonly)
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnUserProfileProps (interface)

class @aws-cdk/aws-opsworks.CfnUserProfileProps

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnUserProfileProps;
// CfnUserProfileProps is an interface
import { CfnUserProfileProps } from '@aws-cdk/aws-opsworks';
iamUserArn

AWS::OpsWorks::UserProfile.IamUserArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-iamuserarn

Type:string
allowSelfManagement

AWS::OpsWorks::UserProfile.AllowSelfManagement

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-allowselfmanagement

Type:boolean or @aws-cdk/cdk.Token (optional)
sshPublicKey

AWS::OpsWorks::UserProfile.SshPublicKey

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshpublickey

Type:string (optional)
sshUsername

AWS::OpsWorks::UserProfile.SshUsername

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshusername

Type:string (optional)

CfnVolume

class @aws-cdk/aws-opsworks.CfnVolume(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnVolume;
const { CfnVolume } = require('@aws-cdk/aws-opsworks');
import { CfnVolume } from '@aws-cdk/aws-opsworks';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnVolumeProps (readonly)
volumeId
Type:string (readonly)
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)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnVolumeProps (interface)

class @aws-cdk/aws-opsworks.CfnVolumeProps

Language-specific names:

using Amazon.CDK.AWS.OpsWorks;
import software.amazon.awscdk.services.opsworks.CfnVolumeProps;
// CfnVolumeProps is an interface
import { CfnVolumeProps } from '@aws-cdk/aws-opsworks';
ec2VolumeId

AWS::OpsWorks::Volume.Ec2VolumeId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-ec2volumeid

Type:string
stackId

AWS::OpsWorks::Volume.StackId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-stackid

Type:string
mountPoint

AWS::OpsWorks::Volume.MountPoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-mountpoint

Type:string (optional)
name

AWS::OpsWorks::Volume.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-name

Type:string (optional)