AWS CLI Command Reference

[ aws . docdb ]

create-db-instance

Description

Creates a new instance.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-db-instance
--db-instance-identifier <value>
--db-instance-class <value>
--engine <value>
[--availability-zone <value>]
[--preferred-maintenance-window <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--tags <value>]
--db-cluster-identifier <value>
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--promotion-tier <value>]
[--enable-performance-insights | --no-enable-performance-insights]
[--performance-insights-kms-key-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--db-instance-identifier (string)

The instance identifier. This parameter is stored as a lowercase string.

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: mydbinstance

--db-instance-class (string)

The compute and memory capacity of the instance; for example, db.r5.large .

--engine (string)

The name of the database engine to be used for this instance.

Valid value: docdb

--availability-zone (string)

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint’s Amazon Web Services Region.

Example: us-east-1d

--preferred-maintenance-window (string)

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (boolean)

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

--tags (list)

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

(structure)

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

Key -> (string)

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with “aws: ” or “rds: “. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).

Value -> (string)

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with “aws: ” or “rds: “. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--db-cluster-identifier (string)

The identifier of the cluster that the instance will belong to.

--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (boolean)

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

--promotion-tier (integer)

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

--enable-performance-insights | --no-enable-performance-insights (boolean)

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .

--performance-insights-kms-key-id (string)

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create an Amazon DocumentDB cluster instance

The following create-db-instance example code creates the instance sample-cluster-instance-2 in the Amazon DocumentDB cluster sample-cluster.

aws docdb create-db-instance \
    --db-cluster-identifier sample-cluster \
    --db-instance-class db.r4.xlarge \
    --db-instance-identifier sample-cluster-instance-2 \
    --engine docdb

Output:

{
    "DBInstance": {
        "DBInstanceStatus": "creating",
        "PendingModifiedValues": {
            "PendingCloudwatchLogsExports": {
                "LogTypesToEnable": [
                    "audit"
                ]
            }
        },
        "PubliclyAccessible": false,
        "PreferredBackupWindow": "00:00-00:30",
        "PromotionTier": 1,
        "EngineVersion": "3.6.0",
        "BackupRetentionPeriod": 3,
        "DBInstanceIdentifier": "sample-cluster-instance-2",
        "PreferredMaintenanceWindow": "tue:10:28-tue:10:58",
        "StorageEncrypted": false,
        "Engine": "docdb",
        "DBClusterIdentifier": "sample-cluster",
        "DBSubnetGroup": {
            "Subnets": [
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-4e26d263"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-afc329f4"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-53ab3636"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-991cb8d0"
                }
            ],
            "DBSubnetGroupDescription": "default",
            "SubnetGroupStatus": "Complete",
            "VpcId": "vpc-91280df6",
            "DBSubnetGroupName": "default"
        },
        "DBInstanceClass": "db.r4.xlarge",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2",
        "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE"
    }
}

For more information, see Adding an Amazon DocumentDB Instance to a Cluster in the Amazon DocumentDB Developer Guide.

Output

DBInstance -> (structure)

Detailed information about an instance.

DBInstanceIdentifier -> (string)

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

DBInstanceClass -> (string)

Contains the name of the compute and memory capacity class of the instance.

Engine -> (string)

Provides the name of the database engine to be used for this instance.

DBInstanceStatus -> (string)

Specifies the current state of this database.

Endpoint -> (structure)

Specifies the connection endpoint.

Address -> (string)

Specifies the DNS address of the instance.

Port -> (integer)

Specifies the port that the database engine is listening on.

HostedZoneId -> (string)

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

InstanceCreateTime -> (timestamp)

Provides the date and time that the instance was created.

PreferredBackupWindow -> (string)

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

BackupRetentionPeriod -> (integer)

Specifies the number of days for which automatic snapshots are retained.

VpcSecurityGroups -> (list)

Provides a list of VPC security group elements that the instance belongs to.

(structure)

Used as a response element for queries on virtual private cloud (VPC) security group membership.

VpcSecurityGroupId -> (string)

The name of the VPC security group.

Status -> (string)

The status of the VPC security group.

AvailabilityZone -> (string)

Specifies the name of the Availability Zone that the instance is located in.

DBSubnetGroup -> (structure)

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

DBSubnetGroupName -> (string)

The name of the subnet group.

DBSubnetGroupDescription -> (string)

Provides the description of the subnet group.

VpcId -> (string)

Provides the virtual private cloud (VPC) ID of the subnet group.

SubnetGroupStatus -> (string)

Provides the status of the subnet group.

Subnets -> (list)

Detailed information about one or more subnets within a subnet group.

(structure)

Detailed information about a subnet.

SubnetIdentifier -> (string)

Specifies the identifier of the subnet.

SubnetAvailabilityZone -> (structure)

Specifies the Availability Zone for the subnet.

Name -> (string)

The name of the Availability Zone.

SubnetStatus -> (string)

Specifies the status of the subnet.

DBSubnetGroupArn -> (string)

The Amazon Resource Name (ARN) for the DB subnet group.

PreferredMaintenanceWindow -> (string)

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

PendingModifiedValues -> (structure)

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

DBInstanceClass -> (string)

Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

AllocatedStorage -> (integer)

Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

MasterUserPassword -> (string)

Contains the pending or currently in-progress change of the master credentials for the instance.

Port -> (integer)

Specifies the pending port for the instance.

BackupRetentionPeriod -> (integer)

Specifies the pending number of days for which automated backups are retained.

MultiAZ -> (boolean)

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

EngineVersion -> (string)

Indicates the database engine version.

LicenseModel -> (string)

The license model for the instance.

Valid values: license-included , bring-your-own-license , general-public-license

Iops -> (integer)

Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

DBInstanceIdentifier -> (string)

Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

StorageType -> (string)

Specifies the storage type to be associated with the instance.

CACertificateIdentifier -> (string)

Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

DBSubnetGroupName -> (string)

The new subnet group for the instance.

PendingCloudwatchLogsExports -> (structure)

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

LogTypesToEnable -> (list)

Log types that are in the process of being deactivated. After they are deactivated, these log types aren’t exported to CloudWatch Logs.

(string)

LogTypesToDisable -> (list)

Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

(string)

LatestRestorableTime -> (timestamp)

Specifies the latest time to which a database can be restored with point-in-time restore.

EngineVersion -> (string)

Indicates the database engine version.

AutoMinorVersionUpgrade -> (boolean)

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

PubliclyAccessible -> (boolean)

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false .

StatusInfos -> (list)

The status of a read replica. If the instance is not a read replica, this is blank.

(structure)

Provides a list of status information for an instance.

StatusType -> (string)

This value is currently “read replication .”

Normal -> (boolean)

A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

Status -> (string)

Status of the instance. For a StatusType of read replica, the values can be replicating , error, stopped , or terminated .

Message -> (string)

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

DBClusterIdentifier -> (string)

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

StorageEncrypted -> (boolean)

Specifies whether or not the instance is encrypted.

KmsKeyId -> (string)

If StorageEncrypted is true , the KMS key identifier for the encrypted instance.

DbiResourceId -> (string)

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

CACertificateIdentifier -> (string)

The identifier of the CA certificate for this DB instance.

CopyTagsToSnapshot -> (boolean)

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

PromotionTier -> (integer)

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

DBInstanceArn -> (string)

The Amazon Resource Name (ARN) for the instance.

EnabledCloudwatchLogsExports -> (list)

A list of log types that this instance is configured to export to CloudWatch Logs.

(string)

© Copyright 2018, Amazon Web Services. Created using Sphinx.