FargateProfile (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.eks.model.FargateProfile

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FargateProfile
extends Object
implements Serializable, Cloneable, StructuredPojo

An object representing an AWS Fargate profile.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FargateProfile()

Constructors
Constructor and Description
`FargateProfile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FargateProfile`	`addTagsEntry(String key, String value)` Add a single Tags entry
`FargateProfile`	`clearTagsEntries()` Removes all the entries added into Tags.
`FargateProfile`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getClusterName()` The name of the Amazon EKS cluster that the Fargate profile belongs to.
`Date`	`getCreatedAt()` The Unix epoch timestamp in seconds for when the Fargate profile was created.
`String`	`getFargateProfileArn()` The full Amazon Resource Name (ARN) of the Fargate profile.
`String`	`getFargateProfileName()` The name of the Fargate profile.
`String`	`getPodExecutionRoleArn()` The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.
`List<FargateProfileSelector>`	`getSelectors()` The selectors to match for pods to use this Fargate profile.
`String`	`getStatus()` The current status of the Fargate profile.
`List<String>`	`getSubnets()` The IDs of subnets to launch pods into.
`Map<String,String>`	`getTags()` The metadata applied to the Fargate profile to assist with categorization and organization.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setClusterName(String clusterName)` The name of the Amazon EKS cluster that the Fargate profile belongs to.
`void`	`setCreatedAt(Date createdAt)` The Unix epoch timestamp in seconds for when the Fargate profile was created.
`void`	`setFargateProfileArn(String fargateProfileArn)` The full Amazon Resource Name (ARN) of the Fargate profile.
`void`	`setFargateProfileName(String fargateProfileName)` The name of the Fargate profile.
`void`	`setPodExecutionRoleArn(String podExecutionRoleArn)` The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.
`void`	`setSelectors(Collection<FargateProfileSelector> selectors)` The selectors to match for pods to use this Fargate profile.
`void`	`setStatus(String status)` The current status of the Fargate profile.
`void`	`setSubnets(Collection<String> subnets)` The IDs of subnets to launch pods into.
`void`	`setTags(Map<String,String> tags)` The metadata applied to the Fargate profile to assist with categorization and organization.
`String`	`toString()` Returns a string representation of this object.
`FargateProfile`	`withClusterName(String clusterName)` The name of the Amazon EKS cluster that the Fargate profile belongs to.
`FargateProfile`	`withCreatedAt(Date createdAt)` The Unix epoch timestamp in seconds for when the Fargate profile was created.
`FargateProfile`	`withFargateProfileArn(String fargateProfileArn)` The full Amazon Resource Name (ARN) of the Fargate profile.
`FargateProfile`	`withFargateProfileName(String fargateProfileName)` The name of the Fargate profile.
`FargateProfile`	`withPodExecutionRoleArn(String podExecutionRoleArn)` The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.
`FargateProfile`	`withSelectors(Collection<FargateProfileSelector> selectors)` The selectors to match for pods to use this Fargate profile.
`FargateProfile`	`withSelectors(FargateProfileSelector... selectors)` The selectors to match for pods to use this Fargate profile.
`FargateProfile`	`withStatus(FargateProfileStatus status)` The current status of the Fargate profile.
`FargateProfile`	`withStatus(String status)` The current status of the Fargate profile.
`FargateProfile`	`withSubnets(Collection<String> subnets)` The IDs of subnets to launch pods into.
`FargateProfile`	`withSubnets(String... subnets)` The IDs of subnets to launch pods into.
`FargateProfile`	`withTags(Map<String,String> tags)` The metadata applied to the Fargate profile to assist with categorization and organization.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FargateProfile
```
public FargateProfile()
```
- Method Detail
  - setFargateProfileName
```
public void setFargateProfileName(String fargateProfileName)
```
    The name of the Fargate profile.
    
    Parameters:
    
    fargateProfileName - The name of the Fargate profile.
  - getFargateProfileName
```
public String getFargateProfileName()
```
    The name of the Fargate profile.
    
    Returns:
    
    The name of the Fargate profile.
  - withFargateProfileName
```
public FargateProfile withFargateProfileName(String fargateProfileName)
```
    The name of the Fargate profile.
    
    Parameters:
    
    fargateProfileName - The name of the Fargate profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFargateProfileArn
```
public void setFargateProfileArn(String fargateProfileArn)
```
    The full Amazon Resource Name (ARN) of the Fargate profile.
    
    Parameters:
    
    fargateProfileArn - The full Amazon Resource Name (ARN) of the Fargate profile.
  - getFargateProfileArn
```
public String getFargateProfileArn()
```
    The full Amazon Resource Name (ARN) of the Fargate profile.
    
    Returns:
    
    The full Amazon Resource Name (ARN) of the Fargate profile.
  - withFargateProfileArn
```
public FargateProfile withFargateProfileArn(String fargateProfileArn)
```
    The full Amazon Resource Name (ARN) of the Fargate profile.
    
    Parameters:
    
    fargateProfileArn - The full Amazon Resource Name (ARN) of the Fargate profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterName
```
public void setClusterName(String clusterName)
```
    The name of the Amazon EKS cluster that the Fargate profile belongs to.
    
    Parameters:
    
    clusterName - The name of the Amazon EKS cluster that the Fargate profile belongs to.
  - getClusterName
```
public String getClusterName()
```
    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.
  - withClusterName
```
public FargateProfile withClusterName(String clusterName)
```
    The name of the Amazon EKS cluster that the Fargate profile belongs to.
    
    Parameters:
    
    clusterName - The name of the Amazon EKS cluster that the Fargate profile belongs to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The Unix epoch timestamp in seconds for when the Fargate profile was created.
    
    Parameters:
    
    createdAt - The Unix epoch timestamp in seconds for when the Fargate profile was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    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.
  - withCreatedAt
```
public FargateProfile withCreatedAt(Date createdAt)
```
    The Unix epoch timestamp in seconds for when the Fargate profile was created.
    
    Parameters:
    
    createdAt - The Unix epoch timestamp in seconds for when the Fargate profile was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPodExecutionRoleArn
```
public void setPodExecutionRoleArn(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.
    
    Parameters:
    
    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.
  - getPodExecutionRoleArn
```
public String getPodExecutionRoleArn()
```
    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.
  - withPodExecutionRoleArn
```
public FargateProfile withPodExecutionRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubnets
```
public List<String> getSubnets()
```
    The IDs of subnets to launch pods into.
    
    Returns:
    
    The IDs of subnets to launch pods into.
  - setSubnets
```
public void setSubnets(Collection<String> subnets)
```
    The IDs of subnets to launch pods into.
    
    Parameters:
    
    subnets - The IDs of subnets to launch pods into.
  - withSubnets
```
public FargateProfile withSubnets(String... subnets)
```
    The IDs of subnets to launch pods into.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubnets(java.util.Collection) or withSubnets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    subnets - The IDs of subnets to launch pods into.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnets
```
public FargateProfile withSubnets(Collection<String> subnets)
```
    The IDs of subnets to launch pods into.
    
    Parameters:
    
    subnets - The IDs of subnets to launch pods into.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSelectors
```
public List<FargateProfileSelector> getSelectors()
```
    The selectors to match for pods to use this Fargate profile.
    
    Returns:
    
    The selectors to match for pods to use this Fargate profile.
  - setSelectors
```
public void setSelectors(Collection<FargateProfileSelector> selectors)
```
    The selectors to match for pods to use this Fargate profile.
    
    Parameters:
    
    selectors - The selectors to match for pods to use this Fargate profile.
  - withSelectors
```
public FargateProfile withSelectors(FargateProfileSelector... selectors)
```
    The selectors to match for pods to use this Fargate profile.
    
    NOTE: This method appends the values to the existing list (if any). Use setSelectors(java.util.Collection) or withSelectors(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    selectors - The selectors to match for pods to use this Fargate profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSelectors
```
public FargateProfile withSelectors(Collection<FargateProfileSelector> selectors)
```
    The selectors to match for pods to use this Fargate profile.
    
    Parameters:
    
    selectors - The selectors to match for pods to use this Fargate profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the Fargate profile.
    
    Parameters:
    
    status - The current status of the Fargate profile.
    
    See Also:
    
    FargateProfileStatus
  - getStatus
```
public String getStatus()
```
    The current status of the Fargate profile.
    
    Returns:
    
    The current status of the Fargate profile.
    
    See Also:
    
    FargateProfileStatus
  - withStatus
```
public FargateProfile withStatus(String status)
```
    The current status of the Fargate profile.
    
    Parameters:
    
    status - The current status of the Fargate profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FargateProfileStatus
  - withStatus
```
public FargateProfile withStatus(FargateProfileStatus status)
```
    The current status of the Fargate profile.
    
    Parameters:
    
    status - The current status of the Fargate profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FargateProfileStatus
  - getTags
```
public Map<String,String> getTags()
```
    The metadata applied 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.
    
    Returns:
    
    The metadata applied 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.
  - setTags
```
public void setTags(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, 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.
    
    Parameters:
    
    tags - The metadata applied 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.
  - withTags
```
public FargateProfile withTags(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, 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.
    
    Parameters:
    
    tags - The metadata applied 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public FargateProfile addTagsEntry(String key,
                                   String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public FargateProfile clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FargateProfile clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class FargateProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FargateProfile

Method Detail

setFargateProfileName

getFargateProfileName

withFargateProfileName

setFargateProfileArn

getFargateProfileArn

withFargateProfileArn

setClusterName

getClusterName

withClusterName

setCreatedAt

getCreatedAt

withCreatedAt

setPodExecutionRoleArn

getPodExecutionRoleArn

withPodExecutionRoleArn

getSubnets

setSubnets

withSubnets

withSubnets

getSelectors

setSelectors

withSelectors

withSelectors

setStatus

getStatus

withStatus

withStatus

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall