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

AWS::OpsWorksCM Construct Library

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

import opsworkscm = require('@aws-cdk/aws-opsworkscm');

Reference

View in Nuget

csproj:

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

dotnet:

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

packages.config:

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

View in Maven Central

Apache Buildr:

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

Apache Ivy:

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

Apache Maven:

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

Gradle / Grails:

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

Groovy Grape:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

CfnServer

class @aws-cdk/aws-opsworkscm.CfnServer(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.OpsWorksCM;
import software.amazon.awscdk.services.opsworkscm.CfnServer;
const { CfnServer } = require('@aws-cdk/aws-opsworkscm');
import { CfnServer } from '@aws-cdk/aws-opsworkscm';
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:CfnServerProps (readonly)
serverArn
Type:string (readonly)
serverEndpoint
Type:string (readonly)
class EngineAttributeProperty

Language-specific names:

using Amazon.CDK.AWS.OpsWorksCM;
import software.amazon.awscdk.services.opsworkscm.CfnServer.EngineAttributeProperty;
// CfnServer.EngineAttributeProperty is an interface
import { CfnServer.EngineAttributeProperty } from '@aws-cdk/aws-opsworkscm';
name

CfnServer.EngineAttributeProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworkscm-server-engineattribute.html#cfn-opsworkscm-server-engineattribute-name

Type:string (optional)
value

CfnServer.EngineAttributeProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworkscm-server-engineattribute.html#cfn-opsworkscm-server-engineattribute-value

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)

CfnServerProps (interface)

class @aws-cdk/aws-opsworkscm.CfnServerProps

Language-specific names:

using Amazon.CDK.AWS.OpsWorksCM;
import software.amazon.awscdk.services.opsworkscm.CfnServerProps;
// CfnServerProps is an interface
import { CfnServerProps } from '@aws-cdk/aws-opsworkscm';
instanceProfileArn

AWS::OpsWorksCM::Server.InstanceProfileArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-instanceprofilearn

Type:string
instanceType

AWS::OpsWorksCM::Server.InstanceType

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

Type:string
serviceRoleArn

AWS::OpsWorksCM::Server.ServiceRoleArn

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

Type:string
associatePublicIpAddress

AWS::OpsWorksCM::Server.AssociatePublicIpAddress

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-associatepublicipaddress

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

AWS::OpsWorksCM::Server.BackupId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-backupid

Type:string (optional)
backupRetentionCount

AWS::OpsWorksCM::Server.BackupRetentionCount

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-backupretentioncount

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

AWS::OpsWorksCM::Server.DisableAutomatedBackup

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-disableautomatedbackup

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

AWS::OpsWorksCM::Server.Engine

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engine

Type:string (optional)
engineAttributes

AWS::OpsWorksCM::Server.EngineAttributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engineattributes

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

AWS::OpsWorksCM::Server.EngineModel

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-enginemodel

Type:string (optional)
engineVersion

AWS::OpsWorksCM::Server.EngineVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engineversion

Type:string (optional)
keyPair

AWS::OpsWorksCM::Server.KeyPair

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-keypair

Type:string (optional)
preferredBackupWindow

AWS::OpsWorksCM::Server.PreferredBackupWindow

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-preferredbackupwindow

Type:string (optional)
preferredMaintenanceWindow

AWS::OpsWorksCM::Server.PreferredMaintenanceWindow

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-preferredmaintenancewindow

Type:string (optional)
securityGroupIds

AWS::OpsWorksCM::Server.SecurityGroupIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-securitygroupids

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

AWS::OpsWorksCM::Server.ServerName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-servername

Type:string (optional)
subnetIds

AWS::OpsWorksCM::Server.SubnetIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-subnetids

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