NAME

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

DESCRIPTION

This class represents the parameters used for calling the method CreateDBInstance on the Amazon Neptune service. Use the attributes of this class as arguments to method CreateDBInstance.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBInstance.

SYNOPSIS

    my $rds = Paws->service('Neptune');
    my $CreateDBInstanceResult = $rds->CreateDBInstance(
      DBInstanceClass                 => 'MyString',
      DBInstanceIdentifier            => 'MyString',
      Engine                          => 'MyString',
      AllocatedStorage                => 1,                      # OPTIONAL
      AutoMinorVersionUpgrade         => 1,                      # OPTIONAL
      AvailabilityZone                => 'MyString',             # OPTIONAL
      BackupRetentionPeriod           => 1,                      # OPTIONAL
      CharacterSetName                => 'MyString',             # OPTIONAL
      CopyTagsToSnapshot              => 1,                      # OPTIONAL
      DBClusterIdentifier             => 'MyString',             # OPTIONAL
      DBName                          => 'MyString',             # OPTIONAL
      DBParameterGroupName            => 'MyString',             # OPTIONAL
      DBSecurityGroups                => [ 'MyString', ... ],    # OPTIONAL
      DBSubnetGroupName               => 'MyString',             # OPTIONAL
      DeletionProtection              => 1,                      # OPTIONAL
      Domain                          => 'MyString',             # OPTIONAL
      DomainIAMRoleName               => 'MyString',             # OPTIONAL
      EnableCloudwatchLogsExports     => [ 'MyString', ... ],    # OPTIONAL
      EnableIAMDatabaseAuthentication => 1,                      # OPTIONAL
      EnablePerformanceInsights       => 1,                      # OPTIONAL
      EngineVersion                   => 'MyString',             # OPTIONAL
      Iops                            => 1,                      # OPTIONAL
      KmsKeyId                        => 'MyString',             # OPTIONAL
      LicenseModel                    => 'MyString',             # OPTIONAL
      MasterUserPassword              => 'MyString',             # OPTIONAL
      MasterUsername                  => 'MyString',             # OPTIONAL
      MonitoringInterval              => 1,                      # OPTIONAL
      MonitoringRoleArn               => 'MyString',             # OPTIONAL
      MultiAZ                         => 1,                      # OPTIONAL
      OptionGroupName                 => 'MyString',             # OPTIONAL
      PerformanceInsightsKMSKeyId     => 'MyString',             # OPTIONAL
      Port                            => 1,                      # OPTIONAL
      PreferredBackupWindow           => 'MyString',             # OPTIONAL
      PreferredMaintenanceWindow      => 'MyString',             # OPTIONAL
      PromotionTier                   => 1,                      # OPTIONAL
      PubliclyAccessible              => 1,                      # OPTIONAL
      StorageEncrypted                => 1,                      # OPTIONAL
      StorageType                     => 'MyString',             # OPTIONAL
      Tags                            => [
        {
          Key   => 'MyString',
          Value => 'MyString',
        },
        ...
      ],                                                         # OPTIONAL
      TdeCredentialArn      => 'MyString',                       # OPTIONAL
      TdeCredentialPassword => 'MyString',                       # OPTIONAL
      Timezone              => 'MyString',                       # OPTIONAL
      VpcSecurityGroupIds   => [ 'MyString', ... ],              # OPTIONAL
    );
    # Results:
    my $DBInstance = $CreateDBInstanceResult->DBInstance;
    # Returns a L<Paws::Neptune::CreateDBInstanceResult> 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/CreateDBInstance>

ATTRIBUTES

AllocatedStorage => Int

Not supported by Neptune.

AutoMinorVersionUpgrade => Bool

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: "true"

AvailabilityZone => Str

The EC2 Availability Zone that the DB instance is created in

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

Example: "us-east-1d"

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to "true". The specified Availability Zone must be in the same Amazon Region as the current endpoint.

BackupRetentionPeriod => Int

The number of days for which automated backups are retained.

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

Default: 1

Constraints:

Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas

CharacterSetName => Str

(Not supported by Neptune)

CopyTagsToSnapshot => Bool

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

DBClusterIdentifier => Str

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

For information on creating a DB cluster, see CreateDBCluster.

Type: String

REQUIRED DBInstanceClass => Str

The compute and memory capacity of the DB instance, for example, "db.m4.large". Not all DB instance classes are available in all Amazon Regions.

REQUIRED DBInstanceIdentifier => Str

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

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

DBName => Str

Not supported.

DBParameterGroupName => Str

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

DBSecurityGroups => ArrayRef[Str|Undef]

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

DBSubnetGroupName => Str

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

DeletionProtection => Bool

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).

DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.

Domain => Str

Specify the Active Directory Domain to create the instance in.

DomainIAMRoleName => Str

Specify the name of the IAM role to be used when making API calls to the Directory Service.

EnableCloudwatchLogsExports => ArrayRef[Str|Undef]

The list of log types that need to be enabled for exporting to CloudWatch Logs.

EnableIAMDatabaseAuthentication => Bool

Not supported by Neptune (ignored).

EnablePerformanceInsights => Bool

(Not supported by Neptune)

REQUIRED Engine => Str

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

Valid Values: "neptune"

EngineVersion => Str

The version number of the database engine to use. Currently, setting this parameter has no effect.

Iops => Int

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

KmsKeyId => Str

The Amazon KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same Amazon account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If the "StorageEncrypted" parameter is true, and you do not specify a value for the "KmsKeyId" parameter, then Amazon Neptune will use your default encryption key. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

LicenseModel => Str

License model information for this DB instance.

Valid values: "license-included" | "bring-your-own-license" | "general-public-license"

MasterUsername => Str

Not supported by Neptune.

MasterUserPassword => Str

Not supported by Neptune.

MonitoringInterval => Int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If "MonitoringRoleArn" is specified, then you must also set "MonitoringInterval" to a value other than 0.

Valid Values: "0, 1, 5, 10, 15, 30, 60"

MonitoringRoleArn => Str

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, "arn:aws:iam:123456789012:role/emaccess".

If "MonitoringInterval" is set to a value other than 0, then you must supply a "MonitoringRoleArn" value.

MultiAZ => Bool

Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

OptionGroupName => Str

(Not supported by Neptune)

PerformanceInsightsKMSKeyId => Str

(Not supported by Neptune)

Port => Int

The port number on which the database accepts connections.

Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.

Default: 8182

Type: Integer

PreferredBackupWindow => Str

The daily time range during which automated backups are created.

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

PreferredMaintenanceWindow => Str

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 Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

PromotionTier => Int

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

Default: 1

Valid Values: 0 - 15

PubliclyAccessible => Bool

This flag should no longer be used.

StorageEncrypted => Bool

Specifies whether the DB instance is encrypted.

Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.

Default: false

Default: The default EC2 VPC security group for the DB subnet group's VPC.

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>