Skip to content

EnvCustomJob

This class encapsulates and extends the ROS resource type ALIYUN::ARMS::EnvCustomJob.

Initializers

import com.aliyun.ros.cdk.arms.EnvCustomJob;
EnvCustomJob.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .configYaml(java.lang.String)
    .configYaml(IResolvable)
    .envCustomJobName(java.lang.String)
    .envCustomJobName(IResolvable)
    .environmentId(java.lang.String)
    .environmentId(IResolvable)
//  .aliyunLang(java.lang.String)
//  .aliyunLang(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
configYaml java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property configYaml: The YAML configuration string of the custom job.
envCustomJobName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property envCustomJobName: The name of the custom job.
environmentId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property environmentId: The ID of the environment instance.
aliyunLang java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property aliyunLang: The language.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

configYamlRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property configYaml: The YAML configuration string of the custom job.


envCustomJobNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property envCustomJobName: The name of the custom job.


environmentIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property environmentId: The ID of the environment instance.


aliyunLangOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property aliyunLang: The language.

Valid values: zh and en. Default value: zh.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.arms.EnvCustomJob;
EnvCustomJob.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrConfigYaml java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConfigYaml: The YAML configuration string of the custom job.
attrEnvCustomJobName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EnvCustomJobName: The name of the custom job.
attrEnvironmentId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EnvironmentId: The ID of the environment instance.
props EnvCustomJobProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrConfigYamlRequired

public java.lang.Object getAttrConfigYaml();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConfigYaml: The YAML configuration string of the custom job.


attrEnvCustomJobNameRequired

public java.lang.Object getAttrEnvCustomJobName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EnvCustomJobName: The name of the custom job.


attrEnvironmentIdRequired

public java.lang.Object getAttrEnvironmentId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EnvironmentId: The ID of the environment instance.


propsRequired

public EnvCustomJobProps getProps();