`aws` Submodule ¶

Structs ¶

CdkBootstrapProps ¶

Configuration properties for initializing a Bootstrap instance.

Initializer ¶

import { aws } from '@gcix/gcix'

const cdkBootstrapProps: aws.CdkBootstrapProps = { ... }

Properties ¶

Name	Type	Description
`awsAccountId`	`string`	The AWS account ID associated with the Bootstrap configuration.
`awsRegion`	`string`	The AWS region in which the Bootstrap will be performed.
`qualifier`	`string`	The qualifier applied to the Bootstrap.
`toolkitStackName`	`string`	The name of the toolkit stack used for Bootstrap.
`jobName`	`string`	An optional name for the Bootstrap job.
`jobStage`	`string`	An optional stage for the Bootstrap job.
`resourceTags`	`{[ key: string ]: string}`	Optional resource tags that can be applied during Bootstrap.

`awsAccountId`^Required ¶

public readonly awsAccountId: string;

Type: string

The AWS account ID associated with the Bootstrap configuration.

`awsRegion`^Required ¶

public readonly awsRegion: string;

Type: string

The AWS region in which the Bootstrap will be performed.

`qualifier`^Required ¶

public readonly qualifier: string;

Type: string

The qualifier applied to the Bootstrap.

`toolkitStackName`^Required ¶

public readonly toolkitStackName: string;

Type: string

The name of the toolkit stack used for Bootstrap.

`jobName`^Optional ¶

public readonly jobName: string;

Type: string

An optional name for the Bootstrap job.

`jobStage`^Optional ¶

public readonly jobStage: string;

Type: string

An optional stage for the Bootstrap job.

`resourceTags`^Optional ¶

public readonly resourceTags: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional resource tags that can be applied during Bootstrap.

CdkDeployProps ¶

Configuration properties for initializing a Deploy instance.

Initializer ¶

import { aws } from '@gcix/gcix'

const cdkDeployProps: aws.CdkDeployProps = { ... }

Properties ¶

Name	Type	Description
`stacks`	`string[]`	An array of stack names to be deployed.
`context`	`{[ key: string ]: string}`	Optional context values to provide additional information for deployment.
`deployOptions`	`string`	Optional deployment options.
`jobName`	`string`	An optional name for the Deploy job.
`jobStage`	`string`	An optional stage for the Deploy job.
`strict`	`boolean`	Enable strict deployment mode.
`toolkitStackName`	`string`	Optional toolkit stack name used for deployment.
`waitForStack`	`boolean`	Wait for stacks to complete deployment.
`waitForStackAccountId`	`string`	AWS account ID for stack waiting.
`waitForStackAssumeRole`	`string`	AWS assume role for stack waiting.

`stacks`^Required ¶

public readonly stacks: string[];

Type: string[]

An array of stack names to be deployed.

`context`^Optional ¶

public readonly context: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional context values to provide additional information for deployment.

`deployOptions`^Optional ¶

public readonly deployOptions: string;

Type: string

Optional deployment options.

`jobName`^Optional ¶

public readonly jobName: string;

Type: string

An optional name for the Deploy job.

`jobStage`^Optional ¶

public readonly jobStage: string;

Type: string

An optional stage for the Deploy job.

`strict`^Optional ¶

public readonly strict: boolean;

Type: boolean

Enable strict deployment mode.

`toolkitStackName`^Optional ¶

public readonly toolkitStackName: string;

Type: string

Optional toolkit stack name used for deployment.

`waitForStack`^Optional ¶

public readonly waitForStack: boolean;

Type: boolean

Wait for stacks to complete deployment.

`waitForStackAccountId`^Optional ¶

public readonly waitForStackAccountId: string;

Type: string

AWS account ID for stack waiting.

`waitForStackAssumeRole`^Optional ¶

public readonly waitForStackAssumeRole: string;

Type: string

AWS assume role for stack waiting.

CdkDiffDeployProps ¶

Configuration properties for initializing a DiffDeploy instance.

Initializer ¶

import { aws } from '@gcix/gcix'

const cdkDiffDeployProps: aws.CdkDiffDeployProps = { ... }

Properties ¶

Name	Type	Description
`stacks`	`string[]`	An array of stack names for which to generate a diff and perform deployment.
`context`	`{[ key: string ]: string}`	Optional context values to provide additional information for the diff and deployment.

`stacks`^Required ¶

public readonly stacks: string[];

Type: string[]

An array of stack names for which to generate a diff and perform deployment.

`context`^Optional ¶

public readonly context: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional context values to provide additional information for the diff and deployment.

CdkDiffProps ¶

Configuration properties for initializing a Diff instance.

Initializer ¶

import { aws } from '@gcix/gcix'

const cdkDiffProps: aws.CdkDiffProps = { ... }

Properties ¶

Name	Type	Description
`stacks`	`string[]`	An array of stack names for which to generate a diff.
`context`	`{[ key: string ]: string}`	Optional context values to provide additional information for the diff.
`diffOptions`	`string`	Optional diff options to customize the diff process.
`jobName`	`string`	An optional name for the Diff job.
`jobStage`	`string`	An optional stage for the Diff job.

`stacks`^Required ¶

public readonly stacks: string[];

Type: string[]

An array of stack names for which to generate a diff.

`context`^Optional ¶

public readonly context: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional context values to provide additional information for the diff.

`diffOptions`^Optional ¶

public readonly diffOptions: string;

Type: string

Optional diff options to customize the diff process.

`jobName`^Optional ¶

public readonly jobName: string;

Type: string

An optional name for the Diff job.

`jobStage`^Optional ¶

public readonly jobStage: string;

Type: string

An optional stage for the Diff job.

CdkMirrorToCodecommitProps ¶

Initializer ¶

import { aws } from '@gcix/gcix'

const cdkMirrorToCodecommitProps: aws.CdkMirrorToCodecommitProps = { ... }

Properties ¶

Name	Type	Description
`awsRegion`	`string`	The AWS region you want to operate in.
`infrastructureTags`	`string`	Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.
`mirrorOpts`	`@gcix/gcix.git.GitMirrorProps`	Options for the upstream Mirror job.
`repositoryName`	`string`	The name of the target Codecommit repository.

`awsRegion`^Optional ¶

public readonly awsRegion: string;

Type: string

The AWS region you want to operate in.

When not set, it would be curl'ed from the current EC2 instance metadata.

`infrastructureTags`^Optional ¶

public readonly infrastructureTags: string;

Type: string

Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.

Changed values won't change the tags on an already existing ECR. This string must have the pattern: Tag1=Value1,Tag2=Value2

`mirrorOpts`^Optional ¶

public readonly mirrorOpts: GitMirrorProps;

Type: @gcix/gcix.git.GitMirrorProps

Options for the upstream Mirror job.

`repositoryName`^Optional ¶

public readonly repositoryName: string;

Type: string
Default: CI_PROJECT_PATH_SLUG.

The name of the target Codecommit repository.

Classes ¶

AWSAccount ¶

Initializers ¶

import { aws } from '@gcix/gcix'

new aws.AWSAccount()

Name	Type	Description

Static Functions ¶

Name	Description
`awsAccountId`	Retrieves the AWS Account ID associated with the current AWS credentials or environment.
`awsRegion`	Retrieves the AWS region associated with the current AWS credentials or environment.

`awsAccountId` ¶

import { aws } from '@gcix/gcix'

aws.AWSAccount.awsAccountId()

Retrieves the AWS Account ID associated with the current AWS credentials or environment.

If available, it uses the environment variable AWS_ACCOUNT_ID. Otherwise, it fetches the AWS Account ID from the caller identity response obtained via STS.

`awsRegion` ¶

import { aws } from '@gcix/gcix'

aws.AWSAccount.awsRegion()

Retrieves the AWS region associated with the current AWS credentials or environment.

If available, it uses the environment variable AWS_DEFAULT_REGION. Otherwise, it fetches the AWS region from the caller identity response obtained via STS.

CdkBootstrap ¶

Implements: ICdkBootstrap

Creates an instance of Bootstrap.

Initializers ¶

import { aws } from '@gcix/gcix'

new aws.CdkBootstrap(props: CdkBootstrapProps)

Name	Type	Description
`props`	`CdkBootstrapProps`	No description.

`props`^Required ¶

Type: CdkBootstrapProps

Methods ¶

Name	Description
`addDependencies`	No description.
`addNeeds`	No description.
`addParent`	This method is called by `gcix.JobCollection`s when the job is added to that JobCollection.
`addTags`	No description.
`addVariables`	No description.
`appendRules`	No description.
`appendScripts`	No description.
`assignAllowFailure`	No description.
`assignArtifacts`	No description.
`assignCache`	No description.
`assignDependencies`	No description.
`assignImage`	Sets the image of this job.
`assignNeeds`	No description.
`assignTags`	No description.
`copy`	Returns an independent, deep copy object of this job.
`extendName`	This method is used by `gcix.JobCollection`s to populate the jobs name.
`extendStage`	This method is used by `gcix.JobCollection`s to populate the jobs name and stage.
`extendStageValue`	This method is used by `gcix.JobCollection`s to populate the jobs stage.
`getAllInstanceNames`	Return all instance names from the given child.
`isEqual`	`isEqual` checks if `this` object is equal to given object.
`prependRules`	No description.
`prependScripts`	No description.
`render`	Returns a representation of any object which implements `IBase`.

`addDependencies` ¶

public addDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addNeeds` ¶

public addNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addParent` ¶

public addParent(parent: Job | JobCollection): void

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

`parent`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`addTags` ¶

public addTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`addVariables` ¶

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

`variables`^Required ¶

Type: {[ key: string ]: string}

`appendRules` ¶

public appendRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`appendScripts` ¶

public appendScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`assignAllowFailure` ¶

public assignAllowFailure(allowFailure: boolean | number[]): Job

`allowFailure`^Required ¶

Type: boolean | number[]

`assignArtifacts` ¶

public assignArtifacts(artifacts: Artifacts): Job

`artifacts`^Required ¶

Type: @gcix/gcix.Artifacts

`assignCache` ¶

public assignCache(cache: Cache): Job

`cache`^Required ¶

Type: @gcix/gcix.Cache

`assignDependencies` ¶

public assignDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignImage` ¶

public assignImage(image: string | Image): Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

`image`^Required ¶

Type: string | @gcix/gcix.Image

`assignNeeds` ¶

public assignNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignTags` ¶

public assignTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`copy` ¶

public copy(): Job

Returns an independent, deep copy object of this job.

`extendName` ¶

public extendName(name: string): void

This method is used by gcix.JobCollections to populate the jobs name.

`name`^Required ¶

Type: string

`extendStage` ¶

public extendStage(stage: string): void

This method is used by gcix.JobCollections to populate the jobs name and stage.

`stage`^Required ¶

Type: string

`extendStageValue` ¶

public extendStageValue(stage: string): void

This method is used by gcix.JobCollections to populate the jobs stage.

`stage`^Required ¶

Type: string

`getAllInstanceNames` ¶

public getAllInstanceNames(child?: Job | JobCollection): OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

`child`^Optional ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`isEqual` ¶

public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

`comparable`^Required ¶

Type: @gcix/gcix.IBase

`prependRules` ¶

public prependRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`prependScripts` ¶

public prependScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`render` ¶

public render(): any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties ¶

Name	Type	Description
`tags`	`string[]`	Getter method to receive added tags.
`allowFailure`	`string \| boolean \| number[]`	No description.
`name`	`string`	No description.
`orderedTags`	`@gcix/gcix.OrderedStringSet`	No description.
`parents`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection[]`	No description.
`scripts`	`string[]`	No description.
`stage`	`string`	No description.
`artifacts`	`@gcix/gcix.Artifacts`	No description.
`cache`	`@gcix/gcix.Cache`	No description.
`dependencies`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`image`	`@gcix/gcix.Image`	No description.
`needs`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`original`	`@gcix/gcix.Job`	No description.
`rules`	`@gcix/gcix.Rule[]`	No description.
`variables`	`{[ key: string ]: string}`	No description.
`awsAccountId`	`string`	The AWS account ID associated with the Bootstrap configuration.
`awsRegion`	`string`	The AWS region in which the Bootstrap will be performed.
`jobName`	`string`	The name of the Bootstrap job.
`jobStage`	`string`	The stage of the Bootstrap job.
`qualifier`	`string`	The qualifier applied to the Bootstrap.
`toolkitStackName`	`string`	The name of the toolkit stack used for Bootstrap.
`resourceTags`	`{[ key: string ]: string}`	Optional resource tags that can be applied during Bootstrap.

`tags`^Required ¶

public readonly tags: string[];

Type: string[]

Getter method to receive added tags.

`allowFailure`^Required ¶

public readonly allowFailure: string | boolean | number[];

Type: string | boolean | number[]

`name`^Required ¶

public readonly name: string;

Type: string

`orderedTags`^Required ¶

public readonly orderedTags: OrderedStringSet;

Type: @gcix/gcix.OrderedStringSet

`parents`^Required ¶

public readonly parents: Job | JobCollection[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]

`scripts`^Required ¶

public readonly scripts: string[];

Type: string[]

`stage`^Required ¶

public readonly stage: string;

Type: string

`artifacts`^Optional ¶

public readonly artifacts: Artifacts;

Type: @gcix/gcix.Artifacts

`cache`^Optional ¶

public readonly cache: Cache;

Type: @gcix/gcix.Cache

`dependencies`^Optional ¶

public readonly dependencies: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`image`^Optional ¶

public readonly image: Image;

Type: @gcix/gcix.Image

`needs`^Optional ¶

public readonly needs: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`original`^Optional ¶

public readonly original: Job;

Type: @gcix/gcix.Job

`rules`^Optional ¶

public readonly rules: Rule[];

Type: @gcix/gcix.Rule[]

`variables`^Optional ¶

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

Type: {[ key: string ]: string}

`awsAccountId`^Required ¶

public readonly awsAccountId: string;

Type: string

The AWS account ID associated with the Bootstrap configuration.

`awsRegion`^Required ¶

public readonly awsRegion: string;

Type: string

The AWS region in which the Bootstrap will be performed.

`jobName`^Required ¶

public readonly jobName: string;

Type: string

The name of the Bootstrap job.

`jobStage`^Required ¶

public readonly jobStage: string;

Type: string

The stage of the Bootstrap job.

`qualifier`^Required ¶

public readonly qualifier: string;

Type: string

The qualifier applied to the Bootstrap.

`toolkitStackName`^Required ¶

public readonly toolkitStackName: string;

Type: string

The name of the toolkit stack used for Bootstrap.

`resourceTags`^Optional ¶

public readonly resourceTags: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional resource tags that can be applied during Bootstrap.

CdkDeploy ¶

Implements: ICdkDeploy

A class that manages the configuration and rendering of a Deploy job.

Inherits from the base Job class and implements the IDeploy interface.

Initializers ¶

import { aws } from '@gcix/gcix'

new aws.CdkDeploy(props: CdkDeployProps)

Name	Type	Description
`props`	`CdkDeployProps`	- Configuration properties for the Deploy job.

`props`^Required ¶

Type: CdkDeployProps

Configuration properties for the Deploy job.

Methods ¶

Name	Description
`addDependencies`	No description.
`addNeeds`	No description.
`addParent`	This method is called by `gcix.JobCollection`s when the job is added to that JobCollection.
`addTags`	No description.
`addVariables`	No description.
`appendRules`	No description.
`appendScripts`	No description.
`assignAllowFailure`	No description.
`assignArtifacts`	No description.
`assignCache`	No description.
`assignDependencies`	No description.
`assignImage`	Sets the image of this job.
`assignNeeds`	No description.
`assignTags`	No description.
`copy`	Returns an independent, deep copy object of this job.
`extendName`	This method is used by `gcix.JobCollection`s to populate the jobs name.
`extendStage`	This method is used by `gcix.JobCollection`s to populate the jobs name and stage.
`extendStageValue`	This method is used by `gcix.JobCollection`s to populate the jobs stage.
`getAllInstanceNames`	Return all instance names from the given child.
`isEqual`	`isEqual` checks if `this` object is equal to given object.
`prependRules`	No description.
`prependScripts`	No description.
`render`	Renders the Deploy job's configuration and scripts.

`addDependencies` ¶

public addDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addNeeds` ¶

public addNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addParent` ¶

public addParent(parent: Job | JobCollection): void

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

`parent`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`addTags` ¶

public addTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`addVariables` ¶

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

`variables`^Required ¶

Type: {[ key: string ]: string}

`appendRules` ¶

public appendRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`appendScripts` ¶

public appendScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`assignAllowFailure` ¶

public assignAllowFailure(allowFailure: boolean | number[]): Job

`allowFailure`^Required ¶

Type: boolean | number[]

`assignArtifacts` ¶

public assignArtifacts(artifacts: Artifacts): Job

`artifacts`^Required ¶

Type: @gcix/gcix.Artifacts

`assignCache` ¶

public assignCache(cache: Cache): Job

`cache`^Required ¶

Type: @gcix/gcix.Cache

`assignDependencies` ¶

public assignDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignImage` ¶

public assignImage(image: string | Image): Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

`image`^Required ¶

Type: string | @gcix/gcix.Image

`assignNeeds` ¶

public assignNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignTags` ¶

public assignTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`copy` ¶

public copy(): Job

Returns an independent, deep copy object of this job.

`extendName` ¶

public extendName(name: string): void

This method is used by gcix.JobCollections to populate the jobs name.

`name`^Required ¶

Type: string

`extendStage` ¶

public extendStage(stage: string): void

This method is used by gcix.JobCollections to populate the jobs name and stage.

`stage`^Required ¶

Type: string

`extendStageValue` ¶

public extendStageValue(stage: string): void

This method is used by gcix.JobCollections to populate the jobs stage.

`stage`^Required ¶

Type: string

`getAllInstanceNames` ¶

public getAllInstanceNames(child?: Job | JobCollection): OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

`child`^Optional ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`isEqual` ¶

public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

`comparable`^Required ¶

Type: @gcix/gcix.IBase

`prependRules` ¶

public prependRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`prependScripts` ¶

public prependScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`render` ¶

public render(): any

Renders the Deploy job's configuration and scripts.

Properties ¶

Name	Type	Description
`tags`	`string[]`	Getter method to receive added tags.
`allowFailure`	`string \| boolean \| number[]`	No description.
`name`	`string`	No description.
`orderedTags`	`@gcix/gcix.OrderedStringSet`	No description.
`parents`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection[]`	No description.
`scripts`	`string[]`	No description.
`stage`	`string`	No description.
`artifacts`	`@gcix/gcix.Artifacts`	No description.
`cache`	`@gcix/gcix.Cache`	No description.
`dependencies`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`image`	`@gcix/gcix.Image`	No description.
`needs`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`original`	`@gcix/gcix.Job`	No description.
`rules`	`@gcix/gcix.Rule[]`	No description.
`variables`	`{[ key: string ]: string}`	No description.
`stacks`	`string[]`	An array of stack names to be deployed.
`strict`	`boolean`	Flag indicating if strict deployment mode is enabled.
`waitForStack`	`boolean`	Flag indicating if the deployment should wait for stack completion.
`context`	`{[ key: string ]: string}`	Optional context values to provide additional information for deployment.
`deployOptions`	`string`	Optional deployment options.
`jobName`	`string`	An optional name for the Deploy job.
`jobStage`	`string`	An optional stage for the Deploy job.
`toolkitStackName`	`string`	Optional toolkit stack name used for deployment.
`waitForStackAccountId`	`string`	AWS account ID for stack waiting.
`waitForStackAssumeRole`	`string`	AWS assume role for stack waiting.

`tags`^Required ¶

public readonly tags: string[];

Type: string[]

Getter method to receive added tags.

`allowFailure`^Required ¶

public readonly allowFailure: string | boolean | number[];

Type: string | boolean | number[]

`name`^Required ¶

public readonly name: string;

Type: string

`orderedTags`^Required ¶

public readonly orderedTags: OrderedStringSet;

Type: @gcix/gcix.OrderedStringSet

`parents`^Required ¶

public readonly parents: Job | JobCollection[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]

`scripts`^Required ¶

public readonly scripts: string[];

Type: string[]

`stage`^Required ¶

public readonly stage: string;

Type: string

`artifacts`^Optional ¶

public readonly artifacts: Artifacts;

Type: @gcix/gcix.Artifacts

`cache`^Optional ¶

public readonly cache: Cache;

Type: @gcix/gcix.Cache

`dependencies`^Optional ¶

public readonly dependencies: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`image`^Optional ¶

public readonly image: Image;

Type: @gcix/gcix.Image

`needs`^Optional ¶

public readonly needs: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`original`^Optional ¶

public readonly original: Job;

Type: @gcix/gcix.Job

`rules`^Optional ¶

public readonly rules: Rule[];

Type: @gcix/gcix.Rule[]

`variables`^Optional ¶

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

Type: {[ key: string ]: string}

`stacks`^Required ¶

public readonly stacks: string[];

Type: string[]

An array of stack names to be deployed.

`strict`^Required ¶

public readonly strict: boolean;

Type: boolean

Flag indicating if strict deployment mode is enabled.

`waitForStack`^Required ¶

public readonly waitForStack: boolean;

Type: boolean

Flag indicating if the deployment should wait for stack completion.

`context`^Optional ¶

public readonly context: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional context values to provide additional information for deployment.

`deployOptions`^Optional ¶

public readonly deployOptions: string;

Type: string

Optional deployment options.

`jobName`^Optional ¶

public readonly jobName: string;

Type: string

An optional name for the Deploy job.

`jobStage`^Optional ¶

public readonly jobStage: string;

Type: string

An optional stage for the Deploy job.

`toolkitStackName`^Optional ¶

public readonly toolkitStackName: string;

Type: string

Optional toolkit stack name used for deployment.

`waitForStackAccountId`^Optional ¶

public readonly waitForStackAccountId: string;

Type: string

AWS account ID for stack waiting.

`waitForStackAssumeRole`^Optional ¶

public readonly waitForStackAssumeRole: string;

Type: string

AWS assume role for stack waiting.

CdkDiff ¶

Implements: ICdkDiff

A class that manages the configuration and rendering of a Diff job.

Inherits from the base Job class and implements the IDiff interface.

Initializers ¶

import { aws } from '@gcix/gcix'

new aws.CdkDiff(props: CdkDiffProps)

Name	Type	Description
`props`	`CdkDiffProps`	- Configuration properties for the Diff job.

`props`^Required ¶

Type: CdkDiffProps

Configuration properties for the Diff job.

Methods ¶

Name	Description
`addDependencies`	No description.
`addNeeds`	No description.
`addParent`	This method is called by `gcix.JobCollection`s when the job is added to that JobCollection.
`addTags`	No description.
`addVariables`	No description.
`appendRules`	No description.
`appendScripts`	No description.
`assignAllowFailure`	No description.
`assignArtifacts`	No description.
`assignCache`	No description.
`assignDependencies`	No description.
`assignImage`	Sets the image of this job.
`assignNeeds`	No description.
`assignTags`	No description.
`copy`	Returns an independent, deep copy object of this job.
`extendName`	This method is used by `gcix.JobCollection`s to populate the jobs name.
`extendStage`	This method is used by `gcix.JobCollection`s to populate the jobs name and stage.
`extendStageValue`	This method is used by `gcix.JobCollection`s to populate the jobs stage.
`getAllInstanceNames`	Return all instance names from the given child.
`isEqual`	`isEqual` checks if `this` object is equal to given object.
`prependRules`	No description.
`prependScripts`	No description.
`render`	Returns a representation of any object which implements `IBase`.

`addDependencies` ¶

public addDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addNeeds` ¶

public addNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addParent` ¶

public addParent(parent: Job | JobCollection): void

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

`parent`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`addTags` ¶

public addTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`addVariables` ¶

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

`variables`^Required ¶

Type: {[ key: string ]: string}

`appendRules` ¶

public appendRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`appendScripts` ¶

public appendScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`assignAllowFailure` ¶

public assignAllowFailure(allowFailure: boolean | number[]): Job

`allowFailure`^Required ¶

Type: boolean | number[]

`assignArtifacts` ¶

public assignArtifacts(artifacts: Artifacts): Job

`artifacts`^Required ¶

Type: @gcix/gcix.Artifacts

`assignCache` ¶

public assignCache(cache: Cache): Job

`cache`^Required ¶

Type: @gcix/gcix.Cache

`assignDependencies` ¶

public assignDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignImage` ¶

public assignImage(image: string | Image): Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

`image`^Required ¶

Type: string | @gcix/gcix.Image

`assignNeeds` ¶

public assignNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignTags` ¶

public assignTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`copy` ¶

public copy(): Job

Returns an independent, deep copy object of this job.

`extendName` ¶

public extendName(name: string): void

This method is used by gcix.JobCollections to populate the jobs name.

`name`^Required ¶

Type: string

`extendStage` ¶

public extendStage(stage: string): void

This method is used by gcix.JobCollections to populate the jobs name and stage.

`stage`^Required ¶

Type: string

`extendStageValue` ¶

public extendStageValue(stage: string): void

This method is used by gcix.JobCollections to populate the jobs stage.

`stage`^Required ¶

Type: string

`getAllInstanceNames` ¶

public getAllInstanceNames(child?: Job | JobCollection): OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

`child`^Optional ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`isEqual` ¶

public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

`comparable`^Required ¶

Type: @gcix/gcix.IBase

`prependRules` ¶

public prependRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`prependScripts` ¶

public prependScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`render` ¶

public render(): any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties ¶

Name	Type	Description
`tags`	`string[]`	Getter method to receive added tags.
`allowFailure`	`string \| boolean \| number[]`	No description.
`name`	`string`	No description.
`orderedTags`	`@gcix/gcix.OrderedStringSet`	No description.
`parents`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection[]`	No description.
`scripts`	`string[]`	No description.
`stage`	`string`	No description.
`artifacts`	`@gcix/gcix.Artifacts`	No description.
`cache`	`@gcix/gcix.Cache`	No description.
`dependencies`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`image`	`@gcix/gcix.Image`	No description.
`needs`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`original`	`@gcix/gcix.Job`	No description.
`rules`	`@gcix/gcix.Rule[]`	No description.
`variables`	`{[ key: string ]: string}`	No description.
`stacks`	`string[]`	An array of stack names for which to generate a diff.
`context`	`{[ key: string ]: string}`	Optional context values to provide additional information for the diff.
`diffOptions`	`string`	Optional diff options to customize the diff process.
`jobName`	`string`	An optional name for the Diff job.
`jobStage`	`string`	An optional stage for the Diff job.

`tags`^Required ¶

public readonly tags: string[];

Type: string[]

Getter method to receive added tags.

`allowFailure`^Required ¶

public readonly allowFailure: string | boolean | number[];

Type: string | boolean | number[]

`name`^Required ¶

public readonly name: string;

Type: string

`orderedTags`^Required ¶

public readonly orderedTags: OrderedStringSet;

Type: @gcix/gcix.OrderedStringSet

`parents`^Required ¶

public readonly parents: Job | JobCollection[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]

`scripts`^Required ¶

public readonly scripts: string[];

Type: string[]

`stage`^Required ¶

public readonly stage: string;

Type: string

`artifacts`^Optional ¶

public readonly artifacts: Artifacts;

Type: @gcix/gcix.Artifacts

`cache`^Optional ¶

public readonly cache: Cache;

Type: @gcix/gcix.Cache

`dependencies`^Optional ¶

public readonly dependencies: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`image`^Optional ¶

public readonly image: Image;

Type: @gcix/gcix.Image

`needs`^Optional ¶

public readonly needs: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`original`^Optional ¶

public readonly original: Job;

Type: @gcix/gcix.Job

`rules`^Optional ¶

public readonly rules: Rule[];

Type: @gcix/gcix.Rule[]

`variables`^Optional ¶

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

Type: {[ key: string ]: string}

`stacks`^Required ¶

public readonly stacks: string[];

Type: string[]

An array of stack names for which to generate a diff.

`context`^Optional ¶

public readonly context: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional context values to provide additional information for the diff.

`diffOptions`^Optional ¶

public readonly diffOptions: string;

Type: string

Optional diff options to customize the diff process.

`jobName`^Optional ¶

public readonly jobName: string;

Type: string

An optional name for the Diff job.

`jobStage`^Optional ¶

public readonly jobStage: string;

Type: string

An optional stage for the Diff job.

CdkDiffDeploy ¶

Implements: ICdkDiffDeploy

A class that manages the configuration and execution of combined Diff and Deploy operations.

Inherits from the base JobCollection class and implements the IDiffDeploy interface.

Initializers ¶

import { aws } from '@gcix/gcix'

new aws.CdkDiffDeploy(props: CdkDiffDeployProps)

Name	Type	Description
`props`	`CdkDiffDeployProps`	- Configuration properties for the DiffDeploy job collection.

`props`^Required ¶

Type: CdkDiffDeployProps

Configuration properties for the DiffDeploy job collection.

Methods ¶

Name	Description
`addChildren`	Add `gcix.Job`s or other `gcix.JobCollection`s to this JobCollection.
`addDependencies`	No description.
`addNeeds`	No description.
`addParent`	No description.
`addTags`	No description.
`addVariables`	No description.
`appendRules`	No description.
`appendScripts`	No description.
`assignArtifacts`	No description.
`assignCache`	No description.
`getAllInstanceNames`	Return all instance names from the given child.
`initializeAllowFailure`	Calling `gcix.Job.assignAllowFailure()` to all jobs within this JobCollection that haven't been set the allowFailure before.
`initializeArtifacts`	Sets `gcix.Job.artifacts` to all jobs within this JobCollection that haven't been set the artifacs before.
`initializeCache`	Calling `gcix.Job.assigneCache()` to all jobs within this JobCollection that haven't been set the cache before.
`initializeDependencies`	Calling `gcix.Job.assignDependencies()` to all jobs within the first stage of this JobCollection that haven't been added dependencies before.
`initializeImage`	Calling `gcix.Job.assignImage()` to all jobs within this JobCollection.
`initializeNeeds`	Calling `gcix.Job.assignNeeds()` to all jobs within the first stage of this JobCollection that haven't been added needs before.
`initializeRules`	Calling `gcix.Job.append_rules()` to all jobs within this JobCollection that haven't been added rules before.
`initializeTags`	Calling `gcix.Job.addTags([...])` to all jobs within this JobCollection that haven't been added tags before.
`initializeVariables`	Calling `gcix.Job.addVariables({...})` to all jobs within this JobCollection that haven't been added variables before.
`isEqual`	`isEqual` checks if `this` object is equal to given object.
`overrideAllowFailure`	Calling `gcix.Job.assignAllowFailure()` to all jobs within this JobCollection overriding any previous set value.
`overrideDependencies`	Calling `gcix.Job.assignDependencies()` to all jobs within the first stage of this JobCollection and overriding any previously added dependencies to that jobs.
`overrideImage`	Calling `gcix.Job.assignImage()` to all jobs within this JobCollection overriding any previous set value.
`overrideNeeds`	Calling `gcix.Job.assignNeeds()` to all jobs within the first stage of this JobCollection and overriding any previously added needs to that jobs.
`overrideRules`	Calling `gcix.Job.overrideRules()` to all jobs within this JobCollection and overriding any previously added rules to that jobs.
`overrideTags`	Calling `gcix.Job.addTags([...])` to all jobs within this JobCollection and overriding any previously added tags to that jobs.
`overrideVariables`	Calling `gcix.Job.addVariables({...})` to all jobs within this JobCollection and overriding any previously added variables to that jobs.
`prependRules`	No description.
`prependScripts`	No description.
`render`	Returns a representation of any object which implements `IBase`.

`addChildren` ¶

public addChildren(props: AddChildrenProps): JobCollection

Add gcix.Jobs or other gcix.JobCollections to this JobCollection.

Adding a child creates a copy of that child. You should provide a name or stage when adding children, to make them different from other places where they will be used.

`props`^Required ¶

Type: @gcix/gcix.AddChildrenProps

`addDependencies` ¶

public addDependencies(dependencies: Job | JobCollection | Need[]): JobCollection

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addNeeds` ¶

public addNeeds(needs: Job | JobCollection | Need[]): JobCollection

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addParent` ¶

public addParent(parent: JobCollection): void

`parent`^Required ¶

Type: @gcix/gcix.JobCollection

`addTags` ¶

public addTags(tags: string[]): JobCollection

`tags`^Required ¶

Type: string[]

`addVariables` ¶

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

`variables`^Required ¶

Type: {[ key: string ]: string}

`appendRules` ¶

public appendRules(rules: Rule[]): JobCollection

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`appendScripts` ¶

public appendScripts(scripts: string[]): JobCollection

`scripts`^Required ¶

Type: string[]

`assignArtifacts` ¶

public assignArtifacts(artifacts: Artifacts): JobCollection

`artifacts`^Required ¶

Type: @gcix/gcix.Artifacts

`assignCache` ¶

public assignCache(cache: Cache): JobCollection

`cache`^Required ¶

Type: @gcix/gcix.Cache

`getAllInstanceNames` ¶

public getAllInstanceNames(child?: Job | JobCollection): OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this JobCollection and all parent JobCollection's.

`child`^Optional ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`initializeAllowFailure` ¶

public initializeAllowFailure(allowFailure: boolean | number[]): JobCollection

Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection that haven't been set the allowFailure before.

`allowFailure`^Required ¶

Type: boolean | number[]

`initializeArtifacts` ¶

public initializeArtifacts(artifacts: Artifacts): JobCollection

Sets gcix.Job.artifacts to all jobs within this JobCollection that haven't been set the artifacs before.

`artifacts`^Required ¶

Type: @gcix/gcix.Artifacts

`initializeCache` ¶

public initializeCache(cache: Cache): JobCollection

Calling gcix.Job.assigneCache() to all jobs within this JobCollection that haven't been set the cache before.

`cache`^Required ¶

Type: @gcix/gcix.Cache

`initializeDependencies` ¶

public initializeDependencies(dependencies: Job | JobCollection | Need[]): JobCollection

Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection that haven't been added dependencies before.

An empty parameter list means that jobs will get an empty dependency list and thus does not download artifacts by default.

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`initializeImage` ¶

public initializeImage(image: string | Image): JobCollection

Calling gcix.Job.assignImage() to all jobs within this JobCollection.

`image`^Required ¶

Type: string | @gcix/gcix.Image

`initializeNeeds` ¶

public initializeNeeds(needs: Job | JobCollection | Need[]): JobCollection

Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection that haven't been added needs before.

An empty parameter list means that jobs will get an empty dependency list and thus does not depend on other jobs by default.

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`initializeRules` ¶

public initializeRules(rules: Rule[]): JobCollection

Calling gcix.Job.append_rules() to all jobs within this JobCollection that haven't been added rules before.

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`initializeTags` ¶

public initializeTags(tags: string[]): JobCollection

Calling gcix.Job.addTags([...]) to all jobs within this JobCollection that haven't been added tags before.

`tags`^Required ¶

Type: string[]

`initializeVariables` ¶

public initializeVariables(variables: {[ key: string ]: string}): JobCollection

Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection that haven't been added variables before.

`variables`^Required ¶

Type: {[ key: string ]: string}

`isEqual` ¶

public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

`comparable`^Required ¶

Type: @gcix/gcix.IBase

`overrideAllowFailure` ¶

public overrideAllowFailure(allowFailure: boolean | number[]): JobCollection

Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection overriding any previous set value.

`allowFailure`^Required ¶

Type: boolean | number[]

`overrideDependencies` ¶

public overrideDependencies(dependencies: Job | JobCollection | Need[]): JobCollection

Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection and overriding any previously added dependencies to that jobs.

An empty parameter list means that jobs will get an empty dependency list and thus does not download artifacts.

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`overrideImage` ¶

public overrideImage(image: string | Image): JobCollection

Calling gcix.Job.assignImage() to all jobs within this JobCollection overriding any previous set value.

`image`^Required ¶

Type: string | @gcix/gcix.Image

`overrideNeeds` ¶

public overrideNeeds(needs: Job | JobCollection | Need[]): JobCollection

Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection and overriding any previously added needs to that jobs.

An empty parameter list means that jobs will get an empty dependency list and thus does not depend on other jobs.

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`overrideRules` ¶

public overrideRules(rules: Rule[]): JobCollection

Calling gcix.Job.overrideRules() to all jobs within this JobCollection and overriding any previously added rules to that jobs.

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`overrideTags` ¶

public overrideTags(tags: string[]): JobCollection

Calling gcix.Job.addTags([...]) to all jobs within this JobCollection and overriding any previously added tags to that jobs.

`tags`^Required ¶

Type: string[]

`overrideVariables` ¶

public overrideVariables(variables: {[ key: string ]: string}): JobCollection

Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection and overriding any previously added variables to that jobs.

`variables`^Required ¶

Type: {[ key: string ]: string}

`prependRules` ¶

public prependRules(rules: Rule[]): JobCollection

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`prependScripts` ¶

public prependScripts(scripts: string[]): JobCollection

`scripts`^Required ¶

Type: string[]

`render` ¶

public render(): any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties ¶

Name	Type	Description
`lastJobsExecuted`	`@gcix/gcix.Job[]`	This property returns all Jobs from the last stage of this JobCollection.
`nestedJobs`	`@gcix/gcix.Job[]`	No description.
`populatedJobs`	`@gcix/gcix.Job[]`	Returns a list with populated copies of all nested jobs of this JobCollection.
`children`	`@gcix/gcix.ChildDict[]`	No description.
`orderedTags`	`@gcix/gcix.OrderedStringSet`	No description.
`orderedTagsForInitialization`	`@gcix/gcix.OrderedStringSet`	No description.
`orderedTagsForReplacement`	`@gcix/gcix.OrderedStringSet`	No description.
`parents`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection[]`	No description.
`allowFailureForInitialization`	`string \| boolean \| number[]`	No description.
`allowFailureForReplacement`	`string \| boolean \| number[]`	No description.
`artifacts`	`@gcix/gcix.Artifacts`	No description.
`artifactsForInitialization`	`@gcix/gcix.Artifacts`	No description.
`artifactsForReplacement`	`@gcix/gcix.Artifacts`	No description.
`cache`	`@gcix/gcix.Cache`	No description.
`cacheForInitialization`	`@gcix/gcix.Cache`	No description.
`dependencies`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`dependenciesForInitialization`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`dependenciesForReplacement`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`imageForInitialization`	`string \| @gcix/gcix.Image`	No description.
`imageForReplacement`	`string \| @gcix/gcix.Image`	No description.
`needs`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`needsForInitialization`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`needsForReplacement`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`rulesForInitialization`	`@gcix/gcix.Rule[]`	No description.
`rulesForReplacement`	`@gcix/gcix.Rule[]`	No description.
`rulesToAppend`	`@gcix/gcix.Rule[]`	No description.
`rulesToPrepend`	`@gcix/gcix.Rule[]`	No description.
`scriptsToAppend`	`string[]`	No description.
`scriptsToPrepend`	`string[]`	No description.
`variables`	`{[ key: string ]: string}`	No description.
`variablesForInitialization`	`{[ key: string ]: string}`	No description.
`variablesForReplacement`	`{[ key: string ]: string}`	No description.
`deployJob`	`CdkDeploy`	The instance of the Deploy job associated with this DiffDeploy instance.
`diffJob`	`CdkDiff`	The instance of the Diff job associated with this DiffDeploy instance.
`stacks`	`string[]`	An array of stack names for which to generate a diff and perform deployment.
`context`	`{[ key: string ]: string}`	Optional context values to provide additional information for the diff and deployment.

`lastJobsExecuted`^Required ¶

public readonly lastJobsExecuted: Job[];

Type: @gcix/gcix.Job[]

This property returns all Jobs from the last stage of this JobCollection.

This is typically be requested from a job which has setup this JobCollection as need, to determine all actual jobs of this JobCollection as need.

`nestedJobs`^Required ¶

public readonly nestedJobs: Job[];

Type: @gcix/gcix.Job[]

`populatedJobs`^Required ¶

public readonly populatedJobs: Job[];

Type: @gcix/gcix.Job[]

Returns a list with populated copies of all nested jobs of this JobCollection.

Populated means, that all attributes of a Job which depends on its context are resolved to their final values. The context is primarily the JobCollection within the jobs resides but also dependencies to other jobs and JobCollection's. Thus this JobCollection will apply its own configuration, like variables to add, tags to set, etc., to all its jobs and JobCollection's.

Copies means what it says, that the returned job are not the same job objects, originally added to this JobCollection, but copies of them.

Nested means, that also jobs from JobCollection's within this JobCollection, are returned, as well as jobs from JobCollection's within JobCollection's within this JobCollection and so on.

`children`^Required ¶

public readonly children: ChildDict[];

Type: @gcix/gcix.ChildDict[]

`orderedTags`^Required ¶

public readonly orderedTags: OrderedStringSet;

Type: @gcix/gcix.OrderedStringSet

`orderedTagsForInitialization`^Required ¶

public readonly orderedTagsForInitialization: OrderedStringSet;

Type: @gcix/gcix.OrderedStringSet

`orderedTagsForReplacement`^Required ¶

public readonly orderedTagsForReplacement: OrderedStringSet;

Type: @gcix/gcix.OrderedStringSet

`parents`^Required ¶

public readonly parents: Job | JobCollection[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]

`allowFailureForInitialization`^Optional ¶

public readonly allowFailureForInitialization: string | boolean | number[];

Type: string | boolean | number[]

`allowFailureForReplacement`^Optional ¶

public readonly allowFailureForReplacement: string | boolean | number[];

Type: string | boolean | number[]

`artifacts`^Optional ¶

public readonly artifacts: Artifacts;

Type: @gcix/gcix.Artifacts

`artifactsForInitialization`^Optional ¶

public readonly artifactsForInitialization: Artifacts;

Type: @gcix/gcix.Artifacts

`artifactsForReplacement`^Optional ¶

public readonly artifactsForReplacement: Artifacts;

Type: @gcix/gcix.Artifacts

`cache`^Optional ¶

public readonly cache: Cache;

Type: @gcix/gcix.Cache

`cacheForInitialization`^Optional ¶

public readonly cacheForInitialization: Cache;

Type: @gcix/gcix.Cache

`dependencies`^Optional ¶

public readonly dependencies: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`dependenciesForInitialization`^Optional ¶

public readonly dependenciesForInitialization: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`dependenciesForReplacement`^Optional ¶

public readonly dependenciesForReplacement: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`imageForInitialization`^Optional ¶

public readonly imageForInitialization: string | Image;

Type: string | @gcix/gcix.Image

`imageForReplacement`^Optional ¶

public readonly imageForReplacement: string | Image;

Type: string | @gcix/gcix.Image

`needs`^Optional ¶

public readonly needs: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`needsForInitialization`^Optional ¶

public readonly needsForInitialization: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`needsForReplacement`^Optional ¶

public readonly needsForReplacement: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`rulesForInitialization`^Optional ¶

public readonly rulesForInitialization: Rule[];

Type: @gcix/gcix.Rule[]

`rulesForReplacement`^Optional ¶

public readonly rulesForReplacement: Rule[];

Type: @gcix/gcix.Rule[]

`rulesToAppend`^Optional ¶

public readonly rulesToAppend: Rule[];

Type: @gcix/gcix.Rule[]

`rulesToPrepend`^Optional ¶

public readonly rulesToPrepend: Rule[];

Type: @gcix/gcix.Rule[]

`scriptsToAppend`^Optional ¶

public readonly scriptsToAppend: string[];

Type: string[]

`scriptsToPrepend`^Optional ¶

public readonly scriptsToPrepend: string[];

Type: string[]

`variables`^Optional ¶

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

Type: {[ key: string ]: string}

`variablesForInitialization`^Optional ¶

public readonly variablesForInitialization: {[ key: string ]: string};

Type: {[ key: string ]: string}

`variablesForReplacement`^Optional ¶

public readonly variablesForReplacement: {[ key: string ]: string};

Type: {[ key: string ]: string}

`deployJob`^Required ¶

public readonly deployJob: CdkDeploy;

Type: CdkDeploy

The instance of the Deploy job associated with this DiffDeploy instance.

`diffJob`^Required ¶

public readonly diffJob: CdkDiff;

Type: CdkDiff

The instance of the Diff job associated with this DiffDeploy instance.

`stacks`^Required ¶

public readonly stacks: string[];

Type: string[]

An array of stack names for which to generate a diff and perform deployment.

`context`^Optional ¶

public readonly context: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional context values to provide additional information for the diff and deployment.

CdkMirrorToCodecommit ¶

Implements: ICdkMirrorToCodecommit

This job clones the CI_COMMIT_REF_NAME of the current repository and forcefully pushes this REF to a AWS CodeCommit repository.

This job requires following IAM permissions:

codecommit:CreateRepository
codecommit:GetRepository
codecommit:CreateBranch
codecommit:GitPush
codecommit:TagResource

You could also limit the resource to !Sub arn:aws:codecommit:${AWS::Region}:${AWS::AccountId}:<repository-name>.

Initializers ¶

import { aws } from '@gcix/gcix'

new aws.CdkMirrorToCodecommit(props: CdkMirrorToCodecommitProps)

Name	Type	Description
`props`	`CdkMirrorToCodecommitProps`	No description.

`props`^Required ¶

Type: CdkMirrorToCodecommitProps

Methods ¶

Name	Description
`addDependencies`	No description.
`addNeeds`	No description.
`addParent`	This method is called by `gcix.JobCollection`s when the job is added to that JobCollection.
`addTags`	No description.
`addVariables`	No description.
`appendRules`	No description.
`appendScripts`	No description.
`assignAllowFailure`	No description.
`assignArtifacts`	No description.
`assignCache`	No description.
`assignDependencies`	No description.
`assignImage`	Sets the image of this job.
`assignNeeds`	No description.
`assignTags`	No description.
`copy`	Returns an independent, deep copy object of this job.
`extendName`	This method is used by `gcix.JobCollection`s to populate the jobs name.
`extendStage`	This method is used by `gcix.JobCollection`s to populate the jobs name and stage.
`extendStageValue`	This method is used by `gcix.JobCollection`s to populate the jobs stage.
`getAllInstanceNames`	Return all instance names from the given child.
`isEqual`	`isEqual` checks if `this` object is equal to given object.
`prependRules`	No description.
`prependScripts`	No description.
`render`	Returns a representation of any object which implements `IBase`.

`addDependencies` ¶

public addDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addNeeds` ¶

public addNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`addParent` ¶

public addParent(parent: Job | JobCollection): void

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

`parent`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`addTags` ¶

public addTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`addVariables` ¶

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

`variables`^Required ¶

Type: {[ key: string ]: string}

`appendRules` ¶

public appendRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`appendScripts` ¶

public appendScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`assignAllowFailure` ¶

public assignAllowFailure(allowFailure: boolean | number[]): Job

`allowFailure`^Required ¶

Type: boolean | number[]

`assignArtifacts` ¶

public assignArtifacts(artifacts: Artifacts): Job

`artifacts`^Required ¶

Type: @gcix/gcix.Artifacts

`assignCache` ¶

public assignCache(cache: Cache): Job

`cache`^Required ¶

Type: @gcix/gcix.Cache

`assignDependencies` ¶

public assignDependencies(dependencies: Job | JobCollection | Need[]): Job

`dependencies`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignImage` ¶

public assignImage(image: string | Image): Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

`image`^Required ¶

Type: string | @gcix/gcix.Image

`assignNeeds` ¶

public assignNeeds(needs: Job | JobCollection | Need[]): Job

`needs`^Required ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`assignTags` ¶

public assignTags(tags: string[]): Job

`tags`^Required ¶

Type: string[]

`copy` ¶

public copy(): Job

Returns an independent, deep copy object of this job.

`extendName` ¶

public extendName(name: string): void

This method is used by gcix.JobCollections to populate the jobs name.

`name`^Required ¶

Type: string

`extendStage` ¶

public extendStage(stage: string): void

This method is used by gcix.JobCollections to populate the jobs name and stage.

`stage`^Required ¶

Type: string

`extendStageValue` ¶

public extendStageValue(stage: string): void

This method is used by gcix.JobCollections to populate the jobs stage.

`stage`^Required ¶

Type: string

`getAllInstanceNames` ¶

public getAllInstanceNames(child?: Job | JobCollection): OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

`child`^Optional ¶

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection

`isEqual` ¶

public isEqual(comparable: IBase): boolean

isEqual checks if this object is equal to given object.

`comparable`^Required ¶

Type: @gcix/gcix.IBase

`prependRules` ¶

public prependRules(rules: Rule[]): Job

`rules`^Required ¶

Type: @gcix/gcix.Rule[]

`prependScripts` ¶

public prependScripts(scripts: string[]): Job

`scripts`^Required ¶

Type: string[]

`render` ¶

public render(): any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties ¶

Name	Type	Description
`tags`	`string[]`	Getter method to receive added tags.
`allowFailure`	`string \| boolean \| number[]`	No description.
`name`	`string`	No description.
`orderedTags`	`@gcix/gcix.OrderedStringSet`	No description.
`parents`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection[]`	No description.
`scripts`	`string[]`	No description.
`stage`	`string`	No description.
`artifacts`	`@gcix/gcix.Artifacts`	No description.
`cache`	`@gcix/gcix.Cache`	No description.
`dependencies`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`image`	`@gcix/gcix.Image`	No description.
`needs`	`@gcix/gcix.Job \| @gcix/gcix.JobCollection \| @gcix/gcix.Need[]`	No description.
`original`	`@gcix/gcix.Job`	No description.
`rules`	`@gcix/gcix.Rule[]`	No description.
`variables`	`{[ key: string ]: string}`	No description.
`gitConfigUserEmail`	`string`	The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.
`gitConfigUserName`	`string`	The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.
`remoteRepository`	`string`	The git repository the code of the pipelines repository should be mirrored to.
`scriptHook`	`string[]`	This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.
`privateKeyVariable`	`string`	DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.
`runOnlyForRepositoryUrl`	`string`	When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.
`repositoryName`	`string`	The name of the target Codecommit repository.
`awsRegion`	`string`	The AWS region you want to operate in.
`infrastructureTags`	`string`	Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.
`mirrorOpts`	`@gcix/gcix.git.GitMirrorProps`	No description.

`tags`^Required ¶

public readonly tags: string[];

Type: string[]

Getter method to receive added tags.

`allowFailure`^Required ¶

public readonly allowFailure: string | boolean | number[];

Type: string | boolean | number[]

`name`^Required ¶

public readonly name: string;

Type: string

`orderedTags`^Required ¶

public readonly orderedTags: OrderedStringSet;

Type: @gcix/gcix.OrderedStringSet

`parents`^Required ¶

public readonly parents: Job | JobCollection[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection[]

`scripts`^Required ¶

public readonly scripts: string[];

Type: string[]

`stage`^Required ¶

public readonly stage: string;

Type: string

`artifacts`^Optional ¶

public readonly artifacts: Artifacts;

Type: @gcix/gcix.Artifacts

`cache`^Optional ¶

public readonly cache: Cache;

Type: @gcix/gcix.Cache

`dependencies`^Optional ¶

public readonly dependencies: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`image`^Optional ¶

public readonly image: Image;

Type: @gcix/gcix.Image

`needs`^Optional ¶

public readonly needs: Job | JobCollection | Need[];

Type: @gcix/gcix.Job | @gcix/gcix.JobCollection | @gcix/gcix.Need[]

`original`^Optional ¶

public readonly original: Job;

Type: @gcix/gcix.Job

`rules`^Optional ¶

public readonly rules: Rule[];

Type: @gcix/gcix.Rule[]

`variables`^Optional ¶

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

Type: {[ key: string ]: string}

`gitConfigUserEmail`^Required ¶

public readonly gitConfigUserEmail: string;

Type: string

The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.

`gitConfigUserName`^Required ¶

public readonly gitConfigUserName: string;

Type: string

The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.

`remoteRepository`^Required ¶

public readonly remoteRepository: string;

Type: string

The git repository the code of the pipelines repository should be mirrored to.

`scriptHook`^Required ¶

public readonly scriptHook: string[];

Type: string[]

This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.

This hook is mostly meant to be for git configuration commands, required to push to the remote repository.

`privateKeyVariable`^Optional ¶

public readonly privateKeyVariable: string;

Type: string

DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.

`runOnlyForRepositoryUrl`^Optional ¶

public readonly runOnlyForRepositoryUrl: string;

Type: string

When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.

With this variable the job only runs, when its value matches the CI_REPOSITORY_URL of the current repository.

`repositoryName`^Required ¶

public readonly repositoryName: string;

Type: string

The name of the target Codecommit repository.

`awsRegion`^Optional ¶

public readonly awsRegion: string;

Type: string

The AWS region you want to operate in.

When not set, it would be curl'ed from the current EC2 instance metadata.

`infrastructureTags`^Optional ¶

public readonly infrastructureTags: string;

Type: string

Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.

Changed values won't change the tags on an already existing ECR. This string must have the pattern: Tag1=Value1,Tag2=Value2

`mirrorOpts`^Optional ¶

public readonly mirrorOpts: GitMirrorProps;

Type: @gcix/gcix.git.GitMirrorProps

Protocols ¶

ICdkBootstrap ¶

Implemented By: CdkBootstrap, ICdkBootstrap

Represents the interface that a Bootstrap instance adheres to.

Properties ¶

Name	Type	Description
`awsAccountId`	`string`	The AWS account ID associated with the Bootstrap configuration.
`awsRegion`	`string`	The AWS region in which the Bootstrap will be performed.
`jobName`	`string`	The name of the Bootstrap job.
`jobStage`	`string`	The stage of the Bootstrap job.
`qualifier`	`string`	The qualifier applied to the Bootstrap.
`toolkitStackName`	`string`	The name of the toolkit stack used for Bootstrap.
`resourceTags`	`{[ key: string ]: string}`	Optional resource tags that can be applied during Bootstrap.

`awsAccountId`^Required ¶

public readonly awsAccountId: string;

Type: string

The AWS account ID associated with the Bootstrap configuration.

`awsRegion`^Required ¶

public readonly awsRegion: string;

Type: string

The AWS region in which the Bootstrap will be performed.

`jobName`^Required ¶

public readonly jobName: string;

Type: string

The name of the Bootstrap job.

`jobStage`^Required ¶

public readonly jobStage: string;

Type: string

The stage of the Bootstrap job.

`qualifier`^Required ¶

public readonly qualifier: string;

Type: string

The qualifier applied to the Bootstrap.

`toolkitStackName`^Required ¶

public readonly toolkitStackName: string;

Type: string

The name of the toolkit stack used for Bootstrap.

`resourceTags`^Optional ¶

public readonly resourceTags: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional resource tags that can be applied during Bootstrap.

ICdkDeploy ¶

Implemented By: CdkDeploy, ICdkDeploy

Represents the interface that a Deploy instance adheres to.

Properties ¶

Name	Type	Description
`stacks`	`string[]`	An array of stack names to be deployed.
`strict`	`boolean`	Flag indicating if strict deployment mode is enabled.
`waitForStack`	`boolean`	Flag indicating if the deployment should wait for stack completion.
`context`	`{[ key: string ]: string}`	Optional context values to provide additional information for deployment.
`deployOptions`	`string`	Optional deployment options.
`jobName`	`string`	An optional name for the Deploy job.
`jobStage`	`string`	An optional stage for the Deploy job.
`toolkitStackName`	`string`	Optional toolkit stack name used for deployment.
`waitForStackAccountId`	`string`	AWS account ID for stack waiting.
`waitForStackAssumeRole`	`string`	AWS assume role for stack waiting.

`stacks`^Required ¶

public readonly stacks: string[];

Type: string[]

An array of stack names to be deployed.

`strict`^Required ¶

public readonly strict: boolean;

Type: boolean

Flag indicating if strict deployment mode is enabled.

`waitForStack`^Required ¶

public readonly waitForStack: boolean;

Type: boolean

Flag indicating if the deployment should wait for stack completion.

`context`^Optional ¶

public readonly context: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional context values to provide additional information for deployment.

`deployOptions`^Optional ¶

public readonly deployOptions: string;

Type: string

Optional deployment options.

`jobName`^Optional ¶

public readonly jobName: string;

Type: string

An optional name for the Deploy job.

`jobStage`^Optional ¶

public readonly jobStage: string;

Type: string

An optional stage for the Deploy job.

`toolkitStackName`^Optional ¶

public readonly toolkitStackName: string;

Type: string

Optional toolkit stack name used for deployment.

`waitForStackAccountId`^Optional ¶

public readonly waitForStackAccountId: string;

Type: string

AWS account ID for stack waiting.

`waitForStackAssumeRole`^Optional ¶

public readonly waitForStackAssumeRole: string;

Type: string

AWS assume role for stack waiting.

ICdkDiff ¶

Implemented By: CdkDiff, ICdkDiff

Represents the interface that a Diff instance adheres to.

Properties ¶

Name	Type	Description
`stacks`	`string[]`	An array of stack names for which to generate a diff.
`context`	`{[ key: string ]: string}`	Optional context values to provide additional information for the diff.
`diffOptions`	`string`	Optional diff options to customize the diff process.
`jobName`	`string`	An optional name for the Diff job.
`jobStage`	`string`	An optional stage for the Diff job.

`stacks`^Required ¶

public readonly stacks: string[];

Type: string[]

An array of stack names for which to generate a diff.

`context`^Optional ¶

public readonly context: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional context values to provide additional information for the diff.

`diffOptions`^Optional ¶

public readonly diffOptions: string;

Type: string

Optional diff options to customize the diff process.

`jobName`^Optional ¶

public readonly jobName: string;

Type: string

An optional name for the Diff job.

`jobStage`^Optional ¶

public readonly jobStage: string;

Type: string

An optional stage for the Diff job.

ICdkDiffDeploy ¶

Implemented By: CdkDiffDeploy, ICdkDiffDeploy

Represents the interface that a DiffDeploy instance adheres to.

Properties ¶

Name	Type	Description
`deployJob`	`CdkDeploy`	The instance of the Deploy job associated with this DiffDeploy instance.
`diffJob`	`CdkDiff`	The instance of the Diff job associated with this DiffDeploy instance.
`stacks`	`string[]`	An array of stack names for which to generate a diff and perform deployment.
`context`	`{[ key: string ]: string}`	Optional context values to provide additional information for the diff and deployment.

`deployJob`^Required ¶

public readonly deployJob: CdkDeploy;

Type: CdkDeploy

The instance of the Deploy job associated with this DiffDeploy instance.

`diffJob`^Required ¶

public readonly diffJob: CdkDiff;

Type: CdkDiff

The instance of the Diff job associated with this DiffDeploy instance.

`stacks`^Required ¶

public readonly stacks: string[];

Type: string[]

An array of stack names for which to generate a diff and perform deployment.

`context`^Optional ¶

public readonly context: {[ key: string ]: string};

Type: {[ key: string ]: string}

Optional context values to provide additional information for the diff and deployment.

ICdkMirrorToCodecommit ¶

Extends: @gcix/gcix.git.IGitMirror
Implemented By: CdkMirrorToCodecommit, ICdkMirrorToCodecommit

Properties ¶

Name	Type	Description
`gitConfigUserEmail`	`string`	The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.
`gitConfigUserName`	`string`	The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.
`remoteRepository`	`string`	The git repository the code of the pipelines repository should be mirrored to.
`scriptHook`	`string[]`	This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.
`privateKeyVariable`	`string`	DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.
`runOnlyForRepositoryUrl`	`string`	When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.
`repositoryName`	`string`	The name of the target Codecommit repository.
`awsRegion`	`string`	The AWS region you want to operate in.
`infrastructureTags`	`string`	Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.

`gitConfigUserEmail`^Required ¶

public readonly gitConfigUserEmail: string;

Type: string

The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.

`gitConfigUserName`^Required ¶

public readonly gitConfigUserName: string;

Type: string

The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.

`remoteRepository`^Required ¶

public readonly remoteRepository: string;

Type: string

The git repository the code of the pipelines repository should be mirrored to.

`scriptHook`^Required ¶

public readonly scriptHook: string[];

Type: string[]

This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.

This hook is mostly meant to be for git configuration commands, required to push to the remote repository.

`privateKeyVariable`^Optional ¶

public readonly privateKeyVariable: string;

Type: string

DO NOT PROVIDE YOUR PRIVATE SSH KEY HERE!!! This parameter takes the name of the Gitlab environment variable, which contains the private ssh key used to push to the remote repository. This one should be created as protected and masked variable in the 'CI/CD' settings of your project.

`runOnlyForRepositoryUrl`^Optional ¶

public readonly runOnlyForRepositoryUrl: string;

Type: string

When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.

With this variable the job only runs, when its value matches the CI_REPOSITORY_URL of the current repository.

`repositoryName`^Required ¶

public readonly repositoryName: string;

Type: string
Default: CI_PROJECT_PATH_SLUG.

The name of the target Codecommit repository.

`awsRegion`^Optional ¶

public readonly awsRegion: string;

Type: string

The AWS region you want to operate in.

When not set, it would be curl'ed from the current EC2 instance metadata.

`infrastructureTags`^Optional ¶

public readonly infrastructureTags: string;

Type: string

Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.

Changed values won't change the tags on an already existing ECR. This string must have the pattern: Tag1=Value1,Tag2=Value2

aws Submodule ¶

Structs ¶

CdkBootstrapProps ¶

Initializer ¶

Properties ¶

awsAccountIdRequired ¶

awsRegionRequired ¶

qualifierRequired ¶

toolkitStackNameRequired ¶

jobNameOptional ¶

jobStageOptional ¶

resourceTagsOptional ¶

CdkDeployProps ¶

Initializer ¶

Properties ¶

stacksRequired ¶

contextOptional ¶

deployOptionsOptional ¶

jobNameOptional ¶

jobStageOptional ¶

strictOptional ¶

toolkitStackNameOptional ¶

waitForStackOptional ¶

waitForStackAccountIdOptional ¶

waitForStackAssumeRoleOptional ¶

CdkDiffDeployProps ¶

Initializer ¶

Properties ¶

stacksRequired ¶

contextOptional ¶

CdkDiffProps ¶

Initializer ¶

Properties ¶

stacksRequired ¶

contextOptional ¶

diffOptionsOptional ¶

jobNameOptional ¶

jobStageOptional ¶

CdkMirrorToCodecommitProps ¶

Initializer ¶

Properties ¶

awsRegionOptional ¶

infrastructureTagsOptional ¶

mirrorOptsOptional ¶

repositoryNameOptional ¶

Classes ¶

AWSAccount ¶

Initializers ¶

Static Functions ¶

awsAccountId ¶

awsRegion ¶

CdkBootstrap ¶

Initializers ¶

propsRequired ¶

Methods ¶

addDependencies ¶

dependenciesRequired ¶

addNeeds ¶

needsRequired ¶

addParent ¶

parentRequired ¶

addTags ¶

tagsRequired ¶

addVariables ¶

variablesRequired ¶

appendRules ¶

rulesRequired ¶

appendScripts ¶

scriptsRequired ¶

assignAllowFailure ¶

allowFailureRequired ¶

assignArtifacts ¶

artifactsRequired ¶

assignCache ¶

cacheRequired ¶

assignDependencies ¶

dependenciesRequired ¶

assignImage ¶

imageRequired ¶

assignNeeds ¶

`aws` Submodule ¶

`awsAccountId`^Required ¶

`awsRegion`^Required ¶

`qualifier`^Required ¶

`toolkitStackName`^Required ¶

`jobName`^Optional ¶

`jobStage`^Optional ¶

`resourceTags`^Optional ¶

`stacks`^Required ¶

`context`^Optional ¶

`deployOptions`^Optional ¶

`jobName`^Optional ¶

`jobStage`^Optional ¶

`strict`^Optional ¶

`toolkitStackName`^Optional ¶

`waitForStack`^Optional ¶

`waitForStackAccountId`^Optional ¶

`waitForStackAssumeRole`^Optional ¶

`stacks`^Required ¶

`context`^Optional ¶

`stacks`^Required ¶

`context`^Optional ¶

`diffOptions`^Optional ¶

`jobName`^Optional ¶

`jobStage`^Optional ¶

`awsRegion`^Optional ¶

`infrastructureTags`^Optional ¶

`mirrorOpts`^Optional ¶

`repositoryName`^Optional ¶

`awsAccountId` ¶

`awsRegion` ¶

`props`^Required ¶

`addDependencies` ¶

`dependencies`^Required ¶

`addNeeds` ¶

`needs`^Required ¶

`addParent` ¶

`parent`^Required ¶

`addTags` ¶

`tags`^Required ¶

`addVariables` ¶

`variables`^Required ¶

`appendRules` ¶

`rules`^Required ¶

`appendScripts` ¶

`scripts`^Required ¶

`assignAllowFailure` ¶

`allowFailure`^Required ¶

`assignArtifacts` ¶

`artifacts`^Required ¶

`assignCache` ¶

`cache`^Required ¶

`assignDependencies` ¶

`dependencies`^Required ¶

`assignImage` ¶

`image`^Required ¶

`assignNeeds` ¶

`needs`^Required ¶

`assignTags` ¶

`tags`^Required ¶

`copy` ¶

`extendName` ¶

`name`^Required ¶

`extendStage` ¶

`stage`^Required ¶

`extendStageValue` ¶

`stage`^Required ¶

`getAllInstanceNames` ¶

`child`^Optional ¶

`isEqual` ¶

`comparable`^Required ¶

`prependRules` ¶

`rules`^Required ¶

`prependScripts` ¶

`scripts`^Required ¶

`render` ¶

`tags`^Required ¶

`allowFailure`^Required ¶

`name`^Required ¶

`orderedTags`^Required ¶