Class CreateFargateProfileRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateFargateProfileRequest.Builder,
CreateFargateProfileRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final String
The name of your cluster.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name of the Fargate profile.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Selectors property.final boolean
For responses, this returns true if the service returned a value for the Subnets property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of thePod
execution role to use for aPod
that matches the selectors in the Fargate profile.final List
<FargateProfileSelector> The selectors to match for aPod
to use this Fargate profile.static Class
<? extends CreateFargateProfileRequest.Builder> subnets()
The IDs of subnets to launch aPod
into.tags()
Metadata that assists with categorization and organization.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fargateProfileName
The name of the Fargate profile.
- Returns:
- The name of the Fargate profile.
-
clusterName
The name of your cluster.
- Returns:
- The name of your cluster.
-
podExecutionRoleArn
The Amazon Resource Name (ARN) of the
Pod
execution role to use for aPod
that matches the selectors in the Fargate profile. ThePod
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, seePod
execution role in the Amazon EKS User Guide.- Returns:
- The Amazon Resource Name (ARN) of the
Pod
execution role to use for aPod
that matches the selectors in the Fargate profile. ThePod
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, seePod
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
The IDs of subnets to launch a
Pod
into. APod
running on Fargate isn't assigned a public IP address, 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 a
Pod
into. APod
running on Fargate isn't assigned a public IP address, 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 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
The selectors to match for a
Pod
to use this Fargate profile. Each selector must have an associated Kubernetesnamespace
. Optionally, you can also specifylabels
for anamespace
. 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 a
Pod
to use this Fargate profile. Each selector must have an associated Kubernetesnamespace
. Optionally, you can also specifylabels
for anamespace
. You may specify up to five selectors in a Fargate profile.
-
clientRequestToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Returns:
- A 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 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
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.
-
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 interfaceToCopyableBuilder<CreateFargateProfileRequest.Builder,
CreateFargateProfileRequest> - Specified by:
toBuilder
in classEksRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-