Skip to content

Latest commit

 

History

History
2862 lines (1778 loc) · 140 KB

batchComputeEnvironment.md

File metadata and controls

2862 lines (1778 loc) · 140 KB

batchComputeEnvironment Submodule

Constructs

BatchComputeEnvironment

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment aws_batch_compute_environment}.

Initializers

import { batchComputeEnvironment } from '@cdktf/aws-cdk'

new batchComputeEnvironment.BatchComputeEnvironment(scope: Construct, id: string, config: BatchComputeEnvironmentConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config BatchComputeEnvironmentConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putComputeResources No description.
resetComputeEnvironmentName No description.
resetComputeEnvironmentNamePrefix No description.
resetComputeResources No description.
resetId No description.
resetServiceRole No description.
resetState No description.
resetTags No description.
resetTagsAll No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


moveToId
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


putComputeResources
public putComputeResources(value: BatchComputeEnvironmentComputeResources): void
valueRequired

resetComputeEnvironmentName
public resetComputeEnvironmentName(): void
resetComputeEnvironmentNamePrefix
public resetComputeEnvironmentNamePrefix(): void
resetComputeResources
public resetComputeResources(): void
resetId
public resetId(): void
resetServiceRole
public resetServiceRole(): void
resetState
public resetState(): void
resetTags
public resetTags(): void
resetTagsAll
public resetTagsAll(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a BatchComputeEnvironment resource upon running "cdktf plan ".

isConstruct
import { batchComputeEnvironment } from '@cdktf/aws-cdk'

batchComputeEnvironment.BatchComputeEnvironment.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


isTerraformElement
import { batchComputeEnvironment } from '@cdktf/aws-cdk'

batchComputeEnvironment.BatchComputeEnvironment.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { batchComputeEnvironment } from '@cdktf/aws-cdk'

batchComputeEnvironment.BatchComputeEnvironment.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { batchComputeEnvironment } from '@cdktf/aws-cdk'

batchComputeEnvironment.BatchComputeEnvironment.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a BatchComputeEnvironment resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

The construct id used in the generated config for the BatchComputeEnvironment to import.


importFromIdRequired
  • Type: string

The id of the existing BatchComputeEnvironment that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the BatchComputeEnvironment to import is found.


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
arn string No description.
computeResources BatchComputeEnvironmentComputeResourcesOutputReference No description.
ecsClusterArn string No description.
status string No description.
statusReason string No description.
computeEnvironmentNameInput string No description.
computeEnvironmentNamePrefixInput string No description.
computeResourcesInput BatchComputeEnvironmentComputeResources No description.
idInput string No description.
serviceRoleInput string No description.
stateInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
typeInput string No description.
computeEnvironmentName string No description.
computeEnvironmentNamePrefix string No description.
id string No description.
serviceRole string No description.
state string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
type string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

arnRequired
public readonly arn: string;
  • Type: string

computeResourcesRequired
public readonly computeResources: BatchComputeEnvironmentComputeResourcesOutputReference;

ecsClusterArnRequired
public readonly ecsClusterArn: string;
  • Type: string

statusRequired
public readonly status: string;
  • Type: string

statusReasonRequired
public readonly statusReason: string;
  • Type: string

computeEnvironmentNameInputOptional
public readonly computeEnvironmentNameInput: string;
  • Type: string

computeEnvironmentNamePrefixInputOptional
public readonly computeEnvironmentNamePrefixInput: string;
  • Type: string

computeResourcesInputOptional
public readonly computeResourcesInput: BatchComputeEnvironmentComputeResources;

idInputOptional
public readonly idInput: string;
  • Type: string

serviceRoleInputOptional
public readonly serviceRoleInput: string;
  • Type: string

stateInputOptional
public readonly stateInput: string;
  • Type: string

tagsAllInputOptional
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsInputOptional
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

typeInputOptional
public readonly typeInput: string;
  • Type: string

computeEnvironmentNameRequired
public readonly computeEnvironmentName: string;
  • Type: string

computeEnvironmentNamePrefixRequired
public readonly computeEnvironmentNamePrefix: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

serviceRoleRequired
public readonly serviceRole: string;
  • Type: string

stateRequired
public readonly state: string;
  • Type: string

tagsRequired
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsAllRequired
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

typeRequired
public readonly type: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

BatchComputeEnvironmentComputeResources

Initializer

import { batchComputeEnvironment } from '@cdktf/aws-cdk'

const batchComputeEnvironmentComputeResources: batchComputeEnvironment.BatchComputeEnvironmentComputeResources = { ... }

Properties

Name Type Description
maxVcpus number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#max_vcpus BatchComputeEnvironment#max_vcpus}.
securityGroupIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#security_group_ids BatchComputeEnvironment#security_group_ids}.
subnets string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#subnets BatchComputeEnvironment#subnets}.
type string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#type BatchComputeEnvironment#type}.
allocationStrategy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#allocation_strategy BatchComputeEnvironment#allocation_strategy}.
bidPercentage number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#bid_percentage BatchComputeEnvironment#bid_percentage}.
desiredVcpus number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#desired_vcpus BatchComputeEnvironment#desired_vcpus}.
ec2Configuration BatchComputeEnvironmentComputeResourcesEc2Configuration ec2_configuration block.
ec2KeyPair string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#ec2_key_pair BatchComputeEnvironment#ec2_key_pair}.
imageId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#image_id BatchComputeEnvironment#image_id}.
instanceRole string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#instance_role BatchComputeEnvironment#instance_role}.
instanceType string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#instance_type BatchComputeEnvironment#instance_type}.
launchTemplate BatchComputeEnvironmentComputeResourcesLaunchTemplate launch_template block.
minVcpus number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#min_vcpus BatchComputeEnvironment#min_vcpus}.
spotIamFleetRole string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#spot_iam_fleet_role BatchComputeEnvironment#spot_iam_fleet_role}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#tags BatchComputeEnvironment#tags}.

maxVcpusRequired
public readonly maxVcpus: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#max_vcpus BatchComputeEnvironment#max_vcpus}.


securityGroupIdsRequired
public readonly securityGroupIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#security_group_ids BatchComputeEnvironment#security_group_ids}.


subnetsRequired
public readonly subnets: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#subnets BatchComputeEnvironment#subnets}.


typeRequired
public readonly type: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#type BatchComputeEnvironment#type}.


allocationStrategyOptional
public readonly allocationStrategy: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#allocation_strategy BatchComputeEnvironment#allocation_strategy}.


bidPercentageOptional
public readonly bidPercentage: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#bid_percentage BatchComputeEnvironment#bid_percentage}.


desiredVcpusOptional
public readonly desiredVcpus: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#desired_vcpus BatchComputeEnvironment#desired_vcpus}.


ec2ConfigurationOptional
public readonly ec2Configuration: BatchComputeEnvironmentComputeResourcesEc2Configuration;

ec2_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#ec2_configuration BatchComputeEnvironment#ec2_configuration}


ec2KeyPairOptional
public readonly ec2KeyPair: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#ec2_key_pair BatchComputeEnvironment#ec2_key_pair}.


imageIdOptional
public readonly imageId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#image_id BatchComputeEnvironment#image_id}.


instanceRoleOptional
public readonly instanceRole: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#instance_role BatchComputeEnvironment#instance_role}.


instanceTypeOptional
public readonly instanceType: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#instance_type BatchComputeEnvironment#instance_type}.


launchTemplateOptional
public readonly launchTemplate: BatchComputeEnvironmentComputeResourcesLaunchTemplate;

launch_template block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#launch_template BatchComputeEnvironment#launch_template}


minVcpusOptional
public readonly minVcpus: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#min_vcpus BatchComputeEnvironment#min_vcpus}.


spotIamFleetRoleOptional
public readonly spotIamFleetRole: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#spot_iam_fleet_role BatchComputeEnvironment#spot_iam_fleet_role}.


tagsOptional
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#tags BatchComputeEnvironment#tags}.


BatchComputeEnvironmentComputeResourcesEc2Configuration

Initializer

import { batchComputeEnvironment } from '@cdktf/aws-cdk'

const batchComputeEnvironmentComputeResourcesEc2Configuration: batchComputeEnvironment.BatchComputeEnvironmentComputeResourcesEc2Configuration = { ... }

Properties

Name Type Description
imageIdOverride string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#image_id_override BatchComputeEnvironment#image_id_override}.
imageType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#image_type BatchComputeEnvironment#image_type}.

imageIdOverrideOptional
public readonly imageIdOverride: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#image_id_override BatchComputeEnvironment#image_id_override}.


imageTypeOptional
public readonly imageType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#image_type BatchComputeEnvironment#image_type}.


BatchComputeEnvironmentComputeResourcesLaunchTemplate

Initializer

import { batchComputeEnvironment } from '@cdktf/aws-cdk'

const batchComputeEnvironmentComputeResourcesLaunchTemplate: batchComputeEnvironment.BatchComputeEnvironmentComputeResourcesLaunchTemplate = { ... }

Properties

Name Type Description
launchTemplateId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#launch_template_id BatchComputeEnvironment#launch_template_id}.
launchTemplateName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#launch_template_name BatchComputeEnvironment#launch_template_name}.
version string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#version BatchComputeEnvironment#version}.

launchTemplateIdOptional
public readonly launchTemplateId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#launch_template_id BatchComputeEnvironment#launch_template_id}.


launchTemplateNameOptional
public readonly launchTemplateName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#launch_template_name BatchComputeEnvironment#launch_template_name}.


versionOptional
public readonly version: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#version BatchComputeEnvironment#version}.


BatchComputeEnvironmentConfig

Initializer

import { batchComputeEnvironment } from '@cdktf/aws-cdk'

const batchComputeEnvironmentConfig: batchComputeEnvironment.BatchComputeEnvironmentConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
type string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#type BatchComputeEnvironment#type}.
computeEnvironmentName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#compute_environment_name BatchComputeEnvironment#compute_environment_name}.
computeEnvironmentNamePrefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#compute_environment_name_prefix BatchComputeEnvironment#compute_environment_name_prefix}.
computeResources BatchComputeEnvironmentComputeResources compute_resources block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#id BatchComputeEnvironment#id}.
serviceRole string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#service_role BatchComputeEnvironment#service_role}.
state string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#state BatchComputeEnvironment#state}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#tags BatchComputeEnvironment#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#tags_all BatchComputeEnvironment#tags_all}.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

typeRequired
public readonly type: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#type BatchComputeEnvironment#type}.


computeEnvironmentNameOptional
public readonly computeEnvironmentName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#compute_environment_name BatchComputeEnvironment#compute_environment_name}.


computeEnvironmentNamePrefixOptional
public readonly computeEnvironmentNamePrefix: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#compute_environment_name_prefix BatchComputeEnvironment#compute_environment_name_prefix}.


computeResourcesOptional
public readonly computeResources: BatchComputeEnvironmentComputeResources;

compute_resources block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#compute_resources BatchComputeEnvironment#compute_resources}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#id BatchComputeEnvironment#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


serviceRoleOptional
public readonly serviceRole: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#service_role BatchComputeEnvironment#service_role}.


stateOptional
public readonly state: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#state BatchComputeEnvironment#state}.


tagsOptional
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#tags BatchComputeEnvironment#tags}.


tagsAllOptional
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_compute_environment#tags_all BatchComputeEnvironment#tags_all}.


Classes

BatchComputeEnvironmentComputeResourcesEc2ConfigurationOutputReference

Initializers

import { batchComputeEnvironment } from '@cdktf/aws-cdk'

new batchComputeEnvironment.BatchComputeEnvironmentComputeResourcesEc2ConfigurationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetImageIdOverride No description.
resetImageType No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetImageIdOverride
public resetImageIdOverride(): void
resetImageType
public resetImageType(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
imageIdOverrideInput string No description.
imageTypeInput string No description.
imageIdOverride string No description.
imageType string No description.
internalValue BatchComputeEnvironmentComputeResourcesEc2Configuration No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

imageIdOverrideInputOptional
public readonly imageIdOverrideInput: string;
  • Type: string

imageTypeInputOptional
public readonly imageTypeInput: string;
  • Type: string

imageIdOverrideRequired
public readonly imageIdOverride: string;
  • Type: string

imageTypeRequired
public readonly imageType: string;
  • Type: string

internalValueOptional
public readonly internalValue: BatchComputeEnvironmentComputeResourcesEc2Configuration;

BatchComputeEnvironmentComputeResourcesLaunchTemplateOutputReference

Initializers

import { batchComputeEnvironment } from '@cdktf/aws-cdk'

new batchComputeEnvironment.BatchComputeEnvironmentComputeResourcesLaunchTemplateOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetLaunchTemplateId No description.
resetLaunchTemplateName No description.
resetVersion No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetLaunchTemplateId
public resetLaunchTemplateId(): void
resetLaunchTemplateName
public resetLaunchTemplateName(): void
resetVersion
public resetVersion(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
launchTemplateIdInput string No description.
launchTemplateNameInput string No description.
versionInput string No description.
launchTemplateId string No description.
launchTemplateName string No description.
version string No description.
internalValue BatchComputeEnvironmentComputeResourcesLaunchTemplate No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

launchTemplateIdInputOptional
public readonly launchTemplateIdInput: string;
  • Type: string

launchTemplateNameInputOptional
public readonly launchTemplateNameInput: string;
  • Type: string

versionInputOptional
public readonly versionInput: string;
  • Type: string

launchTemplateIdRequired
public readonly launchTemplateId: string;
  • Type: string

launchTemplateNameRequired
public readonly launchTemplateName: string;
  • Type: string

versionRequired
public readonly version: string;
  • Type: string

internalValueOptional
public readonly internalValue: BatchComputeEnvironmentComputeResourcesLaunchTemplate;

BatchComputeEnvironmentComputeResourcesOutputReference

Initializers

import { batchComputeEnvironment } from '@cdktf/aws-cdk'

new batchComputeEnvironment.BatchComputeEnvironmentComputeResourcesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
putEc2Configuration No description.
putLaunchTemplate No description.
resetAllocationStrategy No description.
resetBidPercentage No description.
resetDesiredVcpus No description.
resetEc2Configuration No description.
resetEc2KeyPair No description.
resetImageId No description.
resetInstanceRole No description.
resetInstanceType No description.
resetLaunchTemplate No description.
resetMinVcpus No description.
resetSpotIamFleetRole No description.
resetTags No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putEc2Configuration
public putEc2Configuration(value: BatchComputeEnvironmentComputeResourcesEc2Configuration): void
valueRequired

putLaunchTemplate
public putLaunchTemplate(value: BatchComputeEnvironmentComputeResourcesLaunchTemplate): void
valueRequired

resetAllocationStrategy
public resetAllocationStrategy(): void
resetBidPercentage
public resetBidPercentage(): void
resetDesiredVcpus
public resetDesiredVcpus(): void
resetEc2Configuration
public resetEc2Configuration(): void
resetEc2KeyPair
public resetEc2KeyPair(): void
resetImageId
public resetImageId(): void
resetInstanceRole
public resetInstanceRole(): void
resetInstanceType
public resetInstanceType(): void
resetLaunchTemplate
public resetLaunchTemplate(): void
resetMinVcpus
public resetMinVcpus(): void
resetSpotIamFleetRole
public resetSpotIamFleetRole(): void
resetTags
public resetTags(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
ec2Configuration BatchComputeEnvironmentComputeResourcesEc2ConfigurationOutputReference No description.
launchTemplate BatchComputeEnvironmentComputeResourcesLaunchTemplateOutputReference No description.
allocationStrategyInput string No description.
bidPercentageInput number No description.
desiredVcpusInput number No description.
ec2ConfigurationInput BatchComputeEnvironmentComputeResourcesEc2Configuration No description.
ec2KeyPairInput string No description.
imageIdInput string No description.
instanceRoleInput string No description.
instanceTypeInput string[] No description.
launchTemplateInput BatchComputeEnvironmentComputeResourcesLaunchTemplate No description.
maxVcpusInput number No description.
minVcpusInput number No description.
securityGroupIdsInput string[] No description.
spotIamFleetRoleInput string No description.
subnetsInput string[] No description.
tagsInput {[ key: string ]: string} No description.
typeInput string No description.
allocationStrategy string No description.
bidPercentage number No description.
desiredVcpus number No description.
ec2KeyPair string No description.
imageId string No description.
instanceRole string No description.
instanceType string[] No description.
maxVcpus number No description.
minVcpus number No description.
securityGroupIds string[] No description.
spotIamFleetRole string No description.
subnets string[] No description.
tags {[ key: string ]: string} No description.
type string No description.
internalValue BatchComputeEnvironmentComputeResources No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

ec2ConfigurationRequired
public readonly ec2Configuration: BatchComputeEnvironmentComputeResourcesEc2ConfigurationOutputReference;

launchTemplateRequired
public readonly launchTemplate: BatchComputeEnvironmentComputeResourcesLaunchTemplateOutputReference;

allocationStrategyInputOptional
public readonly allocationStrategyInput: string;
  • Type: string

bidPercentageInputOptional
public readonly bidPercentageInput: number;
  • Type: number

desiredVcpusInputOptional
public readonly desiredVcpusInput: number;
  • Type: number

ec2ConfigurationInputOptional
public readonly ec2ConfigurationInput: BatchComputeEnvironmentComputeResourcesEc2Configuration;

ec2KeyPairInputOptional
public readonly ec2KeyPairInput: string;
  • Type: string

imageIdInputOptional
public readonly imageIdInput: string;
  • Type: string

instanceRoleInputOptional
public readonly instanceRoleInput: string;
  • Type: string

instanceTypeInputOptional
public readonly instanceTypeInput: string[];
  • Type: string[]

launchTemplateInputOptional
public readonly launchTemplateInput: BatchComputeEnvironmentComputeResourcesLaunchTemplate;

maxVcpusInputOptional
public readonly maxVcpusInput: number;
  • Type: number

minVcpusInputOptional
public readonly minVcpusInput: number;
  • Type: number

securityGroupIdsInputOptional
public readonly securityGroupIdsInput: string[];
  • Type: string[]

spotIamFleetRoleInputOptional
public readonly spotIamFleetRoleInput: string;
  • Type: string

subnetsInputOptional
public readonly subnetsInput: string[];
  • Type: string[]

tagsInputOptional
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

typeInputOptional
public readonly typeInput: string;
  • Type: string

allocationStrategyRequired
public readonly allocationStrategy: string;
  • Type: string

bidPercentageRequired
public readonly bidPercentage: number;
  • Type: number

desiredVcpusRequired
public readonly desiredVcpus: number;
  • Type: number

ec2KeyPairRequired
public readonly ec2KeyPair: string;
  • Type: string

imageIdRequired
public readonly imageId: string;
  • Type: string

instanceRoleRequired
public readonly instanceRole: string;
  • Type: string

instanceTypeRequired
public readonly instanceType: string[];
  • Type: string[]

maxVcpusRequired
public readonly maxVcpus: number;
  • Type: number

minVcpusRequired
public readonly minVcpus: number;
  • Type: number

securityGroupIdsRequired
public readonly securityGroupIds: string[];
  • Type: string[]

spotIamFleetRoleRequired
public readonly spotIamFleetRole: string;
  • Type: string

subnetsRequired
public readonly subnets: string[];
  • Type: string[]

tagsRequired
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

typeRequired
public readonly type: string;
  • Type: string

internalValueOptional
public readonly internalValue: BatchComputeEnvironmentComputeResources;