@Generated(value="software.amazon.awssdk:codegen") public final class RestoreFromClusterSnapshotRequest extends RedshiftRequest implements ToCopyableBuilder<RestoreFromClusterSnapshotRequest.Builder,RestoreFromClusterSnapshotRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
RestoreFromClusterSnapshotRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
additionalInfo()
Reserved.
|
Boolean |
allowVersionUpgrade()
If
true, major version upgrades can be applied during the maintenance window to the Amazon Redshift
engine that is running on the cluster. |
AquaConfigurationStatus |
aquaConfigurationStatus()
This parameter is retired.
|
String |
aquaConfigurationStatusAsString()
This parameter is retired.
|
Integer |
automatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
String |
availabilityZone()
The Amazon EC2 Availability Zone in which to restore the cluster.
|
Boolean |
availabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is
restored.
|
static RestoreFromClusterSnapshotRequest.Builder |
builder() |
String |
clusterIdentifier()
The identifier of the cluster that will be created from restoring the snapshot.
|
String |
clusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
|
List<String> |
clusterSecurityGroups()
A list of security groups to be associated with this cluster.
|
String |
clusterSubnetGroupName()
The name of the subnet group where you want to cluster restored.
|
String |
defaultIamRoleArn()
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last
modified while it was restored from a snapshot.
|
String |
elasticIp()
The Elastic IP (EIP) address for the cluster.
|
Boolean |
encrypted()
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS)
and a customer managed key.
|
Boolean |
enhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasClusterSecurityGroups()
For responses, this returns true if the service returned a value for the ClusterSecurityGroups property.
|
int |
hashCode() |
boolean |
hasIamRoles()
For responses, this returns true if the service returned a value for the IamRoles property.
|
boolean |
hasVpcSecurityGroupIds()
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
|
String |
hsmClientCertificateIdentifier()
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption
keys stored in an HSM.
|
String |
hsmConfigurationIdentifier()
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to
retrieve and store keys in an HSM.
|
List<String> |
iamRoles()
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web
Services services.
|
String |
kmsKeyId()
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a
shared snapshot.
|
String |
maintenanceTrackName()
The name of the maintenance track for the restored cluster.
|
Integer |
manualSnapshotRetentionPeriod()
The default number of days to retain a manual snapshot.
|
String |
nodeType()
The node type that the restored cluster will be provisioned with.
|
Integer |
numberOfNodes()
The number of nodes specified when provisioning the restored cluster.
|
String |
ownerAccount()
The Amazon Web Services account used to create or copy the snapshot.
|
Integer |
port()
The port number on which the cluster accepts connections.
|
String |
preferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
Boolean |
publiclyAccessible()
If
true, the cluster can be accessed from a public network. |
String |
reservedNodeId()
The identifier of the target reserved node offering.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends RestoreFromClusterSnapshotRequest.Builder> |
serializableBuilderClass() |
String |
snapshotArn()
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster.
|
String |
snapshotClusterIdentifier()
The name of the cluster the source snapshot was created from.
|
String |
snapshotIdentifier()
The name of the snapshot from which to create the new cluster.
|
String |
snapshotScheduleIdentifier()
A unique identifier for the snapshot schedule.
|
String |
targetReservedNodeOfferingId()
The identifier of the target reserved node offering.
|
RestoreFromClusterSnapshotRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<String> |
vpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String clusterIdentifier()
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an Amazon Web Services account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an Amazon Web Services account.
public final String snapshotIdentifier()
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must
specify this parameter or snapshotArn, but not both.
Example: my-snapshot-id
snapshotArn, but not both.
Example: my-snapshot-id
public final String snapshotArn()
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must
specify this parameter or snapshotIdentifier, but not both.
snapshotIdentifier, but not both.public final String snapshotClusterIdentifier()
The name of the cluster the source snapshot was created from. This parameter is required if your IAM user or role has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
public final Integer port()
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between 1115 and 65535.
Default: The same port as the original cluster.
Constraints: Must be between 1115 and 65535.
public final String availabilityZone()
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
public final Boolean allowVersionUpgrade()
If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift
engine that is running on the cluster.
Default: true
true, major version upgrades can be applied during the maintenance window to the Amazon
Redshift engine that is running on the cluster.
Default: true
public final String clusterSubnetGroupName()
The name of the subnet group where you want to cluster restored.
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
public final Boolean publiclyAccessible()
If true, the cluster can be accessed from a public network.
true, the cluster can be accessed from a public network.public final String ownerAccount()
The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
public final String hsmClientCertificateIdentifier()
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
public final String hsmConfigurationIdentifier()
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
public final String elasticIp()
The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.
public final String clusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
public final boolean hasClusterSecurityGroups()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<String> clusterSecurityGroups()
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasClusterSecurityGroups() method.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
public final boolean hasVpcSecurityGroupIds()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> vpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
public final String preferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
public final Integer automatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
public final 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.
The value must be either -1 or an integer between 1 and 3,653.
public final String kmsKeyId()
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.
public final String nodeType()
The node type that the restored cluster will be provisioned with.
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
public final 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
If this option is true, enhanced VPC routing is enabled.
Default: false
public final String additionalInfo()
Reserved.
public final boolean hasIamRoles()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> iamRoles()
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasIamRoles() method.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
public final String maintenanceTrackName()
The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the
MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster
that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the
current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source
cluster are on different tracks.
MaintenanceTrack value from the cluster. The snapshot might be on a different
track than the cluster that was the source for the snapshot. For example, suppose that you take a
snapshot of a cluster that is on the current track and then change the cluster to be on the trailing
track. In this case, the snapshot and the source cluster are on different tracks.public final String snapshotScheduleIdentifier()
A unique identifier for the snapshot schedule.
public final Integer numberOfNodes()
The number of nodes specified when provisioning the restored cluster.
public final Boolean availabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
public final AquaConfigurationStatus aquaConfigurationStatus()
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
If the service returns an enum value that is not available in the current SDK version,
aquaConfigurationStatus will return AquaConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from aquaConfigurationStatusAsString().
AquaConfigurationStatuspublic final String aquaConfigurationStatusAsString()
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
If the service returns an enum value that is not available in the current SDK version,
aquaConfigurationStatus will return AquaConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from aquaConfigurationStatusAsString().
AquaConfigurationStatuspublic final String defaultIamRoleArn()
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
public final String reservedNodeId()
The identifier of the target reserved node offering.
public final String targetReservedNodeOfferingId()
The identifier of the target reserved node offering.
public final Boolean encrypted()
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
public RestoreFromClusterSnapshotRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<RestoreFromClusterSnapshotRequest.Builder,RestoreFromClusterSnapshotRequest>toBuilder in class RedshiftRequestpublic static RestoreFromClusterSnapshotRequest.Builder builder()
public static Class<? extends RestoreFromClusterSnapshotRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.