AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Lightsail CreateContainerServiceDeployment API operation.

Syntax

New-LSContainerServiceDeployment
-ServiceName <String>
-PublicEndpoint_ContainerName <String>
-PublicEndpoint_ContainerPort <Int32>
-Container <Hashtable>
-HealthCheck_HealthyThreshold <Int32>
-HealthCheck_IntervalSecond <Int32>
-HealthCheck_Path <String>
-HealthCheck_SuccessCode <String>
-HealthCheck_TimeoutSecond <Int32>
-HealthCheck_UnhealthyThreshold <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

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

-Container <Hashtable>
An object that describes the settings of the containers that will be launched on the container service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContainers
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HealthCheck_HealthyThreshold <Int32>
The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPublicEndpoint_HealthCheck_HealthyThreshold
-HealthCheck_IntervalSecond <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPublicEndpoint_HealthCheck_IntervalSeconds
-HealthCheck_Path <String>
The path on the container on which to perform the health check. The default value is /.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPublicEndpoint_HealthCheck_Path
-HealthCheck_SuccessCode <String>
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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPublicEndpoint_HealthCheck_SuccessCodes
-HealthCheck_TimeoutSecond <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPublicEndpoint_HealthCheck_TimeoutSeconds
-HealthCheck_UnhealthyThreshold <Int32>
The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPublicEndpoint_HealthCheck_UnhealthyThreshold
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ServiceName parameter. The -PassThru parameter is deprecated, use -Select '^ServiceName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PublicEndpoint_ContainerName <String>
The name of the container for the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PublicEndpoint_ContainerPort <Int32>
The port of the container to which traffic is forwarded to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ContainerService'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.CreateContainerServiceDeploymentResponse). Specifying the name of a property of type Amazon.Lightsail.Model.CreateContainerServiceDeploymentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceName <String>
The name of the container service for which to create the deployment.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Lightsail.Model.ContainerService or Amazon.Lightsail.Model.CreateContainerServiceDeploymentResponse
This cmdlet returns an Amazon.Lightsail.Model.ContainerService object. The service call response (type Amazon.Lightsail.Model.CreateContainerServiceDeploymentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z