Class ManagedInstanceRequest

java.lang.Object
software.amazon.awssdk.services.workspacesinstances.model.ManagedInstanceRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ManagedInstanceRequest.Builder,ManagedInstanceRequest>
@Generated("software.amazon.awssdk:codegen") public final class ManagedInstanceRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ManagedInstanceRequest.Builder,ManagedInstanceRequest>

Defines comprehensive configuration for a managed WorkSpace Instance.

See Also:

  • Method Details

    • hasBlockDeviceMappings

      public final boolean hasBlockDeviceMappings()
      For responses, this returns true if the service returned a value for the BlockDeviceMappings 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.

    • blockDeviceMappings

      public final List<BlockDeviceMappingRequest> blockDeviceMappings()

      Configures block device mappings for storage.

      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 hasBlockDeviceMappings() method.

      Returns:
      Configures block device mappings for storage.

    • capacityReservationSpecification

      public final CapacityReservationSpecification capacityReservationSpecification()

      Specifies capacity reservation preferences.

      Returns:
      Specifies capacity reservation preferences.

    • cpuOptions

      public final CpuOptionsRequest cpuOptions()

      Configures CPU-specific settings.

      Returns:
      Configures CPU-specific settings.

    • creditSpecification

      public final CreditSpecificationRequest creditSpecification()

      Defines CPU credit configuration for burstable instances.

      Returns:
      Defines CPU credit configuration for burstable instances.

    • disableApiStop

      public final Boolean disableApiStop()

      Prevents API-initiated instance stop.

      Returns:
      Prevents API-initiated instance stop.

    • ebsOptimized

      public final Boolean ebsOptimized()

      Enables optimized EBS performance.

      Returns:
      Enables optimized EBS performance.

    • enablePrimaryIpv6

      public final Boolean enablePrimaryIpv6()

      Enables primary IPv6 address configuration.

      Returns:
      Enables primary IPv6 address configuration.

    • enclaveOptions

      public final EnclaveOptionsRequest enclaveOptions()

      Configures AWS Nitro Enclave settings.

      Returns:
      Configures AWS Nitro Enclave settings.

    • hibernationOptions

      public final HibernationOptionsRequest hibernationOptions()

      Configures instance hibernation capabilities.

      Returns:
      Configures instance hibernation capabilities.

    • iamInstanceProfile

      public final IamInstanceProfileSpecification iamInstanceProfile()

      Specifies IAM instance profile configuration.

      Returns:
      Specifies IAM instance profile configuration.

    • imageId

      public final String imageId()

      Identifies the Amazon Machine Image (AMI) for the instance.

      Returns:
      Identifies the Amazon Machine Image (AMI) for the instance.

    • instanceMarketOptions

      public final InstanceMarketOptionsRequest instanceMarketOptions()

      Configures marketplace-specific deployment options.

      Returns:
      Configures marketplace-specific deployment options.

    • instanceType

      public final String instanceType()

      Specifies the WorkSpace Instance type.

      Returns:
      Specifies the WorkSpace Instance type.

    • hasIpv6Addresses

      public final boolean hasIpv6Addresses()
      For responses, this returns true if the service returned a value for the Ipv6Addresses 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.

    • ipv6Addresses

      public final List<InstanceIpv6Address> ipv6Addresses()

      Configures specific IPv6 addresses.

      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 hasIpv6Addresses() method.

      Returns:
      Configures specific IPv6 addresses.

    • ipv6AddressCount

      public final Integer ipv6AddressCount()

      Specifies number of IPv6 addresses to assign.

      Returns:
      Specifies number of IPv6 addresses to assign.

    • kernelId

      public final String kernelId()

      Identifies the kernel for the instance.

      Returns:
      Identifies the kernel for the instance.

    • keyName

      public final String keyName()

      Specifies the key pair for instance access.

      Returns:
      Specifies the key pair for instance access.

    • hasLicenseSpecifications

      public final boolean hasLicenseSpecifications()
      For responses, this returns true if the service returned a value for the LicenseSpecifications 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.

    • licenseSpecifications

      public final List<LicenseConfigurationRequest> licenseSpecifications()

      Configures license-related settings.

      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 hasLicenseSpecifications() method.

      Returns:
      Configures license-related settings.

    • maintenanceOptions

      public final InstanceMaintenanceOptionsRequest maintenanceOptions()

      Defines automatic maintenance settings.

      Returns:
      Defines automatic maintenance settings.

    • metadataOptions

      public final InstanceMetadataOptionsRequest metadataOptions()

      Configures instance metadata service settings.

      Returns:
      Configures instance metadata service settings.

    • monitoring

      public final RunInstancesMonitoringEnabled monitoring()

      Enables or disables detailed instance monitoring.

      Returns:
      Enables or disables detailed instance monitoring.

    • hasNetworkInterfaces

      public final boolean hasNetworkInterfaces()
      For responses, this returns true if the service returned a value for the NetworkInterfaces 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.

    • networkInterfaces

      public final List<InstanceNetworkInterfaceSpecification> networkInterfaces()

      Configures network interface settings.

      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 hasNetworkInterfaces() method.

      Returns:
      Configures network interface settings.

    • networkPerformanceOptions

      public final InstanceNetworkPerformanceOptionsRequest networkPerformanceOptions()

      Defines network performance configuration.

      Returns:
      Defines network performance configuration.

    • placement

      public final Placement placement()

      Specifies instance placement preferences.

      Returns:
      Specifies instance placement preferences.

    • privateDnsNameOptions

      public final PrivateDnsNameOptionsRequest privateDnsNameOptions()

      Configures private DNS name settings.

      Returns:
      Configures private DNS name settings.

    • privateIpAddress

      public final String privateIpAddress()

      Specifies the primary private IP address.

      Returns:
      Specifies the primary private IP address.

    • ramdiskId

      public final String ramdiskId()

      Identifies the ramdisk for the instance.

      Returns:
      Identifies the ramdisk for the instance.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds 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.

    • securityGroupIds

      public final List<String> securityGroupIds()

      Specifies security group identifiers.

      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 hasSecurityGroupIds() method.

      Returns:
      Specifies security group identifiers.

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups 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.

    • securityGroups

      public final List<String> securityGroups()

      Configures security group settings.

      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 hasSecurityGroups() method.

      Returns:
      Configures security group settings.

    • subnetId

      public final String subnetId()

      Identifies the subnet for the instance.

      Returns:
      Identifies the subnet for the instance.

    • hasTagSpecifications

      public final boolean hasTagSpecifications()
      For responses, this returns true if the service returned a value for the TagSpecifications 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.

    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      Configures resource tagging specifications.

      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 hasTagSpecifications() method.

      Returns:
      Configures resource tagging specifications.

    • userData

      public final String userData()

      Provides custom initialization data for the instance.

      Returns:
      Provides custom initialization data for the instance.

    • toBuilder

      public ManagedInstanceRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ManagedInstanceRequest.Builder,ManagedInstanceRequest>
      Returns:
      a builder for type T

    • builder

      public static ManagedInstanceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ManagedInstanceRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.