Class CfnContainer

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnContainer

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Lightsail

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnContainer : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnContainer Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

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 cfnContainer = new CfnContainer(this, "MyCfnContainer", 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

CfnContainer(Construct, string, ICfnContainerProps)

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

Properties

AttrContainerArn	The Amazon Resource Name (ARN) of the container.
AttrPrincipalArn	The principle Amazon Resource Name (ARN) of the role.
AttrPrivateRegistryAccessEcrImagePullerRolePrincipalArn	The principle Amazon Resource Name (ARN) of the role.
AttrUrl	The publicly accessible URL of the container service.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::Lightsail::Container resource specifies a container service.
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	Tag Manager which manages the tags for this resource.
TagsRaw	An array of key-value pairs to apply to this resource.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::Lightsail::Container resource specifies a container service.

Constructors

CfnContainer(Construct, string, ICfnContainerProps)

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

public CfnContainer(Construct scope, string id, ICfnContainerProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnContainerProps

Resource properties.

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

Properties

AttrContainerArn

The Amazon Resource Name (ARN) of the container.

public virtual string AttrContainerArn { get; }

Property Value

string

Remarks

CloudformationAttribute: ContainerArn

AttrPrincipalArn

The principle Amazon Resource Name (ARN) of the role.

public virtual string AttrPrincipalArn { get; }

Property Value

string

Remarks

CloudformationAttribute: PrincipalArn

AttrPrivateRegistryAccessEcrImagePullerRolePrincipalArn

The principle Amazon Resource Name (ARN) of the role.

public virtual string AttrPrivateRegistryAccessEcrImagePullerRolePrincipalArn { get; }

Property Value

string

Remarks

CloudformationAttribute: PrivateRegistryAccess.EcrImagePullerRole.PrincipalArn

AttrUrl

The publicly accessible URL of the container service.

public virtual string AttrUrl { get; }

Property Value

string

Remarks

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

CloudformationAttribute: Url

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

ContainerServiceDeployment

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

public virtual object? ContainerServiceDeployment { get; set; }

Property Value

object

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

IsDisabled

A Boolean value indicating whether the container service is disabled.

public virtual object? IsDisabled { get; set; }

Property Value

object

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

Power

The power specification of the container service.

public virtual string Power { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

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 virtual object? PrivateRegistryAccess { get; set; }

Property Value

object

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

PublicDomainNames

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

public virtual object? PublicDomainNames { get; set; }

Property Value

object

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

Scale

The scale specification of the container service.

public virtual double Scale { get; set; }

Property Value

double

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

ServiceName

The name of the container service.

public virtual string ServiceName { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

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

CloudformationResource: AWS::Lightsail::Container

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable