Blueprint (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lightsail.model.Blueprint

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Blueprint
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes a blueprint (a virtual private server image).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Blueprint()

Constructors
Constructor and Description
`Blueprint()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Blueprint`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBlueprintId()` The ID for the virtual private server image (e.g., `app_wordpress_4_4` or `app_lamp_7_0`).
`String`	`getDescription()` The description of the blueprint.
`String`	`getGroup()` The group name of the blueprint (e.g., `amazon-linux`).
`Boolean`	`getIsActive()` A Boolean value indicating whether the blueprint is active.
`String`	`getLicenseUrl()` The end-user license agreement URL for the image or blueprint.
`Integer`	`getMinPower()` The minimum bundle power required to run this blueprint.
`String`	`getName()` The friendly name of the blueprint (e.g., `Amazon Linux`).
`String`	`getPlatform()` The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
`String`	`getProductUrl()` The product URL to learn more about the image or blueprint.
`String`	`getType()` The type of the blueprint (e.g., `os` or `app`).
`String`	`getVersion()` The version number of the operating system, application, or stack (e.g., `2016.03.0`).
`String`	`getVersionCode()` The version code.
`int`	`hashCode()`
`Boolean`	`isActive()` A Boolean value indicating whether the blueprint is active.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBlueprintId(String blueprintId)` The ID for the virtual private server image (e.g., `app_wordpress_4_4` or `app_lamp_7_0`).
`void`	`setDescription(String description)` The description of the blueprint.
`void`	`setGroup(String group)` The group name of the blueprint (e.g., `amazon-linux`).
`void`	`setIsActive(Boolean isActive)` A Boolean value indicating whether the blueprint is active.
`void`	`setLicenseUrl(String licenseUrl)` The end-user license agreement URL for the image or blueprint.
`void`	`setMinPower(Integer minPower)` The minimum bundle power required to run this blueprint.
`void`	`setName(String name)` The friendly name of the blueprint (e.g., `Amazon Linux`).
`void`	`setPlatform(InstancePlatform platform)` The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
`void`	`setPlatform(String platform)` The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
`void`	`setProductUrl(String productUrl)` The product URL to learn more about the image or blueprint.
`void`	`setType(BlueprintType type)` The type of the blueprint (e.g., `os` or `app`).
`void`	`setType(String type)` The type of the blueprint (e.g., `os` or `app`).
`void`	`setVersion(String version)` The version number of the operating system, application, or stack (e.g., `2016.03.0`).
`void`	`setVersionCode(String versionCode)` The version code.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Blueprint`	`withBlueprintId(String blueprintId)` The ID for the virtual private server image (e.g., `app_wordpress_4_4` or `app_lamp_7_0`).
`Blueprint`	`withDescription(String description)` The description of the blueprint.
`Blueprint`	`withGroup(String group)` The group name of the blueprint (e.g., `amazon-linux`).
`Blueprint`	`withIsActive(Boolean isActive)` A Boolean value indicating whether the blueprint is active.
`Blueprint`	`withLicenseUrl(String licenseUrl)` The end-user license agreement URL for the image or blueprint.
`Blueprint`	`withMinPower(Integer minPower)` The minimum bundle power required to run this blueprint.
`Blueprint`	`withName(String name)` The friendly name of the blueprint (e.g., `Amazon Linux`).
`Blueprint`	`withPlatform(InstancePlatform platform)` The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
`Blueprint`	`withPlatform(String platform)` The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
`Blueprint`	`withProductUrl(String productUrl)` The product URL to learn more about the image or blueprint.
`Blueprint`	`withType(BlueprintType type)` The type of the blueprint (e.g., `os` or `app`).
`Blueprint`	`withType(String type)` The type of the blueprint (e.g., `os` or `app`).
`Blueprint`	`withVersion(String version)` The version number of the operating system, application, or stack (e.g., `2016.03.0`).
`Blueprint`	`withVersionCode(String versionCode)` The version code.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Blueprint
```
public Blueprint()
```
- Method Detail
  - setBlueprintId
```
public void setBlueprintId(String blueprintId)
```
    The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
    
    Parameters:
    
    blueprintId - The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
  - getBlueprintId
```
public String getBlueprintId()
```
    The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
    
    Returns:
    
    The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
  - withBlueprintId
```
public Blueprint withBlueprintId(String blueprintId)
```
    The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
    
    Parameters:
    
    blueprintId - The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The friendly name of the blueprint (e.g., Amazon Linux).
    
    Parameters:
    
    name - The friendly name of the blueprint (e.g., Amazon Linux).
  - getName
```
public String getName()
```
    The friendly name of the blueprint (e.g., Amazon Linux).
    
    Returns:
    
    The friendly name of the blueprint (e.g., Amazon Linux).
  - withName
```
public Blueprint withName(String name)
```
    The friendly name of the blueprint (e.g., Amazon Linux).
    
    Parameters:
    
    name - The friendly name of the blueprint (e.g., Amazon Linux).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGroup
```
public void setGroup(String group)
```
    The group name of the blueprint (e.g., amazon-linux).
    
    Parameters:
    
    group - The group name of the blueprint (e.g., amazon-linux).
  - getGroup
```
public String getGroup()
```
    The group name of the blueprint (e.g., amazon-linux).
    
    Returns:
    
    The group name of the blueprint (e.g., amazon-linux).
  - withGroup
```
public Blueprint withGroup(String group)
```
    The group name of the blueprint (e.g., amazon-linux).
    
    Parameters:
    
    group - The group name of the blueprint (e.g., amazon-linux).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the blueprint (e.g., os or app).
    
    Parameters:
    
    type - The type of the blueprint (e.g., os or app).
    
    See Also:
    
    BlueprintType
  - getType
```
public String getType()
```
    The type of the blueprint (e.g., os or app).
    
    Returns:
    
    The type of the blueprint (e.g., os or app).
    
    See Also:
    
    BlueprintType
  - withType
```
public Blueprint withType(String type)
```
    The type of the blueprint (e.g., os or app).
    
    Parameters:
    
    type - The type of the blueprint (e.g., os or app).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BlueprintType
  - setType
```
public void setType(BlueprintType type)
```
    The type of the blueprint (e.g., os or app).
    
    Parameters:
    
    type - The type of the blueprint (e.g., os or app).
    
    See Also:
    
    BlueprintType
  - withType
```
public Blueprint withType(BlueprintType type)
```
    The type of the blueprint (e.g., os or app).
    
    Parameters:
    
    type - The type of the blueprint (e.g., os or app).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BlueprintType
  - setDescription
```
public void setDescription(String description)
```
    The description of the blueprint.
    
    Parameters:
    
    description - The description of the blueprint.
  - getDescription
```
public String getDescription()
```
    The description of the blueprint.
    
    Returns:
    
    The description of the blueprint.
  - withDescription
```
public Blueprint withDescription(String description)
```
    The description of the blueprint.
    
    Parameters:
    
    description - The description of the blueprint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsActive
```
public void setIsActive(Boolean isActive)
```
    A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
    
    Parameters:
    
    isActive - A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
  - getIsActive
```
public Boolean getIsActive()
```
    A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
    
    Returns:
    
    A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
  - withIsActive
```
public Blueprint withIsActive(Boolean isActive)
```
    A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
    
    Parameters:
    
    isActive - A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isActive
```
public Boolean isActive()
```
    A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
    
    Returns:
    
    A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
  - setMinPower
```
public void setMinPower(Integer minPower)
```
    The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.
    
    Parameters:
    
    minPower - The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.
  - getMinPower
```
public Integer getMinPower()
```
    The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.
    
    Returns:
    
    The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.
  - withMinPower
```
public Blueprint withMinPower(Integer minPower)
```
    The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.
    
    Parameters:
    
    minPower - The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The version number of the operating system, application, or stack (e.g., 2016.03.0).
    
    Parameters:
    
    version - The version number of the operating system, application, or stack (e.g., 2016.03.0).
  - getVersion
```
public String getVersion()
```
    The version number of the operating system, application, or stack (e.g., 2016.03.0).
    
    Returns:
    
    The version number of the operating system, application, or stack (e.g., 2016.03.0).
  - withVersion
```
public Blueprint withVersion(String version)
```
    The version number of the operating system, application, or stack (e.g., 2016.03.0).
    
    Parameters:
    
    version - The version number of the operating system, application, or stack (e.g., 2016.03.0).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionCode
```
public void setVersionCode(String versionCode)
```
    The version code.
    
    Parameters:
    
    versionCode - The version code.
  - getVersionCode
```
public String getVersionCode()
```
    The version code.
    
    Returns:
    
    The version code.
  - withVersionCode
```
public Blueprint withVersionCode(String versionCode)
```
    The version code.
    
    Parameters:
    
    versionCode - The version code.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProductUrl
```
public void setProductUrl(String productUrl)
```
    The product URL to learn more about the image or blueprint.
    
    Parameters:
    
    productUrl - The product URL to learn more about the image or blueprint.
  - getProductUrl
```
public String getProductUrl()
```
    The product URL to learn more about the image or blueprint.
    
    Returns:
    
    The product URL to learn more about the image or blueprint.
  - withProductUrl
```
public Blueprint withProductUrl(String productUrl)
```
    The product URL to learn more about the image or blueprint.
    
    Parameters:
    
    productUrl - The product URL to learn more about the image or blueprint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLicenseUrl
```
public void setLicenseUrl(String licenseUrl)
```
    The end-user license agreement URL for the image or blueprint.
    
    Parameters:
    
    licenseUrl - The end-user license agreement URL for the image or blueprint.
  - getLicenseUrl
```
public String getLicenseUrl()
```
    The end-user license agreement URL for the image or blueprint.
    
    Returns:
    
    The end-user license agreement URL for the image or blueprint.
  - withLicenseUrl
```
public Blueprint withLicenseUrl(String licenseUrl)
```
    The end-user license agreement URL for the image or blueprint.
    
    Parameters:
    
    licenseUrl - The end-user license agreement URL for the image or blueprint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlatform
```
public void setPlatform(String platform)
```
    The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    Parameters:
    
    platform - The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    See Also:
    
    InstancePlatform
  - getPlatform
```
public String getPlatform()
```
    The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    Returns:
    
    The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    See Also:
    
    InstancePlatform
  - withPlatform
```
public Blueprint withPlatform(String platform)
```
    The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    Parameters:
    
    platform - The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstancePlatform
  - setPlatform
```
public void setPlatform(InstancePlatform platform)
```
    The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    Parameters:
    
    platform - The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    See Also:
    
    InstancePlatform
  - withPlatform
```
public Blueprint withPlatform(InstancePlatform platform)
```
    The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    Parameters:
    
    platform - The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstancePlatform
  - 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Blueprint clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Blueprint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Blueprint

Method Detail

setBlueprintId

getBlueprintId

withBlueprintId

setName

getName

withName

setGroup

getGroup

withGroup

setType

getType

withType

setType

withType

setDescription

getDescription

withDescription

setIsActive

getIsActive

withIsActive

isActive

setMinPower

getMinPower

withMinPower

setVersion

getVersion

withVersion

setVersionCode

getVersionCode

withVersionCode

setProductUrl

getProductUrl

withProductUrl

setLicenseUrl

getLicenseUrl

withLicenseUrl

setPlatform

getPlatform

withPlatform

setPlatform

withPlatform

toString

equals

hashCode

clone

marshall