CfnContainerProps

class aws_cdk.aws_lightsail.CfnContainerProps(*, power, scale, service_name, container_service_deployment=None, is_disabled=None, public_domain_names=None, tags=None)

Bases: object

Properties for defining a CfnContainer.

Parameters
  • power (str) – 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.

  • scale (Union[int, float]) – The scale specification of the container service. The scale specifies the allocated compute nodes of the container service.

  • service_name (str) – The name of the container service.

  • container_service_deployment (Union[IResolvable, ContainerServiceDeploymentProperty, Dict[str, Any], None]) – An object that describes the current container deployment of the container service.

  • is_disabled (Union[bool, IResolvable, None]) – A Boolean value indicating whether the container service is disabled.

  • public_domain_names (Union[IResolvable, Sequence[Union[IResolvable, PublicDomainNameProperty, Dict[str, Any]]], None]) – 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. .. epigraph:: 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.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag in the AWS CloudFormation User Guide . .. epigraph:: The Value of Tags is optional for Lightsail resources.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_lightsail as lightsail

cfn_container_props = lightsail.CfnContainerProps(
    power="power",
    scale=123,
    service_name="serviceName",

    # the properties below are optional
    container_service_deployment=lightsail.CfnContainer.ContainerServiceDeploymentProperty(
        containers=[lightsail.CfnContainer.ContainerProperty(
            command=["command"],
            container_name="containerName",
            environment=[lightsail.CfnContainer.EnvironmentVariableProperty(
                value="value",
                variable="variable"
            )],
            image="image",
            ports=[lightsail.CfnContainer.PortInfoProperty(
                port="port",
                protocol="protocol"
            )]
        )],
        public_endpoint=lightsail.CfnContainer.PublicEndpointProperty(
            container_name="containerName",
            container_port=123,
            health_check_config=lightsail.CfnContainer.HealthCheckConfigProperty(
                healthy_threshold=123,
                interval_seconds=123,
                path="path",
                success_codes="successCodes",
                timeout_seconds=123,
                unhealthy_threshold=123
            )
        )
    ),
    is_disabled=False,
    public_domain_names=[lightsail.CfnContainer.PublicDomainNameProperty(
        certificate_name="certificateName",
        domain_names=["domainNames"]
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

container_service_deployment

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

Link

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

Return type

Union[IResolvable, ContainerServiceDeploymentProperty, None]

is_disabled

A Boolean value indicating whether the container service is disabled.

Link

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

Return type

Union[bool, IResolvable, None]

power

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.

Link

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

Return type

str

public_domain_names

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. .. epigraph:

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 <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-certificate.html>`_ resource to create a certificate for the public domain names that you want to use with your container service.
Link

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

Return type

Union[IResolvable, List[Union[IResolvable, PublicDomainNameProperty]], None]

scale

The scale specification of the container service.

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

Link

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

Return type

Union[int, float]

service_name

The name of the container service.

Link

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

Return type

str

tags

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

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

The ``Value`` of ``Tags`` is optional for Lightsail resources.
Link

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

Return type

Optional[List[CfnTag]]