AWS SDK for C++  1.9.14
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::Redshift::Model::RestoreFromClusterSnapshotRequest Class Reference

#include <RestoreFromClusterSnapshotRequest.h>

+ Inheritance diagram for Aws::Redshift::Model::RestoreFromClusterSnapshotRequest:

Public Member Functions

 RestoreFromClusterSnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
RestoreFromClusterSnapshotRequestWithClusterIdentifier (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithClusterIdentifier (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithClusterIdentifier (const char *value)
 
const Aws::StringGetSnapshotIdentifier () const
 
bool SnapshotIdentifierHasBeenSet () const
 
void SetSnapshotIdentifier (const Aws::String &value)
 
void SetSnapshotIdentifier (Aws::String &&value)
 
void SetSnapshotIdentifier (const char *value)
 
RestoreFromClusterSnapshotRequestWithSnapshotIdentifier (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithSnapshotIdentifier (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithSnapshotIdentifier (const char *value)
 
const Aws::StringGetSnapshotClusterIdentifier () const
 
bool SnapshotClusterIdentifierHasBeenSet () const
 
void SetSnapshotClusterIdentifier (const Aws::String &value)
 
void SetSnapshotClusterIdentifier (Aws::String &&value)
 
void SetSnapshotClusterIdentifier (const char *value)
 
RestoreFromClusterSnapshotRequestWithSnapshotClusterIdentifier (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithSnapshotClusterIdentifier (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithSnapshotClusterIdentifier (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
RestoreFromClusterSnapshotRequestWithPort (int value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
RestoreFromClusterSnapshotRequestWithAvailabilityZone (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithAvailabilityZone (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithAvailabilityZone (const char *value)
 
bool GetAllowVersionUpgrade () const
 
bool AllowVersionUpgradeHasBeenSet () const
 
void SetAllowVersionUpgrade (bool value)
 
RestoreFromClusterSnapshotRequestWithAllowVersionUpgrade (bool value)
 
const Aws::StringGetClusterSubnetGroupName () const
 
bool ClusterSubnetGroupNameHasBeenSet () const
 
void SetClusterSubnetGroupName (const Aws::String &value)
 
void SetClusterSubnetGroupName (Aws::String &&value)
 
void SetClusterSubnetGroupName (const char *value)
 
RestoreFromClusterSnapshotRequestWithClusterSubnetGroupName (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithClusterSubnetGroupName (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithClusterSubnetGroupName (const char *value)
 
bool GetPubliclyAccessible () const
 
bool PubliclyAccessibleHasBeenSet () const
 
void SetPubliclyAccessible (bool value)
 
RestoreFromClusterSnapshotRequestWithPubliclyAccessible (bool value)
 
const Aws::StringGetOwnerAccount () const
 
bool OwnerAccountHasBeenSet () const
 
void SetOwnerAccount (const Aws::String &value)
 
void SetOwnerAccount (Aws::String &&value)
 
void SetOwnerAccount (const char *value)
 
RestoreFromClusterSnapshotRequestWithOwnerAccount (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithOwnerAccount (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithOwnerAccount (const char *value)
 
const Aws::StringGetHsmClientCertificateIdentifier () const
 
bool HsmClientCertificateIdentifierHasBeenSet () const
 
void SetHsmClientCertificateIdentifier (const Aws::String &value)
 
void SetHsmClientCertificateIdentifier (Aws::String &&value)
 
void SetHsmClientCertificateIdentifier (const char *value)
 
RestoreFromClusterSnapshotRequestWithHsmClientCertificateIdentifier (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithHsmClientCertificateIdentifier (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithHsmClientCertificateIdentifier (const char *value)
 
const Aws::StringGetHsmConfigurationIdentifier () const
 
bool HsmConfigurationIdentifierHasBeenSet () const
 
void SetHsmConfigurationIdentifier (const Aws::String &value)
 
void SetHsmConfigurationIdentifier (Aws::String &&value)
 
void SetHsmConfigurationIdentifier (const char *value)
 
RestoreFromClusterSnapshotRequestWithHsmConfigurationIdentifier (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithHsmConfigurationIdentifier (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithHsmConfigurationIdentifier (const char *value)
 
const Aws::StringGetElasticIp () const
 
bool ElasticIpHasBeenSet () const
 
void SetElasticIp (const Aws::String &value)
 
void SetElasticIp (Aws::String &&value)
 
void SetElasticIp (const char *value)
 
RestoreFromClusterSnapshotRequestWithElasticIp (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithElasticIp (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithElasticIp (const char *value)
 
const Aws::StringGetClusterParameterGroupName () const
 
bool ClusterParameterGroupNameHasBeenSet () const
 
void SetClusterParameterGroupName (const Aws::String &value)
 
void SetClusterParameterGroupName (Aws::String &&value)
 
void SetClusterParameterGroupName (const char *value)
 
RestoreFromClusterSnapshotRequestWithClusterParameterGroupName (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithClusterParameterGroupName (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithClusterParameterGroupName (const char *value)
 
const Aws::Vector< Aws::String > & GetClusterSecurityGroups () const
 
bool ClusterSecurityGroupsHasBeenSet () const
 
void SetClusterSecurityGroups (const Aws::Vector< Aws::String > &value)
 
void SetClusterSecurityGroups (Aws::Vector< Aws::String > &&value)
 
RestoreFromClusterSnapshotRequestWithClusterSecurityGroups (const Aws::Vector< Aws::String > &value)
 
RestoreFromClusterSnapshotRequestWithClusterSecurityGroups (Aws::Vector< Aws::String > &&value)
 
RestoreFromClusterSnapshotRequestAddClusterSecurityGroups (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestAddClusterSecurityGroups (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestAddClusterSecurityGroups (const char *value)
 
const Aws::Vector< Aws::String > & GetVpcSecurityGroupIds () const
 
bool VpcSecurityGroupIdsHasBeenSet () const
 
void SetVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RestoreFromClusterSnapshotRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
RestoreFromClusterSnapshotRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RestoreFromClusterSnapshotRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestAddVpcSecurityGroupIds (const char *value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
RestoreFromClusterSnapshotRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithPreferredMaintenanceWindow (const char *value)
 
int GetAutomatedSnapshotRetentionPeriod () const
 
bool AutomatedSnapshotRetentionPeriodHasBeenSet () const
 
void SetAutomatedSnapshotRetentionPeriod (int value)
 
RestoreFromClusterSnapshotRequestWithAutomatedSnapshotRetentionPeriod (int value)
 
int GetManualSnapshotRetentionPeriod () const
 
bool ManualSnapshotRetentionPeriodHasBeenSet () const
 
void SetManualSnapshotRetentionPeriod (int value)
 
RestoreFromClusterSnapshotRequestWithManualSnapshotRetentionPeriod (int value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
RestoreFromClusterSnapshotRequestWithKmsKeyId (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithKmsKeyId (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetNodeType () const
 
bool NodeTypeHasBeenSet () const
 
void SetNodeType (const Aws::String &value)
 
void SetNodeType (Aws::String &&value)
 
void SetNodeType (const char *value)
 
RestoreFromClusterSnapshotRequestWithNodeType (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithNodeType (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithNodeType (const char *value)
 
bool GetEnhancedVpcRouting () const
 
bool EnhancedVpcRoutingHasBeenSet () const
 
void SetEnhancedVpcRouting (bool value)
 
RestoreFromClusterSnapshotRequestWithEnhancedVpcRouting (bool value)
 
const Aws::StringGetAdditionalInfo () const
 
bool AdditionalInfoHasBeenSet () const
 
void SetAdditionalInfo (const Aws::String &value)
 
void SetAdditionalInfo (Aws::String &&value)
 
void SetAdditionalInfo (const char *value)
 
RestoreFromClusterSnapshotRequestWithAdditionalInfo (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithAdditionalInfo (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithAdditionalInfo (const char *value)
 
const Aws::Vector< Aws::String > & GetIamRoles () const
 
bool IamRolesHasBeenSet () const
 
void SetIamRoles (const Aws::Vector< Aws::String > &value)
 
void SetIamRoles (Aws::Vector< Aws::String > &&value)
 
RestoreFromClusterSnapshotRequestWithIamRoles (const Aws::Vector< Aws::String > &value)
 
RestoreFromClusterSnapshotRequestWithIamRoles (Aws::Vector< Aws::String > &&value)
 
RestoreFromClusterSnapshotRequestAddIamRoles (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestAddIamRoles (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestAddIamRoles (const char *value)
 
const Aws::StringGetMaintenanceTrackName () const
 
bool MaintenanceTrackNameHasBeenSet () const
 
void SetMaintenanceTrackName (const Aws::String &value)
 
void SetMaintenanceTrackName (Aws::String &&value)
 
void SetMaintenanceTrackName (const char *value)
 
RestoreFromClusterSnapshotRequestWithMaintenanceTrackName (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithMaintenanceTrackName (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithMaintenanceTrackName (const char *value)
 
const Aws::StringGetSnapshotScheduleIdentifier () const
 
bool SnapshotScheduleIdentifierHasBeenSet () const
 
void SetSnapshotScheduleIdentifier (const Aws::String &value)
 
void SetSnapshotScheduleIdentifier (Aws::String &&value)
 
void SetSnapshotScheduleIdentifier (const char *value)
 
RestoreFromClusterSnapshotRequestWithSnapshotScheduleIdentifier (const Aws::String &value)
 
RestoreFromClusterSnapshotRequestWithSnapshotScheduleIdentifier (Aws::String &&value)
 
RestoreFromClusterSnapshotRequestWithSnapshotScheduleIdentifier (const char *value)
 
int GetNumberOfNodes () const
 
bool NumberOfNodesHasBeenSet () const
 
void SetNumberOfNodes (int value)
 
RestoreFromClusterSnapshotRequestWithNumberOfNodes (int value)
 
bool GetAvailabilityZoneRelocation () const
 
bool AvailabilityZoneRelocationHasBeenSet () const
 
void SetAvailabilityZoneRelocation (bool value)
 
RestoreFromClusterSnapshotRequestWithAvailabilityZoneRelocation (bool value)
 
const AquaConfigurationStatusGetAquaConfigurationStatus () const
 
bool AquaConfigurationStatusHasBeenSet () const
 
void SetAquaConfigurationStatus (const AquaConfigurationStatus &value)
 
void SetAquaConfigurationStatus (AquaConfigurationStatus &&value)
 
RestoreFromClusterSnapshotRequestWithAquaConfigurationStatus (const AquaConfigurationStatus &value)
 
RestoreFromClusterSnapshotRequestWithAquaConfigurationStatus (AquaConfigurationStatus &&value)
 
- Public Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual ~RedshiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 26 of file RestoreFromClusterSnapshotRequest.h.

Constructor & Destructor Documentation

◆ RestoreFromClusterSnapshotRequest()

Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::RestoreFromClusterSnapshotRequest ( )

Member Function Documentation

◆ AddClusterSecurityGroups() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AddClusterSecurityGroups ( Aws::String &&  value)
inline

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.

Definition at line 763 of file RestoreFromClusterSnapshotRequest.h.

◆ AddClusterSecurityGroups() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AddClusterSecurityGroups ( const Aws::String value)
inline

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.

Definition at line 756 of file RestoreFromClusterSnapshotRequest.h.

◆ AddClusterSecurityGroups() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AddClusterSecurityGroups ( const char *  value)
inline

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.

Definition at line 770 of file RestoreFromClusterSnapshotRequest.h.

◆ AddIamRoles() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AddIamRoles ( Aws::String &&  value)
inline

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.

Definition at line 1362 of file RestoreFromClusterSnapshotRequest.h.

◆ AddIamRoles() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AddIamRoles ( const Aws::String value)
inline

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.

Definition at line 1353 of file RestoreFromClusterSnapshotRequest.h.

◆ AddIamRoles() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AddIamRoles ( const char *  value)
inline

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.

Definition at line 1371 of file RestoreFromClusterSnapshotRequest.h.

◆ AdditionalInfoHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AdditionalInfoHasBeenSet ( ) const
inline

Reserved.

Definition at line 1259 of file RestoreFromClusterSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AddVpcSecurityGroupIds ( Aws::String &&  value)
inline

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.

Definition at line 827 of file RestoreFromClusterSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AddVpcSecurityGroupIds ( const Aws::String value)
inline

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.

Definition at line 820 of file RestoreFromClusterSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AddVpcSecurityGroupIds ( const char *  value)
inline

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.

Definition at line 834 of file RestoreFromClusterSnapshotRequest.h.

◆ AllowVersionUpgradeHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AllowVersionUpgradeHasBeenSet ( ) const
inline

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

Definition at line 329 of file RestoreFromClusterSnapshotRequest.h.

◆ AquaConfigurationStatusHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AquaConfigurationStatusHasBeenSet ( ) const
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 1568 of file RestoreFromClusterSnapshotRequest.h.

◆ AutomatedSnapshotRetentionPeriodHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AutomatedSnapshotRetentionPeriodHasBeenSet ( ) const
inline

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.

Definition at line 954 of file RestoreFromClusterSnapshotRequest.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AvailabilityZoneHasBeenSet ( ) const
inline

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

Definition at line 272 of file RestoreFromClusterSnapshotRequest.h.

◆ AvailabilityZoneRelocationHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::AvailabilityZoneRelocationHasBeenSet ( ) const
inline

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

Definition at line 1535 of file RestoreFromClusterSnapshotRequest.h.

◆ ClusterIdentifierHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::ClusterIdentifierHasBeenSet ( ) const
inline

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.

Definition at line 62 of file RestoreFromClusterSnapshotRequest.h.

◆ ClusterParameterGroupNameHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::ClusterParameterGroupNameHasBeenSet ( ) const
inline

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.

Definition at line 634 of file RestoreFromClusterSnapshotRequest.h.

◆ ClusterSecurityGroupsHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::ClusterSecurityGroupsHasBeenSet ( ) const
inline

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.

Definition at line 721 of file RestoreFromClusterSnapshotRequest.h.

◆ ClusterSubnetGroupNameHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::ClusterSubnetGroupNameHasBeenSet ( ) const
inline

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.

Definition at line 358 of file RestoreFromClusterSnapshotRequest.h.

◆ DumpBodyToUrl()

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ElasticIpHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::ElasticIpHasBeenSet ( ) const
inline

The elastic IP (EIP) address for the cluster.

Definition at line 579 of file RestoreFromClusterSnapshotRequest.h.

◆ EnhancedVpcRoutingHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::EnhancedVpcRoutingHasBeenSet ( ) const
inline

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

Definition at line 1226 of file RestoreFromClusterSnapshotRequest.h.

◆ GetAdditionalInfo()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetAdditionalInfo ( ) const
inline

Reserved.

Definition at line 1254 of file RestoreFromClusterSnapshotRequest.h.

◆ GetAllowVersionUpgrade()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetAllowVersionUpgrade ( ) const
inline

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

Definition at line 322 of file RestoreFromClusterSnapshotRequest.h.

◆ GetAquaConfigurationStatus()

const AquaConfigurationStatus& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetAquaConfigurationStatus ( ) const
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 1558 of file RestoreFromClusterSnapshotRequest.h.

◆ GetAutomatedSnapshotRetentionPeriod()

int Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetAutomatedSnapshotRetentionPeriod ( ) const
inline

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.

Definition at line 943 of file RestoreFromClusterSnapshotRequest.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetAvailabilityZone ( ) const
inline

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

Definition at line 265 of file RestoreFromClusterSnapshotRequest.h.

◆ GetAvailabilityZoneRelocation()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetAvailabilityZoneRelocation ( ) const
inline

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

Definition at line 1529 of file RestoreFromClusterSnapshotRequest.h.

◆ GetClusterIdentifier()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetClusterIdentifier ( ) const
inline

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.

Definition at line 52 of file RestoreFromClusterSnapshotRequest.h.

◆ GetClusterParameterGroupName()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetClusterParameterGroupName ( ) const
inline

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.

Definition at line 622 of file RestoreFromClusterSnapshotRequest.h.

◆ GetClusterSecurityGroups()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetClusterSecurityGroups ( ) const
inline

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.

Definition at line 714 of file RestoreFromClusterSnapshotRequest.h.

◆ GetClusterSubnetGroupName()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetClusterSubnetGroupName ( ) const
inline

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.

Definition at line 351 of file RestoreFromClusterSnapshotRequest.h.

◆ GetElasticIp()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetElasticIp ( ) const
inline

The elastic IP (EIP) address for the cluster.

Definition at line 574 of file RestoreFromClusterSnapshotRequest.h.

◆ GetEnhancedVpcRouting()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetEnhancedVpcRouting ( ) const
inline

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

Definition at line 1215 of file RestoreFromClusterSnapshotRequest.h.

◆ GetHsmClientCertificateIdentifier()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetHsmClientCertificateIdentifier ( ) const
inline

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Definition at line 477 of file RestoreFromClusterSnapshotRequest.h.

◆ GetHsmConfigurationIdentifier()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetHsmConfigurationIdentifier ( ) const
inline

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.

Definition at line 526 of file RestoreFromClusterSnapshotRequest.h.

◆ GetIamRoles()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetIamRoles ( ) const
inline

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.

Definition at line 1299 of file RestoreFromClusterSnapshotRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetKmsKeyId ( ) const
inline

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.

Definition at line 1017 of file RestoreFromClusterSnapshotRequest.h.

◆ GetMaintenanceTrackName()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetMaintenanceTrackName ( ) const
inline

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.

Definition at line 1383 of file RestoreFromClusterSnapshotRequest.h.

◆ GetManualSnapshotRetentionPeriod()

int Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetManualSnapshotRetentionPeriod ( ) const
inline

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.

Definition at line 985 of file RestoreFromClusterSnapshotRequest.h.

◆ GetNodeType()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetNodeType ( ) const
inline

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.

Definition at line 1084 of file RestoreFromClusterSnapshotRequest.h.

◆ GetNumberOfNodes()

int Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetNumberOfNodes ( ) const
inline

The number of nodes specified when provisioning the restored cluster.

Definition at line 1507 of file RestoreFromClusterSnapshotRequest.h.

◆ GetOwnerAccount()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetOwnerAccount ( ) const
inline

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.

Definition at line 428 of file RestoreFromClusterSnapshotRequest.h.

◆ GetPort()

int Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetPort ( ) const
inline

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

Definition at line 236 of file RestoreFromClusterSnapshotRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetPreferredMaintenanceWindow ( ) const
inline

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.

Definition at line 847 of file RestoreFromClusterSnapshotRequest.h.

◆ GetPubliclyAccessible()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetPubliclyAccessible ( ) const
inline

If true, the cluster can be accessed from a public network.

Definition at line 406 of file RestoreFromClusterSnapshotRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file RestoreFromClusterSnapshotRequest.h.

◆ GetSnapshotClusterIdentifier()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetSnapshotClusterIdentifier ( ) const
inline

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.

Definition at line 179 of file RestoreFromClusterSnapshotRequest.h.

◆ GetSnapshotIdentifier()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetSnapshotIdentifier ( ) const
inline

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Definition at line 129 of file RestoreFromClusterSnapshotRequest.h.

◆ GetSnapshotScheduleIdentifier()

const Aws::String& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetSnapshotScheduleIdentifier ( ) const
inline

A unique identifier for the snapshot schedule.

Definition at line 1466 of file RestoreFromClusterSnapshotRequest.h.

◆ GetVpcSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::GetVpcSecurityGroupIds ( ) const
inline

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.

Definition at line 778 of file RestoreFromClusterSnapshotRequest.h.

◆ HsmClientCertificateIdentifierHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::HsmClientCertificateIdentifierHasBeenSet ( ) const
inline

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Definition at line 483 of file RestoreFromClusterSnapshotRequest.h.

◆ HsmConfigurationIdentifierHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::HsmConfigurationIdentifierHasBeenSet ( ) const
inline

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.

Definition at line 532 of file RestoreFromClusterSnapshotRequest.h.

◆ IamRolesHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::IamRolesHasBeenSet ( ) const
inline

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.

Definition at line 1308 of file RestoreFromClusterSnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::KmsKeyIdHasBeenSet ( ) const
inline

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.

Definition at line 1024 of file RestoreFromClusterSnapshotRequest.h.

◆ MaintenanceTrackNameHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::MaintenanceTrackNameHasBeenSet ( ) const
inline

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.

Definition at line 1394 of file RestoreFromClusterSnapshotRequest.h.

◆ ManualSnapshotRetentionPeriodHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::ManualSnapshotRetentionPeriodHasBeenSet ( ) const
inline

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.

Definition at line 993 of file RestoreFromClusterSnapshotRequest.h.

◆ NodeTypeHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::NodeTypeHasBeenSet ( ) const
inline

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.

Definition at line 1101 of file RestoreFromClusterSnapshotRequest.h.

◆ NumberOfNodesHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::NumberOfNodesHasBeenSet ( ) const
inline

The number of nodes specified when provisioning the restored cluster.

Definition at line 1512 of file RestoreFromClusterSnapshotRequest.h.

◆ OwnerAccountHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::OwnerAccountHasBeenSet ( ) const
inline

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.

Definition at line 434 of file RestoreFromClusterSnapshotRequest.h.

◆ PortHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::PortHasBeenSet ( ) const
inline

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

Definition at line 243 of file RestoreFromClusterSnapshotRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::PreferredMaintenanceWindowHasBeenSet ( ) const
inline

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.

Definition at line 859 of file RestoreFromClusterSnapshotRequest.h.

◆ PubliclyAccessibleHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::PubliclyAccessibleHasBeenSet ( ) const
inline

If true, the cluster can be accessed from a public network.

Definition at line 411 of file RestoreFromClusterSnapshotRequest.h.

◆ SerializePayload()

Aws::String Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAdditionalInfo() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAdditionalInfo ( Aws::String &&  value)
inline

Reserved.

Definition at line 1269 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAdditionalInfo() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAdditionalInfo ( const Aws::String value)
inline

Reserved.

Definition at line 1264 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAdditionalInfo() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAdditionalInfo ( const char *  value)
inline

Reserved.

Definition at line 1274 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAllowVersionUpgrade()

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAllowVersionUpgrade ( bool  value)
inline

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

Definition at line 336 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAquaConfigurationStatus() [1/2]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAquaConfigurationStatus ( AquaConfigurationStatus &&  value)
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 1588 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAquaConfigurationStatus() [2/2]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAquaConfigurationStatus ( const AquaConfigurationStatus value)
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 1578 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAutomatedSnapshotRetentionPeriod()

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAutomatedSnapshotRetentionPeriod ( int  value)
inline

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.

Definition at line 965 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAvailabilityZone() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAvailabilityZone ( Aws::String &&  value)
inline

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

Definition at line 286 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAvailabilityZone() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAvailabilityZone ( const Aws::String value)
inline

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

Definition at line 279 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAvailabilityZone() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAvailabilityZone ( const char *  value)
inline

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

Definition at line 293 of file RestoreFromClusterSnapshotRequest.h.

◆ SetAvailabilityZoneRelocation()

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetAvailabilityZoneRelocation ( bool  value)
inline

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

Definition at line 1541 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterIdentifier() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 82 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterIdentifier() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterIdentifier ( const Aws::String value)
inline

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.

Definition at line 72 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterIdentifier() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterIdentifier ( const char *  value)
inline

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.

Definition at line 92 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterParameterGroupName() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterParameterGroupName ( Aws::String &&  value)
inline

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.

Definition at line 658 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterParameterGroupName() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterParameterGroupName ( const Aws::String value)
inline

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.

Definition at line 646 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterParameterGroupName() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterParameterGroupName ( const char *  value)
inline

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.

Definition at line 670 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterSecurityGroups() [1/2]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 735 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterSecurityGroups() [2/2]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 728 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterSubnetGroupName() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterSubnetGroupName ( Aws::String &&  value)
inline

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.

Definition at line 372 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterSubnetGroupName() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterSubnetGroupName ( const Aws::String value)
inline

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.

Definition at line 365 of file RestoreFromClusterSnapshotRequest.h.

◆ SetClusterSubnetGroupName() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetClusterSubnetGroupName ( const char *  value)
inline

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.

Definition at line 379 of file RestoreFromClusterSnapshotRequest.h.

◆ SetElasticIp() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetElasticIp ( Aws::String &&  value)
inline

The elastic IP (EIP) address for the cluster.

Definition at line 589 of file RestoreFromClusterSnapshotRequest.h.

◆ SetElasticIp() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetElasticIp ( const Aws::String value)
inline

The elastic IP (EIP) address for the cluster.

Definition at line 584 of file RestoreFromClusterSnapshotRequest.h.

◆ SetElasticIp() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetElasticIp ( const char *  value)
inline

The elastic IP (EIP) address for the cluster.

Definition at line 594 of file RestoreFromClusterSnapshotRequest.h.

◆ SetEnhancedVpcRouting()

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetEnhancedVpcRouting ( bool  value)
inline

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

Definition at line 1237 of file RestoreFromClusterSnapshotRequest.h.

◆ SetHsmClientCertificateIdentifier() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetHsmClientCertificateIdentifier ( Aws::String &&  value)
inline

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Definition at line 495 of file RestoreFromClusterSnapshotRequest.h.

◆ SetHsmClientCertificateIdentifier() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetHsmClientCertificateIdentifier ( const Aws::String value)
inline

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Definition at line 489 of file RestoreFromClusterSnapshotRequest.h.

◆ SetHsmClientCertificateIdentifier() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetHsmClientCertificateIdentifier ( const char *  value)
inline

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Definition at line 501 of file RestoreFromClusterSnapshotRequest.h.

◆ SetHsmConfigurationIdentifier() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetHsmConfigurationIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 544 of file RestoreFromClusterSnapshotRequest.h.

◆ SetHsmConfigurationIdentifier() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetHsmConfigurationIdentifier ( const Aws::String value)
inline

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.

Definition at line 538 of file RestoreFromClusterSnapshotRequest.h.

◆ SetHsmConfigurationIdentifier() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetHsmConfigurationIdentifier ( const char *  value)
inline

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.

Definition at line 550 of file RestoreFromClusterSnapshotRequest.h.

◆ SetIamRoles() [1/2]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetIamRoles ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 1326 of file RestoreFromClusterSnapshotRequest.h.

◆ SetIamRoles() [2/2]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetIamRoles ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 1317 of file RestoreFromClusterSnapshotRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetKmsKeyId ( Aws::String &&  value)
inline

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.

Definition at line 1038 of file RestoreFromClusterSnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetKmsKeyId ( const Aws::String value)
inline

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.

Definition at line 1031 of file RestoreFromClusterSnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetKmsKeyId ( const char *  value)
inline

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.

Definition at line 1045 of file RestoreFromClusterSnapshotRequest.h.

◆ SetMaintenanceTrackName() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetMaintenanceTrackName ( Aws::String &&  value)
inline

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.

Definition at line 1416 of file RestoreFromClusterSnapshotRequest.h.

◆ SetMaintenanceTrackName() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetMaintenanceTrackName ( const Aws::String value)
inline

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.

Definition at line 1405 of file RestoreFromClusterSnapshotRequest.h.

◆ SetMaintenanceTrackName() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetMaintenanceTrackName ( const char *  value)
inline

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.

Definition at line 1427 of file RestoreFromClusterSnapshotRequest.h.

◆ SetManualSnapshotRetentionPeriod()

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetManualSnapshotRetentionPeriod ( int  value)
inline

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.

Definition at line 1001 of file RestoreFromClusterSnapshotRequest.h.

◆ SetNodeType() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetNodeType ( Aws::String &&  value)
inline

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.

Definition at line 1135 of file RestoreFromClusterSnapshotRequest.h.

◆ SetNodeType() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetNodeType ( const Aws::String value)
inline

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.

Definition at line 1118 of file RestoreFromClusterSnapshotRequest.h.

◆ SetNodeType() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetNodeType ( const char *  value)
inline

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.

Definition at line 1152 of file RestoreFromClusterSnapshotRequest.h.

◆ SetNumberOfNodes()

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetNumberOfNodes ( int  value)
inline

The number of nodes specified when provisioning the restored cluster.

Definition at line 1517 of file RestoreFromClusterSnapshotRequest.h.

◆ SetOwnerAccount() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetOwnerAccount ( Aws::String &&  value)
inline

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.

Definition at line 446 of file RestoreFromClusterSnapshotRequest.h.

◆ SetOwnerAccount() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetOwnerAccount ( const Aws::String value)
inline

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.

Definition at line 440 of file RestoreFromClusterSnapshotRequest.h.

◆ SetOwnerAccount() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetOwnerAccount ( const char *  value)
inline

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.

Definition at line 452 of file RestoreFromClusterSnapshotRequest.h.

◆ SetPort()

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetPort ( int  value)
inline

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

Definition at line 250 of file RestoreFromClusterSnapshotRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetPreferredMaintenanceWindow ( Aws::String &&  value)
inline

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.

Definition at line 883 of file RestoreFromClusterSnapshotRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetPreferredMaintenanceWindow ( const Aws::String value)
inline

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.

Definition at line 871 of file RestoreFromClusterSnapshotRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetPreferredMaintenanceWindow ( const char *  value)
inline

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.

Definition at line 895 of file RestoreFromClusterSnapshotRequest.h.

◆ SetPubliclyAccessible()

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetPubliclyAccessible ( bool  value)
inline

If true, the cluster can be accessed from a public network.

Definition at line 416 of file RestoreFromClusterSnapshotRequest.h.

◆ SetSnapshotClusterIdentifier() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetSnapshotClusterIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 200 of file RestoreFromClusterSnapshotRequest.h.

◆ SetSnapshotClusterIdentifier() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetSnapshotClusterIdentifier ( const Aws::String value)
inline

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.

Definition at line 193 of file RestoreFromClusterSnapshotRequest.h.

◆ SetSnapshotClusterIdentifier() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetSnapshotClusterIdentifier ( const char *  value)
inline

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.

Definition at line 207 of file RestoreFromClusterSnapshotRequest.h.

◆ SetSnapshotIdentifier() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetSnapshotIdentifier ( Aws::String &&  value)
inline

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Definition at line 147 of file RestoreFromClusterSnapshotRequest.h.

◆ SetSnapshotIdentifier() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetSnapshotIdentifier ( const Aws::String value)
inline

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Definition at line 141 of file RestoreFromClusterSnapshotRequest.h.

◆ SetSnapshotIdentifier() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetSnapshotIdentifier ( const char *  value)
inline

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Definition at line 153 of file RestoreFromClusterSnapshotRequest.h.

◆ SetSnapshotScheduleIdentifier() [1/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetSnapshotScheduleIdentifier ( Aws::String &&  value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1481 of file RestoreFromClusterSnapshotRequest.h.

◆ SetSnapshotScheduleIdentifier() [2/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetSnapshotScheduleIdentifier ( const Aws::String value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1476 of file RestoreFromClusterSnapshotRequest.h.

◆ SetSnapshotScheduleIdentifier() [3/3]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetSnapshotScheduleIdentifier ( const char *  value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1486 of file RestoreFromClusterSnapshotRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 799 of file RestoreFromClusterSnapshotRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

void Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SetVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 792 of file RestoreFromClusterSnapshotRequest.h.

◆ SnapshotClusterIdentifierHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SnapshotClusterIdentifierHasBeenSet ( ) const
inline

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.

Definition at line 186 of file RestoreFromClusterSnapshotRequest.h.

◆ SnapshotIdentifierHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SnapshotIdentifierHasBeenSet ( ) const
inline

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Definition at line 135 of file RestoreFromClusterSnapshotRequest.h.

◆ SnapshotScheduleIdentifierHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::SnapshotScheduleIdentifierHasBeenSet ( ) const
inline

A unique identifier for the snapshot schedule.

Definition at line 1471 of file RestoreFromClusterSnapshotRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

bool Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::VpcSecurityGroupIdsHasBeenSet ( ) const
inline

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.

Definition at line 785 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAdditionalInfo() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAdditionalInfo ( Aws::String &&  value)
inline

Reserved.

Definition at line 1284 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAdditionalInfo() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAdditionalInfo ( const Aws::String value)
inline

Reserved.

Definition at line 1279 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAdditionalInfo() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAdditionalInfo ( const char *  value)
inline

Reserved.

Definition at line 1289 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAllowVersionUpgrade()

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAllowVersionUpgrade ( bool  value)
inline

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

Definition at line 343 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAquaConfigurationStatus() [1/2]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAquaConfigurationStatus ( AquaConfigurationStatus &&  value)
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 1608 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAquaConfigurationStatus() [2/2]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAquaConfigurationStatus ( const AquaConfigurationStatus value)
inline

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

  • enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.

  • disabled - Don't use AQUA.

  • auto - Amazon Redshift determines whether to use AQUA.

Definition at line 1598 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAutomatedSnapshotRetentionPeriod()

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAutomatedSnapshotRetentionPeriod ( int  value)
inline

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.

Definition at line 976 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAvailabilityZone() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAvailabilityZone ( Aws::String &&  value)
inline

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

Definition at line 307 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAvailabilityZone() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAvailabilityZone ( const Aws::String value)
inline

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

Definition at line 300 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAvailabilityZone() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAvailabilityZone ( const char *  value)
inline

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

Definition at line 314 of file RestoreFromClusterSnapshotRequest.h.

◆ WithAvailabilityZoneRelocation()

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithAvailabilityZoneRelocation ( bool  value)
inline

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

Definition at line 1547 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterIdentifier() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 112 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterIdentifier() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterIdentifier ( const Aws::String value)
inline

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.

Definition at line 102 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterIdentifier() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterIdentifier ( const char *  value)
inline

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.

Definition at line 122 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterParameterGroupName() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterParameterGroupName ( Aws::String &&  value)
inline

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.

Definition at line 694 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterParameterGroupName() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterParameterGroupName ( const Aws::String value)
inline

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.

Definition at line 682 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterParameterGroupName() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterParameterGroupName ( const char *  value)
inline

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.

Definition at line 706 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterSecurityGroups() [1/2]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 749 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterSecurityGroups() [2/2]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 742 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterSubnetGroupName() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterSubnetGroupName ( Aws::String &&  value)
inline

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.

Definition at line 393 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterSubnetGroupName() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterSubnetGroupName ( const Aws::String value)
inline

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.

Definition at line 386 of file RestoreFromClusterSnapshotRequest.h.

◆ WithClusterSubnetGroupName() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithClusterSubnetGroupName ( const char *  value)
inline

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.

Definition at line 400 of file RestoreFromClusterSnapshotRequest.h.

◆ WithElasticIp() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithElasticIp ( Aws::String &&  value)
inline

The elastic IP (EIP) address for the cluster.

Definition at line 604 of file RestoreFromClusterSnapshotRequest.h.

◆ WithElasticIp() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithElasticIp ( const Aws::String value)
inline

The elastic IP (EIP) address for the cluster.

Definition at line 599 of file RestoreFromClusterSnapshotRequest.h.

◆ WithElasticIp() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithElasticIp ( const char *  value)
inline

The elastic IP (EIP) address for the cluster.

Definition at line 609 of file RestoreFromClusterSnapshotRequest.h.

◆ WithEnhancedVpcRouting()

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithEnhancedVpcRouting ( bool  value)
inline

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

Definition at line 1248 of file RestoreFromClusterSnapshotRequest.h.

◆ WithHsmClientCertificateIdentifier() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithHsmClientCertificateIdentifier ( Aws::String &&  value)
inline

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Definition at line 513 of file RestoreFromClusterSnapshotRequest.h.

◆ WithHsmClientCertificateIdentifier() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithHsmClientCertificateIdentifier ( const Aws::String value)
inline

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Definition at line 507 of file RestoreFromClusterSnapshotRequest.h.

◆ WithHsmClientCertificateIdentifier() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithHsmClientCertificateIdentifier ( const char *  value)
inline

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Definition at line 519 of file RestoreFromClusterSnapshotRequest.h.

◆ WithHsmConfigurationIdentifier() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithHsmConfigurationIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 562 of file RestoreFromClusterSnapshotRequest.h.

◆ WithHsmConfigurationIdentifier() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithHsmConfigurationIdentifier ( const Aws::String value)
inline

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.

Definition at line 556 of file RestoreFromClusterSnapshotRequest.h.

◆ WithHsmConfigurationIdentifier() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithHsmConfigurationIdentifier ( const char *  value)
inline

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.

Definition at line 568 of file RestoreFromClusterSnapshotRequest.h.

◆ WithIamRoles() [1/2]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithIamRoles ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 1344 of file RestoreFromClusterSnapshotRequest.h.

◆ WithIamRoles() [2/2]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithIamRoles ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 1335 of file RestoreFromClusterSnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithKmsKeyId ( Aws::String &&  value)
inline

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.

Definition at line 1059 of file RestoreFromClusterSnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithKmsKeyId ( const Aws::String value)
inline

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.

Definition at line 1052 of file RestoreFromClusterSnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithKmsKeyId ( const char *  value)
inline

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.

Definition at line 1066 of file RestoreFromClusterSnapshotRequest.h.

◆ WithMaintenanceTrackName() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithMaintenanceTrackName ( Aws::String &&  value)
inline

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.

Definition at line 1449 of file RestoreFromClusterSnapshotRequest.h.

◆ WithMaintenanceTrackName() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithMaintenanceTrackName ( const Aws::String value)
inline

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.

Definition at line 1438 of file RestoreFromClusterSnapshotRequest.h.

◆ WithMaintenanceTrackName() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithMaintenanceTrackName ( const char *  value)
inline

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.

Definition at line 1460 of file RestoreFromClusterSnapshotRequest.h.

◆ WithManualSnapshotRetentionPeriod()

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithManualSnapshotRetentionPeriod ( int  value)
inline

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.

Definition at line 1009 of file RestoreFromClusterSnapshotRequest.h.

◆ WithNodeType() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithNodeType ( Aws::String &&  value)
inline

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.

Definition at line 1186 of file RestoreFromClusterSnapshotRequest.h.

◆ WithNodeType() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithNodeType ( const Aws::String value)
inline

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.

Definition at line 1169 of file RestoreFromClusterSnapshotRequest.h.

◆ WithNodeType() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithNodeType ( const char *  value)
inline

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.

Definition at line 1203 of file RestoreFromClusterSnapshotRequest.h.

◆ WithNumberOfNodes()

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithNumberOfNodes ( int  value)
inline

The number of nodes specified when provisioning the restored cluster.

Definition at line 1522 of file RestoreFromClusterSnapshotRequest.h.

◆ WithOwnerAccount() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithOwnerAccount ( Aws::String &&  value)
inline

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.

Definition at line 464 of file RestoreFromClusterSnapshotRequest.h.

◆ WithOwnerAccount() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithOwnerAccount ( const Aws::String value)
inline

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.

Definition at line 458 of file RestoreFromClusterSnapshotRequest.h.

◆ WithOwnerAccount() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithOwnerAccount ( const char *  value)
inline

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.

Definition at line 470 of file RestoreFromClusterSnapshotRequest.h.

◆ WithPort()

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithPort ( int  value)
inline

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

Definition at line 257 of file RestoreFromClusterSnapshotRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

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.

Definition at line 919 of file RestoreFromClusterSnapshotRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithPreferredMaintenanceWindow ( const Aws::String value)
inline

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.

Definition at line 907 of file RestoreFromClusterSnapshotRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithPreferredMaintenanceWindow ( const char *  value)
inline

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.

Definition at line 931 of file RestoreFromClusterSnapshotRequest.h.

◆ WithPubliclyAccessible()

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithPubliclyAccessible ( bool  value)
inline

If true, the cluster can be accessed from a public network.

Definition at line 421 of file RestoreFromClusterSnapshotRequest.h.

◆ WithSnapshotClusterIdentifier() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithSnapshotClusterIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 221 of file RestoreFromClusterSnapshotRequest.h.

◆ WithSnapshotClusterIdentifier() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithSnapshotClusterIdentifier ( const Aws::String value)
inline

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.

Definition at line 214 of file RestoreFromClusterSnapshotRequest.h.

◆ WithSnapshotClusterIdentifier() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithSnapshotClusterIdentifier ( const char *  value)
inline

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.

Definition at line 228 of file RestoreFromClusterSnapshotRequest.h.

◆ WithSnapshotIdentifier() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithSnapshotIdentifier ( Aws::String &&  value)
inline

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Definition at line 165 of file RestoreFromClusterSnapshotRequest.h.

◆ WithSnapshotIdentifier() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithSnapshotIdentifier ( const Aws::String value)
inline

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Definition at line 159 of file RestoreFromClusterSnapshotRequest.h.

◆ WithSnapshotIdentifier() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithSnapshotIdentifier ( const char *  value)
inline

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Definition at line 171 of file RestoreFromClusterSnapshotRequest.h.

◆ WithSnapshotScheduleIdentifier() [1/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithSnapshotScheduleIdentifier ( Aws::String &&  value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1496 of file RestoreFromClusterSnapshotRequest.h.

◆ WithSnapshotScheduleIdentifier() [2/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithSnapshotScheduleIdentifier ( const Aws::String value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1491 of file RestoreFromClusterSnapshotRequest.h.

◆ WithSnapshotScheduleIdentifier() [3/3]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithSnapshotScheduleIdentifier ( const char *  value)
inline

A unique identifier for the snapshot schedule.

Definition at line 1501 of file RestoreFromClusterSnapshotRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 813 of file RestoreFromClusterSnapshotRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

RestoreFromClusterSnapshotRequest& Aws::Redshift::Model::RestoreFromClusterSnapshotRequest::WithVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 806 of file RestoreFromClusterSnapshotRequest.h.


The documentation for this class was generated from the following file: