Class CfnContainerProps

Properties for defining a CfnContainer.

Inheritance

object

CfnContainerProps

Implements

ICfnContainerProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Lightsail

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnContainerProps : ICfnContainerProps

Syntax (vb)

Public Class CfnContainerProps Implements ICfnContainerProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Lightsail;

             var cfnContainerProps = new CfnContainerProps {
                 Power = "power",
                 Scale = 123,
                 ServiceName = "serviceName",

                 // the properties below are optional
                 ContainerServiceDeployment = new ContainerServiceDeploymentProperty {
                     Containers = new [] { new ContainerProperty {
                         Command = new [] { "command" },
                         ContainerName = "containerName",
                         Environment = new [] { new EnvironmentVariableProperty {
                             Value = "value",
                             Variable = "variable"
                         } },
                         Image = "image",
                         Ports = new [] { new PortInfoProperty {
                             Port = "port",
                             Protocol = "protocol"
                         } }
                     } },
                     PublicEndpoint = new PublicEndpointProperty {
                         ContainerName = "containerName",
                         ContainerPort = 123,
                         HealthCheckConfig = new HealthCheckConfigProperty {
                             HealthyThreshold = 123,
                             IntervalSeconds = 123,
                             Path = "path",
                             SuccessCodes = "successCodes",
                             TimeoutSeconds = 123,
                             UnhealthyThreshold = 123
                         }
                     }
                 },
                 IsDisabled = false,
                 PrivateRegistryAccess = new PrivateRegistryAccessProperty {
                     EcrImagePullerRole = new EcrImagePullerRoleProperty {
                         IsActive = false,
                         PrincipalArn = "principalArn"
                     }
                 },
                 PublicDomainNames = new [] { new PublicDomainNameProperty {
                     CertificateName = "certificateName",
                     DomainNames = new [] { "domainNames" }
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnContainerProps()

Properties for defining a CfnContainer.

Properties

ContainerServiceDeployment	An object that describes the current container deployment of the container service.
IsDisabled	A Boolean value indicating whether the container service is disabled.
Power	The power specification of the container service.
PrivateRegistryAccess	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.
PublicDomainNames	The public domain name of the container service, such as `example.com` and `www.example.com` .
Scale	The scale specification of the container service.
ServiceName	The name of the container service.
Tags	An array of key-value pairs to apply to this resource.

Constructors

CfnContainerProps()

Properties for defining a CfnContainer.

public CfnContainerProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Lightsail;

             var cfnContainerProps = new CfnContainerProps {
                 Power = "power",
                 Scale = 123,
                 ServiceName = "serviceName",

                 // the properties below are optional
                 ContainerServiceDeployment = new ContainerServiceDeploymentProperty {
                     Containers = new [] { new ContainerProperty {
                         Command = new [] { "command" },
                         ContainerName = "containerName",
                         Environment = new [] { new EnvironmentVariableProperty {
                             Value = "value",
                             Variable = "variable"
                         } },
                         Image = "image",
                         Ports = new [] { new PortInfoProperty {
                             Port = "port",
                             Protocol = "protocol"
                         } }
                     } },
                     PublicEndpoint = new PublicEndpointProperty {
                         ContainerName = "containerName",
                         ContainerPort = 123,
                         HealthCheckConfig = new HealthCheckConfigProperty {
                             HealthyThreshold = 123,
                             IntervalSeconds = 123,
                             Path = "path",
                             SuccessCodes = "successCodes",
                             TimeoutSeconds = 123,
                             UnhealthyThreshold = 123
                         }
                     }
                 },
                 IsDisabled = false,
                 PrivateRegistryAccess = new PrivateRegistryAccessProperty {
                     EcrImagePullerRole = new EcrImagePullerRoleProperty {
                         IsActive = false,
                         PrincipalArn = "principalArn"
                     }
                 },
                 PublicDomainNames = new [] { new PublicDomainNameProperty {
                     CertificateName = "certificateName",
                     DomainNames = new [] { "domainNames" }
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

ContainerServiceDeployment

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

public object? ContainerServiceDeployment { get; set; }

Property Value

object

Remarks

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

IsDisabled

A Boolean value indicating whether the container service is disabled.

public object? IsDisabled { get; set; }

Property Value

object

Remarks

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

Power

The power specification of the container service.

public string Power { get; set; }

Property Value

string

Remarks

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

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

PrivateRegistryAccess

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.

public object? PrivateRegistryAccess { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-container.html#cfn-lightsail-container-privateregistryaccess

PublicDomainNames

The public domain name of the container service, such as example.com and www.example.com .

public object? PublicDomainNames { get; set; }

Property Value

object

Remarks

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

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

Scale

The scale specification of the container service.

public double Scale { get; set; }

Property Value

double

Remarks

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

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

ServiceName

The name of the container service.

public string ServiceName { get; set; }