software.amazon.awssdk.services.lightsail.model

Class CreateContainerServiceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.CreateContainerServiceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateContainerServiceRequest.Builder,CreateContainerServiceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateContainerServiceRequest
extends LightsailRequest
implements ToCopyableBuilder<CreateContainerServiceRequest.Builder,CreateContainerServiceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateContainerServiceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateContainerServiceRequest.Builder	builder()
ContainerServiceDeploymentRequest	deployment() An object that describes a deployment for the container service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPublicDomainNames() Returns true if the PublicDomainNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
ContainerServicePowerName	power() The power specification for the container service.
String	powerAsString() The power specification for the container service.
Map<String,List<String>>	publicDomainNames() The public domain names to use with the container service, such as example.com and www.example.com.
Integer	scale() The scale specification for the container service.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateContainerServiceRequest.Builder>	serializableBuilderClass()
String	serviceName() The name for the container service.
List<Tag>	tags() The tag keys and optional values for the container service.
CreateContainerServiceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

serviceName

public final String serviceName()

The name for the container service.

The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) AWS region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com

The following are the requirements for container service names:

• Must be unique within each AWS Region in your Lightsail account.

• Must contain 1 to 63 characters.

• Must contain only alphanumeric characters and hyphens.

• A hyphen (-) can separate words but cannot be at the start or end of the name.

Returns:

The name for the container service.

The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) AWS region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com

The following are the requirements for container service names:

• Must be unique within each AWS Region in your Lightsail account.

• Must contain 1 to 63 characters.

• Must contain only alphanumeric characters and hyphens.

• A hyphen (-) can separate words but cannot be at the start or end of the name.

power

public final ContainerServicePowerName power()

The power specification for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

If the service returns an enum value that is not available in the current SDK version, power will return ContainerServicePowerName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from powerAsString().

Returns:

The power specification for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

See Also:

ContainerServicePowerName

powerAsString

public final String powerAsString()

The power specification for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

If the service returns an enum value that is not available in the current SDK version, power will return ContainerServicePowerName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from powerAsString().

Returns:

The power specification for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

See Also:

ContainerServicePowerName

scale

public final Integer scale()

The scale specification for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Returns:

The scale specification for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

The tag keys and optional values for the container service.

For more information about tags in Lightsail, see the Lightsail Dev Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The tag keys and optional values for the container service.

For more information about tags in Lightsail, see the Lightsail Dev Guide.

hasPublicDomainNames

public final boolean hasPublicDomainNames()

Returns true if the PublicDomainNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

publicDomainNames

public final Map<String,List<String>> publicDomainNames()

The public domain names to use with 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 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 CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

You can specify public domain names using a string to array map as shown in the example later on this page.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPublicDomainNames() to see if a value was sent in this field.

Returns:

The public domain names to use with 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 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 CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

You can specify public domain names using a string to array map as shown in the example later on this page.

deployment

public final ContainerServiceDeploymentRequest deployment()

An object that describes a deployment for the container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

Returns:

An object that describes a deployment for the container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

toBuilder

public CreateContainerServiceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateContainerServiceRequest.Builder,CreateContainerServiceRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static CreateContainerServiceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateContainerServiceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo