@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Cluster extends Object implements Serializable, Cloneable
Describes a cluster.
Constructor and Description |
---|
Cluster() |
Modifier and Type | Method and Description |
---|---|
Cluster |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAllowVersionUpgrade()
A boolean value that, if
true , indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window. |
AquaConfiguration |
getAquaConfiguration()
This field is retired.
|
Integer |
getAutomatedSnapshotRetentionPeriod()
The number of days that automatic cluster snapshots are retained.
|
String |
getAvailabilityZone()
The name of the Availability Zone in which the cluster is located.
|
String |
getAvailabilityZoneRelocationStatus()
Describes the status of the Availability Zone relocation operation.
|
String |
getClusterAvailabilityStatus()
The availability status of the cluster for queries.
|
Date |
getClusterCreateTime()
The date and time that the cluster was created.
|
String |
getClusterIdentifier()
The unique identifier of the cluster.
|
String |
getClusterNamespaceArn()
The namespace Amazon Resource Name (ARN) of the cluster.
|
List<ClusterNode> |
getClusterNodes()
The nodes in the cluster.
|
List<ClusterParameterGroupStatus> |
getClusterParameterGroups()
The list of cluster parameter groups that are associated with this cluster.
|
String |
getClusterPublicKey()
The public key for the cluster.
|
String |
getClusterRevisionNumber()
The specific revision number of the database in the cluster.
|
List<ClusterSecurityGroupMembership> |
getClusterSecurityGroups()
A list of cluster security group that are associated with the cluster.
|
ClusterSnapshotCopyStatus |
getClusterSnapshotCopyStatus()
A value that returns the destination region and retention period that are configured for cross-region snapshot
copy.
|
String |
getClusterStatus()
The current state of the cluster.
|
String |
getClusterSubnetGroupName()
The name of the subnet group that is associated with the cluster.
|
String |
getClusterVersion()
The version ID of the Amazon Redshift engine that is running on the cluster.
|
String |
getCustomDomainCertificateArn()
The certificate Amazon Resource Name (ARN) for the custom domain name.
|
Date |
getCustomDomainCertificateExpiryDate()
The expiration date for the certificate associated with the custom domain name.
|
String |
getCustomDomainName()
The custom domain name associated with the cluster.
|
DataTransferProgress |
getDataTransferProgress()
|
String |
getDBName()
The name of the initial database that was created when the cluster was created.
|
String |
getDefaultIamRoleArn()
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
|
List<DeferredMaintenanceWindow> |
getDeferredMaintenanceWindows()
Describes a group of
DeferredMaintenanceWindow objects. |
ElasticIpStatus |
getElasticIpStatus()
The status of the elastic IP (EIP) address.
|
String |
getElasticResizeNumberOfNodeOptions()
The number of nodes that you can resize the cluster to with the elastic resize method.
|
Boolean |
getEncrypted()
A boolean value that, if
true , indicates that data in the cluster is encrypted at rest. |
Endpoint |
getEndpoint()
The connection endpoint.
|
Boolean |
getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Date |
getExpectedNextSnapshotScheduleTime()
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and
backups enabled.
|
String |
getExpectedNextSnapshotScheduleTimeStatus()
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled.
|
HsmStatus |
getHsmStatus()
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.
|
List<ClusterIamRole> |
getIamRoles()
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web
Services services.
|
String |
getIpAddressType()
The IP address type for the cluster.
|
String |
getKmsKeyId()
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
|
String |
getMaintenanceTrackName()
The name of the maintenance track for the cluster.
|
Integer |
getManualSnapshotRetentionPeriod()
The default number of days to retain a manual snapshot.
|
String |
getMasterPasswordSecretArn()
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
|
String |
getMasterPasswordSecretKmsKeyId()
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
String |
getMasterUsername()
The admin user name for the cluster.
|
String |
getModifyStatus()
The status of a modify operation, if any, initiated for the cluster.
|
String |
getMultiAZ()
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
|
SecondaryClusterInfo |
getMultiAZSecondary()
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
|
Date |
getNextMaintenanceWindowStartTime()
The date and time in UTC when system maintenance can begin.
|
String |
getNodeType()
The node type for the nodes in the cluster.
|
Integer |
getNumberOfNodes()
The number of compute nodes in the cluster.
|
List<String> |
getPendingActions()
Cluster operations that are waiting to be started.
|
PendingModifiedValues |
getPendingModifiedValues()
A value that, if present, indicates that changes to the cluster are pending.
|
String |
getPreferredMaintenanceWindow()
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
|
Boolean |
getPubliclyAccessible()
A boolean value that, if
true , indicates that the cluster can be accessed from a public network. |
ReservedNodeExchangeStatus |
getReservedNodeExchangeStatus()
The status of the reserved-node exchange request.
|
ResizeInfo |
getResizeInfo()
Returns the following:
|
RestoreStatus |
getRestoreStatus()
A value that describes the status of a cluster restore action.
|
String |
getSnapshotScheduleIdentifier()
A unique identifier for the cluster snapshot schedule.
|
String |
getSnapshotScheduleState()
The current state of the cluster snapshot schedule.
|
List<Tag> |
getTags()
The list of tags for the cluster.
|
Long |
getTotalStorageCapacityInMegaBytes()
The total storage capacity of the cluster in megabytes.
|
String |
getVpcId()
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
|
List<VpcSecurityGroupMembership> |
getVpcSecurityGroups()
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
int |
hashCode() |
Boolean |
isAllowVersionUpgrade()
A boolean value that, if
true , indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window. |
Boolean |
isEncrypted()
A boolean value that, if
true , indicates that data in the cluster is encrypted at rest. |
Boolean |
isEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Boolean |
isPubliclyAccessible()
A boolean value that, if
true , indicates that the cluster can be accessed from a public network. |
void |
setAllowVersionUpgrade(Boolean allowVersionUpgrade)
A boolean value that, if
true , indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window. |
void |
setAquaConfiguration(AquaConfiguration aquaConfiguration)
This field is retired.
|
void |
setAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
|
void |
setAvailabilityZone(String availabilityZone)
The name of the Availability Zone in which the cluster is located.
|
void |
setAvailabilityZoneRelocationStatus(String availabilityZoneRelocationStatus)
Describes the status of the Availability Zone relocation operation.
|
void |
setClusterAvailabilityStatus(String clusterAvailabilityStatus)
The availability status of the cluster for queries.
|
void |
setClusterCreateTime(Date clusterCreateTime)
The date and time that the cluster was created.
|
void |
setClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
|
void |
setClusterNamespaceArn(String clusterNamespaceArn)
The namespace Amazon Resource Name (ARN) of the cluster.
|
void |
setClusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
|
void |
setClusterParameterGroups(Collection<ClusterParameterGroupStatus> clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster.
|
void |
setClusterPublicKey(String clusterPublicKey)
The public key for the cluster.
|
void |
setClusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
|
void |
setClusterSecurityGroups(Collection<ClusterSecurityGroupMembership> clusterSecurityGroups)
A list of cluster security group that are associated with the cluster.
|
void |
setClusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)
A value that returns the destination region and retention period that are configured for cross-region snapshot
copy.
|
void |
setClusterStatus(String clusterStatus)
The current state of the cluster.
|
void |
setClusterSubnetGroupName(String clusterSubnetGroupName)
The name of the subnet group that is associated with the cluster.
|
void |
setClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
|
void |
setCustomDomainCertificateArn(String customDomainCertificateArn)
The certificate Amazon Resource Name (ARN) for the custom domain name.
|
void |
setCustomDomainCertificateExpiryDate(Date customDomainCertificateExpiryDate)
The expiration date for the certificate associated with the custom domain name.
|
void |
setCustomDomainName(String customDomainName)
The custom domain name associated with the cluster.
|
void |
setDataTransferProgress(DataTransferProgress dataTransferProgress)
|
void |
setDBName(String dBName)
The name of the initial database that was created when the cluster was created.
|
void |
setDefaultIamRoleArn(String defaultIamRoleArn)
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
|
void |
setDeferredMaintenanceWindows(Collection<DeferredMaintenanceWindow> deferredMaintenanceWindows)
Describes a group of
DeferredMaintenanceWindow objects. |
void |
setElasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
|
void |
setElasticResizeNumberOfNodeOptions(String elasticResizeNumberOfNodeOptions)
The number of nodes that you can resize the cluster to with the elastic resize method.
|
void |
setEncrypted(Boolean encrypted)
A boolean value that, if
true , indicates that data in the cluster is encrypted at rest. |
void |
setEndpoint(Endpoint endpoint)
The connection endpoint.
|
void |
setEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
void |
setExpectedNextSnapshotScheduleTime(Date expectedNextSnapshotScheduleTime)
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and
backups enabled.
|
void |
setExpectedNextSnapshotScheduleTimeStatus(String expectedNextSnapshotScheduleTimeStatus)
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled.
|
void |
setHsmStatus(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.
|
void |
setIamRoles(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.
|
void |
setIpAddressType(String ipAddressType)
The IP address type for the cluster.
|
void |
setKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
|
void |
setMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the cluster.
|
void |
setManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default number of days to retain a manual snapshot.
|
void |
setMasterPasswordSecretArn(String masterPasswordSecretArn)
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
|
void |
setMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
void |
setMasterUsername(String masterUsername)
The admin user name for the cluster.
|
void |
setModifyStatus(String modifyStatus)
The status of a modify operation, if any, initiated for the cluster.
|
void |
setMultiAZ(String multiAZ)
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
|
void |
setMultiAZSecondary(SecondaryClusterInfo multiAZSecondary)
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
|
void |
setNextMaintenanceWindowStartTime(Date nextMaintenanceWindowStartTime)
The date and time in UTC when system maintenance can begin.
|
void |
setNodeType(String nodeType)
The node type for the nodes in the cluster.
|
void |
setNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
|
void |
setPendingActions(Collection<String> pendingActions)
Cluster operations that are waiting to be started.
|
void |
setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A value that, if present, indicates that changes to the cluster are pending.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
A boolean value that, if
true , indicates that the cluster can be accessed from a public network. |
void |
setReservedNodeExchangeStatus(ReservedNodeExchangeStatus reservedNodeExchangeStatus)
The status of the reserved-node exchange request.
|
void |
setResizeInfo(ResizeInfo resizeInfo)
Returns the following:
|
void |
setRestoreStatus(RestoreStatus restoreStatus)
A value that describes the status of a cluster restore action.
|
void |
setSnapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the cluster snapshot schedule.
|
void |
setSnapshotScheduleState(String snapshotScheduleState)
The current state of the cluster snapshot schedule.
|
void |
setTags(Collection<Tag> tags)
The list of tags for the cluster.
|
void |
setTotalStorageCapacityInMegaBytes(Long totalStorageCapacityInMegaBytes)
The total storage capacity of the cluster in megabytes.
|
void |
setVpcId(String vpcId)
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
|
void |
setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
String |
toString()
Returns a string representation of this object.
|
Cluster |
withAllowVersionUpgrade(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 |
withAquaConfiguration(AquaConfiguration aquaConfiguration)
This field is retired.
|
Cluster |
withAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
|
Cluster |
withAvailabilityZone(String availabilityZone)
The name of the Availability Zone in which the cluster is located.
|
Cluster |
withAvailabilityZoneRelocationStatus(String availabilityZoneRelocationStatus)
Describes the status of the Availability Zone relocation operation.
|
Cluster |
withClusterAvailabilityStatus(String clusterAvailabilityStatus)
The availability status of the cluster for queries.
|
Cluster |
withClusterCreateTime(Date clusterCreateTime)
The date and time that the cluster was created.
|
Cluster |
withClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
|
Cluster |
withClusterNamespaceArn(String clusterNamespaceArn)
The namespace Amazon Resource Name (ARN) of the cluster.
|
Cluster |
withClusterNodes(ClusterNode... clusterNodes)
The nodes in the cluster.
|
Cluster |
withClusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
|
Cluster |
withClusterParameterGroups(ClusterParameterGroupStatus... clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster.
|
Cluster |
withClusterParameterGroups(Collection<ClusterParameterGroupStatus> clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster.
|
Cluster |
withClusterPublicKey(String clusterPublicKey)
The public key for the cluster.
|
Cluster |
withClusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
|
Cluster |
withClusterSecurityGroups(ClusterSecurityGroupMembership... clusterSecurityGroups)
A list of cluster security group that are associated with the cluster.
|
Cluster |
withClusterSecurityGroups(Collection<ClusterSecurityGroupMembership> clusterSecurityGroups)
A list of cluster security group that are associated with the cluster.
|
Cluster |
withClusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)
A value that returns the destination region and retention period that are configured for cross-region snapshot
copy.
|
Cluster |
withClusterStatus(String clusterStatus)
The current state of the cluster.
|
Cluster |
withClusterSubnetGroupName(String clusterSubnetGroupName)
The name of the subnet group that is associated with the cluster.
|
Cluster |
withClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
|
Cluster |
withCustomDomainCertificateArn(String customDomainCertificateArn)
The certificate Amazon Resource Name (ARN) for the custom domain name.
|
Cluster |
withCustomDomainCertificateExpiryDate(Date customDomainCertificateExpiryDate)
The expiration date for the certificate associated with the custom domain name.
|
Cluster |
withCustomDomainName(String customDomainName)
The custom domain name associated with the cluster.
|
Cluster |
withDataTransferProgress(DataTransferProgress dataTransferProgress)
|
Cluster |
withDBName(String dBName)
The name of the initial database that was created when the cluster was created.
|
Cluster |
withDefaultIamRoleArn(String defaultIamRoleArn)
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
|
Cluster |
withDeferredMaintenanceWindows(Collection<DeferredMaintenanceWindow> deferredMaintenanceWindows)
Describes a group of
DeferredMaintenanceWindow objects. |
Cluster |
withDeferredMaintenanceWindows(DeferredMaintenanceWindow... deferredMaintenanceWindows)
Describes a group of
DeferredMaintenanceWindow objects. |
Cluster |
withElasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
|
Cluster |
withElasticResizeNumberOfNodeOptions(String elasticResizeNumberOfNodeOptions)
The number of nodes that you can resize the cluster to with the elastic resize method.
|
Cluster |
withEncrypted(Boolean encrypted)
A boolean value that, if
true , indicates that data in the cluster is encrypted at rest. |
Cluster |
withEndpoint(Endpoint endpoint)
The connection endpoint.
|
Cluster |
withEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Cluster |
withExpectedNextSnapshotScheduleTime(Date 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 |
withExpectedNextSnapshotScheduleTimeStatus(String expectedNextSnapshotScheduleTimeStatus)
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled.
|
Cluster |
withHsmStatus(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 |
withIamRoles(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 |
withIamRoles(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 |
withIpAddressType(String ipAddressType)
The IP address type for the cluster.
|
Cluster |
withKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
|
Cluster |
withMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the cluster.
|
Cluster |
withManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default number of days to retain a manual snapshot.
|
Cluster |
withMasterPasswordSecretArn(String masterPasswordSecretArn)
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
|
Cluster |
withMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
Cluster |
withMasterUsername(String masterUsername)
The admin user name for the cluster.
|
Cluster |
withModifyStatus(String modifyStatus)
The status of a modify operation, if any, initiated for the cluster.
|
Cluster |
withMultiAZ(String multiAZ)
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
|
Cluster |
withMultiAZSecondary(SecondaryClusterInfo multiAZSecondary)
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
|
Cluster |
withNextMaintenanceWindowStartTime(Date nextMaintenanceWindowStartTime)
The date and time in UTC when system maintenance can begin.
|
Cluster |
withNodeType(String nodeType)
The node type for the nodes in the cluster.
|
Cluster |
withNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
|
Cluster |
withPendingActions(Collection<String> pendingActions)
Cluster operations that are waiting to be started.
|
Cluster |
withPendingActions(String... pendingActions)
Cluster operations that are waiting to be started.
|
Cluster |
withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A value that, if present, indicates that changes to the cluster are pending.
|
Cluster |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
|
Cluster |
withPubliclyAccessible(Boolean publiclyAccessible)
A boolean value that, if
true , indicates that the cluster can be accessed from a public network. |
Cluster |
withReservedNodeExchangeStatus(ReservedNodeExchangeStatus reservedNodeExchangeStatus)
The status of the reserved-node exchange request.
|
Cluster |
withResizeInfo(ResizeInfo resizeInfo)
Returns the following:
|
Cluster |
withRestoreStatus(RestoreStatus restoreStatus)
A value that describes the status of a cluster restore action.
|
Cluster |
withSnapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the cluster snapshot schedule.
|
Cluster |
withSnapshotScheduleState(ScheduleState snapshotScheduleState)
The current state of the cluster snapshot schedule.
|
Cluster |
withSnapshotScheduleState(String snapshotScheduleState)
The current state of the cluster snapshot schedule.
|
Cluster |
withTags(Collection<Tag> tags)
The list of tags for the cluster.
|
Cluster |
withTags(Tag... tags)
The list of tags for the cluster.
|
Cluster |
withTotalStorageCapacityInMegaBytes(Long totalStorageCapacityInMegaBytes)
The total storage capacity of the cluster in megabytes.
|
Cluster |
withVpcId(String vpcId)
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
|
Cluster |
withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
Cluster |
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
public void setClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
clusterIdentifier
- The unique identifier of the cluster.public String getClusterIdentifier()
The unique identifier of the cluster.
public Cluster withClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
clusterIdentifier
- The unique identifier of the cluster.public void setNodeType(String nodeType)
The node type for the nodes in the cluster.
nodeType
- The node type for the nodes in the cluster.public String getNodeType()
The node type for the nodes in the cluster.
public Cluster withNodeType(String nodeType)
The node type for the nodes in the cluster.
nodeType
- The node type for the nodes in the cluster.public void setClusterStatus(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
public String getClusterStatus()
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
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
public Cluster withClusterStatus(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
public void setClusterAvailabilityStatus(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.
public String getClusterAvailabilityStatus()
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.
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.
public Cluster withClusterAvailabilityStatus(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.
public void setModifyStatus(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.public String getModifyStatus()
The status of a modify operation, if any, initiated for the cluster.
public Cluster withModifyStatus(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.public void setMasterUsername(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.public String getMasterUsername()
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
public Cluster withMasterUsername(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.public void setDBName(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 dev
dev 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 dev
dev was created by default.public String getDBName()
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 dev
dev was
created by default.
dev
dev was created by default.public Cluster withDBName(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 dev
dev 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 dev
dev was created by default.public void setEndpoint(Endpoint endpoint)
The connection endpoint.
endpoint
- The connection endpoint.public Endpoint getEndpoint()
The connection endpoint.
public Cluster withEndpoint(Endpoint endpoint)
The connection endpoint.
endpoint
- The connection endpoint.public void setClusterCreateTime(Date clusterCreateTime)
The date and time that the cluster was created.
clusterCreateTime
- The date and time that the cluster was created.public Date getClusterCreateTime()
The date and time that the cluster was created.
public Cluster withClusterCreateTime(Date clusterCreateTime)
The date and time that the cluster was created.
clusterCreateTime
- The date and time that the cluster was created.public void setAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
automatedSnapshotRetentionPeriod
- The number of days that automatic cluster snapshots are retained.public Integer getAutomatedSnapshotRetentionPeriod()
The number of days that automatic cluster snapshots are retained.
public Cluster withAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
automatedSnapshotRetentionPeriod
- The number of days that automatic cluster snapshots are retained.public void setManualSnapshotRetentionPeriod(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.
public Integer getManualSnapshotRetentionPeriod()
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.
The value must be either -1 or an integer between 1 and 3,653.
public Cluster withManualSnapshotRetentionPeriod(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.
public List<ClusterSecurityGroupMembership> getClusterSecurityGroups()
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.
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.
public void setClusterSecurityGroups(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.
public Cluster withClusterSecurityGroups(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.
NOTE: This method appends the values to the existing list (if any). Use
setClusterSecurityGroups(java.util.Collection)
or
withClusterSecurityGroups(java.util.Collection)
if you want to override the existing values.
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.
public Cluster withClusterSecurityGroups(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.
public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
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.
public void setVpcSecurityGroups(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.public Cluster withVpcSecurityGroups(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.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroups(java.util.Collection)
or withVpcSecurityGroups(java.util.Collection)
if
you want to override the existing values.
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.public Cluster withVpcSecurityGroups(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.public List<ClusterParameterGroupStatus> getClusterParameterGroups()
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
public void setClusterParameterGroups(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.public Cluster withClusterParameterGroups(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.
NOTE: This method appends the values to the existing list (if any). Use
setClusterParameterGroups(java.util.Collection)
or
withClusterParameterGroups(java.util.Collection)
if you want to override the existing values.
clusterParameterGroups
- The list of cluster parameter groups that are associated with this cluster. Each parameter group in the
list is returned with its status.public Cluster withClusterParameterGroups(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.public void setClusterSubnetGroupName(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.public String getClusterSubnetGroupName()
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
public Cluster withClusterSubnetGroupName(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.public void setVpcId(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.public String getVpcId()
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
public Cluster withVpcId(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.public void setAvailabilityZone(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.public String getAvailabilityZone()
The name of the Availability Zone in which the cluster is located.
public Cluster withAvailabilityZone(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.public void setPreferredMaintenanceWindow(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.public String getPreferredMaintenanceWindow()
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
public Cluster withPreferredMaintenanceWindow(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.public void setPendingModifiedValues(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.public PendingModifiedValues getPendingModifiedValues()
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
public Cluster withPendingModifiedValues(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.public void setClusterVersion(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.public String getClusterVersion()
The version ID of the Amazon Redshift engine that is running on the cluster.
public Cluster withClusterVersion(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.public void setAllowVersionUpgrade(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.public Boolean getAllowVersionUpgrade()
A boolean value that, if true
, indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window.
true
, indicates that major version upgrades will be applied
automatically to the cluster during the maintenance window.public Cluster withAllowVersionUpgrade(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.public Boolean isAllowVersionUpgrade()
A boolean value that, if true
, indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window.
true
, indicates that major version upgrades will be applied
automatically to the cluster during the maintenance window.public void setNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
numberOfNodes
- The number of compute nodes in the cluster.public Integer getNumberOfNodes()
The number of compute nodes in the cluster.
public Cluster withNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
numberOfNodes
- The number of compute nodes in the cluster.public void setPubliclyAccessible(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.public Boolean getPubliclyAccessible()
A boolean value that, if true
, indicates that the cluster can be accessed from a public network.
true
, indicates that the cluster can be accessed from a public
network.public Cluster withPubliclyAccessible(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.public Boolean isPubliclyAccessible()
A boolean value that, if true
, indicates that the cluster can be accessed from a public network.
true
, indicates that the cluster can be accessed from a public
network.public void setEncrypted(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.public Boolean getEncrypted()
A boolean value that, if true
, indicates that data in the cluster is encrypted at rest.
true
, indicates that data in the cluster is encrypted at rest.public Cluster withEncrypted(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.public Boolean isEncrypted()
A boolean value that, if true
, indicates that data in the cluster is encrypted at rest.
true
, indicates that data in the cluster is encrypted at rest.public void setRestoreStatus(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.public RestoreStatus getRestoreStatus()
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.
public Cluster withRestoreStatus(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.public void setDataTransferProgress(DataTransferProgress dataTransferProgress)
dataTransferProgress
- public DataTransferProgress getDataTransferProgress()
public Cluster withDataTransferProgress(DataTransferProgress dataTransferProgress)
dataTransferProgress
- public void setHsmStatus(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
public HsmStatus getHsmStatus()
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
Values: active, applying
public Cluster withHsmStatus(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
public void setClusterSnapshotCopyStatus(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.public ClusterSnapshotCopyStatus getClusterSnapshotCopyStatus()
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
public Cluster withClusterSnapshotCopyStatus(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.public void setClusterPublicKey(String clusterPublicKey)
The public key for the cluster.
clusterPublicKey
- The public key for the cluster.public String getClusterPublicKey()
The public key for the cluster.
public Cluster withClusterPublicKey(String clusterPublicKey)
The public key for the cluster.
clusterPublicKey
- The public key for the cluster.public List<ClusterNode> getClusterNodes()
The nodes in the cluster.
public void setClusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
clusterNodes
- The nodes in the cluster.public Cluster withClusterNodes(ClusterNode... clusterNodes)
The nodes in the cluster.
NOTE: This method appends the values to the existing list (if any). Use
setClusterNodes(java.util.Collection)
or withClusterNodes(java.util.Collection)
if you want to
override the existing values.
clusterNodes
- The nodes in the cluster.public Cluster withClusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
clusterNodes
- The nodes in the cluster.public void setElasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
elasticIpStatus
- The status of the elastic IP (EIP) address.public ElasticIpStatus getElasticIpStatus()
The status of the elastic IP (EIP) address.
public Cluster withElasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
elasticIpStatus
- The status of the elastic IP (EIP) address.public void setClusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
clusterRevisionNumber
- The specific revision number of the database in the cluster.public String getClusterRevisionNumber()
The specific revision number of the database in the cluster.
public Cluster withClusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
clusterRevisionNumber
- The specific revision number of the database in the cluster.public List<Tag> getTags()
The list of tags for the cluster.
public void setTags(Collection<Tag> tags)
The list of tags for the cluster.
tags
- The list of tags for the cluster.public Cluster withTags(Tag... tags)
The list of tags for the cluster.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The list of tags for the cluster.public Cluster withTags(Collection<Tag> tags)
The list of tags for the cluster.
tags
- The list of tags for the cluster.public void setKmsKeyId(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.public String getKmsKeyId()
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
public Cluster withKmsKeyId(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.public void setEnhancedVpcRouting(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
public Boolean getEnhancedVpcRouting()
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
If this option is true
, enhanced VPC routing is enabled.
Default: false
public Cluster withEnhancedVpcRouting(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
public Boolean isEnhancedVpcRouting()
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
If this option is true
, enhanced VPC routing is enabled.
Default: false
public List<ClusterIamRole> getIamRoles()
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
public void setIamRoles(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.public Cluster withIamRoles(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.
NOTE: This method appends the values to the existing list (if any). Use
setIamRoles(java.util.Collection)
or withIamRoles(java.util.Collection)
if you want to override
the existing values.
iamRoles
- A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other
Amazon Web Services services.public Cluster withIamRoles(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.public List<String> getPendingActions()
Cluster operations that are waiting to be started.
public void setPendingActions(Collection<String> pendingActions)
Cluster operations that are waiting to be started.
pendingActions
- Cluster operations that are waiting to be started.public Cluster withPendingActions(String... pendingActions)
Cluster operations that are waiting to be started.
NOTE: This method appends the values to the existing list (if any). Use
setPendingActions(java.util.Collection)
or withPendingActions(java.util.Collection)
if you want
to override the existing values.
pendingActions
- Cluster operations that are waiting to be started.public Cluster withPendingActions(Collection<String> pendingActions)
Cluster operations that are waiting to be started.
pendingActions
- Cluster operations that are waiting to be started.public void setMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the cluster.
maintenanceTrackName
- The name of the maintenance track for the cluster.public String getMaintenanceTrackName()
The name of the maintenance track for the cluster.
public Cluster withMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the cluster.
maintenanceTrackName
- The name of the maintenance track for the cluster.public void setElasticResizeNumberOfNodeOptions(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.public String getElasticResizeNumberOfNodeOptions()
The number of nodes that you can resize the cluster to with the elastic resize method.
public Cluster withElasticResizeNumberOfNodeOptions(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.public List<DeferredMaintenanceWindow> getDeferredMaintenanceWindows()
Describes a group of DeferredMaintenanceWindow
objects.
DeferredMaintenanceWindow
objects.public void setDeferredMaintenanceWindows(Collection<DeferredMaintenanceWindow> deferredMaintenanceWindows)
Describes a group of DeferredMaintenanceWindow
objects.
deferredMaintenanceWindows
- Describes a group of DeferredMaintenanceWindow
objects.public Cluster withDeferredMaintenanceWindows(DeferredMaintenanceWindow... deferredMaintenanceWindows)
Describes a group of DeferredMaintenanceWindow
objects.
NOTE: This method appends the values to the existing list (if any). Use
setDeferredMaintenanceWindows(java.util.Collection)
or
withDeferredMaintenanceWindows(java.util.Collection)
if you want to override the existing values.
deferredMaintenanceWindows
- Describes a group of DeferredMaintenanceWindow
objects.public Cluster withDeferredMaintenanceWindows(Collection<DeferredMaintenanceWindow> deferredMaintenanceWindows)
Describes a group of DeferredMaintenanceWindow
objects.
deferredMaintenanceWindows
- Describes a group of DeferredMaintenanceWindow
objects.public void setSnapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the cluster snapshot schedule.
snapshotScheduleIdentifier
- A unique identifier for the cluster snapshot schedule.public String getSnapshotScheduleIdentifier()
A unique identifier for the cluster snapshot schedule.
public Cluster withSnapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the cluster snapshot schedule.
snapshotScheduleIdentifier
- A unique identifier for the cluster snapshot schedule.public void setSnapshotScheduleState(String snapshotScheduleState)
The current state of the cluster snapshot schedule.
snapshotScheduleState
- The current state of the cluster snapshot schedule.ScheduleState
public String getSnapshotScheduleState()
The current state of the cluster snapshot schedule.
ScheduleState
public Cluster withSnapshotScheduleState(String snapshotScheduleState)
The current state of the cluster snapshot schedule.
snapshotScheduleState
- The current state of the cluster snapshot schedule.ScheduleState
public Cluster withSnapshotScheduleState(ScheduleState snapshotScheduleState)
The current state of the cluster snapshot schedule.
snapshotScheduleState
- The current state of the cluster snapshot schedule.ScheduleState
public void setExpectedNextSnapshotScheduleTime(Date 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.public Date getExpectedNextSnapshotScheduleTime()
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
public Cluster withExpectedNextSnapshotScheduleTime(Date 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.public void setExpectedNextSnapshotScheduleTimeStatus(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.
public String getExpectedNextSnapshotScheduleTimeStatus()
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.
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
public Cluster withExpectedNextSnapshotScheduleTimeStatus(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.
public void setNextMaintenanceWindowStartTime(Date nextMaintenanceWindowStartTime)
The date and time in UTC when system maintenance can begin.
nextMaintenanceWindowStartTime
- The date and time in UTC when system maintenance can begin.public Date getNextMaintenanceWindowStartTime()
The date and time in UTC when system maintenance can begin.
public Cluster withNextMaintenanceWindowStartTime(Date nextMaintenanceWindowStartTime)
The date and time in UTC when system maintenance can begin.
nextMaintenanceWindowStartTime
- The date and time in UTC when system maintenance can begin.public void setResizeInfo(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
public ResizeInfo getResizeInfo()
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
public Cluster withResizeInfo(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
public void setAvailabilityZoneRelocationStatus(String availabilityZoneRelocationStatus)
Describes the status of the Availability Zone relocation operation.
availabilityZoneRelocationStatus
- Describes the status of the Availability Zone relocation operation.public String getAvailabilityZoneRelocationStatus()
Describes the status of the Availability Zone relocation operation.
public Cluster withAvailabilityZoneRelocationStatus(String availabilityZoneRelocationStatus)
Describes the status of the Availability Zone relocation operation.
availabilityZoneRelocationStatus
- Describes the status of the Availability Zone relocation operation.public void setClusterNamespaceArn(String clusterNamespaceArn)
The namespace Amazon Resource Name (ARN) of the cluster.
clusterNamespaceArn
- The namespace Amazon Resource Name (ARN) of the cluster.public String getClusterNamespaceArn()
The namespace Amazon Resource Name (ARN) of the cluster.
public Cluster withClusterNamespaceArn(String clusterNamespaceArn)
The namespace Amazon Resource Name (ARN) of the cluster.
clusterNamespaceArn
- The namespace Amazon Resource Name (ARN) of the cluster.public void setTotalStorageCapacityInMegaBytes(Long totalStorageCapacityInMegaBytes)
The total storage capacity of the cluster in megabytes.
totalStorageCapacityInMegaBytes
- The total storage capacity of the cluster in megabytes.public Long getTotalStorageCapacityInMegaBytes()
The total storage capacity of the cluster in megabytes.
public Cluster withTotalStorageCapacityInMegaBytes(Long totalStorageCapacityInMegaBytes)
The total storage capacity of the cluster in megabytes.
totalStorageCapacityInMegaBytes
- The total storage capacity of the cluster in megabytes.public void setAquaConfiguration(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).public AquaConfiguration getAquaConfiguration()
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
public Cluster withAquaConfiguration(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).public void setDefaultIamRoleArn(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.public String getDefaultIamRoleArn()
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
public Cluster withDefaultIamRoleArn(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.public void setReservedNodeExchangeStatus(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.public ReservedNodeExchangeStatus getReservedNodeExchangeStatus()
The status of the reserved-node exchange request. Statuses include in-progress and requested.
public Cluster withReservedNodeExchangeStatus(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.public void setCustomDomainName(String customDomainName)
The custom domain name associated with the cluster.
customDomainName
- The custom domain name associated with the cluster.public String getCustomDomainName()
The custom domain name associated with the cluster.
public Cluster withCustomDomainName(String customDomainName)
The custom domain name associated with the cluster.
customDomainName
- The custom domain name associated with the cluster.public void setCustomDomainCertificateArn(String customDomainCertificateArn)
The certificate Amazon Resource Name (ARN) for the custom domain name.
customDomainCertificateArn
- The certificate Amazon Resource Name (ARN) for the custom domain name.public String getCustomDomainCertificateArn()
The certificate Amazon Resource Name (ARN) for the custom domain name.
public Cluster withCustomDomainCertificateArn(String customDomainCertificateArn)
The certificate Amazon Resource Name (ARN) for the custom domain name.
customDomainCertificateArn
- The certificate Amazon Resource Name (ARN) for the custom domain name.public void setCustomDomainCertificateExpiryDate(Date customDomainCertificateExpiryDate)
The expiration date for the certificate associated with the custom domain name.
customDomainCertificateExpiryDate
- The expiration date for the certificate associated with the custom domain name.public Date getCustomDomainCertificateExpiryDate()
The expiration date for the certificate associated with the custom domain name.
public Cluster withCustomDomainCertificateExpiryDate(Date customDomainCertificateExpiryDate)
The expiration date for the certificate associated with the custom domain name.
customDomainCertificateExpiryDate
- The expiration date for the certificate associated with the custom domain name.public void setMasterPasswordSecretArn(String masterPasswordSecretArn)
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
masterPasswordSecretArn
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.public String getMasterPasswordSecretArn()
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
public Cluster withMasterPasswordSecretArn(String masterPasswordSecretArn)
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
masterPasswordSecretArn
- The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.public void setMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
masterPasswordSecretKmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials
secret.public String getMasterPasswordSecretKmsKeyId()
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
public Cluster withMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
masterPasswordSecretKmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials
secret.public void setIpAddressType(String ipAddressType)
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
ipAddressType
- The IP address type for the cluster. Possible values are ipv4
and dualstack
.public String getIpAddressType()
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
ipv4
and dualstack
.public Cluster withIpAddressType(String ipAddressType)
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
ipAddressType
- The IP address type for the cluster. Possible values are ipv4
and dualstack
.public void setMultiAZ(String multiAZ)
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
multiAZ
- A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.public String getMultiAZ()
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
public Cluster withMultiAZ(String multiAZ)
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
multiAZ
- A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.public void setMultiAZSecondary(SecondaryClusterInfo multiAZSecondary)
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
multiAZSecondary
- The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.public SecondaryClusterInfo getMultiAZSecondary()
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
public Cluster withMultiAZSecondary(SecondaryClusterInfo multiAZSecondary)
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
multiAZSecondary
- The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.public String toString()
toString
in class Object
Object.toString()