@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. |
Integer |
automatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
String |
availabilityZone()
The Amazon EC2 Availability Zone in which to restore the cluster.
|
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 |
elasticIp()
The elastic IP (EIP) address for the cluster.
|
Boolean |
enhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS
services.
|
String |
kmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the
cluster that you restore from a shared snapshot.
|
String |
nodeType()
The node type that the restored cluster will be provisioned with.
|
String |
ownerAccount()
The AWS customer 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. |
static Class<? extends RestoreFromClusterSnapshotRequest.Builder> |
serializableBuilderClass() |
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.
|
RestoreFromClusterSnapshotRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<String> |
vpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
overrideConfiguration
copy
public 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 AWS 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 AWS account.
public String snapshotIdentifier()
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
Example: my-snapshot-id
public String snapshotClusterIdentifier()
The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
public 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 String availabilityZone()
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
public 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 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 Boolean publiclyAccessible()
If true
, the cluster can be accessed from a public network.
true
, the cluster can be accessed from a public network.public String ownerAccount()
The AWS customer 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 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 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 String elasticIp()
The elastic IP (EIP) address for the cluster.
public 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 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.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
public 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.
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
public 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 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.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
public String kmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
public 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 ds2.xlarge into ds1.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. 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 ds2.xlarge into ds1.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. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide
public 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 String additionalInfo()
Reserved.
public List<String> iamRoles()
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated at any time.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
A cluster can have up to 10 IAM roles associated at any time.
public RestoreFromClusterSnapshotRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RestoreFromClusterSnapshotRequest.Builder,RestoreFromClusterSnapshotRequest>
toBuilder
in class RedshiftRequest
public static RestoreFromClusterSnapshotRequest.Builder builder()
public static Class<? extends RestoreFromClusterSnapshotRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.