CreateDBInstanceMessage

public struct CreateDBInstanceMessage : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The amount of storage (in gibibytes) to allocate for the DB instance. Type: Integer Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in a Neptune cluster volume.

    Declaration

    Swift

    public let allocatedStorage: Int?

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

    Declaration

    Swift

    public let autoMinorVersionUpgrade: Bool?

  • The EC2 Availability Zone that the DB instance is created in Default: A random, system-chosen Availability Zone in the endpoint’s AWS 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 AWS Region as the current endpoint.

    Declaration

    Swift

    public let availabilityZone: String?

  • 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

    Declaration

    Swift

    public let backupRetentionPeriod: Int?

  • (Not supported by Neptune)

    Declaration

    Swift

    public let characterSetName: String?

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

    Declaration

    Swift

    public let copyTagsToSnapshot: Bool?

  • The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String

    Declaration

    Swift

    public let dBClusterIdentifier: String?

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

    Declaration

    Swift

    public let dBInstanceClass: String

  • 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

    Declaration

    Swift

    public let dBInstanceIdentifier: String

  • Not supported.

    Declaration

    Swift

    public let dBName: String?

  • 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

    Declaration

    Swift

    public let dBParameterGroupName: String?

  • A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.

    Declaration

    Swift

    public let dBSecurityGroups: [String]?

  • 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.

    Declaration

    Swift

    public let dBSubnetGroupName: String?

  • 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. DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.

    Declaration

    Swift

    public let deletionProtection: Bool?

  • Specify the Active Directory Domain to create the instance in.

    Declaration

    Swift

    public let domain: String?

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

    Declaration

    Swift

    public let domainIAMRoleName: String?

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

    Declaration

    Swift

    public let enableCloudwatchLogsExports: [String]?

  • True to enable AWS Identity and Access Management (IAM) authentication for Neptune. Default: false

    Declaration

    Swift

    public let enableIAMDatabaseAuthentication: Bool?

  • (Not supported by Neptune)

    Declaration

    Swift

    public let enablePerformanceInsights: Bool?

  • The name of the database engine to be used for this instance. Valid Values: neptune

    Declaration

    Swift

    public let engine: String

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

    Declaration

    Swift

    public let engineVersion: String?

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

    Declaration

    Swift

    public let iops: Int?

  • The AWS 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 AWS 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. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    Declaration

    Swift

    public let kmsKeyId: String?

  • License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license

    Declaration

    Swift

    public let licenseModel: String?

  • The name for the master user. Not used.

    Declaration

    Swift

    public let masterUsername: String?

  • The password for the master user. The password can include any printable ASCII character except “/”, “”“, or ”@“. Not used.

    Declaration

    Swift

    public let masterUserPassword: String?

  • 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

    Declaration

    Swift

    public let monitoringInterval: Int?

  • 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.

    Declaration

    Swift

    public let monitoringRoleArn: String?

  • 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.

    Declaration

    Swift

    public let multiAZ: Bool?

  • (Not supported by Neptune)

    Declaration

    Swift

    public let optionGroupName: String?

  • (Not supported by Neptune)

    Declaration

    Swift

    public let performanceInsightsKMSKeyId: String?

  • 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

    Declaration

    Swift

    public let port: Int?

  • 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.

    Declaration

    Swift

    public let preferredBackupWindow: 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 AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.

    Declaration

    Swift

    public let preferredMaintenanceWindow: String?

  • 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

    Declaration

    Swift

    public let promotionTier: Int?

  • 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

    Declaration

    Swift

    public let storageEncrypted: Bool?

  • Specifies the storage type to be associated with the DB instance. Not applicable. Storage is managed by the DB Cluster.

    Declaration

    Swift

    public let storageType: String?

  • The tags to assign to the new instance.

    Declaration

    Swift

    public let tags: [Tag]?

  • The ARN from the key store with which to associate the instance for TDE encryption.

    Declaration

    Swift

    public let tdeCredentialArn: String?

  • The password for the given ARN from the key store in order to access the device.

    Declaration

    Swift

    public let tdeCredentialPassword: String?

  • The time zone of the DB instance.

    Declaration

    Swift

    public let timezone: String?

  • A list of EC2 VPC security groups to associate with this DB instance. Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster. Default: The default EC2 VPC security group for the DB subnet group’s VPC.

    Declaration

    Swift

    public let vpcSecurityGroupIds: [String]?

  • Undocumented

    Declaration

    Swift

    public init(allocatedStorage: Int? = nil, autoMinorVersionUpgrade: Bool? = nil, availabilityZone: String? = nil, backupRetentionPeriod: Int? = nil, characterSetName: String? = nil, copyTagsToSnapshot: Bool? = nil, dBClusterIdentifier: String? = nil, dBInstanceClass: String, dBInstanceIdentifier: String, dBName: String? = nil, dBParameterGroupName: String? = nil, dBSecurityGroups: [String]? = nil, dBSubnetGroupName: String? = nil, deletionProtection: Bool? = nil, domain: String? = nil, domainIAMRoleName: String? = nil, enableCloudwatchLogsExports: [String]? = nil, enableIAMDatabaseAuthentication: Bool? = nil, enablePerformanceInsights: Bool? = nil, engine: String, engineVersion: String? = nil, iops: Int? = nil, kmsKeyId: String? = nil, licenseModel: String? = nil, masterUsername: String? = nil, masterUserPassword: String? = nil, monitoringInterval: Int? = nil, monitoringRoleArn: String? = nil, multiAZ: Bool? = nil, optionGroupName: String? = nil, performanceInsightsKMSKeyId: String? = nil, port: Int? = nil, preferredBackupWindow: String? = nil, preferredMaintenanceWindow: String? = nil, promotionTier: Int? = nil, storageEncrypted: Bool? = nil, storageType: String? = nil, tags: [Tag]? = nil, tdeCredentialArn: String? = nil, tdeCredentialPassword: String? = nil, timezone: String? = nil, vpcSecurityGroupIds: [String]? = nil)