Package software.amazon.awssdk.services.redshift.model

Interface Cluster.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Cluster.Builder,Cluster>, SdkBuilder<Cluster.Builder,Cluster>, SdkPojo
Enclosing class:
Cluster
public static interface Cluster.Builder extends SdkPojo, CopyableBuilder<Cluster.Builder,Cluster>

  • Method Details

    • clusterIdentifier

      Cluster.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.

    • nodeType

      Cluster.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.

    • clusterStatus

      Cluster.Builder clusterStatus(String clusterStatus)

      The current state of the cluster. Possible values are the following:

      • 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 state of the cluster. Possible values are the following:

      • 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.

    • clusterAvailabilityStatus

      Cluster.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.

    • modifyStatus

      Cluster.Builder modifyStatus(String modifyStatus)

      The status of a modify operation, if any, initiated for the cluster.

      Parameters:
      modifyStatus - The status of a modify operation, if any, initiated for the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterUsername

      Cluster.Builder masterUsername(String masterUsername)

      The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

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

    • dbName

      Cluster.Builder dbName(String dbName)

      The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

      Parameters:
      dbName - The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoint

      Cluster.Builder endpoint(Endpoint endpoint)

      The connection endpoint.

      Parameters:
      endpoint - The connection endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoint

      default Cluster.Builder endpoint(Consumer<Endpoint.Builder> endpoint)

      The connection endpoint.

      This is a convenience method that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpoint(Endpoint).

      Parameters:
      endpoint - a consumer that will call methods on Endpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterCreateTime

      Cluster.Builder clusterCreateTime(Instant clusterCreateTime)

      The date and time that the cluster was created.

      Parameters:
      clusterCreateTime - The date and time that the cluster was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • automatedSnapshotRetentionPeriod

      Cluster.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.

    • manualSnapshotRetentionPeriod

      Cluster.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.

      The value must be 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.

      The value must be 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.

    • clusterSecurityGroups

      Cluster.Builder clusterSecurityGroups(Collection<ClusterSecurityGroupMembership> clusterSecurityGroups)

      A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

      Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

      Parameters:
      clusterSecurityGroups - A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

      Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

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

    • clusterSecurityGroups

      Cluster.Builder clusterSecurityGroups(ClusterSecurityGroupMembership... clusterSecurityGroups)

      A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

      Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

      Parameters:
      clusterSecurityGroups - A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

      Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

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

    • clusterSecurityGroups

      Cluster.Builder clusterSecurityGroups(Consumer<ClusterSecurityGroupMembership.Builder>... clusterSecurityGroups)

      A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

      Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

      This is a convenience method that creates an instance of the ClusterSecurityGroupMembership.Builder avoiding the need to create one manually via ClusterSecurityGroupMembership.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clusterSecurityGroups(List<ClusterSecurityGroupMembership>).

      Parameters:
      clusterSecurityGroups - a consumer that will call methods on ClusterSecurityGroupMembership.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcSecurityGroups

      Cluster.Builder vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

      A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

      Parameters:
      vpcSecurityGroups - A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroups

      Cluster.Builder vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)

      A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

      Parameters:
      vpcSecurityGroups - A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroups

      Cluster.Builder vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)

      A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

      This is a convenience method that creates an instance of the VpcSecurityGroupMembership.Builder avoiding the need to create one manually via VpcSecurityGroupMembership.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcSecurityGroups(List<VpcSecurityGroupMembership>).

      Parameters:
      vpcSecurityGroups - a consumer that will call methods on VpcSecurityGroupMembership.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterParameterGroups

      Cluster.Builder clusterParameterGroups(Collection<ClusterParameterGroupStatus> clusterParameterGroups)

      The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

      Parameters:
      clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterParameterGroups

      Cluster.Builder clusterParameterGroups(ClusterParameterGroupStatus... clusterParameterGroups)

      The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

      Parameters:
      clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterParameterGroups

      Cluster.Builder clusterParameterGroups(Consumer<ClusterParameterGroupStatus.Builder>... clusterParameterGroups)

      The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

      This is a convenience method that creates an instance of the ClusterParameterGroupStatus.Builder avoiding the need to create one manually via ClusterParameterGroupStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clusterParameterGroups(List<ClusterParameterGroupStatus>).

      Parameters:
      clusterParameterGroups - a consumer that will call methods on ClusterParameterGroupStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterSubnetGroupName

      Cluster.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.

    • vpcId

      Cluster.Builder vpcId(String vpcId)

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

      Parameters:
      vpcId - The identifier of the VPC 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.

    • availabilityZone

      Cluster.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.

    • preferredMaintenanceWindow

      Cluster.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

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

      Parameters:
      preferredMaintenanceWindow - The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingModifiedValues

      Cluster.Builder pendingModifiedValues(PendingModifiedValues pendingModifiedValues)

      A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

      Parameters:
      pendingModifiedValues - A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingModifiedValues

      default Cluster.Builder pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)

      A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

      This is a convenience method that creates an instance of the PendingModifiedValues.Builder avoiding the need to create one manually via PendingModifiedValues.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pendingModifiedValues(PendingModifiedValues).

      Parameters:
      pendingModifiedValues - a consumer that will call methods on PendingModifiedValues.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterVersion

      Cluster.Builder clusterVersion(String clusterVersion)

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

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

    • allowVersionUpgrade

      Cluster.Builder allowVersionUpgrade(Boolean allowVersionUpgrade)

      A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

      Parameters:
      allowVersionUpgrade - A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • numberOfNodes

      Cluster.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.

    • publiclyAccessible

      Cluster.Builder publiclyAccessible(Boolean publiclyAccessible)

      A boolean value that, if true, indicates that the cluster can be accessed from a public network.

      Parameters:
      publiclyAccessible - A boolean value that, if true, indicates that the cluster can be accessed from a public network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encrypted

      Cluster.Builder encrypted(Boolean encrypted)

      A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

      Parameters:
      encrypted - A boolean value that, if true, indicates that data in the cluster is encrypted at rest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restoreStatus

      Cluster.Builder restoreStatus(RestoreStatus restoreStatus)

      A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

      Parameters:
      restoreStatus - A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restoreStatus

      default Cluster.Builder restoreStatus(Consumer<RestoreStatus.Builder> restoreStatus)

      A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

      This is a convenience method that creates an instance of the RestoreStatus.Builder avoiding the need to create one manually via RestoreStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to restoreStatus(RestoreStatus).

      Parameters:
      restoreStatus - a consumer that will call methods on RestoreStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataTransferProgress

      Cluster.Builder dataTransferProgress(DataTransferProgress dataTransferProgress)

      Parameters:
      dataTransferProgress -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataTransferProgress

      default Cluster.Builder dataTransferProgress(Consumer<DataTransferProgress.Builder> dataTransferProgress)

      This is a convenience method that creates an instance of the DataTransferProgress.Builder avoiding the need to create one manually via DataTransferProgress.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataTransferProgress(DataTransferProgress).

      Parameters:
      dataTransferProgress - a consumer that will call methods on DataTransferProgress.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hsmStatus

      Cluster.Builder hsmStatus(HsmStatus hsmStatus)

      A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.

      Values: active, applying

      Parameters:
      hsmStatus - A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.

      Values: active, applying

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

    • hsmStatus

      default Cluster.Builder hsmStatus(Consumer<HsmStatus.Builder> hsmStatus)

      A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.

      Values: active, applying

      This is a convenience method that creates an instance of the HsmStatus.Builder avoiding the need to create one manually via HsmStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hsmStatus(HsmStatus).

      Parameters:
      hsmStatus - a consumer that will call methods on HsmStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterSnapshotCopyStatus

      Cluster.Builder clusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)

      A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

      Parameters:
      clusterSnapshotCopyStatus - A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterSnapshotCopyStatus

      default Cluster.Builder clusterSnapshotCopyStatus(Consumer<ClusterSnapshotCopyStatus.Builder> clusterSnapshotCopyStatus)

      A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

      This is a convenience method that creates an instance of the ClusterSnapshotCopyStatus.Builder avoiding the need to create one manually via ClusterSnapshotCopyStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clusterSnapshotCopyStatus(ClusterSnapshotCopyStatus).

      Parameters:
      clusterSnapshotCopyStatus - a consumer that will call methods on ClusterSnapshotCopyStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterPublicKey

      Cluster.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.

    • clusterNodes

      Cluster.Builder clusterNodes(Collection<ClusterNode> clusterNodes)

      The nodes in the cluster.

      Parameters:
      clusterNodes - The nodes in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterNodes

      Cluster.Builder clusterNodes(ClusterNode... clusterNodes)

      The nodes in the cluster.

      Parameters:
      clusterNodes - The nodes in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterNodes

      Cluster.Builder clusterNodes(Consumer<ClusterNode.Builder>... clusterNodes)

      The nodes in the cluster.

      This is a convenience method that creates an instance of the ClusterNode.Builder avoiding the need to create one manually via ClusterNode.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clusterNodes(List<ClusterNode>).

      Parameters:
      clusterNodes - a consumer that will call methods on ClusterNode.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • elasticIpStatus

      Cluster.Builder elasticIpStatus(ElasticIpStatus elasticIpStatus)

      The status of the elastic IP (EIP) address.

      Parameters:
      elasticIpStatus - The status of the elastic IP (EIP) address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • elasticIpStatus

      default Cluster.Builder elasticIpStatus(Consumer<ElasticIpStatus.Builder> elasticIpStatus)

      The status of the elastic IP (EIP) address.

      This is a convenience method that creates an instance of the ElasticIpStatus.Builder avoiding the need to create one manually via ElasticIpStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to elasticIpStatus(ElasticIpStatus).

      Parameters:
      elasticIpStatus - a consumer that will call methods on ElasticIpStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterRevisionNumber

      Cluster.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.

    • tags

      Cluster.Builder tags(Collection<Tag> tags)

      The list of tags for the cluster.

      Parameters:
      tags - The list of tags for the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Cluster.Builder tags(Tag... tags)

      The list of tags for the cluster.

      Parameters:
      tags - The list of tags for the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Cluster.Builder tags(Consumer<Tag.Builder>... tags)

      The list of tags for the cluster.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKeyId

      Cluster.Builder kmsKeyId(String kmsKeyId)

      The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

      Parameters:
      kmsKeyId - The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enhancedVpcRouting

      Cluster.Builder enhancedVpcRouting(Boolean 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

      Parameters:
      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

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

    • iamRoles

      Cluster.Builder iamRoles(Collection<ClusterIamRole> iamRoles)

      A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

      Parameters:
      iamRoles - A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamRoles

      Cluster.Builder iamRoles(ClusterIamRole... iamRoles)

      A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

      Parameters:
      iamRoles - A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamRoles

      Cluster.Builder iamRoles(Consumer<ClusterIamRole.Builder>... iamRoles)

      A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

      This is a convenience method that creates an instance of the ClusterIamRole.Builder avoiding the need to create one manually via ClusterIamRole.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to iamRoles(List<ClusterIamRole>).

      Parameters:
      iamRoles - a consumer that will call methods on ClusterIamRole.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pendingActions

      Cluster.Builder pendingActions(Collection<String> pendingActions)

      Cluster operations that are waiting to be started.

      Parameters:
      pendingActions - Cluster operations that are waiting to be started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingActions

      Cluster.Builder pendingActions(String... pendingActions)

      Cluster operations that are waiting to be started.

      Parameters:
      pendingActions - Cluster operations that are waiting to be started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maintenanceTrackName

      Cluster.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.

    • elasticResizeNumberOfNodeOptions

      Cluster.Builder elasticResizeNumberOfNodeOptions(String elasticResizeNumberOfNodeOptions)

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

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

    • deferredMaintenanceWindows

      Cluster.Builder deferredMaintenanceWindows(Collection<DeferredMaintenanceWindow> deferredMaintenanceWindows)

      Describes a group of DeferredMaintenanceWindow objects.

      Parameters:
      deferredMaintenanceWindows - Describes a group of DeferredMaintenanceWindow objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deferredMaintenanceWindows

      Cluster.Builder deferredMaintenanceWindows(DeferredMaintenanceWindow... deferredMaintenanceWindows)

      Describes a group of DeferredMaintenanceWindow objects.

      Parameters:
      deferredMaintenanceWindows - Describes a group of DeferredMaintenanceWindow objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deferredMaintenanceWindows

      Cluster.Builder deferredMaintenanceWindows(Consumer<DeferredMaintenanceWindow.Builder>... deferredMaintenanceWindows)

      Describes a group of DeferredMaintenanceWindow objects.

      This is a convenience method that creates an instance of the DeferredMaintenanceWindow.Builder avoiding the need to create one manually via DeferredMaintenanceWindow.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deferredMaintenanceWindows(List<DeferredMaintenanceWindow>).

      Parameters:
      deferredMaintenanceWindows - a consumer that will call methods on DeferredMaintenanceWindow.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snapshotScheduleIdentifier

      Cluster.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

      Cluster.Builder snapshotScheduleState(String snapshotScheduleState)

      The current state of the cluster snapshot schedule.

      Parameters:
      snapshotScheduleState - The current state of the cluster snapshot schedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snapshotScheduleState

      Cluster.Builder snapshotScheduleState(ScheduleState snapshotScheduleState)

      The current state of the cluster snapshot schedule.

      Parameters:
      snapshotScheduleState - The current state of the cluster snapshot schedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expectedNextSnapshotScheduleTime

      Cluster.Builder expectedNextSnapshotScheduleTime(Instant expectedNextSnapshotScheduleTime)

      The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

      Parameters:
      expectedNextSnapshotScheduleTime - The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expectedNextSnapshotScheduleTimeStatus

      Cluster.Builder expectedNextSnapshotScheduleTimeStatus(String expectedNextSnapshotScheduleTimeStatus)

      The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

      • OnTrack - The next snapshot is expected to be taken on time.

      • Pending - The next snapshot is pending to be taken.

      Parameters:
      expectedNextSnapshotScheduleTimeStatus - The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

      • OnTrack - The next snapshot is expected to be taken on time.

      • Pending - The next snapshot is pending to be taken.

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

    • nextMaintenanceWindowStartTime

      Cluster.Builder nextMaintenanceWindowStartTime(Instant nextMaintenanceWindowStartTime)

      The date and time in UTC when system maintenance can begin.

      Parameters:
      nextMaintenanceWindowStartTime - The date and time in UTC when system maintenance can begin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resizeInfo

      Cluster.Builder resizeInfo(ResizeInfo resizeInfo)

      Returns the following:

      • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

      • ResizeType: Returns ClassicResize

      Parameters:
      resizeInfo - Returns the following:

      • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

      • ResizeType: Returns ClassicResize

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

    • resizeInfo

      default Cluster.Builder resizeInfo(Consumer<ResizeInfo.Builder> resizeInfo)

      Returns the following:

      • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

      • ResizeType: Returns ClassicResize

      This is a convenience method that creates an instance of the ResizeInfo.Builder avoiding the need to create one manually via ResizeInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resizeInfo(ResizeInfo).

      Parameters:
      resizeInfo - a consumer that will call methods on ResizeInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • availabilityZoneRelocationStatus

      Cluster.Builder availabilityZoneRelocationStatus(String availabilityZoneRelocationStatus)

      Describes the status of the Availability Zone relocation operation.

      Parameters:
      availabilityZoneRelocationStatus - Describes the status of the Availability Zone relocation operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterNamespaceArn

      Cluster.Builder clusterNamespaceArn(String clusterNamespaceArn)

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

      Parameters:
      clusterNamespaceArn - The namespace Amazon Resource Name (ARN) of the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalStorageCapacityInMegaBytes

      Cluster.Builder totalStorageCapacityInMegaBytes(Long totalStorageCapacityInMegaBytes)

      The total storage capacity of the cluster in megabytes.

      Parameters:
      totalStorageCapacityInMegaBytes - The total storage capacity of the cluster in megabytes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aquaConfiguration

      Cluster.Builder aquaConfiguration(AquaConfiguration aquaConfiguration)

      This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

      Parameters:
      aquaConfiguration - This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aquaConfiguration

      default Cluster.Builder aquaConfiguration(Consumer<AquaConfiguration.Builder> aquaConfiguration)

      This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

      This is a convenience method that creates an instance of the AquaConfiguration.Builder avoiding the need to create one manually via AquaConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to aquaConfiguration(AquaConfiguration).

      Parameters:
      aquaConfiguration - a consumer that will call methods on AquaConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultIamRoleArn

      Cluster.Builder defaultIamRoleArn(String defaultIamRoleArn)

      The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.

      Parameters:
      defaultIamRoleArn - The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reservedNodeExchangeStatus

      Cluster.Builder reservedNodeExchangeStatus(ReservedNodeExchangeStatus reservedNodeExchangeStatus)

      The status of the reserved-node exchange request. Statuses include in-progress and requested.

      Parameters:
      reservedNodeExchangeStatus - The status of the reserved-node exchange request. Statuses include in-progress and requested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reservedNodeExchangeStatus

      default Cluster.Builder reservedNodeExchangeStatus(Consumer<ReservedNodeExchangeStatus.Builder> reservedNodeExchangeStatus)

      The status of the reserved-node exchange request. Statuses include in-progress and requested.

      This is a convenience method that creates an instance of the ReservedNodeExchangeStatus.Builder avoiding the need to create one manually via ReservedNodeExchangeStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reservedNodeExchangeStatus(ReservedNodeExchangeStatus).

      Parameters:
      reservedNodeExchangeStatus - a consumer that will call methods on ReservedNodeExchangeStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customDomainName

      Cluster.Builder customDomainName(String customDomainName)

      The custom domain name associated with the cluster.

      Parameters:
      customDomainName - The custom domain name associated with the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customDomainCertificateArn

      Cluster.Builder customDomainCertificateArn(String customDomainCertificateArn)

      The certificate Amazon Resource Name (ARN) for the custom domain name.

      Parameters:
      customDomainCertificateArn - The certificate Amazon Resource Name (ARN) for the custom domain name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customDomainCertificateExpiryDate

      Cluster.Builder customDomainCertificateExpiryDate(Instant customDomainCertificateExpiryDate)

      The expiration date for the certificate associated with the custom domain name.

      Parameters:
      customDomainCertificateExpiryDate - The expiration date for the certificate associated with the custom domain name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterPasswordSecretArn

      Cluster.Builder masterPasswordSecretArn(String masterPasswordSecretArn)

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

      Parameters:
      masterPasswordSecretArn - The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterPasswordSecretKmsKeyId

      Cluster.Builder masterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)

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

      Parameters:
      masterPasswordSecretKmsKeyId - The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipAddressType

      Cluster.Builder ipAddressType(String ipAddressType)

      The IP address type for the cluster. Possible values are ipv4 and dualstack.

      Parameters:
      ipAddressType - The IP address type for the cluster. Possible values are ipv4 and dualstack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multiAZ

      Cluster.Builder multiAZ(String multiAZ)

      A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.

      Parameters:
      multiAZ - A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multiAZSecondary

      Cluster.Builder multiAZSecondary(SecondaryClusterInfo multiAZSecondary)

      The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.

      Parameters:
      multiAZSecondary - The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multiAZSecondary

      default Cluster.Builder multiAZSecondary(Consumer<SecondaryClusterInfo.Builder> multiAZSecondary)

      The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.

      This is a convenience method that creates an instance of the SecondaryClusterInfo.Builder avoiding the need to create one manually via SecondaryClusterInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to multiAZSecondary(SecondaryClusterInfo).

      Parameters:
      multiAZSecondary - a consumer that will call methods on SecondaryClusterInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: