Class UpdateInstanceRequest

    • Constructor Detail

      • UpdateInstanceRequest

        public UpdateInstanceRequest()
    • Method Detail

      • setInstanceId

        public void setInstanceId​(String instanceId)

        The instance ID.

        Parameters:
        instanceId - The instance ID.
      • getInstanceId

        public String getInstanceId()

        The instance ID.

        Returns:
        The instance ID.
      • withInstanceId

        public UpdateInstanceRequest withInstanceId​(String instanceId)

        The instance ID.

        Parameters:
        instanceId - The instance ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getLayerIds

        public List<String> getLayerIds()

        The instance's layer IDs.

        Returns:
        The instance's layer IDs.
      • setLayerIds

        public void setLayerIds​(Collection<String> layerIds)

        The instance's layer IDs.

        Parameters:
        layerIds - The instance's layer IDs.
      • withLayerIds

        public UpdateInstanceRequest withLayerIds​(Collection<String> layerIds)

        The instance's layer IDs.

        Parameters:
        layerIds - The instance's layer IDs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setInstanceType

        public void setInstanceType​(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.

        Parameters:
        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.
      • getInstanceType

        public String getInstanceType()

        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.
      • withInstanceType

        public UpdateInstanceRequest withInstanceType​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • setAutoScalingType

        public void setAutoScalingType​(String autoScalingType)

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

        Parameters:
        autoScalingType - For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
        See Also:
        AutoScalingType
      • getAutoScalingType

        public String getAutoScalingType()

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

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

        public UpdateInstanceRequest withAutoScalingType​(String autoScalingType)

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

        Parameters:
        autoScalingType - For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutoScalingType
      • setAutoScalingType

        public void setAutoScalingType​(AutoScalingType autoScalingType)

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

        Parameters:
        autoScalingType - For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
        See Also:
        AutoScalingType
      • withAutoScalingType

        public UpdateInstanceRequest withAutoScalingType​(AutoScalingType autoScalingType)

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

        Parameters:
        autoScalingType - For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutoScalingType
      • setHostname

        public void setHostname​(String hostname)

        The instance host name.

        Parameters:
        hostname - The instance host name.
      • getHostname

        public String getHostname()

        The instance host name.

        Returns:
        The instance host name.
      • withHostname

        public UpdateInstanceRequest withHostname​(String hostname)

        The instance host name.

        Parameters:
        hostname - The instance host name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setOs

        public void setOs​(String os)

        The instance's operating system, which must be set to one of the following.

        • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2015.03, Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
        • Microsoft Windows Server 2012 R2 Base.
        • A custom AMI: Custom.

        For more information on the supported operating systems, see AWS OpsWorks 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 on the supported operating systems, see Operating Systems. For more information on 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.
        Parameters:
        os - The instance's operating system, which must be set to one of the following.

        • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2015.03, Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
        • Microsoft Windows Server 2012 R2 Base.
        • A custom AMI: Custom.

        For more information on the supported operating systems, see AWS OpsWorks 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 on the supported operating systems, see Operating Systems. For more information on 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.
      • getOs

        public String getOs()

        The instance's operating system, which must be set to one of the following.

        • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2015.03, Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
        • Microsoft Windows Server 2012 R2 Base.
        • A custom AMI: Custom.

        For more information on the supported operating systems, see AWS OpsWorks 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 on the supported operating systems, see Operating Systems. For more information on 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.

        • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2015.03, Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
        • Microsoft Windows Server 2012 R2 Base.
        • A custom AMI: Custom.

        For more information on the supported operating systems, see AWS OpsWorks 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 on the supported operating systems, see Operating Systems. For more information on 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.
      • withOs

        public UpdateInstanceRequest withOs​(String os)

        The instance's operating system, which must be set to one of the following.

        • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2015.03, Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
        • Microsoft Windows Server 2012 R2 Base.
        • A custom AMI: Custom.

        For more information on the supported operating systems, see AWS OpsWorks 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 on the supported operating systems, see Operating Systems. For more information on 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.
        Parameters:
        os - The instance's operating system, which must be set to one of the following.

        • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2015.03, Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
        • Microsoft Windows Server 2012 R2 Base.
        • A custom AMI: Custom.

        For more information on the supported operating systems, see AWS OpsWorks 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 on the supported operating systems, see Operating Systems. For more information on 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:
        Returns a reference to this object so that method calls can be chained together.
      • setAmiId

        public void setAmiId​(String amiId)

        A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances

        If you specify a custom AMI, you must set Os to Custom.
        Parameters:
        amiId - A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances

        If you specify a custom AMI, you must set Os to Custom.
      • getAmiId

        public String getAmiId()

        A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances

        If you specify a custom AMI, you must set Os to Custom.
        Returns:
        A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances

        If you specify a custom AMI, you must set Os to Custom.
      • withAmiId

        public UpdateInstanceRequest withAmiId​(String amiId)

        A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances

        If you specify a custom AMI, you must set Os to Custom.
        Parameters:
        amiId - A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances

        If you specify a custom AMI, you must set Os to Custom.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSshKeyName

        public void setSshKeyName​(String sshKeyName)

        The instance's Amazon EC2 key name.

        Parameters:
        sshKeyName - The instance's Amazon EC2 key name.
      • getSshKeyName

        public String getSshKeyName()

        The instance's Amazon EC2 key name.

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

        public UpdateInstanceRequest withSshKeyName​(String sshKeyName)

        The instance's Amazon EC2 key name.

        Parameters:
        sshKeyName - The instance's Amazon EC2 key name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setArchitecture

        public void setArchitecture​(String 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.

        Parameters:
        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.
        See Also:
        Architecture
      • getArchitecture

        public String getArchitecture()

        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.

        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:
        Architecture
      • withArchitecture

        public UpdateInstanceRequest withArchitecture​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Architecture
      • setArchitecture

        public void setArchitecture​(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.

        Parameters:
        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.
        See Also:
        Architecture
      • withArchitecture

        public UpdateInstanceRequest withArchitecture​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Architecture
      • setInstallUpdatesOnBoot

        public void setInstallUpdatesOnBoot​(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.

        Parameters:
        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.

      • getInstallUpdatesOnBoot

        public Boolean getInstallUpdatesOnBoot()

        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.

      • withInstallUpdatesOnBoot

        public UpdateInstanceRequest withInstallUpdatesOnBoot​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • isInstallUpdatesOnBoot

        public Boolean isInstallUpdatesOnBoot()

        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.

      • setEbsOptimized

        public void setEbsOptimized​(Boolean ebsOptimized)

        This property cannot be updated.

        Parameters:
        ebsOptimized - This property cannot be updated.
      • getEbsOptimized

        public Boolean getEbsOptimized()

        This property cannot be updated.

        Returns:
        This property cannot be updated.
      • withEbsOptimized

        public UpdateInstanceRequest withEbsOptimized​(Boolean ebsOptimized)

        This property cannot be updated.

        Parameters:
        ebsOptimized - This property cannot be updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isEbsOptimized

        public Boolean isEbsOptimized()

        This property cannot be updated.

        Returns:
        This property cannot be updated.
      • setAgentVersion

        public void setAgentVersion​(String agentVersion)

        The default AWS OpsWorks 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 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.

        Parameters:
        agentVersion - The default AWS OpsWorks 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 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.

      • getAgentVersion

        public String getAgentVersion()

        The default AWS OpsWorks 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 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.

        Returns:
        The default AWS OpsWorks 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 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.

      • withAgentVersion

        public UpdateInstanceRequest withAgentVersion​(String agentVersion)

        The default AWS OpsWorks 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 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.

        Parameters:
        agentVersion - The default AWS OpsWorks 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 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object