com.atlassian.bamboo.agent.elastic.server

Interface ElasticImageConfiguration

All Superinterfaces:

BambooIdProvider, BambooObject

All Known Implementing Classes:

ElasticImageConfigurationImpl

public interface ElasticImageConfiguration
extends BambooObject

Method Summary

Modifier and Type	Method and Description
String	getAmiId() Get Elastic Instance Configuration's EC2 AMI id.
com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Architecture	getArchitecture() Get image architecture
Collection<String>	getAvailabilityZones() Get Availability Zone for Elastic Instance Configuration.
ImageCapabilitySet	getCapabilitySet()
String	getConfigurationDescription() Get Elastic Instance Configuration's description.
String	getConfigurationName() Get Elastic Instance Configuration's name.
String	getEbsSnapshotId() Get Elastic Instance Configuration's EBS snapshot id.
String	getImageFilesVersion()
com.atlassian.aws.ec2.EC2InstanceType	getInstanceType() Deprecated. since 5.11 use getInstanceTypes() instead
Iterable<com.atlassian.aws.ec2.EC2InstanceType>	getInstanceTypes()
String	getOsName()
com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Platform	getPlatform() Get image platform
String	getProduct()
com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Region	getRegion() Get Region for which the image configuration is defined.
com.atlassian.aws.ec2.awssdk.AwsSupportConstants.RootDeviceType	getRootDeviceType()
List<Script>	getStartupScripts()
Collection<String>	getSubnetIds()
com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Virtualisation	getVirtualisationType()
boolean	isDedicated() Deprecated. without replacement; this is temporary solution
boolean	isDisabled()
boolean	isEbsEnabled() Get Elastic Instance Configuration's EBS status.
boolean	isLegacyEbsHandlingEnabled()
boolean	isShippedWithBamboo() Is set for default configuration.
void	setAmiId(String amiId) Set the Elastic Instance Configuration's EC2 AMI id (image)
void	setArchitecture(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Architecture architecture)
void	setAvailabilityZone(String zone) Deprecated. since 5.8 use setAvailabilityZones(Iterable)
void	setAvailabilityZones(Iterable<com.atlassian.aws.ec2.model.AvailabilityZoneId> availabilityZones)
void	setConfigurationDescription(String configurationDescription)
void	setConfigurationName(String configurationName)
void	setDisabled(boolean disabled) Set Disabled field for Elastic Instance Configuration
void	setImageFilesVersion(String imageFilesLevel)
void	setInstanceType(com.atlassian.aws.ec2.EC2InstanceType instanceType) Deprecated. since 5.11 use setInstanceTypes(Iterable) instead
void	setInstanceTypes(Iterable<com.atlassian.aws.ec2.EC2InstanceType> instanceType)
void	setOsName(String osName)
void	setPlatform(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Platform platform)
void	setProduct(String product)
void	setRegion(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Region region)
void	setRootDeviceType(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.RootDeviceType rootDeviceType)
void	setShippedWithBamboo(boolean shippedWithBamboo)
void	setStartupScripts(List<Script> startupScripts)
void	setSubnetId(String subnetId) Deprecated. since 5.8, use setSubnetIds(Iterable)
void	setSubnetIds(Iterable<String> subnetIds) Subnet ids in the "subnet-xxxxx" format
void	setVirtualisationType(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Virtualisation paravirtual)

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Method Detail

getConfigurationName

String getConfigurationName()

Get Elastic Instance Configuration's name.

Returns:

Elastic Instance Configuration's name

setConfigurationName

void setConfigurationName(String configurationName)

getConfigurationDescription

String getConfigurationDescription()

Get Elastic Instance Configuration's description.

Returns:

Elastic Instance Configuration's description

setConfigurationDescription

void setConfigurationDescription(String configurationDescription)

getAmiId

String getAmiId()

Get Elastic Instance Configuration's EC2 AMI id.

Returns:

Elastic Instance Configuration's EC2 AMI id

setAmiId

void setAmiId(String amiId)

Set the Elastic Instance Configuration's EC2 AMI id (image)

Parameters:

amiId - - Elastic Instance Configuration's EC2 AMI id

isEbsEnabled

boolean isEbsEnabled()

Get Elastic Instance Configuration's EBS status.

Returns:

Elastic Instance Configuration's EBS status

getEbsSnapshotId

@Nullable
String getEbsSnapshotId()

Get Elastic Instance Configuration's EBS snapshot id.

Returns:

Elastic Instance Configuration's EBS snapshot id

getInstanceType

@NotNull
 @Deprecated
com.atlassian.aws.ec2.EC2InstanceType getInstanceType()

Deprecated. since 5.11 use getInstanceTypes() instead

Get Elastic Instance Configuration type.

Returns:

Elastic Instance Configuration type

getInstanceTypes

@NotNull
Iterable<com.atlassian.aws.ec2.EC2InstanceType> getInstanceTypes()

setInstanceType

@Deprecated
void setInstanceType(com.atlassian.aws.ec2.EC2InstanceType instanceType)

Deprecated. since 5.11 use setInstanceTypes(Iterable) instead

setInstanceTypes

void setInstanceTypes(@NotNull
                      Iterable<com.atlassian.aws.ec2.EC2InstanceType> instanceType)

getAvailabilityZones

@NotNull
Collection<String> getAvailabilityZones()

Get Availability Zone for Elastic Instance Configuration.

Returns:

Name of Availability Zone

setAvailabilityZone

@Deprecated
void setAvailabilityZone(@Nullable
                                     String zone)

Deprecated. since 5.8 use setAvailabilityZones(Iterable)

Set Availability Zone for Elastic Instance Configuration.

Parameters:

zone - Name of Availability Zone to be setup. null if the default zone should be used

setAvailabilityZones

void setAvailabilityZones(Iterable<com.atlassian.aws.ec2.model.AvailabilityZoneId> availabilityZones)

isDisabled

boolean isDisabled()

Returns:

returns whether the Elastic Configuration is disabled

setDisabled

void setDisabled(boolean disabled)

Set Disabled field for Elastic Instance Configuration

Parameters:

disabled -

getCapabilitySet

@NotNull
ImageCapabilitySet getCapabilitySet()

Returns:

Capability Set associated with this Elastic Instance Configuration

isShippedWithBamboo

boolean isShippedWithBamboo()

Is set for default configuration. Currently it is configuration shipped with Bamboo

Returns:

True if configuration is marked as "shipped with Bamboo"

setShippedWithBamboo

void setShippedWithBamboo(boolean shippedWithBamboo)

getProduct

@NotNull
String getProduct()

Returns:

the EC2 product used to launch this image (e.g. "Linux/UNIX", "Windows", "SUSE Linux"

setProduct

void setProduct(String product)

getRegion

com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Region getRegion()

Get Region for which the image configuration is defined.

Returns:

setRegion

void setRegion(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Region region)

getArchitecture

com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Architecture getArchitecture()

Get image architecture

Returns:

setArchitecture

void setArchitecture(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Architecture architecture)

getPlatform

com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Platform getPlatform()

Get image platform

Returns:

setPlatform

void setPlatform(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Platform platform)

getRootDeviceType

com.atlassian.aws.ec2.awssdk.AwsSupportConstants.RootDeviceType getRootDeviceType()

Returns:

root device type for image

setRootDeviceType

void setRootDeviceType(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.RootDeviceType rootDeviceType)

getStartupScripts

@NotNull
List<Script> getStartupScripts()

setStartupScripts

void setStartupScripts(@NotNull
                       List<Script> startupScripts)

setSubnetId

@Deprecated
void setSubnetId(@Nullable
                             String subnetId)

Deprecated. since 5.8, use setSubnetIds(Iterable)

Subnet id in the "subnet-xxxxx" format

getSubnetIds

@NotNull
Collection<String> getSubnetIds()

setSubnetIds

void setSubnetIds(@NotNull
                  Iterable<String> subnetIds)

Subnet ids in the "subnet-xxxxx" format

setImageFilesVersion

void setImageFilesVersion(@Nullable
                          String imageFilesLevel)

getImageFilesVersion

@Nullable
String getImageFilesVersion()

isDedicated

@Deprecated
boolean isDedicated()

Deprecated. without replacement; this is temporary solution

Returns:

true iff this configuration is assigned to specific jobs

Since:

5.0

getOsName

String getOsName()

setOsName

void setOsName(String osName)

isLegacyEbsHandlingEnabled

boolean isLegacyEbsHandlingEnabled()

setVirtualisationType

void setVirtualisationType(com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Virtualisation paravirtual)

getVirtualisationType

@Nullable
com.atlassian.aws.ec2.awssdk.AwsSupportConstants.Virtualisation getVirtualisationType()