AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest Class Reference

#include <RestoreDBClusterFromSnapshotRequest.h>

+ Inheritance diagram for Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest:

Public Member Functions

 RestoreDBClusterFromSnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetAvailabilityZones () const
 
bool AvailabilityZonesHasBeenSet () const
 
void SetAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
void SetAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromSnapshotRequestWithAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterFromSnapshotRequestWithAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromSnapshotRequestAddAvailabilityZones (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestAddAvailabilityZones (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestAddAvailabilityZones (const char *value)
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithDBClusterIdentifier (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithDBClusterIdentifier (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithDBClusterIdentifier (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)
 
RestoreDBClusterFromSnapshotRequestWithSnapshotIdentifier (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithSnapshotIdentifier (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithSnapshotIdentifier (const char *value)
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithEngine (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithEngine (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithEngine (const char *value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithEngineVersion (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithEngineVersion (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithEngineVersion (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
RestoreDBClusterFromSnapshotRequestWithPort (int value)
 
const Aws::StringGetDBSubnetGroupName () const
 
bool DBSubnetGroupNameHasBeenSet () const
 
void SetDBSubnetGroupName (const Aws::String &value)
 
void SetDBSubnetGroupName (Aws::String &&value)
 
void SetDBSubnetGroupName (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithDBSubnetGroupName (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithDBSubnetGroupName (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithDBSubnetGroupName (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)
 
RestoreDBClusterFromSnapshotRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterFromSnapshotRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromSnapshotRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestAddVpcSecurityGroupIds (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
RestoreDBClusterFromSnapshotRequestWithTags (const Aws::Vector< Tag > &value)
 
RestoreDBClusterFromSnapshotRequestWithTags (Aws::Vector< Tag > &&value)
 
RestoreDBClusterFromSnapshotRequestAddTags (const Tag &value)
 
RestoreDBClusterFromSnapshotRequestAddTags (Tag &&value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithKmsKeyId (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithKmsKeyId (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithKmsKeyId (const char *value)
 
const Aws::Vector< Aws::String > & GetEnableCloudwatchLogsExports () const
 
bool EnableCloudwatchLogsExportsHasBeenSet () const
 
void SetEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
void SetEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromSnapshotRequestWithEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterFromSnapshotRequestWithEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromSnapshotRequestAddEnableCloudwatchLogsExports (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestAddEnableCloudwatchLogsExports (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestAddEnableCloudwatchLogsExports (const char *value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
RestoreDBClusterFromSnapshotRequestWithDeletionProtection (bool value)
 
- Public Member Functions inherited from Aws::DocDB::DocDBRequest
virtual ~DocDBRequest ()
 
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::DocDB::DocDBRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Represents the input to RestoreDBClusterFromSnapshot.

See Also:

AWS API Reference

Definition at line 27 of file RestoreDBClusterFromSnapshotRequest.h.

Constructor & Destructor Documentation

◆ RestoreDBClusterFromSnapshotRequest()

Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::RestoreDBClusterFromSnapshotRequest ( )

Member Function Documentation

◆ AddAvailabilityZones() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddAvailabilityZones ( const Aws::String value)
inline

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Definition at line 85 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddAvailabilityZones() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddAvailabilityZones ( Aws::String &&  value)
inline

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Definition at line 91 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddAvailabilityZones() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddAvailabilityZones ( const char *  value)
inline

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Definition at line 97 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddEnableCloudwatchLogsExports() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddEnableCloudwatchLogsExports ( const Aws::String value)
inline

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Definition at line 695 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddEnableCloudwatchLogsExports() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddEnableCloudwatchLogsExports ( Aws::String &&  value)
inline

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Definition at line 701 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddEnableCloudwatchLogsExports() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddEnableCloudwatchLogsExports ( const char *  value)
inline

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Definition at line 707 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddTags() [1/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddTags ( const Tag value)
inline

The tags to be assigned to the restored cluster.

Definition at line 518 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddTags() [2/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddTags ( Tag &&  value)
inline

The tags to be assigned to the restored cluster.

Definition at line 523 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddVpcSecurityGroupIds ( const Aws::String value)
inline

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Definition at line 470 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddVpcSecurityGroupIds ( Aws::String &&  value)
inline

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Definition at line 476 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AddVpcSecurityGroupIds ( const char *  value)
inline

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Definition at line 482 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AvailabilityZonesHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::AvailabilityZonesHasBeenSet ( ) const
inline

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Definition at line 55 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DBClusterIdentifierHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::DBClusterIdentifierHasBeenSet ( ) const
inline

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

Definition at line 118 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DBSubnetGroupNameHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::DBSubnetGroupNameHasBeenSet ( ) const
inline

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Definition at line 385 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DeletionProtectionHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::DeletionProtectionHasBeenSet ( ) const
inline

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Definition at line 726 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DumpBodyToUrl()

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::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.

◆ EnableCloudwatchLogsExportsHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::EnableCloudwatchLogsExportsHasBeenSet ( ) const
inline

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Definition at line 665 of file RestoreDBClusterFromSnapshotRequest.h.

◆ EngineHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::EngineHasBeenSet ( ) const
inline

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Definition at line 264 of file RestoreDBClusterFromSnapshotRequest.h.

◆ EngineVersionHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::EngineVersionHasBeenSet ( ) const
inline

The version of the database engine to use for the new cluster.

Definition at line 311 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetAvailabilityZones()

const Aws::Vector<Aws::String>& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetAvailabilityZones ( ) const
inline

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Definition at line 49 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetDBClusterIdentifier()

const Aws::String& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetDBClusterIdentifier ( ) const
inline

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

Definition at line 108 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetDBSubnetGroupName()

const Aws::String& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetDBSubnetGroupName ( ) const
inline

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Definition at line 378 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetDeletionProtection()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetDeletionProtection ( ) const
inline

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Definition at line 717 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetEnableCloudwatchLogsExports()

const Aws::Vector<Aws::String>& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetEnableCloudwatchLogsExports ( ) const
inline

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Definition at line 659 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetEngine()

const Aws::String& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetEngine ( ) const
inline

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Definition at line 258 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetEngineVersion()

const Aws::String& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetEngineVersion ( ) const
inline

The version of the database engine to use for the new cluster.

Definition at line 306 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetKmsKeyId ( ) const
inline

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Definition at line 540 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetPort()

int Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetPort ( ) const
inline

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

Definition at line 349 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetSnapshotIdentifier()

const Aws::String& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetSnapshotIdentifier ( ) const
inline

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

Definition at line 188 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetTags ( ) const
inline

The tags to be assigned to the restored cluster.

Definition at line 488 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetVpcSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::GetVpcSecurityGroupIds ( ) const
inline

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Definition at line 434 of file RestoreDBClusterFromSnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::KmsKeyIdHasBeenSet ( ) const
inline

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Definition at line 556 of file RestoreDBClusterFromSnapshotRequest.h.

◆ PortHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::PortHasBeenSet ( ) const
inline

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

Definition at line 356 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SerializePayload()

Aws::String Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAvailabilityZones() [1/2]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Definition at line 61 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetAvailabilityZones() [2/2]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Definition at line 67 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBClusterIdentifier() [1/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetDBClusterIdentifier ( const Aws::String value)
inline

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

Definition at line 128 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBClusterIdentifier() [2/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetDBClusterIdentifier ( Aws::String &&  value)
inline

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

Definition at line 138 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBClusterIdentifier() [3/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetDBClusterIdentifier ( const char *  value)
inline

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

Definition at line 148 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBSubnetGroupName() [1/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetDBSubnetGroupName ( const Aws::String value)
inline

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Definition at line 392 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBSubnetGroupName() [2/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetDBSubnetGroupName ( Aws::String &&  value)
inline

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Definition at line 399 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBSubnetGroupName() [3/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetDBSubnetGroupName ( const char *  value)
inline

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Definition at line 406 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDeletionProtection()

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetDeletionProtection ( bool  value)
inline

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Definition at line 735 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEnableCloudwatchLogsExports() [1/2]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetEnableCloudwatchLogsExports ( const Aws::Vector< Aws::String > &  value)
inline

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Definition at line 671 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEnableCloudwatchLogsExports() [2/2]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetEnableCloudwatchLogsExports ( Aws::Vector< Aws::String > &&  value)
inline

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Definition at line 677 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngine() [1/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetEngine ( const Aws::String value)
inline

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Definition at line 270 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngine() [2/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetEngine ( Aws::String &&  value)
inline

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Definition at line 276 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngine() [3/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetEngine ( const char *  value)
inline

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Definition at line 282 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngineVersion() [1/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetEngineVersion ( const Aws::String value)
inline

The version of the database engine to use for the new cluster.

Definition at line 316 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngineVersion() [2/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetEngineVersion ( Aws::String &&  value)
inline

The version of the database engine to use for the new cluster.

Definition at line 321 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngineVersion() [3/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetEngineVersion ( const char *  value)
inline

The version of the database engine to use for the new cluster.

Definition at line 326 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetKmsKeyId ( const Aws::String value)
inline

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Definition at line 572 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetKmsKeyId ( Aws::String &&  value)
inline

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Definition at line 588 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetKmsKeyId ( const char *  value)
inline

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Definition at line 604 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetPort()

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetPort ( int  value)
inline

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

Definition at line 363 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetSnapshotIdentifier() [1/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetSnapshotIdentifier ( const Aws::String value)
inline

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

Definition at line 206 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetSnapshotIdentifier() [2/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

Definition at line 215 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetSnapshotIdentifier() [3/3]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetSnapshotIdentifier ( const char *  value)
inline

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

Definition at line 224 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetTags() [1/2]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

The tags to be assigned to the restored cluster.

Definition at line 498 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetTags() [2/2]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

The tags to be assigned to the restored cluster.

Definition at line 503 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Definition at line 446 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

void Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SetVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Definition at line 452 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SnapshotIdentifierHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::SnapshotIdentifierHasBeenSet ( ) const
inline

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

Definition at line 197 of file RestoreDBClusterFromSnapshotRequest.h.

◆ TagsHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::TagsHasBeenSet ( ) const
inline

The tags to be assigned to the restored cluster.

Definition at line 493 of file RestoreDBClusterFromSnapshotRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

bool Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::VpcSecurityGroupIdsHasBeenSet ( ) const
inline

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Definition at line 440 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithAvailabilityZones() [1/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Definition at line 73 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithAvailabilityZones() [2/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Definition at line 79 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBClusterIdentifier() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithDBClusterIdentifier ( const Aws::String value)
inline

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

Definition at line 158 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBClusterIdentifier() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithDBClusterIdentifier ( Aws::String &&  value)
inline

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

Definition at line 168 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBClusterIdentifier() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithDBClusterIdentifier ( const char *  value)
inline

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

Definition at line 178 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBSubnetGroupName() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithDBSubnetGroupName ( const Aws::String value)
inline

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Definition at line 413 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBSubnetGroupName() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithDBSubnetGroupName ( Aws::String &&  value)
inline

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Definition at line 420 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBSubnetGroupName() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithDBSubnetGroupName ( const char *  value)
inline

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Definition at line 427 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDeletionProtection()

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithDeletionProtection ( bool  value)
inline

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Definition at line 744 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEnableCloudwatchLogsExports() [1/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithEnableCloudwatchLogsExports ( const Aws::Vector< Aws::String > &  value)
inline

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Definition at line 683 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEnableCloudwatchLogsExports() [2/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithEnableCloudwatchLogsExports ( Aws::Vector< Aws::String > &&  value)
inline

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Definition at line 689 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngine() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithEngine ( const Aws::String value)
inline

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Definition at line 288 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngine() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithEngine ( Aws::String &&  value)
inline

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Definition at line 294 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngine() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithEngine ( const char *  value)
inline

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Definition at line 300 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngineVersion() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithEngineVersion ( const Aws::String value)
inline

The version of the database engine to use for the new cluster.

Definition at line 331 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngineVersion() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithEngineVersion ( Aws::String &&  value)
inline

The version of the database engine to use for the new cluster.

Definition at line 336 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngineVersion() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithEngineVersion ( const char *  value)
inline

The version of the database engine to use for the new cluster.

Definition at line 341 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithKmsKeyId ( const Aws::String value)
inline

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Definition at line 620 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithKmsKeyId ( Aws::String &&  value)
inline

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Definition at line 636 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithKmsKeyId ( const char *  value)
inline

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Definition at line 652 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithPort()

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithPort ( int  value)
inline

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

Definition at line 370 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithSnapshotIdentifier() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithSnapshotIdentifier ( const Aws::String value)
inline

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

Definition at line 233 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithSnapshotIdentifier() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

Definition at line 242 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithSnapshotIdentifier() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithSnapshotIdentifier ( const char *  value)
inline

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

Definition at line 251 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithTags() [1/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

The tags to be assigned to the restored cluster.

Definition at line 508 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithTags() [2/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

The tags to be assigned to the restored cluster.

Definition at line 513 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Definition at line 458 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

RestoreDBClusterFromSnapshotRequest& Aws::DocDB::Model::RestoreDBClusterFromSnapshotRequest::WithVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Definition at line 464 of file RestoreDBClusterFromSnapshotRequest.h.


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