@Stability(value=Stable) @Internal public static final class CfnComputeEnvironmentProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnComputeEnvironmentProps
CfnComputeEnvironmentPropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnComputeEnvironmentProps.Builder, CfnComputeEnvironmentProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnComputeEnvironmentProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnComputeEnvironmentProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
String |
getComputeEnvironmentName()
The name for your compute environment.
|
Object |
getComputeResources()
The ComputeResources property type specifies details of the compute resources managed by the compute environment.
|
Object |
getReplaceComputeEnvironment()
Specifies whether the compute environment should be replaced if an update is made that requires replacing the instances in the compute environment.
|
String |
getServiceRole()
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
|
String |
getState()
The state of the compute environment.
|
Map<String,String> |
getTags()
The tags applied to the compute environment.
|
String |
getType()
The type of the compute environment: `MANAGED` or `UNMANAGED` .
|
Number |
getUnmanagedvCpus()
The maximum number of vCPUs for an unmanaged compute environment.
|
Object |
getUpdatePolicy()
Specifies the infrastructure update policy for the compute environment.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnComputeEnvironmentProps.Builder builder)
CfnComputeEnvironmentProps.Builder.public final String getType()
CfnComputeEnvironmentPropsFor more information, see Compute Environments in the AWS Batch User Guide .
getType in interface CfnComputeEnvironmentPropspublic final String getComputeEnvironmentName()
CfnComputeEnvironmentPropsIt can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
getComputeEnvironmentName in interface CfnComputeEnvironmentPropspublic final Object getComputeResources()
CfnComputeEnvironmentPropsThis parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
getComputeResources in interface CfnComputeEnvironmentPropspublic final Object getReplaceComputeEnvironment()
CfnComputeEnvironmentProps
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 , no other properties should be changed 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 property type: AllocationStrategy , BidPercentage , Ec2Configuration , Ec2KeyPair , Ec2KeyPair , ImageId , InstanceRole , InstanceTypes , LaunchTemplate , MaxvCpus , MinvCpus , PlacementGroup , SecurityGroupIds , Subnets , Tags , Type , and UpdateToLatestImageVersion .
getReplaceComputeEnvironment in interface CfnComputeEnvironmentPropspublic final String getServiceRole()
CfnComputeEnvironmentPropsFor more information, see AWS Batch service IAM role in the AWS Batch User Guide .
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/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide .
Depending on how you created your AWS Batch service role, its ARN might contain the
service-rolepath prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use theservice-rolepath prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
getServiceRole in interface CfnComputeEnvironmentPropspublic final String getState()
CfnComputeEnvironmentProps
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.
getState in interface CfnComputeEnvironmentPropspublic final Map<String,String> getTags()
CfnComputeEnvironmentPropsgetTags in interface CfnComputeEnvironmentPropspublic final Number getUnmanagedvCpus()
CfnComputeEnvironmentPropsThis 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.
This parameter is only supported when the
typeparameter is set toUNMANAGED.
getUnmanagedvCpus in interface CfnComputeEnvironmentPropspublic final Object getUpdatePolicy()
CfnComputeEnvironmentPropsFor more information about infrastructure updates, see Updating compute environments in the AWS Batch User Guide .
getUpdatePolicy in interface CfnComputeEnvironmentProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.