Package software.amazon.awscdk.services.lightsail

Class CfnContainer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.lightsail.CfnContainer
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.714Z") @Stability(Stable) public class CfnContainer extends CfnResource implements IInspectable
A CloudFormation AWS::Lightsail::Container.

The AWS::Lightsail::Container resource specifies a container service.

A Lightsail container service is a compute resource to which you can deploy containers.

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.*;
 CfnContainer cfnContainer = CfnContainer.Builder.create(this, "MyCfnContainer")
         .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)
         .publicDomainNames(List.of(PublicDomainNameProperty.builder()
                 .certificateName("certificateName")
                 .domainNames(List.of("domainNames"))
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnContainer

      protected CfnContainer(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnContainer

      protected CfnContainer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnContainer

      @Stability(Stable) public CfnContainer(@NotNull Construct scope, @NotNull String id, @NotNull CfnContainerProps props)
      Create a new AWS::Lightsail::Container.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrContainerArn

      @Stability(Stable) @NotNull public String getAttrContainerArn()
      The Amazon Resource Name (ARN) of the container.

    • getAttrUrl

      @Stability(Stable) @NotNull public String getAttrUrl()
      The publicly accessible URL of the container service.

      If no public endpoint is specified in the current deployment, this URL returns a 404 response.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

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

    • getPower

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

    • setPower

      @Stability(Stable) public void setPower(@NotNull String value)
      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.

    • getScale

      @Stability(Stable) @NotNull public Number getScale()
      The scale specification of the container service.

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

    • setScale

      @Stability(Stable) public void setScale(@NotNull Number value)
      The scale specification of the container service.

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

    • getServiceName

      @Stability(Stable) @NotNull public String getServiceName()
      The name of the container service.

    • setServiceName

      @Stability(Stable) public void setServiceName(@NotNull String value)
      The name of the container service.

    • getContainerServiceDeployment

      @Stability(Stable) @Nullable public Object getContainerServiceDeployment()
      An object that describes the current container deployment of the container service.

    • setContainerServiceDeployment

      @Stability(Stable) public void setContainerServiceDeployment(@Nullable IResolvable value)
      An object that describes the current container deployment of the container service.

    • setContainerServiceDeployment

      @Stability(Stable) public void setContainerServiceDeployment(@Nullable CfnContainer.ContainerServiceDeploymentProperty value)
      An object that describes the current container deployment of the container service.

    • getIsDisabled

      @Stability(Stable) @Nullable public Object getIsDisabled()
      A Boolean value indicating whether the container service is disabled.

    • setIsDisabled

      @Stability(Stable) public void setIsDisabled(@Nullable Boolean value)
      A Boolean value indicating whether the container service is disabled.

    • setIsDisabled

      @Stability(Stable) public void setIsDisabled(@Nullable IResolvable value)
      A Boolean value indicating whether the container service is disabled.

    • getPublicDomainNames

      @Stability(Stable) @Nullable public 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.

    • setPublicDomainNames

      @Stability(Stable) public void setPublicDomainNames(@Nullable IResolvable value)
      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.

    • setPublicDomainNames

      @Stability(Stable) public void setPublicDomainNames(@Nullable List<Object> value)
      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.