CreateInstancesRequest (AWS Java SDK :: Services :: Amazon Lightsail 2.21.12 API)

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.CreateInstancesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateInstancesRequest.Builder,CreateInstancesRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateInstancesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateInstancesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`List<AddOnRequest>`	`addOns()` An array of objects representing the add-ons to enable for the new instance.
`String`	`availabilityZone()` The Availability Zone in which to create your instance.
`String`	`blueprintId()` The ID for a virtual private server image (e.g., `app_wordpress_4_4` or `app_lamp_7_0`).
`static CreateInstancesRequest.Builder`	`builder()`
`String`	`bundleId()` The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., `micro_1_0`).
`String`	`customImageName()` Deprecated.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAddOns()` For responses, this returns true if the service returned a value for the AddOns property.
`int`	`hashCode()`
`boolean`	`hasInstanceNames()` For responses, this returns true if the service returned a value for the InstanceNames property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`List<String>`	`instanceNames()` The names to use for your new Lightsail instances.
`IpAddressType`	`ipAddressType()` The IP address type for the instance.
`String`	`ipAddressTypeAsString()` The IP address type for the instance.
`String`	`keyPairName()` The name of your key pair.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateInstancesRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` The tag keys and optional values to add to the resource during create.
`CreateInstancesRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`userData()` A launch script you can create that configures a server with additional user data.

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
  - hasInstanceNames
```
public final boolean hasInstanceNames()
```
    For responses, this returns true if the service returned a value for the InstanceNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - instanceNames
```
public final List<String> instanceNames()
```
    The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]
    
    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 hasInstanceNames() method.
    
    Returns:
    
    The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]
  - availabilityZone
```
public final String availabilityZone()
```
    The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.
    
    Returns:
    
    The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.
  - customImageName
```
@Deprecated
public final String customImageName()
```
    Deprecated.
    
    (Deprecated) The name for your custom image.
    
    In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
    
    Returns:
    
    (Deprecated) The name for your custom image.
    
    In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
  - blueprintId
```
public final String blueprintId()
```
    The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).
    
    Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
    
    Returns:
    
    The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).
    
    Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
  - bundleId
```
public final String bundleId()
```
    The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
    
    Returns:
    
    The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
  - userData
```
public final String userData()
```
    A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
    
    Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.
    
    Returns:
    
    A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
    
    Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.
  - keyPairName
```
public final String keyPairName()
```
    The name of your key pair.
    
    Returns:
    
    The name of your key pair.
  - 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 the isEmpty() 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
```
public final List<Tag> tags()
```
    The tag keys and optional values to add to the resource during create.
    
    Use the TagResource action to tag a resource after it's created.
    
    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 resource during create.
    
    Use the TagResource action to tag a resource after it's created.
  - hasAddOns
```
public final boolean hasAddOns()
```
    For responses, this returns true if the service returned a value for the AddOns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - addOns
```
public final List<AddOnRequest> addOns()
```
    An array of objects representing the add-ons to enable for the new instance.
    
    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 hasAddOns() method.
    
    Returns:
    
    An array of objects representing the add-ons to enable for the new instance.
  - ipAddressType
```
public final IpAddressType ipAddressType()
```
    The IP address type for the instance.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    The default value is dualstack.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().
    
    Returns:
    
    The IP address type for the instance.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    The default value is dualstack.
    
    See Also:
    
    IpAddressType
  - ipAddressTypeAsString
```
public final String ipAddressTypeAsString()
```
    The IP address type for the instance.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    The default value is dualstack.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().
    
    Returns:
    
    The IP address type for the instance.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    The default value is dualstack.
    
    See Also:
    
    IpAddressType
  - toBuilder
```
public CreateInstancesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateInstancesRequest.Builder,CreateInstancesRequest>
    
    Specified by:
    
    toBuilder in class LightsailRequest
  - builder
```
public static CreateInstancesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateInstancesRequest.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

Class CreateInstancesRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

hasInstanceNames

instanceNames

availabilityZone

customImageName

blueprintId

bundleId

userData

keyPairName

hasTags

tags

hasAddOns

addOns

ipAddressType

ipAddressTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields