create_container_service_deployment `async` ¶

create_container_service_deployment(
    service_name: ContainerServiceName,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    containers: Optional[ContainerMap] = None,
    public_endpoint: Optional[EndpointRequest] = None,
) -> CreateContainerServiceDeploymentResult

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:

service_name (ContainerServiceName) –

The name of the container service for which to create the deployment.
containers (Optional[ContainerMap], default: None ) –

An object that describes the settings of the containers that will be launched on the container service.
public_endpoint (Optional[EndpointRequest], default: None ) –

An object that describes the settings of the public endpoint for the container service.

Raises:

AccessDeniedException –

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
InvalidInputException –

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException –

Lightsail throws this exception when it cannot find a resource.
RegionSetupInProgressException –

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
ServiceException –

A general service exception.
UnauthenticatedException –

Lightsail throws this exception when the user has not been authenticated.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lightsail/_services/async_lightsail.py

async def create_container_service_deployment(
    self,
    service_name: "capo_lightsail.types.container_service_name.ContainerServiceName",
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
    containers: Optional["capo_lightsail.types.container_map.ContainerMap"] = None,
    public_endpoint: Optional[
        "capo_lightsail.types.endpoint_request.EndpointRequest"
    ] = None,
) -> "capo_lightsail.types.create_container_service_deployment_result.CreateContainerServiceDeploymentResult":
    """<p>Creates a deployment for your Amazon Lightsail container service.</p> <p>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.</p> <p>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 <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-creating-container-images">Creating container images for your Amazon Lightsail container services</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>

    Args:
        service_name: <p>The name of the container service for which to create the deployment.</p>
        containers: <p>An object that describes the settings of the containers that will be launched on the container service.</p>
        public_endpoint: <p>An object that describes the settings of the public endpoint for the container service.</p>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lightsail.types.create_container_service_deployment_request.CreateContainerServiceDeploymentRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.create_container_service_deployment_result.CreateContainerServiceDeploymentResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.create_container_service_deployment

        (
            output,
            http_response,
        ) = await capo_lightsail._operations.lightsail_20161128.create_container_service_deployment.async_create_container_service_deployment(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateContainerServiceDeployment")
    )
    input_: capo_lightsail.types.create_container_service_deployment_request.CreateContainerServiceDeploymentRequest = {
        "service_name": service_name
    }
    if containers is not None:
        input_["containers"] = containers
    if public_endpoint is not None:
        input_["public_endpoint"] = public_endpoint

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

create_container_service_deployment async ¶

create_container_service_deployment `async` ¶