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 clusterNamespaceArn: String? = null, val clusterParameterGroupName: String? = null, val clusterSecurityGroups: List<String>? = null, val clusterType: String? = null, val clusterVersion: String? = 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 kmsKeyId: String? = null, val loggingProperties: ClusterLoggingProperties? = null, val maintenanceTrackName: String? = null, val manualSnapshotRetentionPeriod: Int? = null, val masterPasswordSecretArn: String? = null, val masterPasswordSecretKmsKeyId: String? = null, val multiAz: Boolean? = null, val namespaceResourcePolicy: Any? = 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<Tag>? = null, val vpcSecurityGroupIds: List<String>? = null)

Constructors

Link copied to clipboard
constructor(allowVersionUpgrade: Boolean? = null, aquaConfigurationStatus: String? = null, automatedSnapshotRetentionPeriod: Int? = null, availabilityZone: String? = null, availabilityZoneRelocation: Boolean? = null, availabilityZoneRelocationStatus: String? = null, clusterNamespaceArn: String? = null, clusterParameterGroupName: String? = null, clusterSecurityGroups: List<String>? = null, clusterType: String? = null, clusterVersion: String? = 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, kmsKeyId: String? = null, loggingProperties: ClusterLoggingProperties? = null, maintenanceTrackName: String? = null, manualSnapshotRetentionPeriod: Int? = null, masterPasswordSecretArn: String? = null, masterPasswordSecretKmsKeyId: String? = null, multiAz: Boolean? = null, namespaceResourcePolicy: Any? = 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<Tag>? = null, vpcSecurityGroupIds: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The availability zone relocation status of the cluster

Link copied to clipboard

The Amazon Resource Name (ARN) of the cluster namespace.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
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

Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard

A unique identifier for the deferred maintenance window.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val elasticIp: String? = null

The Elastic IP (EIP) address for the cluster.

Link copied to clipboard
val encrypted: Boolean? = null

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

Link copied to clipboard

The connection endpoint.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
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

Link copied to clipboard
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.

Link copied to clipboard

Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

Link copied to clipboard

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.

Link copied to clipboard
val multiAz: Boolean? = null

A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.

Link copied to clipboard

The namespace resource policy document that will be attached to a Redshift cluster. Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.

Link copied to clipboard
val nodeType: String? = null

The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

Link copied to clipboard
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.

Link copied to clipboard
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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val resourceAction: String? = null

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

Link copied to clipboard
val revisionTarget: String? = null

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

Link copied to clipboard

A boolean indicating if we want to rotate Encryption Keys.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val tags: List<Tag>? = null

The list of tags for the cluster parameter group.

Link copied to clipboard

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.