Skip to content

ecs.v1alpha1.taskDefinition

"TaskDefinition is the Schema for the TaskDefinitions API"

Index

Fields

fn new

new(name)

new returns an instance of TaskDefinition

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"TaskDefinitionSpec defines the desired state of TaskDefinition"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource."

obj spec.forProvider

"TaskDefinitionParameters defines the desired state of TaskDefinition"

fn spec.forProvider.withContainerDefinitions

withContainerDefinitions(containerDefinitions)

"A list of container definitions in JSON format that describe the different containers that make up your task."

fn spec.forProvider.withContainerDefinitionsMixin

withContainerDefinitionsMixin(containerDefinitions)

"A list of container definitions in JSON format that describe the different containers that make up your task."

Note: This function appends passed data to existing values

fn spec.forProvider.withCpu

withCpu(cpu)

"The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 vCPU or 1 vcpu) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered. \n Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers. \n If you're using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). \n If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter: \n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. \n * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) \n * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) \n * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) \n * 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) \n * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)"

fn spec.forProvider.withExecutionRoleARN

withExecutionRoleARN(executionRoleARN)

"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. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the Amazon Elastic Container Service Developer Guide."

fn spec.forProvider.withFamily

withFamily(family)

"You must specify a family for a task definition. You can use it track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed."

fn spec.forProvider.withInferenceAccelerators

withInferenceAccelerators(inferenceAccelerators)

"The Elastic Inference accelerators to use for the containers in the task."

fn spec.forProvider.withInferenceAcceleratorsMixin

withInferenceAcceleratorsMixin(inferenceAccelerators)

"The Elastic Inference accelerators to use for the containers in the task."

Note: This function appends passed data to existing values

fn spec.forProvider.withIpcMode

withIpcMode(ipcMode)

"The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the Docker run reference. \n If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security (https://docs.docker.com/engine/security/security/). \n If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the Amazon Elastic Container Service Developer Guide. \n * For tasks that use the host IPC mode, IPC namespace related systemControls are not supported. \n * For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task. \n This parameter is not supported for Windows containers or tasks run on Fargate."

fn spec.forProvider.withMemory

withMemory(memory)

"The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for example ,1024) or as a string using GB (for example, 1GB or 1 GB) in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered. \n Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers. \n If using the EC2 launch type, this field is optional. \n If using the Fargate launch type, this field is required and you must use one of the following values. This determines your range of supported values for the cpu parameter. \n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. \n * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU) \n * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) \n * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) \n * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) \n * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)"

fn spec.forProvider.withNetworkMode

withNetworkMode(networkMode)

"The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge. \n For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode. \n With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings. \n When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user. \n If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the Amazon Elastic Container Service Developer Guide. \n If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. \n For more information, see Network settings (https://docs.docker.com/engine/reference/run/#network-settings) in the Docker run reference."

fn spec.forProvider.withPidMode

withPidMode(pidMode)

"The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker run reference. \n If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security (https://docs.docker.com/engine/security/security/). \n This parameter is not supported for Windows containers or tasks run on Fargate."

fn spec.forProvider.withPlacementConstraints

withPlacementConstraints(placementConstraints)

"An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime."

fn spec.forProvider.withPlacementConstraintsMixin

withPlacementConstraintsMixin(placementConstraints)

"An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime."

Note: This function appends passed data to existing values

fn spec.forProvider.withRegion

withRegion(region)

"Region is which region the TaskDefinition will be created."

fn spec.forProvider.withRequiresCompatibilities

withRequiresCompatibilities(requiresCompatibilities)

"The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response."

fn spec.forProvider.withRequiresCompatibilitiesMixin

withRequiresCompatibilitiesMixin(requiresCompatibilities)

"The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response."

Note: This function appends passed data to existing values

fn spec.forProvider.withTags

withTags(tags)

"The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. \n The following basic restrictions apply to tags: \n * Maximum number of tags per resource - 50 \n * For each resource, each tag key must be unique, and each tag key can have only one value. \n * Maximum key length - 128 Unicode characters in UTF-8 \n * Maximum value length - 256 Unicode characters in UTF-8 \n * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. \n * Tag keys and values are case-sensitive. \n * Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. \n The following basic restrictions apply to tags: \n * Maximum number of tags per resource - 50 \n * For each resource, each tag key must be unique, and each tag key can have only one value. \n * Maximum key length - 128 Unicode characters in UTF-8 \n * Maximum value length - 256 Unicode characters in UTF-8 \n * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. \n * Tag keys and values are case-sensitive. \n * Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit."

Note: This function appends passed data to existing values

fn spec.forProvider.withTaskRoleARN

withTaskRoleARN(taskRoleARN)

"The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the Amazon Elastic Container Service Developer Guide. A list of volume definitions in JSON format that containers in your task may use."

fn spec.forProvider.withVolumes

withVolumes(volumes)

fn spec.forProvider.withVolumesMixin

withVolumesMixin(volumes)

Note: This function appends passed data to existing values

obj spec.forProvider.containerDefinitions

"A list of container definitions in JSON format that describe the different containers that make up your task."

fn spec.forProvider.containerDefinitions.withCommand

withCommand(command)

fn spec.forProvider.containerDefinitions.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withCpu

withCpu(cpu)

fn spec.forProvider.containerDefinitions.withDependsOn

withDependsOn(dependsOn)

fn spec.forProvider.containerDefinitions.withDependsOnMixin

withDependsOnMixin(dependsOn)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withDisableNetworking

withDisableNetworking(disableNetworking)

fn spec.forProvider.containerDefinitions.withDnsSearchDomains

withDnsSearchDomains(dnsSearchDomains)

fn spec.forProvider.containerDefinitions.withDnsSearchDomainsMixin

withDnsSearchDomainsMixin(dnsSearchDomains)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withDnsServers

withDnsServers(dnsServers)

fn spec.forProvider.containerDefinitions.withDnsServersMixin

withDnsServersMixin(dnsServers)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withDockerLabels

withDockerLabels(dockerLabels)

fn spec.forProvider.containerDefinitions.withDockerLabelsMixin

withDockerLabelsMixin(dockerLabels)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withDockerSecurityOptions

withDockerSecurityOptions(dockerSecurityOptions)

fn spec.forProvider.containerDefinitions.withDockerSecurityOptionsMixin

withDockerSecurityOptionsMixin(dockerSecurityOptions)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withEntryPoint

withEntryPoint(entryPoint)

fn spec.forProvider.containerDefinitions.withEntryPointMixin

withEntryPointMixin(entryPoint)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withEnvironment

withEnvironment(environment)

fn spec.forProvider.containerDefinitions.withEnvironmentFiles

withEnvironmentFiles(environmentFiles)

fn spec.forProvider.containerDefinitions.withEnvironmentFilesMixin

withEnvironmentFilesMixin(environmentFiles)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withEnvironmentMixin

withEnvironmentMixin(environment)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withEssential

withEssential(essential)

fn spec.forProvider.containerDefinitions.withExtraHosts

withExtraHosts(extraHosts)

fn spec.forProvider.containerDefinitions.withExtraHostsMixin

withExtraHostsMixin(extraHosts)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withHostname

withHostname(hostname)

fn spec.forProvider.containerDefinitions.withImage

withImage(image)

fn spec.forProvider.containerDefinitions.withInteractive

withInteractive(interactive)

withLinks(links)

fn spec.forProvider.containerDefinitions.withLinksMixin

withLinksMixin(links)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withMemory

withMemory(memory)

fn spec.forProvider.containerDefinitions.withMemoryReservation

withMemoryReservation(memoryReservation)

fn spec.forProvider.containerDefinitions.withMountPoints

withMountPoints(mountPoints)

fn spec.forProvider.containerDefinitions.withMountPointsMixin

withMountPointsMixin(mountPoints)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withName

withName(name)

fn spec.forProvider.containerDefinitions.withPortMappings

withPortMappings(portMappings)

fn spec.forProvider.containerDefinitions.withPortMappingsMixin

withPortMappingsMixin(portMappings)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withPrivileged

withPrivileged(privileged)

fn spec.forProvider.containerDefinitions.withPseudoTerminal

withPseudoTerminal(pseudoTerminal)

fn spec.forProvider.containerDefinitions.withReadonlyRootFilesystem

withReadonlyRootFilesystem(readonlyRootFilesystem)

fn spec.forProvider.containerDefinitions.withResourceRequirements

withResourceRequirements(resourceRequirements)

fn spec.forProvider.containerDefinitions.withResourceRequirementsMixin

withResourceRequirementsMixin(resourceRequirements)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withSecrets

withSecrets(secrets)

fn spec.forProvider.containerDefinitions.withSecretsMixin

withSecretsMixin(secrets)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withStartTimeout

withStartTimeout(startTimeout)

fn spec.forProvider.containerDefinitions.withStopTimeout

withStopTimeout(stopTimeout)

fn spec.forProvider.containerDefinitions.withSystemControls

withSystemControls(systemControls)

fn spec.forProvider.containerDefinitions.withSystemControlsMixin

withSystemControlsMixin(systemControls)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withUlimits

withUlimits(ulimits)

fn spec.forProvider.containerDefinitions.withUlimitsMixin

withUlimitsMixin(ulimits)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withUser

withUser(user)

fn spec.forProvider.containerDefinitions.withVolumesFrom

withVolumesFrom(volumesFrom)

fn spec.forProvider.containerDefinitions.withVolumesFromMixin

withVolumesFromMixin(volumesFrom)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.withWorkingDirectory

withWorkingDirectory(workingDirectory)

obj spec.forProvider.containerDefinitions.dependsOn

fn spec.forProvider.containerDefinitions.dependsOn.withCondition

withCondition(condition)

fn spec.forProvider.containerDefinitions.dependsOn.withContainerName

withContainerName(containerName)

obj spec.forProvider.containerDefinitions.environment

fn spec.forProvider.containerDefinitions.environment.withName

withName(name)

fn spec.forProvider.containerDefinitions.environment.withValue

withValue(value)

obj spec.forProvider.containerDefinitions.environmentFiles

fn spec.forProvider.containerDefinitions.environmentFiles.withType_

withType_(type_)

fn spec.forProvider.containerDefinitions.environmentFiles.withValue

withValue(value)

obj spec.forProvider.containerDefinitions.extraHosts

fn spec.forProvider.containerDefinitions.extraHosts.withHostname

withHostname(hostname)

fn spec.forProvider.containerDefinitions.extraHosts.withIpAddress

withIpAddress(ipAddress)

obj spec.forProvider.containerDefinitions.firelensConfiguration

"The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the Amazon Elastic Container Service Developer Guide."

fn spec.forProvider.containerDefinitions.firelensConfiguration.withOptions

withOptions(options)

fn spec.forProvider.containerDefinitions.firelensConfiguration.withOptionsMixin

withOptionsMixin(options)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.firelensConfiguration.withType_

withType_(type_)

obj spec.forProvider.containerDefinitions.healthCheck

"An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). \n The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. \n You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console. \n The following describes the possible healthStatus values for a container: \n * HEALTHY-The container health check has passed successfully. \n * UNHEALTHY-The container health check has failed. \n * UNKNOWN-The container health check is being evaluated or there's no container health check defined. \n The following describes the possible healthStatus values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task. \n * HEALTHY-All essential containers within the task have passed their health checks. \n * UNHEALTHY-One or more essential containers have failed their health check. \n * UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined. \n If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. \n The following are notes about container health check support: \n * Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). \n * Container health checks are supported for Fargate tasks if you're using platform version 1.1.0 or greater. For more information, see Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). \n * Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer."

fn spec.forProvider.containerDefinitions.healthCheck.withCommand

withCommand(command)

fn spec.forProvider.containerDefinitions.healthCheck.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.healthCheck.withInterval

withInterval(interval)

fn spec.forProvider.containerDefinitions.healthCheck.withRetries

withRetries(retries)

fn spec.forProvider.containerDefinitions.healthCheck.withStartPeriod

withStartPeriod(startPeriod)

fn spec.forProvider.containerDefinitions.healthCheck.withTimeout

withTimeout(timeout)

obj spec.forProvider.containerDefinitions.linuxParameters

"Linux-specific options that are applied to the container, such as Linux KernelCapabilities."

fn spec.forProvider.containerDefinitions.linuxParameters.withDevices

withDevices(devices)

fn spec.forProvider.containerDefinitions.linuxParameters.withDevicesMixin

withDevicesMixin(devices)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.linuxParameters.withInitProcessEnabled

withInitProcessEnabled(initProcessEnabled)

fn spec.forProvider.containerDefinitions.linuxParameters.withMaxSwap

withMaxSwap(maxSwap)

fn spec.forProvider.containerDefinitions.linuxParameters.withSharedMemorySize

withSharedMemorySize(sharedMemorySize)

fn spec.forProvider.containerDefinitions.linuxParameters.withSwappiness

withSwappiness(swappiness)

fn spec.forProvider.containerDefinitions.linuxParameters.withTmpfs

withTmpfs(tmpfs)

fn spec.forProvider.containerDefinitions.linuxParameters.withTmpfsMixin

withTmpfsMixin(tmpfs)

Note: This function appends passed data to existing values

obj spec.forProvider.containerDefinitions.linuxParameters.capabilities

"The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) (http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page."

fn spec.forProvider.containerDefinitions.linuxParameters.capabilities.withAdd

withAdd(add)

fn spec.forProvider.containerDefinitions.linuxParameters.capabilities.withAddMixin

withAddMixin(add)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.linuxParameters.capabilities.withDrop

withDrop(drop)

fn spec.forProvider.containerDefinitions.linuxParameters.capabilities.withDropMixin

withDropMixin(drop)

Note: This function appends passed data to existing values

obj spec.forProvider.containerDefinitions.linuxParameters.devices

fn spec.forProvider.containerDefinitions.linuxParameters.devices.withContainerPath

withContainerPath(containerPath)

fn spec.forProvider.containerDefinitions.linuxParameters.devices.withHostPath

withHostPath(hostPath)

fn spec.forProvider.containerDefinitions.linuxParameters.devices.withPermissions

withPermissions(permissions)

fn spec.forProvider.containerDefinitions.linuxParameters.devices.withPermissionsMixin

withPermissionsMixin(permissions)

Note: This function appends passed data to existing values

obj spec.forProvider.containerDefinitions.linuxParameters.tmpfs

fn spec.forProvider.containerDefinitions.linuxParameters.tmpfs.withContainerPath

withContainerPath(containerPath)

fn spec.forProvider.containerDefinitions.linuxParameters.tmpfs.withMountOptions

withMountOptions(mountOptions)

fn spec.forProvider.containerDefinitions.linuxParameters.tmpfs.withMountOptionsMixin

withMountOptionsMixin(mountOptions)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.linuxParameters.tmpfs.withSize

withSize(size)

obj spec.forProvider.containerDefinitions.logConfiguration

"The log configuration for the container. This parameter maps to LogConfig in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/). \n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. \n Understand the following when specifying a log configuration for your containers. \n * Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent. \n * This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. \n * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the Amazon Elastic Container Service Developer Guide. \n * For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to."

fn spec.forProvider.containerDefinitions.logConfiguration.withLogDriver

withLogDriver(logDriver)

fn spec.forProvider.containerDefinitions.logConfiguration.withOptions

withOptions(options)

fn spec.forProvider.containerDefinitions.logConfiguration.withOptionsMixin

withOptionsMixin(options)

Note: This function appends passed data to existing values

fn spec.forProvider.containerDefinitions.logConfiguration.withSecretOptions

withSecretOptions(secretOptions)

fn spec.forProvider.containerDefinitions.logConfiguration.withSecretOptionsMixin

withSecretOptionsMixin(secretOptions)

Note: This function appends passed data to existing values

obj spec.forProvider.containerDefinitions.logConfiguration.secretOptions

fn spec.forProvider.containerDefinitions.logConfiguration.secretOptions.withName

withName(name)

fn spec.forProvider.containerDefinitions.logConfiguration.secretOptions.withValueFrom

withValueFrom(valueFrom)

obj spec.forProvider.containerDefinitions.mountPoints

fn spec.forProvider.containerDefinitions.mountPoints.withContainerPath

withContainerPath(containerPath)

fn spec.forProvider.containerDefinitions.mountPoints.withReadOnly

withReadOnly(readOnly)

fn spec.forProvider.containerDefinitions.mountPoints.withSourceVolume

withSourceVolume(sourceVolume)

obj spec.forProvider.containerDefinitions.portMappings

fn spec.forProvider.containerDefinitions.portMappings.withContainerPort

withContainerPort(containerPort)

fn spec.forProvider.containerDefinitions.portMappings.withHostPort

withHostPort(hostPort)

fn spec.forProvider.containerDefinitions.portMappings.withProtocol

withProtocol(protocol)

obj spec.forProvider.containerDefinitions.repositoryCredentials

"The repository credentials for private registry authentication."

fn spec.forProvider.containerDefinitions.repositoryCredentials.withCredentialsParameter

withCredentialsParameter(credentialsParameter)

obj spec.forProvider.containerDefinitions.resourceRequirements

fn spec.forProvider.containerDefinitions.resourceRequirements.withType_

withType_(type_)

fn spec.forProvider.containerDefinitions.resourceRequirements.withValue

withValue(value)

obj spec.forProvider.containerDefinitions.secrets

fn spec.forProvider.containerDefinitions.secrets.withName

withName(name)

fn spec.forProvider.containerDefinitions.secrets.withValueFrom

withValueFrom(valueFrom)

obj spec.forProvider.containerDefinitions.systemControls

fn spec.forProvider.containerDefinitions.systemControls.withNamespace

withNamespace(namespace)

fn spec.forProvider.containerDefinitions.systemControls.withValue

withValue(value)

obj spec.forProvider.containerDefinitions.ulimits

fn spec.forProvider.containerDefinitions.ulimits.withHardLimit

withHardLimit(hardLimit)

fn spec.forProvider.containerDefinitions.ulimits.withName

withName(name)

fn spec.forProvider.containerDefinitions.ulimits.withSoftLimit

withSoftLimit(softLimit)

obj spec.forProvider.containerDefinitions.volumesFrom

fn spec.forProvider.containerDefinitions.volumesFrom.withReadOnly

withReadOnly(readOnly)

fn spec.forProvider.containerDefinitions.volumesFrom.withSourceContainer

withSourceContainer(sourceContainer)

obj spec.forProvider.ephemeralStorage

"The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) in the Amazon ECS User Guide for Fargate. \n This parameter is only supported for tasks hosted on Fargate using the following platform versions: \n * Linux platform version 1.4.0 or later. \n * Windows platform version 1.0.0 or later."

fn spec.forProvider.ephemeralStorage.withSizeInGiB

withSizeInGiB(sizeInGiB)

obj spec.forProvider.executionRoleARNRef

"A Reference to a named object."

fn spec.forProvider.executionRoleARNRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.executionRoleARNRef.policy

"Policies for referencing."

fn spec.forProvider.executionRoleARNRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.executionRoleARNRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.executionRoleARNSelector

"A Selector selects an object."

fn spec.forProvider.executionRoleARNSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.executionRoleARNSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.executionRoleARNSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.executionRoleARNSelector.policy

"Policies for selection."

fn spec.forProvider.executionRoleARNSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.executionRoleARNSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.inferenceAccelerators

"The Elastic Inference accelerators to use for the containers in the task."

fn spec.forProvider.inferenceAccelerators.withDeviceName

withDeviceName(deviceName)

fn spec.forProvider.inferenceAccelerators.withDeviceType

withDeviceType(deviceType)

obj spec.forProvider.placementConstraints

"An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime."

fn spec.forProvider.placementConstraints.withExpression

withExpression(expression)

fn spec.forProvider.placementConstraints.withType_

withType_(type_)

obj spec.forProvider.proxyConfiguration

"The configuration details for the App Mesh proxy. \n For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html) in the Amazon Elastic Container Service Developer Guide."

fn spec.forProvider.proxyConfiguration.withContainerName

withContainerName(containerName)

fn spec.forProvider.proxyConfiguration.withProperties

withProperties(properties)

fn spec.forProvider.proxyConfiguration.withPropertiesMixin

withPropertiesMixin(properties)

Note: This function appends passed data to existing values

fn spec.forProvider.proxyConfiguration.withType_

withType_(type_)

obj spec.forProvider.proxyConfiguration.properties

fn spec.forProvider.proxyConfiguration.properties.withName

withName(name)

fn spec.forProvider.proxyConfiguration.properties.withValue

withValue(value)

obj spec.forProvider.runtimePlatform

"The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. \n When you specify a task definition in a service, this value must match the runtimePlatform value of the service."

fn spec.forProvider.runtimePlatform.withCpuArchitecture

withCpuArchitecture(cpuArchitecture)

fn spec.forProvider.runtimePlatform.withOperatingSystemFamily

withOperatingSystemFamily(operatingSystemFamily)

obj spec.forProvider.tags

"The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. \n The following basic restrictions apply to tags: \n * Maximum number of tags per resource - 50 \n * For each resource, each tag key must be unique, and each tag key can have only one value. \n * Maximum key length - 128 Unicode characters in UTF-8 \n * Maximum value length - 256 Unicode characters in UTF-8 \n * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. \n * Tag keys and values are case-sensitive. \n * Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit."

fn spec.forProvider.tags.withKey

withKey(key)

fn spec.forProvider.tags.withValue

withValue(value)

obj spec.forProvider.taskRoleARNRef

"A Reference to a named object."

fn spec.forProvider.taskRoleARNRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.taskRoleARNRef.policy

"Policies for referencing."

fn spec.forProvider.taskRoleARNRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.taskRoleARNRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.taskRoleARNSelector

"A Selector selects an object."

fn spec.forProvider.taskRoleARNSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.taskRoleARNSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.taskRoleARNSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.taskRoleARNSelector.policy

"Policies for selection."

fn spec.forProvider.taskRoleARNSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.taskRoleARNSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.volumes

fn spec.forProvider.volumes.withName

withName(name)

obj spec.forProvider.volumes.dockerVolumeConfiguration

"This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead."

fn spec.forProvider.volumes.dockerVolumeConfiguration.withAutoprovision

withAutoprovision(autoprovision)

fn spec.forProvider.volumes.dockerVolumeConfiguration.withDriver

withDriver(driver)

fn spec.forProvider.volumes.dockerVolumeConfiguration.withDriverOpts

withDriverOpts(driverOpts)

fn spec.forProvider.volumes.dockerVolumeConfiguration.withDriverOptsMixin

withDriverOptsMixin(driverOpts)

Note: This function appends passed data to existing values

fn spec.forProvider.volumes.dockerVolumeConfiguration.withLabels

withLabels(labels)

fn spec.forProvider.volumes.dockerVolumeConfiguration.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

fn spec.forProvider.volumes.dockerVolumeConfiguration.withScope

withScope(scope)

obj spec.forProvider.volumes.efsVolumeConfiguration

"This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the Amazon Elastic Container Service Developer Guide."

fn spec.forProvider.volumes.efsVolumeConfiguration.withFileSystemID

withFileSystemID(fileSystemID)

fn spec.forProvider.volumes.efsVolumeConfiguration.withRootDirectory

withRootDirectory(rootDirectory)

fn spec.forProvider.volumes.efsVolumeConfiguration.withTransitEncryption

withTransitEncryption(transitEncryption)

fn spec.forProvider.volumes.efsVolumeConfiguration.withTransitEncryptionPort

withTransitEncryptionPort(transitEncryptionPort)

obj spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig

"The authorization configuration details for the Amazon EFS file system."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.withAccessPointID

withAccessPointID(accessPointID)

"The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the Amazon Elastic File System User Guide."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.withIam

withIam(iam)

"Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the Amazon Elastic Container Service Developer Guide."

obj spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDRef

"A Reference to a named object."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDRef.policy

"Policies for referencing."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDSelector

"A Selector selects an object."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDSelector.policy

"Policies for selection."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.volumes.efsVolumeConfiguration.authorizationConfig.accessPointIDSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDRef

"A Reference to a named object."

fn spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDRef.policy

"Policies for referencing."

fn spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDSelector

"A Selector selects an object."

fn spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDSelector.policy

"Policies for selection."

fn spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.volumes.efsVolumeConfiguration.fileSystemIDSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.volumes.fsxWindowsFileServerVolumeConfiguration

"This parameter is specified when you are using Amazon FSx for Windows File Server (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage. \n For more information and the input format, see Amazon FSx for Windows File Server Volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the Amazon Elastic Container Service Developer Guide."

fn spec.forProvider.volumes.fsxWindowsFileServerVolumeConfiguration.withFileSystemID

withFileSystemID(fileSystemID)

fn spec.forProvider.volumes.fsxWindowsFileServerVolumeConfiguration.withRootDirectory

withRootDirectory(rootDirectory)

obj spec.forProvider.volumes.fsxWindowsFileServerVolumeConfiguration.authorizationConfig

"The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html) in the Amazon Elastic Container Service API Reference. \n For more information and the input format, see Amazon FSx for Windows File Server Volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the Amazon Elastic Container Service Developer Guide."

fn spec.forProvider.volumes.fsxWindowsFileServerVolumeConfiguration.authorizationConfig.withCredentialsParameter

withCredentialsParameter(credentialsParameter)

fn spec.forProvider.volumes.fsxWindowsFileServerVolumeConfiguration.authorizationConfig.withDomain

withDomain(domain)

obj spec.forProvider.volumes.host

"Details on a container instance bind mount host volume."

fn spec.forProvider.volumes.host.withSourcePath

withSourcePath(sourcePath)

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."