CfnJobDefinition

class aws_cdk.aws_batch.CfnJobDefinition(scope, id, *, type, container_properties=None, job_definition_name=None, node_properties=None, parameters=None, platform_capabilities=None, propagate_tags=None, retry_strategy=None, tags=None, timeout=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Batch::JobDefinition.

CloudformationResource

AWS::Batch::JobDefinition

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html

Create a new AWS::Batch::JobDefinition.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • type (str) – AWS::Batch::JobDefinition.Type.

  • container_properties (Union[IResolvable, ContainerPropertiesProperty, None]) – AWS::Batch::JobDefinition.ContainerProperties.

  • job_definition_name (Optional[str]) – AWS::Batch::JobDefinition.JobDefinitionName.

  • node_properties (Union[IResolvable, NodePropertiesProperty, None]) – AWS::Batch::JobDefinition.NodeProperties.

  • parameters (Optional[Any]) – AWS::Batch::JobDefinition.Parameters.

  • platform_capabilities (Optional[Sequence[str]]) – AWS::Batch::JobDefinition.PlatformCapabilities.

  • propagate_tags (Union[bool, IResolvable, None]) – AWS::Batch::JobDefinition.PropagateTags.

  • retry_strategy (Union[IResolvable, RetryStrategyProperty, None]) – AWS::Batch::JobDefinition.RetryStrategy.

  • tags (Optional[Any]) – AWS::Batch::JobDefinition.Tags.

  • timeout (Union[IResolvable, TimeoutProperty, None]) – AWS::Batch::JobDefinition.Timeout.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

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.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

add_override(path, 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:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Batch::JobDefinition'
cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

container_properties

AWS::Batch::JobDefinition.ContainerProperties.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-containerproperties

Return type

Union[IResolvable, ContainerPropertiesProperty, None]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

job_definition_name

AWS::Batch::JobDefinition.JobDefinitionName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-jobdefinitionname

Return type

Optional[str]

logical_id

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).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

node_properties

AWS::Batch::JobDefinition.NodeProperties.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-nodeproperties

Return type

Union[IResolvable, NodePropertiesProperty, None]

parameters

AWS::Batch::JobDefinition.Parameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-parameters

Return type

Any

platform_capabilities

AWS::Batch::JobDefinition.PlatformCapabilities.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-platformcapabilities

Return type

Optional[List[str]]

propagate_tags

AWS::Batch::JobDefinition.PropagateTags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-propagatetags

Return type

Union[bool, IResolvable, None]

ref

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 }).

Return type

str

retry_strategy

AWS::Batch::JobDefinition.RetryStrategy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-retrystrategy

Return type

Union[IResolvable, RetryStrategyProperty, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::Batch::JobDefinition.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-tags

Return type

TagManager

timeout

AWS::Batch::JobDefinition.Timeout.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-timeout

Return type

Union[IResolvable, TimeoutProperty, None]

type

AWS::Batch::JobDefinition.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-type

Return type

str

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ContainerPropertiesProperty

class CfnJobDefinition.ContainerPropertiesProperty(*, image, command=None, environment=None, execution_role_arn=None, fargate_platform_configuration=None, instance_type=None, job_role_arn=None, linux_parameters=None, log_configuration=None, memory=None, mount_points=None, network_configuration=None, privileged=None, readonly_root_filesystem=None, resource_requirements=None, secrets=None, ulimits=None, user=None, vcpus=None, volumes=None)

Bases: object

Parameters
  • image (str) – CfnJobDefinition.ContainerPropertiesProperty.Image.

  • command (Optional[Sequence[str]]) – CfnJobDefinition.ContainerPropertiesProperty.Command.

  • environment (Union[IResolvable, Sequence[Union[IResolvable, EnvironmentProperty]], None]) – CfnJobDefinition.ContainerPropertiesProperty.Environment.

  • execution_role_arn (Optional[str]) – CfnJobDefinition.ContainerPropertiesProperty.ExecutionRoleArn.

  • fargate_platform_configuration (Union[IResolvable, FargatePlatformConfigurationProperty, None]) – CfnJobDefinition.ContainerPropertiesProperty.FargatePlatformConfiguration.

  • instance_type (Optional[str]) – CfnJobDefinition.ContainerPropertiesProperty.InstanceType.

  • job_role_arn (Optional[str]) – CfnJobDefinition.ContainerPropertiesProperty.JobRoleArn.

  • linux_parameters (Union[IResolvable, LinuxParametersProperty, None]) – CfnJobDefinition.ContainerPropertiesProperty.LinuxParameters.

  • log_configuration (Union[IResolvable, LogConfigurationProperty, None]) – CfnJobDefinition.ContainerPropertiesProperty.LogConfiguration.

  • memory (Union[int, float, None]) – CfnJobDefinition.ContainerPropertiesProperty.Memory.

  • mount_points (Union[IResolvable, Sequence[Union[IResolvable, MountPointsProperty]], None]) – CfnJobDefinition.ContainerPropertiesProperty.MountPoints.

  • network_configuration (Union[IResolvable, NetworkConfigurationProperty, None]) – CfnJobDefinition.ContainerPropertiesProperty.NetworkConfiguration.

  • privileged (Union[bool, IResolvable, None]) – CfnJobDefinition.ContainerPropertiesProperty.Privileged.

  • readonly_root_filesystem (Union[bool, IResolvable, None]) – CfnJobDefinition.ContainerPropertiesProperty.ReadonlyRootFilesystem.

  • resource_requirements (Union[IResolvable, Sequence[Union[IResolvable, ResourceRequirementProperty]], None]) – CfnJobDefinition.ContainerPropertiesProperty.ResourceRequirements.

  • secrets (Union[IResolvable, Sequence[Union[IResolvable, SecretProperty]], None]) – CfnJobDefinition.ContainerPropertiesProperty.Secrets.

  • ulimits (Union[IResolvable, Sequence[Union[IResolvable, UlimitProperty]], None]) – CfnJobDefinition.ContainerPropertiesProperty.Ulimits.

  • user (Optional[str]) – CfnJobDefinition.ContainerPropertiesProperty.User.

  • vcpus (Union[int, float, None]) – CfnJobDefinition.ContainerPropertiesProperty.Vcpus.

  • volumes (Union[IResolvable, Sequence[Union[IResolvable, VolumesProperty]], None]) – CfnJobDefinition.ContainerPropertiesProperty.Volumes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html

Attributes

command

CfnJobDefinition.ContainerPropertiesProperty.Command.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-command

Return type

Optional[List[str]]

environment

CfnJobDefinition.ContainerPropertiesProperty.Environment.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-environment

Return type

Union[IResolvable, List[Union[IResolvable, EnvironmentProperty]], None]

execution_role_arn

CfnJobDefinition.ContainerPropertiesProperty.ExecutionRoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-executionrolearn

Return type

Optional[str]

fargate_platform_configuration

CfnJobDefinition.ContainerPropertiesProperty.FargatePlatformConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-fargateplatformconfiguration

Return type

Union[IResolvable, FargatePlatformConfigurationProperty, None]

image

CfnJobDefinition.ContainerPropertiesProperty.Image.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-image

Return type

str

instance_type

CfnJobDefinition.ContainerPropertiesProperty.InstanceType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-instancetype

Return type

Optional[str]

job_role_arn

CfnJobDefinition.ContainerPropertiesProperty.JobRoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-jobrolearn

Return type

Optional[str]

linux_parameters

CfnJobDefinition.ContainerPropertiesProperty.LinuxParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-linuxparameters

Return type

Union[IResolvable, LinuxParametersProperty, None]

log_configuration

CfnJobDefinition.ContainerPropertiesProperty.LogConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-logconfiguration

Return type

Union[IResolvable, LogConfigurationProperty, None]

memory

CfnJobDefinition.ContainerPropertiesProperty.Memory.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-memory

Return type

Union[int, float, None]

mount_points

CfnJobDefinition.ContainerPropertiesProperty.MountPoints.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-mountpoints

Return type

Union[IResolvable, List[Union[IResolvable, MountPointsProperty]], None]

network_configuration

CfnJobDefinition.ContainerPropertiesProperty.NetworkConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-networkconfiguration

Return type

Union[IResolvable, NetworkConfigurationProperty, None]

privileged

CfnJobDefinition.ContainerPropertiesProperty.Privileged.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-privileged

Return type

Union[bool, IResolvable, None]

readonly_root_filesystem

CfnJobDefinition.ContainerPropertiesProperty.ReadonlyRootFilesystem.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-readonlyrootfilesystem

Return type

Union[bool, IResolvable, None]

resource_requirements

CfnJobDefinition.ContainerPropertiesProperty.ResourceRequirements.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-resourcerequirements

Return type

Union[IResolvable, List[Union[IResolvable, ResourceRequirementProperty]], None]

secrets

CfnJobDefinition.ContainerPropertiesProperty.Secrets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-secrets

Return type

Union[IResolvable, List[Union[IResolvable, SecretProperty]], None]

ulimits

CfnJobDefinition.ContainerPropertiesProperty.Ulimits.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-ulimits

Return type

Union[IResolvable, List[Union[IResolvable, UlimitProperty]], None]

user

CfnJobDefinition.ContainerPropertiesProperty.User.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-user

Return type

Optional[str]

vcpus

CfnJobDefinition.ContainerPropertiesProperty.Vcpus.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-vcpus

Return type

Union[int, float, None]

volumes

CfnJobDefinition.ContainerPropertiesProperty.Volumes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-volumes

Return type

Union[IResolvable, List[Union[IResolvable, VolumesProperty]], None]

DeviceProperty

class CfnJobDefinition.DeviceProperty(*, container_path=None, host_path=None, permissions=None)

Bases: object

Parameters
  • container_path (Optional[str]) – CfnJobDefinition.DeviceProperty.ContainerPath.

  • host_path (Optional[str]) – CfnJobDefinition.DeviceProperty.HostPath.

  • permissions (Optional[Sequence[str]]) – CfnJobDefinition.DeviceProperty.Permissions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html

Attributes

container_path

CfnJobDefinition.DeviceProperty.ContainerPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-containerpath

Return type

Optional[str]

host_path

CfnJobDefinition.DeviceProperty.HostPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-hostpath

Return type

Optional[str]

permissions

CfnJobDefinition.DeviceProperty.Permissions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-permissions

Return type

Optional[List[str]]

EnvironmentProperty

class CfnJobDefinition.EnvironmentProperty(*, name=None, value=None)

Bases: object

Parameters
  • name (Optional[str]) – CfnJobDefinition.EnvironmentProperty.Name.

  • value (Optional[str]) – CfnJobDefinition.EnvironmentProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html

Attributes

name

CfnJobDefinition.EnvironmentProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-name

Return type

Optional[str]

value

CfnJobDefinition.EnvironmentProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-value

Return type

Optional[str]

EvaluateOnExitProperty

class CfnJobDefinition.EvaluateOnExitProperty(*, action, on_exit_code=None, on_reason=None, on_status_reason=None)

Bases: object

Parameters
  • action (str) – CfnJobDefinition.EvaluateOnExitProperty.Action.

  • on_exit_code (Optional[str]) – CfnJobDefinition.EvaluateOnExitProperty.OnExitCode.

  • on_reason (Optional[str]) – CfnJobDefinition.EvaluateOnExitProperty.OnReason.

  • on_status_reason (Optional[str]) – CfnJobDefinition.EvaluateOnExitProperty.OnStatusReason.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html

Attributes

action

CfnJobDefinition.EvaluateOnExitProperty.Action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-action

Return type

str

on_exit_code

CfnJobDefinition.EvaluateOnExitProperty.OnExitCode.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onexitcode

Return type

Optional[str]

on_reason

CfnJobDefinition.EvaluateOnExitProperty.OnReason.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onreason

Return type

Optional[str]

on_status_reason

CfnJobDefinition.EvaluateOnExitProperty.OnStatusReason.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onstatusreason

Return type

Optional[str]

FargatePlatformConfigurationProperty

class CfnJobDefinition.FargatePlatformConfigurationProperty(*, platform_version=None)

Bases: object

Parameters

platform_version (Optional[str]) – CfnJobDefinition.FargatePlatformConfigurationProperty.PlatformVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-fargateplatformconfiguration.html

Attributes

platform_version

CfnJobDefinition.FargatePlatformConfigurationProperty.PlatformVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-fargateplatformconfiguration.html#cfn-batch-jobdefinition-containerproperties-fargateplatformconfiguration-platformversion

Return type

Optional[str]

LinuxParametersProperty

class CfnJobDefinition.LinuxParametersProperty(*, devices=None, init_process_enabled=None, max_swap=None, shared_memory_size=None, swappiness=None, tmpfs=None)

Bases: object

Parameters
  • devices (Union[IResolvable, Sequence[Union[IResolvable, DeviceProperty]], None]) – CfnJobDefinition.LinuxParametersProperty.Devices.

  • init_process_enabled (Union[bool, IResolvable, None]) – CfnJobDefinition.LinuxParametersProperty.InitProcessEnabled.

  • max_swap (Union[int, float, None]) – CfnJobDefinition.LinuxParametersProperty.MaxSwap.

  • shared_memory_size (Union[int, float, None]) – CfnJobDefinition.LinuxParametersProperty.SharedMemorySize.

  • swappiness (Union[int, float, None]) – CfnJobDefinition.LinuxParametersProperty.Swappiness.

  • tmpfs (Union[IResolvable, Sequence[Union[IResolvable, TmpfsProperty]], None]) – CfnJobDefinition.LinuxParametersProperty.Tmpfs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html

Attributes

devices

CfnJobDefinition.LinuxParametersProperty.Devices.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-devices

Return type

Union[IResolvable, List[Union[IResolvable, DeviceProperty]], None]

init_process_enabled

CfnJobDefinition.LinuxParametersProperty.InitProcessEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-initprocessenabled

Return type

Union[bool, IResolvable, None]

max_swap

CfnJobDefinition.LinuxParametersProperty.MaxSwap.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-maxswap

Return type

Union[int, float, None]

shared_memory_size

CfnJobDefinition.LinuxParametersProperty.SharedMemorySize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-sharedmemorysize

Return type

Union[int, float, None]

swappiness

CfnJobDefinition.LinuxParametersProperty.Swappiness.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-swappiness

Return type

Union[int, float, None]

tmpfs

CfnJobDefinition.LinuxParametersProperty.Tmpfs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-linuxparameters.html#cfn-batch-jobdefinition-containerproperties-linuxparameters-tmpfs

Return type

Union[IResolvable, List[Union[IResolvable, TmpfsProperty]], None]

LogConfigurationProperty

class CfnJobDefinition.LogConfigurationProperty(*, log_driver, options=None, secret_options=None)

Bases: object

Parameters
  • log_driver (str) – CfnJobDefinition.LogConfigurationProperty.LogDriver.

  • options (Optional[Any]) – CfnJobDefinition.LogConfigurationProperty.Options.

  • secret_options (Union[IResolvable, Sequence[Union[IResolvable, SecretProperty]], None]) – CfnJobDefinition.LogConfigurationProperty.SecretOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html

Attributes

log_driver

CfnJobDefinition.LogConfigurationProperty.LogDriver.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html#cfn-batch-jobdefinition-containerproperties-logconfiguration-logdriver

Return type

str

options

CfnJobDefinition.LogConfigurationProperty.Options.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html#cfn-batch-jobdefinition-containerproperties-logconfiguration-options

Return type

Any

secret_options

CfnJobDefinition.LogConfigurationProperty.SecretOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html#cfn-batch-jobdefinition-containerproperties-logconfiguration-secretoptions

Return type

Union[IResolvable, List[Union[IResolvable, SecretProperty]], None]

MountPointsProperty

class CfnJobDefinition.MountPointsProperty(*, container_path=None, read_only=None, source_volume=None)

Bases: object

Parameters
  • container_path (Optional[str]) – CfnJobDefinition.MountPointsProperty.ContainerPath.

  • read_only (Union[bool, IResolvable, None]) – CfnJobDefinition.MountPointsProperty.ReadOnly.

  • source_volume (Optional[str]) – CfnJobDefinition.MountPointsProperty.SourceVolume.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html

Attributes

container_path

CfnJobDefinition.MountPointsProperty.ContainerPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-containerpath

Return type

Optional[str]

read_only

CfnJobDefinition.MountPointsProperty.ReadOnly.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-readonly

Return type

Union[bool, IResolvable, None]

source_volume

CfnJobDefinition.MountPointsProperty.SourceVolume.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-sourcevolume

Return type

Optional[str]

NetworkConfigurationProperty

class CfnJobDefinition.NetworkConfigurationProperty(*, assign_public_ip=None)

Bases: object

Parameters

assign_public_ip (Optional[str]) – CfnJobDefinition.NetworkConfigurationProperty.AssignPublicIp.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-networkconfiguration.html

Attributes

assign_public_ip

CfnJobDefinition.NetworkConfigurationProperty.AssignPublicIp.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-networkconfiguration.html#cfn-batch-jobdefinition-containerproperties-networkconfiguration-assignpublicip

Return type

Optional[str]

NodePropertiesProperty

class CfnJobDefinition.NodePropertiesProperty(*, main_node, node_range_properties, num_nodes)

Bases: object

Parameters
  • main_node (Union[int, float]) – CfnJobDefinition.NodePropertiesProperty.MainNode.

  • node_range_properties (Union[IResolvable, Sequence[Union[IResolvable, NodeRangePropertyProperty]]]) – CfnJobDefinition.NodePropertiesProperty.NodeRangeProperties.

  • num_nodes (Union[int, float]) – CfnJobDefinition.NodePropertiesProperty.NumNodes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html

Attributes

main_node

CfnJobDefinition.NodePropertiesProperty.MainNode.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-mainnode

Return type

Union[int, float]

node_range_properties

CfnJobDefinition.NodePropertiesProperty.NodeRangeProperties.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-noderangeproperties

Return type

Union[IResolvable, List[Union[IResolvable, NodeRangePropertyProperty]]]

num_nodes

CfnJobDefinition.NodePropertiesProperty.NumNodes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-numnodes

Return type

Union[int, float]

NodeRangePropertyProperty

class CfnJobDefinition.NodeRangePropertyProperty(*, target_nodes, container=None)

Bases: object

Parameters
  • target_nodes (str) – CfnJobDefinition.NodeRangePropertyProperty.TargetNodes.

  • container (Union[IResolvable, ContainerPropertiesProperty, None]) – CfnJobDefinition.NodeRangePropertyProperty.Container.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html

Attributes

container

CfnJobDefinition.NodeRangePropertyProperty.Container.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-container

Return type

Union[IResolvable, ContainerPropertiesProperty, None]

target_nodes

CfnJobDefinition.NodeRangePropertyProperty.TargetNodes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-targetnodes

Return type

str

ResourceRequirementProperty

class CfnJobDefinition.ResourceRequirementProperty(*, type=None, value=None)

Bases: object

Parameters
  • type (Optional[str]) – CfnJobDefinition.ResourceRequirementProperty.Type.

  • value (Optional[str]) – CfnJobDefinition.ResourceRequirementProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html

Attributes

type

CfnJobDefinition.ResourceRequirementProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html#cfn-batch-jobdefinition-resourcerequirement-type

Return type

Optional[str]

value

CfnJobDefinition.ResourceRequirementProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-resourcerequirement.html#cfn-batch-jobdefinition-resourcerequirement-value

Return type

Optional[str]

RetryStrategyProperty

class CfnJobDefinition.RetryStrategyProperty(*, attempts=None, evaluate_on_exit=None)

Bases: object

Parameters
  • attempts (Union[int, float, None]) – CfnJobDefinition.RetryStrategyProperty.Attempts.

  • evaluate_on_exit (Union[IResolvable, Sequence[Union[IResolvable, EvaluateOnExitProperty]], None]) – CfnJobDefinition.RetryStrategyProperty.EvaluateOnExit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html

Attributes

attempts

CfnJobDefinition.RetryStrategyProperty.Attempts.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html#cfn-batch-jobdefinition-retrystrategy-attempts

Return type

Union[int, float, None]

evaluate_on_exit

CfnJobDefinition.RetryStrategyProperty.EvaluateOnExit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html#cfn-batch-jobdefinition-retrystrategy-evaluateonexit

Return type

Union[IResolvable, List[Union[IResolvable, EvaluateOnExitProperty]], None]

SecretProperty

class CfnJobDefinition.SecretProperty(*, name, value_from)

Bases: object

Parameters
  • name (str) – CfnJobDefinition.SecretProperty.Name.

  • value_from (str) – CfnJobDefinition.SecretProperty.ValueFrom.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-secret.html

Attributes

name

CfnJobDefinition.SecretProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-secret.html#cfn-batch-jobdefinition-secret-name

Return type

str

value_from

CfnJobDefinition.SecretProperty.ValueFrom.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-secret.html#cfn-batch-jobdefinition-secret-valuefrom

Return type

str

TimeoutProperty

class CfnJobDefinition.TimeoutProperty(*, attempt_duration_seconds=None)

Bases: object

Parameters

attempt_duration_seconds (Union[int, float, None]) – CfnJobDefinition.TimeoutProperty.AttemptDurationSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-timeout.html

Attributes

attempt_duration_seconds

CfnJobDefinition.TimeoutProperty.AttemptDurationSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-timeout.html#cfn-batch-jobdefinition-timeout-attemptdurationseconds

Return type

Union[int, float, None]

TmpfsProperty

class CfnJobDefinition.TmpfsProperty(*, container_path, size, mount_options=None)

Bases: object

Parameters
  • container_path (str) – CfnJobDefinition.TmpfsProperty.ContainerPath.

  • size (Union[int, float]) – CfnJobDefinition.TmpfsProperty.Size.

  • mount_options (Optional[Sequence[str]]) – CfnJobDefinition.TmpfsProperty.MountOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html

Attributes

container_path

CfnJobDefinition.TmpfsProperty.ContainerPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html#cfn-batch-jobdefinition-tmpfs-containerpath

Return type

str

mount_options

CfnJobDefinition.TmpfsProperty.MountOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html#cfn-batch-jobdefinition-tmpfs-mountoptions

Return type

Optional[List[str]]

size

CfnJobDefinition.TmpfsProperty.Size.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-tmpfs.html#cfn-batch-jobdefinition-tmpfs-size

Return type

Union[int, float]

UlimitProperty

class CfnJobDefinition.UlimitProperty(*, hard_limit, name, soft_limit)

Bases: object

Parameters
  • hard_limit (Union[int, float]) – CfnJobDefinition.UlimitProperty.HardLimit.

  • name (str) – CfnJobDefinition.UlimitProperty.Name.

  • soft_limit (Union[int, float]) – CfnJobDefinition.UlimitProperty.SoftLimit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html

Attributes

hard_limit

CfnJobDefinition.UlimitProperty.HardLimit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-hardlimit

Return type

Union[int, float]

name

CfnJobDefinition.UlimitProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-name

Return type

str

soft_limit

CfnJobDefinition.UlimitProperty.SoftLimit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-softlimit

Return type

Union[int, float]

VolumesHostProperty

class CfnJobDefinition.VolumesHostProperty(*, source_path=None)

Bases: object

Parameters

source_path (Optional[str]) – CfnJobDefinition.VolumesHostProperty.SourcePath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html

Attributes

source_path

CfnJobDefinition.VolumesHostProperty.SourcePath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html#cfn-batch-jobdefinition-volumeshost-sourcepath

Return type

Optional[str]

VolumesProperty

class CfnJobDefinition.VolumesProperty(*, host=None, name=None)

Bases: object

Parameters
  • host (Union[IResolvable, VolumesHostProperty, None]) – CfnJobDefinition.VolumesProperty.Host.

  • name (Optional[str]) – CfnJobDefinition.VolumesProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html

Attributes

host

CfnJobDefinition.VolumesProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-host

Return type

Union[IResolvable, VolumesHostProperty, None]

name

CfnJobDefinition.VolumesProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-name

Return type

Optional[str]