software.amazon.awssdk.services.eks.model

Class CreateFargateProfileRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eks.model.EksRequest

software.amazon.awssdk.services.eks.model.CreateFargateProfileRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFargateProfileRequest.Builder,CreateFargateProfileRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFargateProfileRequest
extends EksRequest
implements ToCopyableBuilder<CreateFargateProfileRequest.Builder,CreateFargateProfileRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFargateProfileRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateFargateProfileRequest.Builder	builder()
String	clientRequestToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	clusterName() The name of the Amazon EKS cluster to apply the Fargate profile to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fargateProfileName() The name of the Fargate profile.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSelectors() For responses, this returns true if the service returned a value for the Selectors property.
boolean	hasSubnets() For responses, this returns true if the service returned a value for the Subnets property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	podExecutionRoleArn() 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 CreateFargateProfileRequest.Builder>	serializableBuilderClass()
List<String>	subnets() The IDs of subnets to launch your pods into.
Map<String,String>	tags() The metadata to apply to the Fargate profile to assist with categorization and organization.
CreateFargateProfileRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

clusterName

public final String clusterName()

The name of the Amazon EKS cluster to apply the Fargate profile to.

Returns:

The name of the Amazon EKS cluster to apply the Fargate profile to.

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. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. 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. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. 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 your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.

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 your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.

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 pods to use this Fargate profile. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a 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. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.

clientRequestToken

public final String clientRequestToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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()

The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. 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 to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. 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 CreateFargateProfileRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFargateProfileRequest.Builder,CreateFargateProfileRequest>

Specified by:

toBuilder in class EksRequest

builder

public static CreateFargateProfileRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo