ClusterState class

Input properties used for looking up and filtering Cluster resources.

Constructors

ClusterState({Input<ClusterBrokerCapacityConfig?>? brokerCapacityConfig, Input<ClusterCapacityConfig?>? capacityConfig, Input<String?>? clusterId, Input<String?>? createTime, Input<String?>? deletionPolicy, Input<Map<String, String>?>? effectiveLabels, Input<ClusterGcpConfig?>? gcpConfig, Input<Map<String, String>?>? labels, Input<String?>? location, Input<String?>? name, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<ClusterRebalanceConfig?>? rebalanceConfig, Input<String?>? state, Input<ClusterTlsConfig?>? tlsConfig, Input<String?>? updateTime})
Creates a new ClusterState. brokerCapacityConfig Capacity configuration at a per-broker level within the Kafka cluster. The config will be appled to each broker in the cluster. capacityConfig A capacity configuration of a Kafka cluster. clusterId The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression a-z? to comply with RFC 1035. This value is structured like: my-cluster-id. createTime The time when the cluster was created. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. gcpConfig Configuration properties for a Kafka cluster deployed to Google Cloud Platform. labels List of label KEY=VALUE pairs to add. Keys must start with a lowercase character and contain only hyphens (-), underscores ( ), lowercase characters, and numbers. Values must contain only hyphens (-), underscores ( ), lowercase characters, and numbers. location ID of the location of the Kafka resource. See https://cloud.google.com/managed-kafka/docs/locations for a list of supported locations. name The name of the cluster. Structured like: projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID. project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource rebalanceConfig Defines rebalancing behavior of a Kafka cluster. state The current state of the cluster. Possible values: STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING. tlsConfig TLS configuration for the Kafka cluster. This is used to configure mTLS authentication. To clear our a TLS configuration that has been previously set, please explicitly add an empty tlsConfig block. updateTime The time when the cluster was last updated.
const
ClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

brokerCapacityConfig → Input<ClusterBrokerCapacityConfig?>?
Capacity configuration at a per-broker level within the Kafka cluster. The config will be appled to each broker in the cluster. Structure is documented below.
final
capacityConfig → Input<ClusterCapacityConfig?>?
A capacity configuration of a Kafka cluster. Structure is documented below.
final
clusterId → Input<String?>?
The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression a-z? to comply with RFC 1035. This value is structured like: my-cluster-id.
final
createTime → Input<String?>?
The time when the cluster was created.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
gcpConfig → Input<ClusterGcpConfig?>?
Configuration properties for a Kafka cluster deployed to Google Cloud Platform. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>?>?
List of label KEY=VALUE pairs to add. Keys must start with a lowercase character and contain only hyphens (-), underscores ( ), lowercase characters, and numbers. Values must contain only hyphens (-), underscores ( ), lowercase characters, and numbers. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
final
location → Input<String?>?
ID of the location of the Kafka resource. See https://cloud.google.com/managed-kafka/docs/locations for a list of supported locations.
final
name → Input<String?>?
The name of the cluster. Structured like: projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
rebalanceConfig → Input<ClusterRebalanceConfig?>?
Defines rebalancing behavior of a Kafka cluster. Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → Input<String?>?
The current state of the cluster. Possible values: STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING.
final
tlsConfig → Input<ClusterTlsConfig?>?
TLS configuration for the Kafka cluster. This is used to configure mTLS authentication. To clear our a TLS configuration that has been previously set, please explicitly add an empty tlsConfig block. Structure is documented below.
final
updateTime → Input<String?>?
The time when the cluster was last updated.
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