Interface AwsComputeSource

All Superinterfaces:

ComputeSource, Credentialed, Identified, Named, Serializable

All Known Implementing Classes:

AwsFleetComputeSource, AwsInstancesComputeSource

@ValidatedBy(AwsComputeSourceValidator.class)
public interface AwsComputeSource
extends ComputeSource

Derives from ComputeSource to provide the interface for all AWS compute source model objects.

Field Summary

Fields inherited from interface ComputeSource

DEFAULT_ASSIGN_PUBLIC_IP

Modifier and Type	Field	Description
static final boolean	DEFAULT_ASSIGN_PUBLIC_IP

Method Summary

Modifier and Type	Method	Description
String	getAvailabilityZone()
Integer	getBootVolumeSizeGb()
AwsCapacityReservation	getCapacityReservation()
Boolean	getCreateClusterPlacementGroup()
Boolean	getCreateElasticFabricAdapter()
@NotBlank String	getCredential()
Boolean	getEnableDetailedMonitoring()
Boolean	getEnableInstanceMetadataTags()
@Valid AwsPlacementGroup	getExistingPlacementGroup()
String	getIamInstanceProfileArn()
@Min(1L) @Max(64L) Integer	getInstanceMetadataHttpPutResponseHopLimit()
@Size(max=45) Map<String,String>	getInstanceTags()	Gets the custom instance tags to be set on the provisioned instance at startup.
String	getKeyName()
default CloudProvider	getProvider()	Gets the Cloud Provider for this source.
@Size(max=31) List<AwsSecondaryNetworkInterface>	getSecondaryNetworkInterfaces()
@NotBlank String	getSecurityGroupId()
String	getSubnetId()
default String	getSubregion()	Gets the provider-specific subregion (aka Availability Domain, Availability Zone or Zone) where instances will be provisioned.
Boolean	getSupportingResourceCreated()	Indicates if supporting resources have been created for this source.
boolean	isAssignPublicIp()
void	setSupportingResourceCreated(Boolean supportingResourceCreated)

Methods inherited from interface ComputeSource

getCreatedFromId, getExhaustion, getId, getImageId, getInstancePricing, getInstanceSummary, getInstanceType, getLimit, getName, getRegion, getStatus, getStatusMessage, getTraits, getUserData, setCreatedFromId, setExhaustion, setId, setImageId, setInstanceSummary, setInstanceTags, setInstanceType, setLimit, setName, setStatus, setStatusMessage, setUserData

Modifier and Type	Method	Description
@Ydid String	getCreatedFromId()	Gets the ID of the source template if this source was created from a template.
ComputeSourceExhaustion	getExhaustion()	If this source is associated with an exhausted allowance, gets the exhaustion state.
@Ydid String	getId()	Returns the ID
@NotBlank String	getImageId()	Gets the image ID to use for the instances that will be provisioned.
InstancePricing	getInstancePricing()	Gets the instance pricing for this source, e.g.
InstanceSummary	getInstanceSummary()	A summary of instance counts according to instance status
@NotBlank String	getInstanceType()	Gets the provider-specific instance type of the instances that will be provisioned.
@Min(0L) int	getLimit()	Returns the limit in number of instances that can be provisioned from this source.
@Name @NotBlank @Pattern(regexp="[a-z](?:[a-z\\d_-]{0,58}[a-z\\d])?") @Size(max=60) String	getName()	Returns the name of this compute source (which must be unique within the containing ComputeRequirement).
@NotBlank String	getRegion()	Gets the provider-specific region where instances will be provisioned.
ComputeSourceStatus	getStatus()	Gets the current provisioning status of this source.
String	getStatusMessage()	Gets the message associated with the current provisioning status of this source.
ComputeSourceTraits	getTraits()	Returns an object describing behavioural traits specific to this compute source.
String	getUserData()	Gets the user-data script to be passed to the provisioned instance at startup.
void	setCreatedFromId(String templateId)	Sets the source template ID
void	setExhaustion(ComputeSourceExhaustion exhaustion)
void	setId(String id)	Sets the ID
void	setImageId(String imageId)	Sets the image ID to use for the instances that will be provisioned.
void	setInstanceSummary(InstanceSummary instanceSummary)
void	setInstanceTags(Map<String,String> instanceTags)	Sets the custom instance tags to be set on the provisioned instance at startup.
void	setInstanceType(String instanceType)	Sets the provider-specific instance type of the instances that will be provisioned.
void	setLimit(int limit)	Sets the limit in number of instances that can be provisioned from this source.
void	setName(String name)	Sets the name of this compute source (which must be unique within the containing ComputeRequirement).
void	setStatus(ComputeSourceStatus status)	Sets the current provisioning status of this source.
void	setStatusMessage(String statusMessage)	Sets the message associated with the current provisioning status of this source.
void	setUserData(String userData)	Sets the user-data script to be passed to the provisioned instance at startup.

Methods inherited from interface Credentialed

getCredentials

Modifier and Type	Method	Description
Set<String>	getCredentials()	Return the names of the credentials to be used for this Credentialed entity.

Method Details

getProvider

default CloudProvider getProvider()

Description copied from interface: ComputeSource

Gets the Cloud Provider for this source.

Specified by:

getProvider in interface ComputeSource

Returns:

the Cloud Provider for this source

getCredential

@NotBlank
@NotBlank String getCredential()

Specified by:

getCredential in interface ComputeSource

getSubregion

default String getSubregion()

Description copied from interface: ComputeSource

Gets the provider-specific subregion (aka Availability Domain, Availability Zone or Zone) where instances will be provisioned.

Specified by:

getSubregion in interface ComputeSource

Returns:

the provider-specific subregion where instances will be provisioned

getSupportingResourceCreated

@SystemGenerated(groups=ValidationGroup.NewEntity.class)
Boolean getSupportingResourceCreated()

Description copied from interface: ComputeSource

Indicates if supporting resources have been created for this source.

Specified by:

getSupportingResourceCreated in interface ComputeSource

Returns:

true, if supporting resources have been created for this source; false, if no supporting resources have been created; null, if unknown

setSupportingResourceCreated

void setSupportingResourceCreated(Boolean supportingResourceCreated)

getAvailabilityZone

@JsonPropertyDescription("The AWS availability zone within the region where instances will be provisioned")
String getAvailabilityZone()

getSecurityGroupId

@NotBlank
@JsonPropertyDescription("The ID of the AWS Security Group for provisioned instances")
@NotBlank String getSecurityGroupId()

getSubnetId

@JsonPropertyDescription("The region-specific subnet ID to use for provisioned instances")
String getSubnetId()

getIamInstanceProfileArn

@JsonPropertyDescription("The ARN of the IAM Instance Profile to use for provisioned instances")
String getIamInstanceProfileArn()

getKeyName

@JsonPropertyDescription("The name of the EC2 key pair to use when logging into any instances provisioned from this source")
String getKeyName()

getEnableDetailedMonitoring

@JsonPropertyDescription("Enabled detailed CloudWatch monitoring for provisioned instances")
Boolean getEnableDetailedMonitoring()

getEnableInstanceMetadataTags

@JsonPropertyDescription("Enabled exposure of instance tags via instance metadata for provisioned instances")
Boolean getEnableInstanceMetadataTags()

getInstanceMetadataHttpPutResponseHopLimit

@Min(1L)
@Max(64L)
@JsonPropertyDescription("The number of network hops that an instance metadata service (IMDS) response is allowed to travel from provisioned instances. If not specified, the AWS default of 1 is used, which only allows processes running on the instance's host network to reach IMDS. Raise this when task workloads run in containers and need IMDS access (for example, to obtain instance-profile credentials or instance metadata): each container network boundary the response must cross consumes one hop, so use 2 for a single bridged container and 3 or more for nested, container-in-container workloads.")
@Min(1L) @Max(64L) Integer getInstanceMetadataHttpPutResponseHopLimit()

isAssignPublicIp

@JsonPropertyDescription("Assign public IP address to provisioned instances")
boolean isAssignPublicIp()

getCreateClusterPlacementGroup

@JsonPropertyDescription("Provision the instances within a cluster placement group")
Boolean getCreateClusterPlacementGroup()

getExistingPlacementGroup

@JsonPropertyDescription("Provision the instances within an existing placement group")
@Valid
@Valid AwsPlacementGroup getExistingPlacementGroup()

getCreateElasticFabricAdapter

@JsonPropertyDescription("Create EFA network interface on provisioned instances")
Boolean getCreateElasticFabricAdapter()

getSecondaryNetworkInterfaces

@JsonPropertyDescription("Secondary network interfaces to create on provisioned instances")
@Size(max=31)
@Size(max=31) List<AwsSecondaryNetworkInterface> getSecondaryNetworkInterfaces()

getCapacityReservation

@JsonPropertyDescription("Specifies the capacity reservation to target for provisioned instances")
AwsCapacityReservation getCapacityReservation()

getInstanceTags

@Size(max=45)
@Size(max=45) Map<String,String> getInstanceTags()

Description copied from interface: ComputeSource

Gets the custom instance tags to be set on the provisioned instance at startup.

Specified by:

getInstanceTags in interface ComputeSource

Returns:

the custom instance tags

getBootVolumeSizeGb

@JsonPropertyDescription("Specifies the size of the boot volume (in GB) for provisioned instances. If not specified, the default size for the selected image will be used.")
Integer getBootVolumeSizeGb()