software.amazon.awscdk.services.batch

Class CfnComputeEnvironment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.batch.CfnComputeEnvironment

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:03.517Z")
 @Stability(value=Stable)
public class CfnComputeEnvironment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Batch::ComputeEnvironment`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 Object tags;
 CfnComputeEnvironment cfnComputeEnvironment = CfnComputeEnvironment.Builder.create(this, "MyCfnComputeEnvironment")
         .type("type")
         // the properties below are optional
         .computeEnvironmentName("computeEnvironmentName")
         .computeResources(ComputeResourcesProperty.builder()
                 .maxvCpus(123)
                 .subnets(List.of("subnets"))
                 .type("type")
                 // the properties below are optional
                 .allocationStrategy("allocationStrategy")
                 .bidPercentage(123)
                 .desiredvCpus(123)
                 .ec2Configuration(List.of(Ec2ConfigurationObjectProperty.builder()
                         .imageType("imageType")
                         // the properties below are optional
                         .imageIdOverride("imageIdOverride")
                         .build()))
                 .ec2KeyPair("ec2KeyPair")
                 .imageId("imageId")
                 .instanceRole("instanceRole")
                 .instanceTypes(List.of("instanceTypes"))
                 .launchTemplate(LaunchTemplateSpecificationProperty.builder()
                         .launchTemplateId("launchTemplateId")
                         .launchTemplateName("launchTemplateName")
                         .version("version")
                         .build())
                 .minvCpus(123)
                 .placementGroup("placementGroup")
                 .securityGroupIds(List.of("securityGroupIds"))
                 .spotIamFleetRole("spotIamFleetRole")
                 .tags(tags)
                 .build())
         .serviceRole("serviceRole")
         .state("state")
         .tags(tags)
         .unmanagedvCpus(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnComputeEnvironment.Builder A fluent builder for CfnComputeEnvironment.
static interface	CfnComputeEnvironment.ComputeResourcesProperty Example:
static interface	CfnComputeEnvironment.Ec2ConfigurationObjectProperty Example:
static interface	CfnComputeEnvironment.LaunchTemplateSpecificationProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnComputeEnvironment(Construct scope, String id, CfnComputeEnvironmentProps props) Create a new `AWS::Batch::ComputeEnvironment`.
protected	CfnComputeEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnComputeEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getComputeEnvironmentName() `AWS::Batch::ComputeEnvironment.ComputeEnvironmentName`.
Object	getComputeResources() `AWS::Batch::ComputeEnvironment.ComputeResources`.
String	getServiceRole() `AWS::Batch::ComputeEnvironment.ServiceRole`.
String	getState() `AWS::Batch::ComputeEnvironment.State`.
TagManager	getTags() `AWS::Batch::ComputeEnvironment.Tags`.
String	getType() `AWS::Batch::ComputeEnvironment.Type`.
Number	getUnmanagedvCpus() `AWS::Batch::ComputeEnvironment.UnmanagedvCpus`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setComputeEnvironmentName(String value) `AWS::Batch::ComputeEnvironment.ComputeEnvironmentName`.
void	setComputeResources(CfnComputeEnvironment.ComputeResourcesProperty value) `AWS::Batch::ComputeEnvironment.ComputeResources`.
void	setComputeResources(IResolvable value) `AWS::Batch::ComputeEnvironment.ComputeResources`.
void	setServiceRole(String value) `AWS::Batch::ComputeEnvironment.ServiceRole`.
void	setState(String value) `AWS::Batch::ComputeEnvironment.State`.
void	setType(String value) `AWS::Batch::ComputeEnvironment.Type`.
void	setUnmanagedvCpus(Number value) `AWS::Batch::ComputeEnvironment.UnmanagedvCpus`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnComputeEnvironment

protected CfnComputeEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

CfnComputeEnvironment

protected CfnComputeEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnComputeEnvironment

@Stability(value=Stable)
public CfnComputeEnvironment(@NotNull
                                                      Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      CfnComputeEnvironmentProps props)

Create a new `AWS::Batch::ComputeEnvironment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Batch::ComputeEnvironment.Tags`.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

`AWS::Batch::ComputeEnvironment.Type`.

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

`AWS::Batch::ComputeEnvironment.Type`.

getComputeEnvironmentName

@Stability(value=Stable)
 @Nullable
public String getComputeEnvironmentName()

`AWS::Batch::ComputeEnvironment.ComputeEnvironmentName`.

setComputeEnvironmentName

@Stability(value=Stable)
public void setComputeEnvironmentName(@Nullable
                                                               String value)

`AWS::Batch::ComputeEnvironment.ComputeEnvironmentName`.

getComputeResources

@Stability(value=Stable)
 @Nullable
public Object getComputeResources()

`AWS::Batch::ComputeEnvironment.ComputeResources`.

setComputeResources

@Stability(value=Stable)
public void setComputeResources(@Nullable
                                                         CfnComputeEnvironment.ComputeResourcesProperty value)

`AWS::Batch::ComputeEnvironment.ComputeResources`.

setComputeResources

@Stability(value=Stable)
public void setComputeResources(@Nullable
                                                         IResolvable value)

`AWS::Batch::ComputeEnvironment.ComputeResources`.

getServiceRole

@Stability(value=Stable)
 @Nullable
public String getServiceRole()

`AWS::Batch::ComputeEnvironment.ServiceRole`.

setServiceRole

@Stability(value=Stable)
public void setServiceRole(@Nullable
                                                    String value)

`AWS::Batch::ComputeEnvironment.ServiceRole`.

getState

@Stability(value=Stable)
 @Nullable
public String getState()

`AWS::Batch::ComputeEnvironment.State`.

setState

@Stability(value=Stable)
public void setState(@Nullable
                                              String value)

`AWS::Batch::ComputeEnvironment.State`.

getUnmanagedvCpus

@Stability(value=Stable)
 @Nullable
public Number getUnmanagedvCpus()

`AWS::Batch::ComputeEnvironment.UnmanagedvCpus`.

setUnmanagedvCpus

@Stability(value=Stable)
public void setUnmanagedvCpus(@Nullable
                                                       Number value)

`AWS::Batch::ComputeEnvironment.UnmanagedvCpus`.