Modifies the specified instance profile using the provided parameters.
Note
All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.
Request Syntax
{
"AvailabilityZone": "string",
"Description": "string",
"InstanceProfileIdentifier": "string",
"InstanceProfileName": "string",
"KmsKeyArn": "string",
"NetworkType": "string",
"PubliclyAccessible": boolean,
"SubnetGroupIdentifier": "string",
"VpcSecurityGroups": [ "string" ]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AvailabilityZone
-
The Availability Zone where the instance profile runs.
Type: String
Required: No
- Description
-
A user-friendly description for the instance profile.
Type: String
Required: No
- InstanceProfileIdentifier
-
The identifier of the instance profile. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
Type: String
Required: Yes
- InstanceProfileName
-
A user-friendly name for the instance profile.
Type: String
Required: No
- KmsKeyArn
-
The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the connection parameters for the instance profile.
If you don't specify a value for the
KmsKeyArnparameter, then AWS DMS 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.
Type: String
Required: No
- NetworkType
-
Specifies the network type for the instance profile. A value of
IPV4represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value ofIPV6represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value ofDUALrepresents an instance profile with dual network type that supports IPv4 and IPv6 addressing.Type: String
Required: No
- PubliclyAccessible
-
Specifies the accessibility options for the instance profile. A value of
truerepresents an instance profile with a public IP address. A value offalserepresents an instance profile with a private IP address. The default value istrue.Type: Boolean
Required: No
- SubnetGroupIdentifier
-
A subnet group to associate with the instance profile.
Type: String
Required: No
- VpcSecurityGroups
-
Specifies the VPC security groups to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
Type: Array of strings
Required: No
Response Syntax
{
"InstanceProfile": {
"AvailabilityZone": "string",
"Description": "string",
"InstanceProfileArn": "string",
"InstanceProfileCreationTime": "string",
"InstanceProfileName": "string",
"KmsKeyArn": "string",
"NetworkType": "string",
"PubliclyAccessible": boolean,
"SubnetGroupIdentifier": "string",
"VpcSecurityGroups": [ "string" ]
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- InstanceProfile
-
The instance profile that was modified.
Type: InstanceProfile object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
AWS DMS was denied access to the endpoint. Check that the role is correctly configured.
HTTP Status Code: 400
- FailedDependencyFault
-
A dependency threw an exception.
HTTP Status Code: 400
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
- KMSKeyNotAccessibleFault
-
AWS DMS cannot access the KMS key.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
- S3AccessDeniedFault
-
Insufficient privileges are preventing access to an Amazon S3 object.
HTTP Status Code: 400
- S3ResourceNotFoundFault
-
A specified Amazon S3 bucket, bucket folder, or other object can't be found.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ModifyInstanceProfile.
Sample Request
{
"InstanceProfileIdentifier": "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
"SubnetGroupIdentifier": "myuser-subnet-group",
"VpcSecurityGroupIds": ["sg-0123456789abcdef0"],
"VpcIdentifier": "vpc-0123456789abcdef0",
"PubliclyAccessible": true,
"KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
"InstanceProfileName": "new-name",
"Description": "Description",
"NetworkType": "DUAL"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
