/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::DocDB::RestoreDBClusterFromSnapshot

NAME

Paws::DocDB::RestoreDBClusterFromSnapshot - Arguments for method RestoreDBClusterFromSnapshot on Paws::DocDB

DESCRIPTION

This class represents the parameters used for calling the method RestoreDBClusterFromSnapshot on the Amazon DocumentDB with MongoDB compatibility service. Use the attributes of this class as arguments to method RestoreDBClusterFromSnapshot.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterFromSnapshot.

SYNOPSIS

my $rds = Paws->service('DocDB');
my $RestoreDBClusterFromSnapshotResult = $rds->RestoreDBClusterFromSnapshot(
  DBClusterIdentifier         => 'MyString',
  Engine                      => 'MyString',
  SnapshotIdentifier          => 'MyString',
  AvailabilityZones           => [ 'MyString', ... ],    # OPTIONAL
  DBSubnetGroupName           => 'MyString',             # OPTIONAL
  DeletionProtection          => 1,                      # OPTIONAL
  EnableCloudwatchLogsExports => [ 'MyString', ... ],    # OPTIONAL
  EngineVersion               => 'MyString',             # OPTIONAL
  KmsKeyId                    => 'MyString',             # OPTIONAL
  Port                        => 1,                      # OPTIONAL
  Tags                        => [
    {
      Key   => 'MyString',
      Value => 'MyString',
    },
    ...
  ],                                                     # OPTIONAL
  VpcSecurityGroupIds => [ 'MyString', ... ],            # OPTIONAL
);

# Results:
my $DBCluster = $RestoreDBClusterFromSnapshotResult->DBCluster;

# Returns a L<Paws::DocDB::RestoreDBClusterFromSnapshotResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBClusterFromSnapshot

ATTRIBUTES

AvailabilityZones => ArrayRef[Str|Undef]

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

REQUIRED DBClusterIdentifier => Str

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

DBSubnetGroupName => Str

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

DeletionProtection => Bool

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.

EnableCloudwatchLogsExports => ArrayRef[Str|Undef]

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

REQUIRED Engine => Str

The database engine to use for the new cluster.

Default: The same as source.

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

EngineVersion => Str

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

KmsKeyId => Str

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

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

Port => Int

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.

REQUIRED SnapshotIdentifier => Str

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.

Tags => ArrayRef[Paws::DocDB::Tag]

The tags to be assigned to the restored cluster.

VpcSecurityGroupIds => ArrayRef[Str|Undef]

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

SEE ALSO

This class forms part of Paws, documenting arguments for method RestoreDBClusterFromSnapshot in Paws::DocDB

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues