Interface AwsRedshiftClusterDetails.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AwsRedshiftClusterDetails.Builder,
,AwsRedshiftClusterDetails> SdkBuilder<AwsRedshiftClusterDetails.Builder,
,AwsRedshiftClusterDetails> SdkPojo
- Enclosing class:
AwsRedshiftClusterDetails
-
Method Summary
Modifier and TypeMethodDescriptionallowVersionUpgrade
(Boolean allowVersionUpgrade) Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.automatedSnapshotRetentionPeriod
(Integer automatedSnapshotRetentionPeriod) The number of days that automatic cluster snapshots are retained.availabilityZone
(String availabilityZone) The name of the Availability Zone in which the cluster is located.clusterAvailabilityStatus
(String clusterAvailabilityStatus) The availability status of the cluster for queries.clusterCreateTime
(String clusterCreateTime) Indicates when the cluster was created.clusterIdentifier
(String clusterIdentifier) The unique identifier of the cluster.clusterNodes
(Collection<AwsRedshiftClusterClusterNode> clusterNodes) The nodes in the cluster.clusterNodes
(Consumer<AwsRedshiftClusterClusterNode.Builder>... clusterNodes) The nodes in the cluster.clusterNodes
(AwsRedshiftClusterClusterNode... clusterNodes) The nodes in the cluster.clusterParameterGroups
(Collection<AwsRedshiftClusterClusterParameterGroup> clusterParameterGroups) The list of cluster parameter groups that are associated with this cluster.clusterParameterGroups
(Consumer<AwsRedshiftClusterClusterParameterGroup.Builder>... clusterParameterGroups) The list of cluster parameter groups that are associated with this cluster.clusterParameterGroups
(AwsRedshiftClusterClusterParameterGroup... clusterParameterGroups) The list of cluster parameter groups that are associated with this cluster.clusterPublicKey
(String clusterPublicKey) The public key for the cluster.clusterRevisionNumber
(String clusterRevisionNumber) The specific revision number of the database in the cluster.clusterSecurityGroups
(Collection<AwsRedshiftClusterClusterSecurityGroup> clusterSecurityGroups) A list of cluster security groups that are associated with the cluster.clusterSecurityGroups
(Consumer<AwsRedshiftClusterClusterSecurityGroup.Builder>... clusterSecurityGroups) A list of cluster security groups that are associated with the cluster.clusterSecurityGroups
(AwsRedshiftClusterClusterSecurityGroup... clusterSecurityGroups) A list of cluster security groups that are associated with the cluster.clusterSnapshotCopyStatus
(Consumer<AwsRedshiftClusterClusterSnapshotCopyStatus.Builder> clusterSnapshotCopyStatus) Information about the destination Region and retention period for the cross-Region snapshot copy.clusterSnapshotCopyStatus
(AwsRedshiftClusterClusterSnapshotCopyStatus clusterSnapshotCopyStatus) Information about the destination Region and retention period for the cross-Region snapshot copy.clusterStatus
(String clusterStatus) The current status of the cluster.clusterSubnetGroupName
(String clusterSubnetGroupName) The name of the subnet group that is associated with the cluster.clusterVersion
(String clusterVersion) The version ID of the Amazon Redshift engine that runs on the cluster.The name of the initial database that was created when the cluster was created.deferredMaintenanceWindows
(Collection<AwsRedshiftClusterDeferredMaintenanceWindow> deferredMaintenanceWindows) List of time windows during which maintenance was deferred.deferredMaintenanceWindows
(Consumer<AwsRedshiftClusterDeferredMaintenanceWindow.Builder>... deferredMaintenanceWindows) List of time windows during which maintenance was deferred.deferredMaintenanceWindows
(AwsRedshiftClusterDeferredMaintenanceWindow... deferredMaintenanceWindows) List of time windows during which maintenance was deferred.elasticIpStatus
(Consumer<AwsRedshiftClusterElasticIpStatus.Builder> elasticIpStatus) Information about the status of the Elastic IP (EIP) address.elasticIpStatus
(AwsRedshiftClusterElasticIpStatus elasticIpStatus) Information about the status of the Elastic IP (EIP) address.elasticResizeNumberOfNodeOptions
(String elasticResizeNumberOfNodeOptions) The number of nodes that you can use the elastic resize method to resize the cluster to.Indicates whether the data in the cluster is encrypted at rest.endpoint
(Consumer<AwsRedshiftClusterEndpoint.Builder> endpoint) The connection endpoint.endpoint
(AwsRedshiftClusterEndpoint endpoint) The connection endpoint.enhancedVpcRouting
(Boolean enhancedVpcRouting) Indicates whether to create the cluster with enhanced VPC routing enabled.expectedNextSnapshotScheduleTime
(String expectedNextSnapshotScheduleTime) Indicates when the next snapshot is expected to be taken.expectedNextSnapshotScheduleTimeStatus
(String expectedNextSnapshotScheduleTimeStatus) The status of the next expected snapshot.hsmStatus
(Consumer<AwsRedshiftClusterHsmStatus.Builder> 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.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.iamRoles
(Collection<AwsRedshiftClusterIamRole> iamRoles) A list of IAM roles that the cluster can use to access other Amazon Web Services services.iamRoles
(Consumer<AwsRedshiftClusterIamRole.Builder>... iamRoles) A list of IAM roles that the cluster can use to access other Amazon Web Services services.iamRoles
(AwsRedshiftClusterIamRole... iamRoles) A list of IAM roles that the cluster can use to access other Amazon Web Services services.The identifier of the KMS encryption key that is used to encrypt data in the cluster.loggingStatus
(Consumer<AwsRedshiftClusterLoggingStatus.Builder> loggingStatus) Information about the logging status of the cluster.loggingStatus
(AwsRedshiftClusterLoggingStatus loggingStatus) Information about the logging status of the cluster.maintenanceTrackName
(String maintenanceTrackName) The name of the maintenance track for the cluster.manualSnapshotRetentionPeriod
(Integer manualSnapshotRetentionPeriod) The default number of days to retain a manual snapshot.masterUsername
(String masterUsername) The master user name for the cluster.nextMaintenanceWindowStartTime
(String nextMaintenanceWindowStartTime) Indicates the start of the next maintenance window.The node type for the nodes in the cluster.numberOfNodes
(Integer numberOfNodes) The number of compute nodes in the cluster.pendingActions
(String... pendingActions) A list of cluster operations that are waiting to start.pendingActions
(Collection<String> pendingActions) A list of cluster operations that are waiting to start.pendingModifiedValues
(Consumer<AwsRedshiftClusterPendingModifiedValues.Builder> pendingModifiedValues) A list of changes to the cluster that are currently pending.pendingModifiedValues
(AwsRedshiftClusterPendingModifiedValues pendingModifiedValues) A list of changes to the cluster that are currently pending.preferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.publiclyAccessible
(Boolean publiclyAccessible) Whether the cluster can be accessed from a public network.resizeInfo
(Consumer<AwsRedshiftClusterResizeInfo.Builder> resizeInfo) Information about the resize operation for the cluster.resizeInfo
(AwsRedshiftClusterResizeInfo resizeInfo) Information about the resize operation for the cluster.restoreStatus
(Consumer<AwsRedshiftClusterRestoreStatus.Builder> restoreStatus) Information about the status of a cluster restore action.restoreStatus
(AwsRedshiftClusterRestoreStatus restoreStatus) Information about the status of a cluster restore action.snapshotScheduleIdentifier
(String snapshotScheduleIdentifier) A unique identifier for the cluster snapshot schedule.snapshotScheduleState
(String snapshotScheduleState) The current state of the cluster snapshot schedule.The identifier of the VPC that the cluster is in, if the cluster is in a VPC.vpcSecurityGroups
(Collection<AwsRedshiftClusterVpcSecurityGroup> vpcSecurityGroups) The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.vpcSecurityGroups
(Consumer<AwsRedshiftClusterVpcSecurityGroup.Builder>... vpcSecurityGroups) The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.vpcSecurityGroups
(AwsRedshiftClusterVpcSecurityGroup... vpcSecurityGroups) The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
Indicates when the cluster was created.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
- Parameters:
clusterCreateTime
- Indicates when the cluster was created.This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
-
clusterNodes
AwsRedshiftClusterDetails.Builder clusterNodes(Collection<AwsRedshiftClusterClusterNode> 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
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
AwsRedshiftClusterDetails.Builder clusterNodes(Consumer<AwsRedshiftClusterClusterNode.Builder>... clusterNodes) The nodes in the cluster.
This is a convenience method that creates an instance of theAwsRedshiftClusterClusterNode.Builder
avoiding the need to create one manually viaAwsRedshiftClusterClusterNode.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toclusterNodes(List<AwsRedshiftClusterClusterNode>)
.- Parameters:
clusterNodes
- a consumer that will call methods onAwsRedshiftClusterClusterNode.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
clusterParameterGroups
AwsRedshiftClusterDetails.Builder clusterParameterGroups(Consumer<AwsRedshiftClusterClusterParameterGroup.Builder>... clusterParameterGroups) The list of cluster parameter groups that are associated with this cluster.
This is a convenience method that creates an instance of theAwsRedshiftClusterClusterParameterGroup.Builder
avoiding the need to create one manually viaAwsRedshiftClusterClusterParameterGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toclusterParameterGroups(List<AwsRedshiftClusterClusterParameterGroup>)
.- Parameters:
clusterParameterGroups
- a consumer that will call methods onAwsRedshiftClusterClusterParameterGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-
clusterSecurityGroups
AwsRedshiftClusterDetails.Builder clusterSecurityGroups(Consumer<AwsRedshiftClusterClusterSecurityGroup.Builder>... clusterSecurityGroups) A list of cluster security groups that are associated with the cluster.
This is a convenience method that creates an instance of theAwsRedshiftClusterClusterSecurityGroup.Builder
avoiding the need to create one manually viaAwsRedshiftClusterClusterSecurityGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toclusterSecurityGroups(List<AwsRedshiftClusterClusterSecurityGroup>)
.- Parameters:
clusterSecurityGroups
- a consumer that will call methods onAwsRedshiftClusterClusterSecurityGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
clusterSnapshotCopyStatus
default AwsRedshiftClusterDetails.Builder clusterSnapshotCopyStatus(Consumer<AwsRedshiftClusterClusterSnapshotCopyStatus.Builder> clusterSnapshotCopyStatus) Information about the destination Region and retention period for the cross-Region snapshot copy.
This is a convenience method that creates an instance of theAwsRedshiftClusterClusterSnapshotCopyStatus.Builder
avoiding the need to create one manually viaAwsRedshiftClusterClusterSnapshotCopyStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toclusterSnapshotCopyStatus(AwsRedshiftClusterClusterSnapshotCopyStatus)
.- Parameters:
clusterSnapshotCopyStatus
- a consumer that will call methods onAwsRedshiftClusterClusterSnapshotCopyStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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(Collection<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.
-
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.
-
deferredMaintenanceWindows
AwsRedshiftClusterDetails.Builder deferredMaintenanceWindows(Consumer<AwsRedshiftClusterDeferredMaintenanceWindow.Builder>... deferredMaintenanceWindows) List of time windows during which maintenance was deferred.
This is a convenience method that creates an instance of theAwsRedshiftClusterDeferredMaintenanceWindow.Builder
avoiding the need to create one manually viaAwsRedshiftClusterDeferredMaintenanceWindow.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todeferredMaintenanceWindows(List<AwsRedshiftClusterDeferredMaintenanceWindow>)
.- Parameters:
deferredMaintenanceWindows
- a consumer that will call methods onAwsRedshiftClusterDeferredMaintenanceWindow.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
elasticIpStatus
default AwsRedshiftClusterDetails.Builder elasticIpStatus(Consumer<AwsRedshiftClusterElasticIpStatus.Builder> elasticIpStatus) Information about the status of the Elastic IP (EIP) address.
This is a convenience method that creates an instance of theAwsRedshiftClusterElasticIpStatus.Builder
avoiding the need to create one manually viaAwsRedshiftClusterElasticIpStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toelasticIpStatus(AwsRedshiftClusterElasticIpStatus)
.- Parameters:
elasticIpStatus
- a consumer that will call methods onAwsRedshiftClusterElasticIpStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-
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 AwsRedshiftClusterDetails.Builder endpoint(Consumer<AwsRedshiftClusterEndpoint.Builder> endpoint) The connection endpoint.
This is a convenience method that creates an instance of theAwsRedshiftClusterEndpoint.Builder
avoiding the need to create one manually viaAwsRedshiftClusterEndpoint.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toendpoint(AwsRedshiftClusterEndpoint)
.- Parameters:
endpoint
- a consumer that will call methods onAwsRedshiftClusterEndpoint.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
- Parameters:
expectedNextSnapshotScheduleTime
- Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
-
- 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
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.
-
hsmStatus
default AwsRedshiftClusterDetails.Builder hsmStatus(Consumer<AwsRedshiftClusterHsmStatus.Builder> 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.
This is a convenience method that creates an instance of theAwsRedshiftClusterHsmStatus.Builder
avoiding the need to create one manually viaAwsRedshiftClusterHsmStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohsmStatus(AwsRedshiftClusterHsmStatus)
.- Parameters:
hsmStatus
- a consumer that will call methods onAwsRedshiftClusterHsmStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
A list of IAM roles that the cluster can use to access other Amazon Web Services services.
This is a convenience method that creates an instance of theAwsRedshiftClusterIamRole.Builder
avoiding the need to create one manually viaAwsRedshiftClusterIamRole.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toiamRoles(List<AwsRedshiftClusterIamRole>)
.- Parameters:
iamRoles
- a consumer that will call methods onAwsRedshiftClusterIamRole.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 ofDBName
.- 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.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
- Parameters:
nextMaintenanceWindowStartTime
- Indicates the start of the next maintenance window.This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
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
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
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.
-
pendingModifiedValues
default AwsRedshiftClusterDetails.Builder pendingModifiedValues(Consumer<AwsRedshiftClusterPendingModifiedValues.Builder> pendingModifiedValues) A list of changes to the cluster that are currently pending.
This is a convenience method that creates an instance of theAwsRedshiftClusterPendingModifiedValues.Builder
avoiding the need to create one manually viaAwsRedshiftClusterPendingModifiedValues.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topendingModifiedValues(AwsRedshiftClusterPendingModifiedValues)
.- Parameters:
pendingModifiedValues
- a consumer that will call methods onAwsRedshiftClusterPendingModifiedValues.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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.
-
resizeInfo
default AwsRedshiftClusterDetails.Builder resizeInfo(Consumer<AwsRedshiftClusterResizeInfo.Builder> resizeInfo) Information about the resize operation for the cluster.
This is a convenience method that creates an instance of theAwsRedshiftClusterResizeInfo.Builder
avoiding the need to create one manually viaAwsRedshiftClusterResizeInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresizeInfo(AwsRedshiftClusterResizeInfo)
.- Parameters:
resizeInfo
- a consumer that will call methods onAwsRedshiftClusterResizeInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
restoreStatus
default AwsRedshiftClusterDetails.Builder restoreStatus(Consumer<AwsRedshiftClusterRestoreStatus.Builder> restoreStatus) Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.
This is a convenience method that creates an instance of theAwsRedshiftClusterRestoreStatus.Builder
avoiding the need to create one manually viaAwsRedshiftClusterRestoreStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torestoreStatus(AwsRedshiftClusterRestoreStatus)
.- Parameters:
restoreStatus
- a consumer that will call methods onAwsRedshiftClusterRestoreStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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.
-
vpcSecurityGroups
AwsRedshiftClusterDetails.Builder vpcSecurityGroups(Consumer<AwsRedshiftClusterVpcSecurityGroup.Builder>... vpcSecurityGroups) The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
This is a convenience method that creates an instance of theAwsRedshiftClusterVpcSecurityGroup.Builder
avoiding the need to create one manually viaAwsRedshiftClusterVpcSecurityGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcSecurityGroups(List<AwsRedshiftClusterVpcSecurityGroup>)
.- Parameters:
vpcSecurityGroups
- a consumer that will call methods onAwsRedshiftClusterVpcSecurityGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
loggingStatus
default AwsRedshiftClusterDetails.Builder loggingStatus(Consumer<AwsRedshiftClusterLoggingStatus.Builder> loggingStatus) Information about the logging status of the cluster.
This is a convenience method that creates an instance of theAwsRedshiftClusterLoggingStatus.Builder
avoiding the need to create one manually viaAwsRedshiftClusterLoggingStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologgingStatus(AwsRedshiftClusterLoggingStatus)
.- Parameters:
loggingStatus
- a consumer that will call methods onAwsRedshiftClusterLoggingStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-