pulumi-azure-native-kotlin/com.pulumi.azurenative.dbforpostgresql.kotlin.outputs/GetClusterResult

GetClusterResult

data class GetClusterResult(val administratorLogin: String, val citusVersion: String? = null, val coordinatorEnablePublicIpAccess: Boolean? = null, val coordinatorServerEdition: String? = null, val coordinatorStorageQuotaInMb: Int? = null, val coordinatorVCores: Int? = null, val earliestRestoreTime: String, val enableHa: Boolean? = null, val enableShardsOnCoordinator: Boolean? = null, val id: String, val location: String, val maintenanceWindow: MaintenanceWindowResponse? = null, val name: String, val nodeCount: Int? = null, val nodeEnablePublicIpAccess: Boolean? = null, val nodeServerEdition: String? = null, val nodeStorageQuotaInMb: Int? = null, val nodeVCores: Int? = null, val pointInTimeUTC: String? = null, val postgresqlVersion: String? = null, val preferredPrimaryZone: String? = null, val privateEndpointConnections: List<SimplePrivateEndpointConnectionResponse>, val provisioningState: String, val readReplicas: List<String>, val serverNames: List<ServerNameItemResponse>, val sourceLocation: String? = null, val sourceResourceId: String? = null, val state: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a cluster.

Constructors

Link copied to clipboard
constructor(administratorLogin: String, citusVersion: String? = null, coordinatorEnablePublicIpAccess: Boolean? = null, coordinatorServerEdition: String? = null, coordinatorStorageQuotaInMb: Int? = null, coordinatorVCores: Int? = null, earliestRestoreTime: String, enableHa: Boolean? = null, enableShardsOnCoordinator: Boolean? = null, id: String, location: String, maintenanceWindow: MaintenanceWindowResponse? = null, name: String, nodeCount: Int? = null, nodeEnablePublicIpAccess: Boolean? = null, nodeServerEdition: String? = null, nodeStorageQuotaInMb: Int? = null, nodeVCores: Int? = null, pointInTimeUTC: String? = null, postgresqlVersion: String? = null, preferredPrimaryZone: String? = null, privateEndpointConnections: List<SimplePrivateEndpointConnectionResponse>, provisioningState: String, readReplicas: List<String>, serverNames: List<ServerNameItemResponse>, sourceLocation: String? = null, sourceResourceId: String? = null, state: String, systemData: SystemDataResponse, tags: Map<String, String>? = null, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val administratorLogin: String

The administrator's login name of the servers in the cluster.

Link copied to clipboard
val citusVersion: String? = null

The Citus extension version on all cluster servers.

Link copied to clipboard
val coordinatorEnablePublicIpAccess: Boolean? = null

If public access is enabled on coordinator.

Link copied to clipboard
val coordinatorServerEdition: String? = null

The edition of a coordinator server (default: GeneralPurpose). Required for creation.

Link copied to clipboard
val coordinatorStorageQuotaInMb: Int? = null

The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.

Link copied to clipboard
val coordinatorVCores: Int? = null

The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.

Link copied to clipboard
val earliestRestoreTime: String

The earliest restore point time (ISO8601 format) for the cluster.

Link copied to clipboard
val enableHa: Boolean? = null

If high availability (HA) is enabled or not for the cluster.

Link copied to clipboard
val enableShardsOnCoordinator: Boolean? = null

If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.

Link copied to clipboard
val id: String

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

Link copied to clipboard
val location: String

The geo-location where the resource lives

Link copied to clipboard
val maintenanceWindow: MaintenanceWindowResponse? = null

Maintenance window of a cluster.

Link copied to clipboard
val name: String

The name of the resource

Link copied to clipboard
val nodeCount: Int? = null

Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.

Link copied to clipboard
val nodeEnablePublicIpAccess: Boolean? = null

If public access is enabled on worker nodes.

Link copied to clipboard
val nodeServerEdition: String? = null

The edition of a node server (default: MemoryOptimized).

Link copied to clipboard
val nodeStorageQuotaInMb: Int? = null

The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.

Link copied to clipboard
val nodeVCores: Int? = null

The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.

Link copied to clipboard
val pointInTimeUTC: String? = null

Date and time in UTC (ISO8601 format) for cluster restore.

Link copied to clipboard
val postgresqlVersion: String? = null

The major PostgreSQL version on all cluster servers.

Link copied to clipboard
val preferredPrimaryZone: String? = null

Preferred primary availability zone (AZ) for all cluster servers.

Link copied to clipboard
val privateEndpointConnections: List<SimplePrivateEndpointConnectionResponse>

The private endpoint connections for a cluster.

Link copied to clipboard
val provisioningState: String

Provisioning state of the cluster

Link copied to clipboard
val readReplicas: List<String>

The array of read replica clusters.

Link copied to clipboard
val serverNames: List<ServerNameItemResponse>

The list of server names in the cluster

Link copied to clipboard
val sourceLocation: String? = null

The Azure region of source cluster for read replica clusters.

Link copied to clipboard
val sourceResourceId: String? = null

The resource id of source cluster for read replica clusters.

Link copied to clipboard
val state: String

A state of a cluster/server that is visible to user.

Link copied to clipboard
val systemData: SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags.

Link copied to clipboard
val type: String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"