CfnComputeEnvironmentProps

class aws_cdk.aws_batch.CfnComputeEnvironmentProps(*, type, compute_environment_name=None, compute_resources=None, eks_configuration=None, replace_compute_environment=None, service_role=None, state=None, tags=None, unmanagedv_cpus=None, update_policy=None)

Bases: object

Properties for defining a CfnComputeEnvironment.

Parameters
Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_batch as batch

cfn_compute_environment_props = batch.CfnComputeEnvironmentProps(
    type="type",

    # the properties below are optional
    compute_environment_name="computeEnvironmentName",
    compute_resources=batch.CfnComputeEnvironment.ComputeResourcesProperty(
        maxv_cpus=123,
        subnets=["subnets"],
        type="type",

        # the properties below are optional
        allocation_strategy="allocationStrategy",
        bid_percentage=123,
        desiredv_cpus=123,
        ec2_configuration=[batch.CfnComputeEnvironment.Ec2ConfigurationObjectProperty(
            image_type="imageType",

            # the properties below are optional
            image_id_override="imageIdOverride",
            image_kubernetes_version="imageKubernetesVersion"
        )],
        ec2_key_pair="ec2KeyPair",
        image_id="imageId",
        instance_role="instanceRole",
        instance_types=["instanceTypes"],
        launch_template=batch.CfnComputeEnvironment.LaunchTemplateSpecificationProperty(
            launch_template_id="launchTemplateId",
            launch_template_name="launchTemplateName",
            version="version"
        ),
        minv_cpus=123,
        placement_group="placementGroup",
        security_group_ids=["securityGroupIds"],
        spot_iam_fleet_role="spotIamFleetRole",
        tags={
            "tags_key": "tags"
        },
        update_to_latest_image_version=False
    ),
    eks_configuration=batch.CfnComputeEnvironment.EksConfigurationProperty(
        eks_cluster_arn="eksClusterArn",
        kubernetes_namespace="kubernetesNamespace"
    ),
    replace_compute_environment=False,
    service_role="serviceRole",
    state="state",
    tags={
        "tags_key": "tags"
    },
    unmanagedv_cpus=123,
    update_policy=batch.CfnComputeEnvironment.UpdatePolicyProperty(
        job_execution_timeout_minutes=123,
        terminate_jobs_on_update=False
    )
)

Attributes

compute_environment_name

The name for your compute environment.

It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Link

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

Return type

Optional[str]

compute_resources

The ComputeResources property type specifies details of the compute resources managed by the compute environment.

This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .

Link

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

Return type

Union[ComputeResourcesProperty, IResolvable, None]

eks_configuration

The details for the Amazon EKS cluster that supports the compute environment.

Link

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

Return type

Union[IResolvable, EksConfigurationProperty, None]

replace_compute_environment

Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.

The default value is true . To enable more properties to be updated, set this property to false . When changing the value of this property to false , do not change any other properties at the same time. If other properties are changed at the same time, and the change needs to be rolled back but it can’t, it’s possible for the stack to go into the UPDATE_ROLLBACK_FAILED state. You can’t update a stack that is in the UPDATE_ROLLBACK_FAILED state. However, if you can continue to roll it back, you can return the stack to its original settings and then try to update it again. For more information, see Continue rolling back an update in the AWS CloudFormation User Guide .

The properties that can’t be changed without replacing the compute environment are in the `ComputeResources <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html>`_ property type: `AllocationStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy>`_ , `BidPercentage <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage>`_ , `Ec2Configuration <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2configuration>`_ , `Ec2KeyPair <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair>`_ , `Ec2KeyPair <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair>`_ , `ImageId <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid>`_ , `InstanceRole <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole>`_ , `InstanceTypes <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes>`_ , `LaunchTemplate <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate>`_ , `MaxvCpus <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus>`_ , `MinvCpus <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus>`_ , `PlacementGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup>`_ , `SecurityGroupIds <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids>`_ , `Subnets <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets>`_ , Tags , `Type <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type>`_ , and `UpdateToLatestImageVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion>`_ .

Link

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

Return type

Union[bool, IResolvable, None]

service_role

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

For more information, see AWS Batch service IAM role in the AWS Batch User Guide . .. epigraph:

If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account.

If your specified role has a path other than / , then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ , specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide . .. epigraph:

Depending on how you created your AWS Batch service role, its ARN might contain the ``service-role`` path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the ``service-role`` path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
Link

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

Return type

Optional[str]

state

The state of the compute environment.

If the state is ENABLED , then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

If the state is ENABLED , then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED , then the AWS Batch scheduler doesn’t attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don’t scale out. However, they scale in to minvCpus value after instances become idle.

Link

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

Return type

Optional[str]

tags

The tags applied to the compute environment.

Link

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

Return type

Optional[Mapping[str, str]]

type

MANAGED or UNMANAGED .

For more information, see Compute Environments in the AWS Batch User Guide .

Link

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

Type

The type of the compute environment

Return type

str

unmanagedv_cpus

The maximum number of vCPUs for an unmanaged compute environment.

This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn’t provided for a fair share job queue, no vCPU capacity is reserved. .. epigraph:

This parameter is only supported when the ``type`` parameter is set to ``UNMANAGED`` .
Link

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

Return type

Union[int, float, None]

update_policy

Specifies the infrastructure update policy for the compute environment.

For more information about infrastructure updates, see Updating compute environments in the AWS Batch User Guide .

Link

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

Return type

Union[IResolvable, UpdatePolicyProperty, None]