class CfnJobDefinition (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Batch.CfnJobDefinition |
Java | software.amazon.awscdk.services.batch.CfnJobDefinition |
Python | aws_cdk.aws_batch.CfnJobDefinition |
TypeScript | @aws-cdk/aws-batch » CfnJobDefinition |
Implements
IConstruct
, IConstruct
, IDependable
, IInspectable
A CloudFormation AWS::Batch::JobDefinition
.
The AWS::Batch::JobDefinition
resource specifies the parameters for an AWS Batch job definition. For more information, see Job Definitions in the ** .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as batch from '@aws-cdk/aws-batch';
declare const labels: any;
declare const limits: any;
declare const options: any;
declare const parameters: any;
declare const requests: any;
declare const tags: any;
const cfnJobDefinition = new batch.CfnJobDefinition(this, 'MyCfnJobDefinition', {
type: 'type',
// the properties below are optional
containerProperties: {
image: 'image',
// the properties below are optional
command: ['command'],
environment: [{
name: 'name',
value: 'value',
}],
ephemeralStorage: {
sizeInGiB: 123,
},
executionRoleArn: 'executionRoleArn',
fargatePlatformConfiguration: {
platformVersion: 'platformVersion',
},
instanceType: 'instanceType',
jobRoleArn: 'jobRoleArn',
linuxParameters: {
devices: [{
containerPath: 'containerPath',
hostPath: 'hostPath',
permissions: ['permissions'],
}],
initProcessEnabled: false,
maxSwap: 123,
sharedMemorySize: 123,
swappiness: 123,
tmpfs: [{
containerPath: 'containerPath',
size: 123,
// the properties below are optional
mountOptions: ['mountOptions'],
}],
},
logConfiguration: {
logDriver: 'logDriver',
// the properties below are optional
options: options,
secretOptions: [{
name: 'name',
valueFrom: 'valueFrom',
}],
},
memory: 123,
mountPoints: [{
containerPath: 'containerPath',
readOnly: false,
sourceVolume: 'sourceVolume',
}],
networkConfiguration: {
assignPublicIp: 'assignPublicIp',
},
privileged: false,
readonlyRootFilesystem: false,
resourceRequirements: [{
type: 'type',
value: 'value',
}],
secrets: [{
name: 'name',
valueFrom: 'valueFrom',
}],
ulimits: [{
hardLimit: 123,
name: 'name',
softLimit: 123,
}],
user: 'user',
vcpus: 123,
volumes: [{
efsVolumeConfiguration: {
fileSystemId: 'fileSystemId',
// the properties below are optional
authorizationConfig: {
accessPointId: 'accessPointId',
iam: 'iam',
},
rootDirectory: 'rootDirectory',
transitEncryption: 'transitEncryption',
transitEncryptionPort: 123,
},
host: {
sourcePath: 'sourcePath',
},
name: 'name',
}],
},
eksProperties: {
podProperties: {
containers: [{
image: 'image',
// the properties below are optional
args: ['args'],
command: ['command'],
env: [{
name: 'name',
// the properties below are optional
value: 'value',
}],
imagePullPolicy: 'imagePullPolicy',
name: 'name',
resources: {
limits: limits,
requests: requests,
},
securityContext: {
privileged: false,
readOnlyRootFilesystem: false,
runAsGroup: 123,
runAsNonRoot: false,
runAsUser: 123,
},
volumeMounts: [{
mountPath: 'mountPath',
name: 'name',
readOnly: false,
}],
}],
dnsPolicy: 'dnsPolicy',
hostNetwork: false,
metadata: {
labels: labels,
},
serviceAccountName: 'serviceAccountName',
volumes: [{
name: 'name',
// the properties below are optional
emptyDir: {
medium: 'medium',
sizeLimit: 'sizeLimit',
},
hostPath: {
path: 'path',
},
secret: {
secretName: 'secretName',
// the properties below are optional
optional: false,
},
}],
},
},
jobDefinitionName: 'jobDefinitionName',
nodeProperties: {
mainNode: 123,
nodeRangeProperties: [{
targetNodes: 'targetNodes',
// the properties below are optional
container: {
image: 'image',
// the properties below are optional
command: ['command'],
environment: [{
name: 'name',
value: 'value',
}],
ephemeralStorage: {
sizeInGiB: 123,
},
executionRoleArn: 'executionRoleArn',
fargatePlatformConfiguration: {
platformVersion: 'platformVersion',
},
instanceType: 'instanceType',
jobRoleArn: 'jobRoleArn',
linuxParameters: {
devices: [{
containerPath: 'containerPath',
hostPath: 'hostPath',
permissions: ['permissions'],
}],
initProcessEnabled: false,
maxSwap: 123,
sharedMemorySize: 123,
swappiness: 123,
tmpfs: [{
containerPath: 'containerPath',
size: 123,
// the properties below are optional
mountOptions: ['mountOptions'],
}],
},
logConfiguration: {
logDriver: 'logDriver',
// the properties below are optional
options: options,
secretOptions: [{
name: 'name',
valueFrom: 'valueFrom',
}],
},
memory: 123,
mountPoints: [{
containerPath: 'containerPath',
readOnly: false,
sourceVolume: 'sourceVolume',
}],
networkConfiguration: {
assignPublicIp: 'assignPublicIp',
},
privileged: false,
readonlyRootFilesystem: false,
resourceRequirements: [{
type: 'type',
value: 'value',
}],
secrets: [{
name: 'name',
valueFrom: 'valueFrom',
}],
ulimits: [{
hardLimit: 123,
name: 'name',
softLimit: 123,
}],
user: 'user',
vcpus: 123,
volumes: [{
efsVolumeConfiguration: {
fileSystemId: 'fileSystemId',
// the properties below are optional
authorizationConfig: {
accessPointId: 'accessPointId',
iam: 'iam',
},
rootDirectory: 'rootDirectory',
transitEncryption: 'transitEncryption',
transitEncryptionPort: 123,
},
host: {
sourcePath: 'sourcePath',
},
name: 'name',
}],
},
}],
numNodes: 123,
},
parameters: parameters,
platformCapabilities: ['platformCapabilities'],
propagateTags: false,
retryStrategy: {
attempts: 123,
evaluateOnExit: [{
action: 'action',
// the properties below are optional
onExitCode: 'onExitCode',
onReason: 'onReason',
onStatusReason: 'onStatusReason',
}],
},
schedulingPriority: 123,
tags: tags,
timeout: {
attemptDurationSeconds: 123,
},
});
Initializer
new CfnJobDefinition(scope: Construct, id: string, props: CfnJobDefinitionProps)
Parameters
- scope
Construct
— - scope in which this resource is defined. - id
string
— - scoped id of the resource. - props
Cfn
— - resource properties.Job Definition Props
Create a new AWS::Batch::JobDefinition
.
Construct Props
Name | Type | Description |
---|---|---|
type | string | The type of job definition. |
container | IResolvable | Container | An object with various properties specific to Amazon ECS based jobs. |
eks | IResolvable | Eks | An object with various properties that are specific to Amazon EKS based jobs. |
job | string | The name of the job definition. |
node | IResolvable | Node | An object with various properties that are specific to multi-node parallel jobs. |
parameters? | any | Default parameters or parameter substitution placeholders that are set in the job definition. |
platform | string[] | The platform capabilities required by the job definition. |
propagate | boolean | IResolvable | Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. |
retry | IResolvable | Retry | The retry strategy to use for failed jobs that are submitted with this job definition. |
scheduling | number | The scheduling priority of the job definition. |
tags? | any | The tags that are applied to the job definition. |
timeout? | IResolvable | Timeout | The timeout time for jobs that are submitted with this job definition. |
type
Type:
string
The type of job definition.
For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide .
If the job is run on Fargate resources, then
multinode
isn't supported.
containerProperties?
Type:
IResolvable
|
Container
(optional)
An object with various properties specific to Amazon ECS based jobs.
Valid values are containerProperties
, eksProperties
, and nodeProperties
. Only one can be specified.
eksProperties?
Type:
IResolvable
|
Eks
(optional)
An object with various properties that are specific to Amazon EKS based jobs.
Valid values are containerProperties
, eksProperties
, and nodeProperties
. Only one can be specified.
jobDefinitionName?
Type:
string
(optional)
The name of the job definition.
nodeProperties?
Type:
IResolvable
|
Node
(optional)
An object with various properties that are specific to multi-node parallel jobs.
Valid values are containerProperties
, eksProperties
, and nodeProperties
. Only one can be specified.
If the job runs on Fargate resources, don't specify
nodeProperties
. UsecontainerProperties
instead.
parameters?
Type:
any
(optional)
Default parameters or parameter substitution placeholders that are set in the job definition.
Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob
request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the AWS Batch User Guide .
platformCapabilities?
Type:
string[]
(optional)
The platform capabilities required by the job definition.
If no value is specified, it defaults to EC2
. Jobs run on Fargate resources specify FARGATE
.
propagateTags?
Type:
boolean |
IResolvable
(optional)
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED
state.
retryStrategy?
Type:
IResolvable
|
Retry
(optional)
The retry strategy to use for failed jobs that are submitted with this job definition.
schedulingPriority?
Type:
number
(optional)
The scheduling priority of the job definition.
This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
tags?
Type:
any
(optional)
The tags that are applied to the job definition.
timeout?
Type:
IResolvable
|
Timeout
(optional)
The timeout time for jobs that are submitted with this job definition.
After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.
Properties
Name | Type | Description |
---|---|---|
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Construct | The construct tree node associated with this construct. |
parameters | any | Default parameters or parameter substitution placeholders that are set in the job definition. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | The tags that are applied to the job definition. |
type | string | The type of job definition. |
container | IResolvable | Container | An object with various properties specific to Amazon ECS based jobs. |
eks | IResolvable | Eks | An object with various properties that are specific to Amazon EKS based jobs. |
job | string | The name of the job definition. |
node | IResolvable | Node | An object with various properties that are specific to multi-node parallel jobs. |
platform | string[] | The platform capabilities required by the job definition. |
propagate | boolean | IResolvable | Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. |
retry | IResolvable | Retry | The retry strategy to use for failed jobs that are submitted with this job definition. |
scheduling | number | The scheduling priority of the job definition. |
timeout? | IResolvable | Timeout | The timeout time for jobs that are submitted with this job definition. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Construct
The construct tree node associated with this construct.
parameters
Type:
any
Default parameters or parameter substitution placeholders that are set in the job definition.
Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob
request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the AWS Batch User Guide .
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
The tags that are applied to the job definition.
type
Type:
string
The type of job definition.
For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide .
If the job is run on Fargate resources, then
multinode
isn't supported.
containerProperties?
Type:
IResolvable
|
Container
(optional)
An object with various properties specific to Amazon ECS based jobs.
Valid values are containerProperties
, eksProperties
, and nodeProperties
. Only one can be specified.
eksProperties?
Type:
IResolvable
|
Eks
(optional)
An object with various properties that are specific to Amazon EKS based jobs.
Valid values are containerProperties
, eksProperties
, and nodeProperties
. Only one can be specified.
jobDefinitionName?
Type:
string
(optional)
The name of the job definition.
nodeProperties?
Type:
IResolvable
|
Node
(optional)
An object with various properties that are specific to multi-node parallel jobs.
Valid values are containerProperties
, eksProperties
, and nodeProperties
. Only one can be specified.
If the job runs on Fargate resources, don't specify
nodeProperties
. UsecontainerProperties
instead.
platformCapabilities?
Type:
string[]
(optional)
The platform capabilities required by the job definition.
If no value is specified, it defaults to EC2
. Jobs run on Fargate resources specify FARGATE
.
propagateTags?
Type:
boolean |
IResolvable
(optional)
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED
state.
retryStrategy?
Type:
IResolvable
|
Retry
(optional)
The retry strategy to use for failed jobs that are submitted with this job definition.
schedulingPriority?
Type:
number
(optional)
The scheduling priority of the job definition.
This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
timeout?
Type:
IResolvable
|
Timeout
(optional)
The timeout time for jobs that are submitted with this job definition.
After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
override | Overrides the auto-generated logical ID with a specific ID. |
to | Returns a string representation of this construct. |
protected render |
DeletionOverride(path)
addpublic addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
DependsOn(target)
addpublic addDependsOn(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
Metadata(key, value)
addpublic addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
Override(path, value)
addpublic addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
PropertyDeletionOverride(propertyPath)
addpublic addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
PropertyOverride(propertyPath, value)
addpublic addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
RemovalPolicy(policy?, options?)
applypublic applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
Att(attributeName)
getpublic getAtt(attributeName: string): Reference
Parameters
- attributeName
string
— The name of the attribute.
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
Metadata(key)
getpublic getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— - tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
LogicalId(newLogicalId)
overridepublic overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
Properties(props)
protected renderprotected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }