Class InstanceTemplate

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.is.vpc.v1.model.InstanceTemplate
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
Direct Known Subclasses:
InstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext, InstanceTemplateInstanceByImageInstanceTemplateContext, InstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext
public class InstanceTemplate extends com.ibm.cloud.sdk.core.service.model.GenericModel
InstanceTemplate. Classes which extend this class: - InstanceTemplateInstanceByImageInstanceTemplateContext - InstanceTemplateInstanceBySourceSnapshotInstanceTemplateContext - InstanceTemplateInstanceByCatalogOfferingInstanceTemplateContext

  • Method Details

    • getAvailabilityPolicy

      public InstanceAvailabilityPolicyPrototype getAvailabilityPolicy()
      Gets the availabilityPolicy. The availability policy to use for this virtual server instance.
      Returns:
      the availabilityPolicy

    • getClusterNetworkAttachments

      public List<InstanceClusterNetworkAttachmentPrototypeInstanceContext> getClusterNetworkAttachments()
      Gets the clusterNetworkAttachments. The cluster network attachments to create for this virtual server instance. A cluster network attachment represents a device that is connected to a cluster network. The number of network attachments must match one of the values from the instance profile's `cluster_network_attachment_count` before the instance can be started.
      Returns:
      the clusterNetworkAttachments

    • getConfidentialComputeMode

      public String getConfidentialComputeMode()
      Gets the confidentialComputeMode. The confidential compute mode to use for this virtual server instance. If unspecified, the default confidential compute mode from the profile will be used.
      Returns:
      the confidentialComputeMode

    • getCreatedAt

      public Date getCreatedAt()
      Gets the createdAt. The date and time that the instance template was created.
      Returns:
      the createdAt

    • getCrn

      public String getCrn()
      Gets the crn. The CRN for this instance template.
      Returns:
      the crn

    • getDefaultTrustedProfile

      public InstanceDefaultTrustedProfilePrototype getDefaultTrustedProfile()
      Gets the defaultTrustedProfile. The default trusted profile configuration to use for this virtual server instance This property's value is used when provisioning the virtual server instance, but not subsequently managed. Accordingly, it is reflected as an [instance initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property.
      Returns:
      the defaultTrustedProfile

    • isEnableSecureBoot

      public Boolean isEnableSecureBoot()
      Gets the enableSecureBoot. Indicates whether secure boot is enabled for this virtual server instance. If unspecified, the default secure boot mode from the profile will be used.
      Returns:
      the enableSecureBoot

    • getHref

      public String getHref()
      Gets the href. The URL for this instance template.
      Returns:
      the href

    • getId

      public String getId()
      Gets the id. The unique identifier for this instance template.
      Returns:
      the id

    • getKeys

      public List<KeyIdentity> getKeys()
      Gets the keys. The public SSH keys for the administrative user of the virtual server instance. Keys will be made available to the virtual server instance as cloud-init vendor data. For cloud-init enabled images, these keys will also be added as SSH authorized keys for the administrative user. For Windows images, the keys of type `rsa` must be specified, and one will be selected to encrypt [the administrator password](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization). Keys are optional for other images, but if no keys are specified, the instance will be inaccessible unless the specified image provides another means of access. This property's value is used when provisioning the virtual server instance, but not subsequently managed. Accordingly, it is reflected as an [instance initialization](https://cloud.ibm.com/apidocs/vpc#get-instance-initialization) property.
      Returns:
      the keys

    • getMetadataService

      public InstanceMetadataServicePrototype getMetadataService()
      Gets the metadataService. The metadata service configuration.
      Returns:
      the metadataService

    • getName

      public String getName()
      Gets the name. The name for this instance template. The name is unique across all instance templates in the region.
      Returns:
      the name

    • getPlacementTarget

      public InstancePlacementTargetPrototype getPlacementTarget()
      Gets the placementTarget. The placement restrictions to use for the virtual server instance. If specified, `reservation_affinity.policy` must be `disabled`.
      Returns:
      the placementTarget

    • getProfile

      public InstanceProfileIdentity getProfile()
      Gets the profile. The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) to use for this virtual server instance. If unspecified, `bx2-2x8` will be used, but this default value is expected to change in the future.
      Returns:
      the profile

    • getReservationAffinity

      public InstanceReservationAffinityPrototype getReservationAffinity()
      Gets the reservationAffinity.
      Returns:
      the reservationAffinity

    • getResourceGroup

      public ResourceGroupReference getResourceGroup()
      Gets the resourceGroup. The resource group for this instance template.
      Returns:
      the resourceGroup

    • getTotalVolumeBandwidth

      public Long getTotalVolumeBandwidth()
      Gets the totalVolumeBandwidth. The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in this value will result in a corresponding decrease to `total_network_bandwidth`.
      Returns:
      the totalVolumeBandwidth

    • getUserData

      public String getUserData()
      Gets the userData. [User data](https://cloud.ibm.com/docs/vpc?topic=vpc-user-data) to make available when setting up the virtual server instance.
      Returns:
      the userData

    • getVolumeAttachments

      public List<VolumeAttachmentPrototype> getVolumeAttachments()
      Gets the volumeAttachments. The additional volume attachments to create for the virtual server instance.
      Returns:
      the volumeAttachments

    • getVpc

      public VPCIdentity getVpc()
      Gets the vpc. The VPC this virtual server instance will reside in. If specified, it must match the VPC for the subnets of the instance network attachments or instance network interfaces.
      Returns:
      the vpc

    • getBootVolumeAttachment

      public VolumeAttachmentPrototypeInstanceByImageContext getBootVolumeAttachment()
      Gets the bootVolumeAttachment. The boot volume attachment to create for the virtual server instance.
      Returns:
      the bootVolumeAttachment

    • getImage

      public ImageIdentity getImage()
      Gets the image. The image to use when provisioning the virtual server instance.
      Returns:
      the image

    • getZone

      public ZoneIdentity getZone()
      Gets the zone. The zone this virtual server instance will reside in.
      Returns:
      the zone

    • getNetworkAttachments

      public List<InstanceNetworkAttachmentPrototype> getNetworkAttachments()
      Gets the networkAttachments. The additional network attachments to create for the virtual server instance.
      Returns:
      the networkAttachments

    • getPrimaryNetworkAttachment

      public InstanceNetworkAttachmentPrototype getPrimaryNetworkAttachment()
      Gets the primaryNetworkAttachment. The primary network attachment to create for the virtual server instance.
      Returns:
      the primaryNetworkAttachment

    • getNetworkInterfaces

      public List<NetworkInterfacePrototype> getNetworkInterfaces()
      Gets the networkInterfaces. The additional instance network interfaces to create.
      Returns:
      the networkInterfaces

    • getPrimaryNetworkInterface

      public NetworkInterfacePrototype getPrimaryNetworkInterface()
      Gets the primaryNetworkInterface. The primary instance network interface to create.
      Returns:
      the primaryNetworkInterface

    • getCatalogOffering

      public InstanceCatalogOfferingPrototype getCatalogOffering()
      Gets the catalogOffering. The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering or offering version to use when provisioning this virtual server instance. If an offering is specified, the latest version of that offering will be used. The specified offering or offering version may be in a different account, subject to IAM policies.
      Returns:
      the catalogOffering