All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.awsnative.redshift.kotlin.outputs.GetClusterResult.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 1.24.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.redshift.kotlin.outputs

import com.pulumi.awsnative.kotlin.outputs.Tag
import kotlin.Any
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List

/**
 *
 * @property allowVersionUpgrade 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
 * @property aquaConfigurationStatus 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.
 * @property automatedSnapshotRetentionPeriod The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
 * @property availabilityZone 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
 * @property availabilityZoneRelocation The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
 * @property availabilityZoneRelocationStatus The availability zone relocation status of the cluster
 * @property clusterNamespaceArn The Amazon Resource Name (ARN) of the cluster namespace.
 * @property clusterParameterGroupName The name of the parameter group to be associated with this cluster.
 * @property clusterSecurityGroups A list of security groups to be associated with this cluster.
 * @property clusterType 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
 * @property clusterVersion 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.
 * @property deferMaintenanceEndTime A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
 * @property deferMaintenanceIdentifier A unique identifier for the deferred maintenance window.
 * @property deferMaintenanceStartTime A timestamp indicating the start time for the deferred maintenance window.
 * @property destinationRegion 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
 * @property elasticIp The Elastic IP (EIP) address for the cluster.
 * @property encrypted If true, the data in the cluster is encrypted at rest.
 * @property endpoint The connection endpoint.
 * @property enhancedVpcRouting 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
 * @property hsmClientCertificateIdentifier Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
 * @property hsmConfigurationIdentifier 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.
 * @property iamRoles 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
 * @property kmsKeyId The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
 * @property loggingProperties Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
 * @property maintenanceTrackName 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.
 * @property manualSnapshotRetentionPeriod 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.
 * @property masterPasswordSecretArn The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
 * @property masterPasswordSecretKmsKeyId The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
 * @property multiAz 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.
 * @property namespaceResourcePolicy The namespace resource policy document that will be attached to a Redshift cluster.
 * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Redshift::Cluster` for more information about the expected schema for this property.
 * @property nodeType 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
 * @property numberOfNodes The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
 * @property port The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
 * @property preferredMaintenanceWindow The weekly time range (in UTC) during which automated cluster maintenance can occur.
 * @property publiclyAccessible If true, the cluster can be accessed from a public network.
 * @property resourceAction The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
 * @property revisionTarget The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
 * @property rotateEncryptionKey A boolean indicating if we want to rotate Encryption Keys.
 * @property snapshotCopyGrantName The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
 * @property snapshotCopyManual Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
 * @property snapshotCopyRetentionPeriod 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.
 * @property tags The list of tags for the cluster parameter group.
 * @property vpcSecurityGroupIds A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
 */
public data class GetClusterResult(
    public val allowVersionUpgrade: Boolean? = null,
    public val aquaConfigurationStatus: String? = null,
    public val automatedSnapshotRetentionPeriod: Int? = null,
    public val availabilityZone: String? = null,
    public val availabilityZoneRelocation: Boolean? = null,
    public val availabilityZoneRelocationStatus: String? = null,
    public val clusterNamespaceArn: String? = null,
    public val clusterParameterGroupName: String? = null,
    public val clusterSecurityGroups: List? = null,
    public val clusterType: String? = null,
    public val clusterVersion: String? = null,
    public val deferMaintenanceEndTime: String? = null,
    public val deferMaintenanceIdentifier: String? = null,
    public val deferMaintenanceStartTime: String? = null,
    public val destinationRegion: String? = null,
    public val elasticIp: String? = null,
    public val encrypted: Boolean? = null,
    public val endpoint: ClusterEndpoint? = null,
    public val enhancedVpcRouting: Boolean? = null,
    public val hsmClientCertificateIdentifier: String? = null,
    public val hsmConfigurationIdentifier: String? = null,
    public val iamRoles: List? = null,
    public val kmsKeyId: String? = null,
    public val loggingProperties: ClusterLoggingProperties? = null,
    public val maintenanceTrackName: String? = null,
    public val manualSnapshotRetentionPeriod: Int? = null,
    public val masterPasswordSecretArn: String? = null,
    public val masterPasswordSecretKmsKeyId: String? = null,
    public val multiAz: Boolean? = null,
    public val namespaceResourcePolicy: Any? = null,
    public val nodeType: String? = null,
    public val numberOfNodes: Int? = null,
    public val port: Int? = null,
    public val preferredMaintenanceWindow: String? = null,
    public val publiclyAccessible: Boolean? = null,
    public val resourceAction: String? = null,
    public val revisionTarget: String? = null,
    public val rotateEncryptionKey: Boolean? = null,
    public val snapshotCopyGrantName: String? = null,
    public val snapshotCopyManual: Boolean? = null,
    public val snapshotCopyRetentionPeriod: Int? = null,
    public val tags: List? = null,
    public val vpcSecurityGroupIds: List? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.redshift.outputs.GetClusterResult): GetClusterResult = GetClusterResult(
            allowVersionUpgrade = javaType.allowVersionUpgrade().map({ args0 -> args0 }).orElse(null),
            aquaConfigurationStatus = javaType.aquaConfigurationStatus().map({ args0 -> args0 }).orElse(null),
            automatedSnapshotRetentionPeriod = javaType.automatedSnapshotRetentionPeriod().map({ args0 ->
                args0
            }).orElse(null),
            availabilityZone = javaType.availabilityZone().map({ args0 -> args0 }).orElse(null),
            availabilityZoneRelocation = javaType.availabilityZoneRelocation().map({ args0 ->
                args0
            }).orElse(null),
            availabilityZoneRelocationStatus = javaType.availabilityZoneRelocationStatus().map({ args0 ->
                args0
            }).orElse(null),
            clusterNamespaceArn = javaType.clusterNamespaceArn().map({ args0 -> args0 }).orElse(null),
            clusterParameterGroupName = javaType.clusterParameterGroupName().map({ args0 ->
                args0
            }).orElse(null),
            clusterSecurityGroups = javaType.clusterSecurityGroups().map({ args0 -> args0 }),
            clusterType = javaType.clusterType().map({ args0 -> args0 }).orElse(null),
            clusterVersion = javaType.clusterVersion().map({ args0 -> args0 }).orElse(null),
            deferMaintenanceEndTime = javaType.deferMaintenanceEndTime().map({ args0 -> args0 }).orElse(null),
            deferMaintenanceIdentifier = javaType.deferMaintenanceIdentifier().map({ args0 ->
                args0
            }).orElse(null),
            deferMaintenanceStartTime = javaType.deferMaintenanceStartTime().map({ args0 ->
                args0
            }).orElse(null),
            destinationRegion = javaType.destinationRegion().map({ args0 -> args0 }).orElse(null),
            elasticIp = javaType.elasticIp().map({ args0 -> args0 }).orElse(null),
            encrypted = javaType.encrypted().map({ args0 -> args0 }).orElse(null),
            endpoint = javaType.endpoint().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.redshift.kotlin.outputs.ClusterEndpoint.Companion.toKotlin(args0)
                })
            }).orElse(null),
            enhancedVpcRouting = javaType.enhancedVpcRouting().map({ args0 -> args0 }).orElse(null),
            hsmClientCertificateIdentifier = javaType.hsmClientCertificateIdentifier().map({ args0 ->
                args0
            }).orElse(null),
            hsmConfigurationIdentifier = javaType.hsmConfigurationIdentifier().map({ args0 ->
                args0
            }).orElse(null),
            iamRoles = javaType.iamRoles().map({ args0 -> args0 }),
            kmsKeyId = javaType.kmsKeyId().map({ args0 -> args0 }).orElse(null),
            loggingProperties = javaType.loggingProperties().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.redshift.kotlin.outputs.ClusterLoggingProperties.Companion.toKotlin(args0)
                })
            }).orElse(null),
            maintenanceTrackName = javaType.maintenanceTrackName().map({ args0 -> args0 }).orElse(null),
            manualSnapshotRetentionPeriod = javaType.manualSnapshotRetentionPeriod().map({ args0 ->
                args0
            }).orElse(null),
            masterPasswordSecretArn = javaType.masterPasswordSecretArn().map({ args0 -> args0 }).orElse(null),
            masterPasswordSecretKmsKeyId = javaType.masterPasswordSecretKmsKeyId().map({ args0 ->
                args0
            }).orElse(null),
            multiAz = javaType.multiAz().map({ args0 -> args0 }).orElse(null),
            namespaceResourcePolicy = javaType.namespaceResourcePolicy().map({ args0 -> args0 }).orElse(null),
            nodeType = javaType.nodeType().map({ args0 -> args0 }).orElse(null),
            numberOfNodes = javaType.numberOfNodes().map({ args0 -> args0 }).orElse(null),
            port = javaType.port().map({ args0 -> args0 }).orElse(null),
            preferredMaintenanceWindow = javaType.preferredMaintenanceWindow().map({ args0 ->
                args0
            }).orElse(null),
            publiclyAccessible = javaType.publiclyAccessible().map({ args0 -> args0 }).orElse(null),
            resourceAction = javaType.resourceAction().map({ args0 -> args0 }).orElse(null),
            revisionTarget = javaType.revisionTarget().map({ args0 -> args0 }).orElse(null),
            rotateEncryptionKey = javaType.rotateEncryptionKey().map({ args0 -> args0 }).orElse(null),
            snapshotCopyGrantName = javaType.snapshotCopyGrantName().map({ args0 -> args0 }).orElse(null),
            snapshotCopyManual = javaType.snapshotCopyManual().map({ args0 -> args0 }).orElse(null),
            snapshotCopyRetentionPeriod = javaType.snapshotCopyRetentionPeriod().map({ args0 ->
                args0
            }).orElse(null),
            tags = javaType.tags().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin(args0)
                })
            }),
            vpcSecurityGroupIds = javaType.vpcSecurityGroupIds().map({ args0 -> args0 }),
        )
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy