@Generated(value="software.amazon.awssdk:codegen") public final class CreateComputeEnvironmentRequest extends BatchRequest implements ToCopyableBuilder<CreateComputeEnvironmentRequest.Builder,CreateComputeEnvironmentRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateComputeEnvironmentRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateComputeEnvironmentRequest.Builder |
builder() |
String |
computeEnvironmentName()
The name for your compute environment.
|
ComputeResource |
computeResources()
Details of the compute resources managed by the compute environment.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
static Class<? extends CreateComputeEnvironmentRequest.Builder> |
serializableBuilderClass() |
String |
serviceRole()
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on
your behalf.
|
CEState |
state()
The state of the compute environment.
|
String |
stateAsString()
The state of the compute environment.
|
CreateComputeEnvironmentRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
CEType |
type()
The type of the compute environment.
|
String |
typeAsString()
The type of the compute environment.
|
overrideConfiguration
copy
public String computeEnvironmentName()
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
public CEType type()
The type of the compute environment.
If the service returns an enum value that is not available in the current SDK version, type
will return
CEType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
CEType
public String typeAsString()
The type of the compute environment.
If the service returns an enum value that is not available in the current SDK version, type
will return
CEType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
CEType
public CEState 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 service returns an enum value that is not available in the current SDK version, state
will return
CEState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateAsString()
.
ENABLED
, then the compute environment
accepts jobs from a queue and can scale out automatically based on queues.CEState
public String stateAsString()
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 service returns an enum value that is not available in the current SDK version, state
will return
CEState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateAsString()
.
ENABLED
, then the compute environment
accepts jobs from a queue and can scale out automatically based on queues.CEState
public ComputeResource computeResources()
Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.
public String serviceRole()
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
If your specified role has a path other than /
, then you must either specify the full role ARN (this
is recommended) or prefix the role name with the path.
Depending on how you created your AWS Batch service role, its ARN may contain the service-role
path
prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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.
If your specified role has a path other than /
, then you must either specify the full role
ARN (this is recommended) or prefix the role name with the path.
Depending on how you created your AWS Batch service role, its ARN may contain the
service-role
path prefix. When you only specify the name of the service role, AWS Batch
assumes that your ARN does not 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.
public CreateComputeEnvironmentRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateComputeEnvironmentRequest.Builder,CreateComputeEnvironmentRequest>
toBuilder
in class BatchRequest
public static CreateComputeEnvironmentRequest.Builder builder()
public static Class<? extends CreateComputeEnvironmentRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.