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

NAME

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

DESCRIPTION

This class represents the parameters used for calling the method RestoreDBClusterFromSnapshot on the Amazon Neptune 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('Neptune');
my $RestoreDBClusterFromSnapshotResult = $rds->RestoreDBClusterFromSnapshot(
  DBClusterIdentifier             => 'MyString',
  Engine                          => 'MyString',
  SnapshotIdentifier              => 'MyString',
  AvailabilityZones               => [ 'MyString', ... ],    # OPTIONAL
  CopyTagsToSnapshot              => 1,                      # OPTIONAL
  DBClusterParameterGroupName     => 'MyString',             # OPTIONAL
  DBSubnetGroupName               => 'MyString',             # OPTIONAL
  DatabaseName                    => 'MyString',             # OPTIONAL
  DeletionProtection              => 1,                      # OPTIONAL
  EnableCloudwatchLogsExports     => [ 'MyString', ... ],    # OPTIONAL
  EnableIAMDatabaseAuthentication => 1,                      # OPTIONAL
  EngineVersion                   => 'MyString',             # OPTIONAL
  KmsKeyId                        => 'MyString',             # OPTIONAL
  OptionGroupName                 => 'MyString',             # OPTIONAL
  Port                            => 1,                      # OPTIONAL
  Tags                            => [
    {
      Key   => 'MyString',
      Value => 'MyString',
    },
    ...
  ],                                                         # OPTIONAL
  VpcSecurityGroupIds => [ 'MyString', ... ],                # OPTIONAL
);

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

# Returns a L<Paws::Neptune::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 EC2 Availability Zones that instances in the restored DB cluster can be created in.

CopyTagsToSnapshot => Bool

If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

DatabaseName => Str

Not supported.

REQUIRED DBClusterIdentifier => Str

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

Constraints:

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

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

DBClusterParameterGroupName => Str

The name of the DB cluster parameter group to associate with the new DB cluster.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

DBSubnetGroupName => Str

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

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

Example: mySubnetgroup

DeletionProtection => Bool

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

EnableCloudwatchLogsExports => ArrayRef[Str|Undef]

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

EnableIAMDatabaseAuthentication => Bool

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

REQUIRED Engine => Str

The database engine to use for the new DB 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 DB cluster.

KmsKeyId => Str

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

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB 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 will occur:

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

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

OptionGroupName => Str

(Not supported by Neptune)

Port => Int

The port number on which the new DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

REQUIRED SnapshotIdentifier => Str

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

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

Constraints:

  • Must match the identifier of an existing Snapshot.

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

The tags to be assigned to the restored DB cluster.

VpcSecurityGroupIds => ArrayRef[Str|Undef]

A list of VPC security groups that the new DB cluster will belong to.

SEE ALSO

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

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