ECS
10 resource kinds. Generated from the operator's CRD schemas.
aws.konfig.io/v1alpha1
ECSCapacityProvider # GA
ECSCapacityProvider is the Schema for managing ECS capacity providers.
kubectl get ecscapacityproviders · example on GitHub
Example
# ECSCapacityProvider — ECS
# 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/ecs.html#ecscapacityprovider
apiVersion: aws.konfig.io/v1alpha1
kind: ECSCapacityProvider
metadata:
name: example-ecscapacityprovider
namespace: default
spec:
autoScalingGroupProvider:
autoScalingGroupArn: arn:aws:iam::123456789012:role/example-role
managedScaling:
instanceWarmupPeriod: 1
maximumScalingStepSize: 2
minimumScalingStepSize: 2
status: ENABLED
targetCapacity: 1
managedTerminationProtection: ENABLED
name: example-ecscapacityprovider
providerRef:
name: example-ecscapacityprovider
region: us-east-1
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
autoScalingGroupProvider | object | yes | AutoScalingGroupProvider is the Auto Scaling group provider configuration. |
autoScalingGroupProvider.autoScalingGroupArn | string | yes | AutoScalingGroupARN is the ARN of the Auto Scaling group. |
autoScalingGroupProvider.managedScaling | object | — | ManagedScaling defines the managed scaling configuration. |
autoScalingGroupProvider.managedScaling.instanceWarmupPeriod | integer | — | InstanceWarmupPeriod is the period of time (in seconds) during which scale-in protection is applied. |
autoScalingGroupProvider.managedScaling.maximumScalingStepSize | integer | — | MaximumScalingStepSize is the maximum number of instances by which to scale. |
autoScalingGroupProvider.managedScaling.minimumScalingStepSize | integer | — | MinimumScalingStepSize is the minimum number of instances by which to scale. |
autoScalingGroupProvider.managedScaling.status | enum | — | Status enables or disables managed scaling. Allowed: ENABLED, DISABLED |
autoScalingGroupProvider.managedScaling.targetCapacity | integer | — | TargetCapacity is the target capacity utilization as a percentage (1-100). |
autoScalingGroupProvider.managedTerminationProtection | enum | — | ManagedTerminationProtection controls whether to enable managed termination protection. Allowed: ENABLED, DISABLED |
name | string | yes | Name is the name of the capacity provider. |
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. |
tags | map<string> | — | Tags are metadata tags for the capacity provider. |
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). |
capacityProviderArn | string | — | CapacityProviderARN is the ARN of the capacity provider. |
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. |
providerStatus | string | — | ProviderStatus is the current status of the capacity provider. |
ECSCluster # GA
ECSCluster is the Schema for managing ECS Clusters.
kubectl get ecsclusters · example on GitHub
Example
# ECSCluster — ECS
# 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/ecs.html#ecscluster
apiVersion: aws.konfig.io/v1alpha1
kind: ECSCluster
metadata:
name: example-ecscluster
namespace: default
spec:
capacityProviders:
- example
clusterName: example-ecscluster
containerInsights: false
providerRef:
name: example-ecscluster
region: us-east-1
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
capacityProviders | array<string> | — | CapacityProviders is the list of capacity providers to associate with the cluster. |
clusterName | string | yes | ClusterName is the name of the ECS cluster. |
containerInsights | boolean | — | ContainerInsights enables CloudWatch Container Insights for the cluster. |
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. |
tags | map<string> | — | Tags are AWS resource tags. |
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). |
clusterArn | string | — | ClusterARN is the ARN of the ECS cluster. |
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 cluster status: ACTIVE, PROVISIONING, DEPROVISIONING, FAILED, INACTIVE. |
ECSClusterCapacityProviderAssociations # CLOUD CONTROL · AWS::ECS::ClusterCapacityProviderAssociations
ECSClusterCapacityProviderAssociations manages AWS::ECS::ClusterCapacityProviderAssociations through the AWS Cloud Control API.
kubectl get ecsclustercapacityproviderassociations · example on GitHub
Example
# ECSClusterCapacityProviderAssociations — ECS
# 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/ecs.html#ecsclustercapacityproviderassociations
apiVersion: aws.konfig.io/v1alpha1
kind: ECSClusterCapacityProviderAssociations
metadata:
name: example-ecsclustercapacityproviderassociations
namespace: default
spec:
cluster: example
defaultCapacityProviderStrategy:
- base: 1
weight: 1
providerRef:
name: example-ecsclustercapacityproviderassociations
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
capacityProviders | array<object> | — | |
cluster | string | yes | Create-only in AWS: changing it requires replacing the resource. |
defaultCapacityProviderStrategy | array<object> | yes | |
defaultCapacityProviderStrategy[].base | integer | — | |
defaultCapacityProviderStrategy[].capacityProvider | object | yes | |
defaultCapacityProviderStrategy[].weight | 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. |
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. |
ECSDaemon # CLOUD CONTROL · AWS::ECS::Daemon
ECSDaemon manages AWS::ECS::Daemon through the AWS Cloud Control API.
kubectl get ecsdaemons · example on GitHub
Example
# ECSDaemon — ECS
# 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/ecs.html#ecsdaemon
apiVersion: aws.konfig.io/v1alpha1
kind: ECSDaemon
metadata:
name: example-ecsdaemon
namespace: default
spec:
capacityProviderArns:
- example
clusterArn: arn:aws:iam::123456789012:role/example-role
daemonName: example-ecsdaemon
daemonTaskDefinitionArn: arn:aws:iam::123456789012:role/example-role
deploymentConfiguration:
alarms:
alarmNames:
- example
enable: true
bakeTimeInMinutes: 1
drainPercent: 1
enableECSManagedTags: true
enableExecuteCommand: true
propagateTags: DAEMON
providerRef:
name: example-ecsdaemon
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
capacityProviderArns | array<string> | — | The Amazon Resource Names (ARNs) of the capacity providers associated with the daemon. |
clusterArn | string | — | The Amazon Resource Name (ARN) of the cluster that the daemon is running in. |
daemonName | string | — | Create-only in AWS: changing it requires replacing the resource. |
daemonTaskDefinitionArn | string | — | The Amazon Resource Name (ARN) of the daemon task definition used by this revision. |
deploymentConfiguration | object | — | The deployment configuration used for this daemon deployment. |
deploymentConfiguration.alarms | object | — | The CloudWatch alarm configuration for the daemon deployment. |
deploymentConfiguration.alarms.alarmNames | array<string> | — | The CloudWatch alarm names to monitor during a daemon deployment. |
deploymentConfiguration.alarms.enable | boolean | — | Determines whether to use the CloudWatch alarm option in the daemon deployment process. |
deploymentConfiguration.bakeTimeInMinutes | integer | — | The amount of time (in minutes) to wait after a successful deployment step before proceeding. |
deploymentConfiguration.drainPercent | number | — | The percentage of container instances to drain simultaneously during a daemon deployment. |
enableECSManagedTags | boolean | — | Specifies whether Amazon ECS managed tags are turned on for the daemon tasks. |
enableExecuteCommand | boolean | — | Specifies whether the execute command functionality is turned on for the daemon tasks. |
propagateTags | enum | — | Specifies whether tags are propagated from the daemon to the daemon tasks. Allowed: DAEMON, NONE |
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. |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes |
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. |
createdAt | string | — | Read-only: reported by AWS after creation. |
daemonArn | string | — | Read-only: reported by AWS after creation. |
daemonStatus | enum | — | Read-only: reported by AWS after creation. Allowed: ACTIVE, DELETE_IN_PROGRESS |
deploymentArn | string | — | Read-only: reported by AWS after creation. |
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. |
updatedAt | string | — | Read-only: reported by AWS after creation. |
ECSDaemonTaskDefinition # CLOUD CONTROL · AWS::ECS::DaemonTaskDefinition
ECSDaemonTaskDefinition manages AWS::ECS::DaemonTaskDefinition through the AWS Cloud Control API.
kubectl get ecsdaemontaskdefinitions · example on GitHub
Example
# ECSDaemonTaskDefinition — ECS
# 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/ecs.html#ecsdaemontaskdefinition
apiVersion: aws.konfig.io/v1alpha1
kind: ECSDaemonTaskDefinition
metadata:
name: example-ecsdaemontaskdefinition
namespace: default
spec:
containerDefinitions:
- command:
- example
cpu: 1
dependsOn:
- condition: example
containerName: example-ecsdaemontaskdefinition
entryPoint:
- example
environment:
- name: example-ecsdaemontaskdefinition
value: example
environmentFiles:
- type: example
value: example
essential: false
firelensConfiguration:
type: example
healthCheck:
command:
- example
interval: 1
retries: 1
startPeriod: 1
timeout: 300
image: example
interactive: false
linuxParameters:
devices:
- containerPath: example
hostPath: example
permissions:
- example
initProcessEnabled: true
tmpfs:
- containerPath: example
mountOptions:
- example
size: 2
logConfiguration:
logDriver: example
secretOptions:
- name: example-ecsdaemontaskdefinition
valueFrom: example
memory: 1
memoryReservation: 1
mountPoints:
- containerPath: example
readOnly: false
sourceVolume: example
name: example-ecsdaemontaskdefinition
privileged: false
pseudoTerminal: false
readonlyRootFilesystem: false
repositoryCredentials:
credentialsParameter: example
restartPolicy:
enabled: true
ignoredExitCodes:
- 1
restartAttemptPeriod: 1
secrets:
- name: example-ecsdaemontaskdefinition
valueFrom: example
startTimeout: 300
stopTimeout: 300
systemControls:
- namespace: example
value: example
ulimits:
- hardLimit: 1
name: example-ecsdaemontaskdefinition
softLimit: 1
user: example
workingDirectory: example
cpu: example
executionRoleArn: arn:aws:iam::123456789012:role/example-role
family: example
ipcMode: example
memory: example
pidMode: example
providerRef:
name: example-ecsdaemontaskdefinition
region: us-east-1
tags:
- key: example
value: example
taskRoleArn: arn:aws:iam::123456789012:role/example-role
volumes:
- host:
sourcePath: example
name: example-ecsdaemontaskdefinition
Spec
| Field | Type | Required | Description |
|---|---|---|---|
containerDefinitions | array<object> | — | A list of container definitions in JSON format that describe the containers that make up the daemon task. |
containerDefinitions[].command | array<string> | — | The command that's passed to the container. |
containerDefinitions[].cpu | integer | — | The number of ``cpu`` units reserved for the container. |
containerDefinitions[].dependsOn | array<object> | — | The dependencies defined for container startup and shutdown. |
containerDefinitions[].dependsOn[].condition | string | — | The dependency condition of the container. |
containerDefinitions[].dependsOn[].containerName | string | — | The name of a container. |
containerDefinitions[].entryPoint | array<string> | — | The entry point that's passed to the container. |
containerDefinitions[].environment | array<object> | — | The environment variables to pass to a container. |
containerDefinitions[].environment[].name | string | — | The name of the key-value pair. |
containerDefinitions[].environment[].value | string | — | The value of the key-value pair. |
containerDefinitions[].environmentFiles | array<object> | — | A list of files containing the environment variables to pass to a container. |
containerDefinitions[].environmentFiles[].type | string | — | The file type to use. |
containerDefinitions[].environmentFiles[].value | string | — | The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file. |
containerDefinitions[].essential | boolean | — | If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. |
containerDefinitions[].firelensConfiguration | object | — | The FireLens configuration for the container. |
containerDefinitions[].firelensConfiguration.options | map<string> | — | The options to use when configuring the log router. |
containerDefinitions[].firelensConfiguration.type | string | — | The log router to use. |
containerDefinitions[].healthCheck | object | — | The container health check command and associated configuration parameters for the container. |
containerDefinitions[].healthCheck.command | array<string> | — | A string array representing the command that the container runs to determine if it is healthy. |
containerDefinitions[].healthCheck.interval | integer | — | The time period in seconds between each health check execution. |
containerDefinitions[].healthCheck.retries | integer | — | The number of times to retry a failed health check before the container is considered unhealthy. |
containerDefinitions[].healthCheck.startPeriod | integer | — | The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. |
containerDefinitions[].healthCheck.timeout | integer | — | The time period in seconds to wait for a health check to succeed before it is considered a failure. |
containerDefinitions[].image | string | yes | The image used to start the container. |
containerDefinitions[].interactive | boolean | — | When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. |
containerDefinitions[].linuxParameters | object | — | Linux-specific modifications that are applied to the container configuration, such as Linux kernel capabilities. |
containerDefinitions[].linuxParameters.capabilities | object | — | The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. |
containerDefinitions[].linuxParameters.capabilities.add | array<string> | — | The Linux capabilities for the container that have been added to the default configuration provided by Docker. |
containerDefinitions[].linuxParameters.capabilities.drop | array<string> | — | The Linux capabilities for the container that have been removed from the default configuration provided by Docker. |
containerDefinitions[].linuxParameters.devices | array<object> | — | Any host devices to expose to the container. |
containerDefinitions[].linuxParameters.devices[].containerPath | string | — | The path inside the container at which to expose the host device. |
containerDefinitions[].linuxParameters.devices[].hostPath | string | — | The path for the device on the host container instance. |
containerDefinitions[].linuxParameters.devices[].permissions | array<string> | — | The explicit permissions to provide to the container for the device. |
containerDefinitions[].linuxParameters.initProcessEnabled | boolean | — | Run an ``init`` process inside the container that forwards signals and reaps processes. |
containerDefinitions[].linuxParameters.tmpfs | array<object> | — | The container path, mount options, and size (in MiB) of the tmpfs mount. |
containerDefinitions[].linuxParameters.tmpfs[].containerPath | string | — | The absolute file path where the tmpfs volume is to be mounted. |
containerDefinitions[].linuxParameters.tmpfs[].mountOptions | array<string> | — | The list of tmpfs volume mount options. |
containerDefinitions[].linuxParameters.tmpfs[].size | integer | yes | The maximum size (in MiB) of the tmpfs volume. |
containerDefinitions[].logConfiguration | object | — | The log configuration specification for the container. |
containerDefinitions[].logConfiguration.logDriver | string | yes | The log driver to use for the container. |
containerDefinitions[].logConfiguration.options | map<string> | — | The configuration options to send to the log driver. |
containerDefinitions[].logConfiguration.secretOptions | array<object> | — | The secrets to pass to the log configuration. |
containerDefinitions[].logConfiguration.secretOptions[].name | string | yes | The name of the secret. |
containerDefinitions[].logConfiguration.secretOptions[].valueFrom | string | yes | The secret to expose to the container. |
containerDefinitions[].memory | integer | — | The amount (in MiB) of memory to present to the container. |
containerDefinitions[].memoryReservation | integer | — | The soft limit (in MiB) of memory to reserve for the container. |
containerDefinitions[].mountPoints | array<object> | — | The mount points for data volumes in your container. |
containerDefinitions[].mountPoints[].containerPath | string | — | The path on the container to mount the host volume at. |
containerDefinitions[].mountPoints[].readOnly | boolean | — | If this value is ``true``, the container has read-only access to the volume. |
containerDefinitions[].mountPoints[].sourceVolume | string | — | The name of the volume to mount. |
containerDefinitions[].name | string | yes | The name of the container. |
containerDefinitions[].privileged | boolean | — | When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). |
containerDefinitions[].pseudoTerminal | boolean | — | When this parameter is ``true``, a TTY is allocated. |
containerDefinitions[].readonlyRootFilesystem | boolean | — | When this parameter is true, the container is given read-only access to its root file system. |
containerDefinitions[].repositoryCredentials | object | — | The private repository authentication credentials to use. |
containerDefinitions[].repositoryCredentials.credentialsParameter | string | — | The Amazon Resource Name (ARN) of the secret containing the private repository credentials. |
containerDefinitions[].restartPolicy | object | — | The restart policy for the container. |
containerDefinitions[].restartPolicy.enabled | boolean | — | |
containerDefinitions[].restartPolicy.ignoredExitCodes | array<integer> | — | |
containerDefinitions[].restartPolicy.restartAttemptPeriod | integer | — | |
containerDefinitions[].secrets | array<object> | — | The secrets to pass to the container. |
containerDefinitions[].secrets[].name | string | yes | The name of the secret. |
containerDefinitions[].secrets[].valueFrom | string | yes | The secret to expose to the container. |
containerDefinitions[].startTimeout | integer | — | Time duration (in seconds) to wait before giving up on resolving dependencies for a container. |
containerDefinitions[].stopTimeout | integer | — | Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. |
containerDefinitions[].systemControls | array<object> | — | A list of namespaced kernel parameters to set in the container. |
containerDefinitions[].systemControls[].namespace | string | — | The namespaced kernel parameter to set a ``value`` for. |
containerDefinitions[].systemControls[].value | string | — | The namespaced kernel parameter to set a ``value`` for. |
containerDefinitions[].ulimits | array<object> | — | A list of ``ulimits`` to set in the container. |
containerDefinitions[].ulimits[].hardLimit | integer | yes | The hard limit for the ``ulimit`` type. |
containerDefinitions[].ulimits[].name | string | yes | The ``type`` of the ``ulimit``. |
containerDefinitions[].ulimits[].softLimit | integer | yes | The soft limit for the ``ulimit`` type. |
containerDefinitions[].user | string | — | The user to use inside the container. |
containerDefinitions[].workingDirectory | string | — | The working directory to run commands inside the container in. |
cpu | string | — | The number of CPU units used by the daemon task. |
executionRoleArn | string | — | The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. |
family | string | — | The name of a family that this daemon task definition is registered to. |
ipcMode | string | — | The IPC namespace mode for the daemon. |
memory | string | — | The amount of memory (in MiB) used by the daemon task. |
pidMode | string | — | The PID namespace mode for the daemon. |
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. |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes | |
taskRoleArn | string | — | The short name or full Amazon Resource Name (ARN) of the IAM role that grants containers in the daemon task permission to call Amazon Web Services APIs on your behalf. |
volumes | array<object> | — | The list of data volume definitions for the daemon task. |
volumes[].host | object | — | This parameter is specified when you use bind mount host volumes. |
volumes[].host.sourcePath | string | — | When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. |
volumes[].name | string | — | The name of the volume. |
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. |
daemonTaskDefinitionArn | string | — | Read-only: reported by AWS after creation. |
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. |
ECSExpressGatewayService # CLOUD CONTROL · AWS::ECS::ExpressGatewayService
ECSExpressGatewayService manages AWS::ECS::ExpressGatewayService through the AWS Cloud Control API.
kubectl get ecsexpressgatewayservices · example on GitHub
Example
# ECSExpressGatewayService — ECS
# 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/ecs.html#ecsexpressgatewayservice
apiVersion: aws.konfig.io/v1alpha1
kind: ECSExpressGatewayService
metadata:
name: example-ecsexpressgatewayservice
namespace: default
spec:
cluster: example
cpu: example
executionRoleArn: arn:aws:iam::123456789012:role/example-role
healthCheckPath: example
infrastructureRoleArn: arn:aws:iam::123456789012:role/example-role
memory: example
networkConfiguration:
securityGroups:
- example
subnets:
- example
primaryContainer:
awsLogsConfiguration:
logGroup: example
logStreamPrefix: example
command:
- example
containerPort: 443
environment:
- name: example-ecsexpressgatewayservice
value: example
image: example
repositoryCredentials:
credentialsParameter: example
secrets:
- name: example-ecsexpressgatewayservice
valueFrom: example
providerRef:
name: example-ecsexpressgatewayservice
region: us-east-1
scalingTarget:
autoScalingMetric: AVERAGE_CPU
autoScalingTargetValue: 1
maxTaskCount: 2
minTaskCount: 2
serviceName: example-ecsexpressgatewayservice
tags:
- key: example
value: example
taskDefinitionArn: arn:aws:iam::123456789012:role/example-role
taskRoleArn: arn:aws:iam::123456789012:role/example-role
Spec
| Field | Type | Required | Description |
|---|---|---|---|
cluster | string | — | Create-only in AWS: changing it requires replacing the resource. |
cpu | string | — | |
executionRoleArn | string | — | |
healthCheckPath | string | — | |
infrastructureRoleArn | string | yes | Create-only in AWS: changing it requires replacing the resource. |
memory | string | — | |
networkConfiguration | object | — | ECSExpressGatewayServiceExpressGatewayServiceNetworkConfiguration is a nested property type of AWS::ECS::ExpressGatewayService. |
networkConfiguration.securityGroups | array<string> | — | |
networkConfiguration.subnets | array<string> | — | |
primaryContainer | object | — | ECSExpressGatewayServiceExpressGatewayContainer is a nested property type of AWS::ECS::ExpressGatewayService. |
primaryContainer.awsLogsConfiguration | object | — | ECSExpressGatewayServiceExpressGatewayServiceAwsLogsConfiguration is a nested property type of AWS::ECS::ExpressGatewayService. |
primaryContainer.awsLogsConfiguration.logGroup | string | yes | |
primaryContainer.awsLogsConfiguration.logStreamPrefix | string | yes | |
primaryContainer.command | array<string> | — | |
primaryContainer.containerPort | integer | — | |
primaryContainer.environment | array<object> | — | |
primaryContainer.environment[].name | string | yes | |
primaryContainer.environment[].value | string | yes | |
primaryContainer.image | string | yes | |
primaryContainer.repositoryCredentials | object | — | ECSExpressGatewayServiceExpressGatewayRepositoryCredentials is a nested property type of AWS::ECS::ExpressGatewayService. |
primaryContainer.repositoryCredentials.credentialsParameter | string | yes | |
primaryContainer.secrets | array<object> | — | |
primaryContainer.secrets[].name | string | yes | |
primaryContainer.secrets[].valueFrom | string | yes | |
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. |
scalingTarget | object | — | ECSExpressGatewayServiceExpressGatewayScalingTarget is a nested property type of AWS::ECS::ExpressGatewayService. |
scalingTarget.autoScalingMetric | enum | — | Allowed: AVERAGE_CPU, AVERAGE_MEMORY, REQUEST_COUNT_PER_TARGET |
scalingTarget.autoScalingTargetValue | integer | — | |
scalingTarget.maxTaskCount | integer | — | |
scalingTarget.minTaskCount | integer | — | |
serviceName | string | — | Create-only in AWS: changing it requires replacing the resource. |
tags | array<object> | — | Create-only in AWS: changing it requires replacing the resource. |
tags[].key | string | yes | |
tags[].value | string | yes | |
taskDefinitionArn | string | — | |
taskRoleArn | string | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
activeConfigurations | array<object> | — | Read-only: reported by AWS after creation. |
activeConfigurations[].cpu | string | — | |
activeConfigurations[].createdAt | string | — | |
activeConfigurations[].executionRoleArn | string | — | |
activeConfigurations[].healthCheckPath | string | — | |
activeConfigurations[].ingressPaths | array<object> | — | |
activeConfigurations[].ingressPaths[].accessType | enum | — | Allowed: PUBLIC, PRIVATE |
activeConfigurations[].ingressPaths[].endpoint | string | — | |
activeConfigurations[].memory | string | — | |
activeConfigurations[].networkConfiguration | object | — | ECSExpressGatewayServiceExpressGatewayServiceNetworkConfiguration is a nested property type of AWS::ECS::ExpressGatewayService. |
activeConfigurations[].networkConfiguration.securityGroups | array<string> | — | |
activeConfigurations[].networkConfiguration.subnets | array<string> | — | |
activeConfigurations[].primaryContainer | object | — | ECSExpressGatewayServiceExpressGatewayContainer is a nested property type of AWS::ECS::ExpressGatewayService. |
activeConfigurations[].primaryContainer.awsLogsConfiguration | object | — | ECSExpressGatewayServiceExpressGatewayServiceAwsLogsConfiguration is a nested property type of AWS::ECS::ExpressGatewayService. |
activeConfigurations[].primaryContainer.awsLogsConfiguration.logGroup | string | yes | |
activeConfigurations[].primaryContainer.awsLogsConfiguration.logStreamPrefix | string | yes | |
activeConfigurations[].primaryContainer.command | array<string> | — | |
activeConfigurations[].primaryContainer.containerPort | integer | — | |
activeConfigurations[].primaryContainer.environment | array<object> | — | |
activeConfigurations[].primaryContainer.environment[].name | string | yes | |
activeConfigurations[].primaryContainer.environment[].value | string | yes | |
activeConfigurations[].primaryContainer.image | string | yes | |
activeConfigurations[].primaryContainer.repositoryCredentials | object | — | ECSExpressGatewayServiceExpressGatewayRepositoryCredentials is a nested property type of AWS::ECS::ExpressGatewayService. |
activeConfigurations[].primaryContainer.repositoryCredentials.credentialsParameter | string | yes | |
activeConfigurations[].primaryContainer.secrets | array<object> | — | |
activeConfigurations[].primaryContainer.secrets[].name | string | yes | |
activeConfigurations[].primaryContainer.secrets[].valueFrom | string | yes | |
activeConfigurations[].scalingTarget | object | — | ECSExpressGatewayServiceExpressGatewayScalingTarget is a nested property type of AWS::ECS::ExpressGatewayService. |
activeConfigurations[].scalingTarget.autoScalingMetric | enum | — | Allowed: AVERAGE_CPU, AVERAGE_MEMORY, REQUEST_COUNT_PER_TARGET |
activeConfigurations[].scalingTarget.autoScalingTargetValue | integer | — | |
activeConfigurations[].scalingTarget.maxTaskCount | integer | — | |
activeConfigurations[].scalingTarget.minTaskCount | integer | — | |
activeConfigurations[].serviceRevisionArn | string | — | |
activeConfigurations[].taskDefinitionArn | string | — | |
activeConfigurations[].taskRoleArn | string | — | |
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. |
createdAt | string | — | Read-only: reported by AWS after creation. |
ecsManagedResourceArns | object | — | Read-only: reported by AWS after creation. |
ecsManagedResourceArns.autoScaling | object | — | ECSExpressGatewayServiceAutoScalingArns is a nested property type of AWS::ECS::ExpressGatewayService. |
ecsManagedResourceArns.autoScaling.applicationAutoScalingPolicies | array<string> | — | |
ecsManagedResourceArns.autoScaling.scalableTarget | string | — | |
ecsManagedResourceArns.ingressPath | object | — | ECSExpressGatewayServiceIngressPathArns is a nested property type of AWS::ECS::ExpressGatewayService. |
ecsManagedResourceArns.ingressPath.certificateArn | string | — | |
ecsManagedResourceArns.ingressPath.listenerArn | string | — | |
ecsManagedResourceArns.ingressPath.listenerRuleArn | string | — | |
ecsManagedResourceArns.ingressPath.loadBalancerArn | string | — | |
ecsManagedResourceArns.ingressPath.loadBalancerSecurityGroups | array<string> | — | |
ecsManagedResourceArns.ingressPath.targetGroupArns | array<string> | — | |
ecsManagedResourceArns.logGroups | array<string> | — | |
ecsManagedResourceArns.metricAlarms | array<string> | — | |
ecsManagedResourceArns.serviceSecurityGroups | array<string> | — | |
endpoint | string | — | Read-only: reported by AWS after creation. |
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. |
serviceArn | string | — | Read-only: reported by AWS after creation. |
status | object | — | Read-only: reported by AWS after creation. |
status.statusCode | enum | — | Allowed: ACTIVE, DRAINING, INACTIVE |
updatedAt | string | — | Read-only: reported by AWS after creation. |
ECSPrimaryTaskSet # CLOUD CONTROL · AWS::ECS::PrimaryTaskSet
ECSPrimaryTaskSet manages AWS::ECS::PrimaryTaskSet through the AWS Cloud Control API.
kubectl get ecsprimarytasksets · example on GitHub
Example
# ECSPrimaryTaskSet — ECS
# 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/ecs.html#ecsprimarytaskset
apiVersion: aws.konfig.io/v1alpha1
kind: ECSPrimaryTaskSet
metadata:
name: example-ecsprimarytaskset
namespace: default
spec:
cluster: example
providerRef:
name: example-ecsprimarytaskset
region: us-east-1
service: example
taskSetId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
cluster | string | yes | The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. |
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. |
service | string | yes | The short name or full Amazon Resource Name (ARN) of the service to create the task set in. |
taskSetId | string | yes | The ID or full Amazon Resource Name (ARN) of the task set. |
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. |
ECSService # GA
ECSService is the Schema for managing ECS Services.
kubectl get ecsservices · example on GitHub
Example
# ECSService — ECS
# 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/ecs.html#ecsservice
apiVersion: aws.konfig.io/v1alpha1
kind: ECSService
metadata:
name: example-ecsservice
namespace: default
spec:
clusterName: example-ecsservice
clusterRef:
clusterName: example-ecsservice
name: example-ecsservice
desiredCount: 1
enableExecuteCommand: true
healthCheckGracePeriodSeconds: 300
launchType: FARGATE
loadBalancers:
- containerName: example-ecsservice
containerPort: 443
targetGroupArn: arn:aws:iam::123456789012:role/example-role
networkConfiguration:
assignPublicIp: ENABLED
securityGroupRefs:
- name: example-securitygrouprefs
subnetRefs:
- name: example-subnetrefs
providerRef:
name: example-ecsservice
region: us-east-1
serviceName: example-ecsservice
tags:
environment: dev
team: platform
taskDefinitionArn: arn:aws:iam::123456789012:role/example-role
taskDefinitionRef:
name: example-taskdefinition
Spec
| Field | Type | Required | Description |
|---|---|---|---|
clusterName | string | — | ClusterName is a direct ECS cluster name or ARN. |
clusterRef | object | — | ClusterRef references the ECS cluster to run the service in. |
clusterRef.clusterName | string | — | ClusterName is a direct AWS ECS cluster name or ARN. |
clusterRef.name | string | — | Name of an ECSCluster CR in the same namespace. |
desiredCount | integer | yes | DesiredCount is the number of task instances to run. |
enableExecuteCommand | boolean | — | EnableExecuteCommand enables ECS Exec on tasks. |
healthCheckGracePeriodSeconds | integer | — | HealthCheckGracePeriodSeconds is the grace period before health check starts. |
launchType | enum | — | LaunchType is the launch type for tasks. Allowed: FARGATE, EC2, EXTERNAL |
loadBalancers | array<object> | — | LoadBalancers connect the service to ALB/NLB target groups. |
loadBalancers[].containerName | string | yes | ContainerName is the name of the container to register with the target group. |
loadBalancers[].containerPort | integer | yes | ContainerPort is the container port to route traffic to. |
loadBalancers[].targetGroupArn | string | yes | TargetGroupArn is the ARN of the ALB/NLB target group. |
networkConfiguration | object | — | NetworkConfiguration is required for awsvpc network mode tasks. |
networkConfiguration.assignPublicIp | enum | — | AssignPublicIP controls whether tasks get a public IP. Allowed: ENABLED, DISABLED |
networkConfiguration.securityGroupRefs | array<object> | — | SecurityGroupRefs are the security groups to attach to tasks. |
networkConfiguration.securityGroupRefs[].id | string | — | ID is a direct AWS Security Group ID (e.g. |
networkConfiguration.securityGroupRefs[].name | string | — | Name of a SecurityGroup CR in the same namespace. |
networkConfiguration.subnetRefs | array<object> | yes | SubnetRefs are the subnets to launch tasks in. |
networkConfiguration.subnetRefs[].id | string | — | ID is a direct AWS Subnet ID (e.g. |
networkConfiguration.subnetRefs[].name | string | — | Name of a Subnet CR in the same namespace. |
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. |
serviceName | string | yes | ServiceName is the name of the ECS service. |
tags | map<string> | — | Tags are AWS resource tags. |
taskDefinitionArn | string | — | TaskDefinitionArn is a direct task definition ARN (with revision). |
taskDefinitionRef | object | — | TaskDefinitionRef references the task definition to run. |
taskDefinitionRef.arn | string | — | ARN is a direct AWS task definition ARN (e.g. |
taskDefinitionRef.name | string | — | Name of an ECSTaskDefinition CR in the same namespace. |
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. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
pendingCount | integer | — | PendingCount is the number of tasks in pending state. |
runningCount | integer | — | RunningCount is the number of currently running task instances. |
serviceArn | string | — | ServiceARN is the ARN of the ECS service. |
status | string | — | Status is the service status: ACTIVE, DRAINING, INACTIVE. |
ECSTaskDefinition # GA
ECSTaskDefinition is the Schema for managing ECS Task Definitions.
kubectl get ecstaskdefinitions · example on GitHub
Example
# ECSTaskDefinition — ECS
# 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/ecs.html#ecstaskdefinition
apiVersion: aws.konfig.io/v1alpha1
kind: ECSTaskDefinition
metadata:
name: example-ecstaskdefinition
namespace: default
spec:
containerDefinitions:
- command:
- example
cpu: 1
entryPoint:
- example
environment:
key: value
essential: false
image: example
logGroup: example
memory: 1
name: example-ecstaskdefinition
portMappings:
- containerPort: 443
protocol: tcp
cpu: example
executionRoleArn: arn:aws:iam::123456789012:role/example-role
executionRoleRef:
name: example-executionrole
family: example
memory: example
networkMode: awsvpc
providerRef:
name: example-ecstaskdefinition
region: us-east-1
tags:
environment: dev
team: platform
taskRoleArn: arn:aws:iam::123456789012:role/example-role
taskRoleRef:
name: example-taskrole
Spec
| Field | Type | Required | Description |
|---|---|---|---|
containerDefinitions | array<object> | yes | ContainerDefinitions is the list of containers in the task. |
containerDefinitions[].command | array<string> | — | Command overrides the container CMD. |
containerDefinitions[].cpu | integer | — | CPU units to reserve for the container. |
containerDefinitions[].entryPoint | array<string> | — | EntryPoint overrides the container ENTRYPOINT. |
containerDefinitions[].environment | map<string> | — | Environment variables for the container. |
containerDefinitions[].essential | boolean | — | Essential — if true, stopping this container stops the entire task. |
containerDefinitions[].image | string | yes | Image is the container image URI. |
containerDefinitions[].logGroup | string | — | LogGroup is a CloudWatch log group name to send container logs to. |
containerDefinitions[].memory | integer | — | Memory is the memory in MiB to reserve for the container. |
containerDefinitions[].name | string | yes | Name is the container name. |
containerDefinitions[].portMappings | array<object> | — | PortMappings are the ports to expose from the container. |
containerDefinitions[].portMappings[].containerPort | integer | yes | ContainerPort is the port exposed by the container. |
containerDefinitions[].portMappings[].protocol | enum | — | Protocol is the transport protocol: tcp or udp. Allowed: tcp, udp |
cpu | string | — | CPU is the number of vCPU units for the task (e.g. |
executionRoleArn | string | — | ExecutionRoleArn is the ARN of the task execution role. |
executionRoleRef | object | — | ExecutionRoleRef references an IAMRole CR in the same namespace. |
executionRoleRef.arn | string | — | ARN is a direct AWS IAM role ARN. |
executionRoleRef.name | string | — | Name of an IAMRole CR in the same namespace. |
executionRoleRef.namespace | string | — | Namespace of the IAMRole CR. |
family | string | yes | Family is the task definition family name. |
memory | string | — | Memory is the memory in MiB for the task (e.g. |
networkMode | enum | — | NetworkMode is the Docker networking mode. Allowed: awsvpc, bridge, host, none |
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. |
tags | map<string> | — | Tags are AWS resource tags. |
taskRoleArn | string | — | TaskRoleArn is the ARN of the task role (permissions for your application code). |
taskRoleRef | object | — | TaskRoleRef references an IAMRole CR in the same namespace. |
taskRoleRef.arn | string | — | ARN is a direct AWS IAM role ARN. |
taskRoleRef.name | string | — | Name of an IAMRole CR in the same namespace. |
taskRoleRef.namespace | string | — | Namespace of the IAMRole CR. |
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. |
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 task definition revision number. |
specHash | string | — | SpecHash is the hash of the spec used to detect changes. |
taskDefinitionArn | string | — | TaskDefinitionARN is the full ARN including revision of the latest registered task definition. |
ECSTaskSet # CLOUD CONTROL · AWS::ECS::TaskSet
ECSTaskSet manages AWS::ECS::TaskSet through the AWS Cloud Control API.
kubectl get ecstasksets · example on GitHub
Example
# ECSTaskSet — ECS
# 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/ecs.html#ecstaskset
apiVersion: aws.konfig.io/v1alpha1
kind: ECSTaskSet
metadata:
name: example-ecstaskset
namespace: default
spec:
capacityProviderStrategy:
- base: 1
capacityProvider: example
weight: 1
cluster: example
launchType: EC2
loadBalancers:
- containerName: example-ecstaskset
containerPort: 443
targetGroupArn: arn:aws:iam::123456789012:role/example-role
networkConfiguration:
awsVpcConfiguration:
assignPublicIp: DISABLED
securityGroups:
- example
subnets:
- example
platformVersion: '1.0'
providerRef:
name: example-ecstaskset
region: us-east-1
scale:
unit: PERCENT
value: 1
service: example
serviceRegistries:
- containerName: example-ecstaskset
containerPort: 443
port: 443
registryArn: arn:aws:iam::123456789012:role/example-role
tags:
- key: example
value: example
taskDefinition: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
capacityProviderStrategy | array<object> | — | Create-only in AWS: changing it requires replacing the resource. |
capacityProviderStrategy[].base | integer | — | |
capacityProviderStrategy[].capacityProvider | string | — | |
capacityProviderStrategy[].weight | integer | — | |
cluster | string | yes | The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. |
externalId | string | — | An optional non-unique tag that identifies this task set in external systems. |
launchType | enum | — | The launch type that new tasks in the task set will use. Allowed: EC2, FARGATE |
loadBalancers | array<object> | — | Create-only in AWS: changing it requires replacing the resource. |
loadBalancers[].containerName | string | — | The name of the container (as it appears in a container definition) to associate with the load balancer. |
loadBalancers[].containerPort | integer | — | The port on the container to associate with the load balancer. |
loadBalancers[].targetGroupArn | string | — | The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. |
networkConfiguration | object | — | Create-only in AWS: changing it requires replacing the resource. |
networkConfiguration.awsVpcConfiguration | object | — | ECSTaskSetAwsVpcConfiguration is a nested property type of AWS::ECS::TaskSet. |
networkConfiguration.awsVpcConfiguration.assignPublicIp | enum | — | Whether the task's elastic network interface receives a public IP address. Allowed: DISABLED, ENABLED |
networkConfiguration.awsVpcConfiguration.securityGroups | array<string> | — | The security groups associated with the task or service. |
networkConfiguration.awsVpcConfiguration.subnets | array<string> | yes | The subnets associated with the task or service. |
platformVersion | string | — | The platform version that the tasks in the task set should use. |
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. |
scale | object | — | A floating-point percentage of the desired number of tasks to place and keep running in the task set. |
scale.unit | enum | — | The unit of measure for the scale value. Allowed: PERCENT |
scale.value | number | — | The value, specified as a percent total of a service's desiredCount, to scale the task set. |
service | string | yes | The short name or full Amazon Resource Name (ARN) of the service to create the task set in. |
serviceRegistries | array<object> | — | The details of the service discovery registries to assign to this task set. |
serviceRegistries[].containerName | string | — | The container name value, already specified in the task definition, to be used for your service discovery service. |
serviceRegistries[].containerPort | integer | — | The port value, already specified in the task definition, to be used for your service discovery service. |
serviceRegistries[].port | integer | — | The port value used if your service discovery service specified an SRV record. |
serviceRegistries[].registryArn | string | — | The Amazon Resource Name (ARN) of the service registry. |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes | |
taskDefinition | string | yes | The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use. |
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. |
id | string | — | The ID of the task set. |
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. |