Class CfnContainer
The AWS::Lightsail::Container
resource specifies a container service.
Inherited Members
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnContainer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnContainer(Construct, String, ICfnContainerProps) |
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 | |
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 |
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>) |
Constructors
CfnContainer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnContainer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnContainer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnContainer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnContainer(Construct, String, ICfnContainerProps)
public CfnContainer(Construct scope, string id, ICfnContainerProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnContainerProps
Resource properties.
Properties
AttrContainerArn
The Amazon Resource Name (ARN) of the container.
public virtual string AttrContainerArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ContainerArn
AttrPrincipalArn
The principle Amazon Resource Name (ARN) of the role.
public virtual string AttrPrincipalArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: PrincipalArn
AttrPrivateRegistryAccessEcrImagePullerRolePrincipalArn
The principle Amazon Resource Name (ARN) of the role.
public virtual string AttrPrivateRegistryAccessEcrImagePullerRolePrincipalArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: PrivateRegistryAccess.EcrImagePullerRole.PrincipalArn
AttrUrl
The publicly accessible URL of the container service.
public virtual string AttrUrl { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ContainerServiceDeployment
An object that describes the current container deployment of the container service.
public virtual object ContainerServiceDeployment { get; set; }
Property Value
System.Object
IsDisabled
A Boolean value indicating whether the container service is disabled.
public virtual object IsDisabled { get; set; }
Property Value
System.Object
Power
The power specification of the container service.
public virtual string Power { get; set; }
Property Value
System.String
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
System.Object
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
System.Object
Scale
The scale specification of the container service.
public virtual double Scale { get; set; }
Property Value
System.Double
ServiceName
The name of the container service.
public virtual string ServiceName { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>