Package io.github.cdklabs.projen.gitlab

Interface Environment

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Environment.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.119Z")
@Stability(Experimental)
public interface Environment
extends software.amazon.jsii.JsiiSerializable

(experimental) The environment that a job deploys to.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Environment.Builder	A builder for Environment
static class	Environment.Jsii$Proxy	An implementation for Environment

Method Summary

Modifier and Type	Method	Description
static Environment.Builder	builder()
default Action	getAction()	(experimental) Specifies what this job will do.
default String	getAutoStopIn()	(experimental) The amount of time it should take before Gitlab will automatically stop the environment.
default DeploymentTier	getDeploymentTier()	(experimental) Explicitly specifies the tier of the deployment environment if non-standard environment name is used.
default KubernetesConfig	getKubernetes()	(experimental) Used to configure the kubernetes deployment for this environment.
String	getName()	(experimental) The name of the environment, e.g.
default String	getOnStop()	(experimental) The name of a job to execute when the environment is about to be stopped.
default String	getUrl()	(experimental) When set, this will expose buttons in various places for the current environment in Gitlab, that will take you to the defined URL.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) The name of the environment, e.g. 'qa', 'staging', 'production'.

getAction

@Stability(Experimental)
@Nullable
default Action getAction()

(experimental) Specifies what this job will do.

'start' (default) indicates the job will start the deployment. 'prepare' indicates this will not affect the deployment. 'stop' indicates this will stop the deployment.

getAutoStopIn

@Stability(Experimental)
@Nullable
default String getAutoStopIn()

(experimental) The amount of time it should take before Gitlab will automatically stop the environment.

Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'.

getDeploymentTier

@Stability(Experimental)
@Nullable
default DeploymentTier getDeploymentTier()

(experimental) Explicitly specifies the tier of the deployment environment if non-standard environment name is used.

getKubernetes

@Stability(Experimental)
@Nullable
default KubernetesConfig getKubernetes()

(experimental) Used to configure the kubernetes deployment for this environment.

This is currently not supported for kubernetes clusters that are managed by Gitlab.

getOnStop

@Stability(Experimental)
@Nullable
default String getOnStop()

(experimental) The name of a job to execute when the environment is about to be stopped.

getUrl

@Stability(Experimental)
@Nullable
default String getUrl()

(experimental) When set, this will expose buttons in various places for the current environment in Gitlab, that will take you to the defined URL.

builder

@Stability(Experimental)
static Environment.Builder builder()

Returns:

a Environment.Builder of Environment