Class CreateInstanceGroupOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.is.vpc.v1.model.CreateInstanceGroupOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class CreateInstanceGroupOptions extends com.ibm.cloud.sdk.core.service.model.GenericModel
The createInstanceGroup options.

  • Method Details

    • newBuilder

      public CreateInstanceGroupOptions.Builder newBuilder()
      New builder.
      Returns:
      a CreateInstanceGroupOptions builder

    • instanceTemplate

      public InstanceTemplateIdentity instanceTemplate()
      Gets the instanceTemplate. Instance template to use when creating new instances. Instance groups are not compatible with instance templates that specify `true` for `default_trusted_profile.auto_link`.
      Returns:
      the instanceTemplate

    • subnets

      public List<SubnetIdentity> subnets()
      Gets the subnets. The subnets to use when creating new instances.
      Returns:
      the subnets

    • applicationPort

      public Long applicationPort()
      Gets the applicationPort. The port to use for new load balancer pool members created by this instance group. The load balancer pool member will receive load balancer traffic on this port, unless the load balancer listener is using a port range. (Traffic received on a listener using a port range will be sent to members using the same port the listener received it on.) This port will also be used for health checks unless the port property of `health_monitor` property is specified. This property must be specified if and only if `load_balancer_pool` has been specified.
      Returns:
      the applicationPort

    • loadBalancer

      public LoadBalancerIdentity loadBalancer()
      Gets the loadBalancer. The load balancer associated with the specified load balancer pool. Required if `load_balancer_pool` is specified. The load balancer must have `instance_groups_supported` set to `true`.
      Returns:
      the loadBalancer

    • loadBalancerPool

      public LoadBalancerPoolIdentity loadBalancerPool()
      Gets the loadBalancerPool. If specified, this instance group will manage the load balancer pool. A pool member will be created for each instance created by this group. The specified load balancer pool must not be used by another instance group in the VPC. If specified, `load_balancer` and `application_port` must also be specified.
      Returns:
      the loadBalancerPool

    • membershipCount

      public Long membershipCount()
      Gets the membershipCount. The number of instances in the instance group.
      Returns:
      the membershipCount

    • name

      public String name()
      Gets the name. The name for this instance group. The name must not be used by another instance group in the region. If unspecified, the name will be a hyphenated list of randomly-selected words.
      Returns:
      the name

    • resourceGroup

      public ResourceGroupIdentity resourceGroup()
      Gets the resourceGroup. The resource group to use. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) will be used.
      Returns:
      the resourceGroup