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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFargateProfile.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FargateProfile.Builderbuilder()StringclusterName()The name of the Amazon EKS cluster that the Fargate profile belongs to.InstantcreatedAt()The Unix epoch timestamp in seconds for when the Fargate profile was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfargateProfileArn()The full Amazon Resource Name (ARN) of the Fargate profile.StringfargateProfileName()The name of the Fargate profile.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSelectors()For responses, this returns true if the service returned a value for the Selectors property.booleanhasSubnets()For responses, this returns true if the service returned a value for the Subnets property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringpodExecutionRoleArn()The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.List<SdkField<?>>sdkFields()List<FargateProfileSelector>selectors()The selectors to match for pods to use this Fargate profile.static Class<? extends FargateProfile.Builder>serializableBuilderClass()FargateProfileStatusstatus()The current status of the Fargate profile.StringstatusAsString()The current status of the Fargate profile.List<String>subnets()The IDs of subnets to launch pods into.Map<String,String>tags()The metadata applied to the Fargate profile to assist with categorization and organization.FargateProfile.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 the Amazon EKS cluster that the Fargate profile belongs to.
- Returns:
- The name of the Amazon EKS cluster that the Fargate profile belongs to.
-
createdAt
public final Instant createdAt()
The Unix epoch timestamp in seconds for when the Fargate profile was created.
- Returns:
- The Unix epoch timestamp in seconds for when the Fargate profile was created.
-
podExecutionRoleArn
public final String podExecutionRoleArn()
The Amazon Resource Name (ARN) of the pod execution role to use for pods that match 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 pods that match 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 theisEmpty()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 pods 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 pods 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 theisEmpty()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 pods 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 pods 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,
statuswill returnFargateProfileStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the Fargate profile.
- See Also:
FargateProfileStatus
-
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,
statuswill returnFargateProfileStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the Fargate profile.
- See Also:
FargateProfileStatus
-
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 theisEmpty()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()
The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
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:
- The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
-
toBuilder
public FargateProfile.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FargateProfile.Builder,FargateProfile>
-
builder
public static FargateProfile.Builder builder()
-
serializableBuilderClass
public static Class<? extends FargateProfile.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-