Interface Cluster.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Cluster.Builder,
,Cluster> SdkBuilder<Cluster.Builder,
,Cluster> SdkPojo
- Enclosing class:
Cluster
-
Method Summary
Modifier and TypeMethodDescriptiondefault Cluster.Builder
accessConfig
(Consumer<AccessConfigResponse.Builder> accessConfig) The access configuration for the cluster.accessConfig
(AccessConfigResponse accessConfig) The access configuration for the cluster.The Amazon Resource Name (ARN) of the cluster.default Cluster.Builder
certificateAuthority
(Consumer<Certificate.Builder> certificateAuthority) Thecertificate-authority-data
for your cluster.certificateAuthority
(Certificate certificateAuthority) Thecertificate-authority-data
for your cluster.clientRequestToken
(String clientRequestToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.default Cluster.Builder
connectorConfig
(Consumer<ConnectorConfigResponse.Builder> connectorConfig) The configuration used to connect to a cluster for registration.connectorConfig
(ConnectorConfigResponse connectorConfig) The configuration used to connect to a cluster for registration.The Unix epoch timestamp at object creation.encryptionConfig
(Collection<EncryptionConfig> encryptionConfig) The encryption configuration for the cluster.encryptionConfig
(Consumer<EncryptionConfig.Builder>... encryptionConfig) The encryption configuration for the cluster.encryptionConfig
(EncryptionConfig... encryptionConfig) The encryption configuration for the cluster.The endpoint for your Kubernetes API server.default Cluster.Builder
health
(Consumer<ClusterHealth.Builder> health) An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost.health
(ClusterHealth health) An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost.The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost.default Cluster.Builder
identity
(Consumer<Identity.Builder> identity) The identity provider information for the cluster.The identity provider information for the cluster.default Cluster.Builder
kubernetesNetworkConfig
(Consumer<KubernetesNetworkConfigResponse.Builder> kubernetesNetworkConfig) The Kubernetes network configuration for the cluster.kubernetesNetworkConfig
(KubernetesNetworkConfigResponse kubernetesNetworkConfig) The Kubernetes network configuration for the cluster.default Cluster.Builder
logging
(Consumer<Logging.Builder> logging) The logging configuration for your cluster.The logging configuration for your cluster.The name of your cluster.default Cluster.Builder
outpostConfig
(Consumer<OutpostConfigResponse.Builder> outpostConfig) An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.outpostConfig
(OutpostConfigResponse outpostConfig) An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.platformVersion
(String platformVersion) The platform version of your Amazon EKS cluster.default Cluster.Builder
resourcesVpcConfig
(Consumer<VpcConfigResponse.Builder> resourcesVpcConfig) The VPC configuration used by the cluster control plane.resourcesVpcConfig
(VpcConfigResponse resourcesVpcConfig) The VPC configuration used by the cluster control plane.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.The current status of the cluster.status
(ClusterStatus status) The current status of the cluster.Metadata that assists with categorization and organization.The Kubernetes server version for the cluster.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of your cluster.
- Parameters:
name
- The name of your cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
The Amazon Resource Name (ARN) of the cluster.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
The Unix epoch timestamp at object creation.
- Parameters:
createdAt
- The Unix epoch timestamp at object creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
version
The Kubernetes server version for the cluster.
- Parameters:
version
- The Kubernetes server version for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpoint
The endpoint for your Kubernetes API server.
- Parameters:
endpoint
- The endpoint for your Kubernetes API server.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourcesVpcConfig
The VPC configuration 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.
- Parameters:
resourcesVpcConfig
- The VPC configuration 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourcesVpcConfig
The VPC configuration 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.
This is a convenience method that creates an instance of theVpcConfigResponse.Builder
avoiding the need to create one manually viaVpcConfigResponse.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourcesVpcConfig(VpcConfigResponse)
.- Parameters:
resourcesVpcConfig
- a consumer that will call methods onVpcConfigResponse.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
kubernetesNetworkConfig
The Kubernetes network configuration for the cluster.
- Parameters:
kubernetesNetworkConfig
- The Kubernetes network configuration for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kubernetesNetworkConfig
default Cluster.Builder kubernetesNetworkConfig(Consumer<KubernetesNetworkConfigResponse.Builder> kubernetesNetworkConfig) The Kubernetes network configuration for the cluster.
This is a convenience method that creates an instance of theKubernetesNetworkConfigResponse.Builder
avoiding the need to create one manually viaKubernetesNetworkConfigResponse.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokubernetesNetworkConfig(KubernetesNetworkConfigResponse)
.- Parameters:
kubernetesNetworkConfig
- a consumer that will call methods onKubernetesNetworkConfigResponse.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logging
The logging configuration for your cluster.
- Parameters:
logging
- The logging configuration for your cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logging
The logging configuration for your cluster.
This is a convenience method that creates an instance of theLogging.Builder
avoiding the need to create one manually viaLogging.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologging(Logging)
.- Parameters:
logging
- a consumer that will call methods onLogging.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
identity
The identity provider information for the cluster.
- Parameters:
identity
- The identity provider information for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
identity
The identity provider information for the cluster.
This is a convenience method that creates an instance of theIdentity.Builder
avoiding the need to create one manually viaIdentity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toidentity(Identity)
.- Parameters:
identity
- a consumer that will call methods onIdentity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The current status of the cluster.
- Parameters:
status
- The current status of the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The current status of the cluster.
- Parameters:
status
- The current status of the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
certificateAuthority
The
certificate-authority-data
for your cluster.- Parameters:
certificateAuthority
- Thecertificate-authority-data
for your cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificateAuthority
The
This is a convenience method that creates an instance of thecertificate-authority-data
for your cluster.Certificate.Builder
avoiding the need to create one manually viaCertificate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocertificateAuthority(Certificate)
.- Parameters:
certificateAuthority
- a consumer that will call methods onCertificate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientRequestToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Parameters:
clientRequestToken
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformVersion
The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
- Parameters:
platformVersion
- The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionConfig
The encryption configuration for the cluster.
- Parameters:
encryptionConfig
- The encryption configuration for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionConfig
The encryption configuration for the cluster.
- Parameters:
encryptionConfig
- The encryption configuration for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionConfig
The encryption configuration for the cluster.
This is a convenience method that creates an instance of theEncryptionConfig.Builder
avoiding the need to create one manually viaEncryptionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionConfig(List<EncryptionConfig>)
.- Parameters:
encryptionConfig
- a consumer that will call methods onEncryptionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
connectorConfig
The configuration used to connect to a cluster for registration.
- Parameters:
connectorConfig
- The configuration used to connect to a cluster for registration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
connectorConfig
The configuration used to connect to a cluster for registration.
This is a convenience method that creates an instance of theConnectorConfigResponse.Builder
avoiding the need to create one manually viaConnectorConfigResponse.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconnectorConfig(ConnectorConfigResponse)
.- Parameters:
connectorConfig
- a consumer that will call methods onConnectorConfigResponse.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
id
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
- Parameters:
id
- The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
health
An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
- Parameters:
health
- An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
health
An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
This is a convenience method that creates an instance of theClusterHealth.Builder
avoiding the need to create one manually viaClusterHealth.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohealth(ClusterHealth)
.- Parameters:
health
- a consumer that will call methods onClusterHealth.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outpostConfig
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
- Parameters:
outpostConfig
- An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outpostConfig
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
This is a convenience method that creates an instance of theOutpostConfigResponse.Builder
avoiding the need to create one manually viaOutpostConfigResponse.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutpostConfig(OutpostConfigResponse)
.- Parameters:
outpostConfig
- a consumer that will call methods onOutpostConfigResponse.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
accessConfig
The access configuration for the cluster.
- Parameters:
accessConfig
- The access configuration for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessConfig
The access configuration for the cluster.
This is a convenience method that creates an instance of theAccessConfigResponse.Builder
avoiding the need to create one manually viaAccessConfigResponse.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaccessConfig(AccessConfigResponse)
.- Parameters:
accessConfig
- a consumer that will call methods onAccessConfigResponse.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-