Package software.amazon.awscdk.cfnpropertymixins.services.lightsail

Class CfnContainerPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.lightsail.CfnContainerPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerPropsMixin>

Enclosing class:

CfnContainerPropsMixin

@Stability(Stable)
public static final class CfnContainerPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnContainerPropsMixin>

A fluent builder for CfnContainerPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnContainerPropsMixin	build()
CfnContainerPropsMixin.Builder	containerServiceDeployment(CfnContainerPropsMixin.ContainerServiceDeploymentProperty containerServiceDeployment)	An object that describes the current container deployment of the container service.
CfnContainerPropsMixin.Builder	containerServiceDeployment(IResolvable containerServiceDeployment)	An object that describes the current container deployment of the container service.
static CfnContainerPropsMixin.Builder	create()
static CfnContainerPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnContainerPropsMixin.Builder	isDisabled(Boolean isDisabled)	A Boolean value indicating whether the container service is disabled.
CfnContainerPropsMixin.Builder	isDisabled(IResolvable isDisabled)	A Boolean value indicating whether the container service is disabled.
CfnContainerPropsMixin.Builder	power(String power)	The power specification of the container service.
CfnContainerPropsMixin.Builder	privateRegistryAccess(CfnContainerPropsMixin.PrivateRegistryAccessProperty privateRegistryAccess)	An object that describes the configuration for the container service to access private container image repositories, such as ( Amazon ECR ) private repositories.
CfnContainerPropsMixin.Builder	privateRegistryAccess(IResolvable privateRegistryAccess)	An object that describes the configuration for the container service to access private container image repositories, such as ( Amazon ECR ) private repositories.
CfnContainerPropsMixin.Builder	publicDomainNames(List<? extends Object> publicDomainNames)	The public domain name of the container service, such as example.com and www.example.com .
CfnContainerPropsMixin.Builder	publicDomainNames(IResolvable publicDomainNames)	The public domain name of the container service, such as example.com and www.example.com .
CfnContainerPropsMixin.Builder	scale(Number scale)	The scale specification of the container service.
CfnContainerPropsMixin.Builder	serviceName(String serviceName)	The name of the container service.
CfnContainerPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnContainerPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnContainerPropsMixin.Builder.

create

@Stability(Stable)
public static CfnContainerPropsMixin.Builder create()

Returns:

a new instance of CfnContainerPropsMixin.Builder.

containerServiceDeployment

@Stability(Stable)
public CfnContainerPropsMixin.Builder containerServiceDeployment(IResolvable containerServiceDeployment)

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

Parameters:

containerServiceDeployment - An object that describes the current container deployment of the container service. This parameter is required.

Returns:

this

See Also:

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

containerServiceDeployment

@Stability(Stable)
public CfnContainerPropsMixin.Builder containerServiceDeployment(CfnContainerPropsMixin.ContainerServiceDeploymentProperty containerServiceDeployment)

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

Parameters:

containerServiceDeployment - An object that describes the current container deployment of the container service. This parameter is required.

Returns:

this

See Also:

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

isDisabled

@Stability(Stable)
public CfnContainerPropsMixin.Builder isDisabled(Boolean isDisabled)

A Boolean value indicating whether the container service is disabled.

Parameters:

isDisabled - A Boolean value indicating whether the container service is disabled. This parameter is required.

Returns:

this

See Also:

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

isDisabled

@Stability(Stable)
public CfnContainerPropsMixin.Builder isDisabled(IResolvable isDisabled)

A Boolean value indicating whether the container service is disabled.

Parameters:

isDisabled - A Boolean value indicating whether the container service is disabled. This parameter is required.

Returns:

this

See Also:

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

power

@Stability(Stable)
public CfnContainerPropsMixin.Builder power(String 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.

Parameters:

power - The power specification of the container service. This parameter is required.

Returns:

this

See Also:

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

privateRegistryAccess

@Stability(Stable)
public CfnContainerPropsMixin.Builder privateRegistryAccess(IResolvable privateRegistryAccess)

An object that describes the configuration for the container service to access private container image repositories, such as ( Amazon ECR ) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide .

Parameters:

privateRegistryAccess - An object that describes the configuration for the container service to access private container image repositories, such as ( Amazon ECR ) private repositories. This parameter is required.

Returns:

this

See Also:

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

privateRegistryAccess

@Stability(Stable)
public CfnContainerPropsMixin.Builder privateRegistryAccess(CfnContainerPropsMixin.PrivateRegistryAccessProperty privateRegistryAccess)

An object that describes the configuration for the container service to access private container image repositories, such as ( Amazon ECR ) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide .

Parameters:

privateRegistryAccess - An object that describes the configuration for the container service to access private container image repositories, such as ( Amazon ECR ) private repositories. This parameter is required.

Returns:

this

See Also:

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

publicDomainNames

@Stability(Stable)
public CfnContainerPropsMixin.Builder publicDomainNames(IResolvable publicDomainNames)

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.

Parameters:

publicDomainNames - The public domain name of the container service, such as example.com and www.example.com . This parameter is required.

Returns:

this

See Also:

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

publicDomainNames

@Stability(Stable)
public CfnContainerPropsMixin.Builder publicDomainNames(List<? extends Object> publicDomainNames)

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.

Parameters:

publicDomainNames - The public domain name of the container service, such as example.com and www.example.com . This parameter is required.

Returns:

this

See Also:

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

scale

@Stability(Stable)
public CfnContainerPropsMixin.Builder scale(Number scale)

The scale specification of the container service.

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

Parameters:

scale - The scale specification of the container service. This parameter is required.

Returns:

this

See Also:

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

serviceName

@Stability(Stable)
public CfnContainerPropsMixin.Builder serviceName(String serviceName)

The name of the container service.

Parameters:

serviceName - The name of the container service. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnContainerPropsMixin.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnContainerPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnContainerPropsMixin>

Returns:

a newly built instance of CfnContainerPropsMixin.