[ aws . rds ]

import-installation-media

Description

Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  import-installation-media
--custom-availability-zone-id <value>
--engine <value>
--engine-version <value>
--engine-installation-media-path <value>
--os-installation-media-path <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--custom-availability-zone-id (string)

The identifier of the custom Availability Zone (AZ) to import the installation media to.

--engine (string)

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

The list only includes supported DB engines that require an on-premises customer provided license.

Valid Values:

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

--engine-version (string)

The version number of the database engine to use.

For a list of valid engine versions, call DescribeDBEngineVersions .

The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license.

Microsoft SQL Server

See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

--engine-installation-media-path (string)

The path to the installation medium for the specified DB engine.

Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso

--os-installation-media-path (string)

The path to the installation medium for the operating system associated with the specified DB engine.

Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso

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

See ‘aws help’ for descriptions of global parameters.

Examples

To import installation media

The following import-installation-media imports installation media.

aws rds import-installation-media \
    --custom-availability-zone-id rds-caz-EXAMPLE \
    --engine sqlserver-ee --engine-version 13.00.5292.0.v1 \
    --engine-installation-media-path SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso \
    --os-installation-media-path WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso

Output:

{
    "InstallationMediaId": "b1zcEXAMPLE",
    "CustomAvailabilityZoneId": "rds-caz-EXAMPLE",
    "Engine": "sqlserver-ee",
    "EngineVersion": "13.00.5292.0.v1",
    "EngineInstallationMediaPath": "SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso",
    "OSInstallationMediaPath": "WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso",
    "Status": "Importing",
    "FailureCause": {}
}

For more information, see What is Amazon RDS on VMware? in the Amazon RDS on VMware User Guide.

Output

InstallationMediaId -> (string)

The installation medium ID.

CustomAvailabilityZoneId -> (string)

The custom Availability Zone (AZ) that contains the installation media.

Engine -> (string)

The DB engine.

EngineVersion -> (string)

The engine version of the DB engine.

EngineInstallationMediaPath -> (string)

The path to the installation medium for the DB engine.

OSInstallationMediaPath -> (string)

The path to the installation medium for the operating system associated with the DB engine.

Status -> (string)

The status of the installation medium.

FailureCause -> (structure)

If an installation media failure occurred, the cause of the failure.

Message -> (string)

The reason that an installation media import failed.