Package com.pulumi.aws.redshift.inputs

Class ClusterState

  • public final class ClusterState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ClusterState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Detail

      • allowVersionUpgrade

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> allowVersionUpgrade()
        Returns:
        If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is `true`.

      • applyImmediately

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()
        Returns:
        Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`.

      • aquaConfigurationStatus

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> aquaConfigurationStatus()
        Deprecated.
        This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.
        Returns:
        The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns `auto`.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        Amazon Resource Name (ARN) of cluster

      • automatedSnapshotRetentionPeriod

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> automatedSnapshotRetentionPeriod()
        Returns:
        The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.

      • availabilityZone

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZone()
        Returns:
        The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Can only be changed if `availability_zone_relocation_enabled` is `true`.

      • availabilityZoneRelocationEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> availabilityZoneRelocationEnabled()
        Returns:
        If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is `false`. Available for use on clusters from the RA3 instance family.

      • clusterIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterIdentifier()
        Returns:
        The Cluster Identifier. Must be a lower case string.

      • clusterNamespaceArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterNamespaceArn()
        Returns:
        The namespace Amazon Resource Name (ARN) of the cluster

      • clusterNodes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ClusterClusterNodeArgs>>> clusterNodes()
        Returns:
        The nodes in the cluster. Cluster node blocks are documented below

      • clusterParameterGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterParameterGroupName()
        Returns:
        The name of the parameter group to be associated with this cluster.

      • clusterPublicKey

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterPublicKey()
        Returns:
        The public key for the cluster

      • clusterRevisionNumber

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterRevisionNumber()
        Returns:
        The specific revision number of the database in the cluster

      • clusterSubnetGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterSubnetGroupName()
        Returns:
        The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

      • clusterType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterType()
        Returns:
        The cluster type to use. Either `single-node` or `multi-node`.

      • clusterVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterVersion()
        Returns:
        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.

      • databaseName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> databaseName()
        Returns:
        The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called `dev`.

      • defaultIamRoleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> defaultIamRoleArn()
        Returns:
        The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

      • dnsName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dnsName()
        Returns:
        The DNS name of the cluster

      • elasticIp

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> elasticIp()
        Returns:
        The Elastic IP (EIP) address for the cluster.

      • encrypted

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> encrypted()
        Returns:
        If true , the data in the cluster is encrypted at rest.

      • endpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
        Returns:
        The connection endpoint

      • enhancedVpcRouting

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enhancedVpcRouting()
        Returns:
        If true , enhanced VPC routing is enabled.

      • finalSnapshotIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotIdentifier()
        Returns:
        The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, `skip_final_snapshot` must be false.

      • iamRoles

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> iamRoles()
        Returns:
        A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.

      • kmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
        Returns:
        The ARN for the KMS encryption key. When specifying `kms_key_id`, `encrypted` needs to be set to true.

      • logging

        public java.util.Optional<com.pulumi.core.Output<ClusterLoggingArgs>> logging()
        Returns:
        Logging, documented below.

      • maintenanceTrackName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> maintenanceTrackName()
        Returns:
        The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks. Default value is `current`.

      • manageMasterPassword

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> manageMasterPassword()
        Returns:
        Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with `master_password`. One of `master_password` or `manage_master_password` is required unless `snapshot_identifier` is provided.

      • manualSnapshotRetentionPeriod

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> manualSnapshotRetentionPeriod()
        Returns:
        The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. Valid values are between `-1` and `3653`. Default value is `-1`.

      • masterPassword

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterPassword()
        Returns:
        Password for the master DB user. Conflicts with `manage_master_password`. One of `master_password` or `manage_master_password` is required unless `snapshot_identifier` is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.

      • masterPasswordSecretArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterPasswordSecretArn()
        Returns:
        ARN of the cluster admin credentials secret

      • masterPasswordSecretKmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterPasswordSecretKmsKeyId()
        Returns:
        ID of the KMS key used to encrypt the cluster admin credentials secret.

      • masterUsername

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterUsername()
        Returns:
        Username for the master DB user.

      • multiAz

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> multiAz()
        Returns:
        Specifies if the Redshift cluster is multi-AZ.

      • nodeType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> nodeType()
        Returns:
        The node type to be provisioned for the cluster.

      • numberOfNodes

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> numberOfNodes()
        Returns:
        The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.

      • ownerAccount

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ownerAccount()
        Returns:
        The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

      • port

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        The port number on which the cluster accepts incoming connections. Valid values are between `1115` and `65535`. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is `5439`.

      • preferredMaintenanceWindow

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredMaintenanceWindow()
        Returns:
        The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi

      • publiclyAccessible

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()
        Returns:
        If true, the cluster can be accessed from a public network. Default is `true`.

      • skipFinalSnapshot

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> skipFinalSnapshot()
        Returns:
        Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.

      • snapshotArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotArn()
        Returns:
        The ARN of the snapshot from which to create the new cluster. Conflicts with `snapshot_identifier`.

      • snapshotClusterIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotClusterIdentifier()
        Returns:
        The name of the cluster the source snapshot was created from.

      • snapshotCopy

        public java.util.Optional<com.pulumi.core.Output<ClusterSnapshotCopyArgs>> snapshotCopy()
        Returns:
        Configuration of automatic copy of snapshots from one region to another. Documented below.

      • snapshotIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotIdentifier()
        Returns:
        The name of the snapshot from which to create the new cluster. Conflicts with `snapshot_arn`.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Deprecated.
        Please use `tags` instead.
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • vpcSecurityGroupIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSecurityGroupIds()
        Returns:
        A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.