interface PublicEndpointProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Lightsail.CfnContainer.PublicEndpointProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslightsail#CfnContainer_PublicEndpointProperty`
Java	`software.amazon.awscdk.services.lightsail.CfnContainer.PublicEndpointProperty`
Python	`aws_cdk.aws_lightsail.CfnContainer.PublicEndpointProperty`
TypeScript	`aws-cdk-lib` » `aws_lightsail` » `CfnContainer` » `PublicEndpointProperty`

PublicEndpoint is a property of the ContainerServiceDeployment property. It describes describes the settings of the public endpoint of a container on a container service.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lightsail as lightsail } from 'aws-cdk-lib';
const publicEndpointProperty: lightsail.CfnContainer.PublicEndpointProperty = {
  containerName: 'containerName',
  containerPort: 123,
  healthCheckConfig: {
    healthyThreshold: 123,
    intervalSeconds: 123,
    path: 'path',
    successCodes: 'successCodes',
    timeoutSeconds: 123,
    unhealthyThreshold: 123,
  },
};

Properties

Name	Type	Description
containerName?	`string`	The name of the container entry of the deployment that the endpoint configuration applies to.
containerPort?	`number`	The port of the specified container to which traffic is forwarded to.
healthCheckConfig?	`IResolvable` `\|` `HealthCheckConfigProperty`	An object that describes the health check configuration of the container.

containerName?

Type: string (optional)

The name of the container entry of the deployment that the endpoint configuration applies to.

containerPort?

Type: number (optional)

The port of the specified container to which traffic is forwarded to.

healthCheckConfig?

Type: IResolvable | HealthCheckConfigProperty (optional)

An object that describes the health check configuration of the container.