cdk-ans

This package contains the core code to define Ansible playbooks as CDK.

It is part of the larger repo cdk-ans where documentation can be found.

API Reference

Constructs

App

Represents a cdk-ans application.

Initializers

import { App } from 'cdk-ans'

new App(props?: AppProps)

Name	Type	Description
props	AppProps	configuration options.

---

props^Optional

• Type: AppProps

configuration options.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synth	Synthesizes all resources to the output directory.

---

toString

public toString(): string

Returns a string representation of this construct.

synth

public synth(): void

Synthesizes all resources to the output directory.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { App } from 'cdk-ans'

App.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
inventories	Inventory[]	Returns all the inventories in this app, sorted topologically.
outdir	string	The output directory into which files will be synthesized.
playbooks	Playbook[]	Returns all the playbooks in this app, sorted topologically.
projects	Project[]	Returns all the playbooks in this app, sorted topologically.
roles	Role[]	Returns all the roles in this app, sorted topologically.
synthesizer	ISynthesizer	The synthesizer that will be used to synthesize the project.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

inventories^Required

public readonly inventories: Inventory[];

• Type: Inventory[]

Returns all the inventories in this app, sorted topologically.

---

outdir^Required

public readonly outdir: string;

• Type: string

The output directory into which files will be synthesized.

---

playbooks^Required

public readonly playbooks: Playbook[];

• Type: Playbook[]

Returns all the playbooks in this app, sorted topologically.

---

projects^Required

public readonly projects: Project[];

• Type: Project[]

Returns all the playbooks in this app, sorted topologically.

---

roles^Required

public readonly roles: Role[];

• Type: Role[]

Returns all the roles in this app, sorted topologically.

---

synthesizer^Required

public readonly synthesizer: ISynthesizer;

• Type: ISynthesizer

The synthesizer that will be used to synthesize the project.

---

Block

• Implements: ITaskChainable

Initializers

import { Block } from 'cdk-ans'

new Block(scope: Construct, name: string, props: BlockProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	BlockProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: BlockProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
toJson	No description.
next	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

toJson

public toJson(): any

next

public next(next: ITaskChainable): TaskDefinition

next^Required

• Type: ITaskChainable

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Block } from 'cdk-ans'

Block.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
chain	Step[]	No description.
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.
tasks	TaskDefinition	No description.
always	TaskDefinition	No description.
notify	Handler[]	No description.
rescue	TaskDefinition	No description.
when	Conditional	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

name^Required

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

tasks^Required

public readonly tasks: TaskDefinition;

• Type: TaskDefinition

---

always^Optional

public readonly always: TaskDefinition;

• Type: TaskDefinition

---

notify^Optional

public readonly notify: Handler[];

• Type: Handler[]

---

rescue^Optional

public readonly rescue: TaskDefinition;

• Type: TaskDefinition

---

when^Optional

public readonly when: Conditional;

• Type: Conditional

---

File

Initializers

import { File } from 'cdk-ans'

new File(scope: Construct, name: string, props: FileProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	FileProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: FileProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { File } from 'cdk-ans'

File.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
fileName	string	No description.
path	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

fileName^Required

public readonly fileName: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

Handler

Initializers

import { Handler } from 'cdk-ans'

new Handler(scope: Construct, name: string, props: HandlerProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	HandlerProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: HandlerProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
toJson	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

toJson

public toJson(): any

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Handler } from 'cdk-ans'

Handler.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
chain	Step[]	No description.
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.
action	TaskAction	No description.
listen	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

name^Required

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

action^Required

public readonly action: TaskAction;

• Type: TaskAction

---

listen^Optional

public readonly listen: string;

• Type: string

---

Host

• Implements: IHostIdentifiable

Represents a host in an Ansible inventory.

https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#inventory-basics-formats-hosts-and-groups

Initializers

import { Host } from 'cdk-ans'

new Host(scope: Construct, name: string, props: HostProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	HostProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: HostProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addVariables	Assigns additional variables to this host.
toJson	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addVariables

public addVariables(variables: HostVariable): void

Assigns additional variables to this host.

variables^Required

• Type: HostVariable

A list of variables to add to this host.

---

toJson

public toJson(): {[ key: string ]: any}

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isHost	Return whether the given object is a Host.

---

isConstruct

import { Host } from 'cdk-ans'

Host.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

isHost

import { Host } from 'cdk-ans'

Host.isHost(x: any)

Return whether the given object is a Host.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
ansibleConnection	AnsibleConnection	No description.
ansibleHost	string	No description.
identifier	string	No description.
variables	HostVariable[]	No description.
ansibleBecome	boolean	No description.
ansiblePassword	string	No description.
ansiblePort	number	No description.
ansibleUser	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

ansibleConnection^Required

public readonly ansibleConnection: AnsibleConnection;

• Type: AnsibleConnection

---

ansibleHost^Required

public readonly ansibleHost: string;

• Type: string

---

identifier^Required

public readonly identifier: string;

• Type: string

---

variables^Required

public readonly variables: HostVariable[];

• Type: HostVariable[]

---

ansibleBecome^Optional

public readonly ansibleBecome: boolean;

• Type: boolean

---

ansiblePassword^Optional

public readonly ansiblePassword: string;

• Type: string

---

ansiblePort^Optional

public readonly ansiblePort: number;

• Type: number

---

ansibleUser^Optional

public readonly ansibleUser: string;

• Type: string

---

HostGroup

• Implements: IHostIdentifiable

A group of hosts in an Ansible inventory.

https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html#inventory-basics-formats-hosts-and-groups

Initializers

import { HostGroup } from 'cdk-ans'

new HostGroup(scope: Construct, name: string, props?: HostGroupProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	HostGroupProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Optional

• Type: HostGroupProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addHosts	Assigns additional hosts to this group.
addSubGroups	Assigns additional groups as subgroups to this group.
addVariables	Assigns additional variables to this group.
toJson	JSONify this group.

---

toString

public toString(): string

Returns a string representation of this construct.

addHosts

public addHosts(hosts: Host): void

Assigns additional hosts to this group.

hosts^Required

• Type: Host

A list of hosts to add to this group.

---

addSubGroups

public addSubGroups(groups: HostGroup): void

Assigns additional groups as subgroups to this group.

groups^Required

• Type: HostGroup

A list of groups to add as subgroups to this group.

---

addVariables

public addVariables(variables: HostVariable): void

Assigns additional variables to this group.

variables^Required

• Type: HostVariable

A list of variables to add to this group.

---

toJson

public toJson(): {[ key: string ]: any}

JSONify this group.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { HostGroup } from 'cdk-ans'

HostGroup.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
groups	{[ key: string ]: HostGroup}	No description.
hosts	Host[]	No description.
identifier	string	No description.
variables	HostVariable[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

groups^Required

public readonly groups: {[ key: string ]: HostGroup};

• Type: {[ key: string ]: HostGroup}

---

hosts^Required

public readonly hosts: Host[];

• Type: Host[]

---

identifier^Required

public readonly identifier: string;

• Type: string

---

variables^Required

public readonly variables: HostVariable[];

• Type: HostVariable[]

---

HostVariable

• Implements: IVariable

Initializers

import { HostVariable } from 'cdk-ans'

new HostVariable(scope: Construct, id: string, props: HostVariableProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	HostVariableProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: HostVariableProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
asRaw	Returns the variable as a raw string.
asVariable	Returns the variable as an ansible variable string {{ variable }}.
index	No description.
property	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

asRaw

public asRaw(): string

Returns the variable as a raw string.

asVariable

public asVariable(): string

Returns the variable as an ansible variable string {{ variable }}.

index

public index(_: number): IVariable

_^Required

• Type: number

---

property

public property(_: string): IVariable

_^Required

• Type: string

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { HostVariable } from 'cdk-ans'

HostVariable.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
name	string	No description.
value	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

name^Required

public readonly name: string;

• Type: string

---

value^Required

public readonly value: string;

• Type: string

---

Inventory

Represents an Ansible inventory.

https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html#inventory-basics-formats-hosts-and-groups

Initializers

import { Inventory } from 'cdk-ans'

new Inventory(scope: Construct, name: string, props: InventoryProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	InventoryProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: InventoryProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Inventory } from 'cdk-ans'

Inventory.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
groups	HostGroup[]	No description.
hosts	Host[]	No description.
name	string	No description.
variables	HostVariable[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

groups^Required

public readonly groups: HostGroup[];

• Type: HostGroup[]

---

hosts^Required

public readonly hosts: Host[];

• Type: Host[]

---

name^Required

public readonly name: string;

• Type: string

---

variables^Required

public readonly variables: HostVariable[];

• Type: HostVariable[]

---

Play

• Implements: IPlayChainable

A play is a collection of tasks and metadata to execute on a set of hosts.

Plays are chainable together to create a playbook

https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html#play

Initializers

import { Play } from 'cdk-ans'

new Play(scope: Construct, name: string, props: PlayProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	PlayProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: PlayProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
toJson	No description.
flattenHosts	No description.
next	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

toJson

public toJson(): any

flattenHosts

public flattenHosts(): string[]

next

public next(next: IPlayChainable): PlayDefinition

next^Required

• Type: IPlayChainable

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Play } from 'cdk-ans'

Play.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
chain	Step[]	No description.
name	string	No description.
hosts	IHostIdentifiable[]	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
factPath	string	No description.
forceHandlers	boolean	No description.
gatherFacts	boolean	No description.
gatherSubset	string	No description.
gatherTimeout	number	No description.
handlers	Handler[]	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
maxFailPercentage	number	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
order	PlayHostOrder	No description.
port	number	No description.
postTasks	TaskDefinition	No description.
preTasks	TaskDefinition	No description.
remoteUser	string	No description.
roles	RoleDefinition	No description.
runOnce	boolean	No description.
serial	number	No description.
strategy	string	No description.
tags	string[]	No description.
tasks	TaskDefinition	No description.
throttle	number	No description.
timeout	number	No description.
varPrompt	string[]	No description.
vars	{[ key: string ]: any}	No description.
varsFiles	string[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

name^Required

public readonly name: string;

• Type: string

---

hosts^Required

public readonly hosts: IHostIdentifiable[];

• Type: IHostIdentifiable[]

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

factPath^Optional

public readonly factPath: string;

• Type: string

---

forceHandlers^Optional

public readonly forceHandlers: boolean;

• Type: boolean

---

gatherFacts^Optional

public readonly gatherFacts: boolean;

• Type: boolean

---

gatherSubset^Optional

public readonly gatherSubset: string;

• Type: string

---

gatherTimeout^Optional

public readonly gatherTimeout: number;

• Type: number

---

handlers^Optional

public readonly handlers: Handler[];

• Type: Handler[]

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

maxFailPercentage^Optional

public readonly maxFailPercentage: number;

• Type: number

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

order^Optional

public readonly order: PlayHostOrder;

• Type: PlayHostOrder

---

port^Optional

public readonly port: number;

• Type: number

---

postTasks^Optional

public readonly postTasks: TaskDefinition;

• Type: TaskDefinition

---

preTasks^Optional

public readonly preTasks: TaskDefinition;

• Type: TaskDefinition

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

roles^Optional

public readonly roles: RoleDefinition;

• Type: RoleDefinition

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

serial^Optional

public readonly serial: number;

• Type: number

---

strategy^Optional

public readonly strategy: string;

• Type: string

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

tasks^Optional

public readonly tasks: TaskDefinition;

• Type: TaskDefinition

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

varPrompt^Optional

public readonly varPrompt: string[];

• Type: string[]

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

varsFiles^Optional

public readonly varsFiles: string[];

• Type: string[]

---

Playbook

Initializers

import { Playbook } from 'cdk-ans'

new Playbook(scope: Construct, name: string, props: PlaybookProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	PlaybookProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: PlaybookProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
toJson	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

toJson

public toJson(): any[]

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Playbook } from 'cdk-ans'

Playbook.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
name	string	No description.
playDefinition	PlayDefinition	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

name^Required

public readonly name: string;

• Type: string

---

playDefinition^Required

public readonly playDefinition: PlayDefinition;

• Type: PlayDefinition

---

Project

Initializers

import { Project } from 'cdk-ans'

new Project(scope: Construct, name: string, props?: ProjectProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	ProjectProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Optional

• Type: ProjectProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Project } from 'cdk-ans'

Project.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
inventories	Inventory[]	No description.
name	string	No description.
playbooks	Playbook[]	No description.
roles	Role[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

inventories^Required

public readonly inventories: Inventory[];

• Type: Inventory[]

---

name^Required

public readonly name: string;

• Type: string

---

playbooks^Required

public readonly playbooks: Playbook[];

• Type: Playbook[]

---

roles^Required

public readonly roles: Role[];

• Type: Role[]

---

Resource

Initializers

import { Resource } from 'cdk-ans'

new Resource(scope: Construct, name: string)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Resource } from 'cdk-ans'

Resource.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

Role

Initializers

import { Role } from 'cdk-ans'

new Role(scope: Construct, name: string, props: RoleProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	RoleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: RoleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addDefaultVariables	No description.
addFile	No description.
addHandler	No description.
addTask	No description.
addTemplate	No description.
addVariables	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addDefaultVariables

public addDefaultVariables(variables: {[ key: string ]: any}): void

variables^Required

• Type: {[ key: string ]: any}

---

addFile

public addFile(file: File): void

file^Required

• Type: File

---

addHandler

public addHandler(handler: Handler): void

handler^Required

• Type: Handler

---

addTask

public addTask(task: Task): void

task^Required

• Type: Task

---

addTemplate

public addTemplate(template: TemplateFile): void

template^Required

• Type: TemplateFile

---

addVariables

public addVariables(variables: {[ key: string ]: any}): void

variables^Required

• Type: {[ key: string ]: any}

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Role } from 'cdk-ans'

Role.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
defaults	{[ key: string ]: any}	No description.
files	File[]	No description.
handlers	Handler[]	No description.
name	string	No description.
tasks	TaskDefinition	No description.
templates	TemplateFile[]	No description.
variables	{[ key: string ]: any}	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

defaults^Required

public readonly defaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

files^Required

public readonly files: File[];

• Type: File[]

---

handlers^Required

public readonly handlers: Handler[];

• Type: Handler[]

---

name^Required

public readonly name: string;

• Type: string

---

tasks^Required

public readonly tasks: TaskDefinition;

• Type: TaskDefinition

---

templates^Required

public readonly templates: TemplateFile[];

• Type: TemplateFile[]

---

variables^Required

public readonly variables: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

RoleTarget

• Implements: IRoleChainable

Represents a targetted role for use within a playbook.

https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html#role

Methods

Name	Description
toString	Returns a string representation of this construct.
toJson	No description.
next	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

toJson

public toJson(): any

next

public next(next: IRoleChainable): RoleDefinition

next^Required

• Type: IRoleChainable

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
fromRole	Creates a role target from a role.

---

isConstruct

import { RoleTarget } from 'cdk-ans'

RoleTarget.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

fromRole

import { RoleTarget } from 'cdk-ans'

RoleTarget.fromRole(scope: Construct, id: string, role: Role, props?: RoleTargetProps)

Creates a role target from a role.

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

role^Required

• Type: Role

---

props^Optional

• Type: RoleTargetProps

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
chain	Step[]	No description.
name	string	No description.
role	Role	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
delegateFacts	boolean	No description.
delegateTo	string	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.
when	Conditional	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

name^Required

public readonly name: string;

• Type: string

---

role^Required

public readonly role: Role;

• Type: Role

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

delegateFacts^Optional

public readonly delegateFacts: boolean;

• Type: boolean

---

delegateTo^Optional

public readonly delegateTo: string;

• Type: string

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

when^Optional

public readonly when: Conditional;

• Type: Conditional

---

Step

Initializers

import { Step } from 'cdk-ans'

new Step(scope: Construct, name: string, props: StepProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	StepProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: StepProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
toJson	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

toJson

public toJson(): any

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Step } from 'cdk-ans'

Step.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
chain	Step[]	No description.
name	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

name^Required

public readonly name: string;

• Type: string

---

Task

• Implements: ITaskChainable

Initializers

import { Task } from 'cdk-ans'

new Task(scope: Construct, name: string, props: TaskProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	TaskProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: TaskProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
toJson	No description.
next	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

toJson

public toJson(): any

next

public next(next: ITaskChainable): TaskDefinition

next^Required

• Type: ITaskChainable

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Task } from 'cdk-ans'

Task.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
chain	Step[]	No description.
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.
action	TaskAction	No description.
args	{[ key: string ]: any}	No description.
async	number	No description.
changedWhen	string	No description.
delay	number	No description.
delegateFacts	boolean	No description.
delegateTo	string	No description.
failedWhen	Conditional[]	No description.
localAction	string	No description.
loop	string | string[]	No description.
loopControl	{[ key: string ]: any}	No description.
notify	Handler[]	No description.
poll	number	No description.
register	string	No description.
retries	number	No description.
until	string	No description.
when	Conditional	No description.
with	string[]	No description.
withItems	{[ key: string ]: any}[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

name^Required

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

action^Required

public readonly action: TaskAction;

• Type: TaskAction

---

args^Optional

public readonly args: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

async^Optional

public readonly async: number;

• Type: number

---

changedWhen^Optional

public readonly changedWhen: string;

• Type: string

---

delay^Optional

public readonly delay: number;

• Type: number

---

delegateFacts^Optional

public readonly delegateFacts: boolean;

• Type: boolean

---

delegateTo^Optional

public readonly delegateTo: string;

• Type: string

---

failedWhen^Optional

public readonly failedWhen: Conditional[];

• Type: Conditional[]

---

localAction^Optional

public readonly localAction: string;

• Type: string

---

loop^Optional

public readonly loop: string | string[];

• Type: string | string[]

---

loopControl^Optional

public readonly loopControl: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

notify^Optional

public readonly notify: Handler[];

• Type: Handler[]

---

poll^Optional

public readonly poll: number;

• Type: number

---

register^Optional

public readonly register: string;

• Type: string

---

retries^Optional

public readonly retries: number;

• Type: number

---

until^Optional

public readonly until: string;

• Type: string

---

when^Optional

public readonly when: Conditional;

• Type: Conditional

---

with^Optional

public readonly with: string[];

• Type: string[]

---

withItems^Optional

public readonly withItems: {[ key: string ]: any}[];

• Type: {[ key: string ]: any}[]

---

TaskBase

Initializers

import { TaskBase } from 'cdk-ans'

new TaskBase(scope: Construct, name: string, props: TaskBaseProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	TaskBaseProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: TaskBaseProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
toJson	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

toJson

public toJson(): any

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { TaskBase } from 'cdk-ans'

TaskBase.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
chain	Step[]	No description.
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

name^Required

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

TemplateFile

Initializers

import { TemplateFile } from 'cdk-ans'

new TemplateFile(scope: Construct, name: string, props: TemplateFileProps)

Name	Type	Description
scope	constructs.Construct	No description.
name	string	No description.
props	TemplateFileProps	No description.

---

scope^Required

• Type: constructs.Construct

---

name^Required

• Type: string

---

props^Required

• Type: TemplateFileProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { TemplateFile } from 'cdk-ans'

TemplateFile.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
fileName	string	No description.
path	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

fileName^Required

public readonly fileName: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

Structs

AppProps

Initializer

import { AppProps } from 'cdk-ans'

const appProps: AppProps = { ... }

Properties

Name	Type	Description
outdir	string	No description.
synthesizer	ISynthesizer	No description.

---

outdir^Optional

public readonly outdir: string;

• Type: string
• Default: CDKANS_OUTDIR if defined, otherwise "dist"

---

synthesizer^Optional

public readonly synthesizer: ISynthesizer;

• Type: ISynthesizer

---

BlockProps

Initializer

import { BlockProps } from 'cdk-ans'

const blockProps: BlockProps = { ... }

Properties

Name	Type	Description
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.
tasks	TaskDefinition	No description.
always	TaskDefinition	No description.
delegateFacts	boolean	No description.
delegateTo	string	No description.
notify	Handler[]	No description.
rescue	TaskDefinition	No description.
when	Conditional	No description.

---

name^Optional

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

tasks^Required

public readonly tasks: TaskDefinition;

• Type: TaskDefinition

---

always^Optional

public readonly always: TaskDefinition;

• Type: TaskDefinition

---

delegateFacts^Optional

public readonly delegateFacts: boolean;

• Type: boolean

---

delegateTo^Optional

public readonly delegateTo: string;

• Type: string

---

notify^Optional

public readonly notify: Handler[];

• Type: Handler[]

---

rescue^Optional

public readonly rescue: TaskDefinition;

• Type: TaskDefinition

---

when^Optional

public readonly when: Conditional;

• Type: Conditional

---

FileProps

Initializer

import { FileProps } from 'cdk-ans'

const fileProps: FileProps = { ... }

Properties

Name	Type	Description
path	string	No description.
fileName	string	No description.

---

path^Required

public readonly path: string;

• Type: string

---

fileName^Optional

public readonly fileName: string;

• Type: string

---

HandlerProps

Initializer

import { HandlerProps } from 'cdk-ans'

const handlerProps: HandlerProps = { ... }

Properties

Name	Type	Description
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.
action	TaskAction	No description.
listen	string	No description.

---

name^Optional

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

action^Required

public readonly action: TaskAction;

• Type: TaskAction

---

listen^Optional

public readonly listen: string;

• Type: string

---

HostGroupProps

Properties for a host group.

Initializer

import { HostGroupProps } from 'cdk-ans'

const hostGroupProps: HostGroupProps = { ... }

Properties

Name	Type	Description
groups	HostGroup[]	Subgroups of this group.
hosts	Host[]	Hosts in this group.
identifier	string	The identifier of the group.
variables	HostVariable[]	Variables that will be set on all hosts in this group.

---

groups^Optional

public readonly groups: HostGroup[];

• Type: HostGroup[]

Subgroups of this group.

---

hosts^Optional

public readonly hosts: Host[];

• Type: Host[]

Hosts in this group.

---

identifier^Optional

public readonly identifier: string;

• Type: string

The identifier of the group.

---

variables^Optional

public readonly variables: HostVariable[];

• Type: HostVariable[]

Variables that will be set on all hosts in this group.

---

HostProps

Configuration for a host in an Ansible inventory.

Initializer

import { HostProps } from 'cdk-ans'

const hostProps: HostProps = { ... }

Properties

Name	Type	Description
host	string	The hostname or IP address of the host.
ansibleBecome	boolean	Whether to become privileged.
ansiblePassword	string	The password to use to connect to the host.
ansiblePort	number	The port to connect to on the remote host.
ansibleUser	string	The user to connect to the host as.
connectionType	AnsibleConnection	The connection type to use to connect to the host.
identifier	string	The identifier of the host on synthesis.
variables	HostVariable[]	Additional variables to set for the host.

---

host^Required

public readonly host: string;

• Type: string

The hostname or IP address of the host.

---

ansibleBecome^Optional

public readonly ansibleBecome: boolean;

• Type: boolean
• Default: no become

Whether to become privileged.

https://docs.ansible.com/ansible/latest/user_guide/become.html

---

ansiblePassword^Optional

public readonly ansiblePassword: string;

• Type: string
• Default: no password

The password to use to connect to the host.

https://docs.ansible.com/ansible/latest/user_guide/connection_details.html#ssh-connection-variables

---

ansiblePort^Optional

public readonly ansiblePort: number;

• Type: number
• Default: the default port for the connection type

The port to connect to on the remote host.

https://docs.ansible.com/ansible/latest/user_guide/connection_details.html#connection-types

---

ansibleUser^Optional

public readonly ansibleUser: string;

• Type: string

The user to connect to the host as.

---

connectionType^Optional

public readonly connectionType: AnsibleConnection;

• Type: AnsibleConnection
• Default: AnsibleConnection.SSH

The connection type to use to connect to the host.

---

identifier^Optional

public readonly identifier: string;

• Type: string
• Default: the construct's id

The identifier of the host on synthesis.

---

variables^Optional

public readonly variables: HostVariable[];

• Type: HostVariable[]

Additional variables to set for the host.

---

HostVariableProps

Initializer

import { HostVariableProps } from 'cdk-ans'

const hostVariableProps: HostVariableProps = { ... }

Properties

Name	Type	Description
name	string	No description.
value	string	No description.

---

name^Required

public readonly name: string;

• Type: string

---

value^Required

public readonly value: string;

• Type: string

---

InventoryProps

Properties for an Ansible inventory.

Initializer

import { InventoryProps } from 'cdk-ans'

const inventoryProps: InventoryProps = { ... }

Properties

Name	Type	Description
groups	HostGroup[]	Groups in the inventory.
hosts	Host[]	Hosts in the inventory.
name	string	The name of the inventory.
variables	HostVariable[]	Inventory level variables that will be set on all hosts.

---

groups^Optional

public readonly groups: HostGroup[];

• Type: HostGroup[]

Groups in the inventory.

---

hosts^Optional

public readonly hosts: Host[];

• Type: Host[]

Hosts in the inventory.

Hosts added here are part of the top level "all" group.

---

name^Optional

public readonly name: string;

• Type: string
• Default: the name of the construct.

The name of the inventory.

---

variables^Optional

public readonly variables: HostVariable[];

• Type: HostVariable[]

Inventory level variables that will be set on all hosts.

https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#adding-variables-to-inventory

---

PlaybookProps

Initializer

import { PlaybookProps } from 'cdk-ans'

const playbookProps: PlaybookProps = { ... }

Properties

Name	Type	Description
playDefinition	PlayDefinition	No description.
name	string	No description.

---

playDefinition^Required

public readonly playDefinition: PlayDefinition;

• Type: PlayDefinition

---

name^Optional

public readonly name: string;

• Type: string

---

PlayProps

Initializer

import { PlayProps } from 'cdk-ans'

const playProps: PlayProps = { ... }

Properties

Name	Type	Description
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.
hosts	IHostIdentifiable[]	No description.
factPath	string	No description.
forceHandlers	boolean	No description.
gatherFacts	boolean	No description.
gatherSubset	string	No description.
gatherTimeout	number	No description.
handlers	Handler[]	No description.
maxFailPercentage	number	No description.
order	PlayHostOrder	No description.
postTasks	TaskDefinition	No description.
preTasks	TaskDefinition	No description.
roles	RoleDefinition	No description.
serial	number	No description.
strategy	string	No description.
tasks	TaskDefinition	No description.
varPrompt	string[]	No description.
varsFiles	string[]	No description.

---

name^Optional

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

hosts^Required

public readonly hosts: IHostIdentifiable[];

• Type: IHostIdentifiable[]

---

factPath^Optional

public readonly factPath: string;

• Type: string

---

forceHandlers^Optional

public readonly forceHandlers: boolean;

• Type: boolean

---

gatherFacts^Optional

public readonly gatherFacts: boolean;

• Type: boolean

---

gatherSubset^Optional

public readonly gatherSubset: string;

• Type: string

---

gatherTimeout^Optional

public readonly gatherTimeout: number;

• Type: number

---

handlers^Optional

public readonly handlers: Handler[];

• Type: Handler[]

---

maxFailPercentage^Optional

public readonly maxFailPercentage: number;

• Type: number

---

order^Optional

public readonly order: PlayHostOrder;

• Type: PlayHostOrder

---

postTasks^Optional

public readonly postTasks: TaskDefinition;

• Type: TaskDefinition

---

preTasks^Optional

public readonly preTasks: TaskDefinition;

• Type: TaskDefinition

---

roles^Optional

public readonly roles: RoleDefinition;

• Type: RoleDefinition

---

serial^Optional

public readonly serial: number;

• Type: number

---

strategy^Optional

public readonly strategy: string;

• Type: string

---

tasks^Optional

public readonly tasks: TaskDefinition;

• Type: TaskDefinition

---

varPrompt^Optional

public readonly varPrompt: string[];

• Type: string[]

---

varsFiles^Optional

public readonly varsFiles: string[];

• Type: string[]

---

ProjectProps

Initializer

import { ProjectProps } from 'cdk-ans'

const projectProps: ProjectProps = { ... }

Properties

Name	Type	Description
name	string	No description.

---

name^Optional

public readonly name: string;

• Type: string

---

ProjectSynthesizerOptions

Options on how the project synthezier should behave when synthesizing a project.

Initializer

import { ProjectSynthesizerOptions } from 'cdk-ans'

const projectSynthesizerOptions: ProjectSynthesizerOptions = { ... }

Properties

Name	Type	Description
inventoryOptions	SynthesizeInventoryOptions	Options on how to synthesize inventories.
playbookOptions	SynthesizePlaybookOptions	Options on how to synthesize playbooks.
roleOptions	SynthesizeRoleOptions	Options on how to synthesize roles.

---

inventoryOptions^Optional

public readonly inventoryOptions: SynthesizeInventoryOptions;

• Type: SynthesizeInventoryOptions

Options on how to synthesize inventories.

---

playbookOptions^Optional

public readonly playbookOptions: SynthesizePlaybookOptions;

• Type: SynthesizePlaybookOptions

Options on how to synthesize playbooks.

---

roleOptions^Optional

public readonly roleOptions: SynthesizeRoleOptions;

• Type: SynthesizeRoleOptions

Options on how to synthesize roles.

---

RoleProps

Initializer

import { RoleProps } from 'cdk-ans'

const roleProps: RoleProps = { ... }

Properties

Name	Type	Description
tasks	TaskDefinition	No description.
defaults	{[ key: string ]: any}	No description.
files	File[]	No description.
handlers	Handler[]	No description.
name	string	No description.
templates	TemplateFile[]	No description.
variables	{[ key: string ]: any}	No description.

---

tasks^Required

public readonly tasks: TaskDefinition;

• Type: TaskDefinition

---

defaults^Optional

public readonly defaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

files^Optional

public readonly files: File[];

• Type: File[]

---

handlers^Optional

public readonly handlers: Handler[];

• Type: Handler[]

---

name^Optional

public readonly name: string;

• Type: string

---

templates^Optional

public readonly templates: TemplateFile[];

• Type: TemplateFile[]

---

variables^Optional

public readonly variables: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

RoleTargetProps

Initializer

import { RoleTargetProps } from 'cdk-ans'

const roleTargetProps: RoleTargetProps = { ... }

Properties

Name	Type	Description
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.
delegateFacts	boolean	No description.
delegateTo	string	No description.
when	Conditional	No description.

---

name^Optional

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

delegateFacts^Optional

public readonly delegateFacts: boolean;

• Type: boolean

---

delegateTo^Optional

public readonly delegateTo: string;

• Type: string

---

when^Optional

public readonly when: Conditional;

• Type: Conditional

---

StepProps

Initializer

import { StepProps } from 'cdk-ans'

const stepProps: StepProps = { ... }

Properties

Name	Type	Description
name	string	No description.

---

name^Optional

public readonly name: string;

• Type: string

---

SynthesizeInventoryOptions

Initializer

import { SynthesizeInventoryOptions } from 'cdk-ans'

const synthesizeInventoryOptions: SynthesizeInventoryOptions = { ... }

Properties

Name	Type	Description
inventoryOutputType	InventoryOutputType	How to organzie inventory output.
outDir	string	Where synthezied roles should be saved.

---

inventoryOutputType^Optional

public readonly inventoryOutputType: InventoryOutputType;

• Type: InventoryOutputType
• Default: InventoryOutputType.SINGLE_FILE

How to organzie inventory output.

---

outDir^Optional

public readonly outDir: string;

• Type: string
• Default: inventories

Where synthezied roles should be saved.

---

SynthesizePlaybookOptions

Initializer

import { SynthesizePlaybookOptions } from 'cdk-ans'

const synthesizePlaybookOptions: SynthesizePlaybookOptions = { ... }

Properties

Name	Type	Description
outDir	string	Where synthezied playbooks should be saved.
playbookOutputType	PlaybookOutputType	How to organzie playbook output.

---

outDir^Optional

public readonly outDir: string;

• Type: string
• Default: projects

Where synthezied playbooks should be saved.

Only used if playbookOutputType is PlaybookOutputType.IN_DIRECTORY

---

playbookOutputType^Optional

public readonly playbookOutputType: PlaybookOutputType;

• Type: PlaybookOutputType
• Default: PlaybookOutputType.IN_ROOT

How to organzie playbook output.

---

SynthesizeRoleOptions

Initializer

import { SynthesizeRoleOptions } from 'cdk-ans'

const synthesizeRoleOptions: SynthesizeRoleOptions = { ... }

Properties

Name	Type	Description
outDir	string	Where synthezied roles should be saved.
roleOutputType	RoleOutputType	How to organzie role output.

---

outDir^Optional

public readonly outDir: string;

• Type: string
• Default: roles

Where synthezied roles should be saved.

---

roleOutputType^Optional

public readonly roleOutputType: RoleOutputType;

• Type: RoleOutputType
• Default: RoleOutputType.STANDARD

How to organzie role output.

---

TaskActionProps

An empty interface TaskActionProps extends from This is a placeholder incase there are base settings ever needed for an Action.

Initializer

import { TaskActionProps } from 'cdk-ans'

const taskActionProps: TaskActionProps = { ... }

TaskBaseProps

Initializer

import { TaskBaseProps } from 'cdk-ans'

const taskBaseProps: TaskBaseProps = { ... }

Properties

Name	Type	Description
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.

---

name^Optional

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

TaskProps

Initializer

import { TaskProps } from 'cdk-ans'

const taskProps: TaskProps = { ... }

Properties

Name	Type	Description
name	string	No description.
anyErrorsFatal	boolean	No description.
become	boolean	No description.
becomeExe	string	No description.
becomeFlags	string	No description.
becomeMethod	string	No description.
becomeUser	string	No description.
checkMode	boolean	No description.
collections	string[]	No description.
connection	string	No description.
debugger	boolean	No description.
diff	boolean	No description.
environment	{[ key: string ]: any}	No description.
ignoreErrors	boolean	No description.
ignoreUnreachable	boolean	No description.
moduleDefaults	{[ key: string ]: any}	No description.
noLog	boolean	No description.
port	number	No description.
remoteUser	string	No description.
runOnce	boolean	No description.
tags	string[]	No description.
throttle	number	No description.
timeout	number	No description.
vars	{[ key: string ]: any}	No description.
action	TaskAction	No description.
args	{[ key: string ]: any}	No description.
async	number	No description.
changedWhen	string	No description.
delay	number	No description.
delegateFacts	boolean	No description.
delegateTo	string	No description.
failedWhen	Conditional[]	No description.
localAction	string	No description.
loop	string | string[]	No description.
loopControl	{[ key: string ]: any}	No description.
notify	Handler[]	No description.
poll	number	No description.
register	string	No description.
retries	number	No description.
until	string	No description.
when	Conditional	No description.
with	string[]	No description.
withItems	{[ key: string ]: any}[]	No description.

---

name^Optional

public readonly name: string;

• Type: string

---

anyErrorsFatal^Optional

public readonly anyErrorsFatal: boolean;

• Type: boolean

---

become^Optional

public readonly become: boolean;

• Type: boolean

---

becomeExe^Optional

public readonly becomeExe: string;

• Type: string

---

becomeFlags^Optional

public readonly becomeFlags: string;

• Type: string

---

becomeMethod^Optional

public readonly becomeMethod: string;

• Type: string

---

becomeUser^Optional

public readonly becomeUser: string;

• Type: string

---

checkMode^Optional

public readonly checkMode: boolean;

• Type: boolean

---

collections^Optional

public readonly collections: string[];

• Type: string[]

---

connection^Optional

public readonly connection: string;

• Type: string

---

debugger^Optional

public readonly debugger: boolean;

• Type: boolean

---

diff^Optional

public readonly diff: boolean;

• Type: boolean

---

environment^Optional

public readonly environment: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

ignoreErrors^Optional

public readonly ignoreErrors: boolean;

• Type: boolean

---

ignoreUnreachable^Optional

public readonly ignoreUnreachable: boolean;

• Type: boolean

---

moduleDefaults^Optional

public readonly moduleDefaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

noLog^Optional

public readonly noLog: boolean;

• Type: boolean

---

port^Optional

public readonly port: number;

• Type: number

---

remoteUser^Optional

public readonly remoteUser: string;

• Type: string

---

runOnce^Optional

public readonly runOnce: boolean;

• Type: boolean

---

tags^Optional

public readonly tags: string[];

• Type: string[]

---

throttle^Optional

public readonly throttle: number;

• Type: number

---

timeout^Optional

public readonly timeout: number;

• Type: number

---

vars^Optional

public readonly vars: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

action^Required

public readonly action: TaskAction;

• Type: TaskAction

---

args^Optional

public readonly args: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

async^Optional

public readonly async: number;

• Type: number

---

changedWhen^Optional

public readonly changedWhen: string;

• Type: string

---

delay^Optional

public readonly delay: number;

• Type: number

---

delegateFacts^Optional

public readonly delegateFacts: boolean;

• Type: boolean

---

delegateTo^Optional

public readonly delegateTo: string;

• Type: string

---

failedWhen^Optional

public readonly failedWhen: Conditional[];

• Type: Conditional[]

---

localAction^Optional

public readonly localAction: string;

• Type: string

---

loop^Optional

public readonly loop: string | string[];

• Type: string | string[]

---

loopControl^Optional

public readonly loopControl: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

notify^Optional

public readonly notify: Handler[];

• Type: Handler[]

---

poll^Optional

public readonly poll: number;

• Type: number

---

register^Optional

public readonly register: string;

• Type: string

---

retries^Optional

public readonly retries: number;

• Type: number

---

until^Optional

public readonly until: string;

• Type: string

---

when^Optional

public readonly when: Conditional;

• Type: Conditional

---

with^Optional

public readonly with: string[];

• Type: string[]

---

withItems^Optional

public readonly withItems: {[ key: string ]: any}[];

• Type: {[ key: string ]: any}[]

---

TemplateFileProps

Initializer

import { TemplateFileProps } from 'cdk-ans'

const templateFileProps: TemplateFileProps = { ... }

Properties

Name	Type	Description
path	string	No description.
fileName	string	No description.

---

path^Required

public readonly path: string;

• Type: string

---

fileName^Optional

public readonly fileName: string;

• Type: string

---

Classes

AllHosts

• Implements: IHostIdentifiable

A special host identifier that contains all hosts.

Used from the Hosts.All class

Initializers

import { AllHosts } from 'cdk-ans'

new AllHosts()

Name	Type	Description

---

Properties

Name	Type	Description
identifier	string	No description.

---

identifier^Required

public readonly identifier: string;

• Type: string

---

AnyVariable

A variable that can be used to access any type of variable.

Used by returns of property and index methods of other variables.

Initializers

import { AnyVariable } from 'cdk-ans'

new AnyVariable(name: string, parents?: string[])

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

• Type: string

---

parents^Optional

• Type: string[]

---

Methods

Name	Description
asRaw	Returns the variable as a raw string.
asVariable	Returns the variable as an ansible variable string {{ variable }}.
index	No description.
property	No description.

---

asRaw

public asRaw(): string

Returns the variable as a raw string.

asVariable

public asVariable(): string

Returns the variable as an ansible variable string {{ variable }}.

index

public index(index: number): IVariable

index^Required

• Type: number

---

property

public property(key: string): IVariable

key^Required

• Type: string

---

Static Functions

Name	Description
of	No description.

---

of

import { AnyVariable } from 'cdk-ans'

AnyVariable.of(name: string)

name^Required

• Type: string

---

Properties

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

public readonly name: string;

• Type: string

---

parents^Required

public readonly parents: string[];

• Type: string[]

---

BaseVariable

• Implements: IVariable

The base variable class that all other variables extend from.

Initializers

import { BaseVariable } from 'cdk-ans'

new BaseVariable(name: string, parents?: string[])

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

• Type: string

---

parents^Optional

• Type: string[]

---

Methods

Name	Description
asRaw	Returns the variable as a raw string.
asVariable	Returns the variable as an ansible variable string {{ variable }}.
index	No description.
property	No description.

---

asRaw

public asRaw(): string

Returns the variable as a raw string.

asVariable

public asVariable(): string

Returns the variable as an ansible variable string {{ variable }}.

index

public index(index: number): IVariable

index^Required

• Type: number

---

property

public property(name: string): IVariable

name^Required

• Type: string

---

Properties

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

public readonly name: string;

• Type: string

---

parents^Required

public readonly parents: string[];

• Type: string[]

---

Conditional

Methods

Name	Description
format	No description.

---

format

public format(): string

Static Functions

Name	Description
and	No description.
bool	No description.
equal	No description.
greaterThan	No description.
greaterThanOrEqual	No description.
in	No description.
is	No description.
isNot	No description.
lessThan	No description.
lessThanOrEqual	No description.
notBool	No description.
notEqual	No description.
notIn	No description.
or	No description.

---

and

import { Conditional } from 'cdk-ans'

Conditional.and(condition1: any, condition2: any)

condition1^Required

• Type: any

---

condition2^Required

• Type: any

---

bool

import { Conditional } from 'cdk-ans'

Conditional.bool(bool: any)

bool^Required

• Type: any

---

equal

import { Conditional } from 'cdk-ans'

Conditional.equal(var1: any, var2: any)

var1^Required

• Type: any

---

var2^Required

• Type: any

---

greaterThan

import { Conditional } from 'cdk-ans'

Conditional.greaterThan(var1: any, var2: any)

var1^Required

• Type: any

---

var2^Required

• Type: any

---

greaterThanOrEqual

import { Conditional } from 'cdk-ans'

Conditional.greaterThanOrEqual(var1: any, var2: any)

var1^Required

• Type: any

---

var2^Required

• Type: any

---

in

import { Conditional } from 'cdk-ans'

Conditional.in(var1: any, var2: any)

var1^Required

• Type: any

---

var2^Required

• Type: any

---

is

import { Conditional } from 'cdk-ans'

Conditional.is(var1: any, isEval: IsEvaluation)

var1^Required

• Type: any

---

isEval^Required

• Type: IsEvaluation

---

isNot

import { Conditional } from 'cdk-ans'

Conditional.isNot(var1: any, isEval: IsEvaluation)

var1^Required

• Type: any

---

isEval^Required

• Type: IsEvaluation

---

lessThan

import { Conditional } from 'cdk-ans'

Conditional.lessThan(var1: any, var2: any)

var1^Required

• Type: any

---

var2^Required

• Type: any

---

lessThanOrEqual

import { Conditional } from 'cdk-ans'

Conditional.lessThanOrEqual(var1: any, var2: any)

var1^Required

• Type: any

---

var2^Required

• Type: any

---

notBool

import { Conditional } from 'cdk-ans'

Conditional.notBool(bool: any)

bool^Required

• Type: any

---

notEqual

import { Conditional } from 'cdk-ans'

Conditional.notEqual(var1: any, var2: any)

var1^Required

• Type: any

---

var2^Required

• Type: any

---

notIn

import { Conditional } from 'cdk-ans'

Conditional.notIn(var1: any, var2: any)

var1^Required

• Type: any

---

var2^Required

• Type: any

---

or

import { Conditional } from 'cdk-ans'

Conditional.or(condition1: any, condition2: any)

condition1^Required

• Type: any

---

condition2^Required

• Type: any

---

Properties

Name	Type	Description
mode	ConditionalEvaluation	No description.
var1	any	No description.
var2	any	No description.

---

mode^Required

public readonly mode: ConditionalEvaluation;

• Type: ConditionalEvaluation

---

var1^Required

public readonly var1: any;

• Type: any

---

var2^Optional

public readonly var2: any;

• Type: any

---

DependencyGraph

Represents the dependency graph for a given Node.

This graph includes the dependency relationships between all nodes in the node (construct) sub-tree who's root is this Node.

Note that this means that lonely nodes (no dependencies and no dependants) are also included in this graph as childless children of the root node of the graph.

The graph does not include cross-scope dependencies. That is, if a child on the current scope depends on a node from a different scope, that relationship is not represented in this graph.

Initializers

import { DependencyGraph } from 'cdk-ans'

new DependencyGraph(node: Node)

Name	Type	Description
node	constructs.Node	No description.

---

node^Required

• Type: constructs.Node

---

Methods

Name	Description
topology	No description.

---

topology

public topology(): IConstruct[]

Vertex.topology ()

Properties

Name	Type	Description
root	DependencyVertex	Returns the root of the graph.

---

root^Required

public readonly root: DependencyVertex;

• Type: DependencyVertex

Returns the root of the graph.

Note that this vertex will always have null as its .value since it is an artifical root that binds all the connected spaces of the graph.

---

DependencyVertex

Represents a vertex in the graph.

The value of each vertex is an IConstruct that is accessible via the .value getter.

Initializers

import { DependencyVertex } from 'cdk-ans'

new DependencyVertex(value?: IConstruct)

Name	Type	Description
value	constructs.IConstruct	No description.

---

value^Optional

• Type: constructs.IConstruct

---

Methods

Name	Description
addChild	Adds a vertex as a dependency of the current node.
topology	Returns a topologically sorted array of the constructs in the sub-graph.

---

addChild

public addChild(dep: DependencyVertex): void

Adds a vertex as a dependency of the current node.

Also updates the parents of dep, so that it contains this node as a parent.

This operation will fail in case it creates a cycle in the graph.

dep^Required

• Type: DependencyVertex

The dependency.

---

topology

public topology(): IConstruct[]

Returns a topologically sorted array of the constructs in the sub-graph.

Properties

Name	Type	Description
inbound	DependencyVertex[]	Returns the parents of the vertex (i.e dependants).
outbound	DependencyVertex[]	Returns the children of the vertex (i.e dependencies).
value	constructs.IConstruct	Returns the IConstruct this graph vertex represents.

---

inbound^Required

public readonly inbound: DependencyVertex[];

• Type: DependencyVertex[]

Returns the parents of the vertex (i.e dependants).

---

outbound^Required

public readonly outbound: DependencyVertex[];

• Type: DependencyVertex[]

Returns the children of the vertex (i.e dependencies).

---

value^Optional

public readonly value: IConstruct;

• Type: constructs.IConstruct

Returns the IConstruct this graph vertex represents.

null in case this is the root of the graph.

---

DictionaryVariable

A variable that represents a dictionary (object) This can be used to access properties of the dictionary.

Initializers

import { DictionaryVariable } from 'cdk-ans'

new DictionaryVariable(name: string, parents?: string[])

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

• Type: string

---

parents^Optional

• Type: string[]

---

Methods

Name	Description
asRaw	Returns the variable as a raw string.
asVariable	Returns the variable as an ansible variable string {{ variable }}.
index	No description.
property	No description.

---

asRaw

public asRaw(): string

Returns the variable as a raw string.

asVariable

public asVariable(): string

Returns the variable as an ansible variable string {{ variable }}.

index

public index(_: number): IVariable

_^Required

• Type: number

---

property

public property(key: string): IVariable

key^Required

• Type: string

---

Static Functions

Name	Description
of	No description.

---

of

import { DictionaryVariable } from 'cdk-ans'

DictionaryVariable.of(name: string)

name^Required

• Type: string

---

Properties

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

public readonly name: string;

• Type: string

---

parents^Required

public readonly parents: string[];

• Type: string[]

---

Hosts

A special class to allow for specifying all hosts in a playbook.

Initializers

import { Hosts } from 'cdk-ans'

new Hosts()

Name	Type	Description

---

Constants

Name	Type	Description
All	AllHosts[]	No description.

---

All^Required

public readonly All: AllHosts[];

• Type: AllHosts[]

---

ListVariable

A variable that can be used to access a indexed sub variables.

Initializers

import { ListVariable } from 'cdk-ans'

new ListVariable(name: string, parents?: string[])

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

• Type: string

---

parents^Optional

• Type: string[]

---

Methods

Name	Description
asRaw	Returns the variable as a raw string.
asVariable	Returns the variable as an ansible variable string {{ variable }}.
index	No description.
property	No description.

---

asRaw

public asRaw(): string

Returns the variable as a raw string.

asVariable

public asVariable(): string

Returns the variable as an ansible variable string {{ variable }}.

index

public index(index: number): IVariable

index^Required

• Type: number

---

property

public property(_: string): IVariable

_^Required

• Type: string

---

Static Functions

Name	Description
of	No description.

---

of

import { ListVariable } from 'cdk-ans'

ListVariable.of(name: string)

name^Required

• Type: string

---

Properties

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

public readonly name: string;

• Type: string

---

parents^Required

public readonly parents: string[];

• Type: string[]

---

MagicVariable

Ansible magic variable.

A class used to format anisble variables.

https://docs.ansible.com/ansible/latest/reference_appendices/special_variables.html

Initializers

import { MagicVariable } from 'cdk-ans'

new MagicVariable()

Name	Type	Description

---

Constants

Name	Type	Description
AnsibleBecomeUser	SimpleVariable	The user Ansible ‘becomes’ after using privilege escalation.
AnsibleCheckMode	SimpleVariable	Boolean that indicates if we are in check mode or not.
AnsibleCheckModeEnabled	SimpleVariable	The names of the roles currently imported into the current play as dependencies of other plays.
AnsibleCollectionName	SimpleVariable	The name of the collection the task that is executing is a part of.
AnsibleConfigFile	SimpleVariable	The full path of used Ansible configuration file.
AnsibleConnection	SimpleVariable	The connection plugin actually used for the task on the target host.
AnsibleDiffMode	SimpleVariable	Boolean that indicates if we are in diff mode or not.
AnsibleFacts	DictionaryVariable	Contains any facts gathered or cached for the inventory_hostname Facts are normally gathered by the setup module automatically in a play, but any module can return facts.
AnsibleForks	SimpleVariable	Integer reflecting the number of maximum forks available to this run.
AnsibleHost	SimpleVariable	The ip/name of the target host to use instead of inventory_hostname.
AnsibleIndexVar	SimpleVariable	The name of the value provided to loop_control.index_var. Added in 2.9.
AnsibleInventorySources	ListVariable	List of sources used as inventory.
AnsibleLimit	SimpleVariable	Contents of the --limit CLI option for the current execution of Ansible.
AnsibleLocal	DictionaryVariable	Contains any ‘local facts’ gathered or cached for the inventory_hostname.
AnsibleLoop	DictionaryVariable	A dictionary/map containing extended loop information when enabled through loop_control.extended.
AnsibleLoopVar	SimpleVariable	The name of the value provided to loop_control.loop_var. Added in 2.8.
AnsibleParentRoleNames	ListVariable	When the current role is being executed by means of an include_role or import_role action, this variable contains a list of all parent roles, with the most recent role (in other words, the role that included/imported this role) being the first item in the list.
AnsibleParentRolePath	SimpleVariable	When the current role is being executed by means of an include_role or import_role action, this variable contains a list of all parent roles paths, with the most recent role (in other words, the role that included/imported this role) being the first item in the list.
AnsiblePlayBatch	ListVariable	List of active hosts in the current play run limited by the serial, aka ‘batch’.
AnsiblePlaybookPython	SimpleVariable	The path to the python interpreter being used by Ansible on the controller.
AnsiblePlayHosts	ListVariable	List of hosts in the current play run, not limited by the serial.
AnsiblePlayHostsAll	ListVariable	List of all the hosts that were targeted by the play.
AnsiblePlayName	SimpleVariable	The name of the currently executed play.
AnsiblePlayRoleNames	ListVariable	The names of the roles currently imported into the current play.
AnsiblePort	SimpleVariable	The port used to connect to the target host.
AnsiblePythonInterpreter	SimpleVariable	The path to the Python executable Ansible should use on the target host.
AnsibleRoleName	SimpleVariable	The fully qualified collection role name, in the format of namespace.collection.role_name.
AnsibleRoleNames	ListVariable	The names of the roles currently imported into the current play, or roles referenced as dependencies of the roles imported into the current play.
AnsibleRunTags	ListVariable	Contents of the --tags CLI option, which specifies which tags will be included for the current run.
AnsibleSearchPath	SimpleVariable	Current search path for action plugins and lookups, in other words, where we search for relative paths when you do template: src=myfile.
AnsibleSkipTags	ListVariable	Contents of the --skip-tags CLI option, which specifies which tags will be skipped for the current run.
AnsibleUser	SimpleVariable	The user Ansible ‘logs in’ as.
AnsibleVerbosity	SimpleVariable	Current verbosity setting for Ansible.
AnsibleVersion	SimpleVariable	Dictionary/map that contains information about the current running version of ansible, it has the following keys: full, major, minor, revision and string.
GroupNames	ListVariable	List of groups the current host is part of.
Groups	DictionaryVariable	A dictionary/map with all the groups in inventory and each group has the list of hosts that belong to it.
HostVars	DictionaryVariable	A dictionary/map with all the hosts in inventory and variables assigned to them.
InventoryDir	SimpleVariable	The directory of the inventory source in which the inventory_hostname was first defined.
InventoryFile	SimpleVariable	The file name of the inventory source in which the inventory_hostname was first defined.
InventoryHostname	SimpleVariable	The inventory name for the ‘current’ host being iterated over in the play.
InventoryHostnameShort	SimpleVariable	The short version of inventory_hostname.
Item	AnyVariable	A special variable to quickly implement an item variable in a loop.
Omit	SimpleVariable	Special variable that allows you to ‘omit’ an option in a task, for example - user: name=bob home={{ bobs_home\|default(omit) }}.
PlaybookDir	SimpleVariable	The path to the directory of the current playbook being executed.
RoleName	SimpleVariable	The name of the role currently being executed.
RolePath	SimpleVariable	The path to the dir of the currently running role.

---

AnsibleBecomeUser^Required

public readonly AnsibleBecomeUser: SimpleVariable;

• Type: SimpleVariable

The user Ansible ‘becomes’ after using privilege escalation.

This must be available to the ‘login user’.

---

AnsibleCheckMode^Required

public readonly AnsibleCheckMode: SimpleVariable;

• Type: SimpleVariable

Boolean that indicates if we are in check mode or not.

---

AnsibleCheckModeEnabled^Required

public readonly AnsibleCheckModeEnabled: SimpleVariable;

• Type: SimpleVariable

The names of the roles currently imported into the current play as dependencies of other plays.

---

AnsibleCollectionName^Required

public readonly AnsibleCollectionName: SimpleVariable;

• Type: SimpleVariable

The name of the collection the task that is executing is a part of.

In the format of namespace.collection.

---

AnsibleConfigFile^Required

public readonly AnsibleConfigFile: SimpleVariable;

• Type: SimpleVariable

The full path of used Ansible configuration file.

---

AnsibleConnection^Required

public readonly AnsibleConnection: SimpleVariable;

• Type: SimpleVariable

The connection plugin actually used for the task on the target host.

---

AnsibleDiffMode^Required

public readonly AnsibleDiffMode: SimpleVariable;

• Type: SimpleVariable

Boolean that indicates if we are in diff mode or not.

---

AnsibleFacts^Required

public readonly AnsibleFacts: DictionaryVariable;

• Type: DictionaryVariable

Contains any facts gathered or cached for the inventory_hostname Facts are normally gathered by the setup module automatically in a play, but any module can return facts.

https://docs.ansible.com/ansible/latest/collections/ansible/builtin/setup_module.html

---

AnsibleForks^Required

public readonly AnsibleForks: SimpleVariable;

• Type: SimpleVariable

Integer reflecting the number of maximum forks available to this run.

---

AnsibleHost^Required

public readonly AnsibleHost: SimpleVariable;

• Type: SimpleVariable

The ip/name of the target host to use instead of inventory_hostname.

---

AnsibleIndexVar^Required

public readonly AnsibleIndexVar: SimpleVariable;

• Type: SimpleVariable

The name of the value provided to loop_control.index_var. Added in 2.9.

---

AnsibleInventorySources^Required

public readonly AnsibleInventorySources: ListVariable;

• Type: ListVariable

List of sources used as inventory.

---

AnsibleLimit^Required

public readonly AnsibleLimit: SimpleVariable;

• Type: SimpleVariable

Contents of the --limit CLI option for the current execution of Ansible.

---

AnsibleLocal^Required

public readonly AnsibleLocal: DictionaryVariable;

• Type: DictionaryVariable

Contains any ‘local facts’ gathered or cached for the inventory_hostname.

The keys available depend on the custom facts created. See the setup module and facts.d or local facts for more details.

---

AnsibleLoop^Required

public readonly AnsibleLoop: DictionaryVariable;

• Type: DictionaryVariable

A dictionary/map containing extended loop information when enabled through loop_control.extended.

---

AnsibleLoopVar^Required

public readonly AnsibleLoopVar: SimpleVariable;

• Type: SimpleVariable

The name of the value provided to loop_control.loop_var. Added in 2.8.

---

AnsibleParentRoleNames^Required

public readonly AnsibleParentRoleNames: ListVariable;

• Type: ListVariable

When the current role is being executed by means of an include_role or import_role action, this variable contains a list of all parent roles, with the most recent role (in other words, the role that included/imported this role) being the first item in the list.

When multiple inclusions occur, this list lists the last role (in other words, the role that included this role) as the first item in the list. It is also possible that a specific role exists more than once in this list.

For example: When role A includes role B, inside role B, ansible_parent_role_names will equal to ['A']. If role B then includes role C, the list becomes ['B', 'A'].

https://docs.ansible.com/ansible/latest/collections/ansible/builtin/import_role_module.html

---

AnsibleParentRolePath^Required

public readonly AnsibleParentRolePath: SimpleVariable;

• Type: SimpleVariable

When the current role is being executed by means of an include_role or import_role action, this variable contains a list of all parent roles paths, with the most recent role (in other words, the role that included/imported this role) being the first item in the list.

Please refer to ansible_parent_role_names for the order of items in this list.

https://docs.ansible.com/ansible/latest/collections/ansible/builtin/import_role_module.html

---

AnsiblePlayBatch^Required

public readonly AnsiblePlayBatch: ListVariable;

• Type: ListVariable

List of active hosts in the current play run limited by the serial, aka ‘batch’.

Failed/Unreachable hosts are not considered ‘active’.

---

AnsiblePlaybookPython^Required

public readonly AnsiblePlaybookPython: SimpleVariable;

• Type: SimpleVariable

The path to the python interpreter being used by Ansible on the controller.

---

AnsiblePlayHosts^Required

public readonly AnsiblePlayHosts: ListVariable;

• Type: ListVariable

List of hosts in the current play run, not limited by the serial.

Failed/Unreachable hosts are excluded from this list.

---

AnsiblePlayHostsAll^Required

public readonly AnsiblePlayHostsAll: ListVariable;

• Type: ListVariable

List of all the hosts that were targeted by the play.

---

AnsiblePlayName^Required

public readonly AnsiblePlayName: SimpleVariable;

• Type: SimpleVariable

The name of the currently executed play.

Added in 2.8. (name attribute of the play, not file name of the playbook.)

---

AnsiblePlayRoleNames^Required

public readonly AnsiblePlayRoleNames: ListVariable;

• Type: ListVariable

The names of the roles currently imported into the current play.

This list does not contain the role names that are implicitly included through dependencies.

---

AnsiblePort^Required

public readonly AnsiblePort: SimpleVariable;

• Type: SimpleVariable

The port used to connect to the target host.

---

AnsiblePythonInterpreter^Required

public readonly AnsiblePythonInterpreter: SimpleVariable;

• Type: SimpleVariable

The path to the Python executable Ansible should use on the target host.

https://docs.ansible.com/ansible/latest/reference_appendices/interpreter_discovery.html

---

AnsibleRoleName^Required

public readonly AnsibleRoleName: SimpleVariable;

• Type: SimpleVariable

The fully qualified collection role name, in the format of namespace.collection.role_name.

---

AnsibleRoleNames^Required

public readonly AnsibleRoleNames: ListVariable;

• Type: ListVariable

The names of the roles currently imported into the current play, or roles referenced as dependencies of the roles imported into the current play.

---

AnsibleRunTags^Required

public readonly AnsibleRunTags: ListVariable;

• Type: ListVariable

Contents of the --tags CLI option, which specifies which tags will be included for the current run.

Note that if --tags is not passed, this variable will default to ["all"].

---

AnsibleSearchPath^Required

public readonly AnsibleSearchPath: SimpleVariable;

• Type: SimpleVariable

Current search path for action plugins and lookups, in other words, where we search for relative paths when you do template: src=myfile.

---

AnsibleSkipTags^Required

public readonly AnsibleSkipTags: ListVariable;

• Type: ListVariable

Contents of the --skip-tags CLI option, which specifies which tags will be skipped for the current run.

---

AnsibleUser^Required

public readonly AnsibleUser: SimpleVariable;

• Type: SimpleVariable

The user Ansible ‘logs in’ as.

---

AnsibleVerbosity^Required

public readonly AnsibleVerbosity: SimpleVariable;

• Type: SimpleVariable

Current verbosity setting for Ansible.

---

AnsibleVersion^Required

public readonly AnsibleVersion: SimpleVariable;

• Type: SimpleVariable

Dictionary/map that contains information about the current running version of ansible, it has the following keys: full, major, minor, revision and string.

---

GroupNames^Required

public readonly GroupNames: ListVariable;

• Type: ListVariable

List of groups the current host is part of.

---

Groups^Required

public readonly Groups: DictionaryVariable;

• Type: DictionaryVariable

A dictionary/map with all the groups in inventory and each group has the list of hosts that belong to it.

---

HostVars^Required

public readonly HostVars: DictionaryVariable;

• Type: DictionaryVariable

A dictionary/map with all the hosts in inventory and variables assigned to them.

---

InventoryDir^Required

public readonly InventoryDir: SimpleVariable;

• Type: SimpleVariable

The directory of the inventory source in which the inventory_hostname was first defined.

---

InventoryFile^Required

public readonly InventoryFile: SimpleVariable;

• Type: SimpleVariable

The file name of the inventory source in which the inventory_hostname was first defined.

---

InventoryHostname^Required

public readonly InventoryHostname: SimpleVariable;

• Type: SimpleVariable

The inventory name for the ‘current’ host being iterated over in the play.

---

InventoryHostnameShort^Required

public readonly InventoryHostnameShort: SimpleVariable;

• Type: SimpleVariable

The short version of inventory_hostname.

---

Item^Required

public readonly Item: AnyVariable;

• Type: AnyVariable

A special variable to quickly implement an item variable in a loop.

---

Omit^Required

public readonly Omit: SimpleVariable;

• Type: SimpleVariable

Special variable that allows you to ‘omit’ an option in a task, for example - user: name=bob home={{ bobs_home|default(omit) }}.

---

PlaybookDir^Required

public readonly PlaybookDir: SimpleVariable;

• Type: SimpleVariable

The path to the directory of the current playbook being executed.

NOTE: This might be different than directory of the playbook passed to the ansible-playbook command line when a playbook contains a import_playbook statement.

---

RoleName^Required

public readonly RoleName: SimpleVariable;

• Type: SimpleVariable

The name of the role currently being executed.

---

RolePath^Required

public readonly RolePath: SimpleVariable;

• Type: SimpleVariable

The path to the dir of the currently running role.

---

PlayDefinition

• Implements: IPlayChainable

Methods

Name	Description
toJson	Iterate over the chain, JSONify it, and return it as an array.
next	No description.

---

toJson

public toJson(): any[]

Iterate over the chain, JSONify it, and return it as an array.

next

public next(next: IPlayChainable): PlayDefinition

next^Required

• Type: IPlayChainable

---

Static Functions

Name	Description
sequence	No description.

---

sequence

import { PlayDefinition } from 'cdk-ans'

PlayDefinition.sequence(next: IPlayChainable, chain: Step[])

next^Required

• Type: IPlayChainable

---

chain^Required

• Type: Step[]

---

Properties

Name	Type	Description
chain	Step[]	No description.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

ProjectSynthesizer

• Implements: ISynthesizer

Initializers

import { ProjectSynthesizer } from 'cdk-ans'

new ProjectSynthesizer(options?: ProjectSynthesizerOptions)

Name	Type	Description
options	ProjectSynthesizerOptions	No description.

---

options^Optional

• Type: ProjectSynthesizerOptions

---

Methods

Name	Description
synth	No description.

---

synth

public synth(project: Project, outDir: string): void

project^Required

• Type: Project

---

outDir^Required

• Type: string

---

Properties

Name	Type	Description
options	ProjectSynthesizerOptions	No description.

---

options^Required

public readonly options: ProjectSynthesizerOptions;

• Type: ProjectSynthesizerOptions

---

RoleDefinition

• Implements: IRoleChainable

Methods

Name	Description
toJson	Iterate over the chain, JSONify it, and return it as an array.
next	No description.

---

toJson

public toJson(): any[]

Iterate over the chain, JSONify it, and return it as an array.

next

public next(next: IRoleChainable): RoleDefinition

next^Required

• Type: IRoleChainable

---

Static Functions

Name	Description
sequence	No description.

---

sequence

import { RoleDefinition } from 'cdk-ans'

RoleDefinition.sequence(next: IRoleChainable, chain: Step[])

next^Required

• Type: IRoleChainable

---

chain^Required

• Type: Step[]

---

Properties

Name	Type	Description
chain	Step[]	No description.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

RunDefinition

• Implements: IChainable

Initializers

import { RunDefinition } from 'cdk-ans'

new RunDefinition(chain: Step[])

Name	Type	Description
chain	Step[]	No description.

---

chain^Required

• Type: Step[]

---

Methods

Name	Description
toJson	Iterate over the chain, JSONify it, and return it as an array.

---

toJson

public toJson(): any[]

Iterate over the chain, JSONify it, and return it as an array.

Properties

Name	Type	Description
chain	Step[]	No description.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

SimpleVariable

A variable that represents a flat value (string, number, boolean).

Initializers

import { SimpleVariable } from 'cdk-ans'

new SimpleVariable(name: string, parents?: string[])

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

• Type: string

---

parents^Optional

• Type: string[]

---

Methods

Name	Description
asRaw	Returns the variable as a raw string.
asVariable	Returns the variable as an ansible variable string {{ variable }}.
index	No description.
property	No description.

---

asRaw

public asRaw(): string

Returns the variable as a raw string.

asVariable

public asVariable(): string

Returns the variable as an ansible variable string {{ variable }}.

index

public index(_: number): IVariable

_^Required

• Type: number

---

property

public property(_: string): IVariable

_^Required

• Type: string

---

Static Functions

Name	Description
of	No description.

---

of

import { SimpleVariable } from 'cdk-ans'

SimpleVariable.of(name: string)

name^Required

• Type: string

---

Properties

Name	Type	Description
name	string	No description.
parents	string[]	No description.

---

name^Required

public readonly name: string;

• Type: string

---

parents^Required

public readonly parents: string[];

• Type: string[]

---

TaskAction

Base class for all Task Actions.

Initializers

import { TaskAction } from 'cdk-ans'

new TaskAction(name: string, props: {[ key: string ]: any})

Name	Type	Description
name	string	No description.
props	{[ key: string ]: any}	No description.

---

name^Required

• Type: string

---

props^Required

• Type: {[ key: string ]: any}

---

Methods

Name	Description
toJson	No description.

---

toJson

public toJson(): any

Properties

Name	Type	Description
name	string	No description.
props	{[ key: string ]: any}	No description.

---

name^Required

public readonly name: string;

• Type: string

---

props^Required

public readonly props: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

TaskDefinition

• Implements: ITaskChainable

Methods

Name	Description
toJson	Iterate over the chain, JSONify it, and return it as an array.
next	No description.

---

toJson

public toJson(): any[]

Iterate over the chain, JSONify it, and return it as an array.

next

public next(next: ITaskChainable): TaskDefinition

next^Required

• Type: ITaskChainable

---

Static Functions

Name	Description
sequence	No description.

---

sequence

import { TaskDefinition } from 'cdk-ans'

TaskDefinition.sequence(next: ITaskChainable, chain: Step[])

next^Required

• Type: ITaskChainable

---

chain^Required

• Type: Step[]

---

Properties

Name	Type	Description
chain	Step[]	No description.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

Yaml

YAML utilities.

Static Functions

Name	Description
load	Downloads a set of YAML documents from a file and returns them as javascript objects.
save	Saves a set of objects as a multi-document YAML file.
stringify	Stringify a document (or multiple documents) into YAML.

---

load

import { Yaml } from 'cdk-ans'

Yaml.load(file: string)

Downloads a set of YAML documents from a file and returns them as javascript objects.

Empty documents are filtered out.

file^Required

• Type: string

path to load from.

---

save

import { Yaml } from 'cdk-ans'

Yaml.save(filePath: string, docs: any[])

Saves a set of objects as a multi-document YAML file.

filePath^Required

• Type: string

The output path.

---

docs^Required

• Type: any[]

The set of objects.

---

stringify

import { Yaml } from 'cdk-ans'

Yaml.stringify(docs: any)

Stringify a document (or multiple documents) into YAML.

We convert undefined values to null, but ignore any documents that are undefined.

docs^Required

• Type: any

A set of objects to convert to YAML.

---

Protocols

IChainable

• Implemented By: Block, Play, PlayDefinition, RoleDefinition, RoleTarget, RunDefinition, Task, TaskDefinition, IChainable, IPlayChainable, IRoleChainable, ITaskChainable

Properties

Name	Type	Description
chain	Step[]	No description.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

IHostIdentifiable

• Implemented By: AllHosts, Host, HostGroup, IHostIdentifiable

Properties

Name	Type	Description
identifier	string	No description.

---

identifier^Required

public readonly identifier: string;

• Type: string

---

IPlayChainable

• Extends: IChainable

• Implemented By: Play, PlayDefinition, IPlayChainable

Methods

Name	Description
next	No description.

---

next

public next(next: IPlayChainable): PlayDefinition

next^Required

• Type: IPlayChainable

---

Properties

Name	Type	Description
chain	Step[]	No description.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

IRoleChainable

• Extends: IChainable

• Implemented By: RoleDefinition, RoleTarget, IRoleChainable

Methods

Name	Description
next	No description.

---

next

public next(next: IRoleChainable): RoleDefinition

next^Required

• Type: IRoleChainable

---

Properties

Name	Type	Description
chain	Step[]	No description.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

ISynthesizer

• Implemented By: ProjectSynthesizer, ISynthesizer

Methods

Name	Description
synth	No description.

---

synth

public synth(project: Project, outDir: string): void

project^Required

• Type: Project

---

outDir^Required

• Type: string

---

ITaskChainable

• Extends: IChainable

• Implemented By: Block, Task, TaskDefinition, ITaskChainable

Methods

Name	Description
next	No description.

---

next

public next(next: ITaskChainable): TaskDefinition

next^Required

• Type: ITaskChainable

---

Properties

Name	Type	Description
chain	Step[]	No description.

---

chain^Required

public readonly chain: Step[];

• Type: Step[]

---

IVariable

• Implemented By: AnyVariable, BaseVariable, DictionaryVariable, HostVariable, ListVariable, SimpleVariable, IVariable

A variable that can access any type of variable.

Methods

Name	Description
asRaw	Returns the variable as a raw string.
asVariable	Returns the variable as an ansible variable string {{ variable }}.
index	No description.
property	No description.

---

asRaw

public asRaw(): string

Returns the variable as a raw string.

asVariable

public asVariable(): string

Returns the variable as an ansible variable string {{ variable }}.

index

public index(index: number): IVariable

index^Required

• Type: number

---

property

public property(name: string): IVariable

name^Required

• Type: string

---

Enums

AnsibleConnection

The connection type to use to connect to the host.

https://docs.ansible.com/ansible/latest/user_guide/connection_details.html#connection-types

Members

Name	Description
SMART	No description.
SSH	No description.
PARAMIKO	No description.
LOCAL	No description.

---

SMART

---

SSH

---

PARAMIKO

---

LOCAL

---

ConditionalEvaluation

Members

Name	Description
AND	No description.
OR	No description.
IS	No description.
IS_NOT	No description.
IN	No description.
NOT_IN	No description.
WHEN_EQUALS	No description.
WHEN_NOT_EQUALS	No description.
WHEN_GREATER_THAN	No description.
WHEN_LESS_THAN	No description.
WHEN_GREATER_THAN_OR_EQUALS	No description.
WHEN_LESS_THAN_OR_EQUALS	No description.
BOOL	No description.
BOOL_NOT	No description.
DEFINED	No description.
UNDEFINED	No description.
FAILED	No description.
SUCCEEDED	No description.
SKIPPED	No description.
CHANGED	No description.

---

AND

---

OR

---

IS

---

IS_NOT

---

IN

---

NOT_IN

---

WHEN_EQUALS

---

WHEN_NOT_EQUALS

---

WHEN_GREATER_THAN

---

WHEN_LESS_THAN

---

WHEN_GREATER_THAN_OR_EQUALS

---

WHEN_LESS_THAN_OR_EQUALS

---

BOOL

---

BOOL_NOT

---

DEFINED

---

UNDEFINED

---

FAILED

---

SUCCEEDED

---

SKIPPED

---

CHANGED

---

InventoryOutputType

How inventories should be sythesized in the output directory.

Members

Name	Description
SINGLE_FILE	Create a single inventory file including all hosts, hosts vars, and groups in one.
GROUP_AND_HOST_VAR_FILES	Create a file for hosts, a file for each host's vars, and a file for each group's vars.

---

SINGLE_FILE

Create a single inventory file including all hosts, hosts vars, and groups in one.

---

GROUP_AND_HOST_VAR_FILES

Create a file for hosts, a file for each host's vars, and a file for each group's vars.

---

IsEvaluation

Members

Name	Description
DEFINED	No description.
UNDEFINED	No description.
FAILED	No description.
SUCCEEDED	No description.
SKIPPED	No description.
CHANGED	No description.

---

DEFINED

---

UNDEFINED

---

FAILED

---

SUCCEEDED

---

SKIPPED

---

CHANGED

---

PlaybookOutputType

How playbooks should be sythesized in the output directory.

Members

Name	Description
IN_ROOT	Place all playbooks in the root of the project.
IN_DIRECTORY	Place all playbooks in a directory named "playbooks".

---

IN_ROOT

Place all playbooks in the root of the project.

---

IN_DIRECTORY

Place all playbooks in a directory named "playbooks".

---

PlayHostOrder

Members

Name	Description
INVENTORY	No description.
SORTED	No description.
REVERSE_SORTED	No description.
REVERSE_INVENTORY	No description.
SHUFFLED	No description.

---

INVENTORY

---

SORTED

---

REVERSE_SORTED

---

REVERSE_INVENTORY

---

SHUFFLED

---

RoleOutputType

How roles should be sythesized in the output directory.

Members

Name	Description
STANDARD	Use the standard role structure https://docs.ansible.com/ansible/2.8/user_guide/playbooks_reuse_roles.html#role-directory-structure.

---

STANDARD

Use the standard role structure https://docs.ansible.com/ansible/2.8/user_guide/playbooks_reuse_roles.html#role-directory-structure.

---