Class UpdateInstanceRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateInstanceRequest.Builder,UpdateInstanceRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateInstanceRequest extends OpsWorksRequest implements ToCopyableBuilder<UpdateInstanceRequest.Builder,UpdateInstanceRequest>
  • Method Details

    • instanceId

      public final String instanceId()

      The instance ID.

      Returns:
      The instance ID.
    • hasLayerIds

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

      public final List<String> layerIds()

      The instance's layer IDs.

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

      Returns:
      The instance's layer IDs.
    • instanceType

      public final String instanceType()

      The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

      Returns:
      The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
    • autoScalingType

      public final AutoScalingType autoScalingType()

      For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

      If the service returns an enum value that is not available in the current SDK version, autoScalingType will return AutoScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoScalingTypeAsString().

      Returns:
      For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
      See Also:
    • autoScalingTypeAsString

      public final String autoScalingTypeAsString()

      For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

      If the service returns an enum value that is not available in the current SDK version, autoScalingType will return AutoScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoScalingTypeAsString().

      Returns:
      For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
      See Also:
    • hostname

      public final String hostname()

      The instance host name.

      Returns:
      The instance host name.
    • os

      public final String os()

      The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.

      • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

      • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

      • CentOS Linux 7

      • Red Hat Enterprise Linux 7

      • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

      For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

      The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported operating systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

      You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

      Returns:
      The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.

      • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

      • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS , or Ubuntu 12.04 LTS.

      • CentOS Linux 7

      • Red Hat Enterprise Linux 7

      • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

      For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

      The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported operating systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

      You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

    • amiId

      public final String amiId()

      The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.

      Returns:
      The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.
    • sshKeyName

      public final String sshKeyName()

      The instance's Amazon EC2 key name.

      Returns:
      The instance's Amazon EC2 key name.
    • architecture

      public final Architecture architecture()

      The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

      If the service returns an enum value that is not available in the current SDK version, architecture will return Architecture.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from architectureAsString().

      Returns:
      The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
      See Also:
    • architectureAsString

      public final String architectureAsString()

      The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

      If the service returns an enum value that is not available in the current SDK version, architecture will return Architecture.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from architectureAsString().

      Returns:
      The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
      See Also:
    • installUpdatesOnBoot

      public final Boolean installUpdatesOnBoot()

      Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

      We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

      Returns:
      Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

      We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

    • ebsOptimized

      public final Boolean ebsOptimized()

      This property cannot be updated.

      Returns:
      This property cannot be updated.
    • agentVersion

      public final String agentVersion()

      The default AWS OpsWorks Stacks agent version. You have the following options:

      • INHERIT - Use the stack's default agent version setting.

      • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

      The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

      AgentVersion cannot be set to Chef 12.2.

      Returns:
      The default AWS OpsWorks Stacks agent version. You have the following options:

      • INHERIT - Use the stack's default agent version setting.

      • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

      The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

      AgentVersion cannot be set to Chef 12.2.

    • toBuilder

      public UpdateInstanceRequest.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<UpdateInstanceRequest.Builder,UpdateInstanceRequest>
      Specified by:
      toBuilder in class OpsWorksRequest
      Returns:
      a builder for type T
    • builder

      public static UpdateInstanceRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdateInstanceRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.