Interface AwsRedshiftClusterDetails.Builder

    • Method Detail

      • allowVersionUpgrade

        AwsRedshiftClusterDetails.Builder allowVersionUpgrade​(Boolean allowVersionUpgrade)

        Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.

        Parameters:
        allowVersionUpgrade - Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • automatedSnapshotRetentionPeriod

        AwsRedshiftClusterDetails.Builder automatedSnapshotRetentionPeriod​(Integer automatedSnapshotRetentionPeriod)

        The number of days that automatic cluster snapshots are retained.

        Parameters:
        automatedSnapshotRetentionPeriod - The number of days that automatic cluster snapshots are retained.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • availabilityZone

        AwsRedshiftClusterDetails.Builder availabilityZone​(String availabilityZone)

        The name of the Availability Zone in which the cluster is located.

        Parameters:
        availabilityZone - The name of the Availability Zone in which the cluster is located.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterAvailabilityStatus

        AwsRedshiftClusterDetails.Builder clusterAvailabilityStatus​(String clusterAvailabilityStatus)

        The availability status of the cluster for queries. Possible values are the following:

        • Available - The cluster is available for queries.

        • Unavailable - The cluster is not available for queries.

        • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

        • Modifying -The cluster is intermittently available for queries due to changes that modify the cluster.

        • Failed - The cluster failed and is not available for queries.

        Parameters:
        clusterAvailabilityStatus - The availability status of the cluster for queries. Possible values are the following:

        • Available - The cluster is available for queries.

        • Unavailable - The cluster is not available for queries.

        • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

        • Modifying -The cluster is intermittently available for queries due to changes that modify the cluster.

        • Failed - The cluster failed and is not available for queries.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterCreateTime

        AwsRedshiftClusterDetails.Builder clusterCreateTime​(String clusterCreateTime)

        Indicates when the cluster was created.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        Parameters:
        clusterCreateTime - Indicates when the cluster was created.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterIdentifier

        AwsRedshiftClusterDetails.Builder clusterIdentifier​(String clusterIdentifier)

        The unique identifier of the cluster.

        Parameters:
        clusterIdentifier - The unique identifier of the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterParameterGroups

        AwsRedshiftClusterDetails.Builder clusterParameterGroups​(Collection<AwsRedshiftClusterClusterParameterGroup> clusterParameterGroups)

        The list of cluster parameter groups that are associated with this cluster.

        Parameters:
        clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterParameterGroups

        AwsRedshiftClusterDetails.Builder clusterParameterGroups​(AwsRedshiftClusterClusterParameterGroup... clusterParameterGroups)

        The list of cluster parameter groups that are associated with this cluster.

        Parameters:
        clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterPublicKey

        AwsRedshiftClusterDetails.Builder clusterPublicKey​(String clusterPublicKey)

        The public key for the cluster.

        Parameters:
        clusterPublicKey - The public key for the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterRevisionNumber

        AwsRedshiftClusterDetails.Builder clusterRevisionNumber​(String clusterRevisionNumber)

        The specific revision number of the database in the cluster.

        Parameters:
        clusterRevisionNumber - The specific revision number of the database in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterSecurityGroups

        AwsRedshiftClusterDetails.Builder clusterSecurityGroups​(Collection<AwsRedshiftClusterClusterSecurityGroup> clusterSecurityGroups)

        A list of cluster security groups that are associated with the cluster.

        Parameters:
        clusterSecurityGroups - A list of cluster security groups that are associated with the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterSecurityGroups

        AwsRedshiftClusterDetails.Builder clusterSecurityGroups​(AwsRedshiftClusterClusterSecurityGroup... clusterSecurityGroups)

        A list of cluster security groups that are associated with the cluster.

        Parameters:
        clusterSecurityGroups - A list of cluster security groups that are associated with the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterSnapshotCopyStatus

        AwsRedshiftClusterDetails.Builder clusterSnapshotCopyStatus​(AwsRedshiftClusterClusterSnapshotCopyStatus clusterSnapshotCopyStatus)

        Information about the destination Region and retention period for the cross-Region snapshot copy.

        Parameters:
        clusterSnapshotCopyStatus - Information about the destination Region and retention period for the cross-Region snapshot copy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterStatus

        AwsRedshiftClusterDetails.Builder clusterStatus​(String clusterStatus)

        The current status of the cluster.

        Valid values: available | available, prep-for-resize | available, resize-cleanup | cancelling-resize | creating | deleting | final-snapshot | hardware-failure | incompatible-hsm | incompatible-network | incompatible-parameters | incompatible-restore | modifying | paused | rebooting | renaming | resizing | rotating-keys | storage-full | updating-hsm

        Parameters:
        clusterStatus - The current status of the cluster.

        Valid values: available | available, prep-for-resize | available, resize-cleanup | cancelling-resize | creating | deleting | final-snapshot | hardware-failure | incompatible-hsm | incompatible-network | incompatible-parameters | incompatible-restore | modifying | paused | rebooting | renaming | resizing | rotating-keys | storage-full | updating-hsm

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterSubnetGroupName

        AwsRedshiftClusterDetails.Builder clusterSubnetGroupName​(String clusterSubnetGroupName)

        The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

        Parameters:
        clusterSubnetGroupName - The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clusterVersion

        AwsRedshiftClusterDetails.Builder clusterVersion​(String clusterVersion)

        The version ID of the Amazon Redshift engine that runs on the cluster.

        Parameters:
        clusterVersion - The version ID of the Amazon Redshift engine that runs on the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dbName

        AwsRedshiftClusterDetails.Builder dbName​(String dbName)

        The name of the initial database that was created when the cluster was created.

        The same name is returned for the life of the cluster.

        If an initial database is not specified, a database named devdev is created by default.

        Parameters:
        dbName - The name of the initial database that was created when the cluster was created.

        The same name is returned for the life of the cluster.

        If an initial database is not specified, a database named devdev is created by default.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • deferredMaintenanceWindows

        AwsRedshiftClusterDetails.Builder deferredMaintenanceWindows​(AwsRedshiftClusterDeferredMaintenanceWindow... deferredMaintenanceWindows)

        List of time windows during which maintenance was deferred.

        Parameters:
        deferredMaintenanceWindows - List of time windows during which maintenance was deferred.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • elasticIpStatus

        AwsRedshiftClusterDetails.Builder elasticIpStatus​(AwsRedshiftClusterElasticIpStatus elasticIpStatus)

        Information about the status of the Elastic IP (EIP) address.

        Parameters:
        elasticIpStatus - Information about the status of the Elastic IP (EIP) address.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • elasticResizeNumberOfNodeOptions

        AwsRedshiftClusterDetails.Builder elasticResizeNumberOfNodeOptions​(String elasticResizeNumberOfNodeOptions)

        The number of nodes that you can use the elastic resize method to resize the cluster to.

        Parameters:
        elasticResizeNumberOfNodeOptions - The number of nodes that you can use the elastic resize method to resize the cluster to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • encrypted

        AwsRedshiftClusterDetails.Builder encrypted​(Boolean encrypted)

        Indicates whether the data in the cluster is encrypted at rest.

        Parameters:
        encrypted - Indicates whether the data in the cluster is encrypted at rest.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • enhancedVpcRouting

        AwsRedshiftClusterDetails.Builder enhancedVpcRouting​(Boolean enhancedVpcRouting)

        Indicates whether to create the cluster with enhanced VPC routing enabled.

        Parameters:
        enhancedVpcRouting - Indicates whether to create the cluster with enhanced VPC routing enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • expectedNextSnapshotScheduleTime

        AwsRedshiftClusterDetails.Builder expectedNextSnapshotScheduleTime​(String expectedNextSnapshotScheduleTime)

        Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        Parameters:
        expectedNextSnapshotScheduleTime - Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • expectedNextSnapshotScheduleTimeStatus

        AwsRedshiftClusterDetails.Builder expectedNextSnapshotScheduleTimeStatus​(String expectedNextSnapshotScheduleTimeStatus)

        The status of the next expected snapshot.

        Valid values: OnTrack | Pending

        Parameters:
        expectedNextSnapshotScheduleTimeStatus - The status of the next expected snapshot.

        Valid values: OnTrack | Pending

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • hsmStatus

        AwsRedshiftClusterDetails.Builder hsmStatus​(AwsRedshiftClusterHsmStatus hsmStatus)

        Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.

        Parameters:
        hsmStatus - Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • iamRoles

        AwsRedshiftClusterDetails.Builder iamRoles​(Collection<AwsRedshiftClusterIamRole> iamRoles)

        A list of IAM roles that the cluster can use to access other Amazon Web Services services.

        Parameters:
        iamRoles - A list of IAM roles that the cluster can use to access other Amazon Web Services services.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • iamRoles

        AwsRedshiftClusterDetails.Builder iamRoles​(AwsRedshiftClusterIamRole... iamRoles)

        A list of IAM roles that the cluster can use to access other Amazon Web Services services.

        Parameters:
        iamRoles - A list of IAM roles that the cluster can use to access other Amazon Web Services services.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • kmsKeyId

        AwsRedshiftClusterDetails.Builder kmsKeyId​(String kmsKeyId)

        The identifier of the KMS encryption key that is used to encrypt data in the cluster.

        Parameters:
        kmsKeyId - The identifier of the KMS encryption key that is used to encrypt data in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • maintenanceTrackName

        AwsRedshiftClusterDetails.Builder maintenanceTrackName​(String maintenanceTrackName)

        The name of the maintenance track for the cluster.

        Parameters:
        maintenanceTrackName - The name of the maintenance track for the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • manualSnapshotRetentionPeriod

        AwsRedshiftClusterDetails.Builder manualSnapshotRetentionPeriod​(Integer manualSnapshotRetentionPeriod)

        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: Either -1 or an integer between 1 and 3,653

        Parameters:
        manualSnapshotRetentionPeriod - 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: Either -1 or an integer between 1 and 3,653

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • masterUsername

        AwsRedshiftClusterDetails.Builder masterUsername​(String masterUsername)

        The master user name for the cluster. This name is used to connect to the database that is specified in as the value of DBName.

        Parameters:
        masterUsername - The master user name for the cluster. This name is used to connect to the database that is specified in as the value of DBName.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • nextMaintenanceWindowStartTime

        AwsRedshiftClusterDetails.Builder nextMaintenanceWindowStartTime​(String nextMaintenanceWindowStartTime)

        Indicates the start of the next maintenance window.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        Parameters:
        nextMaintenanceWindowStartTime - Indicates the start of the next maintenance window.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • nodeType

        AwsRedshiftClusterDetails.Builder nodeType​(String nodeType)

        The node type for the nodes in the cluster.

        Parameters:
        nodeType - The node type for the nodes in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • numberOfNodes

        AwsRedshiftClusterDetails.Builder numberOfNodes​(Integer numberOfNodes)

        The number of compute nodes in the cluster.

        Parameters:
        numberOfNodes - The number of compute nodes in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • pendingActions

        AwsRedshiftClusterDetails.Builder pendingActions​(Collection<String> pendingActions)

        A list of cluster operations that are waiting to start.

        Parameters:
        pendingActions - A list of cluster operations that are waiting to start.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • pendingActions

        AwsRedshiftClusterDetails.Builder pendingActions​(String... pendingActions)

        A list of cluster operations that are waiting to start.

        Parameters:
        pendingActions - A list of cluster operations that are waiting to start.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • pendingModifiedValues

        AwsRedshiftClusterDetails.Builder pendingModifiedValues​(AwsRedshiftClusterPendingModifiedValues pendingModifiedValues)

        A list of changes to the cluster that are currently pending.

        Parameters:
        pendingModifiedValues - A list of changes to the cluster that are currently pending.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • preferredMaintenanceWindow

        AwsRedshiftClusterDetails.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

        Format: <day>:HH:MM-<day>:HH:MM

        For the day values, use mon | tue | wed | thu | fri | sat | sun

        For example, sun:09:32-sun:10:02

        Parameters:
        preferredMaintenanceWindow - The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

        Format: <day>:HH:MM-<day>:HH:MM

        For the day values, use mon | tue | wed | thu | fri | sat | sun

        For example, sun:09:32-sun:10:02

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • publiclyAccessible

        AwsRedshiftClusterDetails.Builder publiclyAccessible​(Boolean publiclyAccessible)

        Whether the cluster can be accessed from a public network.

        Parameters:
        publiclyAccessible - Whether the cluster can be accessed from a public network.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • resizeInfo

        AwsRedshiftClusterDetails.Builder resizeInfo​(AwsRedshiftClusterResizeInfo resizeInfo)

        Information about the resize operation for the cluster.

        Parameters:
        resizeInfo - Information about the resize operation for the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • restoreStatus

        AwsRedshiftClusterDetails.Builder restoreStatus​(AwsRedshiftClusterRestoreStatus restoreStatus)

        Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.

        Parameters:
        restoreStatus - Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • snapshotScheduleIdentifier

        AwsRedshiftClusterDetails.Builder snapshotScheduleIdentifier​(String snapshotScheduleIdentifier)

        A unique identifier for the cluster snapshot schedule.

        Parameters:
        snapshotScheduleIdentifier - A unique identifier for the cluster snapshot schedule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • snapshotScheduleState

        AwsRedshiftClusterDetails.Builder snapshotScheduleState​(String snapshotScheduleState)

        The current state of the cluster snapshot schedule.

        Valid values: MODIFYING | ACTIVE | FAILED

        Parameters:
        snapshotScheduleState - The current state of the cluster snapshot schedule.

        Valid values: MODIFYING | ACTIVE | FAILED

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • vpcId

        AwsRedshiftClusterDetails.Builder vpcId​(String vpcId)

        The identifier of the VPC that the cluster is in, if the cluster is in a VPC.

        Parameters:
        vpcId - The identifier of the VPC that the cluster is in, if the cluster is in a VPC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • vpcSecurityGroups

        AwsRedshiftClusterDetails.Builder vpcSecurityGroups​(Collection<AwsRedshiftClusterVpcSecurityGroup> vpcSecurityGroups)

        The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.

        Parameters:
        vpcSecurityGroups - The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • vpcSecurityGroups

        AwsRedshiftClusterDetails.Builder vpcSecurityGroups​(AwsRedshiftClusterVpcSecurityGroup... vpcSecurityGroups)

        The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.

        Parameters:
        vpcSecurityGroups - The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • loggingStatus

        AwsRedshiftClusterDetails.Builder loggingStatus​(AwsRedshiftClusterLoggingStatus loggingStatus)

        Information about the logging status of the cluster.

        Parameters:
        loggingStatus - Information about the logging status of the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.