Package software.amazon.awscdk.services.lightsail

Interface CfnContainer.ContainerProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainer.ContainerProperty.Jsii$Proxy

Enclosing class:

CfnContainer

@Stability(Stable)
public static interface CfnContainer.ContainerProperty
extends software.amazon.jsii.JsiiSerializable

Container is a property of the ContainerServiceDeployment property. It describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

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.*;
 ContainerProperty containerProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnContainer.ContainerProperty.Builder	builder()
default List<String>	getCommand()	The launch command for the container.
default String	getContainerName()	The name of the container.
default Object	getEnvironment()	The environment variables of the container.
default String	getImage()	The name of the image used for the container.
default Object	getPorts()	An object that describes the open firewall ports and protocols of the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCommand

@Stability(Stable)
@Nullable
default List<String> getCommand()

The launch command for the container.

See Also:

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

getContainerName

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

The name of the container.

See Also:

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

getEnvironment

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

The environment variables of the container.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnContainer.EnvironmentVariableProperty>

See Also:

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

getImage

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

The name of the image used for the container.

Container images that are sourced from (registered and stored on) your container service start with a colon ( : ). For example, if your container service name is container-service-1 , the container image label is mystaticsite , and you want to use the third version ( 3 ) of the registered container image, then you should specify :container-service-1.mystaticsite.3 . To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest ). Your container service will automatically use the highest numbered version of the registered container image.

Container images that are sourced from a public registry like Docker Hub don’t start with a colon. For example, nginx:latest or nginx .

See Also:

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

getPorts

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

An object that describes the open firewall ports and protocols of the container.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnContainer.PortInfoProperty>

See Also:

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

builder

@Stability(Stable)
static CfnContainer.ContainerProperty.Builder builder()

Returns:

a CfnContainer.ContainerProperty.Builder of CfnContainer.ContainerProperty