Package io.fabric8.openshift.api.model.machine.v1beta1

Class AWSMachineProviderConfig

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<AWSMachineProviderConfigBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.KubernetesResource, io.fabric8.kubernetes.api.model.Namespaced, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class AWSMachineProviderConfig
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<AWSMachineProviderConfigBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.Namespaced
    AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

        DNS_LABEL_END, DNS_LABEL_REGEXP, DNS_LABEL_START, FINALIZER_NAME_MATCHER, REQUIRES_NON_NULL_METADATA, REQUIRES_NON_NULL_NAME, REQUIRES_NON_NULL_NAMESPACE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AWSMachineProviderConfigBuilder edit()  
      Map<String,​Object> getAdditionalProperties()  
      AWSResourceReference getAmi()
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      String getApiVersion()
      APIVersion defines the versioned schema of this representation of an object.
      List<BlockDeviceMappingSpec> getBlockDevices()
      blockDevices is the set of block device mapping associated to this instance, block device without a name will be used as a root device and only one device without a name is allowed https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
      String getCapacityReservationId()
      capacityReservationId specifies the target Capacity Reservation into which the instance should be launched.
      io.fabric8.kubernetes.api.model.LocalObjectReference getCredentialsSecret()
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      Long getDeviceIndex()
      deviceIndex is the index of the device on the instance for the network interface attachment.
      AWSResourceReference getIamInstanceProfile()
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      String getInstanceType()
      instanceType is the type of instance to create.
      String getKeyName()
      keyName is the name of the KeyPair to use for SSH
      String getKind()
      Kind is a string value representing the REST resource this object represents.
      List<LoadBalancerReference> getLoadBalancers()
      loadBalancers is the set of load balancers to which the new instance should be added once it is created.
      String getMarketType()
      marketType specifies the type of market for the EC2 instance.
      io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      MetadataServiceOptions getMetadataServiceOptions()
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      String getNetworkInterfaceType()
      networkInterfaceType specifies the type of network interface to be used for the primary network interface.
      Placement getPlacement()
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      String getPlacementGroupName()
      placementGroupName specifies the name of the placement group in which to launch the instance.
      Integer getPlacementGroupPartition()
      placementGroupPartition is the partition number within the placement group in which to launch the instance.
      Boolean getPublicIp()
      publicIp specifies whether the instance should get a public IP.
      List<AWSResourceReference> getSecurityGroups()
      securityGroups is an array of references to security groups that should be applied to the instance.
      SpotMarketOptions getSpotMarketOptions()
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      AWSResourceReference getSubnet()
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      List<TagSpecification> getTags()
      tags is the set of tags to add to apply to an instance, in addition to the ones added by default by the actuator.
      io.fabric8.kubernetes.api.model.LocalObjectReference getUserDataSecret()
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      void setAdditionalProperties​(Map<String,​Object> additionalProperties)  
      void setAdditionalProperty​(String name, Object value)  
      void setAmi​(AWSResourceReference ami)
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      void setApiVersion​(String apiVersion)
      APIVersion defines the versioned schema of this representation of an object.
      void setBlockDevices​(List<BlockDeviceMappingSpec> blockDevices)
      blockDevices is the set of block device mapping associated to this instance, block device without a name will be used as a root device and only one device without a name is allowed https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
      void setCapacityReservationId​(String capacityReservationId)
      capacityReservationId specifies the target Capacity Reservation into which the instance should be launched.
      void setCredentialsSecret​(io.fabric8.kubernetes.api.model.LocalObjectReference credentialsSecret)
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      void setDeviceIndex​(Long deviceIndex)
      deviceIndex is the index of the device on the instance for the network interface attachment.
      void setIamInstanceProfile​(AWSResourceReference iamInstanceProfile)
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      void setInstanceType​(String instanceType)
      instanceType is the type of instance to create.
      void setKeyName​(String keyName)
      keyName is the name of the KeyPair to use for SSH
      void setKind​(String kind)
      Kind is a string value representing the REST resource this object represents.
      void setLoadBalancers​(List<LoadBalancerReference> loadBalancers)
      loadBalancers is the set of load balancers to which the new instance should be added once it is created.
      void setMarketType​(String marketType)
      marketType specifies the type of market for the EC2 instance.
      void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      void setMetadataServiceOptions​(MetadataServiceOptions metadataServiceOptions)
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      void setNetworkInterfaceType​(String networkInterfaceType)
      networkInterfaceType specifies the type of network interface to be used for the primary network interface.
      void setPlacement​(Placement placement)
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      void setPlacementGroupName​(String placementGroupName)
      placementGroupName specifies the name of the placement group in which to launch the instance.
      void setPlacementGroupPartition​(Integer placementGroupPartition)
      placementGroupPartition is the partition number within the placement group in which to launch the instance.
      void setPublicIp​(Boolean publicIp)
      publicIp specifies whether the instance should get a public IP.
      void setSecurityGroups​(List<AWSResourceReference> securityGroups)
      securityGroups is an array of references to security groups that should be applied to the instance.
      void setSpotMarketOptions​(SpotMarketOptions spotMarketOptions)
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      void setSubnet​(AWSResourceReference subnet)
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      void setTags​(List<TagSpecification> tags)
      tags is the set of tags to add to apply to an instance, in addition to the ones added by default by the actuator.
      void setUserDataSecret​(io.fabric8.kubernetes.api.model.LocalObjectReference userDataSecret)
      AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
      AWSMachineProviderConfigBuilder toBuilder()  

      • Methods inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

        addFinalizer, addOwnerReference, addOwnerReference, getFinalizers, getFullResourceName, getOwnerReferenceFor, getOwnerReferenceFor, getPlural, getSingular, hasFinalizer, hasOwnerReferenceFor, hasOwnerReferenceFor, initNameAndNamespaceFrom, isFinalizerValid, isMarkedForDeletion, optionalMetadata, removeFinalizer, removeOwnerReference, removeOwnerReference

    • Method Detail

      • getAmi

        public AWSResourceReference getAmi()
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setAmi

        public void setAmi​(AWSResourceReference ami)
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getApiVersion

        public String getApiVersion()
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        getApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setApiVersion

        public void setApiVersion​(String apiVersion)
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        setApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getBlockDevices

        public List<BlockDeviceMappingSpec> getBlockDevices()
        blockDevices is the set of block device mapping associated to this instance, block device without a name will be used as a root device and only one device without a name is allowed https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

      • setBlockDevices

        public void setBlockDevices​(List<BlockDeviceMappingSpec> blockDevices)
        blockDevices is the set of block device mapping associated to this instance, block device without a name will be used as a root device and only one device without a name is allowed https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

      • getCapacityReservationId

        public String getCapacityReservationId()
        capacityReservationId specifies the target Capacity Reservation into which the instance should be launched. The field size should be greater than 0 and the field input must start with cr-***

      • setCapacityReservationId

        public void setCapacityReservationId​(String capacityReservationId)
        capacityReservationId specifies the target Capacity Reservation into which the instance should be launched. The field size should be greater than 0 and the field input must start with cr-***

      • getCredentialsSecret

        public io.fabric8.kubernetes.api.model.LocalObjectReference getCredentialsSecret()
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setCredentialsSecret

        public void setCredentialsSecret​(io.fabric8.kubernetes.api.model.LocalObjectReference credentialsSecret)
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getDeviceIndex

        public Long getDeviceIndex()
        deviceIndex is the index of the device on the instance for the network interface attachment. Defaults to 0.

      • setDeviceIndex

        public void setDeviceIndex​(Long deviceIndex)
        deviceIndex is the index of the device on the instance for the network interface attachment. Defaults to 0.

      • getIamInstanceProfile

        public AWSResourceReference getIamInstanceProfile()
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setIamInstanceProfile

        public void setIamInstanceProfile​(AWSResourceReference iamInstanceProfile)
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getInstanceType

        public String getInstanceType()
        instanceType is the type of instance to create. Example: m4.xlarge

      • setInstanceType

        public void setInstanceType​(String instanceType)
        instanceType is the type of instance to create. Example: m4.xlarge

      • getKeyName

        public String getKeyName()
        keyName is the name of the KeyPair to use for SSH

      • setKeyName

        public void setKeyName​(String keyName)
        keyName is the name of the KeyPair to use for SSH

      • getKind

        public String getKind()
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
        Specified by:
        getKind in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setKind

        public void setKind​(String kind)
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      • getLoadBalancers

        public List<LoadBalancerReference> getLoadBalancers()
        loadBalancers is the set of load balancers to which the new instance should be added once it is created.

      • setLoadBalancers

        public void setLoadBalancers​(List<LoadBalancerReference> loadBalancers)
        loadBalancers is the set of load balancers to which the new instance should be added once it is created.

      • getMarketType

        public String getMarketType()
        marketType specifies the type of market for the EC2 instance. Valid values are OnDemand, Spot, CapacityBlock and omitted.


        Defaults to OnDemand. When SpotMarketOptions is provided, the marketType defaults to "Spot".


        When set to OnDemand the instance runs as a standard OnDemand instance. When set to Spot the instance runs as a Spot instance. When set to CapacityBlock the instance utilizes pre-purchased compute capacity (capacity blocks) with AWS Capacity Reservations. If this value is selected, capacityReservationID must be specified to identify the target reservation.

      • setMarketType

        public void setMarketType​(String marketType)
        marketType specifies the type of market for the EC2 instance. Valid values are OnDemand, Spot, CapacityBlock and omitted.


        Defaults to OnDemand. When SpotMarketOptions is provided, the marketType defaults to "Spot".


        When set to OnDemand the instance runs as a standard OnDemand instance. When set to Spot the instance runs as a Spot instance. When set to CapacityBlock the instance utilizes pre-purchased compute capacity (capacity blocks) with AWS Capacity Reservations. If this value is selected, capacityReservationID must be specified to identify the target reservation.

      • getMetadata

        public io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
        Specified by:
        getMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setMetadata

        public void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
        Specified by:
        setMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getMetadataServiceOptions

        public MetadataServiceOptions getMetadataServiceOptions()
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setMetadataServiceOptions

        public void setMetadataServiceOptions​(MetadataServiceOptions metadataServiceOptions)
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getNetworkInterfaceType

        public String getNetworkInterfaceType()
        networkInterfaceType specifies the type of network interface to be used for the primary network interface. Valid values are "ENA", "EFA", and omitted, which means no opinion and the platform chooses a good default which may change over time. The current default value is "ENA". Please visit https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html to learn more about the AWS Elastic Fabric Adapter interface option.

      • setNetworkInterfaceType

        public void setNetworkInterfaceType​(String networkInterfaceType)
        networkInterfaceType specifies the type of network interface to be used for the primary network interface. Valid values are "ENA", "EFA", and omitted, which means no opinion and the platform chooses a good default which may change over time. The current default value is "ENA". Please visit https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html to learn more about the AWS Elastic Fabric Adapter interface option.

      • getPlacement

        public Placement getPlacement()
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setPlacement

        public void setPlacement​(Placement placement)
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getPlacementGroupName

        public String getPlacementGroupName()
        placementGroupName specifies the name of the placement group in which to launch the instance. The placement group must already be created and may use any placement strategy. When omitted, no placement group is used when creating the EC2 instance.

      • setPlacementGroupName

        public void setPlacementGroupName​(String placementGroupName)
        placementGroupName specifies the name of the placement group in which to launch the instance. The placement group must already be created and may use any placement strategy. When omitted, no placement group is used when creating the EC2 instance.

      • getPlacementGroupPartition

        public Integer getPlacementGroupPartition()
        placementGroupPartition is the partition number within the placement group in which to launch the instance. This must be an integer value between 1 and 7. It is only valid if the placement group, referred in `PlacementGroupName` was created with strategy set to partition.

      • setPlacementGroupPartition

        public void setPlacementGroupPartition​(Integer placementGroupPartition)
        placementGroupPartition is the partition number within the placement group in which to launch the instance. This must be an integer value between 1 and 7. It is only valid if the placement group, referred in `PlacementGroupName` was created with strategy set to partition.

      • getPublicIp

        public Boolean getPublicIp()
        publicIp specifies whether the instance should get a public IP. If not present, it should use the default of its subnet.

      • setPublicIp

        public void setPublicIp​(Boolean publicIp)
        publicIp specifies whether the instance should get a public IP. If not present, it should use the default of its subnet.

      • getSecurityGroups

        public List<AWSResourceReference> getSecurityGroups()
        securityGroups is an array of references to security groups that should be applied to the instance.

      • setSecurityGroups

        public void setSecurityGroups​(List<AWSResourceReference> securityGroups)
        securityGroups is an array of references to security groups that should be applied to the instance.

      • getSpotMarketOptions

        public SpotMarketOptions getSpotMarketOptions()
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setSpotMarketOptions

        public void setSpotMarketOptions​(SpotMarketOptions spotMarketOptions)
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getSubnet

        public AWSResourceReference getSubnet()
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setSubnet

        public void setSubnet​(AWSResourceReference subnet)
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getTags

        public List<TagSpecification> getTags()
        tags is the set of tags to add to apply to an instance, in addition to the ones added by default by the actuator. These tags are additive. The actuator will ensure these tags are present, but will not remove any other tags that may exist on the instance.

      • setTags

        public void setTags​(List<TagSpecification> tags)
        tags is the set of tags to add to apply to an instance, in addition to the ones added by default by the actuator. These tags are additive. The actuator will ensure these tags are present, but will not remove any other tags that may exist on the instance.

      • getUserDataSecret

        public io.fabric8.kubernetes.api.model.LocalObjectReference getUserDataSecret()
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • setUserDataSecret

        public void setUserDataSecret​(io.fabric8.kubernetes.api.model.LocalObjectReference userDataSecret)
        AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)