Package software.amazon.awscdk.services.lightsail

Class CfnInstanceProps.Builder

java.lang.Object
software.amazon.awscdk.services.lightsail.CfnInstanceProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnInstanceProps>
Enclosing interface:
CfnInstanceProps
@Stability(Stable) public static final class CfnInstanceProps.Builder extends Object implements software.amazon.jsii.Builder<CfnInstanceProps>
A builder for CfnInstanceProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • blueprintId

      @Stability(Stable) public CfnInstanceProps.Builder blueprintId(String blueprintId)
      Sets the value of CfnInstanceProps.getBlueprintId()
      Parameters:
      blueprintId - The blueprint ID for the instance (for example, os_amlinux_2016_03 ). This parameter is required.
      Returns:
      this

    • bundleId

      @Stability(Stable) public CfnInstanceProps.Builder bundleId(String bundleId)
      Sets the value of CfnInstanceProps.getBundleId()
      Parameters:
      bundleId - The bundle ID for the instance (for example, micro_1_0 ). This parameter is required.
      Returns:
      this

    • instanceName

      @Stability(Stable) public CfnInstanceProps.Builder instanceName(String instanceName)
      Sets the value of CfnInstanceProps.getInstanceName()
      Parameters:
      instanceName - The name of the instance. This parameter is required.
      Returns:
      this

    • addOns

      @Stability(Stable) public CfnInstanceProps.Builder addOns(IResolvable addOns)
      Sets the value of CfnInstanceProps.getAddOns()
      Parameters:
      addOns - An array of add-ons for the instance.

      If the instance has an add-on enabled when performing a delete instance request, the add-on is automatically disabled before the instance is deleted.

      Returns:
      this

    • addOns

      @Stability(Stable) public CfnInstanceProps.Builder addOns(List<? extends Object> addOns)
      Sets the value of CfnInstanceProps.getAddOns()
      Parameters:
      addOns - An array of add-ons for the instance.

      If the instance has an add-on enabled when performing a delete instance request, the add-on is automatically disabled before the instance is deleted.

      Returns:
      this

    • availabilityZone

      @Stability(Stable) public CfnInstanceProps.Builder availabilityZone(String availabilityZone)
      Sets the value of CfnInstanceProps.getAvailabilityZone()
      Parameters:
      availabilityZone - The Availability Zone for the instance.
      Returns:
      this

    • hardware

      @Stability(Stable) public CfnInstanceProps.Builder hardware(IResolvable hardware)
      Sets the value of CfnInstanceProps.getHardware()
      Parameters:
      hardware - The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.

      The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.

      Returns:
      this

    • hardware

      @Stability(Stable) public CfnInstanceProps.Builder hardware(CfnInstance.HardwareProperty hardware)
      Sets the value of CfnInstanceProps.getHardware()
      Parameters:
      hardware - The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM.

      The instance restarts when performing an attach disk or detach disk request. This resets the public IP address of your instance if a static IP isn't attached to it.

      Returns:
      this

    • keyPairName

      @Stability(Stable) public CfnInstanceProps.Builder keyPairName(String keyPairName)
      Sets the value of CfnInstanceProps.getKeyPairName()
      Parameters:
      keyPairName - The name of the key pair to use for the instance. If no key pair name is specified, the Regional Lightsail default key pair is used.
      Returns:
      this

    • location

      @Stability(Stable) public CfnInstanceProps.Builder location(IResolvable location)
      Sets the value of CfnInstanceProps.getLocation()
      Parameters:
      location - The location for the instance, such as the AWS Region and Availability Zone.

      The Location property is read-only and should not be specified in a create instance or update instance request.

      Returns:
      this

    • location

      @Stability(Stable) public CfnInstanceProps.Builder location(CfnInstance.LocationProperty location)
      Sets the value of CfnInstanceProps.getLocation()
      Parameters:
      location - The location for the instance, such as the AWS Region and Availability Zone.

      The Location property is read-only and should not be specified in a create instance or update instance request.

      Returns:
      this

    • networking

      @Stability(Stable) public CfnInstanceProps.Builder networking(IResolvable networking)
      Sets the value of CfnInstanceProps.getNetworking()
      Parameters:
      networking - The public ports and the monthly amount of data transfer allocated for the instance.
      Returns:
      this

    • networking

      @Stability(Stable) public CfnInstanceProps.Builder networking(CfnInstance.NetworkingProperty networking)
      Sets the value of CfnInstanceProps.getNetworking()
      Parameters:
      networking - The public ports and the monthly amount of data transfer allocated for the instance.
      Returns:
      this

    • state

      @Stability(Stable) public CfnInstanceProps.Builder state(IResolvable state)
      Sets the value of CfnInstanceProps.getState()
      Parameters:
      state - The status code and the state (for example, running ) of the instance.

      The State property is read-only and should not be specified in a create instance or update instance request.

      Returns:
      this

    • state

      @Stability(Stable) public CfnInstanceProps.Builder state(CfnInstance.StateProperty state)
      Sets the value of CfnInstanceProps.getState()
      Parameters:
      state - The status code and the state (for example, running ) of the instance.

      The State property is read-only and should not be specified in a create instance or update instance request.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnInstanceProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnInstanceProps.getTags()
      Parameters:
      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.

      Returns:
      this

    • userData

      @Stability(Stable) public CfnInstanceProps.Builder userData(String userData)
      Sets the value of CfnInstanceProps.getUserData()
      Parameters:
      userData - The optional launch script for the instance. Specify a launch script to configure an instance with additional user data. For example, you might want to specify apt-get -y update as a launch script.

      Depending on the blueprint of your instance, 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 .

      Returns:
      this

    • build

      @Stability(Stable) public CfnInstanceProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnInstanceProps>
      Returns:
      a new instance of CfnInstanceProps
      Throws:
      NullPointerException - if any required attribute was not provided