{ "swagger": "2.0", "info": { "title": "Microsoft.AwsConnector", "version": "2024-12-01", "description": "Microsoft.AwsConnector Resource Provider management API.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "DatabaseMigrationServiceReplicationInstances" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/databaseMigrationServiceReplicationInstances": { "get": { "operationId": "DatabaseMigrationServiceReplicationInstances_ListBySubscription", "tags": [ "DatabaseMigrationServiceReplicationInstances" ], "description": "List DatabaseMigrationServiceReplicationInstance resources by subscription ID", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstanceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DatabaseMigrationServiceReplicationInstances_ListBySubscription": { "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/databaseMigrationServiceReplicationInstances": { "get": { "operationId": "DatabaseMigrationServiceReplicationInstances_ListByResourceGroup", "tags": [ "DatabaseMigrationServiceReplicationInstances" ], "description": "List DatabaseMigrationServiceReplicationInstance resources by resource group", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstanceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DatabaseMigrationServiceReplicationInstances_ListByResourceGroup": { "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/databaseMigrationServiceReplicationInstances/{name}": { "get": { "operationId": "DatabaseMigrationServiceReplicationInstances_Get", "tags": [ "DatabaseMigrationServiceReplicationInstances" ], "description": "Get a DatabaseMigrationServiceReplicationInstance", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of DatabaseMigrationServiceReplicationInstance", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DatabaseMigrationServiceReplicationInstances_Get": { "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_Get.json" } } }, "put": { "operationId": "DatabaseMigrationServiceReplicationInstances_CreateOrReplace", "tags": [ "DatabaseMigrationServiceReplicationInstances" ], "description": "Create a DatabaseMigrationServiceReplicationInstance. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of DatabaseMigrationServiceReplicationInstance", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" } } ], "responses": { "200": { "description": "Resource 'DatabaseMigrationServiceReplicationInstance' update operation succeeded", "schema": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" } }, "201": { "description": "Resource 'DatabaseMigrationServiceReplicationInstance' create operation succeeded", "schema": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DatabaseMigrationServiceReplicationInstances_CreateOrReplace": { "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "DatabaseMigrationServiceReplicationInstances_Update", "tags": [ "DatabaseMigrationServiceReplicationInstances" ], "description": "Update a DatabaseMigrationServiceReplicationInstance", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of DatabaseMigrationServiceReplicationInstance", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstanceTagsUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DatabaseMigrationServiceReplicationInstances_Update": { "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "DatabaseMigrationServiceReplicationInstances_Delete", "tags": [ "DatabaseMigrationServiceReplicationInstances" ], "description": "Delete a DatabaseMigrationServiceReplicationInstance", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of DatabaseMigrationServiceReplicationInstance", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DatabaseMigrationServiceReplicationInstances_Delete": { "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "AvailabilityZone": { "type": "object", "description": "Definition of AvailabilityZone", "properties": { "name": { "type": "string", "description": "
The name of the Availability Zone.
" } } }, "AwsDatabaseMigrationServiceReplicationInstanceProperties": { "type": "object", "description": "Definition of awsDatabaseMigrationServiceReplicationInstance", "properties": { "allocatedStorage": { "type": "integer", "format": "int32", "description": "The amount of storage (in gigabytes) that is allocated for the replication instance.
" }, "autoMinorVersionUpgrade": { "type": "boolean", "description": "Boolean value indicating if minor version upgrades will be automatically applied to the instance.
" }, "availabilityZone": { "type": "string", "description": "The Availability Zone for the instance.
" }, "dnsNameServers": { "type": "string", "description": "The DNS name servers supported for the replication instance to access your on-premise source or target database.
" }, "engineVersion": { "type": "string", "description": "The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
The expiration date of the free replication instance that is part of the Free DMS program.
" }, "instanceCreateTime": { "type": "string", "format": "date-time", "description": "The time the replication instance was created.
" }, "kmsKeyId": { "type": "string", "description": "An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
" }, "multiAZ": { "type": "boolean", "description": " Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
" }, "pendingModifiedValues": { "$ref": "#/definitions/ReplicationPendingModifiedValues", "description": "The pending modification values.
" }, "preferredMaintenanceWindow": { "type": "string", "description": "The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
" }, "publiclyAccessible": { "type": "boolean", "description": " Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
The Amazon Resource Name (ARN) of the replication instance.
" }, "replicationInstanceClass": { "type": "string", "description": "The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
" }, "replicationInstanceIdentifier": { "type": "string", "description": "The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
One or more IPv6 addresses for the replication instance.
", "items": { "type": "string" } }, "replicationInstancePrivateIpAddress": { "type": "string", "description": "The private IP address of the replication instance.
" }, "replicationInstancePrivateIpAddresses": { "type": "array", "description": "One or more private IP addresses for the replication instance.
", "items": { "type": "string" } }, "replicationInstancePublicIpAddress": { "type": "string", "description": "The public IP address of the replication instance.
" }, "replicationInstancePublicIpAddresses": { "type": "array", "description": "One or more public IP addresses for the replication instance.
", "items": { "type": "string" } }, "replicationInstanceStatus": { "type": "string", "description": "The status of the replication instance. The possible return values include:
'available'
'creating'
'deleted'
'deleting'
'failed'
'modifying'
'upgrading'
'rebooting'
'resetting-master-credentials'
'storage-full'
'incompatible-credentials'
'incompatible-network'
'maintenance'
The subnet group for the replication instance.
" }, "secondaryAvailabilityZone": { "type": "string", "description": "The Availability Zone of the standby replication instance in a Multi-AZ deployment.
" }, "vpcSecurityGroups": { "type": "array", "description": "The VPC security group for the instance.
", "items": { "$ref": "#/definitions/VpcSecurityGroupMembership" }, "x-ms-identifiers": [] } } }, "DatabaseMigrationServiceReplicationInstance": { "type": "object", "description": "A Microsoft.AwsConnector resource", "properties": { "properties": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstanceProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "DatabaseMigrationServiceReplicationInstanceListResult": { "type": "object", "description": "The response of a DatabaseMigrationServiceReplicationInstance list operation.", "properties": { "value": { "type": "array", "description": "The DatabaseMigrationServiceReplicationInstance items on this page", "items": { "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DatabaseMigrationServiceReplicationInstanceProperties": { "type": "object", "description": "Definition of DatabaseMigrationServiceReplicationInstance", "properties": { "awsProperties": { "$ref": "#/definitions/AwsDatabaseMigrationServiceReplicationInstanceProperties", "description": "AWS Properties" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsTags": { "type": "object", "description": "AWS Tags", "additionalProperties": { "type": "string" } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation.", "readOnly": true } } }, "DatabaseMigrationServiceReplicationInstanceTagsUpdate": { "type": "object", "description": "The type used for updating tags in DatabaseMigrationServiceReplicationInstance resources.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "ProvisioningState": { "type": "string", "description": "The provisioning state of a resource.", "enum": [ "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." }, { "name": "Provisioning", "value": "Provisioning", "description": "The resource is being provisioned" }, { "name": "Updating", "value": "Updating", "description": "The resource is updating" }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted" }, { "name": "Accepted", "value": "Accepted", "description": "The resource create request has been accepted" } ] }, "readOnly": true }, "ReplicationPendingModifiedValues": { "type": "object", "description": "Definition of ReplicationPendingModifiedValues", "properties": { "allocatedStorage": { "type": "integer", "format": "int32", "description": "The amount of storage (in gigabytes) that is allocated for the replication instance.
" }, "engineVersion": { "type": "string", "description": "The engine version number of the replication instance.
" }, "multiAZ": { "type": "boolean", "description": " Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
" }, "replicationInstanceClass": { "type": "string", "description": "The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
" } } }, "ReplicationSubnetGroup": { "type": "object", "description": "Definition of ReplicationSubnetGroup", "properties": { "replicationSubnetGroupDescription": { "type": "string", "description": "A description for the replication subnet group.
" }, "replicationSubnetGroupIdentifier": { "type": "string", "description": "The identifier of the replication instance subnet group.
" }, "subnetGroupStatus": { "type": "string", "description": "The status of the subnet group.
" }, "subnets": { "type": "array", "description": "The subnets that are in the subnet group.
", "items": { "$ref": "#/definitions/Subnet" }, "x-ms-identifiers": [] }, "supportedNetworkTypes": { "type": "array", "description": "The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
", "items": { "type": "string" } }, "vpcId": { "type": "string", "description": "The ID of the VPC.
" } } }, "Subnet": { "type": "object", "description": "Definition of Subnet", "properties": { "subnetAvailabilityZone": { "$ref": "#/definitions/AvailabilityZone", "description": "The Availability Zone of the subnet.
" }, "subnetIdentifier": { "type": "string", "description": "The subnet identifier.
" }, "subnetStatus": { "type": "string", "description": "The status of the subnet.
" } } }, "VpcSecurityGroupMembership": { "type": "object", "description": "Definition of VpcSecurityGroupMembership", "properties": { "status": { "type": "string", "description": "The status of the VPC security group.
" }, "vpcSecurityGroupId": { "type": "string", "description": "The VPC security group ID.
" } } } }, "parameters": {} }