# CreateInstanceProfile
<a name="API_CreateInstanceProfile"></a>

Creates the instance profile using the specified parameters.

## Request Syntax
<a name="API_CreateInstanceProfile_RequestSyntax"></a>

```
{
   "AvailabilityZone": "string",
   "Description": "string",
   "InstanceProfileName": "string",
   "KmsKeyArn": "string",
   "NetworkType": "string",
   "PubliclyAccessible": boolean,
   "SubnetGroupIdentifier": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "ResourceArn": "string",
         "Value": "string"
      }
   ],
   "VpcSecurityGroups": [ "string" ]
}
```

## Request Parameters
<a name="API_CreateInstanceProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZone](#API_CreateInstanceProfile_RequestSyntax) **   <a name="DMS-CreateInstanceProfile-request-AvailabilityZone"></a>
The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the AWS Region where your data provider is created, for examplem `us-east-1d`.  
Type: String  
Required: No

 ** [Description](#API_CreateInstanceProfile_RequestSyntax) **   <a name="DMS-CreateInstanceProfile-request-Description"></a>
A user-friendly description of the instance profile.  
Type: String  
Required: No

 ** [InstanceProfileName](#API_CreateInstanceProfile_RequestSyntax) **   <a name="DMS-CreateInstanceProfile-request-InstanceProfileName"></a>
A user-friendly name for the instance profile.  
Type: String  
Required: No

 ** [KmsKeyArn](#API_CreateInstanceProfile_RequestSyntax) **   <a name="DMS-CreateInstanceProfile-request-KmsKeyArn"></a>
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 `KmsKeyArn` parameter, then AWS DMS uses an AWS owned encryption key to encrypt your resources.  
Type: String  
Required: No

 ** [NetworkType](#API_CreateInstanceProfile_RequestSyntax) **   <a name="DMS-CreateInstanceProfile-request-NetworkType"></a>
Specifies the network type for the instance profile. A value of `IPV4` represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of `IPV6` represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of `DUAL` represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.  
Type: String  
Required: No

 ** [PubliclyAccessible](#API_CreateInstanceProfile_RequestSyntax) **   <a name="DMS-CreateInstanceProfile-request-PubliclyAccessible"></a>
Specifies the accessibility options for the instance profile. A value of `true` represents an instance profile with a public IP address. A value of `false` represents an instance profile with a private IP address. The default value is `true`.  
Type: Boolean  
Required: No

 ** [SubnetGroupIdentifier](#API_CreateInstanceProfile_RequestSyntax) **   <a name="DMS-CreateInstanceProfile-request-SubnetGroupIdentifier"></a>
A subnet group to associate with the instance profile.  
Type: String  
Required: No

 ** [Tags](#API_CreateInstanceProfile_RequestSyntax) **   <a name="DMS-CreateInstanceProfile-request-Tags"></a>
One or more tags to be assigned to the instance profile.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [VpcSecurityGroups](#API_CreateInstanceProfile_RequestSyntax) **   <a name="DMS-CreateInstanceProfile-request-VpcSecurityGroups"></a>
Specifies the VPC security group names 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
<a name="API_CreateInstanceProfile_ResponseSyntax"></a>

```
{
   "InstanceProfile": { 
      "AvailabilityZone": "string",
      "Description": "string",
      "InstanceProfileArn": "string",
      "InstanceProfileCreationTime": "string",
      "InstanceProfileName": "string",
      "KmsKeyArn": "string",
      "NetworkType": "string",
      "PubliclyAccessible": boolean,
      "SubnetGroupIdentifier": "string",
      "VpcSecurityGroups": [ "string" ]
   }
}
```

## Response Elements
<a name="API_CreateInstanceProfile_ResponseElements"></a>

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](#API_CreateInstanceProfile_ResponseSyntax) **   <a name="DMS-CreateInstanceProfile-response-InstanceProfile"></a>
The instance profile that was created.  
Type: [InstanceProfile](API_InstanceProfile.md) object

## Errors
<a name="API_CreateInstanceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedFault **   
 AWS DMS was denied access to the endpoint. Check that the role is correctly configured.    
 ** message **   

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

HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
 AWS DMS cannot access the KMS key.    
 ** message **   

HTTP Status Code: 400

 ** ResourceAlreadyExistsFault **   
The resource you are attempting to create already exists.    
 ** message **   
  
 ** resourceArn **   

HTTP Status Code: 400

 ** ResourceNotFoundFault **   
The resource could not be found.    
 ** message **   

HTTP Status Code: 400

 ** ResourceQuotaExceededFault **   
The quota for this resource quota has been exceeded.    
 ** message **   

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
<a name="API_CreateInstanceProfile_Examples"></a>

### Creating a replication subnet group
<a name="API_CreateInstanceProfile_Example_1"></a>

Before you create an instance profile, you must create a replication subnet group. The following example demonstrates creating a replication subnet group using the CreateReplicationSubnetGroup action:

#### Sample Request
<a name="API_CreateInstanceProfile_Example_1_Request"></a>

```
{
    "ReplicationSubnetGroupIdentifier": "your-subnet-group",
    "ReplicationSubnetGroupDescription": "Your subnet group description",
    "SubnetIds": [
        "subnet-0123EXAMPLE456789", "subnet-012EXAMPLE3456789"
    ]
}
```

### Creating an instance profile
<a name="API_CreateInstanceProfile_Example_2"></a>

 The following example demonstrates creating an instance profile with the CreateInstanceProfile action:

#### Sample Request
<a name="API_CreateInstanceProfile_Example_2_Request"></a>

```
{
    "SubnetGroupIdentifier": "my-subnet-group",
    "VpcSecurityGroupIds": ["sg-0123456789abcdef0"],
    "PubliclyAccessible": true,
    "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
    "InstanceProfileName": "my-instance-profile",
    "Description": "Description",
    "NetworkType": "DUAL",
    "Tags": [
                {
                    "Key": "access",
                    "Value": "authorizedusers"
                } 
        ]
}
```

### Example
<a name="API_CreateInstanceProfile_Example_3"></a>

This example illustrates one usage of CreateInstanceProfile.

#### Sample Response
<a name="API_CreateInstanceProfile_Example_3_Response"></a>

```
{
    InstanceProfileName: "testConfigIdentifier1",
    Description: "A description",
    InstanceProfileCreationTime: "2023-02-20T14:12:30Z",
    InstanceProfileArn: "arn:aws:dms:us-east-1:012345678901:instance-profile:resourceId", 
    AvailabilityZone: "us-east-1a",
    SubnetGroupIdentifier: ["myGroup"],
    VpcSecurityGroups: ["sg-5475435"],
    KmsKeyArn: "arn:aws:kms:us-east-1:012345678901:key/abcdefg-0123-4567-89ab-cdef01234567",
    EncryptionContext: [
        {
            Key: "aws:servicename:id",
            Value: "redshift"
        },
        {
            Key: "aws:redshift:integration:arn",
            Value: "arn:aws:rds:us-east-1:122333444:integration/0123456789012"
        }
    ],
    NetworkType: "DUAL|IPv4",
    PubliclyAccessible: true
 }
```

## See Also
<a name="API_CreateInstanceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dms-2016-01-01/CreateInstanceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dms-2016-01-01/CreateInstanceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dms-2016-01-01/CreateInstanceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dms-2016-01-01/CreateInstanceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dms-2016-01-01/CreateInstanceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dms-2016-01-01/CreateInstanceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dms-2016-01-01/CreateInstanceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dms-2016-01-01/CreateInstanceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dms-2016-01-01/CreateInstanceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dms-2016-01-01/CreateInstanceProfile)