amazonka-neptune-2.0: Amazon Neptune SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Neptune.RestoreDBClusterFromSnapshot

Description

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Synopsis

Creating a Request

data RestoreDBClusterFromSnapshot Source #

See: newRestoreDBClusterFromSnapshot smart constructor.

Constructors

RestoreDBClusterFromSnapshot' 

Fields

  • availabilityZones :: Maybe [Text]

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

  • copyTagsToSnapshot :: Maybe Bool

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

  • dbClusterParameterGroupName :: Maybe Text

    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 :: Maybe Text

    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

  • databaseName :: Maybe Text

    Not supported.

  • deletionProtection :: Maybe 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 :: Maybe [Text]

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

  • enableIAMDatabaseAuthentication :: Maybe Bool

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

    Default: false

  • engineVersion :: Maybe Text

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

  • kmsKeyId :: Maybe Text

    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 :: Maybe Text

    (Not supported by Neptune)

  • port :: Maybe 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.

  • serverlessV2ScalingConfiguration :: Maybe ServerlessV2ScalingConfiguration
     
  • tags :: Maybe [Tag]

    The tags to be assigned to the restored DB cluster.

  • vpcSecurityGroupIds :: Maybe [Text]

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

  • dbClusterIdentifier :: Text

    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

  • snapshotIdentifier :: Text

    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.
  • engine :: Text

    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

Instances

Instances details
ToHeaders RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

ToPath RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

ToQuery RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

AWSRequest RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

Generic RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

Associated Types

type Rep RestoreDBClusterFromSnapshot :: Type -> Type #

Read RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

Show RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

NFData RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

Eq RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

Hashable RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

type AWSResponse RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshot = D1 ('MetaData "RestoreDBClusterFromSnapshot" "Amazonka.Neptune.RestoreDBClusterFromSnapshot" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "RestoreDBClusterFromSnapshot'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "enableIAMDatabaseAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "serverlessV2ScalingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerlessV2ScalingConfiguration)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "snapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newRestoreDBClusterFromSnapshot Source #

Create a value of RestoreDBClusterFromSnapshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_availabilityZones - Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

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

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_dbClusterParameterGroupName - 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.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_dbSubnetGroupName - 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

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_databaseName - Not supported.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_deletionProtection - 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.

$sel:enableCloudwatchLogsExports:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

$sel:enableIAMDatabaseAuthentication:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_enableIAMDatabaseAuthentication - True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_engineVersion - The version of the database engine to use for the new DB cluster.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_kmsKeyId - 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.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_optionGroupName - (Not supported by Neptune)

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_port - 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.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_serverlessV2ScalingConfiguration - Undocumented member.

$sel:tags:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_tags - The tags to be assigned to the restored DB cluster.

$sel:vpcSecurityGroupIds:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_vpcSecurityGroupIds - A list of VPC security groups that the new DB cluster will belong to.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_dbClusterIdentifier - 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

$sel:snapshotIdentifier:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_snapshotIdentifier - 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.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_engine - 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

Request Lenses

restoreDBClusterFromSnapshot_availabilityZones :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #

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

restoreDBClusterFromSnapshot_copyTagsToSnapshot :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #

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

restoreDBClusterFromSnapshot_dbClusterParameterGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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.

restoreDBClusterFromSnapshot_dbSubnetGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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

restoreDBClusterFromSnapshot_deletionProtection :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #

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.

restoreDBClusterFromSnapshot_enableCloudwatchLogsExports :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #

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

restoreDBClusterFromSnapshot_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #

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

Default: false

restoreDBClusterFromSnapshot_engineVersion :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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

restoreDBClusterFromSnapshot_kmsKeyId :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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.

restoreDBClusterFromSnapshot_port :: Lens' RestoreDBClusterFromSnapshot (Maybe Int) Source #

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.

restoreDBClusterFromSnapshot_tags :: Lens' RestoreDBClusterFromSnapshot (Maybe [Tag]) Source #

The tags to be assigned to the restored DB cluster.

restoreDBClusterFromSnapshot_vpcSecurityGroupIds :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #

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

restoreDBClusterFromSnapshot_dbClusterIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #

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

restoreDBClusterFromSnapshot_snapshotIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #

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.

restoreDBClusterFromSnapshot_engine :: Lens' RestoreDBClusterFromSnapshot Text Source #

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

Destructuring the Response

data RestoreDBClusterFromSnapshotResponse Source #

Constructors

RestoreDBClusterFromSnapshotResponse' 

Fields

Instances

Instances details
Generic RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

Read RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

Show RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

NFData RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

Eq RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Neptune.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshotResponse = D1 ('MetaData "RestoreDBClusterFromSnapshotResponse" "Amazonka.Neptune.RestoreDBClusterFromSnapshot" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "RestoreDBClusterFromSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRestoreDBClusterFromSnapshotResponse Source #

Create a value of RestoreDBClusterFromSnapshotResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbCluster:RestoreDBClusterFromSnapshotResponse', restoreDBClusterFromSnapshotResponse_dbCluster - Undocumented member.

$sel:httpStatus:RestoreDBClusterFromSnapshotResponse', restoreDBClusterFromSnapshotResponse_httpStatus - The response's http status code.

Response Lenses