Class CreateContainerServiceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateContainerServiceRequest.Builder,
CreateContainerServiceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
An object that describes a deployment for the container service.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PublicDomainNames property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.power()
The power specification for the container service.final String
The power specification for the container service.An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.The public domain names to use with the container service, such asexample.com
andwww.example.com
.final Integer
scale()
The scale specification for the container service.static Class
<? extends CreateContainerServiceRequest.Builder> final String
The name for the container service.tags()
The tag keys and optional values to add to the container service during create.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 iscontainer-service-1
, and it's located in the US East (Ohio) Amazon Web Services 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 Amazon Web Services 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 iscontainer-service-1
, and it's located in the US East (Ohio) Amazon Web Services 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 Amazon Web Services 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
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
andscale
of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of thepower
with thescale
(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 returnContainerServicePowerName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompowerAsString()
.- 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
andscale
of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of thepower
with thescale
(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:
-
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
andscale
of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of thepower
with thescale
(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 returnContainerServicePowerName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompowerAsString()
.- 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
andscale
of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of thepower
with thescale
(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:
-
scale
The scale specification for the container service.
The scale specifies the allocated compute nodes of the container service. The
power
andscale
of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of thepower
with thescale
(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
andscale
of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of thepower
with thescale
(the number of nodes) of the service.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The tag keys and optional values to add to the container service during create.
Use the
TagResource
action to tag a resource after it's created.For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The tag keys and optional values to add to the container service during create.
Use the
TagResource
action to tag a resource after it's created.For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
-
hasPublicDomainNames
public final boolean hasPublicDomainNames()For responses, this returns true if the service returned a value for the PublicDomainNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
publicDomainNames
The public domain names to use with the container service, such as
example.com
andwww.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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPublicDomainNames()
method.- Returns:
- The public domain names to use with the container service, such as
example.com
andwww.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
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.
-
privateRegistryAccess
An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (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.
- Returns:
- An object to describe the configuration for the container service to access private container image
repositories, such as Amazon Elastic Container Registry (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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateContainerServiceRequest.Builder,
CreateContainerServiceRequest> - Specified by:
toBuilder
in classLightsailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-