ClusterState class
Input properties used for looking up and filtering Cluster resources.
Constructors
-
ClusterState({Input<
ClusterAccessConfig?> ? accessConfig, Input<String?> ? arn, Input<bool?> ? bootstrapSelfManagedAddons, Input<ClusterCertificateAuthority?> ? certificateAuthority, Input<String?> ? clusterId, Input<ClusterComputeConfig?> ? computeConfig, Input<ClusterControlPlaneScalingConfig?> ? controlPlaneScalingConfig, Input<String?> ? createdAt, Input<List< ? defaultAddonsToRemoves, Input<String> ?>bool?> ? deletionProtection, Input<List< ? enabledClusterLogTypes, Input<String> ?>ClusterEncryptionConfig?> ? encryptionConfig, Input<String?> ? endpoint, Input<bool?> ? forceUpdateVersion, Input<List< ? identities, Input<ClusterIdentity> ?>ClusterKubeApiServerConfig?> ? kubeApiServerConfig, Input<ClusterKubeControllerManagerConfig?> ? kubeControllerManagerConfig, Input<ClusterKubeSchedulerConfig?> ? kubeSchedulerConfig, Input<ClusterKubernetesNetworkConfig?> ? kubernetesNetworkConfig, Input<String?> ? name, Input<ClusterOutpostConfig?> ? outpostConfig, Input<String?> ? platformVersion, Input<String?> ? region, Input<ClusterRemoteNetworkConfig?> ? remoteNetworkConfig, Input<String?> ? roleArn, Input<String?> ? status, Input<ClusterStorageConfig?> ? storageConfig, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>ClusterUpgradePolicy?> ? upgradePolicy, Input<String?> ? version, Input<ClusterVpcConfig?> ? vpcConfig, Input<ClusterZonalShiftConfig?> ? zonalShiftConfig}) -
Creates a new ClusterState.
accessConfigConfiguration block for the access config associated with your cluster, see Amazon EKS Access Entries. Detailed below.arnARN of the cluster.bootstrapSelfManagedAddonsInstall default unmanaged add-ons, such asaws-cni,kube-proxy, and CoreDNS during cluster creation. Iffalse, you must manually install desired add-ons. Changing this value will force a new cluster to be created. Defaults totrue.certificateAuthorityAttribute block containingcertificate-authority-datafor your cluster. Detailed below.clusterIdThe ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud.computeConfigConfiguration block with compute configuration for EKS Auto Mode. Detailed below.controlPlaneScalingConfigConfiguration block for the control plane scaling tier. See EKS Provisioned Control Plane for more information. Detailed below.createdAtUnix epoch timestamp in seconds for when the cluster was created.defaultAddonsToRemovesOptional.deletionProtectionWhether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. Default:false.enabledClusterLogTypesList of the desired control plane logging to enable. For more information, see Amazon EKS Control Plane Logging.encryptionConfigConfiguration block with encryption configuration for the cluster. Detailed below.endpointEndpoint for your Kubernetes API server.forceUpdateVersionForce version update by overriding upgrade-blocking readiness checks when updating a cluster.identitiesAttribute block containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. Detailed below.kubeApiServerConfigConfiguration block for customizing the Kubernetes API server. Detailed below.kubeControllerManagerConfigConfiguration block for customizing the Kubernetes controller manager. Detailed below.kubeSchedulerConfigConfiguration block for customizing the Kubernetes scheduler. Detailed below.kubernetesNetworkConfigConfiguration block with kubernetes network configuration for the cluster. Detailed below. If removed, the provider will only perform drift detection if a configuration value is provided.nameName of the cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (^[0-9A-Za-z][A-Za-z0-9\-_]*$).outpostConfigConfiguration block representing the configuration of your local Amazon EKS cluster on an AWS Outpost. This block isn't available for creating Amazon EKS clusters on the AWS cloud.platformVersionPlatform version for the cluster.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.remoteNetworkConfigConfiguration block with remote network configuration for EKS Hybrid Nodes. Detailed below.roleArnARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. Ensure the resource configuration includes explicit dependencies on the IAM Role permissions by addingdependsOnif using theaws.iam.RolePolicyresource oraws.iam.RolePolicyAttachmentresource, otherwise EKS cannot delete EKS managed EC2 infrastructure such as Security Groups on EKS Cluster deletion.statusStatus of the EKS cluster. One ofCREATING,ACTIVE,DELETING,FAILED.storageConfigConfiguration block with storage configuration for EKS Auto Mode. Detailed below.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.upgradePolicyConfiguration block for the support policy to use for the cluster. See upgradePolicy for details.versionDesired Kubernetes master version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except those automatically triggered by EKS. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by EKS.vpcConfigConfiguration block for the VPC associated with your cluster. 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. Detailed below. Also contains attributes detailed in the Attributes section.zonalShiftConfigConfiguration block with zonal shift configuration for the cluster. Detailed below.const -
ClusterState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
accessConfig
→ Input<
ClusterAccessConfig?> ? -
Configuration block for the access config associated with your cluster, see Amazon EKS Access Entries. Detailed below.
final
-
arn
→ Input<
String?> ? -
ARN of the cluster.
final
-
bootstrapSelfManagedAddons
→ Input<
bool?> ? -
Install default unmanaged add-ons, such as
aws-cni,kube-proxy, and CoreDNS during cluster creation. Iffalse, you must manually install desired add-ons. Changing this value will force a new cluster to be created. Defaults totrue.final -
certificateAuthority
→ Input<
ClusterCertificateAuthority?> ? -
Attribute block containing
certificate-authority-datafor your cluster. Detailed below.final -
clusterId
→ Input<
String?> ? -
The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud.
final
-
computeConfig
→ Input<
ClusterComputeConfig?> ? -
Configuration block with compute configuration for EKS Auto Mode. Detailed below.
final
-
controlPlaneScalingConfig
→ Input<
ClusterControlPlaneScalingConfig?> ? -
Configuration block for the control plane scaling tier. See EKS Provisioned Control Plane for more information. Detailed below.
final
-
createdAt
→ Input<
String?> ? -
Unix epoch timestamp in seconds for when the cluster was created.
final
-
defaultAddonsToRemoves
→ Input<
List< ?String> ?> -
final
-
deletionProtection
→ Input<
bool?> ? -
Whether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. Default:
false.final -
enabledClusterLogTypes
→ Input<
List< ?String> ?> -
List of the desired control plane logging to enable. For more information, see Amazon EKS Control Plane Logging.
final
-
encryptionConfig
→ Input<
ClusterEncryptionConfig?> ? -
Configuration block with encryption configuration for the cluster. Detailed below.
final
-
endpoint
→ Input<
String?> ? -
Endpoint for your Kubernetes API server.
final
-
forceUpdateVersion
→ Input<
bool?> ? -
Force version update by overriding upgrade-blocking readiness checks when updating a cluster.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identities
→ Input<
List< ?ClusterIdentity> ?> -
Attribute block containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. Detailed below.
final
-
kubeApiServerConfig
→ Input<
ClusterKubeApiServerConfig?> ? -
Configuration block for customizing the Kubernetes API server. Detailed below.
final
-
kubeControllerManagerConfig
→ Input<
ClusterKubeControllerManagerConfig?> ? -
Configuration block for customizing the Kubernetes controller manager. Detailed below.
final
-
kubernetesNetworkConfig
→ Input<
ClusterKubernetesNetworkConfig?> ? -
Configuration block with kubernetes network configuration for the cluster. Detailed below. If removed, the provider will only perform drift detection if a configuration value is provided.
final
-
kubeSchedulerConfig
→ Input<
ClusterKubeSchedulerConfig?> ? -
Configuration block for customizing the Kubernetes scheduler. Detailed below.
final
-
name
→ Input<
String?> ? -
Name of the cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (
^[0-9A-Za-z][A-Za-z0-9\-_]*$).final -
outpostConfig
→ Input<
ClusterOutpostConfig?> ? -
Configuration block representing the configuration of your local Amazon EKS cluster on an AWS Outpost. This block isn't available for creating Amazon EKS clusters on the AWS cloud.
final
-
platformVersion
→ Input<
String?> ? -
Platform version for the cluster.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
remoteNetworkConfig
→ Input<
ClusterRemoteNetworkConfig?> ? -
Configuration block with remote network configuration for EKS Hybrid Nodes. Detailed below.
final
-
roleArn
→ Input<
String?> ? -
ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. Ensure the resource configuration includes explicit dependencies on the IAM Role permissions by adding
dependsOnif using theaws.iam.RolePolicyresource oraws.iam.RolePolicyAttachmentresource, otherwise EKS cannot delete EKS managed EC2 infrastructure such as Security Groups on EKS Cluster deletion.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
→ Input<
String?> ? -
Status of the EKS cluster. One of
CREATING,ACTIVE,DELETING,FAILED.final -
storageConfig
→ Input<
ClusterStorageConfig?> ? -
Configuration block with storage configuration for EKS Auto Mode. Detailed below.
final
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
upgradePolicy
→ Input<
ClusterUpgradePolicy?> ? -
Configuration block for the support policy to use for the cluster. See upgradePolicy for details.
final
-
version
→ Input<
String?> ? -
Desired Kubernetes master version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except those automatically triggered by EKS. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by EKS.
final
-
vpcConfig
→ Input<
ClusterVpcConfig?> ? -
Configuration block for the VPC associated with your cluster. 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. Detailed below. Also contains attributes detailed in the Attributes section.
final
-
zonalShiftConfig
→ Input<
ClusterZonalShiftConfig?> ? -
Configuration block with zonal shift configuration for the cluster. Detailed below.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited