AssociateProfile
Associates a Route 53 Profiles profile with a VPC. A VPC can have up to two Profile associations. A Profile can be associated with up to 1,000 VPCs, and you can request a higher quota for the number of VPCs. For more information, see Quotas on Route 53 Profiles.
Route 53 VPC Resolver evaluates the Profile associations for a VPC in priority order, starting with the lowest Priority value.
If the VPC has no other Profile associations, you can omit Priority, and the association gets priority 100. When the VPC
already has a Profile association, you must specify a Priority, and each Profile association for the VPC must have a unique
priority. To change the priority of an existing association, use UpdateProfileAssociation.
The request fails with a ValidationException in these cases:
-
You omit
Priority, and the VPC already has a Profile association. -
Another Profile association for the VPC already uses the priority that you specify.
-
The priority is outside the range 100–9900.
-
The Profile is already associated with the VPC, and you specify a different
NameorPriority. To change the priority, use UpdateProfileAssociation.
The request fails with a LimitExceededException if the VPC already has the maximum number of Profile associations.
Request Syntax
POST /profileassociation HTTP/1.1
Content-type: application/json
{
"Name": "string",
"Priority": number,
"ProfileId": "string",
"ResourceId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Name
-
A name for the association.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
(?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)Required: Yes
- Priority
-
The priority of the Profile association. Route 53 VPC Resolver evaluates the Profile associations for a VPC in priority order, starting with the lowest value.
When the VPC already has a Profile association, you must specify a priority that no other Profile association for the VPC uses. If you omit the priority for the first association with a VPC, the association gets priority 100.
Type: Integer
Valid Range: Minimum value of 100. Maximum value of 9900.
Required: No
- ProfileId
-
ID of the Profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- ResourceId
-
The ID of the VPC.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- Tags
-
A list of the tag keys and values that you want to identify the Profile association.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ProfileAssociation": {
"CreationTime": number,
"Id": "string",
"ModificationTime": number,
"Name": "string",
"OwnerId": "string",
"Priority": number,
"ProfileId": "string",
"ResourceId": "string",
"Status": "string",
"StatusMessage": "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.
- ProfileAssociation
-
The association that you just created. The association has an ID that you can use to identify it in other requests, such as update and delete.
Type: ProfileAssociation object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
The current account doesn't have the IAM permissions required to perform the specified operation.
HTTP Status Code: 400
- ConflictException
-
The request you submitted conflicts with an existing request.
HTTP Status Code: 400
- InvalidParameterException
-
One or more parameters in this request are not valid.
- FieldName
-
The parameter field name for the invalid parameter exception.
HTTP Status Code: 400
- LimitExceededException
-
The request caused one or more limits to be exceeded.
- ResourceType
-
The resource type that caused the limits to be exceeded.
HTTP Status Code: 400
- ResourceExistsException
-
The resource you are trying to associate, has already been associated.
- ResourceType
-
The resource type that caused the resource exists exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource you are associating is not found.
- ResourceType
-
The resource type that caused the resource not found exception.
HTTP Status Code: 400
- ThrottlingException
-
The request was throttled. Try again in a few minutes.
HTTP Status Code: 400
- ValidationException
-
You have provided an invalid command.
HTTP Status Code: 400
Examples
AssociateProfile Example
This example illustrates one usage of AssociateProfile.
Sample Request
POST /profileassociation HTTP/1.1
host:route53profiles.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 103
X-Amz-Date:20240319T222051Z
User-Agent: aws-cli/1.32.63 botocore/1.34.63 Python/3.8.18
Content-Type: application/json
Authorization: AWS4-HMAC-SHA256
Credential=AKIAJJ2SONIPEXAMPLE/20191101/us-east-1/route53profiles/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-security-token
Signature=[calculated-signature]
{
"Name": "test-association",
"ProfileId": "rp-4987774726example",
"ResourceId": "vpc-0af3b96b3example"
}
Sample Response
HTTP/1.1 200 OK
Date: Tue, 19 Mar 2024 22:20:51 GMT
Content-Type: application/json
Content-Length: 322
Connection: keep-alive
x-amzn-RequestId: dcd9d91e-1a5a-sdds-82b7-bafe7dexample
Access-Control-Allow-Origin: *
x-amz-apigw-id: U5eX0FdmIexample=
X-Amzn-Trace-Id: Root=1-65fa10fe-6e5a93a56a32afsdfd3example
{
"ProfileAssociation": {
"CreationTime": 1710886843.849,
"Id": "rpassoc-489ce212fexample",
"ModificationTime": 1710886843.849,
"Name": "test-association",
"OwnerId": "123456789012",
"ProfileId": "rp-4987774726example",
"ResourceId": "vpc-0af3b96b3example",
"Priority": 100,
"Status": "CREATING",
"StatusMessage": "Creating Profile Association"
}
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: