Package software.amazon.awscdk.services.lightsail

Interface CfnContainerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:01.366Z")
@Stability(Stable)
public interface CfnContainerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnContainer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lightsail.*;
 CfnContainerProps cfnContainerProps = CfnContainerProps.builder()
         .power("power")
         .scale(123)
         .serviceName("serviceName")
         // the properties below are optional
         .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)
         .privateRegistryAccess(PrivateRegistryAccessProperty.builder()
                 .ecrImagePullerRole(EcrImagePullerRoleProperty.builder()
                         .isActive(false)
                         .principalArn("principalArn")
                         .build())
                 .build())
         .publicDomainNames(List.of(PublicDomainNameProperty.builder()
                 .certificateName("certificateName")
                 .domainNames(List.of("domainNames"))
                 .build()))
         .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	CfnContainerProps.Builder	A builder for CfnContainerProps
static final class	CfnContainerProps.Jsii$Proxy	An implementation for CfnContainerProps

Method Summary

Modifier and Type	Method	Description
static CfnContainerProps.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.
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 Elastic Container Registry ( Amazon ECR ) private repositories.
default Object	getPublicDomainNames()	The public domain name of the container service, such as example.com and www.example.com .
Number	getScale()	The scale specification of the container service.
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

getPower

@Stability(Stable)
@NotNull
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

getScale

@Stability(Stable)
@NotNull
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)
@NotNull
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

getContainerServiceDeployment

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

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

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.

See Also:

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

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 Elastic Container Registry ( 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 .

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.

See Also:

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

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 CfnContainerProps.Builder builder()

Returns:

a CfnContainerProps.Builder of CfnContainerProps