Interface RestoreFromClusterSnapshotRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<RestoreFromClusterSnapshotRequest.Builder,
,RestoreFromClusterSnapshotRequest> RedshiftRequest.Builder
,SdkBuilder<RestoreFromClusterSnapshotRequest.Builder,
,RestoreFromClusterSnapshotRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
RestoreFromClusterSnapshotRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalInfo
(String additionalInfo) Reserved.allowVersionUpgrade
(Boolean allowVersionUpgrade) Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.aquaConfigurationStatus
(String aquaConfigurationStatus) This parameter is retired.aquaConfigurationStatus
(AquaConfigurationStatus aquaConfigurationStatus) This parameter is retired.automatedSnapshotRetentionPeriod
(Integer automatedSnapshotRetentionPeriod) The number of days that automated snapshots are retained.availabilityZone
(String availabilityZone) The Amazon EC2 Availability Zone in which to restore the cluster.availabilityZoneRelocation
(Boolean availabilityZoneRelocation) The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.clusterIdentifier
(String clusterIdentifier) The identifier of the cluster that will be created from restoring the snapshot.clusterParameterGroupName
(String clusterParameterGroupName) The name of the parameter group to be associated with this cluster.clusterSecurityGroups
(String... clusterSecurityGroups) A list of security groups to be associated with this cluster.clusterSecurityGroups
(Collection<String> clusterSecurityGroups) A list of security groups to be associated with this cluster.clusterSubnetGroupName
(String clusterSubnetGroupName) The name of the subnet group where you want to cluster restored.defaultIamRoleArn
(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.The Elastic IP (EIP) address for the cluster.Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.enhancedVpcRouting
(Boolean enhancedVpcRouting) An option that specifies whether to create the cluster with enhanced VPC routing enabled.hsmClientCertificateIdentifier
(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.hsmConfigurationIdentifier
(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.A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.iamRoles
(Collection<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.ipAddressType
(String ipAddressType) The IP address type for the cluster.The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot.maintenanceTrackName
(String maintenanceTrackName) The name of the maintenance track for the restored cluster.manageMasterPassword
(Boolean manageMasterPassword) Iftrue
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials.manualSnapshotRetentionPeriod
(Integer manualSnapshotRetentionPeriod) The default number of days to retain a manual snapshot.masterPasswordSecretKmsKeyId
(String masterPasswordSecretKmsKeyId) The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.If true, the snapshot will be restored to a cluster deployed in two Availability Zones.The node type that the restored cluster will be provisioned with.numberOfNodes
(Integer numberOfNodes) The number of nodes specified when provisioning the restored cluster.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.ownerAccount
(String ownerAccount) The Amazon Web Services account used to create or copy the snapshot.The port number on which the cluster accepts connections.preferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range (in UTC) during which automated cluster maintenance can occur.publiclyAccessible
(Boolean publiclyAccessible) Iftrue
, the cluster can be accessed from a public network.reservedNodeId
(String reservedNodeId) The identifier of the target reserved node offering.snapshotArn
(String snapshotArn) The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster.snapshotClusterIdentifier
(String snapshotClusterIdentifier) The name of the cluster the source snapshot was created from.snapshotIdentifier
(String snapshotIdentifier) The name of the snapshot from which to create the new cluster.snapshotScheduleIdentifier
(String snapshotScheduleIdentifier) A unique identifier for the snapshot schedule.targetReservedNodeOfferingId
(String targetReservedNodeOfferingId) The identifier of the target reserved node offering.vpcSecurityGroupIds
(String... vpcSecurityGroupIds) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.vpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.redshift.model.RedshiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
- Parameters:
snapshotIdentifier
- The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter orsnapshotArn
, but not both.Example:
my-snapshot-id
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
snapshotArn
- The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify this parameter orsnapshotIdentifier
, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotClusterIdentifier
RestoreFromClusterSnapshotRequest.Builder snapshotClusterIdentifier(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
port
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Valid values: For clusters with ds2 or dc2 nodes, must be within the range
1150
-65535
. For clusters with ra3 nodes, must be within the ranges5431
-5455
or8191
-8215
.- Parameters:
port
- The port number on which the cluster accepts connections.Default: The same port as the original cluster.
Valid values: For clusters with ds2 or dc2 nodes, must be within the range
1150
-65535
. For clusters with ra3 nodes, must be within the ranges5431
-5455
or8191
-8215
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZone
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example:
us-east-2a
- Parameters:
availabilityZone
- The Amazon EC2 Availability Zone in which to restore the cluster.Default: A random, system-chosen Availability Zone.
Example:
us-east-2a
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
allowVersionUpgrade
- Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.Default:
true
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publiclyAccessible
If
true
, the cluster can be accessed from a public network.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hsmClientCertificateIdentifier
RestoreFromClusterSnapshotRequest.Builder hsmClientCertificateIdentifier(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.
- Parameters:
hsmClientCertificateIdentifier
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hsmConfigurationIdentifier
RestoreFromClusterSnapshotRequest.Builder hsmConfigurationIdentifier(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterParameterGroupName
RestoreFromClusterSnapshotRequest.Builder clusterParameterGroupName(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
clusterSecurityGroups
RestoreFromClusterSnapshotRequest.Builder clusterSecurityGroups(Collection<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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
RestoreFromClusterSnapshotRequest.Builder vpcSecurityGroupIds(Collection<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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredMaintenanceWindow
RestoreFromClusterSnapshotRequest.Builder preferredMaintenanceWindow(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
automatedSnapshotRetentionPeriod
RestoreFromClusterSnapshotRequest.Builder automatedSnapshotRetentionPeriod(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
manualSnapshotRetentionPeriod
RestoreFromClusterSnapshotRequest.Builder manualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod) The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
- Parameters:
manualSnapshotRetentionPeriod
- The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.The value must be either -1 or an integer between 1 and 3,653.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalInfo
Reserved.
- Parameters:
additionalInfo
- Reserved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
maintenanceTrackName
- The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits theMaintenanceTrack
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotScheduleIdentifier
RestoreFromClusterSnapshotRequest.Builder snapshotScheduleIdentifier(String snapshotScheduleIdentifier) A unique identifier for the snapshot schedule.
- Parameters:
snapshotScheduleIdentifier
- A unique identifier for the snapshot schedule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numberOfNodes
The number of nodes specified when provisioning the restored cluster.
- Parameters:
numberOfNodes
- The number of nodes specified when provisioning the restored cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZoneRelocation
RestoreFromClusterSnapshotRequest.Builder availabilityZoneRelocation(Boolean availabilityZoneRelocation) The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
- Parameters:
availabilityZoneRelocation
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aquaConfigurationStatus
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
- Parameters:
aquaConfigurationStatus
- This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
aquaConfigurationStatus
RestoreFromClusterSnapshotRequest.Builder aquaConfigurationStatus(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).
- Parameters:
aquaConfigurationStatus
- This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reservedNodeId
The identifier of the target reserved node offering.
- Parameters:
reservedNodeId
- The identifier of the target reserved node offering.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetReservedNodeOfferingId
RestoreFromClusterSnapshotRequest.Builder targetReservedNodeOfferingId(String targetReservedNodeOfferingId) The identifier of the target reserved node offering.
- Parameters:
targetReservedNodeOfferingId
- The identifier of the target reserved node offering.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encrypted
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
- Parameters:
encrypted
- Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
manageMasterPassword
If
true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. IfManageMasterPassword
is false or not set, Amazon Redshift uses the admin credentials the cluster had at the time the snapshot was taken.- Parameters:
manageMasterPassword
- Iftrue
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. IfManageMasterPassword
is false or not set, Amazon Redshift uses the admin credentials the cluster had at the time the snapshot was taken.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
masterPasswordSecretKmsKeyId
RestoreFromClusterSnapshotRequest.Builder masterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId) The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if
ManageMasterPassword
is true.- Parameters:
masterPasswordSecretKmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter ifManageMasterPassword
is true.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipAddressType
The IP address type for the cluster. Possible values are
ipv4
anddualstack
.- Parameters:
ipAddressType
- The IP address type for the cluster. Possible values areipv4
anddualstack
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
multiAZ
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
- Parameters:
multiAZ
- If true, the snapshot will be restored to a cluster deployed in two Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
RestoreFromClusterSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
RestoreFromClusterSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-