public static interface Cluster.Builder extends SdkPojo, CopyableBuilder<Cluster.Builder,Cluster>
| Modifier and Type | Method and Description |
|---|---|
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. |
Cluster.Builder |
aquaConfiguration(AquaConfiguration aquaConfiguration)
This field is retired.
|
default Cluster.Builder |
aquaConfiguration(Consumer<AquaConfiguration.Builder> aquaConfiguration)
This field is retired.
|
Cluster.Builder |
automatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
|
Cluster.Builder |
availabilityZone(String availabilityZone)
The name of the Availability Zone in which the cluster is located.
|
Cluster.Builder |
availabilityZoneRelocationStatus(String availabilityZoneRelocationStatus)
Describes the status of the Availability Zone relocation operation.
|
Cluster.Builder |
clusterAvailabilityStatus(String clusterAvailabilityStatus)
The availability status of the cluster for queries.
|
Cluster.Builder |
clusterCreateTime(Instant clusterCreateTime)
The date and time that the cluster was created.
|
Cluster.Builder |
clusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
|
Cluster.Builder |
clusterNamespaceArn(String clusterNamespaceArn)
The namespace Amazon Resource Name (ARN) of the cluster.
|
Cluster.Builder |
clusterNodes(ClusterNode... clusterNodes)
The nodes in the cluster.
|
Cluster.Builder |
clusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
|
Cluster.Builder |
clusterNodes(Consumer<ClusterNode.Builder>... clusterNodes)
The nodes in the cluster.
|
Cluster.Builder |
clusterParameterGroups(ClusterParameterGroupStatus... clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster.
|
Cluster.Builder |
clusterParameterGroups(Collection<ClusterParameterGroupStatus> clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster.
|
Cluster.Builder |
clusterParameterGroups(Consumer<ClusterParameterGroupStatus.Builder>... clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster.
|
Cluster.Builder |
clusterPublicKey(String clusterPublicKey)
The public key for the cluster.
|
Cluster.Builder |
clusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
|
Cluster.Builder |
clusterSecurityGroups(ClusterSecurityGroupMembership... clusterSecurityGroups)
A list of cluster security group that are associated with the cluster.
|
Cluster.Builder |
clusterSecurityGroups(Collection<ClusterSecurityGroupMembership> clusterSecurityGroups)
A list of cluster security group that are associated with the cluster.
|
Cluster.Builder |
clusterSecurityGroups(Consumer<ClusterSecurityGroupMembership.Builder>... clusterSecurityGroups)
A list of cluster security group that are associated with the cluster.
|
Cluster.Builder |
clusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)
A value that returns the destination region and retention period that are configured for cross-region
snapshot copy.
|
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.
|
Cluster.Builder |
clusterStatus(String clusterStatus)
The current state of the cluster.
|
Cluster.Builder |
clusterSubnetGroupName(String clusterSubnetGroupName)
The name of the subnet group that is associated with the cluster.
|
Cluster.Builder |
clusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
|
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(). |
Cluster.Builder |
dataTransferProgress(DataTransferProgress dataTransferProgress)
|
Cluster.Builder |
dbName(String dbName)
The name of the initial database that was created when the cluster was created.
|
Cluster.Builder |
defaultIamRoleArn(String defaultIamRoleArn)
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
|
Cluster.Builder |
deferredMaintenanceWindows(Collection<DeferredMaintenanceWindow> deferredMaintenanceWindows)
Describes a group of
DeferredMaintenanceWindow objects. |
Cluster.Builder |
deferredMaintenanceWindows(Consumer<DeferredMaintenanceWindow.Builder>... deferredMaintenanceWindows)
Describes a group of
DeferredMaintenanceWindow objects. |
Cluster.Builder |
deferredMaintenanceWindows(DeferredMaintenanceWindow... deferredMaintenanceWindows)
Describes a group of
DeferredMaintenanceWindow objects. |
default Cluster.Builder |
elasticIpStatus(Consumer<ElasticIpStatus.Builder> elasticIpStatus)
The status of the elastic IP (EIP) address.
|
Cluster.Builder |
elasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
|
Cluster.Builder |
elasticResizeNumberOfNodeOptions(String elasticResizeNumberOfNodeOptions)
The number of nodes that you can resize the cluster to with the elastic resize method.
|
Cluster.Builder |
encrypted(Boolean encrypted)
A boolean value that, if
true, indicates that data in the cluster is encrypted at rest. |
default Cluster.Builder |
endpoint(Consumer<Endpoint.Builder> endpoint)
The connection endpoint.
|
Cluster.Builder |
endpoint(Endpoint endpoint)
The connection endpoint.
|
Cluster.Builder |
enhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
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.
|
Cluster.Builder |
expectedNextSnapshotScheduleTimeStatus(String expectedNextSnapshotScheduleTimeStatus)
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled.
|
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.
|
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.
|
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.
|
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.
|
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.
|
Cluster.Builder |
kmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
|
Cluster.Builder |
maintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the cluster.
|
Cluster.Builder |
manualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default number of days to retain a manual snapshot.
|
Cluster.Builder |
masterUsername(String masterUsername)
The admin user name for the cluster.
|
Cluster.Builder |
modifyStatus(String modifyStatus)
The status of a modify operation, if any, initiated for the cluster.
|
Cluster.Builder |
nextMaintenanceWindowStartTime(Instant nextMaintenanceWindowStartTime)
The date and time in UTC when system maintenance can begin.
|
Cluster.Builder |
nodeType(String nodeType)
The node type for the nodes in the cluster.
|
Cluster.Builder |
numberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
|
Cluster.Builder |
pendingActions(Collection<String> pendingActions)
Cluster operations that are waiting to be started.
|
Cluster.Builder |
pendingActions(String... pendingActions)
Cluster operations that are waiting to be started.
|
default Cluster.Builder |
pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)
A value that, if present, indicates that changes to the cluster are pending.
|
Cluster.Builder |
pendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A value that, if present, indicates that changes to the cluster are pending.
|
Cluster.Builder |
preferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
|
Cluster.Builder |
publiclyAccessible(Boolean publiclyAccessible)
A boolean value that, if
true, indicates that the cluster can be accessed from a public network. |
default Cluster.Builder |
reservedNodeExchangeStatus(Consumer<ReservedNodeExchangeStatus.Builder> reservedNodeExchangeStatus)
The status of the reserved-node exchange request.
|
Cluster.Builder |
reservedNodeExchangeStatus(ReservedNodeExchangeStatus reservedNodeExchangeStatus)
The status of the reserved-node exchange request.
|
default Cluster.Builder |
resizeInfo(Consumer<ResizeInfo.Builder> resizeInfo)
Returns the following:
|
Cluster.Builder |
resizeInfo(ResizeInfo resizeInfo)
Returns the following:
|
default Cluster.Builder |
restoreStatus(Consumer<RestoreStatus.Builder> restoreStatus)
A value that describes the status of a cluster restore action.
|
Cluster.Builder |
restoreStatus(RestoreStatus restoreStatus)
A value that describes the status of a cluster restore action.
|
Cluster.Builder |
snapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the cluster snapshot schedule.
|
Cluster.Builder |
snapshotScheduleState(ScheduleState snapshotScheduleState)
The current state of the cluster snapshot schedule.
|
Cluster.Builder |
snapshotScheduleState(String snapshotScheduleState)
The current state of the cluster snapshot schedule.
|
Cluster.Builder |
tags(Collection<Tag> tags)
The list of tags for the cluster.
|
Cluster.Builder |
tags(Consumer<Tag.Builder>... tags)
The list of tags for the cluster.
|
Cluster.Builder |
tags(Tag... tags)
The list of tags for the cluster.
|
Cluster.Builder |
totalStorageCapacityInMegaBytes(Long totalStorageCapacityInMegaBytes)
The total storage capacity of the cluster in megabytes.
|
Cluster.Builder |
vpcId(String vpcId)
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
|
Cluster.Builder |
vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
Cluster.Builder |
vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
Cluster.Builder |
vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildCluster.Builder clusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
clusterIdentifier - The unique identifier of the cluster.Cluster.Builder nodeType(String nodeType)
The node type for the nodes in the cluster.
nodeType - The node type for the nodes in the cluster.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
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
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.
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.
Cluster.Builder modifyStatus(String modifyStatus)
The status of a modify operation, if any, initiated for the cluster.
modifyStatus - The status of a modify operation, if any, initiated for the cluster.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.
masterUsername - The admin user name for the cluster. This name is used to connect to the database that is specified in
the DBName parameter.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.
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.Cluster.Builder endpoint(Endpoint endpoint)
The connection endpoint.
endpoint - The connection endpoint.default Cluster.Builder endpoint(Consumer<Endpoint.Builder> endpoint)
The connection endpoint.
This is a convenience method that creates an instance of theEndpoint.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).
endpoint - a consumer that will call methods on Endpoint.Builderendpoint(Endpoint)Cluster.Builder clusterCreateTime(Instant clusterCreateTime)
The date and time that the cluster was created.
clusterCreateTime - The date and time that the cluster was created.Cluster.Builder automatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
automatedSnapshotRetentionPeriod - The number of days that automatic cluster snapshots are retained.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.
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.
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.
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.
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.
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.
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 theClusterSecurityGroupMembership.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.
clusterSecurityGroups - a consumer that will call methods on
ClusterSecurityGroupMembership.Builder#clusterSecurityGroups(java.util.Collection) 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.
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.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.
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.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 theVpcSecurityGroupMembership.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.
vpcSecurityGroups - a consumer that will call methods on
VpcSecurityGroupMembership.Builder#vpcSecurityGroups(java.util.Collection) 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.
clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster. Each parameter group in
the list is returned with its status.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.
clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster. Each parameter group in
the list is returned with its status.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 theClusterParameterGroupStatus.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.
clusterParameterGroups - a consumer that will call methods on
ClusterParameterGroupStatus.Builder#clusterParameterGroups(java.util.Collection) 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.
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.Cluster.Builder vpcId(String vpcId)
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
vpcId - The identifier of the VPC the cluster is in, if the cluster is in a VPC.Cluster.Builder availabilityZone(String availabilityZone)
The name of the Availability Zone in which the cluster is located.
availabilityZone - The name of the Availability Zone in which the cluster is located.Cluster.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
preferredMaintenanceWindow - The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.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.
pendingModifiedValues - A value that, if present, indicates that changes to the cluster are pending. Specific pending changes
are identified by subelements.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 thePendingModifiedValues.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).
pendingModifiedValues - a consumer that will call methods on PendingModifiedValues.BuilderpendingModifiedValues(PendingModifiedValues)Cluster.Builder clusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
clusterVersion - The version ID of the Amazon Redshift engine that is running on the cluster.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.
allowVersionUpgrade - A boolean value that, if true, indicates that major version upgrades will be applied
automatically to the cluster during the maintenance window.Cluster.Builder numberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
numberOfNodes - The number of compute nodes in the cluster.Cluster.Builder publiclyAccessible(Boolean publiclyAccessible)
A boolean value that, if true, indicates that the cluster can be accessed from a public network.
publiclyAccessible - A boolean value that, if true, indicates that the cluster can be accessed from a public
network.Cluster.Builder encrypted(Boolean encrypted)
A boolean value that, if true, indicates that data in the cluster is encrypted at rest.
encrypted - A boolean value that, if true, indicates that data in the cluster is encrypted at rest.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.
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.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 theRestoreStatus.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).
restoreStatus - a consumer that will call methods on RestoreStatus.BuilderrestoreStatus(RestoreStatus)Cluster.Builder dataTransferProgress(DataTransferProgress dataTransferProgress)
dataTransferProgress - default Cluster.Builder dataTransferProgress(Consumer<DataTransferProgress.Builder> dataTransferProgress)
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).
dataTransferProgress - a consumer that will call methods on DataTransferProgress.BuilderdataTransferProgress(DataTransferProgress)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
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
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 theHsmStatus.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).
hsmStatus - a consumer that will call methods on HsmStatus.BuilderhsmStatus(HsmStatus)Cluster.Builder clusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
clusterSnapshotCopyStatus - A value that returns the destination region and retention period that are configured for cross-region
snapshot copy.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 theClusterSnapshotCopyStatus.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).
clusterSnapshotCopyStatus - a consumer that will call methods on ClusterSnapshotCopyStatus.BuilderclusterSnapshotCopyStatus(ClusterSnapshotCopyStatus)Cluster.Builder clusterPublicKey(String clusterPublicKey)
The public key for the cluster.
clusterPublicKey - The public key for the cluster.Cluster.Builder clusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
clusterNodes - The nodes in the cluster.Cluster.Builder clusterNodes(ClusterNode... clusterNodes)
The nodes in the cluster.
clusterNodes - The nodes in the cluster.Cluster.Builder clusterNodes(Consumer<ClusterNode.Builder>... clusterNodes)
The nodes in the cluster.
This is a convenience method that creates an instance of theClusterNode.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.
clusterNodes - a consumer that will call methods on
ClusterNode.Builder#clusterNodes(java.util.Collection) Cluster.Builder elasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
elasticIpStatus - The status of the elastic IP (EIP) address.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 theElasticIpStatus.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).
elasticIpStatus - a consumer that will call methods on ElasticIpStatus.BuilderelasticIpStatus(ElasticIpStatus)Cluster.Builder clusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
clusterRevisionNumber - The specific revision number of the database in the cluster.Cluster.Builder tags(Collection<Tag> tags)
The list of tags for the cluster.
tags - The list of tags for the cluster.Cluster.Builder tags(Tag... tags)
The list of tags for the cluster.
tags - The list of tags for the cluster.Cluster.Builder tags(Consumer<Tag.Builder>... tags)
The list of tags for the cluster.
This is a convenience method that creates an instance of theTag.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.
tags - a consumer that will call methods on
Tag.Builder#tags(java.util.Collection) Cluster.Builder kmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
kmsKeyId - The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.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
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
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.
iamRoles - A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other
Amazon Web Services services.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.
iamRoles - A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other
Amazon Web Services services.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 theClusterIamRole.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.
iamRoles - a consumer that will call methods on
ClusterIamRole.Builder#iamRoles(java.util.Collection) Cluster.Builder pendingActions(Collection<String> pendingActions)
Cluster operations that are waiting to be started.
pendingActions - Cluster operations that are waiting to be started.Cluster.Builder pendingActions(String... pendingActions)
Cluster operations that are waiting to be started.
pendingActions - Cluster operations that are waiting to be started.Cluster.Builder maintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the cluster.
maintenanceTrackName - The name of the maintenance track for the cluster.Cluster.Builder elasticResizeNumberOfNodeOptions(String elasticResizeNumberOfNodeOptions)
The number of nodes that you can resize the cluster to with the elastic resize method.
elasticResizeNumberOfNodeOptions - The number of nodes that you can resize the cluster to with the elastic resize method.Cluster.Builder deferredMaintenanceWindows(Collection<DeferredMaintenanceWindow> deferredMaintenanceWindows)
Describes a group of DeferredMaintenanceWindow objects.
deferredMaintenanceWindows - Describes a group of DeferredMaintenanceWindow objects.Cluster.Builder deferredMaintenanceWindows(DeferredMaintenanceWindow... deferredMaintenanceWindows)
Describes a group of DeferredMaintenanceWindow objects.
deferredMaintenanceWindows - Describes a group of DeferredMaintenanceWindow objects.Cluster.Builder deferredMaintenanceWindows(Consumer<DeferredMaintenanceWindow.Builder>... deferredMaintenanceWindows)
Describes a group of DeferredMaintenanceWindow objects.
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.
deferredMaintenanceWindows - a consumer that will call methods on
DeferredMaintenanceWindow.Builder#deferredMaintenanceWindows(java.util.Collection) Cluster.Builder snapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the cluster snapshot schedule.
snapshotScheduleIdentifier - A unique identifier for the cluster snapshot schedule.Cluster.Builder snapshotScheduleState(String snapshotScheduleState)
The current state of the cluster snapshot schedule.
snapshotScheduleState - The current state of the cluster snapshot schedule.ScheduleState,
ScheduleStateCluster.Builder snapshotScheduleState(ScheduleState snapshotScheduleState)
The current state of the cluster snapshot schedule.
snapshotScheduleState - The current state of the cluster snapshot schedule.ScheduleState,
ScheduleStateCluster.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.
expectedNextSnapshotScheduleTime - The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot
schedule and backups enabled.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.
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.
Cluster.Builder nextMaintenanceWindowStartTime(Instant nextMaintenanceWindowStartTime)
The date and time in UTC when system maintenance can begin.
nextMaintenanceWindowStartTime - The date and time in UTC when system maintenance can begin.Cluster.Builder resizeInfo(ResizeInfo resizeInfo)
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
resizeInfo - Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
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
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).
resizeInfo - a consumer that will call methods on ResizeInfo.BuilderresizeInfo(ResizeInfo)Cluster.Builder availabilityZoneRelocationStatus(String availabilityZoneRelocationStatus)
Describes the status of the Availability Zone relocation operation.
availabilityZoneRelocationStatus - Describes the status of the Availability Zone relocation operation.Cluster.Builder clusterNamespaceArn(String clusterNamespaceArn)
The namespace Amazon Resource Name (ARN) of the cluster.
clusterNamespaceArn - The namespace Amazon Resource Name (ARN) of the cluster.Cluster.Builder totalStorageCapacityInMegaBytes(Long totalStorageCapacityInMegaBytes)
The total storage capacity of the cluster in megabytes.
totalStorageCapacityInMegaBytes - The total storage capacity of the cluster in megabytes.Cluster.Builder aquaConfiguration(AquaConfiguration aquaConfiguration)
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
aquaConfiguration - This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query
Accelerator).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 theAquaConfiguration.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).
aquaConfiguration - a consumer that will call methods on AquaConfiguration.BuilderaquaConfiguration(AquaConfiguration)Cluster.Builder defaultIamRoleArn(String defaultIamRoleArn)
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
defaultIamRoleArn - The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.Cluster.Builder reservedNodeExchangeStatus(ReservedNodeExchangeStatus reservedNodeExchangeStatus)
The status of the reserved-node exchange request. Statuses include in-progress and requested.
reservedNodeExchangeStatus - The status of the reserved-node exchange request. Statuses include in-progress and requested.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 theReservedNodeExchangeStatus.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).
reservedNodeExchangeStatus - a consumer that will call methods on ReservedNodeExchangeStatus.BuilderreservedNodeExchangeStatus(ReservedNodeExchangeStatus)Copyright © 2023. All rights reserved.