Batch

7 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

BatchComputeEnvironment # GA

BatchComputeEnvironment is the Schema for managing AWS Batch compute environments.

kubectl get batchcomputeenvironments · example on GitHub

Example

# BatchComputeEnvironment — Batch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/batch.html#batchcomputeenvironment
apiVersion: aws.konfig.io/v1alpha1
kind: BatchComputeEnvironment
metadata:
  name: example-batchcomputeenvironment
  namespace: default
spec:
  computeResources:
    desiredvCpus: 1
    instanceRoleArn: arn:aws:iam::123456789012:role/example-role
    instanceTypes:
    - example
    maxvCpus: 1
    minvCpus: 1
    securityGroupRefs:
    - name: example-securitygrouprefs
    subnetRefs:
    - name: example-subnetrefs
    type: FARGATE
  name: example-batchcomputeenvironment
  providerRef:
    name: example-batchcomputeenvironment
    region: us-east-1
  state: ENABLED
  tags:
    environment: dev
    team: platform
  type: MANAGED

Spec

Field	Type	Required	Description
`computeResources`	object	—	ComputeResources configures the managed compute resources.
`computeResources.desiredvCpus`	integer	—	DesiredvCpus is the desired number of vCPUs (EC2/SPOT only).
`computeResources.instanceRoleArn`	string	—	InstanceRoleArn is the ECS instance profile applied to EC2 instances (EC2/SPOT only).
`computeResources.instanceTypes`	array<string>	—	InstanceTypes are EC2 instance types that can be launched (EC2/SPOT only).
`computeResources.maxvCpus`	integer	yes	MaxvCpus is the maximum number of vCPUs.
`computeResources.minvCpus`	integer	—	MinvCpus is the minimum number of vCPUs (EC2/SPOT only).
`computeResources.securityGroupRefs`	array<object>	—	SecurityGroupRefs are the security groups for the compute resources.
`computeResources.securityGroupRefs[].id`	string	—	ID is a direct AWS Security Group ID (e.g.
`computeResources.securityGroupRefs[].name`	string	—	Name of a SecurityGroup CR in the same namespace.
`computeResources.subnetRefs`	array<object>	—	SubnetRefs are the VPC subnets where compute resources are launched.
`computeResources.subnetRefs[].id`	string	—	ID is a direct AWS Subnet ID (e.g.
`computeResources.subnetRefs[].name`	string	—	Name of a Subnet CR in the same namespace.
`computeResources.type`	enum	yes	Type of compute resource. Allowed: `FARGATE, FARGATE_SPOT, EC2, SPOT`
`name`	string	yes	Name of the compute environment.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`state`	enum	—	State of the compute environment. Allowed: `ENABLED, DISABLED`
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`type`	enum	yes	Type of the compute environment. Allowed: `MANAGED, UNMANAGED`

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`computeEnvironmentArn`	string	—	ComputeEnvironmentARN is the ARN of the compute environment.
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`status`	string	—	Status is the current compute environment status (e.g.

BatchConsumableResource # CLOUD CONTROL · AWS::Batch::ConsumableResource

BatchConsumableResource manages AWS::Batch::ConsumableResource through the AWS Cloud Control API.

kubectl get batchconsumableresources · example on GitHub

Example

# BatchConsumableResource — Batch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/batch.html#batchconsumableresource
apiVersion: aws.konfig.io/v1alpha1
kind: BatchConsumableResource
metadata:
  name: example-batchconsumableresource
  namespace: default
spec:
  consumableResourceName: example-batchconsumableresource
  providerRef:
    name: example-batchconsumableresource
    region: us-east-1
  resourceType: REPLENISHABLE
  tags:
    environment: dev
    team: platform
  totalQuantity: 1

Spec

Field	Type	Required	Description
`consumableResourceName`	string	—	Name of ConsumableResource.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`resourceType`	enum	yes	Create-only in AWS: changing it requires replacing the resource. Allowed: `REPLENISHABLE, NON_REPLENISHABLE`
`tags`	map<string>	—	A key-value pair to associate with a resource.
`totalQuantity`	integer	yes	Total Quantity of ConsumableResource.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`availableQuantity`	integer	—	Available Quantity of ConsumableResource.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`consumableResourceArn`	string	—	Read-only: reported by AWS after creation.
`createdAt`	integer	—	Read-only: reported by AWS after creation.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`inUseQuantity`	integer	—	In-use Quantity of ConsumableResource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

BatchJobDefinition # GA

BatchJobDefinition is the Schema for managing AWS Batch job definitions.

kubectl get batchjobdefinitions · example on GitHub

Example

# BatchJobDefinition — Batch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/batch.html#batchjobdefinition
apiVersion: aws.konfig.io/v1alpha1
kind: BatchJobDefinition
metadata:
  name: example-batchjobdefinition
  namespace: default
spec:
  containerProperties:
    command:
    - example
    environment:
      key: value
    executionRoleArn: arn:aws:iam::123456789012:role/example-role
    executionRoleRef:
      name: example-executionrole
    image: example
    jobRoleArn: arn:aws:iam::123456789012:role/example-role
    jobRoleRef:
      name: example-jobrole
    resourceRequirements:
    - type: VCPU
      value: example
  name: example-batchjobdefinition
  platformCapabilities:
  - example
  providerRef:
    name: example-batchjobdefinition
    region: us-east-1
  retryStrategy:
    attempts: 1
  tags:
    environment: dev
    team: platform
  timeout:
    attemptDurationSeconds: 60
  type: container

Spec

Field	Type	Required	Description
`containerProperties`	object	yes	ContainerProperties describe the container run by the job.
`containerProperties.command`	array<string>	—	Command passed to the container.
`containerProperties.environment`	map<string>	—	Environment variables for the container.
`containerProperties.executionRoleArn`	string	—	ExecutionRoleArn is a direct IAM role ARN for the execution role (required for Fargate).
`containerProperties.executionRoleRef`	object	—	ExecutionRoleRef references an IAMRole CR for the execution role.
`containerProperties.executionRoleRef.arn`	string	—	ARN is a direct AWS IAM role ARN.
`containerProperties.executionRoleRef.name`	string	—	Name of an IAMRole CR in the same namespace.
`containerProperties.executionRoleRef.namespace`	string	—	Namespace of the IAMRole CR.
`containerProperties.image`	string	yes	Image used to start the container.
`containerProperties.jobRoleArn`	string	—	JobRoleArn is a direct IAM role ARN the job assumes.
`containerProperties.jobRoleRef`	object	—	JobRoleRef references an IAMRole CR for the job role.
`containerProperties.jobRoleRef.arn`	string	—	ARN is a direct AWS IAM role ARN.
`containerProperties.jobRoleRef.name`	string	—	Name of an IAMRole CR in the same namespace.
`containerProperties.jobRoleRef.namespace`	string	—	Namespace of the IAMRole CR.
`containerProperties.resourceRequirements`	array<object>	—	ResourceRequirements declare VCPU/MEMORY/GPU requirements.
`containerProperties.resourceRequirements[].type`	enum	yes	Type of resource. Allowed: `VCPU, MEMORY, GPU`
`containerProperties.resourceRequirements[].value`	string	yes	Value is the quantity of the resource (e.g.
`name`	string	yes	Name of the job definition.
`platformCapabilities`	array<string>	—	PlatformCapabilities required by the job (EC2 or FARGATE).
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`retryStrategy`	object	—	RetryStrategy configures retries for failed jobs.
`retryStrategy.attempts`	integer	yes	Attempts is the number of times to move a job to RUNNABLE status (1-10).
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`timeout`	object	—	Timeout configures the job timeout.
`timeout.attemptDurationSeconds`	integer	yes	AttemptDurationSeconds after which Batch terminates unfinished jobs.
`type`	enum	yes	Type of job definition. Allowed: `container`

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`jobDefinitionArn`	string	—	JobDefinitionARN is the ARN of the active job definition revision.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`revision`	integer	—	Revision is the current job definition revision.
`specHash`	string	—	SpecHash tracks the spec that produced the current revision.

BatchJobQueue # GA

BatchJobQueue is the Schema for managing AWS Batch job queues.

kubectl get batchjobqueues · example on GitHub

Example

# BatchJobQueue — Batch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/batch.html#batchjobqueue
apiVersion: aws.konfig.io/v1alpha1
kind: BatchJobQueue
metadata:
  name: example-batchjobqueue
  namespace: default
spec:
  computeEnvironmentOrder:
  - computeEnvironmentRef:
      name: example-computeenvironment
    order: 1
  name: example-batchjobqueue
  priority: 1
  providerRef:
    name: example-batchjobqueue
    region: us-east-1
  state: ENABLED
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`computeEnvironmentOrder`	array<object>	yes	ComputeEnvironmentOrder maps compute environments to this queue.
`computeEnvironmentOrder[].computeEnvironmentRef`	object	yes	ComputeEnvironmentRef references the compute environment.
`computeEnvironmentOrder[].computeEnvironmentRef.arn`	string	—	ARN is a direct AWS compute environment ARN.
`computeEnvironmentOrder[].computeEnvironmentRef.name`	string	—	Name of a BatchComputeEnvironment CR in the same namespace.
`computeEnvironmentOrder[].order`	integer	yes	Order in which compute environments are tried (ascending).
`name`	string	yes	Name of the job queue.
`priority`	integer	yes	Priority of the job queue.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`state`	enum	—	State of the job queue. Allowed: `ENABLED, DISABLED`
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`jobQueueArn`	string	—	JobQueueARN is the ARN of the job queue.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`status`	string	—	Status is the current job queue status (e.g.

BatchQuotaShare # CLOUD CONTROL · AWS::Batch::QuotaShare

BatchQuotaShare manages AWS::Batch::QuotaShare through the AWS Cloud Control API.

kubectl get batchquotashares · example on GitHub

Example

# BatchQuotaShare — Batch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/batch.html#batchquotashare
apiVersion: aws.konfig.io/v1alpha1
kind: BatchQuotaShare
metadata:
  name: example-batchquotashare
  namespace: default
spec:
  capacityLimits:
  - capacityUnit: example
    maxCapacity: 1
  jobQueue: example
  preemptionConfiguration:
    inSharePreemption: ENABLED
  providerRef:
    name: example-batchquotashare
    region: us-east-1
  quotaShareName: example-batchquotashare
  resourceSharingConfiguration:
    borrowLimit: 1
    strategy: RESERVE
  state: ENABLED
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`capacityLimits`	array<object>	yes	A list that specifies the quantity and type of compute capacity allocated to the quota share.
`capacityLimits[].capacityUnit`	string	yes	The unit of compute capacity for the capacityLimit.
`capacityLimits[].maxCapacity`	integer	yes	The maximum capacity available for the quota share.
`jobQueue`	string	yes	The AWS Batch job queue associated with the quota share.
`preemptionConfiguration`	object	yes	Specifies the preemption behavior for jobs in a quota share.
`preemptionConfiguration.inSharePreemption`	enum	yes	Specifies whether jobs within a quota share can be preempted by another, higher priority job in the same quota share. Allowed: `ENABLED, DISABLED`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`quotaShareName`	string	yes	The name of the quota share.
`resourceSharingConfiguration`	object	yes	Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
`resourceSharingConfiguration.borrowLimit`	integer	—	The maximum percentage of additional capacity that the quota share can borrow from other shares.
`resourceSharingConfiguration.strategy`	enum	yes	The resource sharing strategy for the quota share. Allowed: `RESERVE, LEND, LEND_AND_BORROW`
`state`	enum	—	The state of the quota share. Allowed: `ENABLED, DISABLED`
`tags`	map<string>	—	The tags that you apply to the quota share to help you categorize and organize your resources.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`quotaShareArn`	string	—	The Amazon Resource Name (ARN) of the quota share.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

BatchSchedulingPolicy # CLOUD CONTROL · AWS::Batch::SchedulingPolicy

BatchSchedulingPolicy manages AWS::Batch::SchedulingPolicy through the AWS Cloud Control API.

kubectl get batchschedulingpolicies · example on GitHub

Example

# BatchSchedulingPolicy — Batch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/batch.html#batchschedulingpolicy
apiVersion: aws.konfig.io/v1alpha1
kind: BatchSchedulingPolicy
metadata:
  name: example-batchschedulingpolicy
  namespace: default
spec:
  fairsharePolicy:
    computeReservation: 1
    shareDecaySeconds: 300
    shareDistribution:
    - shareIdentifier: example
      weightFactor: 1
  name: example-batchschedulingpolicy
  providerRef:
    name: example-batchschedulingpolicy
    region: us-east-1
  quotaSharePolicy:
    idleResourceAssignmentStrategy: FIFO
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`fairsharePolicy`	object	—	BatchSchedulingPolicyFairsharePolicy is a nested property type of AWS::Batch::SchedulingPolicy.
`fairsharePolicy.computeReservation`	number	—
`fairsharePolicy.shareDecaySeconds`	number	—
`fairsharePolicy.shareDistribution`	array<object>	—	List of Share Attributes
`fairsharePolicy.shareDistribution[].shareIdentifier`	string	—
`fairsharePolicy.shareDistribution[].weightFactor`	number	—
`name`	string	—	Name of Scheduling Policy.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`quotaSharePolicy`	object	—	BatchSchedulingPolicyQuotaSharePolicy is a nested property type of AWS::Batch::SchedulingPolicy.
`quotaSharePolicy.idleResourceAssignmentStrategy`	enum	—	Allowed: `FIFO`
`tags`	map<string>	—	A key-value pair to associate with a resource.

Status

Field	Type	Required	Description
`arn`	string	—	Read-only: reported by AWS after creation.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

BatchServiceEnvironment # CLOUD CONTROL · AWS::Batch::ServiceEnvironment

BatchServiceEnvironment manages AWS::Batch::ServiceEnvironment through the AWS Cloud Control API.

kubectl get batchserviceenvironments · example on GitHub

Example

# BatchServiceEnvironment — Batch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/batch.html#batchserviceenvironment
apiVersion: aws.konfig.io/v1alpha1
kind: BatchServiceEnvironment
metadata:
  name: example-batchserviceenvironment
  namespace: default
spec:
  capacityLimits:
  - capacityUnit: example
    maxCapacity: 2
  providerRef:
    name: example-batchserviceenvironment
    region: us-east-1
  serviceEnvironmentName: example-batchserviceenvironment
  serviceEnvironmentType: example
  state: example
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`capacityLimits`	array<object>	yes
`capacityLimits[].capacityUnit`	string	—
`capacityLimits[].maxCapacity`	integer	—
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`serviceEnvironmentName`	string	—	Create-only in AWS: changing it requires replacing the resource.
`serviceEnvironmentType`	string	yes	Create-only in AWS: changing it requires replacing the resource.
`state`	string	—
`tags`	map<string>	—	A key-value pair to associate with a resource.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`serviceEnvironmentArn`	string	—	Read-only: reported by AWS after creation.