This product is not supported for your selected Datadog site. ().
This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_lightsail_container_service

account_id

Type: STRING

arn

Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN) of the container service.

container_service_name

Type: STRING
Provider name: containerServiceName
Description: The name of the container service.

created_at

Type: TIMESTAMP
Provider name: createdAt
Description: The timestamp when the container service was created.

current_deployment

Type: STRUCT
Provider name: currentDeployment
Description: An object that describes the current container deployment of the container service.

  • containers
    Type: STRING
    Provider name: containers
    Description: An object that describes the configuration for the containers of the deployment.
  • created_at
    Type: TIMESTAMP
    Provider name: createdAt
    Description: The timestamp when the deployment was created.
  • public_endpoint
    Type: STRUCT
    Provider name: publicEndpoint
    Description: An object that describes the endpoint of the deployment.
    • container_name
      Type: STRING
      Provider name: containerName
      Description: The name of the container entry of the deployment that the endpoint configuration applies to.
    • container_port
      Type: INT32
      Provider name: containerPort
      Description: The port of the specified container to which traffic is forwarded to.
    • health_check
      Type: STRUCT
      Provider name: healthCheck
      Description: An object that describes the health check configuration of the container.
      • healthy_threshold
        Type: INT32
        Provider name: healthyThreshold
        Description: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
      • interval_seconds
        Type: INT32
        Provider name: intervalSeconds
        Description: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.
      • path
        Type: STRING
        Provider name: path
        Description: The path on the container on which to perform the health check. The default value is /.
      • success_codes
        Type: STRING
        Provider name: successCodes
        Description: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).
      • timeout_seconds
        Type: INT32
        Provider name: timeoutSeconds
        Description: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.
      • unhealthy_threshold
        Type: INT32
        Provider name: unhealthyThreshold
        Description: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.
  • state
    Type: STRING
    Provider name: state
    Description: The state of the deployment. A deployment can be in one of the following states:
    • ACTIVATING - The deployment is being created.
    • ACTIVE - The deployment was successfully created, and it’s currently running on the container service. The container service can have only one deployment in an active state at a time.
    • INACTIVE - The deployment was previously successfully created, but it is not currently running on the container service.
    • FAILED - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
  • version
    Type: INT32
    Provider name: version
    Description: The version number of the deployment.

is_disabled

Type: BOOLEAN
Provider name: isDisabled
Description: A Boolean value indicating whether the container service is disabled.

location

Type: STRUCT
Provider name: location
Description: An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

  • availability_zone
    Type: STRING
    Provider name: availabilityZone
    Description: The Availability Zone. Follows the format us-east-2a (case-sensitive).
  • region_name
    Type: STRING
    Provider name: regionName
    Description: The Amazon Web Services Region name.

next_deployment

Type: STRUCT
Provider name: nextDeployment
Description: An object that describes the next deployment of the container service. This value is null when there is no deployment in a pending state.

  • containers
    Type: STRING
    Provider name: containers
    Description: An object that describes the configuration for the containers of the deployment.
  • created_at
    Type: TIMESTAMP
    Provider name: createdAt
    Description: The timestamp when the deployment was created.
  • public_endpoint
    Type: STRUCT
    Provider name: publicEndpoint
    Description: An object that describes the endpoint of the deployment.
    • container_name
      Type: STRING
      Provider name: containerName
      Description: The name of the container entry of the deployment that the endpoint configuration applies to.
    • container_port
      Type: INT32
      Provider name: containerPort
      Description: The port of the specified container to which traffic is forwarded to.
    • health_check
      Type: STRUCT
      Provider name: healthCheck
      Description: An object that describes the health check configuration of the container.
      • healthy_threshold
        Type: INT32
        Provider name: healthyThreshold
        Description: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
      • interval_seconds
        Type: INT32
        Provider name: intervalSeconds
        Description: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.
      • path
        Type: STRING
        Provider name: path
        Description: The path on the container on which to perform the health check. The default value is /.
      • success_codes
        Type: STRING
        Provider name: successCodes
        Description: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).
      • timeout_seconds
        Type: INT32
        Provider name: timeoutSeconds
        Description: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.
      • unhealthy_threshold
        Type: INT32
        Provider name: unhealthyThreshold
        Description: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.
  • state
    Type: STRING
    Provider name: state
    Description: The state of the deployment. A deployment can be in one of the following states:
    • ACTIVATING - The deployment is being created.
    • ACTIVE - The deployment was successfully created, and it’s currently running on the container service. The container service can have only one deployment in an active state at a time.
    • INACTIVE - The deployment was previously successfully created, but it is not currently running on the container service.
    • FAILED - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.
  • version
    Type: INT32
    Provider name: version
    Description: The version number of the deployment.

power

Type: STRING
Provider name: power
Description: The power specification of the container service. The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

power_id

Type: STRING
Provider name: powerId
Description: The ID of the power of the container service.

principal_arn

Type: STRING
Provider name: principalArn
Description: The principal ARN of the container service. The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your service permission to access resources in your standard Amazon Web Services account.

private_domain_name

Type: STRING
Provider name: privateDomainName
Description: The private domain name of the container service. The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.

private_registry_access

Type: STRUCT
Provider name: privateRegistryAccess
Description: An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

  • ecr_image_puller_role
    Type: STRUCT
    Provider name: ecrImagePullerRole
    Description: An object that describes the activation status of the role that you can use to grant a Lightsail container service access to Amazon ECR private repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also listed.
    • is_active
      Type: BOOLEAN
      Provider name: isActive
      Description: A Boolean value that indicates whether the role is activated.
    • principal_arn
      Type: STRING
      Provider name: principalArn
      Description: The Amazon Resource Name (ARN) of the role, if it is activated.

public_domain_names

Type: STRING
Provider name: publicDomainNames
Description: The public domain name of the container service, such as example.com and www.example.com. You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service. If you don’t specify public domain names, then you can use the default domain of the container service. You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service. See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.

resource_type

Type: STRING
Provider name: resourceType
Description: The Lightsail resource type of the container service.

scale

Type: INT32
Provider name: scale
Description: The scale specification of the container service. The scale specifies the allocated compute nodes of the container service.

state

Type: STRING
Provider name: state
Description: The current state of the container service. The following container service states are possible:

  • PENDING - The container service is being created.
  • READY - The container service is running but it does not have an active container deployment.
  • DEPLOYING - The container service is launching a container deployment.
  • RUNNING - The container service is running and it has an active container deployment.
  • UPDATING - The container service capacity or its custom domains are being updated.
  • DELETING - The container service is being deleted.
  • DISABLED - The container service is disabled, and its active deployment and containers, if any, are shut down.

state_detail

Type: STRUCT
Provider name: stateDetail
Description: An object that describes the current state of the container service. The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

  • code
    Type: STRING
    Provider name: code
    Description: The state code of the container service. The following state codes are possible:
    • The following state codes are possible if your container service is in a DEPLOYING or UPDATING state:
      • CREATING_SYSTEM_RESOURCES - The system resources for your container service are being created.
      • CREATING_NETWORK_INFRASTRUCTURE - The network infrastructure for your container service are being created.
      • PROVISIONING_CERTIFICATE - The SSL/TLS certificate for your container service is being created.
      • PROVISIONING_SERVICE - Your container service is being provisioned.
      • CREATING_DEPLOYMENT - Your deployment is being created on your container service.
      • EVALUATING_HEALTH_CHECK - The health of your deployment is being evaluated.
      • ACTIVATING_DEPLOYMENT - Your deployment is being activated.
    • The following state codes are possible if your container service is in a PENDING state:
      • CERTIFICATE_LIMIT_EXCEEDED - The SSL/TLS certificate required for your container service exceeds the maximum number of certificates allowed for your account.
      • UNKNOWN_ERROR - An error was experienced when your container service was being created.
  • message
    Type: STRING
    Provider name: message
    Description: A message that provides more information for the state code. The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

tags

Type: UNORDERED_LIST_STRING

url

Type: STRING
Provider name: url
Description: The publicly accessible URL of the container service. If no public endpoint is specified in the currentDeployment, this URL returns a 404 response.