Skip to content

aws Submodule

Structs

CdkBootstrapProps

Configuration properties for initializing a Bootstrap instance.

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from gcix import aws

aws.CdkBootstrapProps(
  aws_account_id: str,
  aws_region: str,
  qualifier: str,
  toolkit_stack_name: str,
  job_name: str = None,
  job_stage: str = None,
  resource_tags: typing.Mapping[str] = None
)

Properties

Name Type Description
aws_account_id str The AWS account ID associated with the Bootstrap configuration.
aws_region str The AWS region in which the Bootstrap will be performed.
qualifier str The qualifier applied to the Bootstrap.
toolkit_stack_name str The name of the toolkit stack used for Bootstrap.
job_name str An optional name for the Bootstrap job.
job_stage str An optional stage for the Bootstrap job.
resource_tags typing.Mapping[str] Optional resource tags that can be applied during Bootstrap.
aws_account_idRequired 
1
aws_account_id: str
  • Type: str

The AWS account ID associated with the Bootstrap configuration.

aws_regionRequired 
1
aws_region: str
  • Type: str

The AWS region in which the Bootstrap will be performed.

qualifierRequired 
1
qualifier: str
  • Type: str

The qualifier applied to the Bootstrap.

toolkit_stack_nameRequired 
1
toolkit_stack_name: str
  • Type: str

The name of the toolkit stack used for Bootstrap.

job_nameOptional 
1
job_name: str
  • Type: str

An optional name for the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

An optional stage for the Bootstrap job.

resource_tagsOptional 
1
resource_tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

Optional resource tags that can be applied during Bootstrap.

CdkDeployProps

Configuration properties for initializing a Deploy instance.

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from gcix import aws

aws.CdkDeployProps(
  stacks: typing.List[str],
  context: typing.Mapping[str] = None,
  deploy_options: str = None,
  job_name: str = None,
  job_stage: str = None,
  strict: bool = None,
  toolkit_stack_name: str = None,
  wait_for_stack: bool = None,
  wait_for_stack_account_id: str = None,
  wait_for_stack_assume_role: str = None
)

Properties

Name Type Description
stacks typing.List[str] An array of stack names to be deployed.
context typing.Mapping[str] Optional context values to provide additional information for deployment.
deploy_options str Optional deployment options.
job_name str An optional name for the Deploy job.
job_stage str An optional stage for the Deploy job.
strict bool Enable strict deployment mode.
toolkit_stack_name str Optional toolkit stack name used for deployment.
wait_for_stack bool Wait for stacks to complete deployment.
wait_for_stack_account_id str AWS account ID for stack waiting.
wait_for_stack_assume_role str AWS assume role for stack waiting.
stacksRequired 
1
stacks: typing.List[str]
  • Type: typing.List[str]

An array of stack names to be deployed.

contextOptional 
1
context: typing.Mapping[str]
  • Type: typing.Mapping[str]

Optional context values to provide additional information for deployment.

deploy_optionsOptional 
1
deploy_options: str
  • Type: str

Optional deployment options.

job_nameOptional 
1
job_name: str
  • Type: str

An optional name for the Deploy job.

job_stageOptional 
1
job_stage: str
  • Type: str

An optional stage for the Deploy job.

strictOptional 
1
strict: bool
  • Type: bool

Enable strict deployment mode.

toolkit_stack_nameOptional 
1
toolkit_stack_name: str
  • Type: str

Optional toolkit stack name used for deployment.

wait_for_stackOptional 
1
wait_for_stack: bool
  • Type: bool

Wait for stacks to complete deployment.

wait_for_stack_account_idOptional 
1
wait_for_stack_account_id: str
  • Type: str

AWS account ID for stack waiting.

wait_for_stack_assume_roleOptional 
1
wait_for_stack_assume_role: str
  • Type: str

AWS assume role for stack waiting.

CdkDiffDeployProps

Configuration properties for initializing a DiffDeploy instance.

Initializer 

1
2
3
4
5
6
from gcix import aws

aws.CdkDiffDeployProps(
  stacks: typing.List[str],
  context: typing.Mapping[str] = None
)

Properties

Name Type Description
stacks typing.List[str] An array of stack names for which to generate a diff and perform deployment.
context typing.Mapping[str] Optional context values to provide additional information for the diff and deployment.
stacksRequired 
1
stacks: typing.List[str]
  • Type: typing.List[str]

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

contextOptional 
1
context: typing.Mapping[str]
  • Type: typing.Mapping[str]

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

CdkDiffProps

Configuration properties for initializing a Diff instance.

Initializer 

1
2
3
4
5
6
7
8
9
from gcix import aws

aws.CdkDiffProps(
  stacks: typing.List[str],
  context: typing.Mapping[str] = None,
  diff_options: str = None,
  job_name: str = None,
  job_stage: str = None
)

Properties

Name Type Description
stacks typing.List[str] An array of stack names for which to generate a diff.
context typing.Mapping[str] Optional context values to provide additional information for the diff.
diff_options str Optional diff options to customize the diff process.
job_name str An optional name for the Diff job.
job_stage str An optional stage for the Diff job.
stacksRequired 
1
stacks: typing.List[str]
  • Type: typing.List[str]

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

contextOptional 
1
context: typing.Mapping[str]
  • Type: typing.Mapping[str]

Optional context values to provide additional information for the diff.

diff_optionsOptional 
1
diff_options: str
  • Type: str

Optional diff options to customize the diff process.

job_nameOptional 
1
job_name: str
  • Type: str

An optional name for the Diff job.

job_stageOptional 
1
job_stage: str
  • Type: str

An optional stage for the Diff job.

CdkMirrorToCodecommitProps

Initializer 

1
2
3
4
5
6
7
8
from gcix import aws

aws.CdkMirrorToCodecommitProps(
  aws_region: str = None,
  infrastructure_tags: str = None,
  mirror_opts: GitMirrorProps = None,
  repository_name: str = None
)

Properties

Name Type Description
aws_region str The AWS region you want to operate in.
infrastructure_tags str Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.
mirror_opts gcix.git.GitMirrorProps Options for the upstream Mirror job.
repository_name str The name of the target Codecommit repository.
aws_regionOptional 
1
aws_region: str
  • Type: str

The AWS region you want to operate in.

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

infrastructure_tagsOptional 
1
infrastructure_tags: str
  • Type: str

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

mirror_optsOptional 
1
mirror_opts: GitMirrorProps
  • Type: gcix.git.GitMirrorProps

Options for the upstream Mirror job.

repository_nameOptional 
1
repository_name: str
  • Type: str
  • Default: CI_PROJECT_PATH_SLUG.

The name of the target Codecommit repository.

Classes

AWSAccount

Initializers 

1
2
3
from gcix import aws

aws.AWSAccount()
Name Type Description

Static Functions

Name Description
aws_account_id Retrieves the AWS Account ID associated with the current AWS credentials or environment.
aws_region Retrieves the AWS region associated with the current AWS credentials or environment.
aws_account_id 
1
2
3
from gcix import aws

aws.AWSAccount.aws_account_id()

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.

aws_region 
1
2
3
from gcix import aws

aws.AWSAccount.aws_region()

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

Creates an instance of Bootstrap.

Initializers 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from gcix import aws

aws.CdkBootstrap(
  aws_account_id: str,
  aws_region: str,
  qualifier: str,
  toolkit_stack_name: str,
  job_name: str = None,
  job_stage: str = None,
  resource_tags: typing.Mapping[str] = None
)
Name Type Description
aws_account_id str The AWS account ID associated with the Bootstrap configuration.
aws_region str The AWS region in which the Bootstrap will be performed.
qualifier str The qualifier applied to the Bootstrap.
toolkit_stack_name str The name of the toolkit stack used for Bootstrap.
job_name str An optional name for the Bootstrap job.
job_stage str An optional stage for the Bootstrap job.
resource_tags typing.Mapping[str] Optional resource tags that can be applied during Bootstrap.
aws_account_idRequired
  • Type: str

The AWS account ID associated with the Bootstrap configuration.

aws_regionRequired
  • Type: str

The AWS region in which the Bootstrap will be performed.

qualifierRequired
  • Type: str

The qualifier applied to the Bootstrap.

toolkit_stack_nameRequired
  • Type: str

The name of the toolkit stack used for Bootstrap.

job_nameOptional
  • Type: str

An optional name for the Bootstrap job.

job_stageOptional
  • Type: str

An optional stage for the Bootstrap job.

resource_tagsOptional
  • Type: typing.Mapping[str]

Optional resource tags that can be applied during Bootstrap.

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

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.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, 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.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

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

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

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

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

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

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> 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.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.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 typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
aws_account_id str The AWS account ID associated with the Bootstrap configuration.
aws_region str The AWS region in which the Bootstrap will be performed.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
qualifier str The qualifier applied to the Bootstrap.
toolkit_stack_name str The name of the toolkit stack used for Bootstrap.
resource_tags typing.Mapping[str] Optional resource tags that can be applied during Bootstrap.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
aws_account_idRequired 
1
aws_account_id: str
  • Type: str

The AWS account ID associated with the Bootstrap configuration.

aws_regionRequired 
1
aws_region: str
  • Type: str

The AWS region in which the Bootstrap will be performed.

job_nameRequired 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageRequired 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

qualifierRequired 
1
qualifier: str
  • Type: str

The qualifier applied to the Bootstrap.

toolkit_stack_nameRequired 
1
toolkit_stack_name: str
  • Type: str

The name of the toolkit stack used for Bootstrap.

resource_tagsOptional 
1
resource_tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

Optional resource tags that can be applied during Bootstrap.

CdkDeploy

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

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

Initializers 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from gcix import aws

aws.CdkDeploy(
  stacks: typing.List[str],
  context: typing.Mapping[str] = None,
  deploy_options: str = None,
  job_name: str = None,
  job_stage: str = None,
  strict: bool = None,
  toolkit_stack_name: str = None,
  wait_for_stack: bool = None,
  wait_for_stack_account_id: str = None,
  wait_for_stack_assume_role: str = None
)
Name Type Description
stacks typing.List[str] An array of stack names to be deployed.
context typing.Mapping[str] Optional context values to provide additional information for deployment.
deploy_options str Optional deployment options.
job_name str An optional name for the Deploy job.
job_stage str An optional stage for the Deploy job.
strict bool Enable strict deployment mode.
toolkit_stack_name str Optional toolkit stack name used for deployment.
wait_for_stack bool Wait for stacks to complete deployment.
wait_for_stack_account_id str AWS account ID for stack waiting.
wait_for_stack_assume_role str AWS assume role for stack waiting.
stacksRequired
  • Type: typing.List[str]

An array of stack names to be deployed.

contextOptional
  • Type: typing.Mapping[str]

Optional context values to provide additional information for deployment.

deploy_optionsOptional
  • Type: str

Optional deployment options.

job_nameOptional
  • Type: str

An optional name for the Deploy job.

job_stageOptional
  • Type: str

An optional stage for the Deploy job.

strictOptional
  • Type: bool

Enable strict deployment mode.

toolkit_stack_nameOptional
  • Type: str

Optional toolkit stack name used for deployment.

wait_for_stackOptional
  • Type: bool

Wait for stacks to complete deployment.

wait_for_stack_account_idOptional
  • Type: str

AWS account ID for stack waiting.

wait_for_stack_assume_roleOptional
  • Type: str

AWS assume role for stack waiting.

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Renders the Deploy job's configuration and scripts.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

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.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, 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.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

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

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

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

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

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

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> 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.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Renders the Deploy job's configuration and scripts.

Properties

Name Type Description
tags typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
stacks typing.List[str] An array of stack names to be deployed.
strict bool Flag indicating if strict deployment mode is enabled.
wait_for_stack bool Flag indicating if the deployment should wait for stack completion.
context typing.Mapping[str] Optional context values to provide additional information for deployment.
deploy_options str Optional deployment options.
job_name str An optional name for the Deploy job.
job_stage str An optional stage for the Deploy job.
toolkit_stack_name str Optional toolkit stack name used for deployment.
wait_for_stack_account_id str AWS account ID for stack waiting.
wait_for_stack_assume_role str AWS assume role for stack waiting.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
stacksRequired 
1
stacks: typing.List[str]
  • Type: typing.List[str]

An array of stack names to be deployed.

strictRequired 
1
strict: bool
  • Type: bool

Flag indicating if strict deployment mode is enabled.

wait_for_stackRequired 
1
wait_for_stack: bool
  • Type: bool

Flag indicating if the deployment should wait for stack completion.

contextOptional 
1
context: typing.Mapping[str]
  • Type: typing.Mapping[str]

Optional context values to provide additional information for deployment.

deploy_optionsOptional 
1
deploy_options: str
  • Type: str

Optional deployment options.

job_nameOptional 
1
job_name: str
  • Type: str

An optional name for the Deploy job.

job_stageOptional 
1
job_stage: str
  • Type: str

An optional stage for the Deploy job.

toolkit_stack_nameOptional 
1
toolkit_stack_name: str
  • Type: str

Optional toolkit stack name used for deployment.

wait_for_stack_account_idOptional 
1
wait_for_stack_account_id: str
  • Type: str

AWS account ID for stack waiting.

wait_for_stack_assume_roleOptional 
1
wait_for_stack_assume_role: str
  • Type: str

AWS assume role for stack waiting.

CdkDiff

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

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

Initializers 

1
2
3
4
5
6
7
8
9
from gcix import aws

aws.CdkDiff(
  stacks: typing.List[str],
  context: typing.Mapping[str] = None,
  diff_options: str = None,
  job_name: str = None,
  job_stage: str = None
)
Name Type Description
stacks typing.List[str] An array of stack names for which to generate a diff.
context typing.Mapping[str] Optional context values to provide additional information for the diff.
diff_options str Optional diff options to customize the diff process.
job_name str An optional name for the Diff job.
job_stage str An optional stage for the Diff job.
stacksRequired
  • Type: typing.List[str]

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

contextOptional
  • Type: typing.Mapping[str]

Optional context values to provide additional information for the diff.

diff_optionsOptional
  • Type: str

Optional diff options to customize the diff process.

job_nameOptional
  • Type: str

An optional name for the Diff job.

job_stageOptional
  • Type: str

An optional stage for the Diff job.

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

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.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, 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.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

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

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

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

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

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

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> 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.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.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 typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
stacks typing.List[str] An array of stack names for which to generate a diff.
context typing.Mapping[str] Optional context values to provide additional information for the diff.
diff_options str Optional diff options to customize the diff process.
job_name str An optional name for the Diff job.
job_stage str An optional stage for the Diff job.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
stacksRequired 
1
stacks: typing.List[str]
  • Type: typing.List[str]

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

contextOptional 
1
context: typing.Mapping[str]
  • Type: typing.Mapping[str]

Optional context values to provide additional information for the diff.

diff_optionsOptional 
1
diff_options: str
  • Type: str

Optional diff options to customize the diff process.

job_nameOptional 
1
job_name: str
  • Type: str

An optional name for the Diff job.

job_stageOptional 
1
job_stage: str
  • Type: str

An optional stage for the Diff job.

CdkDiffDeploy

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 

1
2
3
4
5
6
from gcix import aws

aws.CdkDiffDeploy(
  stacks: typing.List[str],
  context: typing.Mapping[str] = None
)
Name Type Description
stacks typing.List[str] An array of stack names for which to generate a diff and perform deployment.
context typing.Mapping[str] Optional context values to provide additional information for the diff and deployment.
stacksRequired
  • Type: typing.List[str]

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

contextOptional
  • Type: typing.Mapping[str]

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

Methods

Name Description
add_children Add gcix.Jobs or other gcix.JobCollections to this JobCollection.
add_dependencies No description.
add_needs No description.
add_parent No description.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_artifacts No description.
assign_cache No description.
get_all_instance_names Return all instance names from the given child.
initialize_allow_failure Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection that haven't been set the allowFailure before.
initialize_artifacts Sets gcix.Job.artifacts to all jobs within this JobCollection that haven't been set the artifacs before.
initialize_cache Calling gcix.Job.assigneCache() to all jobs within this JobCollection that haven't been set the cache before.
initialize_dependencies Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection that haven't been added dependencies before.
initialize_image Calling gcix.Job.assignImage() to all jobs within this JobCollection.
initialize_needs Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection that haven't been added needs before.
initialize_rules Calling gcix.Job.append_rules() to all jobs within this JobCollection that haven't been added rules before.
initialize_tags Calling gcix.Job.addTags([...]) to all jobs within this JobCollection that haven't been added tags before.
initialize_variables Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection that haven't been added variables before.
is_equal isEqual checks if this object is equal to given object.
override_allow_failure Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection overriding any previous set value.
override_dependencies Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection and overriding any previously added dependencies to that jobs.
override_image Calling gcix.Job.assignImage() to all jobs within this JobCollection overriding any previous set value.
override_needs Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection and overriding any previously added needs to that jobs.
override_rules Calling gcix.Job.overrideRules() to all jobs within this JobCollection and overriding any previously added rules to that jobs.
override_tags Calling gcix.Job.addTags([...]) to all jobs within this JobCollection and overriding any previously added tags to that jobs.
override_variables Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection and overriding any previously added variables to that jobs.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_children 
1
2
3
4
5
def add_children(
  jobs_or_job_collections: typing.List[typing.Union[Job, JobCollection]],
  name: str = None,
  stage: str = None
) -> 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.

jobs_or_job_collectionsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
nameOptional
  • Type: str
stageOptional
  • Type: str
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: JobCollection
) -> None
parentRequired
  • Type: gcix.JobCollection
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> JobCollection
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> JobCollection
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> JobCollection
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> JobCollection
scriptsRequired
  • Type: typing.List[str]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> JobCollection
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> JobCollection
cacheRequired
  • Type: gcix.Cache
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> 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.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
initialize_allow_failure 
1
2
3
def initialize_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> JobCollection

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

allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
initialize_artifacts 
1
2
3
def initialize_artifacts(
  artifacts: Artifacts
) -> JobCollection

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

artifactsRequired
  • Type: gcix.Artifacts
initialize_cache 
1
2
3
def initialize_cache(
  cache: Cache
) -> JobCollection

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

cacheRequired
  • Type: gcix.Cache
initialize_dependencies 
1
2
3
def initialize_dependencies(
  dependencies: typing.List[typing.Union[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.

dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
initialize_image 
1
2
3
def initialize_image(
  image: typing.Union[str, Image]
) -> JobCollection

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

imageRequired
  • Type: typing.Union[str, gcix.Image]
initialize_needs 
1
2
3
def initialize_needs(
  needs: typing.List[typing.Union[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.

needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
initialize_rules 
1
2
3
def initialize_rules(
  rules: typing.List[Rule]
) -> JobCollection

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

rulesRequired
  • Type: typing.List[gcix.Rule]
initialize_tags 
1
2
3
def initialize_tags(
  tags: typing.List[str]
) -> JobCollection

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

tagsRequired
  • Type: typing.List[str]
initialize_variables 
1
2
3
def initialize_variables(
  variables: typing.Mapping[str]
) -> JobCollection

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

variablesRequired
  • Type: typing.Mapping[str]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
override_allow_failure 
1
2
3
def override_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> JobCollection

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

allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
override_dependencies 
1
2
3
def override_dependencies(
  dependencies: typing.List[typing.Union[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.

dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
override_image 
1
2
3
def override_image(
  image: typing.Union[str, Image]
) -> JobCollection

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

imageRequired
  • Type: typing.Union[str, gcix.Image]
override_needs 
1
2
3
def override_needs(
  needs: typing.List[typing.Union[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.

needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
override_rules 
1
2
3
def override_rules(
  rules: typing.List[Rule]
) -> JobCollection

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

rulesRequired
  • Type: typing.List[gcix.Rule]
override_tags 
1
2
3
def override_tags(
  tags: typing.List[str]
) -> JobCollection

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

tagsRequired
  • Type: typing.List[str]
override_variables 
1
2
3
def override_variables(
  variables: typing.Mapping[str]
) -> JobCollection

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

variablesRequired
  • Type: typing.Mapping[str]
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> JobCollection
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> JobCollection
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.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
last_jobs_executed typing.List[gcix.Job] This property returns all Jobs from the last stage of this JobCollection.
nested_jobs typing.List[gcix.Job] No description.
populated_jobs typing.List[gcix.Job] Returns a list with populated copies of all nested jobs of this JobCollection.
children typing.List[gcix.ChildDict] No description.
ordered_tags gcix.OrderedStringSet No description.
ordered_tags_for_initialization gcix.OrderedStringSet No description.
ordered_tags_for_replacement gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
allow_failure_for_initialization typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
allow_failure_for_replacement typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
artifacts gcix.Artifacts No description.
artifacts_for_initialization gcix.Artifacts No description.
artifacts_for_replacement gcix.Artifacts No description.
cache gcix.Cache No description.
cache_for_initialization gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
dependencies_for_initialization typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
dependencies_for_replacement typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image_for_initialization typing.Union[str, gcix.Image] No description.
image_for_replacement typing.Union[str, gcix.Image] No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
needs_for_initialization typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
needs_for_replacement typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
rules_for_initialization typing.List[gcix.Rule] No description.
rules_for_replacement typing.List[gcix.Rule] No description.
rules_to_append typing.List[gcix.Rule] No description.
rules_to_prepend typing.List[gcix.Rule] No description.
scripts_to_append typing.List[str] No description.
scripts_to_prepend typing.List[str] No description.
variables typing.Mapping[str] No description.
variables_for_initialization typing.Mapping[str] No description.
variables_for_replacement typing.Mapping[str] No description.
deploy_job CdkDeploy The instance of the Deploy job associated with this DiffDeploy instance.
diff_job CdkDiff The instance of the Diff job associated with this DiffDeploy instance.
stacks typing.List[str] An array of stack names for which to generate a diff and perform deployment.
context typing.Mapping[str] Optional context values to provide additional information for the diff and deployment.
last_jobs_executedRequired 
1
last_jobs_executed: typing.List[Job]
  • Type: typing.List[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.

nested_jobsRequired 
1
nested_jobs: typing.List[Job]
  • Type: typing.List[gcix.Job]
populated_jobsRequired 
1
populated_jobs: typing.List[Job]
  • Type: typing.List[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.

childrenRequired 
1
children: typing.List[ChildDict]
  • Type: typing.List[gcix.ChildDict]
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
ordered_tags_for_initializationRequired 
1
ordered_tags_for_initialization: OrderedStringSet
  • Type: gcix.OrderedStringSet
ordered_tags_for_replacementRequired 
1
ordered_tags_for_replacement: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
allow_failure_for_initializationOptional 
1
allow_failure_for_initialization: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
allow_failure_for_replacementOptional 
1
allow_failure_for_replacement: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
artifacts_for_initializationOptional 
1
artifacts_for_initialization: Artifacts
  • Type: gcix.Artifacts
artifacts_for_replacementOptional 
1
artifacts_for_replacement: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
cache_for_initializationOptional 
1
cache_for_initialization: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
dependencies_for_initializationOptional 
1
dependencies_for_initialization: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
dependencies_for_replacementOptional 
1
dependencies_for_replacement: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
image_for_initializationOptional 
1
image_for_initialization: typing.Union[str, Image]
  • Type: typing.Union[str, gcix.Image]
image_for_replacementOptional 
1
image_for_replacement: typing.Union[str, Image]
  • Type: typing.Union[str, gcix.Image]
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
needs_for_initializationOptional 
1
needs_for_initialization: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
needs_for_replacementOptional 
1
needs_for_replacement: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
rules_for_initializationOptional 
1
rules_for_initialization: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
rules_for_replacementOptional 
1
rules_for_replacement: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
rules_to_appendOptional 
1
rules_to_append: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
rules_to_prependOptional 
1
rules_to_prepend: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
scripts_to_appendOptional 
1
scripts_to_append: typing.List[str]
  • Type: typing.List[str]
scripts_to_prependOptional 
1
scripts_to_prepend: typing.List[str]
  • Type: typing.List[str]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
variables_for_initializationOptional 
1
variables_for_initialization: typing.Mapping[str]
  • Type: typing.Mapping[str]
variables_for_replacementOptional 
1
variables_for_replacement: typing.Mapping[str]
  • Type: typing.Mapping[str]
deploy_jobRequired 
1
deploy_job: CdkDeploy

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

diff_jobRequired 
1
diff_job: CdkDiff

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

stacksRequired 
1
stacks: typing.List[str]
  • Type: typing.List[str]

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

contextOptional 
1
context: typing.Mapping[str]
  • Type: typing.Mapping[str]

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

CdkMirrorToCodecommit

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 

1
2
3
4
5
6
7
8
from gcix import aws

aws.CdkMirrorToCodecommit(
  aws_region: str = None,
  infrastructure_tags: str = None,
  mirror_opts: GitMirrorProps = None,
  repository_name: str = None
)
Name Type Description
aws_region str The AWS region you want to operate in.
infrastructure_tags str Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.
mirror_opts gcix.git.GitMirrorProps Options for the upstream Mirror job.
repository_name str The name of the target Codecommit repository.
aws_regionOptional
  • Type: str

The AWS region you want to operate in.

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

infrastructure_tagsOptional
  • Type: str

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

mirror_optsOptional
  • Type: gcix.git.GitMirrorProps

Options for the upstream Mirror job.

repository_nameOptional
  • Type: str
  • Default: CI_PROJECT_PATH_SLUG.

The name of the target Codecommit repository.

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

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.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, 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.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

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

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

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

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

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

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> 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.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.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 typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
git_config_user_email str The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.
git_config_user_name str The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.
remote_repository str The git repository the code of the pipelines repository should be mirrored to.
script_hook typing.List[str] This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.
private_key_variable str 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.
run_only_for_repository_url str When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.
repository_name str The name of the target Codecommit repository.
aws_region str The AWS region you want to operate in.
infrastructure_tags str Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.
mirror_opts gcix.git.GitMirrorProps No description.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
git_config_user_emailRequired 
1
git_config_user_email: str
  • Type: str

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

git_config_user_nameRequired 
1
git_config_user_name: str
  • Type: str

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

remote_repositoryRequired 
1
remote_repository: str
  • Type: str

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

script_hookRequired 
1
script_hook: typing.List[str]
  • Type: typing.List[str]

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.

private_key_variableOptional 
1
private_key_variable: str
  • Type: str

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.

run_only_for_repository_urlOptional 
1
run_only_for_repository_url: str
  • Type: str

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.

repository_nameRequired 
1
repository_name: str
  • Type: str

The name of the target Codecommit repository.

aws_regionOptional 
1
aws_region: str
  • Type: str

The AWS region you want to operate in.

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

infrastructure_tagsOptional 
1
infrastructure_tags: str
  • Type: str

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

mirror_optsOptional 
1
mirror_opts: GitMirrorProps
  • Type: gcix.git.GitMirrorProps

Protocols

ICdkBootstrap

Represents the interface that a Bootstrap instance adheres to.

Properties

Name Type Description
aws_account_id str The AWS account ID associated with the Bootstrap configuration.
aws_region str The AWS region in which the Bootstrap will be performed.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
qualifier str The qualifier applied to the Bootstrap.
toolkit_stack_name str The name of the toolkit stack used for Bootstrap.
resource_tags typing.Mapping[str] Optional resource tags that can be applied during Bootstrap.
aws_account_idRequired 
1
aws_account_id: str
  • Type: str

The AWS account ID associated with the Bootstrap configuration.

aws_regionRequired 
1
aws_region: str
  • Type: str

The AWS region in which the Bootstrap will be performed.

job_nameRequired 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageRequired 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

qualifierRequired 
1
qualifier: str
  • Type: str

The qualifier applied to the Bootstrap.

toolkit_stack_nameRequired 
1
toolkit_stack_name: str
  • Type: str

The name of the toolkit stack used for Bootstrap.

resource_tagsOptional 
1
resource_tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

Optional resource tags that can be applied during Bootstrap.

ICdkDeploy

Represents the interface that a Deploy instance adheres to.

Properties

Name Type Description
stacks typing.List[str] An array of stack names to be deployed.
strict bool Flag indicating if strict deployment mode is enabled.
wait_for_stack bool Flag indicating if the deployment should wait for stack completion.
context typing.Mapping[str] Optional context values to provide additional information for deployment.
deploy_options str Optional deployment options.
job_name str An optional name for the Deploy job.
job_stage str An optional stage for the Deploy job.
toolkit_stack_name str Optional toolkit stack name used for deployment.
wait_for_stack_account_id str AWS account ID for stack waiting.
wait_for_stack_assume_role str AWS assume role for stack waiting.
stacksRequired 
1
stacks: typing.List[str]
  • Type: typing.List[str]

An array of stack names to be deployed.

strictRequired 
1
strict: bool
  • Type: bool

Flag indicating if strict deployment mode is enabled.

wait_for_stackRequired 
1
wait_for_stack: bool
  • Type: bool

Flag indicating if the deployment should wait for stack completion.

contextOptional 
1
context: typing.Mapping[str]
  • Type: typing.Mapping[str]

Optional context values to provide additional information for deployment.

deploy_optionsOptional 
1
deploy_options: str
  • Type: str

Optional deployment options.

job_nameOptional 
1
job_name: str
  • Type: str

An optional name for the Deploy job.

job_stageOptional 
1
job_stage: str
  • Type: str

An optional stage for the Deploy job.

toolkit_stack_nameOptional 
1
toolkit_stack_name: str
  • Type: str

Optional toolkit stack name used for deployment.

wait_for_stack_account_idOptional 
1
wait_for_stack_account_id: str
  • Type: str

AWS account ID for stack waiting.

wait_for_stack_assume_roleOptional 
1
wait_for_stack_assume_role: str
  • Type: str

AWS assume role for stack waiting.

ICdkDiff

Represents the interface that a Diff instance adheres to.

Properties

Name Type Description
stacks typing.List[str] An array of stack names for which to generate a diff.
context typing.Mapping[str] Optional context values to provide additional information for the diff.
diff_options str Optional diff options to customize the diff process.
job_name str An optional name for the Diff job.
job_stage str An optional stage for the Diff job.
stacksRequired 
1
stacks: typing.List[str]
  • Type: typing.List[str]

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

contextOptional 
1
context: typing.Mapping[str]
  • Type: typing.Mapping[str]

Optional context values to provide additional information for the diff.

diff_optionsOptional 
1
diff_options: str
  • Type: str

Optional diff options to customize the diff process.

job_nameOptional 
1
job_name: str
  • Type: str

An optional name for the Diff job.

job_stageOptional 
1
job_stage: str
  • Type: str

An optional stage for the Diff job.

ICdkDiffDeploy

Represents the interface that a DiffDeploy instance adheres to.

Properties

Name Type Description
deploy_job CdkDeploy The instance of the Deploy job associated with this DiffDeploy instance.
diff_job CdkDiff The instance of the Diff job associated with this DiffDeploy instance.
stacks typing.List[str] An array of stack names for which to generate a diff and perform deployment.
context typing.Mapping[str] Optional context values to provide additional information for the diff and deployment.
deploy_jobRequired 
1
deploy_job: CdkDeploy

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

diff_jobRequired 
1
diff_job: CdkDiff

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

stacksRequired 
1
stacks: typing.List[str]
  • Type: typing.List[str]

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

contextOptional 
1
context: typing.Mapping[str]
  • Type: typing.Mapping[str]

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

ICdkMirrorToCodecommit

Properties

Name Type Description
git_config_user_email str The 'user.email' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_EMAIL.
git_config_user_name str The 'user.name' with which the commits to the remote repository should be made. Defaults to GITLAB_USER_NAME.
remote_repository str The git repository the code of the pipelines repository should be mirrored to.
script_hook typing.List[str] This list of strings could contain any commands that should be executed between pulling the current repository and pushing it to the remote.
private_key_variable str 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.
run_only_for_repository_url str When mirroring to a remote Gitlab instance, you don't want to run this mirroring job there again.
repository_name str The name of the target Codecommit repository.
aws_region str The AWS region you want to operate in.
infrastructure_tags str Only if the ECR would be created on the first call, these AWS Tags becomes applied to the AWS Codecommit resource.
git_config_user_emailRequired 
1
git_config_user_email: str
  • Type: str

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

git_config_user_nameRequired 
1
git_config_user_name: str
  • Type: str

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

remote_repositoryRequired 
1
remote_repository: str
  • Type: str

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

script_hookRequired 
1
script_hook: typing.List[str]
  • Type: typing.List[str]

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.

private_key_variableOptional 
1
private_key_variable: str
  • Type: str

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.

run_only_for_repository_urlOptional 
1
run_only_for_repository_url: str
  • Type: str

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.

repository_nameRequired 
1
repository_name: str
  • Type: str
  • Default: CI_PROJECT_PATH_SLUG.

The name of the target Codecommit repository.

aws_regionOptional 
1
aws_region: str
  • Type: str

The AWS region you want to operate in.

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

infrastructure_tagsOptional 
1
infrastructure_tags: str
  • Type: str

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

Last update: November 14, 2023
Created: November 14, 2023