Class CreateClusterRequest

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

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

        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.
      • 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 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.
      • 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.
      • accessConfig

        public final CreateAccessConfigRequest accessConfig()

        The access configuration for the cluster.

        Returns:
        The access configuration for the cluster.
      • bootstrapSelfManagedAddons

        public final Boolean bootstrapSelfManagedAddons()

        If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

        The default networking addons include vpc-cni, coredns, and kube-proxy.

        Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

        Returns:
        If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

        The default networking addons include vpc-cni, coredns, and kube-proxy.

        Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

      • upgradePolicy

        public final UpgradePolicyRequest upgradePolicy()

        New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.

        Returns:
        New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.
      • 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