@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateComputeEnvironmentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Contains the parameters for CreateComputeEnvironment
.
NOOP
Constructor and Description |
---|
CreateComputeEnvironmentRequest() |
Modifier and Type | Method and Description |
---|---|
CreateComputeEnvironmentRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateComputeEnvironmentRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateComputeEnvironmentRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getComputeEnvironmentName()
The name for your compute environment.
|
ComputeResource |
getComputeResources()
Details about the compute resources managed by 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 that you apply to the compute environment to help you categorize and organize your resources.
|
String |
getType()
The type of the compute environment:
MANAGED or UNMANAGED . |
int |
hashCode() |
void |
setComputeEnvironmentName(String computeEnvironmentName)
The name for your compute environment.
|
void |
setComputeResources(ComputeResource computeResources)
Details about the compute resources managed by the compute environment.
|
void |
setServiceRole(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.
|
void |
setState(CEState state)
The state of the compute environment.
|
void |
setState(String state)
The state of the compute environment.
|
void |
setTags(Map<String,String> tags)
The tags that you apply to the compute environment to help you categorize and organize your resources.
|
void |
setType(CEType type)
The type of the compute environment:
MANAGED or UNMANAGED . |
void |
setType(String type)
The type of the compute environment:
MANAGED or UNMANAGED . |
String |
toString()
Returns a string representation of this object.
|
CreateComputeEnvironmentRequest |
withComputeEnvironmentName(String computeEnvironmentName)
The name for your compute environment.
|
CreateComputeEnvironmentRequest |
withComputeResources(ComputeResource computeResources)
Details about the compute resources managed by the compute environment.
|
CreateComputeEnvironmentRequest |
withServiceRole(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.
|
CreateComputeEnvironmentRequest |
withState(CEState state)
The state of the compute environment.
|
CreateComputeEnvironmentRequest |
withState(String state)
The state of the compute environment.
|
CreateComputeEnvironmentRequest |
withTags(Map<String,String> tags)
The tags that you apply to the compute environment to help you categorize and organize your resources.
|
CreateComputeEnvironmentRequest |
withType(CEType type)
The type of the compute environment:
MANAGED or UNMANAGED . |
CreateComputeEnvironmentRequest |
withType(String type)
The type of the compute environment:
MANAGED or UNMANAGED . |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setComputeEnvironmentName(String computeEnvironmentName)
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
computeEnvironmentName
- The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed.public String getComputeEnvironmentName()
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
public CreateComputeEnvironmentRequest withComputeEnvironmentName(String computeEnvironmentName)
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
computeEnvironmentName
- The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed.public void setType(String type)
The type of the compute environment: MANAGED
or UNMANAGED
. For more information, see Compute Environments in
the AWS Batch User Guide.
type
- The type of the compute environment: MANAGED
or UNMANAGED
. For more information,
see Compute
Environments in the AWS Batch User Guide.CEType
public String getType()
The type of the compute environment: MANAGED
or UNMANAGED
. For more information, see Compute Environments in
the AWS Batch User Guide.
MANAGED
or UNMANAGED
. For more
information, see Compute
Environments in the AWS Batch User Guide.CEType
public CreateComputeEnvironmentRequest withType(String type)
The type of the compute environment: MANAGED
or UNMANAGED
. For more information, see Compute Environments in
the AWS Batch User Guide.
type
- The type of the compute environment: MANAGED
or UNMANAGED
. For more information,
see Compute
Environments in the AWS Batch User Guide.CEType
public void setType(CEType type)
The type of the compute environment: MANAGED
or UNMANAGED
. For more information, see Compute Environments in
the AWS Batch User Guide.
type
- The type of the compute environment: MANAGED
or UNMANAGED
. For more information,
see Compute
Environments in the AWS Batch User Guide.CEType
public CreateComputeEnvironmentRequest withType(CEType type)
The type of the compute environment: MANAGED
or UNMANAGED
. For more information, see Compute Environments in
the AWS Batch User Guide.
type
- The type of the compute environment: MANAGED
or UNMANAGED
. For more information,
see Compute
Environments in the AWS Batch User Guide.CEType
public void setState(String 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.
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.
CEState
public String getState()
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.
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.
CEState
public CreateComputeEnvironmentRequest withState(String 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.
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.
CEState
public void setState(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 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.
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.
CEState
public CreateComputeEnvironmentRequest withState(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 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.
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.
CEState
public void setComputeResources(ComputeResource computeResources)
Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.
computeResources
- Details about the compute resources managed by the compute environment. This parameter is required for
managed compute environments. For more information, see Compute
Environments in the AWS Batch User Guide.public ComputeResource getComputeResources()
Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.
public CreateComputeEnvironmentRequest withComputeResources(ComputeResource computeResources)
Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.
computeResources
- Details about the compute resources managed by the compute environment. This parameter is required for
managed compute environments. For more information, see Compute
Environments in the AWS Batch User Guide.public void setServiceRole(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. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
If your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try 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-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.
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. For more information, see AWS Batch service IAM
role in the AWS Batch User Guide. If your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try 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-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.
public 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. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
If your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try 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-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.
If your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try 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-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.
public CreateComputeEnvironmentRequest withServiceRole(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. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
If your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try 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-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.
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. For more information, see AWS Batch service IAM
role in the AWS Batch User Guide. If your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try 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-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.
public Map<String,String> getTags()
The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
public void setTags(Map<String,String> tags)
The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
tags
- The tags that you apply to the compute environment to help you categorize and organize your resources.
Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS
General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
public CreateComputeEnvironmentRequest withTags(Map<String,String> tags)
The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
tags
- The tags that you apply to the compute environment to help you categorize and organize your resources.
Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS
General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
public CreateComputeEnvironmentRequest addTagsEntry(String key, String value)
public CreateComputeEnvironmentRequest clearTagsEntries()
public String toString()
toString
in class Object
Object.toString()
public CreateComputeEnvironmentRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()