RestoreDBInstanceFromS3Message Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    allocatedStorage

The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance. Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.

Declaration

Swift

public let allocatedStorage: Int?


                    
                    
                    autoMinorVersionUpgrade

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.

Declaration

Swift

public let autoMinorVersionUpgrade: Bool?


                    
                    
                    availabilityZone

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide. 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 DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

Declaration

Swift

public let availabilityZone: String?


                    
                    
                    backupRetentionPeriod

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

Declaration

Swift

public let backupRetentionPeriod: Int?


                    
                    
                    copyTagsToSnapshot

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

Declaration

Swift

public let copyTagsToSnapshot: Bool?


                    
                    
                    dBInstanceClass

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, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Importing from Amazon S3 isn’t supported on the db.t2.micro DB instance class.

Declaration

Swift

public let dBInstanceClass: String


                    
                    
                    dBInstanceIdentifier

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. Can’t end with a hyphen or contain two consecutive hyphens. Example: mydbinstance

Declaration

Swift

public let dBInstanceIdentifier: String


                    
                    
                    dBName

The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

Declaration

Swift

public let dBName: String?


                    
                    
                    dBParameterGroupName

The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Declaration

Swift

public let dBParameterGroupName: String?


                    
                    
                    dBSecurityGroups

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]?


                    
                    
                    dBSubnetGroupName

A DB subnet group to associate with this DB instance.

Declaration

Swift

public let dBSubnetGroupName: String?


                    
                    
                    deletionProtection

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. For more information, see Deleting a DB Instance.

Declaration

Swift

public let deletionProtection: Bool?


                    
                    
                    enableCloudwatchLogsExports

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Declaration

Swift

public let enableCloudwatchLogsExports: [String]?


                    
                    
                    enableIAMDatabaseAuthentication

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Declaration

Swift

public let enableIAMDatabaseAuthentication: Bool?


                    
                    
                    enablePerformanceInsights

A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Declaration

Swift

public let enablePerformanceInsights: Bool?


                    
                    
                    engine

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

Declaration

Swift

public let engine: String


                    
                    
                    engineVersion

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Declaration

Swift

public let engineVersion: String?


                    
                    
                    iops

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Declaration

Swift

public let iops: Int?


                    
                    
                    kmsKeyId

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. If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS 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?


                    
                    
                    licenseModel

The license model for this DB instance. Use general-public-license.

Declaration

Swift

public let licenseModel: String?


                    
                    
                    masterUsername

The name for the master user. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can’t be a reserved word for the chosen database engine.

Declaration

Swift

public let masterUsername: String?


                    
                    
                    masterUserPassword

The password for the master user. The password can include any printable ASCII character except “/”, “”“, or ”@“. Constraints: Must contain from 8 to 41 characters.

Declaration

Swift

public let masterUserPassword: String?


                    
                    
                    monitoringInterval

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 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 Default: 0

Declaration

Swift

public let monitoringInterval: Int?


                    
                    
                    monitoringRoleArn

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Declaration

Swift

public let monitoringRoleArn: String?


                    
                    
                    multiAZ

A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can’t set the AvailabilityZone parameter.

Declaration

Swift

public let multiAZ: Bool?


                    
                    
                    optionGroupName

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

Declaration

Swift

public let optionGroupName: String?


                    
                    
                    performanceInsightsKMSKeyId

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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 performanceInsightsKMSKeyId: String?


                    
                    
                    performanceInsightsRetentionPeriod

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Declaration

Swift

public let performanceInsightsRetentionPeriod: Int?


                    
                    
                    port

The port number on which the database accepts connections. Type: Integer Valid Values: 1150-65535 Default: 3306

Declaration

Swift

public let port: Int?


                    
                    
                    preferredBackupWindow

The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

Declaration

Swift

public let preferredBackupWindow: String?


                    
                    
                    preferredMaintenanceWindow

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred backup window. Must be at least 30 minutes.

Declaration

Swift

public let preferredMaintenanceWindow: String?


                    
                    
                    processorFeatures

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Declaration

Swift

public let processorFeatures: [ProcessorFeature]?


                    
                    
                    publiclyAccessible

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance’s VPC, and to the public IP address from outside of the DB instance’s VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn’t permit it. When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

Declaration

Swift

public let publiclyAccessible: Bool?


                    
                    
                    s3BucketName

The name of your Amazon S3 bucket that contains your database backup file.

Declaration

Swift

public let s3BucketName: String


                    
                    
                    s3IngestionRoleArn

An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

Declaration

Swift

public let s3IngestionRoleArn: String


                    
                    
                    s3Prefix

The prefix of your Amazon S3 bucket.

Declaration

Swift

public let s3Prefix: String?


                    
                    
                    sourceEngine

The name of the engine of your source database. Valid Values: mysql

Declaration

Swift

public let sourceEngine: String


                    
                    
                    sourceEngineVersion

The version of the database that the backup files were created from. MySQL versions 5.6 and 5.7 are supported. Example: 5.6.40

Declaration

Swift

public let sourceEngineVersion: String


                    
                    
                    storageEncrypted

A value that indicates whether the new DB instance is encrypted or not.

Declaration

Swift

public let storageEncrypted: Bool?


                    
                    
                    storageType

Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise gp2

Declaration

Swift

public let storageType: String?


                    
                    
                    tags

A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Declaration

Swift

public let tags: [Tag]?


                    
                    
                    useDefaultProcessorFeatures

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Declaration

Swift

public let useDefaultProcessorFeatures: Bool?


                    
                    
                    vpcSecurityGroupIds

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

Declaration

Swift

public let vpcSecurityGroupIds: [String]?


                    
                    
                    init(allocatedStorage:autoMinorVersionUpgrade:availabilityZone:backupRetentionPeriod:copyTagsToSnapshot:dBInstanceClass:dBInstanceIdentifier:dBName:dBParameterGroupName:dBSecurityGroups:dBSubnetGroupName:deletionProtection:enableCloudwatchLogsExports:enableIAMDatabaseAuthentication:enablePerformanceInsights:engine:engineVersion:iops:kmsKeyId:licenseModel:masterUsername:masterUserPassword:monitoringInterval:monitoringRoleArn:multiAZ:optionGroupName:performanceInsightsKMSKeyId:performanceInsightsRetentionPeriod:port:preferredBackupWindow:preferredMaintenanceWindow:processorFeatures:publiclyAccessible:s3BucketName:s3IngestionRoleArn:s3Prefix:sourceEngine:sourceEngineVersion:storageEncrypted:storageType:tags:useDefaultProcessorFeatures:vpcSecurityGroupIds:)

Undocumented

Declaration

Swift

public init(allocatedStorage: Int? = nil, autoMinorVersionUpgrade: Bool? = nil, availabilityZone: String? = nil, backupRetentionPeriod: Int? = nil, copyTagsToSnapshot: Bool? = nil, dBInstanceClass: String, dBInstanceIdentifier: String, dBName: String? = nil, dBParameterGroupName: String? = nil, dBSecurityGroups: [String]? = nil, dBSubnetGroupName: String? = nil, deletionProtection: Bool? = 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, performanceInsightsRetentionPeriod: Int? = nil, port: Int? = nil, preferredBackupWindow: String? = nil, preferredMaintenanceWindow: String? = nil, processorFeatures: [ProcessorFeature]? = nil, publiclyAccessible: Bool? = nil, s3BucketName: String, s3IngestionRoleArn: String, s3Prefix: String? = nil, sourceEngine: String, sourceEngineVersion: String, storageEncrypted: Bool? = nil, storageType: String? = nil, tags: [Tag]? = nil, useDefaultProcessorFeatures: Bool? = nil, vpcSecurityGroupIds: [String]? = nil)