Package software.amazon.awscdk.cfnpropertymixins.services.lightsail

Interface CfnContainerMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:01.071Z")
@Stability(Stable)
public interface CfnContainerMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnContainerPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.lightsail.*;
 CfnContainerMixinProps cfnContainerMixinProps = CfnContainerMixinProps.builder()
         .containerServiceDeployment(ContainerServiceDeploymentProperty.builder()
                 .containers(List.of(ContainerProperty.builder()
                         .command(List.of("command"))
                         .containerName("containerName")
                         .environment(List.of(EnvironmentVariableProperty.builder()
                                 .value("value")
                                 .variable("variable")
                                 .build()))
                         .image("image")
                         .ports(List.of(PortInfoProperty.builder()
                                 .port("port")
                                 .protocol("protocol")
                                 .build()))
                         .build()))
                 .publicEndpoint(PublicEndpointProperty.builder()
                         .containerName("containerName")
                         .containerPort(123)
                         .healthCheckConfig(HealthCheckConfigProperty.builder()
                                 .healthyThreshold(123)
                                 .intervalSeconds(123)
                                 .path("path")
                                 .successCodes("successCodes")
                                 .timeoutSeconds(123)
                                 .unhealthyThreshold(123)
                                 .build())
                         .build())
                 .build())
         .isDisabled(false)
         .power("power")
         .privateRegistryAccess(PrivateRegistryAccessProperty.builder()
                 .ecrImagePullerRole(EcrImagePullerRoleProperty.builder()
                         .isActive(false)
                         .principalArn("principalArn")
                         .build())
                 .build())
         .publicDomainNames(List.of(PublicDomainNameProperty.builder()
                 .certificateName("certificateName")
                 .domainNames(List.of("domainNames"))
                 .build()))
         .scale(123)
         .serviceName("serviceName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnContainerMixinProps.Builder	A builder for CfnContainerMixinProps
static final class	CfnContainerMixinProps.Jsii$Proxy	An implementation for CfnContainerMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnContainerMixinProps.Builder	builder()
default Object	getContainerServiceDeployment()	An object that describes the current container deployment of the container service.
default Object	getIsDisabled()	A Boolean value indicating whether the container service is disabled.
default String	getPower()	The power specification of the container service.
default Object	getPrivateRegistryAccess()	An object that describes the configuration for the container service to access private container image repositories, such as ( Amazon ECR ) private repositories.
default Object	getPublicDomainNames()	The public domain name of the container service, such as example.com and www.example.com .
default Number	getScale()	The scale specification of the container service.
default String	getServiceName()	The name of the container service.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerServiceDeployment

@Stability(Stable)
@Nullable
default Object getContainerServiceDeployment()

An object that describes the current container deployment of the container service.

Returns union: either IResolvable or CfnContainerPropsMixin.ContainerServiceDeploymentProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-containerservicedeployment

getIsDisabled

@Stability(Stable)
@Nullable
default Object getIsDisabled()

A Boolean value indicating whether the container service is disabled.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-isdisabled

getPower

@Stability(Stable)
@Nullable
default String getPower()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-power

getPrivateRegistryAccess

@Stability(Stable)
@Nullable
default Object getPrivateRegistryAccess()

An object that describes the configuration for the container service to access private container image repositories, such as ( 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 .

Returns union: either IResolvable or CfnContainerPropsMixin.PrivateRegistryAccessProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-privateregistryaccess

getPublicDomainNames

@Stability(Stable)
@Nullable
default Object getPublicDomainNames()

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 that is 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 AWS::Lightsail::Certificate resource to create a certificate for the public domain names that you want to use with your container service.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnContainerPropsMixin.PublicDomainNameProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-publicdomainnames

getScale

@Stability(Stable)
@Nullable
default Number getScale()

The scale specification of the container service.

The scale specifies the allocated compute nodes of the container service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-scale

getServiceName

@Stability(Stable)
@Nullable
default String getServiceName()

The name of the container service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-servicename

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag in the AWS CloudFormation User Guide .

The Value of Tags is optional for Lightsail resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-tags

builder

@Stability(Stable)
static CfnContainerMixinProps.Builder builder()

Returns:

a CfnContainerMixinProps.Builder of CfnContainerMixinProps