software.amazon.awscdk.services.lightsail

Class CfnContainer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lightsail.CfnContainer

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.634Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnContainer.Builder A fluent builder for CfnContainer.
static interface	CfnContainer.ContainerProperty `Container` is a property of the [ContainerServiceDeployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-containerservicedeployment.html) property.
static interface	CfnContainer.ContainerServiceDeploymentProperty `ContainerServiceDeployment` is a property of the [AWS::Lightsail::Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html) resource.
static interface	CfnContainer.EnvironmentVariableProperty `EnvironmentVariable` is a property of the [Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html) property.
static interface	CfnContainer.HealthCheckConfigProperty `HealthCheckConfig` is a property of the [PublicEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-publicendpoint.html) property.
static interface	CfnContainer.PortInfoProperty `PortInfo` is a property of the [Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-container.html) property.
static interface	CfnContainer.PublicDomainNameProperty `PublicDomainName` is a property of the [AWS::Lightsail::Container](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html) resource.
static interface	CfnContainer.PublicEndpointProperty `PublicEndpoint` is a property of the [ContainerServiceDeployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-containerservicedeployment.html) property.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnContainer(software.constructs.Construct scope, String id, CfnContainerProps props) Create a new `AWS::Lightsail::Container`.
protected	CfnContainer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnContainer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrContainerArn() The Amazon Resource Name (ARN) of the container.
String	getAttrUrl() The publicly accessible URL of the container service.
protected Map<String,Object>	getCfnProperties()
Object	getContainerServiceDeployment() An object that describes the current container deployment of the container service.
Object	getIsDisabled() A Boolean value indicating whether the container service is disabled.
String	getPower() The power specification of the container service.
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.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContainerServiceDeployment(CfnContainer.ContainerServiceDeploymentProperty value) An object that describes the current container deployment of the container service.
void	setContainerServiceDeployment(IResolvable value) An object that describes the current container deployment of the container service.
void	setIsDisabled(Boolean value) A Boolean value indicating whether the container service is disabled.
void	setIsDisabled(IResolvable value) A Boolean value indicating whether the container service is disabled.
void	setPower(String value) The power specification of the container service.
void	setPublicDomainNames(IResolvable value) The public domain name of the container service, such as `example.com` and `www.example.com` .
void	setPublicDomainNames(List<Object> value) The public domain name of the container service, such as `example.com` and `www.example.com` .
void	setScale(Number value) The scale specification of the container service.
void	setServiceName(String value) The name of the container service.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnContainer

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

CfnContainer

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

CfnContainer

@Stability(value=Stable)
public CfnContainer(@NotNull
                                             software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrContainerArn()

The Amazon Resource Name (ARN) of the container.

getAttrUrl

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @NotNull
public String getServiceName()

The name of the container service.

setServiceName

@Stability(value=Stable)
public void setServiceName(@NotNull
                                                    String value)

The name of the container service.

getContainerServiceDeployment

@Stability(value=Stable)
 @Nullable
public Object getContainerServiceDeployment()

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

setContainerServiceDeployment

@Stability(value=Stable)
public void setContainerServiceDeployment(@Nullable
                                                                   CfnContainer.ContainerServiceDeploymentProperty value)

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

setContainerServiceDeployment

@Stability(value=Stable)
public void setContainerServiceDeployment(@Nullable
                                                                   IResolvable value)

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

getIsDisabled

@Stability(value=Stable)
 @Nullable
public Object getIsDisabled()

A Boolean value indicating whether the container service is disabled.

setIsDisabled

@Stability(value=Stable)
public void setIsDisabled(@Nullable
                                                   Boolean value)

A Boolean value indicating whether the container service is disabled.

setIsDisabled

@Stability(value=Stable)
public void setIsDisabled(@Nullable
                                                   IResolvable value)

A Boolean value indicating whether the container service is disabled.

getPublicDomainNames

@Stability(value=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(value=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(value=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.