Updates to access, maintenance, and support policy for official packages:On January 31, 2025 Upbound is updating the access policy for Official Providers
Learn More
You are viewing an outdated version of provider-aws.Go to Latest
crossplane-contrib/provider-aws@v0.33.0
Service
ecs.aws.crossplane.io
Service
crossplane-contrib/provider-aws@v0.33.0ecs.aws.crossplane.io

Service is the Schema for the Services API

Type

CRD

Group

ecs.aws.crossplane.io

Version

v1alpha1

apiVersion: ecs.aws.crossplane.io/v1alpha1

kind: Service

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

ServiceSpec defines the desired state of Service

forProvider
requiredobject
requiredobject

ServiceParameters defines the desired state of Service

array

The capacity provider strategy to use for the service. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used. A capacity provider strategy may contain a maximum of 6 capacity providers.

base
integer
weight
integer
cluster
string
object

A Reference to a named object.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

A Selector selects an object.

policy
object
object

Policies for selection.

resolve
string
object

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

object

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type that are not behind a Classic Load Balancer. The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the Amazon Elastic Container Service Developer Guide.

enable
boolean
rollback
boolean
object

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

type_
string
array

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the Amazon Elastic Container Service Developer Guide. If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the Amazon Elastic Container Service Developer Guide. If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it. After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service. For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here. For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here. Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

object

A Reference to a named object.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

A Selector selects an object.

policy
object
object

Policies for selection.

resolve
string
object

A Reference to a named object.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

A Selector selects an object.

policy
object
object

Policies for selection.

resolve
string
object

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. 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.

object

An object representing the networking details for a task or service.

array

No description provided.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

A Selector selects an object.

policy
object
object

Policies for selection.

resolve
string
array

No description provided.

array

No description provided.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

A Selector selects an object.

policy
object
object

Policies for selection.

resolve
string
subnets
array
array

No description provided.

array

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

type_
string
array

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

field
string
type_
string
region
requiredstring
role
string
array

The details of the service discovery registry to associate with this service. For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). Each service may be associated with one service registry. Multiple service registries per service isn't supported.

tags
array
array

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8
  • Maximum value length - 256 Unicode characters in UTF-8
  • 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: + - = . _ : / @.
  • Tag keys and values are case-sensitive.
  • 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.
key
string
value
string
object

A Reference to a named object.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

A Selector selects an object.

policy
object
object

Policies for selection.

resolve
string
object

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

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

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

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

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.

configRef
object
object

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

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

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.

name
requiredstring
namespace
requiredstring
status
object
object

ServiceStatus defines the observed state of Service.

object

ServiceObservation defines the observed state of Service

createdAt
string
createdBy
string
array

The current state of deployments for the service.

array

No description provided.

base
integer
weight
integer
createdAt
string
id
string
object

An object representing the network configuration for a task or service.

object

An object representing the networking details for a task or service.

array

No description provided.

subnets
array
array

No description provided.

status
string
updatedAt
string
events
array
array

The event stream for your service. A maximum of 100 of the latest events are displayed.

createdAt
string
id
string
message
string
array

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

object

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

object

An object representing the networking details for a task or service.

array

No description provided.

subnets
array
array

No description provided.

roleARN
string
status
string
array

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

array

No description provided.

base
integer
weight
integer
createdAt
string
id
string
array

No description provided.

object

An object representing the network configuration for a task or service.

object

An object representing the networking details for a task or service.

array

No description provided.

subnets
array
array

No description provided.

scale
object
object

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

unit
string
value
number
array

No description provided.

startedBy
string
status
string
tags
array
array

No description provided.

key
string
value
string
updatedAt
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions