Class CreateClusterRequest
- 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.CreateClusterRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateClusterRequest extends EksRequest implements ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateClusterRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateClusterRequest.Builderbuilder()StringclientRequestToken()Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.List<EncryptionConfig>encryptionConfig()The encryption configuration for the cluster.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEncryptionConfig()For responses, this returns true if the service returned a value for the EncryptionConfig property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.KubernetesNetworkConfigRequestkubernetesNetworkConfig()The Kubernetes network configuration for the cluster.Logginglogging()Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs.Stringname()The unique name to give to your cluster.OutpostConfigRequestoutpostConfig()An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.VpcConfigRequestresourcesVpcConfig()The VPC configuration that's used by the cluster control plane.StringroleArn()The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.List<SdkField<?>>sdkFields()static Class<? extends CreateClusterRequest.Builder>serializableBuilderClass()Map<String,String>tags()The metadata to apply to the cluster to assist with categorization and organization.CreateClusterRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringversion()The desired Kubernetes version for your cluster.-
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
-
name
public final String name()
The unique name to give to your cluster.
- Returns:
- The unique name to give to your cluster.
-
version
public final String version()
The desired Kubernetes version for your cluster. If you don't specify a value here, the default version available in Amazon EKS is used.
The default version might not be the latest version available.
- Returns:
- The desired Kubernetes version for your cluster. If you don't specify a value here, the default version
available in Amazon EKS is used.
The default version might not be the latest version available.
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .
- Returns:
- The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .
-
resourcesVpcConfig
public final VpcConfigRequest resourcesVpcConfig()
The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane.
- Returns:
- The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane.
-
kubernetesNetworkConfig
public final KubernetesNetworkConfigRequest kubernetesNetworkConfig()
The Kubernetes network configuration for the cluster.
- Returns:
- The Kubernetes network configuration for the cluster.
-
logging
public final Logging logging()
Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
- Returns:
- Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By
default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster
control plane logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
-
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 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 to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
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 cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
-
hasEncryptionConfig
public final boolean hasEncryptionConfig()
For responses, this returns true if the service returned a value for the EncryptionConfig 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.
-
encryptionConfig
public final List<EncryptionConfig> encryptionConfig()
The encryption configuration for the cluster.
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
hasEncryptionConfig()method.- Returns:
- The encryption configuration for the cluster.
-
outpostConfig
public final OutpostConfigRequest outpostConfig()
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters on the Amazon Web Services cloud.
- Returns:
- An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters on the Amazon Web Services cloud.
-
toBuilder
public CreateClusterRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>- Specified by:
toBuilderin classEksRequest
-
builder
public static CreateClusterRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateClusterRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-