Class FargateProfile

java.lang.Object
software.amazon.awssdk.services.eks.model.FargateProfile
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FargateProfile.Builder,FargateProfile>
@Generated("software.amazon.awssdk:codegen") public final class FargateProfile extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FargateProfile.Builder,FargateProfile>

An object representing an Fargate profile.

See Also:

  • Method Details

    • fargateProfileName

      public final String fargateProfileName()

      The name of the Fargate profile.

      Returns:
      The name of the Fargate profile.

    • fargateProfileArn

      public final String fargateProfileArn()

      The full Amazon Resource Name (ARN) of the Fargate profile.

      Returns:
      The full Amazon Resource Name (ARN) of the Fargate profile.

    • clusterName

      public final String clusterName()

      The name of your cluster.

      Returns:
      The name of your cluster.

    • createdAt

      public final Instant createdAt()

      The Unix epoch timestamp at object creation.

      Returns:
      The Unix epoch timestamp at object creation.

    • podExecutionRoleArn

      public final String podExecutionRoleArn()

      The Amazon Resource Name (ARN) of the Pod execution role to use for any Pod that matches the selectors in the Fargate profile. For more information, see Pod execution role in the Amazon EKS User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the Pod execution role to use for any Pod that matches the selectors in the Fargate profile. For more information, see Pod execution role in the Amazon EKS User Guide.

    • hasSubnets

      public final boolean hasSubnets()
      For responses, this returns true if the service returned a value for the Subnets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • subnets

      public final List<String> subnets()

      The IDs of subnets to launch a Pod into.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnets() method.

      Returns:
      The IDs of subnets to launch a Pod into.

    • hasSelectors

      public final boolean hasSelectors()
      For responses, this returns true if the service returned a value for the Selectors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • selectors

      public final List<FargateProfileSelector> selectors()

      The selectors to match for a Pod to use this Fargate profile.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSelectors() method.

      Returns:
      The selectors to match for a Pod to use this Fargate profile.

    • status

      public final FargateProfileStatus status()

      The current status of the Fargate profile.

      If the service returns an enum value that is not available in the current SDK version, status will return FargateProfileStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the Fargate profile.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the Fargate profile.

      If the service returns an enum value that is not available in the current SDK version, status will return FargateProfileStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the Fargate profile.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

    • health

      public final FargateProfileHealth health()

      The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here.

      Returns:
      The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here.

    • toBuilder

      public FargateProfile.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FargateProfile.Builder,FargateProfile>
      Returns:
      a builder for type T

    • builder

      public static FargateProfile.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FargateProfile.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.