1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package neptune
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/neptune/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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.
func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *RestoreDBClusterFromSnapshotInput, optFns ...func(*Options)) (*RestoreDBClusterFromSnapshotOutput, error) {
if params == nil {
params = &RestoreDBClusterFromSnapshotInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RestoreDBClusterFromSnapshot", params, optFns, c.addOperationRestoreDBClusterFromSnapshotMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RestoreDBClusterFromSnapshotOutput)
out.ResultMetadata = metadata
return out, nil
}
type RestoreDBClusterFromSnapshotInput struct {
// 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
//
// This member is required.
DBClusterIdentifier *string
// 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
//
// This member is required.
Engine *string
// 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.
//
// This member is required.
SnapshotIdentifier *string
// Provides the list of EC2 Availability Zones that instances in the restored DB
// cluster can be created in.
AvailabilityZones []string
// If set to true , tags are copied to any snapshot of the restored DB cluster
// that is created.
CopyTagsToSnapshot *bool
// 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.
DBClusterParameterGroupName *string
// 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
DBSubnetGroupName *string
// Not supported.
DatabaseName *string
// 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.
DeletionProtection *bool
// The list of logs that the restored DB cluster is to export to Amazon CloudWatch
// Logs.
EnableCloudwatchLogsExports []string
// True to enable mapping of Amazon Identity and Access Management (IAM) accounts
// to database accounts, and otherwise false.
//
// Default: false
EnableIAMDatabaseAuthentication *bool
// The version of the database engine to use for the new DB cluster.
EngineVersion *string
// 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.
KmsKeyId *string
// (Not supported by Neptune)
OptionGroupName *string
// 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.
Port *int32
// Contains the scaling configuration of a Neptune Serverless DB cluster.
//
// For more information, see [Using Amazon Neptune Serverless] in the Amazon Neptune User Guide.
//
// [Using Amazon Neptune Serverless]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html
ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration
// Specifies the storage type to be associated with the DB cluster.
//
// Valid values: standard , iopt1
//
// Default: standard
StorageType *string
// The tags to be assigned to the restored DB cluster.
Tags []types.Tag
// A list of VPC security groups that the new DB cluster will belong to.
VpcSecurityGroupIds []string
noSmithyDocumentSerde
}
type RestoreDBClusterFromSnapshotOutput struct {
// Contains the details of an Amazon Neptune DB cluster.
//
// This data type is used as a response element in the DescribeDBClusters.
DBCluster *types.DBCluster
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRestoreDBClusterFromSnapshotMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpRestoreDBClusterFromSnapshot{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpRestoreDBClusterFromSnapshot{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "RestoreDBClusterFromSnapshot"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpRestoreDBClusterFromSnapshotValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRestoreDBClusterFromSnapshot(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opRestoreDBClusterFromSnapshot(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "RestoreDBClusterFromSnapshot",
}
}
|