import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateDBClusterMessage, CreateDBClusterResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateDBClusterCommand}. */ export interface CreateDBClusterCommandInput extends CreateDBClusterMessage { } /** * @public * * The output of {@link CreateDBClusterCommand}. */ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __MetadataBearer { } declare const CreateDBClusterCommand_base: { new (input: CreateDBClusterCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateDBClusterCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Creates a new Amazon DocumentDB cluster.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DocDBClient, CreateDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import * // const { DocDBClient, CreateDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import * // import type { DocDBClientConfig } from "@aws-sdk/client-docdb"; * const config = {}; // type is DocDBClientConfig * const client = new DocDBClient(config); * const input = { // CreateDBClusterMessage * AvailabilityZones: [ // AvailabilityZones * "STRING_VALUE", * ], * BackupRetentionPeriod: Number("int"), * DBClusterIdentifier: "STRING_VALUE", // required * DBClusterParameterGroupName: "STRING_VALUE", * VpcSecurityGroupIds: [ // VpcSecurityGroupIdList * "STRING_VALUE", * ], * DBSubnetGroupName: "STRING_VALUE", * Engine: "STRING_VALUE", // required * EngineVersion: "STRING_VALUE", * Port: Number("int"), * MasterUsername: "STRING_VALUE", * MasterUserPassword: "STRING_VALUE", * PreferredBackupWindow: "STRING_VALUE", * PreferredMaintenanceWindow: "STRING_VALUE", * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * StorageEncrypted: true || false, * KmsKeyId: "STRING_VALUE", * PreSignedUrl: "STRING_VALUE", * EnableCloudwatchLogsExports: [ // LogTypeList * "STRING_VALUE", * ], * DeletionProtection: true || false, * GlobalClusterIdentifier: "STRING_VALUE", * StorageType: "STRING_VALUE", * ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfiguration * MinCapacity: Number("double"), * MaxCapacity: Number("double"), * }, * ManageMasterUserPassword: true || false, * MasterUserSecretKmsKeyId: "STRING_VALUE", * NetworkType: "STRING_VALUE", * }; * const command = new CreateDBClusterCommand(input); * const response = await client.send(command); * // { // CreateDBClusterResult * // DBCluster: { // DBCluster * // AvailabilityZones: [ // AvailabilityZones * // "STRING_VALUE", * // ], * // BackupRetentionPeriod: Number("int"), * // DBClusterIdentifier: "STRING_VALUE", * // DBClusterParameterGroup: "STRING_VALUE", * // DBSubnetGroup: "STRING_VALUE", * // Status: "STRING_VALUE", * // PercentProgress: "STRING_VALUE", * // EarliestRestorableTime: new Date("TIMESTAMP"), * // Endpoint: "STRING_VALUE", * // ReaderEndpoint: "STRING_VALUE", * // MultiAZ: true || false, * // Engine: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // LatestRestorableTime: new Date("TIMESTAMP"), * // Port: Number("int"), * // MasterUsername: "STRING_VALUE", * // PreferredBackupWindow: "STRING_VALUE", * // PreferredMaintenanceWindow: "STRING_VALUE", * // ReplicationSourceIdentifier: "STRING_VALUE", * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList * // "STRING_VALUE", * // ], * // DBClusterMembers: [ // DBClusterMemberList * // { // DBClusterMember * // DBInstanceIdentifier: "STRING_VALUE", * // IsClusterWriter: true || false, * // DBClusterParameterGroupStatus: "STRING_VALUE", * // PromotionTier: Number("int"), * // }, * // ], * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList * // { // VpcSecurityGroupMembership * // VpcSecurityGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // HostedZoneId: "STRING_VALUE", * // StorageEncrypted: true || false, * // KmsKeyId: "STRING_VALUE", * // DbClusterResourceId: "STRING_VALUE", * // DBClusterArn: "STRING_VALUE", * // AssociatedRoles: [ // DBClusterRoles * // { // DBClusterRole * // RoleArn: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // CloneGroupId: "STRING_VALUE", * // ClusterCreateTime: new Date("TIMESTAMP"), * // EnabledCloudwatchLogsExports: [ // LogTypeList * // "STRING_VALUE", * // ], * // DeletionProtection: true || false, * // IOOptimizedNextAllowedModificationTime: new Date("TIMESTAMP"), * // StorageType: "STRING_VALUE", * // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo * // MinCapacity: Number("double"), * // MaxCapacity: Number("double"), * // }, * // MasterUserSecret: { // ClusterMasterUserSecret * // SecretArn: "STRING_VALUE", * // SecretStatus: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // }, * // NetworkType: "STRING_VALUE", * // }, * // }; * * ``` * * @param CreateDBClusterCommandInput - {@link CreateDBClusterCommandInput} * @returns {@link CreateDBClusterCommandOutput} * @see {@link CreateDBClusterCommandInput} for command's `input` shape. * @see {@link CreateDBClusterCommandOutput} for command's `response` shape. * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape. * * @throws {@link DBClusterAlreadyExistsFault} (client fault) *

You already have a cluster with the given identifier.

* * @throws {@link DBClusterNotFoundFault} (client fault) *

* DBClusterIdentifier doesn't refer to an existing cluster.

* * @throws {@link DBClusterParameterGroupNotFoundFault} (client fault) *

* DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

* * @throws {@link DBClusterQuotaExceededFault} (client fault) *

The cluster can't be created because you have reached the maximum allowed quota of clusters.

* * @throws {@link DBInstanceNotFoundFault} (client fault) *

* DBInstanceIdentifier doesn't refer to an existing instance.

* * @throws {@link DBSubnetGroupDoesNotCoverEnoughAZs} (client fault) *

Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

* * @throws {@link DBSubnetGroupNotFoundFault} (client fault) *

* DBSubnetGroupName doesn't refer to an existing subnet group.

* * @throws {@link GlobalClusterNotFoundFault} (client fault) *

The GlobalClusterIdentifier doesn't refer to an existing global cluster.

* * @throws {@link InsufficientStorageClusterCapacityFault} (client fault) *

There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

* * @throws {@link InvalidDBClusterStateFault} (client fault) *

The cluster isn't in a valid state.

* * @throws {@link InvalidDBInstanceStateFault} (client fault) *

The specified instance isn't in the available state. *

* * @throws {@link InvalidDBSubnetGroupStateFault} (client fault) *

The subnet group can't be deleted because it's in use.

* * @throws {@link InvalidGlobalClusterStateFault} (client fault) *

The requested operation can't be performed while the cluster is in this state.

* * @throws {@link InvalidSubnet} (client fault) *

The requested subnet is not valid, or multiple subnets were requested that are not all * in a common virtual private cloud (VPC).

* * @throws {@link InvalidVPCNetworkStateFault} (client fault) *

The subnet group doesn't cover all Availability Zones after it is created * because of changes that were made.

* * @throws {@link KMSKeyNotAccessibleFault} (client fault) *

An error occurred when accessing an KMS key.

* * @throws {@link NetworkTypeNotSupported} (client fault) *

The network type is not supported by either DBSubnetGroup or the DB engine version.

* * @throws {@link StorageQuotaExceededFault} (client fault) *

The request would cause you to exceed the allowed amount of storage available across * all instances.

* * @throws {@link DocDBServiceException} *

Base exception class for all service exceptions from DocDB service.

* * * @public */ export declare class CreateDBClusterCommand extends CreateDBClusterCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateDBClusterMessage; output: CreateDBClusterResult; }; sdk: { input: CreateDBClusterCommandInput; output: CreateDBClusterCommandOutput; }; }; }