container_service_deployments

Creates, updates, deletes, gets or lists a container_service_deployments resource.

Overview

Name	container_service_deployments
Type	Resource
Id	aws.lightsail.container_service_deployments

Fields

The following fields are returned by SELECT queries:

get_container_service_deployments

Name	Datatype	Description
deployments	array	An array of objects that describe deployments for a container service.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_container_service_deployments	select	region		Returns the deployments for your Amazon Lightsail container service A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service. The deployments are ordered by version in ascending order. The newest version is listed at the top of the response. A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.
create_container_service_deployment	insert	region, serviceName		Creates a deployment for your Amazon Lightsail container service. A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration. You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_container_service_deployments

Returns the deployments for your Amazon Lightsail container service A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service. The deployments are ordered by version in ascending order. The newest version is listed at the top of the response. A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.

SELECT
deployments
FROM aws.lightsail.container_service_deployments
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_container_service_deployment

Creates a deployment for your Amazon Lightsail container service. A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration. You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

INSERT INTO aws.lightsail.container_service_deployments (
serviceName,
containers,
publicEndpoint,
region
)
SELECT 
'{{ serviceName }}' /* required */,
'{{ containers }}',
'{{ publicEndpoint }}',
'{{ region }}'
RETURNING
container_service
;

Manifest

# Description fields are for documentation purposes
- name: container_service_deployments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the container_service_deployments resource.
  - name: serviceName
    value: "{{ serviceName }}"
    description: |
      The name of the container service for which to create the deployment.
  - name: containers
    value: "{{ containers }}"
    description: |
      An object that describes the settings of the containers that will be launched on the container service.
  - name: publicEndpoint
    description: |
      An object that describes the settings of the public endpoint for the container service.
    value:
      containerName: "{{ containerName }}"
      containerPort: {{ containerPort }}
      healthCheck:
        healthyThreshold: {{ healthyThreshold }}
        unhealthyThreshold: {{ unhealthyThreshold }}
        timeoutSeconds: {{ timeoutSeconds }}
        intervalSeconds: {{ intervalSeconds }}
        path: "{{ path }}"
        successCodes: "{{ successCodes }}"