Interface CreateInstancesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateInstancesRequest.Builder,CreateInstancesRequest>,LightsailRequest.Builder,SdkBuilder<CreateInstancesRequest.Builder,CreateInstancesRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateInstancesRequest
public static interface CreateInstancesRequest.Builder extends LightsailRequest.Builder, SdkPojo, CopyableBuilder<CreateInstancesRequest.Builder,CreateInstancesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description CreateInstancesRequest.BuilderaddOns(Collection<AddOnRequest> addOns)An array of objects representing the add-ons to enable for the new instance.CreateInstancesRequest.BuilderaddOns(Consumer<AddOnRequest.Builder>... addOns)An array of objects representing the add-ons to enable for the new instance.CreateInstancesRequest.BuilderaddOns(AddOnRequest... addOns)An array of objects representing the add-ons to enable for the new instance.CreateInstancesRequest.BuilderavailabilityZone(String availabilityZone)The Availability Zone in which to create your instance.CreateInstancesRequest.BuilderblueprintId(String blueprintId)The ID for a virtual private server image (app_wordpress_4_4orapp_lamp_7_0).CreateInstancesRequest.BuilderbundleId(String bundleId)The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_1_0).CreateInstancesRequest.BuildercustomImageName(String customImageName)Deprecated.CreateInstancesRequest.BuilderinstanceNames(String... instanceNames)The names to use for your new Lightsail instances.CreateInstancesRequest.BuilderinstanceNames(Collection<String> instanceNames)The names to use for your new Lightsail instances.CreateInstancesRequest.BuilderipAddressType(String ipAddressType)The IP address type for the instance.CreateInstancesRequest.BuilderipAddressType(IpAddressType ipAddressType)The IP address type for the instance.CreateInstancesRequest.BuilderkeyPairName(String keyPairName)The name of your key pair.CreateInstancesRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateInstancesRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateInstancesRequest.Buildertags(Collection<Tag> tags)The tag keys and optional values to add to the resource during create.CreateInstancesRequest.Buildertags(Consumer<Tag.Builder>... tags)The tag keys and optional values to add to the resource during create.CreateInstancesRequest.Buildertags(Tag... tags)The tag keys and optional values to add to the resource during create.CreateInstancesRequest.BuilderuserData(String userData)A launch script you can create that configures a server with additional user data.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.lightsail.model.LightsailRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
instanceNames
CreateInstancesRequest.Builder instanceNames(Collection<String> instanceNames)
The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example:
["MyFirstInstance","MySecondInstance"]- Parameters:
instanceNames- The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example:["MyFirstInstance","MySecondInstance"]- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceNames
CreateInstancesRequest.Builder instanceNames(String... instanceNames)
The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example:
["MyFirstInstance","MySecondInstance"]- Parameters:
instanceNames- The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example:["MyFirstInstance","MySecondInstance"]- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZone
CreateInstancesRequest.Builder availabilityZone(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 theinclude Availability Zonesparameter to your request.- Parameters:
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 theinclude Availability Zonesparameter to your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customImageName
@Deprecated CreateInstancesRequest.Builder customImageName(String customImageName)
Deprecated.(Discontinued) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.
- Parameters:
customImageName- (Discontinued) The name for your custom image.In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blueprintId
CreateInstancesRequest.Builder blueprintId(String blueprintId)
The ID for a virtual private server image (
app_wordpress_4_4orapp_lamp_7_0). Use theget blueprintsoperation 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.
- Parameters:
blueprintId- The ID for a virtual private server image (app_wordpress_4_4orapp_lamp_7_0). Use theget blueprintsoperation 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:
- Returns a reference to this object so that method calls can be chained together.
-
bundleId
CreateInstancesRequest.Builder bundleId(String bundleId)
The bundle of specification information for your virtual private server (or instance), including the pricing plan (
micro_1_0).- Parameters:
bundleId- The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_1_0).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userData
CreateInstancesRequest.Builder userData(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 useapt-get, and FreeBSD usespkg. For a complete list, see the Amazon Lightsail Developer Guide.- Parameters:
userData- A launch script you can create that configures a server with additional user data. For example, you might want to runapt-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 useapt-get, and FreeBSD usespkg. For a complete list, see the Amazon Lightsail Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyPairName
CreateInstancesRequest.Builder keyPairName(String keyPairName)
The name of your key pair.
- Parameters:
keyPairName- The name of your key pair.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateInstancesRequest.Builder tags(Collection<Tag> tags)
The tag keys and optional values to add to the resource during create.
Use the
TagResourceaction to tag a resource after it's created.- Parameters:
tags- The tag keys and optional values to add to the resource during create.Use the
TagResourceaction to tag a resource after it's created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateInstancesRequest.Builder tags(Tag... tags)
The tag keys and optional values to add to the resource during create.
Use the
TagResourceaction to tag a resource after it's created.- Parameters:
tags- The tag keys and optional values to add to the resource during create.Use the
TagResourceaction to tag a resource after it's created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateInstancesRequest.Builder tags(Consumer<Tag.Builder>... tags)
The tag keys and optional values to add to the resource during create.
Use the
This is a convenience method that creates an instance of theTagResourceaction to tag a resource after it's created.Tag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
addOns
CreateInstancesRequest.Builder addOns(Collection<AddOnRequest> addOns)
An array of objects representing the add-ons to enable for the new instance.
- Parameters:
addOns- An array of objects representing the add-ons to enable for the new instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addOns
CreateInstancesRequest.Builder addOns(AddOnRequest... addOns)
An array of objects representing the add-ons to enable for the new instance.
- Parameters:
addOns- An array of objects representing the add-ons to enable for the new instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addOns
CreateInstancesRequest.Builder addOns(Consumer<AddOnRequest.Builder>... addOns)
An array of objects representing the add-ons to enable for the new instance.
This is a convenience method that creates an instance of theAddOnRequest.Builderavoiding the need to create one manually viaAddOnRequest.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#addOns(List.) - Parameters:
addOns- a consumer that will call methods onAddOnRequest.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#addOns(java.util.Collection)
-
ipAddressType
CreateInstancesRequest.Builder ipAddressType(String ipAddressType)
The IP address type for the instance.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack.- Parameters:
ipAddressType- The IP address type for the instance.The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IpAddressType,IpAddressType
-
ipAddressType
CreateInstancesRequest.Builder ipAddressType(IpAddressType ipAddressType)
The IP address type for the instance.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack.- Parameters:
ipAddressType- The IP address type for the instance.The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IpAddressType,IpAddressType
-
overrideConfiguration
CreateInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-