pulumi-aws-native-kotlin/com.pulumi.awsnative.redshift.kotlin.outputs/GetClusterResult

GetClusterResult

data class GetClusterResult(val allowVersionUpgrade: Boolean? = null, val aquaConfigurationStatus: String? = null, val automatedSnapshotRetentionPeriod: Int? = null, val availabilityZone: String? = null, val availabilityZoneRelocation: Boolean? = null, val availabilityZoneRelocationStatus: String? = null, val clusterParameterGroupName: String? = null, val clusterSecurityGroups: List<String>? = null, val clusterType: String? = null, val clusterVersion: String? = null, val deferMaintenance: Boolean? = null, val deferMaintenanceDuration: Int? = null, val deferMaintenanceEndTime: String? = null, val deferMaintenanceIdentifier: String? = null, val deferMaintenanceStartTime: String? = null, val destinationRegion: String? = null, val elasticIp: String? = null, val encrypted: Boolean? = null, val endpoint: ClusterEndpoint? = null, val enhancedVpcRouting: Boolean? = null, val hsmClientCertificateIdentifier: String? = null, val hsmConfigurationIdentifier: String? = null, val iamRoles: List<String>? = null, val id: String? = null, val kmsKeyId: String? = null, val loggingProperties: ClusterLoggingProperties? = null, val maintenanceTrackName: String? = null, val manualSnapshotRetentionPeriod: Int? = null, val nodeType: String? = null, val numberOfNodes: Int? = null, val port: Int? = null, val preferredMaintenanceWindow: String? = null, val publiclyAccessible: Boolean? = null, val resourceAction: String? = null, val revisionTarget: String? = null, val rotateEncryptionKey: Boolean? = null, val snapshotCopyGrantName: String? = null, val snapshotCopyManual: Boolean? = null, val snapshotCopyRetentionPeriod: Int? = null, val tags: List<ClusterTag>? = null, val vpcSecurityGroupIds: List<String>? = null)

Constructors

GetClusterResult

fun GetClusterResult(allowVersionUpgrade: Boolean? = null, aquaConfigurationStatus: String? = null, automatedSnapshotRetentionPeriod: Int? = null, availabilityZone: String? = null, availabilityZoneRelocation: Boolean? = null, availabilityZoneRelocationStatus: String? = null, clusterParameterGroupName: String? = null, clusterSecurityGroups: List<String>? = null, clusterType: String? = null, clusterVersion: String? = null, deferMaintenance: Boolean? = null, deferMaintenanceDuration: Int? = null, deferMaintenanceEndTime: String? = null, deferMaintenanceIdentifier: String? = null, deferMaintenanceStartTime: String? = null, destinationRegion: String? = null, elasticIp: String? = null, encrypted: Boolean? = null, endpoint: ClusterEndpoint? = null, enhancedVpcRouting: Boolean? = null, hsmClientCertificateIdentifier: String? = null, hsmConfigurationIdentifier: String? = null, iamRoles: List<String>? = null, id: String? = null, kmsKeyId: String? = null, loggingProperties: ClusterLoggingProperties? = null, maintenanceTrackName: String? = null, manualSnapshotRetentionPeriod: Int? = null, nodeType: String? = null, numberOfNodes: Int? = null, port: Int? = null, preferredMaintenanceWindow: String? = null, publiclyAccessible: Boolean? = null, resourceAction: String? = null, revisionTarget: String? = null, rotateEncryptionKey: Boolean? = null, snapshotCopyGrantName: String? = null, snapshotCopyManual: Boolean? = null, snapshotCopyRetentionPeriod: Int? = null, tags: List<ClusterTag>? = null, vpcSecurityGroupIds: List<String>? = null)

Types

Companion

object Companion

Properties

allowVersionUpgrade

val allowVersionUpgrade: Boolean? = null

Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True

aquaConfigurationStatus

val aquaConfigurationStatus: String? = null

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following. enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA.

automatedSnapshotRetentionPeriod

val automatedSnapshotRetentionPeriod: Int? = null

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1

availabilityZone

val availabilityZone: String? = null

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint

availabilityZoneRelocation

val availabilityZoneRelocation: Boolean? = null

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

availabilityZoneRelocationStatus

val availabilityZoneRelocationStatus: String? = null

The availability zone relocation status of the cluster

clusterParameterGroupName

val clusterParameterGroupName: String? = null

The name of the parameter group to be associated with this cluster.

clusterSecurityGroups

val clusterSecurityGroups: List<String>? = null

A list of security groups to be associated with this cluster.

clusterType

val clusterType: String? = null

The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required

clusterVersion

val clusterVersion: String? = null

The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.

deferMaintenance

val deferMaintenance: Boolean? = null

A boolean indicating whether to enable the deferred maintenance window.

deferMaintenanceDuration

val deferMaintenanceDuration: Int? = null

An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.

deferMaintenanceEndTime

val deferMaintenanceEndTime: String? = null

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

deferMaintenanceIdentifier

val deferMaintenanceIdentifier: String? = null

A unique identifier for the deferred maintenance window.

deferMaintenanceStartTime

val deferMaintenanceStartTime: String? = null

A timestamp indicating the start time for the deferred maintenance window.

destinationRegion

val destinationRegion: String? = null

The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region General Reference

elasticIp

val elasticIp: String? = null

The Elastic IP (EIP) address for the cluster.

encrypted

val encrypted: Boolean? = null

If true, the data in the cluster is encrypted at rest.

endpoint

val endpoint: ClusterEndpoint? = null

enhancedVpcRouting

val enhancedVpcRouting: Boolean? = null

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true , enhanced VPC routing is enabled. Default: false

hsmClientCertificateIdentifier

val hsmClientCertificateIdentifier: String? = null

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM

hsmConfigurationIdentifier

val hsmConfigurationIdentifier: String? = null

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

iamRoles

val iamRoles: List<String>? = null

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request

val id: String? = null

kmsKeyId

val kmsKeyId: String? = null

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

loggingProperties

val loggingProperties: ClusterLoggingProperties? = null

maintenanceTrackName

val maintenanceTrackName: String? = null

The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.

manualSnapshotRetentionPeriod

val manualSnapshotRetentionPeriod: Int? = null

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.

nodeType

val nodeType: String? = null

numberOfNodes

val numberOfNodes: Int? = null

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

port

val port: Int? = null

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings

preferredMaintenanceWindow

val preferredMaintenanceWindow: String? = null

The weekly time range (in UTC) during which automated cluster maintenance can occur.

publiclyAccessible

val publiclyAccessible: Boolean? = null

If true, the cluster can be accessed from a public network.

resourceAction

val resourceAction: String? = null

The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster APIs

revisionTarget

val revisionTarget: String? = null

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rotateEncryptionKey

val rotateEncryptionKey: Boolean? = null

A boolean indicating if we want to rotate Encryption Keys.

snapshotCopyGrantName

val snapshotCopyGrantName: String? = null

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

snapshotCopyManual

val snapshotCopyManual: Boolean? = null

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

snapshotCopyRetentionPeriod

val snapshotCopyRetentionPeriod: Int? = null

The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default is 7. Constraints: Must be at least 1 and no more than 35.